ClearShortcode.php in Shortcode 2.0.x

Namespace

Drupal\shortcode_basic_tags\Plugin\Shortcode

File

shortcode_basic_tags/src/Plugin/Shortcode/ClearShortcode.php

<?php

namespace Drupal\shortcode_basic_tags\Plugin\Shortcode;

use Drupal\Core\Language\Language;
use Drupal\shortcode\Plugin\ShortcodeBase;

/**
 * Insert div or span around the text with some css classes.
 *
 * @Shortcode(
 *   id = "clear",
 *   title = @Translation("Clear"),
 *   description = @Translation("Insert a float-clearing div for a proper layout.")
 * )
 */
class ClearShortcode extends ShortcodeBase {

  /**
   * {@inheritdoc}
   */
  public function process(array $attributes, $text, $langcode = Language::LANGCODE_NOT_SPECIFIED) {

    // Merge with default attributes.
    $attributes = $this
      ->getAttributes([
      'class' => '',
      'id' => '',
      'style' => '',
      // Default element to div.
      'type' => 'div',
    ], $attributes);
    $class = $this
      ->addClass($attributes['class'], 'clearfix');

    // Only allow allowed types, and replace common shorthands.
    // TODO: Use map.
    // TODO: Allow any type the user enters?
    switch ($attributes['type']) {
      case 's':
      case 'span':
        $attributes['type'] = 'span';
        break;
      case 'd':
      default:
        $attributes['type'] = 'div';
        break;
    }

    // Build element attributes to be used in twig.
    $element_attributes = [
      'class' => $class,
      'id' => $attributes['id'],
      'style' => $attributes['style'],
    ];

    // Filter away empty attributes.
    $element_attributes = array_filter($element_attributes);
    $output = [
      '#theme' => 'shortcode_clear',
      '#type' => $attributes['type'],
      '#attributes' => $element_attributes,
      '#text' => $text,
    ];
    return $this
      ->render($output);
  }

  /**
   * {@inheritdoc}
   */
  public function tips($long = FALSE) {
    $output = [];
    $output[] = '<p><strong>' . $this
      ->t('[clear (class="additional class"|id=item id|type=div,d,span,s)]text[/clear]') . '</strong>';
    if ($long) {
      $output[] = $this
        ->t('Inserts a float-clearing html item (type parameter = div or span) around the given text. Use the simple [clear /].') . '</p>';
      $output[] = '<p>' . $this
        ->t('Additional class names can be added by the <em>class</em> parameter. The id parameter gives the html an unique css id.') . '</p>';
    }
    else {
      $output[] = $this
        ->t('Inserts a float-clearing html item (div or span) around the given text. Use the simple [clear /].') . '</p>';
    }
    return implode(' ', $output);
  }

}

Classes

Name	Description
ClearShortcode	Insert div or span around the text with some css classes.