You are here

Home » API reference » Views Advanced Routing 8 » AdvancedRouting.php

class AdvancedRouting in Views Advanced Routing 8

Same name and namespace in other branches
  1. 2.x src/Plugin/views/display_extender/AdvancedRouting.php \Drupal\views_advanced_routing\Plugin\views\display_extender\AdvancedRouting

Advanced route editor.

Plugin annotation


@ViewsDisplayExtender(
  id = "views_advanced_routing_route",
  title = @Translation("Route")
)

Hierarchy

Expanded class hierarchy of AdvancedRouting

File

src/Plugin/views/display_extender/AdvancedRouting.php, line 25
Contains \Drupal\views_test_data\Plugin\views\display_extender\DisplayExtenderTest.

Namespace

Drupal\views_advanced_routing\Plugin\views\display_extender
View source 
class AdvancedRouting extends DisplayExtenderPluginBase {

  /**
   * Stores some state booleans to be sure a certain method got called.
   *
   * @var array
   */
  public $testState;

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();

    // YAML.
    $options['route'] = [
      'default' => '',
    ];
    return $options;
  }

  /**
   * Overrides Drupal\views\Plugin\views\display\DisplayPluginBase::optionsSummary().
   *
   * $options keys is section as used by buildOptionsForm().
   */
  public function optionsSummary(&$categories, &$options) {
    if (!$this->displayHandler instanceof DisplayRouterInterface) {
      return;
    }
    parent::optionsSummary($categories, $options);
    $categories['views_advanced_routing'] = [
      'title' => '',
      'column' => 'second',
      'build' => [
        // Page settings is -10, Access is -5.
        '#weight' => -6,
      ],
    ];
    $message = [];
    $route = $this->options['route'];
    if (!empty($route['defaults'])) {
      $message[] = $this
        ->t('Defaults');
    }
    if (!empty($route['requirements'])) {
      $message[] = $this
        ->t('Requirements');
    }
    if (!empty($route['options'])) {
      $message[] = $this
        ->t('Options');
    }
    $options['views_advanced_routing_route'] = [
      'category' => 'views_advanced_routing',
      'title' => $this
        ->t('Route'),
      'value' => implode(' | ', $message) ?: $this
        ->t('None'),
    ];
  }

  /**
   * Overrides Drupal\views\Plugin\views\display_extender\DisplayExtenderPluginBase::buildOptionsForm().
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    $section = $form_state
      ->get('section');
    if ($section == 'views_advanced_routing_route') {
      $route = $this->options['route'];
      $form['route'] = [
        '#title' => t('Route YAML'),
        '#type' => 'fieldset',
        '#tree' => TRUE,
      ];
      $form['route']['defaults'] = [
        '#type' => 'textarea',
        '#title' => t('Defaults'),
        '#default_value' => !empty($route['defaults']) ? Yaml::encode($route['defaults']) : '',
      ];
      $form['route']['requirements'] = [
        '#type' => 'textarea',
        '#title' => t('Requirements'),
        '#default_value' => !empty($route['requirements']) ? Yaml::encode($route['requirements']) : '',
      ];
      $form['route']['options'] = [
        '#type' => 'textarea',
        '#title' => t('Options'),
        '#default_value' => !empty($route['options']) ? Yaml::encode($route['options']) : '',
      ];
    }
  }

  /**
   * @inheritDoc
   */
  public function validateOptionsForm(&$form, FormStateInterface $form_state) {
    $section = $form_state
      ->get('section');
    if ($section == 'views_advanced_routing_route') {
      $route_info = [
        'defaults' => [],
        'requirements' => [],
        'options' => [],
      ];

      // $key: defaults, requirements, options.
      $route = $form_state
        ->getValue('route');
      foreach ($route as $key => $value) {
        try {
          $route_data = Yaml::decode($route[$key]) ?: [];
          if (is_array($route_data)) {
            $route_info[$key] = $route_data;
          }
          else {
            $form_state
              ->setError($form['route'][$key], $this
              ->t('Value must be an array.'));
          }
        } catch (InvalidDataTypeException $e) {
          $form_state
            ->setError($form['route'][$key], $this
            ->t('YAML does not validate: @exception', [
            '@exception' => $e
              ->getMessage(),
          ]));
        }
      }
      try {
        new Route('<none>', $route_info['defaults'], $route_info['requirements'], $route_info['options']);
      } catch (\Exception $e) {

        // Creating the route can throw exceptions.
        $form_state
          ->setError($form['route'], $e
          ->getMessage());
      }
      $form_state
        ->set('route_info', $route_info);
    }
  }

  /**
   * Overrides Drupal\views\Plugin\views\display\DisplayExtenderPluginBase::submitOptionsForm().
   */
  public function submitOptionsForm(&$form, FormStateInterface $form_state) {
    $section = $form_state
      ->get('section');
    if ($section == 'views_advanced_routing_route') {
      if ($route_info = $form_state
        ->get('route_info')) {
        $this->options['route'] = $route_info;
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AdvancedRouting::$testState public property Stores some state booleans to be sure a certain method got called.
AdvancedRouting::buildOptionsForm public function Overrides Drupal\views\Plugin\views\display_extender\DisplayExtenderPluginBase::buildOptionsForm(). Overrides DisplayExtenderPluginBase::buildOptionsForm
AdvancedRouting::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides PluginBase::defineOptions
AdvancedRouting::optionsSummary public function Overrides Drupal\views\Plugin\views\display\DisplayPluginBase::optionsSummary(). Overrides DisplayExtenderPluginBase::optionsSummary
AdvancedRouting::submitOptionsForm public function Overrides Drupal\views\Plugin\views\display\DisplayExtenderPluginBase::submitOptionsForm(). Overrides DisplayExtenderPluginBase::submitOptionsForm
AdvancedRouting::validateOptionsForm public function @inheritDoc Overrides DisplayExtenderPluginBase::validateOptionsForm
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
DisplayExtenderPluginBase::defaultableSections public function Static member function to list which sections are defaultable and what items each section contains. 1
DisplayExtenderPluginBase::defineOptionsAlter public function Provide a form to edit options for this plugin.
DisplayExtenderPluginBase::preExecute public function Set up any variables on the view prior to execution. 1
DisplayExtenderPluginBase::query public function Inject anything into the query that the display_extender handler needs. Overrides PluginBase::query 1
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's definition
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$renderer protected property Stores the render API renderer. 3
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
PluginBase::$view public property The top object of a view. 1
PluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 14
PluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 62
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function Clears a plugin. Overrides ViewsPluginInterface::destroy 2
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
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 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::getProvider public function Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer protected function Returns the render API renderer. 1
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY constant Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED constant Include negotiated languages when listing languages.
PluginBase::init public function Initialize the plugin. Overrides ViewsPluginInterface::init 8
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::listLanguages protected function Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle public function Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup public static function Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData public static function Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::queryLanguageSubstitutions public static function Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults protected function Fills up the options of the plugin with defaults.
PluginBase::summaryTitle public function Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions 1
PluginBase::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks 6
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions 8
PluginBase::validate public function Validate that the plugin is correct and can be saved. Overrides ViewsPluginInterface::validate 6
PluginBase::viewsTokenReplace protected function Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin. 1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
PluginBase::__construct public function Constructs a PluginBase object. Overrides PluginBase::__construct
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
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.
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.