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

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

Class Settings

For managing the configuration options of a valid peg managed extension directory.

Namespace: Peg\Custom
Located at src/Settings.php
Methods summary
public static
# SetBackEnd( Peg\Custom\Config\Base $backend )

Sets the back-end or implementation that will be used to manage the retreival and storage of settings.

Sets the back-end or implementation that will be used to manage the retreival and storage of settings.

Parameters

$backend
Peg\Custom\Config\Base
$backend
public static
# Load( string $directory, string $file )

Loads the configuration file on the given directory.

Loads the configuration file on the given directory.

Parameters

$directory
string
$directory
$file
string
$file
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|boolean
# GetGroupValue( string $group, string $option )

Gets the value of a specific option inside a group.

Gets the value of a specific option inside a group.

Parameters

$group
string
$group Eg: parser
$option
string
$option Eg: input_format

Returns

string|boolean
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 string
# GetExtensionName( )

Get the current extension name.

Get the current extension name.

Returns

string
public static string
# GetVersion( )

Get the current extension version.

Get the current extension version.

Returns

string
public static
# Set( string $option, string $value )

Modify or add a new option.

Modify or add a new option.

Parameters

$option
string
$option Option to add or modify.
$value
string
$value Value of the option.
public static
# SetGroupValue( string $group, string $option, string $value )

Modify or add a new group with an option.

Modify or add a new group with an option.

Parameters

$group
string
$group Name of group to modify or create.
$option
string
$option Name of option to add or modify in the group.
$value
string
$value Value of the option.
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
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
PEG Api API documentation generated by ApiGen 2.8.0