class PathAlias in Freelinking 8.3

Same name and namespace in other branches

4.0.x src/Plugin/freelinking/PathAlias.php \Drupal\freelinking\Plugin\freelinking\PathAlias

Freelinking path plugin.

Plugin annotation


@Freelinking(
  id = "path_alias",
  title = @Translation("Path Alias"),
  weight = 0,
  hidden = false,
  settings = {
    "failover" = "search"
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\freelinking\Plugin\FreelinkingPluginBase implements FreelinkingPluginInterface
    class \Drupal\freelinking\Plugin\freelinking\PathAlias implements ContainerFactoryPluginInterface

Expanded class hierarchy of PathAlias

2 files declare their use of PathAlias

PathAliasSearchTest.php in tests/src/Unit/Plugin/freelinking/PathAliasSearchTest.php
PathAliasTest.php in tests/src/Unit/Plugin/freelinking/PathAliasTest.php

File

src/Plugin/freelinking/PathAlias.php, line 26

Namespace

Drupal\freelinking\Plugin\freelinking

View source

class PathAlias extends FreelinkingPluginBase implements ContainerFactoryPluginInterface {

  /**
   * Module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * Path Alias Manager.
   *
   * @var \Drupal\path_alias\AliasManagerInterface
   */
  protected $aliasManager;

  /**
   * Initialize method.
   *
   * @param array $configuration
   *   The plugin configuration array.
   * @param string $plugin_id
   *   The plugin ID.
   * @param mixed $plugin_definition
   *   The plugin definition array.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler
   *   The module handler.
   * @param \Drupal\path_alias\AliasManagerInterface $aliasManager
   *   The path alias manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ModuleHandlerInterface $moduleHandler, AliasManagerInterface $aliasManager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->moduleHandler = $moduleHandler;
    $this->aliasManager = $aliasManager;
  }

  /**
   * {@inheritdoc}
   */
  public function getIndicator() {
    return '/path|alias/i';
  }

  /**
   * {@inheritdoc}
   */
  public function getTip() {
    return $this
      ->t('Click to view a local node.');
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return parent::defaultConfiguration() + [
      'settings' => [
        'failover' => 'search',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element['failover'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('If path alias is not found'),
      '#description' => $this
        ->t('What should freelinking do when the page is not found?'),
      '#options' => [
        'error' => $this
          ->t('Insert an error message'),
      ],
    ];
    if ($this->moduleHandler
      ->moduleExists('search')) {
      $element['failover']['#options']['search'] = $this
        ->t('Add link to search content');
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function buildLink(array $target) {
    $failover = $this
      ->getConfiguration()['settings']['failover'];

    // All aliases must use a preceding slash.
    $alias = strpos('/', $target['dest']) === 0 ? $target['dest'] : '/' . $target['dest'];
    $langcode = isset($target['language']) ? $target['language']
      ->getId() : NULL;
    $path = $this->aliasManager
      ->getPathByAlias($alias, $langcode);

    // A path  was found.
    if ($path !== $alias) {
      $link = [
        '#type' => 'link',
        '#title' => $target['text'],
        '#url' => Url::fromUserInput($path, [
          'language' => $target['language'],
        ]),
        '#attributes' => [
          'title' => isset($target['tooltip']) ? $target['tooltip'] : $this
            ->getTip(),
        ],
      ];
    }
    elseif ($failover === 'search' && $this->moduleHandler
      ->moduleExists('search')) {
      $link = [
        '#type' => 'link',
        '#title' => $target['text'],
        '#url' => Url::fromUserInput('/search', [
          'query' => [
            'keys' => $path,
          ],
          'language' => $target['language'],
        ]),
        '#attributes' => [
          'title' => $this
            ->getTip(),
        ],
      ];
    }
    else {
      $link = [
        '#theme' => 'freelink_error',
        '#plugin' => 'path_alias',
        '#message' => $this
          ->t('path “%path” not found', [
          '%path' => $path,
        ]),
      ];
    }
    return $link;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('module_handler'), $container
      ->get('path_alias.manager'));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
FreelinkingPluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
FreelinkingPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration	1
FreelinkingPluginBase::getFailoverPluginId	public	function	Get the failover plugin ID (if applicable). Overrides FreelinkingPluginInterface::getFailoverPluginId	1
FreelinkingPluginBase::isHidden	public	function	Determine if the plugin is built-in (always on). Overrides FreelinkingPluginInterface::isHidden
FreelinkingPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PathAlias::$aliasManager	protected	property	Path Alias Manager.
PathAlias::$moduleHandler	protected	property	Module handler.
PathAlias::buildLink	public	function	Build a link with the plugin. Overrides FreelinkingPluginInterface::buildLink
PathAlias::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
PathAlias::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides FreelinkingPluginBase::defaultConfiguration
PathAlias::getIndicator	public	function	A regular expression string to indicate what to replace for this plugin. Overrides FreelinkingPluginInterface::getIndicator
PathAlias::getTip	public	function	Provides tips for this freelinking plugin. Overrides FreelinkingPluginInterface::getTip
PathAlias::settingsForm	public	function	Plugin configuration form. Overrides FreelinkingPluginBase::settingsForm
PathAlias::__construct	public	function	Initialize method. Overrides PluginBase::__construct
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	3
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.
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.

You are here

class PathAlias in Freelinking 8.3

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation