class LightGallery in Lightgallery 8

Style plugin to render each item in an ordered or unordered list.

Plugin annotation


@ViewsStyle(
  id = "lightgallery",
  title = @Translation("Lightgallery"),
  help = @Translation("Displays a view as a Lightgallery, using the Lightgallery jQuery plugin."),
  theme = "lightgallery_views_style",
  theme_file = "lightgallery_views.theme.inc",
  display_types = {"normal"}
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
    class \Drupal\views\Plugin\views\style\StylePluginBase
    class \Drupal\lightgallery\Plugin\views\style\LightGallery

Expanded class hierarchy of LightGallery

File

src/Plugin/views/style/LightGallery.php, line 27

Namespace

Drupal\lightgallery\Plugin\views\style

View source

class LightGallery extends StylePluginBase {

  /**
   * {@inheritdoc}
   */
  protected $usesRowPlugin = FALSE;

  /**
   * {@inheritdoc}
   */
  protected $usesFields = TRUE;

  /**
   * {@inheritdoc}
   */
  protected $usesOptions = TRUE;

  /**
   * {@inheritdoc}
   */
  protected $usesGrouping = FALSE;

  /**
   * {@inheritdoc}
   */
  protected $usesRowClass = FALSE;

  /**
   * A Drupal entity field manager service.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $entityFieldManager;

  /**
   * Contains all available fields on view.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $fieldSources;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityFieldManagerInterface $entity_field_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityFieldManager = $entity_field_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {

    // Create a new instance of the plugin. This also allows us to extract
    // services from the container and inject them into our plugin via its own
    // constructor as needed.
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_field.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function evenEmpty() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);

    // Get the active field options.
    $this->fieldSources = $this
      ->confGetFieldSources();
    $field_images = $this
      ->getImageFields();
    $field_others = $this
      ->getNonImageFields();
    $missing_field_warning = '';
    if (empty($field_images)) {
      $missing_field_warning = $this
        ->t('<strong>You must add a field of type image to your view display before this value can be set.</strong><br/>');
    }
    $fields_settings = LightgalleryManager::getSettingFields();

    /*
     * @var \Drupal\lightgallery\Field\FieldInterface $field
     * @var \Drupal\lightgallery\Group\GroupInterface $group
     */
    foreach ($fields_settings as $field) {
      $group = $field
        ->getGroup();
      if (empty($form[$group
        ->getName()])) {

        // Attach group to form.
        $form[$group
          ->getName()] = [
          '#type' => 'details',
          '#title' => $group
            ->getTitle(),
          '#open' => !empty($group
            ->getOpenValue()) ? $this->options['lightgallery'][$group
            ->getOpenValue()] : $group
            ->isOpen(),
        ];
      }
      if ($field
        ->appliesToViews()) {

        // Attach field to group and form.
        $form[$group
          ->getName()][$field
          ->getName()] = [
          '#type' => $field
            ->getType(),
          '#title' => $field
            ->getTitle(),
          '#default_value' => isset($this->options['lightgallery'][$field
            ->getName()]) ? $this->options['lightgallery'][$field
            ->getName()] : $field
            ->getDefaultValue(),
          '#description' => $field
            ->getDescription(),
          '#required' => $field
            ->isRequired(),
        ];
        if ($field
          ->getName() == 'thumb_field' || $field
          ->getName() == 'image_field') {

          // Add exception for these fields.
          $form[$group
            ->getName()][$field
            ->getName()]['#suffix'] = $missing_field_warning;
        }
        if (!empty($field
          ->getOptions())) {

          // Set field options.
          if (is_callable($field
            ->getOptions())) {
            $form[$group
              ->getName()][$field
              ->getName()]['#options'] = call_user_func($field
              ->getOptions());
          }
        }
      }
    }
  }

  /**
   * Form validator.
   *
   * @param array $form
   *   The form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state.
   */
  public function validateOptionsForm(array &$form, FormStateInterface $form_state) {
    parent::validateOptionsForm($form, $form_state);

    // Flatten style options array.
    $style_options = $form_state
      ->getValue('style_options');
    $form_state
      ->setValue([
      'style_options',
      'lightgallery',
    ], LightgalleryManager::flattenArray($style_options));

    // Unset nested values.
    $form_state
      ->unsetValue([
      'style_options',
      'lightgallery_core',
    ]);
    $form_state
      ->unsetValue([
      'style_options',
      'lightgallery_thumbs',
    ]);
    $form_state
      ->unsetValue([
      'style_options',
      'lightgallery_autoplay',
    ]);
    $form_state
      ->unsetValue([
      'style_options',
      'lightgallery_full_screen',
    ]);
    $form_state
      ->unsetValue([
      'style_options',
      'lightgallery_pager',
    ]);
    $form_state
      ->unsetValue([
      'style_options',
      'lightgallery_zoom',
    ]);
    $form_state
      ->unsetValue([
      'style_options',
      'lightgallery_hash',
    ]);
  }

  /**
   * Utility to determine which view fields can be used for image data.
   */
  protected function confGetFieldSources() {
    $options = [
      'field_options_images' => [],
      'field_options' => [],
    ];
    $view = $this->view;
    $field_handlers = $view->display_handler
      ->getHandlers('field');
    $field_labels = $view->display_handler
      ->getFieldLabels();

    /** @var \Drupal\views\Plugin\views\field\FieldHandlerInterface $handler */

    // Separate image fields from non-image fields. For image fields we can
    // work with fids and fields of type image or file.
    foreach ($field_handlers as $field => $handler) {
      $is_image = FALSE;
      $id = $handler
        ->getPluginId();
      $name = $field_labels[$field];
      if ($id == 'field') {

        // The field definition is on the handler, it's right bloody there, but
        // it's protected so we can't access it. This means we have to take the
        // long road (via our own injected entity manager) to get the field type
        // info.
        $entity_type = $handler
          ->getEntityType();

        // Fetch the real field name, because views alters the field name if the
        // same fields gets added multiple times.
        $field_name = $handler->field;
        $field_definition = $this->entityFieldManager
          ->getFieldStorageDefinitions($entity_type)[$field_name];
        if ($field_definition) {
          $field_type = $field_definition
            ->getType();
          if ($field_type == 'image' || $field_type == 'file') {
            $field_cardinality = $field_definition
              ->get('cardinality');
            $options['field_options_images'][$field] = $name . ($field_cardinality == 1 ? '' : '*');
            $is_image = TRUE;
          }
        }
      }
      if (!$is_image) {
        $options['field_options'][$field] = $name;
      }
    }
    return $options;
  }

  /**
   * Render fields.
   *
   * @Override parent.
   */
  public function renderFields(array $result) {
    $rendered_fields = [];
    $this->view->row_index = 0;
    $keys = array_keys($this->view->field);

    // If all fields have a field::access FALSE there might be no fields, so
    // there is no reason to execute this code.
    if (!empty($keys)) {
      $fields = $this->view->field;
      $field_sources = $this
        ->confGetFieldSources();
      $image_fields = array_keys($field_sources['field_options_images']);
      foreach ($result as $count => $row) {
        $this->view->row_index = $count;
        foreach ($keys as $id) {
          if (in_array($id, $image_fields)) {

            // This is an image/thumb field.
            // Create URI for selected image style.
            $image_style = $this->view->field[$id]->options['settings']['image_style'];
            $field_name = $fields[$id]->field;
            $file = $result[$count]->_entity->{$field_name}->entity;
            if ($file instanceof FileInterface && ($uri = $file
              ->getFileUri())) {
              if (!empty($image_style)) {
                $rendered_fields[$count][$id] = ImageStyle::load($image_style)
                  ->buildUrl($uri);
              }
              else {
                $rendered_fields[$count][$id] = file_create_url($uri);
              }
            }
          }
          else {

            // Just render the field as views would do.
            $rendered_fields[$count][$id] = $this->view->field[$id]
              ->render($row);
          }
        }

        // Populate row tokens.
        $this->rowTokens[$count] = $this->view->field[$id]
          ->getRenderTokens([]);
      }
    }
    unset($this->view->row_index);
    return $rendered_fields;
  }

  /**
   * Returns available image fields on view.
   */
  private function getImageFields() {
    return !empty($this->fieldSources['field_options_images']) ? $this->fieldSources['field_options_images'] : [];
  }

  /**
   * Returns available fields on view apart from images.
   */
  private function getNonImageFields() {
    return !empty($this->fieldSources['field_options']) ? $this->fieldSources['field_options'] : [];
  }

}

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
LightGallery::$entityFieldManager	protected	property	A Drupal entity field manager service.
LightGallery::$fieldSources	protected	property	Contains all available fields on view.
LightGallery::$usesFields	protected	property	Does the style plugin for itself support to add fields to its output. Overrides StylePluginBase::$usesFields
LightGallery::$usesGrouping	protected	property	Does the style plugin support grouping of rows. Overrides StylePluginBase::$usesGrouping
LightGallery::$usesOptions	protected	property	Denotes whether the plugin has an additional options form. Overrides StylePluginBase::$usesOptions
LightGallery::$usesRowClass	protected	property	Does the style plugin support custom css class for the rows. Overrides StylePluginBase::$usesRowClass
LightGallery::$usesRowPlugin	protected	property	Whether or not this style uses a row plugin. Overrides StylePluginBase::$usesRowPlugin
LightGallery::buildOptionsForm	public	function	Provide a form to edit options for this plugin. Overrides StylePluginBase::buildOptionsForm
LightGallery::confGetFieldSources	protected	function	Utility to determine which view fields can be used for image data.
LightGallery::create	public static	function	Creates an instance of the plugin. Overrides PluginBase::create
LightGallery::evenEmpty	public	function	Should the output of the style plugin be rendered even if it's a empty view. Overrides StylePluginBase::evenEmpty
LightGallery::getImageFields	private	function	Returns available image fields on view.
LightGallery::getNonImageFields	private	function	Returns available fields on view apart from images.
LightGallery::renderFields	public	function	Render fields. Overrides StylePluginBase::renderFields
LightGallery::validateOptionsForm	public	function	Form validator. Overrides StylePluginBase::validateOptionsForm
LightGallery::__construct	public	function	Constructs a PluginBase object. Overrides PluginBase::__construct
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::$definition	public	property	Plugins's definition
PluginBase::$displayHandler	public	property	The display object this plugin is for.
PluginBase::$options	public	property	Options for this plugin will be held here.
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::$renderer	protected	property	Stores the render API renderer.	3
PluginBase::$view	public	property	The top object of a view.	1
PluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	14
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::doFilterByDefinedOptions	protected	function	Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions	public	function	Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens	public	function	Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
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::getProvider	public	function	Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer	protected	function	Returns the render API renderer.	1
PluginBase::globalTokenForm	public	function	Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace	public	function	Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY		constant	Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED		constant	Include negotiated languages when listing languages.
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::listLanguages	protected	function	Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle	public	function	Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup	public static	function	Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData	public static	function	Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::queryLanguageSubstitutions	public static	function	Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults	protected	function	Fills up the options of the plugin with defaults.
PluginBase::submitOptionsForm	public	function	Handle any special handling on the validate form. Overrides ViewsPluginInterface::submitOptionsForm	16
PluginBase::summaryTitle	public	function	Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle	6
PluginBase::themeFunctions	public	function	Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions	1
PluginBase::unpackOptions	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions	public	function	Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions	8
PluginBase::viewsTokenReplace	protected	function	Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin.	1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT		constant	Query string to indicate the site default language.
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.
StylePluginBase::$defaultFieldLabels	protected	property	Should field labels be enabled by default.	1
StylePluginBase::$groupingTheme	protected	property	The theme function used to render the grouping set.
StylePluginBase::$rendered_fields	protected	property	Stores the rendered field values, keyed by the row index and field name.
StylePluginBase::$rowTokens	protected	property	Store all available tokens row rows.
StylePluginBase::buildSort	public	function	Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query.	1
StylePluginBase::buildSortPost	public	function	Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view.	1
StylePluginBase::defaultFieldLabels	public	function	Return TRUE if this style enables field labels by default.	1
StylePluginBase::defineOptions	protected	function	Information about options for all kinds of purposes will be held here. Overrides PluginBase::defineOptions	9
StylePluginBase::destroy	public	function	Clears a plugin. Overrides PluginBase::destroy
StylePluginBase::elementPreRenderRow	public	function	#pre_render callback for view row field rendering.
StylePluginBase::getField	public	function	Gets a rendered field.
StylePluginBase::getFieldValue	public	function	Get the raw field value.
StylePluginBase::getRowClass	public	function	Return the token replaced row class for the specified row.
StylePluginBase::init	public	function	Overrides \Drupal\views\Plugin\views\PluginBase::init(). Overrides PluginBase::init
StylePluginBase::preRender	public	function	Allow the style to do stuff before each row is rendered.
StylePluginBase::query	public	function	Add anything to the query that we might need to. Overrides PluginBase::query	1
StylePluginBase::render	public	function	Render the display in this style.	7
StylePluginBase::renderGrouping	public	function	Group records as needed for rendering.
StylePluginBase::renderGroupingSets	public	function	Render the grouping sets.
StylePluginBase::renderRowGroup	protected	function	Renders a group of rows of the grouped view.
StylePluginBase::tokenizeValue	public	function	Take a value and apply token replacement logic to it.
StylePluginBase::trustedCallbacks	public static	function	Lists the trusted callbacks provided by the implementing class. Overrides PluginBase::trustedCallbacks
StylePluginBase::usesFields	public	function	Return TRUE if this style also uses fields.	3
StylePluginBase::usesGrouping	public	function	Returns the usesGrouping property.	3
StylePluginBase::usesRowClass	public	function	Returns the usesRowClass property.	3
StylePluginBase::usesRowPlugin	public	function	Returns the usesRowPlugin property.	10
StylePluginBase::usesTokens	public	function	Return TRUE if this style uses tokens.
StylePluginBase::validate	public	function	Validate that the plugin is correct and can be saved. Overrides PluginBase::validate
StylePluginBase::wizardForm	public	function	Provide a form in the views wizard if this style is selected.
StylePluginBase::wizardSubmit	public	function	Alter the options of a display before they are added to the view.	1
TrustedCallbackInterface::THROW_EXCEPTION		constant	Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION		constant	Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING		constant	Untrusted callbacks trigger E_USER_WARNING errors.

You are here

class LightGallery in Lightgallery 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation