You are here

Home » API reference » RoyalSlider Integration 8 » RoyalSliderFormatter.php

class RoyalSliderFormatter in RoyalSlider Integration 8

Plugin implementation of the 'royalslider' formatter.

Plugin annotation


@FieldFormatter(
  id = "royalslider",
  label = @Translation("RoyalSlider"),
  field_types = {
    "image"
  }
)

Hierarchy

Expanded class hierarchy of RoyalSliderFormatter

File

src/Plugin/Field/FieldFormatter/RoyalSliderFormatter.php, line 30
Contains \Drupal\royalslider\Plugin\Field\FieldFormatter\RoyalSliderFormatter.

Namespace

Drupal\royalslider\Plugin\Field\FieldFormatter
View source 
class RoyalSliderFormatter extends FormatterBase implements ContainerFactoryPluginInterface {

  /**
   * Constructs an RoyalSliderFormatter object.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param string $label
   *   The formatter label display setting.
   * @param string $view_mode
   *   The view mode.
   * @param array $third_party_settings
   *   Any third party settings settings.
   * @param \Drupal\Core\Session\AccountInterface $current_user
   *   The current user.
   * @param \Drupal\Core\Utility\LinkGeneratorInterface $link_generator
   *   The link generator service.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, AccountInterface $current_user, LinkGeneratorInterface $link_generator) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->currentUser = $current_user;
    $this->linkGenerator = $link_generator;
  }

  /**
   * {@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('link_generator'));
  }

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

  /**
   * The link generator.
   *
   * @var \Drupal\Core\Utility\LinkGeneratorInterface
   */
  protected $linkGenerator;

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return array(
      'royalslider_optionset' => '',
    ) + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $royalslider_optionsets = royalslider_optionset_options(FALSE);
    $element['royalslider_optionset'] = array(
      '#title' => t('OptionSet'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('royalslider_optionset'),
      '#empty_option' => t('None (defaults)'),
      '#options' => $royalslider_optionsets,
      '#description' => array(
        '#markup' => $this->linkGenerator
          ->generate($this
          ->t('Configure RoyalSlider OptionSets'), new Url('entity.royalslider_optionset.collection')),
        '#access' => $this->currentUser
          ->hasPermission('administer site configuration'),
      ),
    );
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = array();
    $optionsets = royalslider_optionset_options(FALSE);

    // Unset possible 'No defined optionset' option.
    unset($optionsets['']);

    // Optionsets could be lost because of enabled/disabled modules that defines
    // their styles in code.
    $optionset_setting = $this
      ->getSetting('royalslider_optionset');
    if (isset($optionsets[$optionset_setting])) {
      $summary[] = t('OptionSet: @optionset', array(
        '@optionset' => $optionsets[$optionset_setting],
      ));
    }
    else {
      $summary[] = t('Default options');
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items) {
    $optionset_setting = $this
      ->getSetting('royalslider_optionset');

    // @TODO load a default optionset if it is set to default.
    $optionset = entity_load('royalslider_optionset', $optionset_setting);
    $entity = $items
      ->getEntity();
    $fieldname = $items
      ->getName();
    $slider_id = 'royalslider-' . $entity
      ->getEntityTypeId() . '-' . $entity
      ->id() . '-' . $fieldname;
    $elements = array(
      '#theme' => 'royalslider_formatter',
      '#attributes' => array(
        'id' => $slider_id,
      ),
      '#items' => array(),
      '#optionset' => $optionset_setting,
      '#cache' => [
        'tags' => $optionset
          ->getCacheTags(),
      ],
    );
    foreach ($items as $delta => $item) {
      $elements['#items'][] = [
        '#theme' => 'image_formatter',
        '#item' => $item,
      ];
    }
    $elements['#attached'] = [
      'library' => [
        'royalslider/royalslider',
        'royalslider/royalslider-rsdefault',
      ],
      'drupalSettings' => [
        'royalslider' => [
          'optionsets' => [
            $optionset
              ->label() => $optionset
              ->buildJsOptionset(),
          ],
          'instances' => [
            $slider_id => [
              'optionset' => $optionset
                ->label(),
            ],
          ],
        ],
      ],
    ];
    return $elements;
  }

}

Members

Namesort descending 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
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
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
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::$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
RoyalSliderFormatter::$currentUser protected property The current user.
RoyalSliderFormatter::$linkGenerator protected property The link generator.
RoyalSliderFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
RoyalSliderFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
RoyalSliderFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
RoyalSliderFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
RoyalSliderFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
RoyalSliderFormatter::__construct public function Constructs an RoyalSliderFormatter object. Overrides FormatterBase::__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.