class OwlFieldFormatter in Multipurpose Corporate Profile 8

Plugin implementation of the 'owl_field_formatter' formatter.

Plugin annotation


@FieldFormatter(
  id = "owl_field_formatter",
  label = @Translation("Owl Carousel"),
  field_types = {
    "image"
  }
)

View source

class OwlFieldFormatter extends EntityReferenceFormatterBase implements ContainerFactoryPluginInterface {
  protected $currentUser;
  protected $imageStyleStorage;
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, AccountInterface $current_user, EntityStorageInterface $image_style_storage) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->currentUser = $current_user;
    $this->imageStyleStorage = $image_style_storage;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
      ->get('current_user'), $container
      ->get('entity.manager')
      ->getStorage('image_style'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return _owl_default_settings() + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $image_styles = image_style_options(FALSE);
    $description_link = Link::fromTextAndUrl($this
      ->t('Configure Image Styles'), Url::fromRoute('entity.image_style.collection'));
    $element['image_style'] = [
      '#title' => t('Image style'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('image_style'),
      '#empty_option' => t('None (original image)'),
      '#options' => $image_styles,
      '#description' => $description_link
        ->toRenderable() + [
        '#access' => $this->currentUser
          ->hasPermission('administer image styles'),
      ],
    ];
    $link_types = array(
      'content' => t('Content'),
      'file' => t('File'),
    );
    $element['image_link'] = array(
      '#title' => t('Link image to'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('image_link'),
      '#empty_option' => t('Nothing'),
      '#options' => $link_types,
    );
    $element['items'] = array(
      '#type' => 'number',
      '#title' => $this
        ->t('Items'),
      '#description' => $this
        ->t('Maximum amount of items displayed at a time with the widest browser width.'),
      '#default_value' => $this
        ->getSetting('items'),
    );
    $element['itemsDesktop'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Items Desktop'),
      '#description' => $this
        ->t('This allows you to preset the number of slides visible with a particular browser width. The format is [x,y] whereby x=browser width and y=number of slides displayed. For example [1199,4] means that if(window<=1199){ show 4 slides per page}'),
      '#default_value' => $this
        ->getSetting('itemsDesktop'),
    );
    $element['itemsDesktopSmall'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Items Desktop Small'),
      '#description' => $this
        ->t('Example: [979,3]'),
      '#default_value' => $this
        ->getSetting('itemsDesktopSmall'),
    );
    $element['itemsTablet'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Items Tablet'),
      '#description' => $this
        ->t('Example: [768,2]'),
      '#default_value' => $this
        ->getSetting('itemsTablet'),
    );
    $element['itemsMobile'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Items Mobile'),
      '#description' => $this
        ->t('Example: [479,1]'),
      '#default_value' => $this
        ->getSetting('itemsMobile'),
    );
    $element['singleItem'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Single Item'),
      '#default_value' => $this
        ->getSetting('singleItem'),
      '#description' => $this
        ->t('Display only one item.'),
    );

    //itemsScaleUp
    $element['itemsScaleUp'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Items ScaleUp'),
      '#default_value' => $this
        ->getSetting('itemsScaleUp'),
      '#description' => $this
        ->t('Option to not stretch items when it is less than the supplied items.'),
    );

    //slideSpeed
    $element['slideSpeed'] = array(
      '#type' => 'number',
      '#title' => $this
        ->t('Slide Speed'),
      '#default_value' => $this
        ->getSetting('slideSpeed'),
      '#description' => $this
        ->t('Slide speed in milliseconds.'),
    );

    //paginationSpeed
    $element['paginationSpeed'] = array(
      '#type' => 'number',
      '#title' => $this
        ->t('Pagination Speed'),
      '#default_value' => $this
        ->getSetting('paginationSpeed'),
      '#description' => $this
        ->t('Pagination speed in milliseconds.'),
    );

    //rewindSpeed
    $element['rewindSpeed'] = array(
      '#type' => 'number',
      '#title' => $this
        ->t('Rewind Speed'),
      '#default_value' => $this
        ->getSetting('rewindSpeed'),
      '#description' => $this
        ->t('Rewind speed in milliseconds.'),
    );

    //autoPlay
    $element['autoPlay'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('AutoPlay'),
      '#default_value' => $this
        ->getSetting('autoPlay'),
    );

    //stopOnHover
    $element['stopOnHover'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Stop On Hover'),
      '#default_value' => $this
        ->getSetting('stopOnHover'),
      '#description' => $this
        ->t('Stop autoplay on mouse hover.'),
    );

    //navigation
    $element['navigation'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Navigation'),
      '#default_value' => $this
        ->getSetting('navigation'),
      '#description' => $this
        ->t('Display "next" and "prev" buttons.'),
    );

    //prevText
    $element['prevText'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Prev Text'),
      '#default_value' => $this
        ->getSetting('prevText'),
      '#description' => $this
        ->t('Text for navigation prev button'),
    );

    //nextText
    $element['nextText'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Next Text'),
      '#default_value' => $this
        ->getSetting('nextText'),
      '#description' => $this
        ->t('Text for navigation next button'),
    );

    //rewindNav
    $element['rewindNav'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Rewind Nav'),
      '#default_value' => $this
        ->getSetting('rewindNav'),
      '#description' => $this
        ->t('Slide to first item.'),
    );

    //scrollPerPage
    $element['scrollPerPage'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Scroll Per Page'),
      '#default_value' => $this
        ->getSetting('scrollPerPage'),
      '#description' => $this
        ->t('Scroll per page not per item. This affect next/prev buttons and mouse/touch dragging.'),
    );

    //pagination
    $element['pagination'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('pagination'),
      '#default_value' => $this
        ->getSetting('pagination'),
      '#description' => $this
        ->t('Show pagination.'),
    );

    //paginationNumbers
    $element['paginationNumbers'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Pagination Numbers'),
      '#default_value' => $this
        ->getSetting('paginationNumbers'),
      '#description' => $this
        ->t('Show numbers inside pagination buttons.'),
    );

    //responsive
    $element['responsive'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Responsive'),
      '#default_value' => $this
        ->getSetting('responsive'),
      '#description' => $this
        ->t('Uncheck to use Owl Carousel on desktop-only.'),
    );

    //responsiveRefreshRate
    $element['responsiveRefreshRate'] = array(
      '#type' => 'number',
      '#title' => $this
        ->t('Responsive Refresh Rate'),
      '#default_value' => $this
        ->getSetting('responsiveRefreshRate'),
      '#description' => $this
        ->t('Check window width changes every 200ms for responsive actions.'),
    );

    //mouseDrag
    $element['mouseDrag'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Mouse Drag'),
      '#default_value' => $this
        ->getSetting('mouseDrag'),
      '#description' => $this
        ->t('Turn off/on mouse events.'),
    );

    //touchDrag
    $element['touchDrag'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Touch Drag'),
      '#default_value' => $this
        ->getSetting('touchDrag'),
      '#description' => $this
        ->t('Turn off/on touch events.'),
    );

    //transitionStyle
    $element['transitionStyle'] = array(
      '#type' => 'select',
      '#options' => array(
        'fade' => $this
          ->t('Fade'),
        'backSlide' => $this
          ->t('Back Slide'),
        'goDown' => $this
          ->t('Go Down'),
        'scaleUp' => $this
          ->t('ScaleUp'),
      ),
      '#title' => $this
        ->t('Transition Style'),
      '#default_value' => $this
        ->getSetting('transitionStyle'),
      '#description' => $this
        ->t('Add CSS3 transition style. Works only with one item on screen.'),
    );
    return $element + parent::settingsForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];

    // Implement settings summary.
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = array();
    $files = $this
      ->getEntitiesToView($items, $langcode);

    // Early opt-out if the field is empty.
    if (empty($files)) {
      return $elements;
    }
    $url = NULL;
    $image_link_setting = $this
      ->getSetting('image_link');

    // Check if the formatter involves a link.
    if ($image_link_setting == 'content') {
      $entity = $items
        ->getEntity();
      if (!$entity
        ->isNew()) {
        $url = $entity
          ->urlInfo();
      }
    }
    elseif ($image_link_setting == 'file') {
      $link_file = TRUE;
    }
    $image_style_setting = $this
      ->getSetting('image_style');

    // Collect cache tags to be added for each item in the field.
    $cache_tags = array();
    if (!empty($image_style_setting)) {
      $image_style = $this->imageStyleStorage
        ->load($image_style_setting);
      $cache_tags = $image_style
        ->getCacheTags();
    }
    foreach ($files as $delta => $file) {
      if (isset($link_file)) {
        $image_uri = $file
          ->getFileUri();
        $url = Url::fromUri(file_create_url($image_uri));
      }
      $cache_tags = Cache::mergeTags($cache_tags, $file
        ->getCacheTags());

      // Extract field item attributes for the theme function, and unset them
      // from the $item so that the field template does not re-render them.
      $item = $file->_referringItem;
      $item_attributes = $item->_attributes;
      unset($item->_attributes);
      $elements[$delta] = array(
        '#theme' => 'image_formatter',
        '#item' => $item,
        '#item_attributes' => $item_attributes,
        '#image_style' => $image_style_setting,
        '#url' => $url,
        '#cache' => array(
          'tags' => $cache_tags,
        ),
      );
    }
    $settings = _owl_default_settings();
    foreach ($settings as $k => $v) {
      $s = $this
        ->getSetting($k);
      $settings[$k] = isset($s) ? $s : $settings[$k];
    }
    return array(
      '#theme' => 'owl',
      '#items' => $elements,
      '#settings' => $settings,
      '#attached' => array(
        'library' => array(
          'owl/owl',
        ),
      ),
    );
  }

  /**
   * Generate the output appropriate for one field item.
   *
   * @param \Drupal\Core\Field\FieldItemInterface $item
   *   One field item.
   *
   * @return string
   *   The textual output generated.
   */
  protected function viewValue(FieldItemInterface $item) {

    // The text value has no text format assigned to it, so the user input
    // should equal the output, including newlines.
    return nl2br(Html::escape($item->value));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
EntityReferenceFormatterBase::checkAccess	protected	function	Checks access to the given entity.	3
EntityReferenceFormatterBase::getEntitiesToView	protected	function	Returns the referenced entities for display.	1
EntityReferenceFormatterBase::needsEntityLoad	protected	function	Returns whether the entity referenced by an item needs to be loaded.	1
EntityReferenceFormatterBase::prepareView	public	function	Loads the entities referenced in that field across all the entities being viewed. Overrides FormatterBase::prepareView
EntityReferenceFormatterBase::view	public	function	Overrides FormatterBase::view
FormatterBase::$fieldDefinition	protected	property	The field definition.
FormatterBase::$label	protected	property	The label display setting.
FormatterBase::$settings	protected	property	The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode	protected	property	The view mode.
FormatterBase::getFieldSetting	protected	function	Returns the value of a field setting.
FormatterBase::getFieldSettings	protected	function	Returns the array of field settings.
FormatterBase::isApplicable	public static	function	Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable	14
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
OwlFieldFormatter::$currentUser	protected	property
OwlFieldFormatter::$imageStyleStorage	protected	property
OwlFieldFormatter::create	public static	function	Creates an instance of the plugin. Overrides FormatterBase::create
OwlFieldFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
OwlFieldFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
OwlFieldFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
OwlFieldFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
OwlFieldFormatter::viewValue	protected	function	Generate the output appropriate for one field item.
OwlFieldFormatter::__construct	public	function	Constructs a FormatterBase object. Overrides FormatterBase::__construct
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
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.
PluginSettingsBase::$defaultSettingsMerged	protected	property	Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings	protected	property	The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	6
PluginSettingsBase::getSetting	public	function	Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings	public	function	Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults	protected	function	Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval	public	function	Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval	3
PluginSettingsBase::setSetting	public	function	Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings	public	function	Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
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.

You are here

class OwlFieldFormatter in Multipurpose Corporate Profile 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation