|
|
Drupal example source code file (views_handler_sort.inc)
The views_handler_sort.inc Drupal example source code<?php // $Id: views_handler_sort.inc,v 1.2.4.4 2010/12/17 21:42:19 merlinofchaos Exp $ /** * @defgroup views_sort_handlers Views' sort handlers * @{ * Handlers to tell Views how to sort queries */ /** * Base sort handler that has no options and performs a simple sort */ class views_handler_sort extends views_handler { /** * Determine if a sort can be exposed. */ function can_expose() { return TRUE; } /** * Called to add the sort to a query. */ function query() { $this->ensure_my_table(); // Add the field. $this->query->add_orderby($this->table_alias, $this->real_field, $this->options['order']); } function option_definition() { $options = parent::option_definition(); $options['order'] = array('default' => 'ASC'); $options['exposed'] = array('default' => FALSE); $options['expose'] = array( 'contains' => array( 'label' => array('default' => '', 'translatable' => TRUE), ), ); return $options; } /** * Display whether or not the sort order is ascending or descending */ function admin_summary() { if (!empty($this->options['exposed'])) { return t('Exposed'); } switch ($this->options['order']) { case 'ASC': case 'asc': default: return t('asc'); break; case 'DESC'; case 'desc'; return t('desc'); break; } } /** * Basic options for all sort criteria */ function options_form(&$form, &$form_state) { parent::options_form($form, $form_state); if ($this->can_expose()) { $this->show_expose_button($form, $form_state); } $form['op_val_start'] = array('#value' => '<div class="clearfix">'); $this->show_sort_form($form, $form_state); $form['op_val_end'] = array('#value' => '</div>'); if ($this->can_expose()) { $this->show_expose_form($form, $form_state); } } /** * Simple validate handler */ function options_validate(&$form, &$form_state) { $this->sort_validate($form, $form_state); if (!empty($this->options['exposed'])) { $this->expose_validate($form, $form_state); } } /** * Simple submit handler */ function options_submit(&$form, &$form_state) { unset($form_state['values']['expose_button']); // don't store this. $this->sort_submit($form, $form_state); if (!empty($this->options['exposed'])) { $this->expose_submit($form, $form_state); } } /** * Shortcut to display the value form. */ function show_sort_form(&$form, &$form_state) { $options = $this->sort_options(); if (!empty($options)) { $form['order'] = array( '#type' => 'radios', '#options' => $options, '#default_value' => $this->options['order'], ); } } function sort_validate(&$form, &$form_state) { } function sort_submit(&$form, &$form_state) { } /** * Provide a list of options for the default sort form. * Should be overridden by classes that don't override sort_form */ function sort_options() { return array( 'ASC' => t('Sort ascending'), 'DESC' => t('Sort descending'), ); } /** * Since all exposed sorts are grouped into one select box. * We don't return nothing when views call to exposed_form() */ function exposed_form(&$form, &$form_state) { } /** * Handle the 'left' side fo the exposed options form. */ function expose_form_left(&$form, &$form_state) { $form['expose']['label'] = array( '#type' => 'textfield', '#default_value' => $this->options['expose']['label'], '#title' => t('Label'), '#required' => TRUE, '#size' => 40, ); } /** * Handle the 'right' side fo the exposed options form. */ function expose_form_right(&$form, &$form_state) { $form['expose']['order'] = array( '#type' => 'value', '#value' => 'ASC', ); } /** * Provide default options for exposed sorts. */ function expose_options() { $this->options['expose'] = array( 'order' => $this->options['order'], 'label' => $this->ui_name(), ); } } /** * A special handler to take the place of missing or broken handlers. */ class views_handler_sort_broken extends views_handler_sort { function ui_name($short = FALSE) { return t('Broken/missing handler'); } function ensure_my_table() { /* No table to ensure! */ } function query() { /* No query to run */ } function options_form(&$form, &$form_state) { $form['markup'] = array( '#markup' => '<div class="form-item description">' . t('The handler for this item is broken or missing and cannot be used. If a module provided the handler and was disabled, re-enabling the module may restore it. Otherwise, you should probably delete this item.') . '</div>', ); } /** * Determine if the handler is considered 'broken' */ function broken() { return TRUE; } } /** * @} */ Other Drupal examples (source code examples)Here is a short list of links related to this Drupal views_handler_sort.inc source code file: |
"Drupal" is a registered trademark of Dries Buytaert.
my drupal tutorials and examples
Copyright
1998-2016 Alvin Alexander, alvinalexander.com
All Rights Reserved.
Beginning in 2016, a portion of the proceeds from pages under the '/drupal-code-examples/' URI will be donated to charity.