You are here

Home » API reference » Social Media Links Block and Field 8.2 » PlatformBase.php

class PlatformBase in Social Media Links Block and Field 8.2

Base class for platform.

Hierarchy

Expanded class hierarchy of PlatformBase

26 files declare their use of PlatformBase
Amazon.php in src/Plugin/SocialMediaLinks/Platform/Amazon.php
Behance.php in src/Plugin/SocialMediaLinks/Platform/Behance.php
BitBucket.php in src/Plugin/SocialMediaLinks/Platform/BitBucket.php
Contact.php in src/Plugin/SocialMediaLinks/Platform/Contact.php
Drupal.php in src/Plugin/SocialMediaLinks/Platform/Drupal.php

... See full list

File

src/PlatformBase.php, line 14

Namespace

Drupal\social_media_links
View source 
class PlatformBase extends PluginBase implements PlatformInterface {

  /**
   * {@inheritdoc}
   */
  protected $value;

  /**
   * {@inheritdoc}
   */
  protected $description;

  /**
   * {@inheritdoc}
   */
  public function getValue() {
    return Html::escape($this->value);
  }

  /**
   * {@inheritdoc}
   */
  public function setValue($value) {
    $this->value = $value;
  }

  /**
   * {@inheritdoc}
   */
  public function getIconName() {
    return !empty($this->pluginDefinition['iconName']) ? $this->pluginDefinition['iconName'] : $this->pluginDefinition['id'];
  }

  /**
   * {@inheritdoc}
   */
  public function getName() {
    return $this->pluginDefinition['name'];
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldDescription() {
    return isset($this->pluginDefinition['fieldDescription']) ? $this->pluginDefinition['fieldDescription'] : '';
  }

  /**
   * {@inheritdoc}
   */
  public function getUrlPrefix() {
    return isset($this->pluginDefinition['urlPrefix']) ? $this->pluginDefinition['urlPrefix'] : '';
  }

  /**
   * {@inheritdoc}
   */
  public function getUrlSuffix() {
    return isset($this->pluginDefinition['urlSuffix']) ? $this->pluginDefinition['urlSuffix'] : '';
  }

  /**
   * {@inheritdoc}
   */
  public function getUrl() {
    return Url::fromUri($this
      ->getUrlPrefix() . $this
      ->getValue() . $this
      ->getUrlSuffix());
  }

  /**
   * {@inheritdoc}
   */
  public function generateUrl(Url $url) {
    return $url
      ->toString();
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return Html::escape($this->description);
  }

  /**
   * {@inheritdoc}
   */
  public function setDescription($description) {
    $this->description = $description;
  }

  /**
   * {@inheritdoc}
   */
  public static function validateValue(array &$element, FormStateInterface $form_state, array $form) {

    // Do not allow a URL when the plugin already provides a URL prefix.
    if (!empty($element['#value']) && !empty($element['#field_prefix'])) {
      if (UrlHelper::isExternal($element['#value'])) {
        $form_state
          ->setError($element, t("The entered value %value is a URL. You should enter only the relative part, the URL prefix is automatically prepended.", [
          '%value' => $element['#value'],
        ]));
      }
    }
  }

}

Members

Namesort descending 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
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PlatformBase::$description protected property
PlatformBase::$value protected property
PlatformBase::generateUrl public function Generates the final url for the output. Overrides PlatformInterface::generateUrl
PlatformBase::getDescription public function Return value for the title and WAI-ARIA attribute. Overrides PlatformInterface::getDescription
PlatformBase::getFieldDescription public function Returns the description for the value field. Overrides PlatformInterface::getFieldDescription
PlatformBase::getIconName public function Return the name of the icon. Overrides PlatformInterface::getIconName
PlatformBase::getName public function Return the name of the platform. Overrides PlatformInterface::getName
PlatformBase::getUrl public function Get the full url for the platform. Overrides PlatformInterface::getUrl 2
PlatformBase::getUrlPrefix public function Return the url prefix of the platform. Overrides PlatformInterface::getUrlPrefix 1
PlatformBase::getUrlSuffix public function Return the url suffix of the platform. Overrides PlatformInterface::getUrlSuffix
PlatformBase::getValue public function Get the value for the platform. Overrides PlatformInterface::getValue
PlatformBase::setDescription public function Set the description. Overrides PlatformInterface::setDescription
PlatformBase::setValue public function Set the value for the platform. Overrides PlatformInterface::setValue
PlatformBase::validateValue public static function Validates the user input of a platform before the value is saved. Overrides PlatformInterface::validateValue 3
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.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
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.