public function BootstrapIconShortcode::tips in Bootstrap 3 shortcodes 8

Generates a filter's tip.

A filter's tips should be informative and to the point. Short tips are preferably one-liners.

@todo Split into getSummaryItem() and buildGuidelines().

Parameters

bool $long: Whether this callback should return a short tip to display in a form (FALSE), or whether a more elaborate filter tips should be returned for template_preprocess_filter_tips() (TRUE).

Return value

string|null Translated text to display as a tip, or NULL if this filter has no tip.

Overrides ShortcodeBase::tips

File

src/Plugin/Shortcode/BootstrapIconShortcode.php, line 52

Adds shortcodes for all Bootstrap elements.

Class

BootstrapIconShortcode

@Shortcode( id = "bs_icon", token = "icon", title = @Translation("Icon"), description = @Translation("Bootstrap 3 shortcode"), weight = 50 )

Namespace

Drupal\bs_shortcodes\Plugin\Shortcode

Code

public function tips($long = FALSE) {
  $output = array();
  $output[] = '<p><strong>[icon</strong> type="See Bootstrap docs" xclass="any text" data="any text"<strong>]</strong>  ... <strong>[/icon]</strong>';
  if ($long) {
    $output[] = t('More info about this shortcode <a href=":url" target="_blank">here</a>', array(
      ':url' => 'https://github.com/MWDelaney/bootstrap-3-shortcodes#icons',
    )) . '.</p>';
  }
  else {
    $output[] = t('More info <a href=":url" target="_blank">here</a>', array(
      ':url' => 'https://github.com/MWDelaney/bootstrap-3-shortcodes#icons',
    )) . '.</p>';
  }
  return implode(' ', $output);
}