public function FlickrFilter::tips in Flickr 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 FilterBase::tips

File

modules/flickr_filter/src/Plugin/Filter/FlickrFilter.php, line 142

Class

FlickrFilter

Provides a filter to insert Flickr photo.

Namespace

Drupal\flickr_filter\Plugin\Filter

Code

public function tips($long = FALSE) {

  // TODO Make this text a bit more informative.
  if ($long) {
    return $this
      ->t('Embed Flickr photos using @embed. Values for imagesize is optional, if left off the default values configured on the %filter input filter will be used', [
      '@embed' => '[flickr-photo:id=<photo_id>, size=<imagesize>]',
      '%filter' => 'Embed Flickr photo',
    ]);
  }
  else {
    return $this
      ->t('Embed Flickr photo using @embed', [
      '@embed' => '[flickr-photo:id=<photo_id>, size=<imagesize>]',
    ]);
  }
}