You are here

Home » API reference » Views Photo Grid 7 » views_photo_grid_plugin_style.inc

class views_photo_grid_plugin_style in Views Photo Grid 7

@file Style plugin for Views Photo Grid.

Hierarchy

Expanded class hierarchy of views_photo_grid_plugin_style

1 string reference to 'views_photo_grid_plugin_style'
views_photo_grid_views_plugins in views/views_photo_grid.views.inc
Implements hook_views_plugins().

File

views/views_photo_grid_plugin_style.inc, line 7
Style plugin for Views Photo Grid.

View source 
class views_photo_grid_plugin_style extends views_plugin_style {

  /**
   * Sets option defaults.
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['grid_padding'] = array(
      'default' => 1,
    );
    return $options;
  }

  /**
   * Renders the options form.
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['grid_padding'] = array(
      '#type' => 'textfield',
      '#title' => t('Padding'),
      '#size' => 2,
      '#description' => 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.
   */
  function get_image_field_name() {
    $fields = $this->display->handler
      ->get_handlers('field');

    // Find the first non-excluded image field.
    foreach ($fields as $key => $field) {
      if (empty($field->options['exclude']) && !empty($field->field_info['type']) && $field->field_info['type'] == 'image') {
        return $key;
      }
    }
    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 (!is_numeric($this->view->vid)) {

      // 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->display->handler
      ->get_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;
      }
      if (empty($field->field_info['type']) || $field->field_info['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[] = t('This format can display only one image field and no other fields.');
    }
    return $errors;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
views_object::$definition public property Handler's definition.
views_object::$options public property Except for displays, options for the object will be held here. 1
views_object::altered_option_definition function Collect this handler's option definition and alter them, ready for use.
views_object::construct public function Views handlers use a special construct function. 4
views_object::export_option public function 1
views_object::export_options public function
views_object::export_option_always public function Always exports the option, regardless of the default value.
views_object::options Deprecated public function Set default options on this object. 1
views_object::set_default_options public function Set default options.
views_object::set_definition public function Let the handler know what its full definition is.
views_object::unpack_options public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable public function Unpack a single option definition.
views_object::unpack_translatables public function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults public function
views_photo_grid_plugin_style::get_image_field_name function Returns the name of the image field used in the view.
views_photo_grid_plugin_style::options_form function Renders the options form. Overrides views_plugin_style::options_form
views_photo_grid_plugin_style::option_definition function Sets option defaults. Overrides views_plugin_style::option_definition
views_photo_grid_plugin_style::validate function 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. Overrides views_plugin_style::validate
views_plugin::$display public property The current used views display.
views_plugin::$plugin_name public property The plugin name of this plugin, for example table or full.
views_plugin::$plugin_type public property The plugin type of this plugin, for example style or query.
views_plugin::$view public property The top object of a view. Overrides views_object::$view 1
views_plugin::additional_theme_functions public function Provide a list of additional theme functions for the theme info page.
views_plugin::options_submit public function Handle any special handling on the validate form. 9
views_plugin::plugin_title public function Return the human readable name of the display.
views_plugin::summary_title public function Returns the summary of the settings in the display. 8
views_plugin::theme_functions public function Provide a full list of possible theme templates used by this style.
views_plugin_style::$row_plugin public property The row plugin, if it's initialized and the style itself supports it.
views_plugin_style::$row_tokens public property Store all available tokens row rows.
views_plugin_style::build_sort 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
views_plugin_style::build_sort_post 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
views_plugin_style::destroy public function Destructor. Overrides views_object::destroy
views_plugin_style::even_empty public function Should the output of the style plugin be rendered even if it's empty. 1
views_plugin_style::get_field public function Get a rendered field.
views_plugin_style::get_field_value public function Get the raw field value.
views_plugin_style::get_row_class public function Return the token replaced row class for the specified row.
views_plugin_style::init public function Initialize a style plugin.
views_plugin_style::options_validate public function Validate the options form. Overrides views_plugin::options_validate
views_plugin_style::pre_render public function Allow the style to do stuff before each row is rendered.
views_plugin_style::query public function Add anything to the query that we might need to. Overrides views_plugin::query 2
views_plugin_style::render public function Render the display in this style. 5
views_plugin_style::render_fields public function Render all of the fields for a given style and store them on the object.
views_plugin_style::render_grouping public function Group records as needed for rendering.
views_plugin_style::render_grouping_sets public function Render the grouping sets.
views_plugin_style::tokenize_value public function Take a value and apply token replacement logic to it.
views_plugin_style::uses_fields public function Return TRUE if this style also uses fields.
views_plugin_style::uses_row_class public function Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_row_plugin public function Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_tokens public function Return TRUE if this style uses tokens.