class GoogleSearch in Freelinking 4.0.x

Freelinking google search plugin.

Plugin annotation

@Freelinking(
  id = "google",
  title = @Translation("Google Search"),
  weight = 1,
  hidden = false,
  settings = {  }
)

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\GoogleSearch

1 file declares its use of GoogleSearch

GoogleSearchTest.php in tests/src/Unit/Plugin/freelinking/GoogleSearchTest.php

File

src/Plugin/freelinking/GoogleSearch.php, line 21

Namespace

Drupal\freelinking\Plugin\freelinking

class GoogleSearch extends FreelinkingPluginBase {

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

  /**
   * {@inheritdoc}
   */
  public function getTip() {
    return $this
      ->t('Search google for the specified terms.');
  }

  /**
   * {@inheritdoc}
   */
  public function buildLink(array $target) {
    $searchString = str_replace(' ', '+', $target['dest']);
    $tooltip = isset($target['tooltip']) ? $target['tooltip'] : $this
      ->getTip();
    return self::createRenderArray($searchString, $target['text'], $target['language'], $tooltip);
  }

  /**
   * Create a google search link.
   *
   * @param string $searchString
   *   The search string to use, which should already have spaces replaced with
   *   plus signs.
   * @param string $text
   *   The text to display for the link.
   * @param \Drupal\Core\Language\LanguageInterface|null $language
   *   The language code.
   * @param \Drupal\Core\StringTranslation\TranslatableMarkup $tip
   *   The tooltip to use.
   *
   * @return array
   *   A valid link render array.
   */
  public static function createRenderArray($searchString, $text, $language, TranslatableMarkup $tip) {

    // @todo Fix so that language is typed.
    $lang = NULL === $language || LanguageInterface::LANGCODE_DEFAULT === $language
      ->getId() ? 'en' : $language
      ->getId();
    return [
      '#type' => 'link',
      '#title' => 'Google Search ' . $text,
      '#url' => Url::fromUri('https://google.com/search', [
        'absolute' => TRUE,
        'query' => [
          'q' => $searchString,
          'hl' => $lang,
        ],
        'language' => $language,
      ]),
      '#attributes' => array(
        'title' => $tip,
      ),
    ];
  }

}

Members

Name	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::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	6
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
FreelinkingPluginBase::settingsForm	public	function	Plugin configuration form. Overrides FreelinkingPluginInterface::settingsForm	6
GoogleSearch::buildLink	public	function	Build a link with the plugin. Overrides FreelinkingPluginInterface::buildLink
GoogleSearch::createRenderArray	public static	function	Create a google search link.
GoogleSearch::getIndicator	public	function	A regular expression string to indicate what to replace for this plugin. Overrides FreelinkingPluginInterface::getIndicator
GoogleSearch::getTip	public	function	Provides tips for this freelinking plugin. Overrides FreelinkingPluginInterface::getTip
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.