class draggableviews_handler_sort in DraggableViews 7.2

Sort handler for ordering by weight.

Hierarchy

class \views_object
- class \views_handler
  - class \views_handler_sort
    class \draggableviews_handler_sort

Expanded class hierarchy of draggableviews_handler_sort

2 string references to 'draggableviews_handler_sort'

draggableviews_views_data_alter in views/draggableviews.views.inc: Implements hook_views_data_alter().
_draggableviews_get_draggable_sort in ./draggableviews.module: Get the draggable views weight sort of a view if there is one and return its ID. If there are multiple of these sorts, either the one matching a specified table alias or the first one is returned.

File

views/draggableviews_handler_sort.inc, line 11: Draggableviews views native handler sort.

View source

class draggableviews_handler_sort extends views_handler_sort {
  function query() {
    $this
      ->ensure_my_table();

    // If new items should be placed in the bottom.
    if ($this->options['draggableviews_setting_new_items_bottom_list']) {

      // New items will get the biggest integer possible instead of NULL.
      $field = "COALESCE({$this->table_alias}.{$this->field}, 2147483647)";
      $alias = $this->table_alias . '_' . $this->field . '_coalesce';

      // No need to call $this->query->add_field(), add_orderby() adds the field.
      $this->query
        ->add_orderby(NULL, $field, $this->options['order'], $alias);
    }
    else {

      // New items will be placed at the top as have NULL value.
      $this->query
        ->add_orderby($this->table_alias, $this->real_field, $this->options['order']);
    }
  }
  function option_definition() {
    $options = parent::option_definition();
    $options['draggableviews_setting_view'] = array(
      'default' => '',
    );
    $options['draggableviews_setting_arguments'] = array(
      'default' => 'all',
    );
    $options['draggableviews_setting_arguments_php'] = array(
      'default' => '',
    );
    $options['draggableviews_setting_new_items_bottom_list'] = array(
      'default' => TRUE,
    );
    return $options;
  }
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['expose_button']['#access'] = FALSE;
    $form['order']['#description'] = t('Please remember to override settings of the sort criterion if you have display that sets weights and you choose descending order.');

    // Grab all of the views and their display that contain a draggableviews
    // field. If this display has one then 'view->name:view->current_display'
    // is returned.
    $options = _draggableviews_get_views_options($this->view);

    // If it is setting view.
    if (!is_array($options)) {
      $form['order']['#access'] = FALSE;
      $form['draggableviews_setting_view'] = array(
        '#type' => 'value',
        '#value' => $options,
      );
    }
    else {
      $form['draggableviews_setting_view'] = array(
        '#type' => 'select',
        '#title' => t('Display sort as'),
        '#default_value' => $this->options['draggableviews_setting_view'],
        '#options' => $options,
        '#description' => t('Please choose the view and display that sets the order.'),
      );

      // If there is no setting views available, show error message.
      if (empty($options)) {
        drupal_set_message(t('First you should create a view that sets sorting order.'), 'error');
      }
    }
    $form['draggableviews_setting_arguments'] = array(
      '#title' => t('Arguments handling'),
      '#type' => 'radios',
      '#options' => array(
        'all' => t('Use all arguments'),
        'none' => t('Do not use any arguments (use empty arguments)'),
        'php' => t('Prepare arguments with PHP code'),
      ),
      '#default_value' => $this->options['draggableviews_setting_arguments'],
      '#description' => t('When sorting order is saved all arguments passed are saved with order.
          In display view we can choose how to use these arguments.'),
    );
    $form['draggableviews_setting_arguments_php'] = array(
      '#title' => t('PHP code to prepare arguments'),
      '#type' => 'textarea',
      '#default_value' => $this->options['draggableviews_setting_arguments_php'],
      '#description' => t('Enter the php code to prepare the arguments. Do not enter &lt;?php ?&gt; tags.
          The following variables are available - $view (the view), $arguments (existing arguments -
          manipulate these, and then return them, to alter the arguments used to sort). See README.txt for more details.'),
      '#states' => array(
        'visible' => array(
          'input[name="options[draggableviews_setting_arguments]"]' => array(
            'value' => 'php',
          ),
        ),
      ),
    );
    $form['draggableviews_setting_new_items_bottom_list'] = array(
      '#type' => 'checkbox',
      '#title' => t('New items appear bottom of the list'),
      '#description' => t('New items means elements (for example nodes) that do not have saved weight (newly created).'),
      '#default_value' => $this->options['draggableviews_setting_new_items_bottom_list'],
    );
  }

}

Members

Name	Modifiers	Type	Description	Overrides
draggableviews_handler_sort::options_form		function	Basic options for all sort criteria Overrides views_handler_sort::options_form
draggableviews_handler_sort::option_definition		function	Information about options for all kinds of purposes will be held here. Overrides views_handler_sort::option_definition
draggableviews_handler_sort::query		function	Called to add the sort to a query. Overrides views_handler_sort::query
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::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_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::init	public	function	Init the handler with necessary data.	6
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::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_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::ui_name	public	function	Return a string representing this handler's name in the UI.	9
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_sort::admin_summary	public	function	Display whether or not the sort order is ascending or descending Overrides views_handler::admin_summary	1
views_handler_sort::can_expose	public	function	Determine if a sort can be exposed. Overrides views_handler::can_expose	1
views_handler_sort::expose_form	public	function	Form for exposed handler options. Overrides views_handler::expose_form
views_handler_sort::expose_options	public	function	Provide default options for exposed sorts. Overrides views_handler::expose_options
views_handler_sort::options_submit	public	function	Simple submit handler. Overrides views_handler::options_submit
views_handler_sort::options_validate	public	function	Simple validate handler. Overrides views_handler::options_validate
views_handler_sort::show_expose_button	public	function	Shortcut to display the expose/hide button. Overrides views_handler::show_expose_button
views_handler_sort::show_sort_form	public	function	Shortcut to display the value form.	1
views_handler_sort::sort_options	public	function	Provide a list of options for the default sort form.
views_handler_sort::sort_submit	public	function
views_handler_sort::sort_validate	public	function
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::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_sort in DraggableViews 7.2

Hierarchy

File

Members

API Navigation