class ResetAccessRules in RNG - Events and Registrations 3.x

Modifies the reset access rules action.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Menu\LocalActionDefault implements CacheableDependencyInterface, LocalActionInterface, ContainerFactoryPluginInterface uses DependencySerializationTrait
    • class \Drupal\rng\Plugin\Menu\LocalAction\ResetAccessRules uses StringTranslationTrait

File

src/Plugin/Menu/LocalAction/ResetAccessRules.php, line 16

Namespace

Drupal\rng\Plugin\Menu\LocalAction

class ResetAccessRules extends LocalActionDefault {
  use StringTranslationTrait;

  /**
   * The RNG event manager.
   *
   * @var \Drupal\rng\EventManagerInterface
   */
  protected $eventManager;

  /**
   * The current route matcher.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $currentRoute;

  /**
   * Constructs a LocalActionDefault object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Routing\RouteProviderInterface $route_provider
   *   The route provider to load routes by name.
   * @param \Drupal\rng\EventManagerInterface $event_manager
   *   The RNG event manager.
   * @param \Drupal\Core\Routing\RouteMatchInterface $current_route
   *   The current route matcher.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, RouteProviderInterface $route_provider, EventManagerInterface $event_manager, RouteMatchInterface $current_route) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $route_provider);
    $this->eventManager = $event_manager;
    $this->currentRoute = $current_route;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('router.route_provider'), $container
      ->get('rng.event_manager'), $container
      ->get('current_route_match'));
  }

  /**
   * {@inheritdoc}
   */
  public function getTitle(Request $request = NULL) {
    $route = $this->routeProvider
      ->getRouteByName($this
      ->getRouteName());
    $param = $route
      ->getDefault('event');
    if ($event = $this->currentRoute
      ->getParameter($param)) {
      if ($this->eventManager
        ->getMeta($event)
        ->isDefaultRules('rng_event.register')) {
        return $this
          ->t('Customize access rules');
      }
      else {
        return $this
          ->t('Reset access rules to site default');
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
LocalActionDefault::$routeProvider	protected	property	The route provider to load routes by name.
LocalActionDefault::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
LocalActionDefault::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
LocalActionDefault::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
LocalActionDefault::getOptions	public	function	Returns options for rendering a link for the local action. Overrides LocalActionInterface::getOptions	2
LocalActionDefault::getRouteName	public	function	Get the route name from the settings. Overrides LocalActionInterface::getRouteName
LocalActionDefault::getRouteParameters	public	function	Returns the route parameters needed to render a link for the local action. Overrides LocalActionInterface::getRouteParameters
LocalActionDefault::getWeight	public	function	Returns the weight for the local action. Overrides LocalActionInterface::getWeight
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	2
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
ResetAccessRules::$currentRoute	protected	property	The current route matcher.
ResetAccessRules::$eventManager	protected	property	The RNG event manager.
ResetAccessRules::create	public static	function	Creates an instance of the plugin. Overrides LocalActionDefault::create
ResetAccessRules::getTitle	public	function	Returns the localized title to be shown for this action. Overrides LocalActionDefault::getTitle
ResetAccessRules::__construct	public	function	Constructs a LocalActionDefault object. Overrides LocalActionDefault::__construct
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.