You are here

Home » API reference » SMS Framework 8 » FilterInlineSms.php

class FilterInlineSms in SMS Framework 8

Same name and namespace in other branches
  1. 2.x modules/sms_sendtophone/src/Plugin/Filter/FilterInlineSms.php \Drupal\sms_sendtophone\Plugin\Filter\FilterInlineSms
  2. 2.1.x modules/sms_sendtophone/src/Plugin/Filter/FilterInlineSms.php \Drupal\sms_sendtophone\Plugin\Filter\FilterInlineSms

Provides a filter to align elements.

Plugin annotation


@Filter(
  id = "filter_inline_sms",
  title = @Translation("Inline SMS"),
  description = @Translation("Highlights text between <code>[sms][/sms]</code> tags and appends a 'send to phone' button."),
  type = Drupal\filter\Plugin\FilterInterface::TYPE_MARKUP_LANGUAGE,
  settings = {
    "display" = "icon",
    "display_text" = @Translation("Send to phone"),
    "default_icon" = 1,
    "custom_icon_path" = ""
  }
)

Hierarchy

Expanded class hierarchy of FilterInlineSms

File

modules/sms_sendtophone/src/Plugin/Filter/FilterInlineSms.php, line 28

Namespace

Drupal\sms_sendtophone\Plugin\Filter
View source 
class FilterInlineSms extends FilterBase {
  use LinkGeneratorTrait;

  /**
   * {@inheritdoc}
   */
  public function process($text, $langcode) {
    $matches = [];
    preg_match_all('/\\[sms\\](.*?)\\[\\/sms\\]/i', $text, $matches, PREG_SET_ORDER);
    $type = $this->settings['display'] == 'icon' ? 'icon' : 'text';
    foreach ($matches as $match) {
      $text = str_replace($match[0], $this
        ->theme($match[1], $type), $text);
    }
    return new FilterProcessResult($text);
  }

  /**
   * {@inheritdoc}
   */
  public function tips($long = FALSE) {
    return $this
      ->t('Text between [sms][/sms] tags will be highlighted and appended with a "send to phone" button.');
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements['display'] = [
      '#type' => 'radios',
      '#title' => t('Show link as'),
      '#description' => t('How to display the the "send to phone" link.'),
      '#options' => [
        'text' => t('Text'),
        'icon' => t('Icon'),
      ],
      '#default_value' => $this->settings['display'],
    ];
    $elements['display_text'] = [
      '#type' => 'textfield',
      '#title' => t('Text for link'),
      '#description' => t('If "Text" is selected above, the following text will be appended as a link.'),
      '#size' => 32,
      '#maxlength' => 32,
      '#default_value' => $this->settings['display_text'],
    ];
    $elements['default_icon'] = [
      '#type' => 'checkbox',
      '#title' => t('Use default icon'),
      '#description' => t('If "Icon" is selected above and this option is enabled, the default icon that came with the module will be used.'),
      '#default_value' => $this->settings['default_icon'],
    ];
    $elements['custom_icon_path'] = [
      '#type' => 'textfield',
      '#title' => t('Path to custom icon'),
      '#description' => t('Provide a path to a custom icon. This icon will be used if "Icon" is selected above and the "Use default icon" option is disabled.'),
      '#size' => 40,
      '#maxlength' => 255,
      '#default_value' => $this->settings['custom_icon_path'],
      '#field_prefix' => Url::fromRoute('<none>', [], [
        'absolute' => TRUE,
      ]),
    ];
    return $elements;
  }

  /**
   * Themes the message using a text link.
   */
  protected function theme($text, $type = 'icon') {
    switch ($type) {
      case 'text':
        $markup = '(' . $this->settings['display_text'] . ')';
        break;
      case 'icon':
      default:
        if (!isset($this->settings["default_icon"]) || $this->settings["default_icon"] == 1) {
          $icon_path = drupal_get_path('module', 'sms_sendtophone') . '/sms-send.gif';
        }
        else {
          $icon_path = $this->settings["custom_icon_path"];
        }
        $title = $this
          ->t('Send the highlighted text via SMS.');
        $icon_path = base_path() . $icon_path;

        // @todo: Figure out a better way to render the icon.
        $markup = Markup::create("<img src='{$icon_path}' alt='{$this->settings["display_text"]}' title='{$title}'/>");
        break;
    }
    $options = [
      'attributes' => [
        'title' => t('Send the highlighted text via SMS.'),
        'class' => 'sms-sendtophone',
      ],
      'query' => [
        'text' => urlencode($text),
      ],
      'html' => TRUE,
    ];
    $link = [
      '#type' => 'link',
      '#prefix' => '<span class="sms-sendtophone-inline">' . $text . '</span> ',
      '#title' => $markup,
      '#url' => Url::fromRoute('sms_sendtophone.page', [
        'type' => 'inline',
      ], $options),
    ];
    return $this
      ->renderer()
      ->renderPlain($link);
  }

  /**
   * Encapsulates the renderer service for unit testing purposes.
   *
   * @return \Drupal\Core\Render\RendererInterface
   *   Returns the renderer service.
   */
  protected function renderer() {
    return \Drupal::service('renderer');
  }

}

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
FilterBase::$provider public property The name of the provider that owns this filter.
FilterBase::$settings public property An associative array containing the configured settings of this filter.
FilterBase::$status public property A Boolean indicating whether this filter is enabled.
FilterBase::$weight public property The weight of this filter compared to others in a filter collection.
FilterBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 1
FilterBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
FilterBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
FilterBase::getDescription public function Returns the administrative description for this filter plugin. Overrides FilterInterface::getDescription
FilterBase::getHTMLRestrictions public function Returns HTML allowed by this filter's configuration. Overrides FilterInterface::getHTMLRestrictions 4
FilterBase::getLabel public function Returns the administrative label for this filter plugin. Overrides FilterInterface::getLabel
FilterBase::getType public function Returns the processing type of this filter plugin. Overrides FilterInterface::getType
FilterBase::prepare public function Prepares the text for processing. Overrides FilterInterface::prepare
FilterBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration 1
FilterBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct 4
FilterInlineSms::process public function Performs the filter processing. Overrides FilterInterface::process
FilterInlineSms::renderer protected function Encapsulates the renderer service for unit testing purposes.
FilterInlineSms::settingsForm public function Generates a filter's settings form. Overrides FilterBase::settingsForm
FilterInlineSms::theme protected function Themes the message using a text link.
FilterInlineSms::tips public function Generates a filter's tip. Overrides FilterBase::tips
FilterInterface::TYPE_HTML_RESTRICTOR constant HTML tag and attribute restricting filters to prevent XSS attacks.
FilterInterface::TYPE_MARKUP_LANGUAGE constant Non-HTML markup language filters that generate HTML.
FilterInterface::TYPE_TRANSFORM_IRREVERSIBLE constant Irreversible transformation filters.
FilterInterface::TYPE_TRANSFORM_REVERSIBLE constant Reversible transformation filters.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
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 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.