Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Core\Menu;
Chris@0: 
Chris@0: /**
Chris@0:  * Provides a value object to model an element in a menu link tree.
Chris@0:  *
Chris@0:  * \Drupal\Core\Menu\MenuLinkTreeElement objects represent a menu link's data.
Chris@0:  * Objects of this class provide complimentary data: the placement in a tree.
Chris@0:  * Therefore, we can summarize this split as follows:
Chris@0:  * - Menu link objects contain all information about an individual menu link,
Chris@0:  *   plus what their parent is. But they don't know where exactly in a menu link
Chris@0:  *   tree they live.
Chris@0:  * - Instances of this class are complimentary to those objects, they know:
Chris@0:  *   - All additional metadata from {menu_tree}, which contains "materialized"
Chris@0:  *     metadata about a menu link tree, such as whether a link in the tree has
Chris@0:  *     visible children and the depth relative to the root.
Chris@0:  *   - Plus all additional metadata that's adjusted for the current tree query,
Chris@0:  *     such as whether the link is in the active trail, whether the link is
Chris@0:  *     accessible for the current user, and the link's children (which are only
Chris@0:  *     loaded if the link was marked as "expanded" by the query).
Chris@0:  *
Chris@0:  * @see \Drupal\Core\Menu\MenuTreeStorage::loadTreeData()
Chris@0:  */
Chris@0: class MenuLinkTreeElement {
Chris@0: 
Chris@0:   /**
Chris@0:    * The menu link for this element in a menu link tree.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Menu\MenuLinkInterface
Chris@0:    */
Chris@0:   public $link;
Chris@0: 
Chris@0:   /**
Chris@0:    * The subtree of this element in the menu link tree (this link's children).
Chris@0:    *
Chris@0:    * (Children of a link are only loaded if a link is marked as "expanded" by
Chris@0:    * the query.)
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Menu\MenuLinkTreeElement[]
Chris@0:    */
Chris@0:   public $subtree;
Chris@0: 
Chris@0:   /**
Chris@0:    * The depth of this link relative to the root of the tree.
Chris@0:    *
Chris@0:    * @var int
Chris@0:    */
Chris@0:   public $depth;
Chris@0: 
Chris@0:   /**
Chris@0:    * Whether this link has any children at all.
Chris@0:    *
Chris@0:    * @var bool
Chris@0:    */
Chris@0:   public $hasChildren;
Chris@0: 
Chris@0:   /**
Chris@0:    * Whether this link is in the active trail.
Chris@0:    *
Chris@0:    * @var bool
Chris@0:    */
Chris@0:   public $inActiveTrail;
Chris@0: 
Chris@0:   /**
Chris@0:    * Whether this link is accessible by the current user.
Chris@0:    *
Chris@0:    * If the value is NULL the access was not determined yet, if an access result
Chris@0:    * object, it was determined already.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Access\AccessResultInterface|null
Chris@0:    */
Chris@0:   public $access;
Chris@0: 
Chris@0:   /**
Chris@0:    * Additional options for this link.
Chris@0:    *
Chris@0:    * This is merged (\Drupal\Component\Utility\NestedArray::mergeDeep()) with
Chris@0:    * \Drupal\Core\Menu\MenuLinkInterface::getOptions(), to allow menu link tree
Chris@0:    * manipulators to add or override link options.
Chris@0:    */
Chris@0:   public $options = [];
Chris@0: 
Chris@0:   /**
Chris@0:    * Constructs a new \Drupal\Core\Menu\MenuLinkTreeElement.
Chris@0:    *
Chris@0:    * @param \Drupal\Core\Menu\MenuLinkInterface $link
Chris@0:    *   The menu link for this element in the menu link tree.
Chris@0:    * @param bool $has_children
Chris@0:    *   A flag as to whether this element has children even if they are not
Chris@0:    *   included in the tree (i.e. this may be TRUE even if $subtree is empty).
Chris@0:    * @param int $depth
Chris@0:    *   The depth of this element relative to the tree root.
Chris@0:    * @param bool $in_active_trail
Chris@0:    *   A flag as to whether this link was included in the list of active trail
Chris@0:    *   IDs used to build the tree.
Chris@0:    * @param \Drupal\Core\Menu\MenuLinkTreeElement[] $subtree
Chris@0:    *   The children of this element in the menu link tree.
Chris@0:    */
Chris@0:   public function __construct(MenuLinkInterface $link, $has_children, $depth, $in_active_trail, array $subtree) {
Chris@0:     // Essential properties.
Chris@0:     $this->link = $link;
Chris@0:     $this->hasChildren = $has_children;
Chris@0:     $this->depth = $depth;
Chris@0:     $this->subtree = $subtree;
Chris@0:     $this->inActiveTrail = $in_active_trail;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Counts all menu links in the current subtree.
Chris@0:    *
Chris@0:    * @return int
Chris@0:    *   The number of menu links in this subtree (one plus the number of menu
Chris@0:    *   links in all descendants).
Chris@0:    */
Chris@0:   public function count() {
Chris@0:     $sum = function ($carry, MenuLinkTreeElement $element) {
Chris@0:       return $carry + $element->count();
Chris@0:     };
Chris@0:     return 1 + array_reduce($this->subtree, $sum);
Chris@0:   }
Chris@0: 
Chris@0: }