class BootstrapColumnShortcode in Shortcode 8

Provides a shortcode for bootstrap columns.

Plugin annotation

@Shortcode(
  id = "col",
  title = @Translation("Bootstrap column"),
  description = @Translation("Builds a div with bootstrap column size classes")
)

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_example\Plugin\Shortcode\BootstrapColumnShortcode

File

shortcode_example/src/Plugin/Shortcode/BootstrapColumnShortcode.php, line 17

Namespace

Drupal\shortcode_example\Plugin\Shortcode

class BootstrapColumnShortcode extends ShortcodeBase {

  /**
   * {@inheritdoc}
   */
  public function process(array $attributes, $text, $langcode = Language::LANGCODE_NOT_SPECIFIED) {
    $attributes = $this
      ->getAttributes([
      'class' => '',
      'xs' => '',
      'sm' => '',
      'md' => '',
      'lg' => '',
    ], $attributes);
    $class = $attributes['class'];
    foreach ([
      'xs',
      'sm',
      'md',
      'lg',
    ] as $size) {
      if ($attributes[$size]) {
        $class = $this
          ->addClass($class, 'col-' . $size . '-' . $attributes[$size]);
      }
    }
    return '<div class="' . $class . '">' . $text . '</div>';
  }

  /**
   * {@inheritdoc}
   */
  public function tips($long = FALSE) {
    $output = [];
    $output[] = '<p><strong>' . $this
      ->t('[col class="custom-class" xs="12" sm="6" md="4" lg="3"]Other HTML content here [/col]') . '</strong> ';
    if ($long) {
      $output[] = $this
        ->t('Wraps your content with a div with bootstrap column size classes. All attributes are optional but it would not be very useful unless you define at least 1 size attribute or custom all the classes yourself using class. Setting md=4 translates to the col-md-4 class, etc.') . '</p>';
    }
    else {
      $output[] = $this
        ->t('Wraps your content with a div with bootstrap column size classes.') . '</p>';
    }
    return implode(' ', $output);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BootstrapColumnShortcode::process	public	function	Performs the shortcode processing. Overrides ShortcodeInterface::process
BootstrapColumnShortcode::tips	public	function	Generates a filter's tip. Overrides ShortcodeBase::tips
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.
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	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.
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
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
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.