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 Overload

Represents a function or class method overload element.

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

Create a function or method overload.

Create a function or method overload.

Parameters

$description
string
$description
public Peg\Lib\Definitions\Element\Overload
# SetReturnType( Peg\Lib\Definitions\Element\ReturnType $return_type )

Helper function to set the overload return type.

Helper function to set the overload return type.

Parameters

$return_type
Peg\Lib\Definitions\Element\ReturnType
$return_type

Returns

Peg\Lib\Definitions\Element\Overload
public Peg\Lib\Definitions\Element\Overload
# AddParameter( Peg\Lib\Definitions\Element\Parameter $parameter )

Adds a new parameter.

Adds a new parameter.

Parameters

$parameter
Peg\Lib\Definitions\Element\Parameter
$parameter

Returns

Peg\Lib\Definitions\Element\Overload
public boolean
# HasParameters( )

Check if the overload has parameters.

Check if the overload has parameters.

Returns

boolean
public
# GetParametersCount( )
public
# GetRequiredParametersCount( )
Properties summary
public string $description
#

Description of the element.

Description of the element.

public array $platforms
#

List of platforms where the element is supported.

List of platforms where the element is supported.

public Peg\Lib\Definitions\Element\ReturnType $return_type
#

The return type of the overload.

The return type of the overload.

public Peg\Lib\Definitions\Element\Parameter[] $parameters
#

Holds the list of parameters for the overload.

Holds the list of parameters for the overload.

public boolean $protected
#

Flag that indicate if the method is protected.

Flag that indicate if the method is protected.

public boolean $constant
#

Flag that indicate if the method is const.

Flag that indicate if the method is const.

public boolean $static
#

Flag that indicate if the method is static.

Flag that indicate if the method is static.

public boolean $virtual
#

Flag that indicate if the method is virtual.

Flag that indicate if the method is virtual.

public boolean $pure_virtual
#

Flag that indicate if the method is pure virtual.

Flag that indicate if the method is pure virtual.

public boolean $deprecated
#

Flag that indicate if the method/function is deprecated.

Flag that indicate if the method/function is deprecated.

public Peg\Lib\Definitions\Element\FunctionElement $function
#

Reference to the parent function element.

Reference to the parent function element.

PEG Api API documentation generated by ApiGen 2.8.0