class views_php_handler_sort in Views PHP 7
Same name and namespace in other branches
- 6 plugins/views/views_php_handler_sort.inc \views_php_handler_sort
- 7.2 plugins/views/views_php_handler_sort.inc \views_php_handler_sort
A handler to sort a view using PHP defined by the administrator.
Hierarchy
- class \views_object
- class \views_handler
- class \views_handler_sort
- class \views_php_handler_sort
- class \views_handler_sort
- class \views_handler
Expanded class hierarchy of views_php_handler_sort
1 string reference to 'views_php_handler_sort'
- views_php_views_data in ./
views_php.views.inc - Implements hook_views_data().
File
- plugins/
views/ views_php_handler_sort.inc, line 8
View source
class views_php_handler_sort extends views_handler_sort {
protected $php_static_variable = NULL;
/**
* Implements views_object#option_definition().
*/
public function option_definition() {
$options = parent::option_definition();
$options['use_php_setup'] = array(
'default' => FALSE,
);
$options['php_setup'] = array(
'default' => '',
);
$options['php_sort'] = array(
'default' => '',
);
return $options;
}
/**
* Implements views_handler#option_definition().
*/
public function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
$form += views_php_form_element($this, array(
'use_php_setup',
t('Use setup code'),
t('If checked, you can provide PHP code to be run once right before execution of the view. This may be useful to define functions to be re-used in the value and/or output code.'),
), array(
'php_setup',
t('Setup code'),
t('Code to run right before execution of the view.'),
FALSE,
), array(
'$view',
'$handler',
'$static',
));
$form += views_php_form_element($this, FALSE, array(
'php_sort',
t('Sort code'),
t('The comparison code must return an integer less than, equal to, or greater than zero if the first row should respectively appear before, stay where it was compared to, or appear after the second row.'),
FALSE,
), array(
'$view',
'$handler',
'$static',
'$row1' => t('Data of row.'),
'$row2' => t('Data of row to compare against.'),
));
}
/**
* Implements views_handler_sort#query().
*/
public function query() {
// Inform views_php_views_pre_execute() to seize control over the query.
$this->view->views_php = TRUE;
}
/**
*
* @see views_php_views_pre_execute()
*/
public function php_pre_execute() {
// Execute static PHP code.
if (!empty($this->options['php_setup'])) {
$code = $this->options['php_setup'] . ';';
$function = function ($view, $handler, &$static) use ($code) {
eval($code);
};
ob_start();
$function($this->view, $this, $this->php_static_variable);
ob_end_clean();
}
}
/**
*
* @see views_php_views_post_execute()
*/
public function php_post_execute() {
if (!empty($this->options['php_sort']) && $this->view->style_plugin
->build_sort()) {
ob_start();
usort($this->view->result, array(
$this,
'php_sort',
));
ob_end_clean();
}
}
/**
* Helper function; usort() callback for sort support.
*/
public function php_sort($row1, $row2) {
$factor = strtoupper($this->options['order']) == 'ASC' ? 1 : -1;
$code = $this->options['php_sort'] . ';';
$function = function ($view, $handler, &$static, $row1, $row2) use ($code) {
return eval($code);
};
foreach (array(
'row1' => 'normalized_row1',
'row2' => 'normalized_row2',
) as $name => $normalized_name) {
${$normalized_name} = new stdClass();
foreach ($this->view->display_handler
->get_handlers('field') as $field => $handler) {
${$normalized_name}->{$field} = isset(${$name}->{$handler->field_alias}) ? ${$name}->{$handler->field_alias} : NULL;
}
}
$result = (int) $function($this->view, $this, $this->php_static_variable, $normalized_row1, $normalized_row2);
return $factor * $result;
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
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 |
Simple submit handler. Overrides views_handler:: |
|
views_handler_sort:: |
public | function |
Simple validate handler. Overrides views_handler:: |
|
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 | ||
views_php_handler_sort:: |
protected | property | ||
views_php_handler_sort:: |
public | function |
Implements views_handler#option_definition(). Overrides views_handler_sort:: |
|
views_php_handler_sort:: |
public | function |
Implements views_object#option_definition(). Overrides views_handler_sort:: |
|
views_php_handler_sort:: |
public | function | ||
views_php_handler_sort:: |
public | function | ||
views_php_handler_sort:: |
public | function | Helper function; usort() callback for sort support. | |
views_php_handler_sort:: |
public | function |
Implements views_handler_sort#query(). Overrides views_handler_sort:: |