PHPXRef 0.7.1 : phpBB-3.2.11-deutsch : Detail view of TraitUsageInterface.php

Interface: TraitUsageInterface - X-Ref

Zend Framework (http://framework.zend.com/)

Add a class to "use" classes

param: string $use
param: string|null $useAlias
return: self

Returns the "use" classes

return: array

Add trait takes an array of trait options or string as arguments.

Array Format:
key: traitName value: String

key: aliases value: array of arrays
key: method value: @see addTraitAlias
key: alias value: @see addTraitAlias
key: visibility value: @see addTraitAlias

key: insteadof value: array of arrays
key: method value: @see self::addTraitOverride
key: traitToReplace value: @see self::addTraitOverride

param: mixed $trait String | Array
return: self

addTraits(array $traits) X-Ref

Add multiple traits. Trait can be an array of trait names or array of trait
configurations

param: array $traitName Array of string names or configurations (@see addTrait)
return: self

hasTrait($traitName) X-Ref

Check to see if the class has a trait defined

param: strint $traitName
return: bool

getTraits() X-Ref

Get a list of trait names

return: array

removeTrait($traitName) X-Ref

Remove a trait by its name

param: $traitName

addTraitAlias($method, $alias, $visibility = null) X-Ref

Add a trait alias. This will be used to generate the AS portion of the use statement.

$method:
This method provides 2 ways for defining the trait method.
Option 1: String
Option 2: Array
key: traitName value: name of trait
key: method value: trait method

$alias:
Alias is a string representing the new method name.

$visibilty:
ReflectionMethod::IS_PUBLIC | ReflectionMethod::IS_PRIVATE| ReflectionMethod::IS_PROTECTED

param: mixed $method String or Array
param: string $alias
param: int $visiblity

getTraitAliases() X-Ref

return: array

addTraitOverride($method, $traitsToReplace) X-Ref

Add a trait method override. This will be used to generate the INSTEADOF portion of the use
statement.

$method:
This method provides 2 ways for defining the trait method.
Option 1: String Format: <trait name>::<method name>
Option 2: Array
key: traitName value: trait name
key: method value: method name

$traitToReplace:
The name of the trait that you wish to supersede.

This method provides 2 ways for defining the trait method.
Option 1: String of trait to replace
Option 2: Array of strings of traits to replace
param: mixed $method
param: mixed $traitToReplace

removeTraitOverride($method, $overridesToRemove = null) X-Ref

Remove an override for a given trait::method

$method:
This method provides 2 ways for defining the trait method.
Option 1: String Format: <trait name>::<method name>
Option 2: Array
key: traitName value: trait name
key: method value: method name

$overridesToRemove:
The name of the trait that you wish to remove.

This method provides 2 ways for defining the trait method.
Option 1: String of trait to replace
Option 2: Array of strings of traits to replace

param: $traitAndMethod
param: null $overridesToRemove
return: $this

getTraitOverrides() X-Ref

Return trait overrides

return: array

File Size:	159 lines (4 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of phpBB-3.2.11-deutsch

/vendor/zendframework/zend-code/src/Generator/ -> TraitUsageInterface.php (summary)

Defines 1 class