Overview

Namespaces

  • None
  • Peg
    • Cli
      • Commands
    • Config
    • Custom
      • Command
        • Action
          • Generate
          • Parse
      • CommandLine
      • Config
      • Localization
      • Utilities
    • Lib
      • Definitions
        • Element
      • Generator
      • Lexers
      • Plugins
      • Signals
        • Data
          • Definitions
          • Lexers
        • Type
  • PHP

Classes

  • Settings
  • Overview
  • Namespace
  • Class
  • Tree
  • Todo

Class Settings

Base configuration class. Every frontend's configuration helper should extend this.

Namespace: Peg\Config
Located at src/Settings.php
Methods summary
public static string|boolean
# Get( string $option )

Gets the value of a specific option.

Gets the value of a specific option.

Parameters

$option
string
$option

Returns

string|boolean
public static string
# GetExtensionName( )

Get the current extension name.

Get the current extension name.

Returns

string
public static string
# GetExtensionVersion( )

Get the current extension version.

Get the current extension version.

Returns

string
public static string
# GetAuthors( )

Get a comma separated list of authors.

Get a comma separated list of authors.

Returns

string
public static string
# GetContributors( )

Get a comma separated list of contributors.

Get a comma separated list of contributors.

Returns

string
public static
# SetExtensionName( string $name )

Set the extension name, which is used in some important parts of the code generator.

Set the extension name, which is used in some important parts of the code generator.

Parameters

$name
string
$name
public static
# SetVersion( string $number )

Sets the version of the extension, which is used in some important parts of the code generator.

Sets the version of the extension, which is used in some important parts of the code generator.

Parameters

$number
string
$number
public static
# SetAuthors( string $authors )

Set the authors of the extension. This should be a comma seperated list with the names of the authors.

Set the authors of the extension. This should be a comma seperated list with the names of the authors.

Parameters

$authors
string
$authors
public static
# SetContributors( string $contributors )

Set the contributors of the extension. This should be a comma seperated list with the names of the contributors.

Set the contributors of the extension. This should be a comma seperated list with the names of the contributors.

Parameters

$contributors
string
$contributors
Properties summary
protected array $settings [ "ExtensionName" => null, "ExtensionVersion" => null, "Authors" => null, "Contributors" => null, ]
#
PEG Api API documentation generated by ApiGen 2.8.0