Macro
extends Method
in package
Table of Contents
- $declaringClassName : mixed
- $interfaces : mixed
- $method : ReflectionMethod
- $name : mixed
- $namespace : mixed
- $output : mixed
- $params : mixed
- $params_with_default : mixed
- $phpdoc : DocBlock
- $real_name : mixed
- $return : mixed
- $root : mixed
- __construct() : mixed
- Macro constructor.
- getDeclaringClass() : string
- Get the class wherein the function resides
- getDocComment() : mixed
- Get the docblock for this method
- getName() : string
- Get the method name
- getParameters() : array<string|int, mixed>
- Get the parameters and format them correctly
- getParams() : string
- Get the parameters for this method
- getParamsWithDefault() : string
- Get the parameters for this method including default values
- getRealName() : string
- Get the real method name
- getRoot() : string
- Return the class from which this function would be called
- getRootMethodCall() : string
- isInstanceCall() : bool
- shouldReturn() : bool
- Should the function return a value?
- convertKeywords() : string
- Convert keywwords that are incorrect.
- getInheritDoc() : DocBlock
- initClassDefinedProperties() : mixed
- initPhpDoc() : mixed
- normalizeDescription() : mixed
- Get the description and get the inherited docs.
- normalizeParams() : mixed
- Normalize the parameters
- normalizeReturn() : mixed
- Normalize the return tag (make full namespace, replace interfaces)
Properties
$declaringClassName
protected
mixed
$declaringClassName
$interfaces
protected
mixed
$interfaces
= array()
$method
protected
ReflectionMethod
$method
$name
protected
mixed
$name
$namespace
protected
mixed
$namespace
$output
protected
mixed
$output
= ''
$params
protected
mixed
$params
= array()
$params_with_default
protected
mixed
$params_with_default
= array()
$phpdoc
protected
DocBlock
$phpdoc
$real_name
protected
mixed
$real_name
$return
protected
mixed
$return
= null
$root
protected
mixed
$root
Methods
__construct()
Macro constructor.
public
__construct(ReflectionFunctionAbstract $method, string $alias, ReflectionClass $class[, null $methodName = null ][, array<string|int, mixed> $interfaces = array() ]) : mixed
Parameters
- $method : ReflectionFunctionAbstract
- $alias : string
- $class : ReflectionClass
- $methodName : null = null
- $interfaces : array<string|int, mixed> = array()
Return values
mixed —getDeclaringClass()
Get the class wherein the function resides
public
getDeclaringClass() : string
Return values
string —getDocComment()
Get the docblock for this method
public
getDocComment([string $prefix = " " ]) : mixed
Parameters
- $prefix : string = " "
Return values
mixed —getName()
Get the method name
public
getName() : string
Return values
string —getParameters()
Get the parameters and format them correctly
public
getParameters(ReflectionMethod $method) : array<string|int, mixed>
Parameters
- $method : ReflectionMethod
Return values
array<string|int, mixed> —getParams()
Get the parameters for this method
public
getParams([bool $implode = true ]) : string
Parameters
- $implode : bool = true
-
Wether to implode the array or not
Return values
string —getParamsWithDefault()
Get the parameters for this method including default values
public
getParamsWithDefault([bool $implode = true ]) : string
Parameters
- $implode : bool = true
-
Wether to implode the array or not
Return values
string —getRealName()
Get the real method name
public
getRealName() : string
Return values
string —getRoot()
Return the class from which this function would be called
public
getRoot() : string
Return values
string —getRootMethodCall()
public
getRootMethodCall() : string
Return values
string —isInstanceCall()
public
isInstanceCall() : bool
Return values
bool —shouldReturn()
Should the function return a value?
public
shouldReturn() : bool
Return values
bool —convertKeywords()
Convert keywwords that are incorrect.
protected
convertKeywords(string $string) : string
Parameters
- $string : string
Return values
string —getInheritDoc()
protected
getInheritDoc(ReflectionMethod $reflectionMethod) : DocBlock
Parameters
- $reflectionMethod : ReflectionMethod
Return values
DocBlock —initClassDefinedProperties()
protected
initClassDefinedProperties(ReflectionFunctionAbstract $method, ReflectionClass $class) : mixed
Parameters
- $method : ReflectionFunctionAbstract
- $class : ReflectionClass
Return values
mixed —initPhpDoc()
protected
initPhpDoc(ReflectionFunctionAbstract $method) : mixed
Parameters
- $method : ReflectionFunctionAbstract
Return values
mixed —normalizeDescription()
Get the description and get the inherited docs.
protected
normalizeDescription(DocBlock $phpdoc) : mixed
Parameters
- $phpdoc : DocBlock
Return values
mixed —normalizeParams()
Normalize the parameters
protected
normalizeParams(DocBlock $phpdoc) : mixed
Parameters
- $phpdoc : DocBlock
Return values
mixed —normalizeReturn()
Normalize the return tag (make full namespace, replace interfaces)
protected
normalizeReturn(DocBlock $phpdoc) : mixed
Parameters
- $phpdoc : DocBlock