Class Base

Base for a lexer that extract and generates definition files.

Peg\Lib\Signals\Signal

Extended by

Peg\Lib\Lexers\Base

Direct known subclasses

Peg\Lib\Lexers\Doxygen

Abstract
Namespace: Peg\Lib\Lexers
Located at src/Lexers/Base.php

Methods summary
`public`	# `__construct( type $definitions_path, type $headers_path = "" )` Constructor. Constructor. Parameters `$definitions_path` `type` $definitions_path `$headers_path` `type` $headers_path Throws `Exception` If the definitions path does not exists. Overrides `Peg\Lib\Signals\Signal::__construct()`
`public`	# `SaveDefinitions( string $path = null, string $type = \Peg\Lib\Definitions\Type::JSON )` Generates definition files in a specified path. Can generate definitions of a specific type if the $type is specified using one of the values from \Peg\Lib\Definitions\Type Generates definition files in a specified path. Can generate definitions of a specific type if the $type is specified using one of the values from \Peg\Lib\Definitions\Type Parameters `$path` `string` $path `$type` `string` $type The type of definitions file to generate.
`protected`	# `SendMessage( string $message )` Sends a signal with message of current task being performed. Sends a signal with message of current task being performed. Parameters `$message` `string` $message
`abstract public`	# `Start( )` Needs to be implemented by classes extending this one in order to begin the parsing process. Needs to be implemented by classes extending this one in order to begin the parsing process.

Methods inherited from Peg\Lib\Signals\Signal
`Listen(), Send(), Unlisten()`

Properties summary
`public string`	`$definitions_path`		# The path where resides the files with definitions of a c/c++ library. The path where resides the files with definitions of a c/c++ library.
`public string`	`$headers_path`		# Full path where the definition c/c++ header files reside, this is used to correctly resolve a header file name by stripping this path out and only leaving the real header name. This may not be required in all lexers. Full path where the definition c/c++ header files reside, this is used to correctly resolve a header file name by stripping this path out and only leaving the real header name. This may not be required in all lexers.
`public Peg\Lib\Definitions\Symbols`	`$symbols`		# The symbols object used to store definitions. The symbols object used to store definitions.
`public Peg\Lib\Definitions\Exporter`	`$exporter`		# Object used to create the symbols cache files. Object used to create the symbols cache files.
`protected Peg\Lib\Signals\Data\Lexers\Message`	`$signal_data`		# Object used to send message signals. Object used to send message signals.