class SlickImageFormatter in Slick Carousel 7.3

Plugin implementation of the 'Slick Image' formatter.

Hierarchy

• class \Drupal\blazy\Plugin\Field\FieldFormatter\FormatterBase implements FormatterInterface
  • class \Drupal\blazy\Plugin\Field\FieldFormatter\BlazyFormatterBase
    • class \Drupal\slick\Plugin\Field\FieldFormatter\SlickFormatterBase
      • class \Drupal\slick\Plugin\Field\FieldFormatter\SlickImageFormatter uses SlickFormatterTrait

File

src/Plugin/Field/FieldFormatter/SlickImageFormatter.php, line 8

Namespace

Drupal\slick\Plugin\Field\FieldFormatter

class SlickImageFormatter extends SlickFormatterBase {
  use SlickFormatterTrait;

  /**
   * {@inheritdoc}
   */
  protected function getCaption($item, $caption, $settings) {
    return empty($item->{$caption}) ? [] : [
      '#markup' => filter_xss_admin($item->{$caption}),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildElement(array &$element, $entity, $delta = 0) {
    $settings = $element['settings'];
    $item_id = $settings['item_id'];

    // Image with responsive image, lazyLoad, and lightbox supports.
    $element[$item_id] = $this
      ->formatter()
      ->getBlazy($element);

    // Build caption if so configured, supports file entity/ media via $file.
    if (!empty($settings['caption'])) {
      foreach ($settings['caption'] as $caption) {
        $element['caption'][$caption] = $this
          ->getCaption($entity, $caption, $element['settings']);
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BlazyFormatterBase::getEntitiesToView	protected	function	Converts $items array to object for easy D8 -> D7 backports.	1
BlazyFormatterBase::getRequiredForms	public	function	Returns required form elements for the current formatter. Overrides FormatterBase::getRequiredForms	2
BlazyFormatterBase::settingsForm	public	function	Implements hook_field_formatter_settings_form(). Overrides FormatterBase::settingsForm	1
BlazyFormatterTrait::$formatter	protected	property	The blazy-related formatter service.
BlazyFormatterTrait::$manager	protected	property	The blazy field formatter manager.
BlazyFormatterTrait::formatter	public	function	Returns the blazy-related formatter.
BlazyFormatterTrait::manager	public	function	Returns the blazy service.
BlazyFormatterTrait::settingsSummary	public	function
FormatterBase::$admin	protected	property	The blazy-related admin formatter service.
FormatterBase::$defaultSettingsMerged	protected	property	Whether default settings have been merged into the current $settings.
FormatterBase::$fieldDefinition	protected	property	The field definition.
FormatterBase::$fieldDisplay	protected	property	The field display.
FormatterBase::$fieldInstance	protected	property	The field instance.
FormatterBase::$htmlSettings	protected	property	The form settings.
FormatterBase::$isMultiple	protected	property	True if the field cardinality equals -1.
FormatterBase::$knownEntities	protected	property	The known hard-coded entities.
FormatterBase::$langcode	protected	property	The langcode.
FormatterBase::$pluginId	protected	property	The blazy formatter plugin id.
FormatterBase::$settings	protected	property	The formatter settings.
FormatterBase::$viewMode	protected	property	The view mode.
FormatterBase::buildSettings	public	function	Builds the settings.	1
FormatterBase::buildSettingsForm	public	function	Implements hook_field_formatter_settings_form().
FormatterBase::buildSettingsSummary	public	function
FormatterBase::getHtmlSettings	public	function	Gets html settings.
FormatterBase::getPluginId	public	function	Gets formatter plugin id.
FormatterBase::getSetting	public	function
FormatterBase::getSettings	public	function	Gets formatter settings.
FormatterBase::mergeDefaults	protected	function	Merges default settings values into $settings.
FormatterBase::setHtmlSettings	public	function	Sets html settings.
FormatterBase::setSetting	public	function
FormatterBase::setSettings	public	function	Sets formatter settings.
FormatterBase::setupFieldVariables	protected	function	Setup common variables across different hooks.
FormatterBase::view	public	function	Implements hook_field_formatter_view().
SlickFormatterBase::buildElements	public	function	Build the slick carousel elements.	1
SlickFormatterBase::defaultSettings	public static	function	Returns default settings. Overrides BlazyFormatterBase::defaultSettings	1
SlickFormatterBase::getScopedFormElements	public	function	Defines the scope for the form elements. Overrides BlazyFormatterBase::getScopedFormElements	1
SlickFormatterBase::__construct	public	function	Constructs a SlickImageFormatter instance. Overrides FormatterBase::__construct
SlickFormatterTrait::admin	public	function	Returns the slick admin service.
SlickFormatterTrait::viewElements	public	function		1
SlickImageFormatter::buildElement	public	function	Build individual item if so configured such as for file entity goodness. Overrides BlazyFormatterBase::buildElement
SlickImageFormatter::getCaption	protected	function	Build caption element if so configured can be used for thumbnail caption. Overrides SlickFormatterBase::getCaption