class ClearShortcode in Shortcode 2.0.x

Same name and namespace in other branches

8 shortcode_basic_tags/src/Plugin/Shortcode/ClearShortcode.php \Drupal\shortcode_basic_tags\Plugin\Shortcode\ClearShortcode

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

Plugin annotation


@Shortcode(
  id = "clear",
  title = @Translation("Clear"),
  description = @Translation("Insert a float-clearing div for a proper layout.")
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\shortcode\Plugin\ShortcodeBase implements ShortcodeInterface
    class \Drupal\shortcode_basic_tags\Plugin\Shortcode\ClearShortcode

Expanded class hierarchy of ClearShortcode

File

shortcode_basic_tags/src/Plugin/Shortcode/ClearShortcode.php, line 17

Namespace

Drupal\shortcode_basic_tags\Plugin\Shortcode

View source

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);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ClearShortcode::process	public	function	Performs the shortcode processing. Overrides ShortcodeInterface::process
ClearShortcode::tips	public	function	Generates a filter's tip. Overrides ShortcodeBase::tips
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
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::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.
ShortcodeBase::$pluginId	protected	property	The plugin ID of this filter. Overrides PluginBase::$pluginId
ShortcodeBase::$provider	public	property	The name of the provider that owns this filter.
ShortcodeBase::$settings	public	property	An associative array containing the configured settings of this filter.
ShortcodeBase::$status	public	property	A Boolean indicating whether this filter is enabled.
ShortcodeBase::addClass	public	function	Add a class into a classes string if not already inside.
ShortcodeBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ShortcodeBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	1
ShortcodeBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
ShortcodeBase::getAttributes	public	function	Combines user attributes with known attributes.
ShortcodeBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ShortcodeBase::getDescription	public	function	Returns the administrative description for this shortcode plugin. Overrides ShortcodeInterface::getDescription
ShortcodeBase::getImageProperties	public	function	Returns image properties for a given image media entity id.
ShortcodeBase::getLabel	public	function	Returns the administrative label for this shortcode plugin. Overrides ShortcodeInterface::getLabel
ShortcodeBase::getMediaField	public	function	Get a media entity field.
ShortcodeBase::getMediaFileUrl	public	function	Get the file url for a media object.
ShortcodeBase::getMidFromPath	public	function	Extracts the media id from a 'media/x' system path.
ShortcodeBase::getTitleFromAttributes	public	function	Returns a suitable title string given the user provided title and text.
ShortcodeBase::getType	public	function
ShortcodeBase::getUrlFromPath	public	function	Returns a url to be used in a link element given path or url.
ShortcodeBase::render	public	function	Wrapper for renderPlain.
ShortcodeBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ShortcodeBase::settingsForm	public	function	Generates a shortcode's settings form. Overrides ShortcodeInterface::settingsForm
ShortcodeBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	1
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 ClearShortcode in Shortcode 2.0.x

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation