Documentation

Alias
in package

Table of Contents

$alias  : mixed
$classes  : mixed
$classType  : mixed
$config  : Repository
$extends  : mixed
$extendsClass  : mixed
$extendsNamespace  : mixed
$facade  : mixed
$interfaces  : mixed
$magicMethods  : mixed
$methods  : mixed
$namespace  : mixed
$phpdoc  : mixed
$root  : mixed
$short  : mixed
$usedMethods  : mixed
$valid  : mixed
__construct()  : mixed
addClass()  : mixed
Add one or more classes to analyze
getAlias()  : string
Get the Alias by which this class is called
getClasstype()  : string
Get the classtype, 'interface' or 'class'
getDocComment()  : mixed
getExtends()  : null|string
Get the class which this alias extends
getExtendsClass()  : null|string
Get the class short name which this alias extends
getExtendsNamespace()  : null|string
Get the namespace of the class which this alias extends
getMethods()  : array<string|int, mixed>|array<string|int, Method>
Get the methods found by this Alias
getNamespace()  : string
Get the namespace from the alias
getShortName()  : mixed
Return the short name (without namespace)
isValid()  : bool
Check if this class is valid to process.
addMagicMethods()  : mixed
Add magic methods, as defined in the configuration files
detectClassType()  : mixed
Detect the class type
detectExtendsNamespace()  : mixed
Detect the extends namespace
detectFake()  : mixed
Detect class returned by ::fake()
detectMethods()  : string
Get the methods for one or multiple classes.
detectNamespace()  : mixed
Detect the namespace
detectRoot()  : bool|string
Get the real root of a facade
error()  : void
Output an error.
getMacroFunction()  : ReflectionFunctionAbstract
isTrait()  : bool
Detect if this class is a trait or not.
removeDuplicateMethodsFromPhpDoc()  : void
Removes method tags from the doc comment that already appear as functions inside the class.

Properties

$alias

protected mixed $alias

$classes

protected mixed $classes = array()

$classType

protected mixed $classType = 'class'

$extends

protected mixed $extends = null

$extendsClass

protected mixed $extendsClass = null

$extendsNamespace

protected mixed $extendsNamespace = null

$facade

protected mixed $facade
Tags
psalm-var

class-string $facade

$interfaces

protected mixed $interfaces = array()

$magicMethods

protected mixed $magicMethods = array()

$methods

protected mixed $methods = array()

$namespace

protected mixed $namespace = '__root'

$phpdoc

protected mixed $phpdoc = null

$root

protected mixed $root = null

$short

protected mixed $short

$usedMethods

protected mixed $usedMethods = array()

$valid

protected mixed $valid = false

Methods

__construct()

public __construct(Repository $config, string $alias, string $facade[, array<string|int, mixed> $magicMethods = array() ][, array<string|int, mixed> $interfaces = array() ]) : mixed
Parameters
$config : Repository
$alias : string
$facade : string
$magicMethods : array<string|int, mixed> = array()
$interfaces : array<string|int, mixed> = array()
Tags
psalm-param

class-string $facade

Return values
mixed —

addClass()

Add one or more classes to analyze

public addClass(array<string|int, mixed>|string $classes) : mixed
Parameters
$classes : array<string|int, mixed>|string
Return values
mixed —

getAlias()

Get the Alias by which this class is called

public getAlias() : string
Return values
string —

getClasstype()

Get the classtype, 'interface' or 'class'

public getClasstype() : string
Return values
string —

getDocComment()

public getDocComment([mixed $prefix = " " ]) : mixed
Parameters
$prefix : mixed = " "
Return values
mixed —

getExtends()

Get the class which this alias extends

public getExtends() : null|string
Return values
null|string —

getExtendsClass()

Get the class short name which this alias extends

public getExtendsClass() : null|string
Return values
null|string —

getExtendsNamespace()

Get the namespace of the class which this alias extends

public getExtendsNamespace() : null|string
Return values
null|string —

getMethods()

Get the methods found by this Alias

public getMethods() : array<string|int, mixed>|array<string|int, Method>
Return values
array<string|int, mixed>|array<string|int, Method> —

getNamespace()

Get the namespace from the alias

public getNamespace() : string
Return values
string —

getShortName()

Return the short name (without namespace)

public getShortName() : mixed
Return values
mixed —

isValid()

Check if this class is valid to process.

public isValid() : bool
Return values
bool —

addMagicMethods()

Add magic methods, as defined in the configuration files

protected addMagicMethods() : mixed
Return values
mixed —

detectClassType()

Detect the class type

protected detectClassType() : mixed
Return values
mixed —

detectExtendsNamespace()

Detect the extends namespace

protected detectExtendsNamespace() : mixed
Return values
mixed —

detectFake()

Detect class returned by ::fake()

protected detectFake() : mixed
Return values
mixed —

detectMethods()

Get the methods for one or multiple classes.

protected detectMethods() : string
Return values
string —

detectNamespace()

Detect the namespace

protected detectNamespace() : mixed
Return values
mixed —

detectRoot()

Get the real root of a facade

protected detectRoot() : bool|string
Return values
bool|string —

error()

Output an error.

protected error(string $string) : void
Parameters
$string : string
Return values
void —

getMacroFunction()

protected getMacroFunction( $macro_func) : ReflectionFunctionAbstract
Parameters
$macro_func :
Tags
throws
ReflectionException
Return values
ReflectionFunctionAbstract —

isTrait()

Detect if this class is a trait or not.

protected isTrait() : bool
Return values
bool —

removeDuplicateMethodsFromPhpDoc()

Removes method tags from the doc comment that already appear as functions inside the class.

protected removeDuplicateMethodsFromPhpDoc() : void

This prevents duplicate function errors in the IDE.

Return values
void —

Search results