You are here

Home » API reference » Collage Formatter 7 » collageformatter_plugin_style_collage.inc

class collageformatter_plugin_style_collage in Collage Formatter 7

Class collageformatter_plugin_style_collage.

Hierarchy

Expanded class hierarchy of collageformatter_plugin_style_collage

1 string reference to 'collageformatter_plugin_style_collage'
collageformatter_views_plugins in ./collageformatter.views.inc
Implements hook_views_plugins().

File

views/collageformatter_plugin_style_collage.inc, line 10
Definition of the Views style plugin.

View source 
class collageformatter_plugin_style_collage extends views_plugin_style {
  public function option_definition() {
    $options = parent::option_definition();
    $options += _collageformatter_default_settings();
    return $options;
  }

  /**
   * Provide the form for setting options.
   */
  public function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['#collageformatter'] = TRUE;
    $form += _collageformatter_settings_form($this->options);
    $form['image_link_image_style']['#states'] = array(
      'visible' => array(
        ':input[name="style_options[image_link]"]' => array(
          'value' => 'file',
        ),
      ),
    );
    $form['image_link_modal']['#states'] = array(
      'visible' => array(
        ':input[name="style_options[image_link]"]' => array(
          'value' => 'file',
        ),
      ),
    );
    $form['image_link_class']['#states'] = array(
      'invisible' => array(
        ':input[name="style_options[image_link]"]' => array(
          'value' => '',
        ),
      ),
    );
    $form['image_link_rel']['#states'] = array(
      'invisible' => array(
        ':input[name="style_options[image_link]"]' => array(
          'value' => '',
        ),
      ),
    );
  }
  public function render() {
    $collage_fields = array();
    foreach ($this->view->field as $field_name => $field) {
      if (isset($field->field_info) && $field->field_info['type'] == 'image') {
        $collage_fields[] = $field->handler_type . '_' . $field_name;
      }
    }
    $settings = $this->options;
    $settings['gallery'] = isset($this->view->dom_id) ? $this->view->dom_id : $this->view->name;
    $images = array();
    foreach ($this->view->result as $result) {
      foreach ($collage_fields as $field_name) {
        foreach ($result->{$field_name} as $element) {
          $images[$element['raw']['fid']] = $element['raw'];
          if ($settings['image_link'] == 'content') {
            $content_uri = entity_uri($result->_field_data['nid']['entity_type'], $result->_field_data['nid']['entity']);
            $images[$element['raw']['fid']]['content_uri'] = $content_uri['path'];
          }
        }
      }
    }
    if (empty($images)) {
      return '';
    }
    $output = collageformatter_render_collage($images, $settings);
    return $output;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
collageformatter_plugin_style_collage::options_form public function Provide the form for setting options. Overrides views_plugin_style::options_form
collageformatter_plugin_style_collage::option_definition public function Information about options for all kinds of purposes will be held here. Overrides views_plugin_style::option_definition
collageformatter_plugin_style_collage::render public function Render the display in this style. Overrides views_plugin_style::render
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_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_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.
views_plugin_style::validate public function Validate that the plugin is correct and can be saved. Overrides views_plugin::validate