\phpDocumentor\Compiler\LinkerLinker

The linker contains all rules to replace FQSENs in the ProjectDescriptor with aliases to objects.

This object contains a list of class FQCNs for Descriptors and their associated linker rules.

An example scenario should be:

The Descriptor ``\phpDocumentor\Descriptor\ClassDescriptor`` has a *Substitute* rule determining that the
contents of the ``Parent`` field should be substituted with another ClassDescriptor with the FQCN
represented by the value of the Parent field. In addition (second element) it has an *Analyse* rule
specifying that the contents of the ``Methods`` field should be interpreted by the linker. Because that field
contains an array or Descriptor Collection will each element be analysed by the linker.

As can be seen in the above example is it possible to analyse a tree structure and substitute FQSENs where encountered.

Summary

Methods
Properties
Constants
getDescription()
__construct()
execute()
getSubstitutions()
substitute()
No public properties found
COMPILER_PRIORITY
No protected methods found
No protected properties found
N/A
substituteChildrenOfCollection()
findFieldValue()
isDescriptorContainer()
substituteMembersOfObject()
$substitutions
$processedObjects
$descriptorRepository
N/A

Constants

COMPILER_PRIORITY

COMPILER_PRIORITY = 10000

Properties

$substitutions

$substitutions : array<class-string,string[]>

Type

array

$processedObjects

$processedObjects : string[]

Type

string[] — Prevent cycles by tracking which objects have been analyzed

$descriptorRepository

$descriptorRepository : \phpDocumentor\Compiler\Linker\DescriptorRepository

Type

DescriptorRepository

Methods

getDescription()

getDescription() : string

Returns a textual description of what this pass does for output purposes.

Please note that the command line will be truncated to 68 characters ( .. 000.000s) so longer descriptions won't have much use.

Returns

string —

__construct()

__construct(array<class-string,string[]>  $substitutions, \phpDocumentor\Compiler\Linker\DescriptorRepository  $descriptorRepository) : mixed

Initializes the linker with a series of Descriptors to link to.

Parameters

array $substitutions
\phpDocumentor\Compiler\Linker\DescriptorRepository $descriptorRepository

Returns

mixed —

execute()

execute(\phpDocumentor\Descriptor\ProjectDescriptor  $project) : void

Executes a compiler pass.

This method will execute the business logic associated with a given compiler pass and allow it to manipulate or consumer the Object Graph using the ProjectDescriptor object.

Parameters

\phpDocumentor\Descriptor\ProjectDescriptor $project

Representation of the Object Graph that can be manipulated.

getSubstitutions()

getSubstitutions() : string[][]

Returns the list of substitutions for the linker.

Returns

string[][] —

substitute()

substitute(string|\phpDocumentor\Reflection\Fqsen|\phpDocumentor\Reflection\Type|\phpDocumentor\Descriptor\Collection<mixed>|array|\phpDocumentor\Descriptor\Descriptor  $item, ?\phpDocumentor\Descriptor\DescriptorAbstract  $container = null) : string|\phpDocumentor\Descriptor\DescriptorAbstract|\phpDocumentor\Descriptor\Collection<string|\phpDocumentor\Descriptor\DescriptorAbstract>|(string|\phpDocumentor\Descriptor\DescriptorAbstract)[]|null

Substitutes the given item or its children's FQCN with an object alias.

This method may do either of the following depending on the item's type

FQSEN or String If the given item is a string then this method will attempt to find an appropriate Class, Interface or TraitDescriptor object and return that. See {@see} for more information on the normalization of these strings.

Array or Traversable Iterate through each item, pass each key's contents to a new call to substitute and replace the key's contents if the contents is not an object (objects automatically update and this saves performance).

Object Determines all eligible substitutions using the substitutions property, construct a getter and retrieve the field's contents. Pass these contents to a new call of substitute and use a setter to replace the field's contents if anything other than null is returned.

The Container is a descriptor that acts as container for all elements underneath or null if there is no current container.

This method will return null if no substitution was possible and all of the above should not update the parent item when null is passed.

Parameters

string|\phpDocumentor\Reflection\Fqsen|\phpDocumentor\Reflection\Type|\phpDocumentor\Descriptor\Collection|array|\phpDocumentor\Descriptor\Descriptor $item
?\phpDocumentor\Descriptor\DescriptorAbstract $container

Returns

string|\phpDocumentor\Descriptor\DescriptorAbstract|\phpDocumentor\Descriptor\Collection|(string|\phpDocumentor\Descriptor\DescriptorAbstract)[]|null —

substituteChildrenOfCollection()

substituteChildrenOfCollection((string|\phpDocumentor\Descriptor\DescriptorAbstract)[]|\phpDocumentor\Descriptor\Collection<string|\phpDocumentor\Descriptor\DescriptorAbstract>  $collection, ?\phpDocumentor\Descriptor\DescriptorAbstract  $container) : (string|\phpDocumentor\Descriptor\DescriptorAbstract)[]|\phpDocumentor\Descriptor\Collection<string|\phpDocumentor\Descriptor\DescriptorAbstract>|null

Parameters

(string|\phpDocumentor\Descriptor\DescriptorAbstract)[]|\phpDocumentor\Descriptor\Collection $collection
?\phpDocumentor\Descriptor\DescriptorAbstract $container

Returns

(string|\phpDocumentor\Descriptor\DescriptorAbstract)[]|\phpDocumentor\Descriptor\Collection|null —

findFieldValue()

findFieldValue(object  $object, string  $fieldName) : string|object

Returns the value of a field in the given object.

Parameters

object $object
string $fieldName

Returns

string|object —

isDescriptorContainer()

isDescriptorContainer(object  $item) : bool

Returns true if the given Descriptor is a container type.

Parameters

object $item

Returns

bool —

substituteMembersOfObject()

substituteMembersOfObject(object  $object, ?\phpDocumentor\Descriptor\DescriptorAbstract  $container) : void

Parameters

object $object
?\phpDocumentor\Descriptor\DescriptorAbstract $container