Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Core\Menu;
Chris@0: 
Chris@0: use Drupal\Component\Plugin\Exception\PluginException;
Chris@0: use Drupal\Core\Cache\Cache;
Chris@0: use Drupal\Core\Plugin\PluginBase;
Chris@0: use Drupal\Core\Url;
Chris@0: 
Chris@0: /**
Chris@0:  * Defines a base menu link class.
Chris@0:  */
Chris@0: abstract class MenuLinkBase extends PluginBase implements MenuLinkInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * The list of definition values where an override is allowed.
Chris@0:    *
Chris@0:    * The keys are definition names. The values are ignored.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $overrideAllowed = [];
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getWeight() {
Chris@0:     // By default the weight is 0.
Chris@0:     if (!isset($this->pluginDefinition['weight'])) {
Chris@0:       $this->pluginDefinition['weight'] = 0;
Chris@0:     }
Chris@0:     return $this->pluginDefinition['weight'];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getMenuName() {
Chris@0:     return $this->pluginDefinition['menu_name'];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getProvider() {
Chris@0:     return $this->pluginDefinition['provider'];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getParent() {
Chris@0:     return $this->pluginDefinition['parent'];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function isEnabled() {
Chris@0:     return (bool) $this->pluginDefinition['enabled'];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function isExpanded() {
Chris@0:     return (bool) $this->pluginDefinition['expanded'];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function isResettable() {
Chris@0:     return FALSE;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function isTranslatable() {
Chris@0:     return (bool) $this->getTranslateRoute();
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function isDeletable() {
Chris@0:     return (bool) $this->getDeleteRoute();
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getOptions() {
Chris@0:     return $this->pluginDefinition['options'] ?: [];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getMetaData() {
Chris@0:     return $this->pluginDefinition['metadata'] ?: [];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getRouteName() {
Chris@0:     return isset($this->pluginDefinition['route_name']) ? $this->pluginDefinition['route_name'] : '';
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getRouteParameters() {
Chris@0:     return isset($this->pluginDefinition['route_parameters']) ? $this->pluginDefinition['route_parameters'] : [];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getUrlObject($title_attribute = TRUE) {
Chris@0:     $options = $this->getOptions();
Chris@0:     if ($title_attribute && $description = $this->getDescription()) {
Chris@0:       $options['attributes']['title'] = $description;
Chris@0:     }
Chris@0:     if (empty($this->pluginDefinition['url'])) {
Chris@0:       return new Url($this->getRouteName(), $this->getRouteParameters(), $options);
Chris@0:     }
Chris@0:     else {
Chris@0:       return Url::fromUri($this->pluginDefinition['url'], $options);
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getFormClass() {
Chris@0:     return $this->pluginDefinition['form_class'];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getDeleteRoute() {
Chris@0:     return NULL;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getEditRoute() {
Chris@0:     return NULL;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getTranslateRoute() {
Chris@0:     return NULL;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function deleteLink() {
Chris@0:     throw new PluginException("Menu link plugin with ID '{$this->getPluginId()}' does not support deletion");
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getCacheMaxAge() {
Chris@0:     return Cache::PERMANENT;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getCacheContexts() {
Chris@0:     return [];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getCacheTags() {
Chris@0:     return [];
Chris@0:   }
Chris@0: 
Chris@0: }