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

  • ClassElement
  • ClassVariable
  • Constant
  • Enumeration
  • FunctionElement
  • GlobalVariable
  • Header
  • NamespaceElement
  • Overload
  • Parameter
  • ReturnType
  • TypeComponents
  • TypeDef
  • VariableType
  • Overview
  • Namespace
  • Class
  • Tree
  • Todo

Class FunctionElement

Represents a function or class method element.

Namespace: Peg\Lib\Definitions\Element
Located at src/Definitions/Element/FunctionElement.php
Methods summary
public
# __construct( string $name, string $description = "" )

Creates a function element.

Creates a function element.

Parameters

$name
string
$name
$description
string
$description
public Peg\Lib\Definitions\Element\FunctionElement
# AddOverload( Peg\Lib\Definitions\Element\Overload $overload )

Adds a new overload for the function.

Adds a new overload for the function.

Parameters

$overload
Peg\Lib\Definitions\Element\Overload
$overload

Returns

Peg\Lib\Definitions\Element\FunctionElement
Properties summary
public string $name
#

Holds the name of the element

Holds the name of the element

public string $description
#

Description of the element.

Description of the element.

public Peg\Lib\Definitions\Element\Overload[] $overloads
#

List of overloads for this function/method

List of overloads for this function/method

public Peg\Lib\Definitions\Element\ClassElement $parent_class
#

Reference to the class containing this element if applicable.

Reference to the class containing this element if applicable.

public Peg\Lib\Definitions\Element\Header $header
#

Reference to the header containing this element.

Reference to the header containing this element.

public Peg\Lib\Definitions\Element\NamespaceElement $namespace
#

Reference to the namespace containing this element.

Reference to the namespace containing this element.

PEG Api API documentation generated by ApiGen 2.8.0