PHP Class PHPDocMD\Parser

Author: Evert Pot (http://www.rooftopsolutions.nl/)

Protected Properties

Property	Type	Description
$classDefinitions	array	The list of classes and interfaces.
$structureXmlFile	string	Path to the structure.xml file.

Method	Description
__construct ( string $structureXmlFile )
run ( )	Starts the process.

Method	Description
expandMethods ( string $className ) : array	This method goes through all the class definitions, and adds non-overridden method information from parent classes.
expandProperties ( string $className ) : array	This method goes through all the class definitions, and adds non-overridden property information from parent classes.
getClassDefinitions ( SimpleXmlElement $xml )	Gets all classes and interfaces from the file and puts them in an easy to use array.
parseConstants ( SimpleXMLElement $class ) : array	Parses all constant information for a single class or interface.
parseMethods ( SimpleXMLElement $class ) : array	Parses all the method information for a single class or interface.
parseProperties ( SimpleXMLElement $class ) : array	Parses all property information for a single class or interface.

public __construct ( string $structureXmlFile )
$structureXmlFile	string

This method goes through all the class definitions, and adds non-overridden method information from parent classes.

protected expandMethods ( string $className ) : array
$className	string
return	array

This method goes through all the class definitions, and adds non-overridden property information from parent classes.

protected expandProperties ( string $className ) : array
$className	string
return	array

Gets all classes and interfaces from the file and puts them in an easy to use array.

protected getClassDefinitions ( SimpleXmlElement $xml )
$xml	SimpleXmlElement

You must pass an xml element that refers to either the class or interface element from structure.xml.

protected parseConstants ( SimpleXMLElement $class ) : array
$class	SimpleXMLElement
return	array

You must pass an xml element that refers to either the class or interface element from structure.xml.

protected parseMethods ( SimpleXMLElement $class ) : array
$class	SimpleXMLElement
return	array

You must pass an xml element that refers to either the class or interface element from structure.xml.

protected parseProperties ( SimpleXMLElement $class ) : array
$class	SimpleXMLElement
return	array

Starts the process.

public run ( )

The list of classes and interfaces.

protected array $classDefinitions
return	array

Path to the structure.xml file.

protected string $structureXmlFile
return	string