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 Application

Holds global options and objects.

Namespace: Peg\Custom
Located at src/Application.php
Methods summary
public static
# Initialize( )

Initialize all variables used by Peg. Has to be called before any usage of peg.

Initialize all variables used by Peg. Has to be called before any usage of peg.

public static boolean
# ValidExtension( )

Check if the current directory is of a valid extension.

Check if the current directory is of a valid extension.

Returns

boolean
public static string
# GetCwd( )

Gets the current working directory.

Gets the current working directory.

Returns

string
public static string
# GetSkeletonPath( )

Retreieve the skeleton path from PEG_SKELETON_PATH or throws an exception if not exists.

Retreieve the skeleton path from PEG_SKELETON_PATH or throws an exception if not exists.

Returns

string

Throws

Exception
public static Peg\Custom\CommandLine\Parser &
# GetCLIParser( )

Gets the global command line parser.

Gets the global command line parser.

Returns

Peg\Custom\CommandLine\Parser
public static Peg\Custom\Command\Init &
# GetInitCommand( )

Gets a reference to init command currently used by peg.

Gets a reference to init command currently used by peg.

Returns

Peg\Custom\Command\Init
public static Peg\Custom\Command\Help &
# GetHelpCommand( )

Gets a reference to help command currently used by peg.

Gets a reference to help command currently used by peg.

Returns

Peg\Custom\Command\Help
public static Peg\Custom\Command\Parse &
# GetParseCommand( )

Gets a reference to parse command currently used by peg.

Gets a reference to parse command currently used by peg.

Returns

Peg\Custom\Command\Parse
public static Peg\Custom\Command\Parse &
# GetGenerateCommand( )

Gets a reference to generate command currently used by peg.

Gets a reference to generate command currently used by peg.

Returns

Peg\Custom\Command\Parse
public static Peg\Lib\Definitions\Symbols &
# GetDefinitions( )

Loads definitions files if not yet loaded and returns a reference to a symbols object that can be used throught the application.

Loads definitions files if not yet loaded and returns a reference to a symbols object that can be used throught the application.

Returns

Peg\Lib\Definitions\Symbols
public static Peg\Lib\Plugins\Loader &
# GetPluginLoader( )

Get reference to the plugin loader currently used by peg.

Get reference to the plugin loader currently used by peg.

Returns

Peg\Lib\Plugins\Loader
PEG Api API documentation generated by ApiGen 2.8.0