class draggableviews_handler_field_draggable in DraggableViews 7.2

@file Views field handler. Contains all relevant Draggableviews options and related logic. Implements the Views Form API.

Hierarchy

class \views_object
- class \views_handler
  - class \views_handler_field
    class \draggableviews_handler_field_draggable

Expanded class hierarchy of draggableviews_handler_field_draggable

1 string reference to 'draggableviews_handler_field_draggable'

draggableviews_views_data_alter in views/draggableviews.views.inc: Implements hook_views_data_alter().

File

views/draggableviews_handler_field_draggable.inc, line 10: Views field handler. Contains all relevant Draggableviews options and related logic. Implements the Views Form API.

View source

class draggableviews_handler_field_draggable extends views_handler_field {
  function construct() {
    parent::construct();
  }
  function option_definition() {
    $options = parent::option_definition();
    $options['draggableviews'] = array(
      'contains' => array(
        'handler' => array(
          'default' => 'draggableviews_handler_native',
        ),
        'hierarchy_handler' => array(
          'default' => '',
        ),
        'save_button_label' => array(
          'default' => 'Save',
        ),
        'ajax' => array(
          'default' => FALSE,
        ),
      ),
    );

    // Populate default values of form elements provided by handlers.
    foreach (draggableviews_get_handlers() as $handler_id => $handler_object) {
      $options['draggableviews']['contains'][$handler_id] = array(
        'default' => $handler_object
          ->option_definition(),
      );
    }
    foreach (draggableviews_get_hierarchy_handlers() as $handler_id => $handler_object) {
      $options['draggableviews']['contains'][$handler_id] = array(
        'default' => $handler_object
          ->option_definition(),
      );
    }
    return $options;
  }
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);

    // Remove not needed settings options.
    $form['alter']['#access'] = FALSE;
    $form['style_settings']['#access'] = FALSE;
    $form['empty_field_behavior']['#access'] = FALSE;
    $form['draggableviews'] = array(
      '#type' => 'fieldset',
      '#title' => t('Draggable Views'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
    );
    $handler_options = array();
    $handler_forms = array();
    foreach (draggableviews_get_handlers() as $handler_id => $handler_object) {
      $handler = ctools_get_plugins('draggableviews', 'handler', $handler_id);
      $handler_options[$handler_id] = filter_xss($handler['label']);
      $handler_forms[$handler_id] = $handler_object
        ->options_form($this);
    }
    $form['draggableviews']['handler'] = array(
      '#type' => 'select',
      '#title' => t('Sort handler'),
      '#options' => $handler_options,
      '#default_value' => $this->options['draggableviews']['handler'],
    );

    // Add handler's form element as fieldset that
    // is active only if handler selected.
    foreach ($handler_forms as $handler_id => $handler_form_element) {

      // Skip empty handler's form elements.
      if (empty($handler_form_element)) {
        continue;
      }
      $form['draggableviews'][$handler_id] = array(
        '#type' => 'fieldset',
        '#title' => check_plain($form['draggableviews']['handler']['#options'][$handler_id]),
        '#collapsible' => FALSE,
        '#states' => array(
          'visible' => array(
            'select[name="options[draggableviews][handler]"]' => array(
              'value' => $handler_id,
            ),
          ),
        ),
      );
      foreach ($handler_form_element as $key => $form_element) {
        $form['draggableviews'][$handler_id][$key] = $form_element;
      }
    }
    $hierarchy_handler_options = array(
      '' => t('- None -'),
    );
    $hierarchy_handler_forms = array();
    foreach (draggableviews_get_hierarchy_handlers() as $handler_id => $handler_object) {
      $handler = ctools_get_plugins('draggableviews', 'hierarchy_handler', $handler_id);
      $hierarchy_handler_options[$handler_id] = filter_xss($handler['label']);
      $hierarchy_handler_forms[$handler_id] = $handler_object
        ->options_form($this);
    }
    $form['draggableviews']['hierarchy_handler'] = array(
      '#type' => 'select',
      '#title' => t('Hierarchy handler'),
      '#options' => $hierarchy_handler_options,
      '#default_value' => $this->options['draggableviews']['hierarchy_handler'],
    );

    // Add handler's form element as fieldset that
    // is active only if handler selected.
    foreach ($hierarchy_handler_forms as $handler_id => $hierarchy_handler_form_element) {

      // Skip empty handler's form elements.
      if (empty($hierarchy_handler_form_element)) {
        continue;
      }
      $form['draggableviews'][$handler_id] = array(
        '#type' => 'fieldset',
        '#title' => check_plain($form['draggableviews']['handler']['#options'][$handler_id]),
        '#collapsible' => FALSE,
        '#states' => array(
          'visible' => array(
            'select[name="options[draggableviews][hierarchy_handler]"]' => array(
              'value' => $handler_id,
            ),
          ),
        ),
      );
      foreach ($hierarchy_handler_form_element as $key => $form_element) {
        $form['draggableviews'][$handler_id][$key] = $form_element;
      }
    }
    $form['draggableviews']['save_button_label'] = array(
      '#type' => 'textfield',
      '#title' => t('Custom Save button label'),
      '#size' => 20,
      '#description' => t("Allow to change Save button Label."),
      '#default_value' => $this->options['draggableviews']['save_button_label'],
    );
    $form['draggableviews']['ajax'] = array(
      '#type' => 'checkbox',
      '#title' => t('Ajax'),
      '#description' => t('Use ajax in draggable form.'),
      '#default_value' => $this->options['draggableviews']['ajax'],
    );
  }
  function render($values) {
    return '<!--form-item-' . $this->options['id'] . '--' . $this->view->row_index . '-->';
  }

  /**
   * The form which replaces the placeholder from render().
   */
  function views_form(&$form, &$form_state) {

    // The view is empty, abort.
    if (empty($this->view->result)) {
      return;
    }

    // If this view is a summary, do not add a form.
    if ($this->field_alias == 'unknown') {
      return;
    }
    $form[$this->options['id']] = array(
      '#tree' => TRUE,
    );
    $range = count($this->view->result);

    // At this point, the query has already been run, so we can access the results
    // in order to get the base key value (for example, nid for nodes).
    foreach ($this->view->result as $row_index => $row) {
      $entity_id = $this
        ->get_value($row);
      $form[$this->options['id']][$row_index] = array(
        '#tree' => TRUE,
      );
      $handler_object = draggableviews_get_handler_class($this->options['draggableviews']['handler']);

      // Weight field selectbox.
      $form[$this->options['id']][$row_index]['weight'] = array(
        '#type' => 'select',
        '#options' => range(-$range, $range),
        '#attributes' => array(
          'class' => array(
            'draggableviews-weight',
          ),
        ),
        '#default_value' => $handler_object
          ->get($this, $row_index),
      );

      // Item to keep id of the entity.
      $form[$this->options['id']][$row_index]['id'] = array(
        '#type' => 'hidden',
        '#value' => $this->view->result[$row_index]->{$this->field_alias},
        '#attributes' => array(
          'class' => array(
            'draggableviews-id',
          ),
        ),
      );

      // Add parent and depth field.
      if (!empty($this->options['draggableviews']['hierarchy_handler'])) {
        $hierarchy_handler_object = draggableviews_get_handler_class($this->options['draggableviews']['hierarchy_handler'], 'hierarchy_handler');
        $form[$this->options['id']][$row_index]['parent'] = array(
          '#type' => 'hidden',
          '#default_value' => $hierarchy_handler_object
            ->get($this, $row_index),
          '#attributes' => array(
            'class' => array(
              'draggableviews-parent',
            ),
          ),
        );
        $form[$this->options['id']][$row_index]['depth'] = array(
          '#type' => 'hidden',
          '#default_value' => $hierarchy_handler_object
            ->get_depth($this, $row_index),
          '#attributes' => array(
            'class' => array(
              'draggableviews-depth',
            ),
          ),
        );
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
draggableviews_handler_field_draggable::construct		function	Construct a new field handler. Overrides views_handler_field::construct
draggableviews_handler_field_draggable::options_form		function	Default options form provides the label widget that all fields should have. Overrides views_handler_field::options_form
draggableviews_handler_field_draggable::option_definition		function	Information about options for all kinds of purposes will be held here. Overrides views_handler_field::option_definition
draggableviews_handler_field_draggable::render		function	Render the field. Overrides views_handler_field::render
draggableviews_handler_field_draggable::views_form		function	The form which replaces the placeholder from render().
views_handler::$handler_type	public	property	The type of the handler, for example filter/footer/field.
views_handler::$query	public	property	Where the $query object will reside:.	1
views_handler::$real_field	public	property	The actual field in the database table, maybe different on other kind of query plugins/special handlers.
views_handler::$relationship	public	property	The relationship used for this field.
views_handler::$table_alias	public	property	The alias of the table of this handler which is used in the query.
views_handler::$view	public	property	The top object of a view. Overrides views_object::$view
views_handler::accept_exposed_input	public	function	Take input from exposed handlers and assign to this handler, if necessary.	1
views_handler::access	public	function	Check whether current user has access to this handler.	10
views_handler::broken	public	function	Determine if the handler is considered 'broken'.	6
views_handler::can_expose	public	function	Determine if a handler can be exposed.	2
views_handler::case_transform	public	function	Transform a string by a certain method.
views_handler::ensure_my_table	public	function	Ensure the main table for this handler is in the query. This is used a lot.	8
views_handler::exposed_form	public	function	Render our chunk of the exposed handler form when selecting.	1
views_handler::exposed_info	public	function	Get information about the exposed form for the form renderer.	1
views_handler::exposed_submit	public	function	Submit the exposed handler form.
views_handler::exposed_validate	public	function	Validate the exposed handler form.	4
views_handler::expose_form	public	function	Form for exposed handler options.	2
views_handler::expose_options	public	function	Set new exposed option defaults when exposed setting is flipped on.	2
views_handler::expose_submit	public	function	Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data.
views_handler::expose_validate	public	function	Validate the options form.	1
views_handler::extra_options	public	function	Provide defaults for the handler.
views_handler::extra_options_form	public	function	Provide a form for setting options.	1
views_handler::extra_options_submit	public	function	Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.
views_handler::extra_options_validate	public	function	Validate the options form.
views_handler::get_field	public	function	Shortcut to get a handler's raw field value.
views_handler::get_join	public	function	Get the join object that should be used for this handler.
views_handler::groupby_form	public	function	Provide a form for aggregation settings.	1
views_handler::groupby_form_submit	public	function	Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.	1
views_handler::has_extra_options	public	function	If a handler has 'extra options' it will get a little settings widget and another form called extra_options.	1
views_handler::is_a_group	public	function	Returns TRUE if the exposed filter works like a grouped filter.	1
views_handler::is_exposed	public	function	Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::multiple_exposed_input	public	function	Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets.	1
views_handler::needs_style_plugin	public	function	Determine if the argument needs a style plugin.	1
views_handler::options_validate	public	function	Validate the options form.	4
views_handler::placeholder	public	function	Provides a unique placeholders for handlers.
views_handler::post_execute	public	function	Run after the view is executed, before the result is cached.	1
views_handler::pre_query	public	function	Run before the view is built.	1
views_handler::sanitize_value	public	function	Sanitize the value for output.
views_handler::set_relationship	public	function	Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::show_expose_button	public	function	Shortcut to display the expose/hide button.	2
views_handler::show_expose_form	public	function	Shortcut to display the exposed options form.
views_handler::store_exposed_input	public	function	If set to remember exposed input in the session, store it there.	1
views_handler::use_group_by	public	function	Provides the handler some groupby.	2
views_handler::validate	public	function	Validates the handler against the complete View.	1
views_handler_field::$additional_fields	public	property	Stores additional fields which get added to the query. The generated aliases are stored in $aliases.
views_handler_field::$aliases	public	property
views_handler_field::$field_alias	public	property
views_handler_field::$last_render_index	protected	property	Keeps track of the last render index.
views_handler_field::$original_value	public	property	The field value prior to any rewriting.
views_handler_field::add_additional_fields	public	function	Add 'additional' fields to the query.
views_handler_field::add_self_tokens	public	function	Add any special tokens this field might use for itself.	4
views_handler_field::admin_summary	public	function	Provide extra data to the administration form Overrides views_handler::admin_summary
views_handler_field::advanced_render	public	function	Render a field using advanced settings.
views_handler_field::allow_advanced_render	public	function	Determine if this field can allow advanced rendering.	1
views_handler_field::click_sort	public	function	Called to determine what to tell the clicksorter.	1
views_handler_field::click_sortable	public	function	Determine if this field is click sortable.	1
views_handler_field::document_self_tokens	public	function	Document any special tokens this field might use for itself.	4
views_handler_field::element_classes	public	function	Return the class of the field.
views_handler_field::element_label_classes	public	function	Return the class of the field's label.
views_handler_field::element_label_type	public	function	Return an HTML element for the label based upon the field's element type.
views_handler_field::element_type	public	function	Return an HTML element based upon the field's element type.	2
views_handler_field::element_wrapper_classes	public	function	Return the class of the field's wrapper.
views_handler_field::element_wrapper_type	public	function	Return an HTML element for the wrapper based upon the field's element type.
views_handler_field::get_elements	public	function	Provide a list of elements valid for field HTML.
views_handler_field::get_render_tokens	public	function	Get the 'render' tokens to use for advanced rendering.
views_handler_field::get_token_values_recursive	public	function	Recursive function to add replacements for nested query string parameters.
views_handler_field::get_value	public	function	Get the value that's supposed to be rendered.	3
views_handler_field::init	public	function	Init the handler with necessary data. Overrides views_handler::init	11
views_handler_field::is_value_empty	public	function	Checks if a field value is empty.
views_handler_field::label	public	function	Get this field's label.
views_handler_field::options_submit	public	function	Performs some cleanup tasks on the options array before saving it. Overrides views_handler::options_submit	1
views_handler_field::pre_render	public	function	Run before any fields are rendered.	8
views_handler_field::query	public	function	Called to add the field to a query.	22
views_handler_field::render_altered	public	function	Render this field as altered text, from a fieldset set by the user.
views_handler_field::render_as_link	public	function	Render this field as a link, with info from a fieldset set by the user.
views_handler_field::render_text	public	function	Perform an advanced text render for the item.
views_handler_field::render_trim_text	public	function	Trim the field down to the specified length.
views_handler_field::theme	public	function	Call out to the theme() function.
views_handler_field::theme_functions	public	function	Build a list of suitable theme functions for this view.
views_handler_field::tokenize_value	public	function	Replace a value with tokens from the last field.
views_handler_field::ui_name	public	function	Return a string representing this handler's name in the UI. Overrides views_handler::ui_name	1
views_handler_field::use_string_group_by	public	function	Determines if this field will be available as an option to group the result by in the style settings.
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::destroy	public	function	Destructor.	2
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

You are here

class draggableviews_handler_field_draggable in DraggableViews 7.2

Hierarchy

File

Members

API Navigation