Relations

Analyses the extracted tokens and finds the relations and links and replaces linkables with links.
Source
Relations.php
Depends on
Extract
Since
Artaengine 1.4

Methods

__construct

Relations $obj = new Relations(array configs)

Constructor.

Arguments

    configs (array)
    relations configs

Returns

void

addAllInterfaces

array $obj->addAllInterfaces(array namespaces)

Add the extended interfaces of interfaces to class implement list. e.g. class x implements interface ix and interface ix extends iy and iz, this method will find iy and iz and will add them to class x.

Arguments

    namespaces (array)
    The array returned from "arta\doxer\Extract"

Returns

array
namespaces The updated "arta\doxer\Extract" array

addInterfaceImplementings

array $obj->addInterfaceImplementings(array namespaces)

Add the classes which implement an interface to it.

Arguments

    namespaces (array)
    The array returned from "arta\doxer\Extract"

Returns

array
namespaces The updated "arta\doxer\Extract" array

addParentMembers

array $obj->addParentMembers(array namespaces)

Merge the documentations of parent's public and protected members to child's documentations. Updated the result of "arta\doxer\Extract".

Arguments

    namespaces (array)
    The array returned from "arta\doxer\Extract"

Returns

array
namespaces The updated "arta\doxer\Extract" array