123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214 |
- <?php
- namespace Drupal\Core\Menu;
- /**
- * Provides a value object to model menu tree parameters.
- *
- * Menu tree parameters are used to determine the set of definitions to be
- * loaded from \Drupal\Core\Menu\MenuTreeStorageInterface. Hence they determine
- * the shape and content of the tree:
- * - Which parent IDs should be used to restrict the tree. Only links with
- * a parent in the list will be included.
- * - Which menu links are omitted, depending on the minimum and maximum depth.
- */
- class MenuTreeParameters {
- /**
- * A menu link plugin ID that should be used as the root.
- *
- * By default the root ID of empty string '' is used. However, when only the
- * descendants (subtree) of a certain menu link are needed, a custom root can
- * be specified.
- *
- * @var string
- */
- public $root = '';
- /**
- * The minimum depth of menu links in the resulting tree relative to the root.
- *
- * Defaults to 1, which is the default to build a whole tree for a menu
- * (excluding the root).
- *
- * @var int|null
- */
- public $minDepth = NULL;
- /**
- * The maximum depth of menu links in the resulting tree relative to the root.
- *
- * @var int|null
- */
- public $maxDepth = NULL;
- /**
- * An array of parent link IDs.
- *
- * This restricts the tree to only menu links that are at the top level or
- * have a parent ID in this list. If empty, the whole menu tree is built.
- *
- * @var string[]
- */
- public $expandedParents = [];
- /**
- * The IDs from the currently active menu link to the root of the whole tree.
- *
- * This is an array of menu link plugin IDs, representing the trail from the
- * currently active menu link to the ("real") root of that menu link's menu.
- * This does not affect the way the tree is built. It is only used to set the
- * value of the inActiveTrail property for each tree element.
- *
- * @var string[]
- */
- public $activeTrail = [];
- /**
- * The conditions used to restrict which links are loaded.
- *
- * An associative array of custom query condition key/value pairs.
- *
- * @var array
- */
- public $conditions = [];
- /**
- * Sets a root for menu tree loading.
- *
- * @param string $root
- * A menu link plugin ID, or empty string '' to use the root of the whole
- * tree.
- *
- * @return $this
- *
- * @codeCoverageIgnore
- */
- public function setRoot($root) {
- $this->root = (string) $root;
- return $this;
- }
- /**
- * Sets a minimum depth for menu tree loading.
- *
- * @param int $min_depth
- * The (root-relative) minimum depth to apply.
- *
- * @return $this
- */
- public function setMinDepth($min_depth) {
- $this->minDepth = max(1, $min_depth);
- return $this;
- }
- /**
- * Sets a maximum depth for menu tree loading.
- *
- * @param int $max_depth
- * The (root-relative) maximum depth to apply.
- *
- * @return $this
- *
- * @codeCoverageIgnore
- */
- public function setMaxDepth($max_depth) {
- $this->maxDepth = $max_depth;
- return $this;
- }
- /**
- * Adds parent menu links IDs to restrict the tree.
- *
- * @param string[] $parents
- * An array containing parent IDs. If supplied, the tree is limited to
- * links that have these parents.
- *
- * @return $this
- */
- public function addExpandedParents(array $parents) {
- $this->expandedParents = array_merge($this->expandedParents, $parents);
- $this->expandedParents = array_unique($this->expandedParents);
- return $this;
- }
- /**
- * Sets the active trail IDs used to set the inActiveTrail property.
- *
- * @param string[] $active_trail
- * An array containing the active trail: a list of menu link plugin IDs.
- *
- * @return $this
- *
- * @see \Drupal\Core\Menu\MenuActiveTrail::getActiveTrailIds()
- *
- * @codeCoverageIgnore
- */
- public function setActiveTrail(array $active_trail) {
- $this->activeTrail = $active_trail;
- return $this;
- }
- /**
- * Adds a custom query condition.
- *
- * @param string $definition_field
- * Only conditions that are testing menu link definition fields are allowed.
- * @param mixed $value
- * The value to test the link definition field against. In most cases, this
- * is a scalar. For more complex options, it is an array. The meaning of
- * each element in the array is dependent on the $operator.
- * @param string|null $operator
- * (optional) The comparison operator, such as =, <, or >=. It also accepts
- * more complex options such as IN, LIKE, or BETWEEN. If NULL, defaults to
- * the = operator.
- *
- * @return $this
- */
- public function addCondition($definition_field, $value, $operator = NULL) {
- if (!isset($operator)) {
- $this->conditions[$definition_field] = $value;
- }
- else {
- $this->conditions[$definition_field] = [$value, $operator];
- }
- return $this;
- }
- /**
- * Excludes links that are not enabled.
- *
- * @return $this
- */
- public function onlyEnabledLinks() {
- $this->addCondition('enabled', 1);
- return $this;
- }
- /**
- * Ensures only the top level of the tree is loaded.
- *
- * @return $this
- */
- public function setTopLevelOnly() {
- $this->setMaxDepth(1);
- return $this;
- }
- /**
- * Excludes the root menu link from the tree.
- *
- * Note that this is only necessary when you specified a custom root, because
- * the normal root ID is the empty string, '', which does not correspond to an
- * actual menu link. Hence when loading a menu link tree without specifying a
- * custom root the tree will start at the children even if this method has not
- * been called.
- *
- * @return $this
- */
- public function excludeRoot() {
- $this->setMinDepth(1);
- return $this;
- }
- }
|