DependencyTree - staffcheck/api GitHub Wiki

DependencyTree

  • Class name: DependencyTree
  • Namespace:

Properties

$cache

protected mixed $cache = NULL
  • Visibility: protected

$raw_data

public mixed $raw_data = NULL
  • Visibility: public

$raw_data_order

public mixed $raw_data_order = array()
  • Visibility: public

$provide_id_raw_data

protected mixed $provide_id_raw_data = array()
  • Visibility: protected

$require_id_raw_data

protected mixed $require_id_raw_data = array()
  • Visibility: protected

$provide_ids

protected mixed $provide_ids = NULL
  • Visibility: protected

$tree

protected mixed $tree = NULL
  • Visibility: protected

$tree_ordering

protected mixed $tree_ordering = FALSE
  • Visibility: protected

Methods

getTreeOrdering

boolean DependencyTree::getTreeOrdering()
  • Visibility: public

setTreeOrdering

mixed DependencyTree::setTreeOrdering($bool)
  • Visibility: public

Arguments

  • $bool mixed

addNode

boolean DependencyTree::addNode(string $id, string|integer|array $requires, string|integer|array $provides, integer $order)
  • Visibility: public

Arguments

  • $id string - ID of node
  • $requires string|integer|array - array of IDs this node requires
  • $provides string|integer|array - array of IDs this node provides
  • $order integer - integer to help resolve circular dependencies, lower order comes first.

addObjectByProvideIDs

boolean DependencyTree::addObjectByProvideIDs(string $provide_ids, object $obj)
  • Visibility: private

Arguments

  • $provide_ids string - UUID
  • $obj object

addObjectByRequireIDs

boolean DependencyTree::addObjectByRequireIDs(string $requires_ids, object $obj)
  • Visibility: private

Arguments

  • $requires_ids string - UUID
  • $obj object

getProvideIDs

boolean|null DependencyTree::getProvideIDs()
  • Visibility: private

addProvideIDs

boolean DependencyTree::addProvideIDs($provide_arr)
  • Visibility: private

Arguments

  • $provide_arr mixed

deleteOrphanRequireIDs

boolean DependencyTree::deleteOrphanRequireIDs()
  • Visibility: private

sort

integer DependencyTree::sort($a, $b)

02-Nov-2006: changing the sort functionality to depth-based

  • Visibility: private

Arguments

  • $a mixed
  • $b mixed

markTreeNumber

mixed DependencyTree::markTreeNumber($node, $tree_number, array $marked_edges)

Traverse a tree starting with a node.

  • Visibility: public

Arguments

  • $node mixed
  • $tree_number mixed
  • $marked_edges array

_findDepth

integer DependencyTree::_findDepth(object $obj, array $marked_edges, integer $depth)

Get an object's depth by traversing all its parents (recursively) ontul there are no edges left. the count of edges is the 'depth'.

  • Visibility: public

Arguments

  • $obj object
  • $marked_edges array
  • $depth integer

_buildTree

array|boolean DependencyTree::_buildTree()
  • Visibility: public

getAllNodesInOrder

array DependencyTree::getAllNodesInOrder()
  • Visibility: public
⚠️ **GitHub.com Fallback** ⚠️