You are here

abstract class StyleguidePluginBase in Style Guide 2.x

Same name and namespace in other branches
  1. 8 src/Plugin/StyleguidePluginBase.php \Drupal\styleguide\Plugin\StyleguidePluginBase

Base class for Styleguide plugins.

Hierarchy

Expanded class hierarchy of StyleguidePluginBase

5 files declare their use of StyleguidePluginBase
CommentStyleguide.php in src/Plugin/Styleguide/CommentStyleguide.php
DefaultStyleguide.php in src/Plugin/Styleguide/DefaultStyleguide.php
ImageStyleguide.php in src/Plugin/Styleguide/ImageStyleguide.php
LayoutStyleguide.php in src/Plugin/Styleguide/LayoutStyleguide.php
SearchStyleguide.php in src/Plugin/Styleguide/SearchStyleguide.php

File

src/Plugin/StyleguidePluginBase.php, line 14

Namespace

Drupal\styleguide\Plugin
View source
abstract class StyleguidePluginBase extends PluginBase implements StyleguideInterface, ContainerFactoryPluginInterface {

  /**
   * Build a link.
   *
   * @param string $text
   *   Text displayed in the link.
   * @param string $uri
   *   Url used in the link.
   *
   * @return string
   *   The renderable array.
   */
  public function buildLink($text, $uri) {
    $url = Url::fromUserInput($uri);
    $link = Link::fromTextAndUrl($text, $url);
    return $link
      ->toRenderable();
  }

  /**
   * Build a link from a given route name and parameters.
   *
   * @param string $text
   *   Text displayed in the link.
   * @param string $route_name
   *   The name of the route.
   * @param array $route_parameters
   *   (optional) An associative array of parameter names and values.
   * @param array $options
   *   (optional) An associative array of additional options.
   *
   * @return array
   *   The renderable array.
   */
  public function buildLinkFromRoute($text, $route_name, array $route_parameters = [], array $options = []) {
    $link = Link::createFromRoute($text, $route_name, $route_parameters, $options);
    return $link
      ->toRenderable();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ContainerFactoryPluginInterface::create public static function Creates an instance of the plugin. 120
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
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.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 98
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.
StyleguideInterface::items public function Styleguide elements implementation. 5
StyleguidePluginBase::buildLink public function Build a link.
StyleguidePluginBase::buildLinkFromRoute public function Build a link from a given route name and parameters.