You are here

Home » API reference » Freelinking 4.0.x » Search.php

class Search in Freelinking 4.0.x

Same name and namespace in other branches
  1. 8.3 src/Plugin/freelinking/Search.php \Drupal\freelinking\Plugin\freelinking\Search

Freelinking search plugin.

Plugin annotation


@Freelinking(
  id = "search",
  title = @Translation("Search"),
  weight = 0,
  hidden = false,
  settings = {
    "failover" = "error"
  }
)

Hierarchy

Expanded class hierarchy of Search

2 files declare their use of Search
SearchFailoverTest.php in tests/src/Unit/Plugin/freelinking/SearchFailoverTest.php
SearchTest.php in tests/src/Unit/Plugin/freelinking/SearchTest.php
2 string references to 'Search'
SearchFailoverTest::testBuildLink in tests/src/Unit/Plugin/freelinking/SearchFailoverTest.php
Asserts the failover functionality for the search plugin.
SearchTest::setUp in tests/src/Unit/Plugin/freelinking/SearchTest.php

File

src/Plugin/freelinking/Search.php, line 25

Namespace

Drupal\freelinking\Plugin\freelinking
View source 
class Search extends FreelinkingPluginBase implements ContainerFactoryPluginInterface {

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

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

  /**
   * {@inheritdoc}
   */
  public function getIndicator() {
    return '/^search$/';
  }

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

  /**
   * {@inheritdoc}
   */
  public function getTip() {
    return $this
      ->t('Search this site for content.');
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element['failover'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Failover Option'),
      '#description' => $this
        ->t('If Search is disabled or inaccessible do something else.'),
      '#options' => [
        'error' => $this
          ->t('Error Message'),
        'google' => $this
          ->t('Google'),
      ],
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function buildLink(array $target) {
    $failover = $this
      ->getConfiguration()['settings']['failover'];
    $searchString = str_replace(' ', '+', $target['dest']);
    if ($this->moduleHandler
      ->moduleExists('search')) {
      return [
        '#type' => 'link',
        '#title' => $target['text'] ? $target['text'] : $this
          ->t('Search: “@text”', [
          '@text' => $target['dest'],
        ]),
        '#url' => Url::fromUserInput('/search/node', [
          'query' => [
            'keys' => $searchString,
          ],
          'language' => $target['language'],
        ]),
        '#attributes' => [
          'title' => isset($target['tooltip']) ? $target['tooltip'] : $this
            ->getTip(),
        ],
      ];
    }
    elseif ($failover === 'google') {
      return GoogleSearch::createRenderArray($searchString, $target['text'], $target['language'], $this
        ->getTip());
    }
    return [
      '#theme' => 'freelink_error',
      '#plugin' => 'search',
      '#message' => $this
        ->t('Search unavailable'),
    ];
  }

  /**
   * {@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'));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
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. 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.
Search::$moduleHandler protected property Module handler interface.
Search::buildLink public function Build a link with the plugin. Overrides FreelinkingPluginInterface::buildLink
Search::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
Search::defaultConfiguration public function Gets default configuration for this plugin. Overrides FreelinkingPluginBase::defaultConfiguration
Search::getIndicator public function A regular expression string to indicate what to replace for this plugin. Overrides FreelinkingPluginInterface::getIndicator
Search::getTip public function Provides tips for this freelinking plugin. Overrides FreelinkingPluginInterface::getTip
Search::settingsForm public function Plugin configuration form. Overrides FreelinkingPluginBase::settingsForm
Search::__construct public function Initialize method. Overrides PluginBase::__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.