| Methods |
public
static
|
getAllClassDocComments(ReflectionClass<object> $class): array<class-string, string>
Get an array of doc comments for a class and its parents
Get an array of doc comments for a class and its parents
Returns an empty array if no doc comments are found for the class or any
inherited classes or interfaces.
|
#
|
public
static
|
getAllMethodDocComments<T is ReflectionClass|null>(
ReflectionMethod $method,
T $fromClass = null,
array<class-string, string|null>|null &$classDocComments = null,
): (T is null ? array<class-string, string> : array<class-string, string|null>)
Get an array of doc comments for a method from its declaring class and
its parents
Get an array of doc comments for a method from its declaring class and
its parents
Returns an empty array if no doc comments are found in the declaring
class or in any inherited classes, interfaces or traits.
Parameters
| $fromClass |
If given, entries are returned for $fromClass and
every parent with $method, including any without doc comments or
where $method is not declared.
|
| $classDocComments |
If given,
receives the doc comment of the declaring class for each entry in the
return value.
|
|
#
|
public
static
|
getAllPropertyDocComments(
ReflectionProperty $property,
array<class-string, string|null>|null &$classDocComments = null,
): array<class-string, string>
Get an array of doc comments for a property from its declaring class and
its parents
Get an array of doc comments for a property from its declaring class and
its parents
Returns an empty array if no doc comments are found in the declaring
class or in any inherited classes or traits.
Parameters
| $classDocComments |
If given,
receives the doc comment of the declaring class for each entry in the
return value.
|
|
#
|
public
static
|
getParameterPHPDoc(
ReflectionParameter $parameter,
string $classPrefix = '\\',
(callable(class-string): (string|null))|null $callback = null,
string|null $type = null,
?string $name = null,
?string $documentation = null,
bool $force = false,
): ?string
Convert a ReflectionParameter to a PHPDoc tag
Convert a ReflectionParameter to a PHPDoc tag
Returns null if:
-
$force is not set,
-
$documentation is empty or null, and
- there is no difference between PHPDoc and native data types
Parameters
| $callback |
Applied to
qualified class names if given. Must return null or an unqualified
alias.
|
| $type |
If set, ignore the parameter's declared type and
use $type instead.
|
|
#
|
public
static
|
getParameterDeclaration(
ReflectionParameter $parameter,
string $classPrefix = '\\',
(callable(class-string): (string|null))|null $callback = null,
string|null $type = null,
?string $name = null,
bool $phpDoc = false,
): string
Convert a ReflectionParameter to a PHP parameter declaration
Convert a ReflectionParameter to a PHP parameter declaration
Parameters
| $callback |
Applied to
qualified class names if given. Must return null or an unqualified
alias.
|
| $type |
If set, ignore the parameter's declared type and
use $type instead. Do not use when generating code unless $type is
from a trusted source.
|
|
#
|
public
static
|
getTypeDeclaration(
?ReflectionType $type,
string $classPrefix = '\\',
(callable(class-string): (string|null))|null $callback = null,
bool $phpDoc = false,
): string
Convert a ReflectionType to a PHP type declaration
Convert a ReflectionType to a PHP type declaration
Parameters
| $callback |
Applied to
qualified class names if given. Must return null or an unqualified
alias.
|
|
#
|