interface/modules/zend_modules/library/Zend/Server/Reflection/Node.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Server\Reflection;
  11
  12 /**
  13  * Node Tree class for Zend\Server reflection operations
  14  */
  15 class Node
  16 {
  17     /**
  18      * Node value
  19      * @var mixed
  20      */
  21     protected $value = null;
  22
  23     /**
  24      * Array of child nodes (if any)
  25      * @var array
  26      */
  27     protected $children = array();
  28
  29     /**
  30      * Parent node (if any)
  31      * @var \Zend\Server\Reflection\Node
  32      */
  33     protected $parent = null;
  34
  35     /**
  36      * Constructor
  37      *
  38      * @param mixed $value
  39      * @param \Zend\Server\Reflection\Node $parent Optional
  40      * @return \Zend\Server\Reflection\Node
  41      */
  42     public function __construct($value, Node $parent = null)
  43     {
  44         $this->value = $value;
  45         if (null !== $parent) {
  46             $this->setParent($parent, true);
  47         }
  48
  49         return $this;
  50     }
  51
  52     /**
  53      * Set parent node
  54      *
  55      * @param \Zend\Server\Reflection\Node $node
  56      * @param  bool $new Whether or not the child node is newly created
  57      * and should always be attached
  58      * @return void
  59      */
  60     public function setParent(Node $node, $new = false)
  61     {
  62         $this->parent = $node;
  63
  64         if ($new) {
  65             $node->attachChild($this);
  66             return;
  67         }
  68     }
  69
  70     /**
  71      * Create and attach a new child node
  72      *
  73      * @param mixed $value
  74      * @access public
  75      * @return \Zend\Server\Reflection\Node New child node
  76      */
  77     public function createChild($value)
  78     {
  79         $child = new static($value, $this);
  80
  81         return $child;
  82     }
  83
  84     /**
  85      * Attach a child node
  86      *
  87      * @param \Zend\Server\Reflection\Node $node
  88      * @return void
  89      */
  90     public function attachChild(Node $node)
  91     {
  92         $this->children[] = $node;
  93
  94         if ($node->getParent() !== $this) {
  95             $node->setParent($this);
  96         }
  97     }
  98
  99     /**
 100      * Return an array of all child nodes
 101      *
 102      * @return array
 103      */
 104     public function getChildren()
 105     {
 106         return $this->children;
 107     }
 108
 109     /**
 110      * Does this node have children?
 111      *
 112      * @return bool
 113      */
 114     public function hasChildren()
 115     {
 116         return count($this->children) > 0;
 117     }
 118
 119     /**
 120      * Return the parent node
 121      *
 122      * @return null|\Zend\Server\Reflection\Node
 123      */
 124     public function getParent()
 125     {
 126         return $this->parent;
 127     }
 128
 129     /**
 130      * Return the node's current value
 131      *
 132      * @return mixed
 133      */
 134     public function getValue()
 135     {
 136         return $this->value;
 137     }
 138
 139     /**
 140      * Set the node value
 141      *
 142      * @param mixed $value
 143      * @return void
 144      */
 145     public function setValue($value)
 146     {
 147         $this->value = $value;
 148     }
 149
 150     /**
 151      * Retrieve the bottommost nodes of this node's tree
 152      *
 153      * Retrieves the bottommost nodes of the tree by recursively calling
 154      * getEndPoints() on all children. If a child is null, it returns the parent
 155      * as an end point.
 156      *
 157      * @return array
 158      */
 159     public function getEndPoints()
 160     {
 161         $endPoints = array();
 162         if (!$this->hasChildren()) {
 163             return $endPoints;
 164         }
 165
 166         foreach ($this->children as $child) {
 167             $value = $child->getValue();
 168
 169             if (null === $value) {
 170                 $endPoints[] = $this;
 171             } elseif ((null !== $value)
 172                 && $child->hasChildren())
 173             {
 174                 $childEndPoints = $child->getEndPoints();
 175                 if (!empty($childEndPoints)) {
 176                     $endPoints = array_merge($endPoints, $childEndPoints);
 177                 }
 178             } elseif ((null !== $value) && !$child->hasChildren()) {
 179                 $endPoints[] = $child;
 180             }
 181         }
 182
 183         return $endPoints;
 184     }
 185 }