PhotoGrid.php in Views Photo Grid 8

Contains \Drupal\views_photo_grid\Plugin\views\style\PhotoGrid.

Namespace

Drupal\views_photo_grid\Plugin\views\style

File

src/Plugin/views/style/PhotoGrid.php

<?php

/**
 * @file
 * Contains \Drupal\views_photo_grid\Plugin\views\style\PhotoGrid.
 */
namespace Drupal\views_photo_grid\Plugin\views\style;

use Drupal\views\Plugin\views\style\StylePluginBase;
use Drupal\Core\Form\FormStateInterface;

/**
 * Style plugin to render the photo grid.
 *
 * @ViewsStyle(
 *   id = "views_photo_grid",
 *   title = @Translation("Photo Grid"),
 *   help = @Translation("Displays photos in a grid."),
 *   theme = "views_photo_grid_style",
 *   display_types = {"normal"}
 * )
 */
class PhotoGrid extends StylePluginBase {

  /**
   * Specifies if the plugin uses fields.
   *
   * @var bool
   */
  protected $usesFields = TRUE;

  /**
   * Specifies if the plugin uses row plugins.
   *
   * @var bool
   */
  protected $usesRowPlugin = FALSE;

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['grid_padding'] = array(
      'default' => 1,
    );
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['grid_padding'] = array(
      '#type' => 'number',
      '#title' => $this
        ->t('Padding'),
      '#size' => 2,
      '#description' => $this
        ->t('The amount of padding in pixels in between grid items.'),
      '#default_value' => $this->options['grid_padding'],
      '#maxlength' => 2,
    );
  }

  /**
   * Returns the name of the image field used in the view.
   */
  public function get_image_field_name() {
    $fields = $this->displayHandler->handlers['field'];

    // Find the first non-excluded image field.
    foreach ($fields as $key => $field) {

      // Get the storage definition in order to determine the field type.
      // Note: This is the same as $field->getFieldStorageDefinition(), but
      // that method is protected and inaccessible here.
      $field_storage_definitions = \Drupal::entityManager()
        ->getFieldStorageDefinitions($field->definition['entity_type']);
      $field_type = $field_storage_definitions[$field->field]
        ->getType();
      if (empty($field->options['exclude']) && $field_type == 'image') {
        return $field->field;
      }
    }
    return FALSE;
  }

  /**
   * Validates the view configuration.
   * Fails if there is a non-image field, or there are more
   * than one image fields that are not excluded from display.
   */
  function validate() {
    $errors = parent::validate();
    if ($this->view->storage
      ->isNew()) {

      // Skip validation when the view is being created.
      // (the default field is a title field, which would fail.)
      return $errors;
    }

    // Get a list of fields that have been added to the display.
    $fields = $this->displayHandler->handlers['field'];

    // Check if there is exactly one image field to display.
    $fields_valid = TRUE;
    $field_count = 0;
    foreach ($fields as $key => $field) {

      // Ignore fields excluded from display.
      if (!empty($field->options['exclude'])) {
        continue;
      }

      // Determine the field's type.
      $field_storage_definitions = \Drupal::entityManager()
        ->getFieldStorageDefinitions($field->definition['entity_type']);
      $field_type = $field_storage_definitions[$field->field]
        ->getType();
      if ($field_type != 'image') {

        // Cannot display non-image fields. That would break the image grid.
        $fields_valid = FALSE;
        break;
      }
      $field_count++;
    }
    if (!$fields_valid || $field_count > 1) {
      $errors[] = $this
        ->t('This format can display only one image field and no other fields.');
    }
    return $errors;
  }

}

Classes

Name	Description
PhotoGrid	Style plugin to render the photo grid.