class birthdays_field_views_handler_sort in Birthdays 7
A views handler for sorting by a birthday field.
Hierarchy
- class \views_object
- class \views_handler
- class \views_handler_sort
- class \views_handler
Expanded class hierarchy of birthdays_field_views_handler_sort
1 string reference to 'birthdays_field_views_handler_sort'
- birthdays_field_views_data_alter in views/
birthdays.views.inc - Implements hook_field_views_data_alter().
File
- views/
birthdays_field_views_handler_sort.inc, line 11 - The birthdays_field_views_handler_sort class.
View source
class birthdays_field_views_handler_sort extends views_handler_sort {
/**
* Overrides views_handler_sort::query().
* Add an ORDER_BY to the query.
*/
function query() {
$this
->ensure_my_table();
self::addOrderBy($this->query, $this->options['order'], array(
'day' => $this->field . '_day',
'month' => $this->field . '_month',
'year' => $this->field . '_year',
), $this->field . '_sort_column');
}
/**
* Add an "ORDER BY time to next birthday" to a query.
*
* @param $query
* The Views query.
* @param $order
* DESC or ASC.
* @param
* An array with the keys year, month and day where the values are the real
* column names in the query.
* @param $fieldname
* The name for the sorting column.
*/
public static function addOrderBy($query, $order, $columns, $fieldname) {
// Use the formula to calculate a value for the current time.
$now = date('m', REQUEST_TIME) * 32 + date('d', REQUEST_TIME);
// Get the formula for the current database type.
switch (Database::getConnection()
->databaseType()) {
case 'mysql':
case 'mysqli':
case 'pgsql':
$formula = "CASE WHEN {$columns['month']}*32 + {$columns['day']} >= {$now} THEN {$columns['month']}*32 + {$columns['day']} ELSE {$columns['month']}*32 + {$columns['day']} + 1000 END";
break;
}
// Add the ORDER BY.
if (isset($formula)) {
$query
->add_orderby(NULL, $formula, $order, $fieldname);
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
birthdays_field_views_handler_sort:: |
public static | function | Add an "ORDER BY time to next birthday" to a query. | |
birthdays_field_views_handler_sort:: |
function |
Overrides views_handler_sort::query().
Add an ORDER_BY to the query. Overrides views_handler_sort:: |
||
views_handler:: |
public | property | The type of the handler, for example filter/footer/field. | |
views_handler:: |
public | property | Where the $query object will reside:. | 1 |
views_handler:: |
public | property | The actual field in the database table, maybe different on other kind of query plugins/special handlers. | |
views_handler:: |
public | property | The relationship used for this field. | |
views_handler:: |
public | property | The alias of the table of this handler which is used in the query. | |
views_handler:: |
public | property |
The top object of a view. Overrides views_object:: |
|
views_handler:: |
public | function | Take input from exposed handlers and assign to this handler, if necessary. | 1 |
views_handler:: |
public | function | Check whether current user has access to this handler. | 10 |
views_handler:: |
public | function | Determine if the handler is considered 'broken'. | 6 |
views_handler:: |
public | function | Transform a string by a certain method. | |
views_handler:: |
public | function | Ensure the main table for this handler is in the query. This is used a lot. | 8 |
views_handler:: |
public | function | Render our chunk of the exposed handler form when selecting. | 1 |
views_handler:: |
public | function | Get information about the exposed form for the form renderer. | 1 |
views_handler:: |
public | function | Submit the exposed handler form. | |
views_handler:: |
public | function | Validate the exposed handler form. | 4 |
views_handler:: |
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:: |
public | function | Validate the options form. | 1 |
views_handler:: |
public | function | Provide defaults for the handler. | |
views_handler:: |
public | function | Provide a form for setting options. | 1 |
views_handler:: |
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:: |
public | function | Validate the options form. | |
views_handler:: |
public | function | Shortcut to get a handler's raw field value. | |
views_handler:: |
public | function | Get the join object that should be used for this handler. | |
views_handler:: |
public | function | Provide a form for aggregation settings. | 1 |
views_handler:: |
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:: |
public | function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | 1 |
views_handler:: |
public | function | Init the handler with necessary data. | 6 |
views_handler:: |
public | function | Returns TRUE if the exposed filter works like a grouped filter. | 1 |
views_handler:: |
public | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler:: |
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:: |
public | function | Determine if the argument needs a style plugin. | 1 |
views_handler:: |
public | function | Provides a unique placeholders for handlers. | |
views_handler:: |
public | function | Run after the view is executed, before the result is cached. | 1 |
views_handler:: |
public | function | Run before the view is built. | 1 |
views_handler:: |
public | function | Sanitize the value for output. | |
views_handler:: |
public | function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
views_handler:: |
public | function | Shortcut to display the exposed options form. | |
views_handler:: |
public | function | If set to remember exposed input in the session, store it there. | 1 |
views_handler:: |
public | function | Return a string representing this handler's name in the UI. | 9 |
views_handler:: |
public | function | Provides the handler some groupby. | 2 |
views_handler:: |
public | function | Validates the handler against the complete View. | 1 |
views_handler_sort:: |
public | function |
Display whether or not the sort order is ascending or descending Overrides views_handler:: |
1 |
views_handler_sort:: |
public | function |
Determine if a sort can be exposed. Overrides views_handler:: |
1 |
views_handler_sort:: |
public | function |
Form for exposed handler options. Overrides views_handler:: |
|
views_handler_sort:: |
public | function |
Provide default options for exposed sorts. Overrides views_handler:: |
|
views_handler_sort:: |
public | function |
Basic options for all sort criteria Overrides views_handler:: |
4 |
views_handler_sort:: |
public | function |
Simple submit handler. Overrides views_handler:: |
|
views_handler_sort:: |
public | function |
Simple validate handler. Overrides views_handler:: |
|
views_handler_sort:: |
public | function |
Information about options for all kinds of purposes will be held here. Overrides views_handler:: |
3 |
views_handler_sort:: |
public | function |
Shortcut to display the expose/hide button. Overrides views_handler:: |
|
views_handler_sort:: |
public | function | Shortcut to display the value form. | 1 |
views_handler_sort:: |
public | function | Provide a list of options for the default sort form. | |
views_handler_sort:: |
public | function | ||
views_handler_sort:: |
public | function | ||
views_object:: |
public | property | Handler's definition. | |
views_object:: |
public | property | Except for displays, options for the object will be held here. | 1 |
views_object:: |
function | Collect this handler's option definition and alter them, ready for use. | ||
views_object:: |
public | function | Views handlers use a special construct function. | 4 |
views_object:: |
public | function | Destructor. | 2 |
views_object:: |
public | function | 1 | |
views_object:: |
public | function | ||
views_object:: |
public | function | Always exports the option, regardless of the default value. | |
views_object:: |
public | function | Set default options on this object. | 1 |
views_object:: |
public | function | Set default options. | |
views_object:: |
public | function | Let the handler know what its full definition is. | |
views_object:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
views_object:: |
public | function | Unpack a single option definition. | |
views_object:: |
public | function | Unpacks each handler to store translatable texts. | |
views_object:: |
public | function |