class External in Freelinking 4.0.x

Same name and namespace in other branches

8.3 src/Plugin/freelinking/External.php \Drupal\freelinking\Plugin\freelinking\External

Freelinking external link plugin.

@Freelinking( id = "external", title = @Translation("External links"), weight = 0, hidden = false, settings = { "scrape" = "1" } )

@todo Should SSL links be a separate plugin?

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\External implements ContainerFactoryPluginInterface

Expanded class hierarchy of External

1 file declares its use of External

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

File

src/Plugin/freelinking/External.php, line 28

Namespace

Drupal\freelinking\Plugin\freelinking

View source

class External extends FreelinkingPluginBase implements ContainerFactoryPluginInterface {

  /**
   * Drupal Guzzle Client.
   *
   * @var \GuzzleHttp\Client
   */
  protected $client;

  /**
   * 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 \GuzzleHttp\Client $client
   *   A configured HTTP Request client.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, Client $client) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->client = $client;
  }

  /**
   * {@inheritdoc}
   */
  public function getIndicator() {
    return '/^http(s)?|ext(ernal)?/';
  }

  /**
   * {@inheritdoc}
   */
  public function getTip() {
    return $this
      ->t('Click to visit an external URL.');
  }

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

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $settings = $this
      ->getConfiguration()['settings'];
    $element['scrape'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Scrape external URLs'),
      '#description' => $this
        ->t('Should freelinking try to scrape external URLs?'),
      '#options' => [
        '0' => $this
          ->t('No'),
        '1' => $this
          ->t('Yes'),
      ],
      '#default_value' => isset($settings['scrape']) ? $settings['scrape'] : '1',
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function buildLink(array $target) {
    $scrape = $this
      ->getConfiguration()['settings']['scrape'];
    $scheme = preg_match('/^http(s)?$/', $target['indicator']) === 1 ? $target['indicator'] . ':' : '';
    $url = $scheme . $target['dest'];
    $link = [
      '#type' => 'link',
      '#url' => Url::fromUri($url, [
        'absolute' => TRUE,
        'language' => $target['language'],
      ]),
      '#attributes' => [
        'title' => isset($target['tooltip']) ? $target['tooltip'] : $this
          ->getTip(),
      ],
    ];

    // Get the page title from the external URL or use the target text.
    if (!$target['text'] && $scrape) {
      try {
        $page_title = $this
          ->getPageTitle($url);
        if ($page_title) {
          $link['#title'] = $this
            ->t('Ext. link: “@title”', [
            '@title' => $page_title,
          ]);
        }
        else {
          $link['#title'] = $url;
        }
      } catch (RequestException $e) {
        $link = [
          '#theme' => 'freelink_error',
          '#plugin' => 'external',
        ];
        if ($e
          ->getResponse()
          ->getStatusCode() >= 400) {
          $link['#message'] = $this
            ->t('External target “@url” not found', [
            '@url' => $url,
          ]);
        }
      }
    }
    else {
      $link['#title'] = $target['text'] ? $target['text'] : $target['dest'];
    }
    return $link;
  }

  /**
   * Get the page title by fetching from the external URL.
   *
   * @param string $url
   *   The URL to fetch.
   *
   * @return string
   *   The page title to use.
   *
   * @throws \GuzzleHttp\Exception\RequestException
   */
  protected function getPageTitle($url) {

    // Try to fetch the URL.
    $response = $this->client
      ->get($url);
    $body = $response
      ->getBody()
      ->getContents();

    // Extract the page title from either the h1 or h2.
    if (preg_match('/<h1.*>(.*)<\\/h1>/', $body, $matches)) {
      if (strlen($matches[1]) < 3 && preg_match('/<h2.*>(.*)<\\/h2>/', $body, $h2_matches)) {
        return $h2_matches[1];
      }
      return $matches[1];
    }
    return '';
  }

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

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
External::$client	protected	property	Drupal Guzzle Client.
External::buildLink	public	function	Build a link with the plugin. Overrides FreelinkingPluginInterface::buildLink	1
External::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
External::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides FreelinkingPluginBase::defaultConfiguration	1
External::getIndicator	public	function	A regular expression string to indicate what to replace for this plugin. Overrides FreelinkingPluginInterface::getIndicator	1
External::getPageTitle	protected	function	Get the page title by fetching from the external URL.
External::getTip	public	function	Provides tips for this freelinking plugin. Overrides FreelinkingPluginInterface::getTip	1
External::settingsForm	public	function	Plugin configuration form. Overrides FreelinkingPluginBase::settingsForm	1
External::__construct	public	function	Initialize method. Overrides PluginBase::__construct
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.
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.

You are here

class External in Freelinking 4.0.x

Hierarchy

File

Namespace

Members

API Navigation