class commerce_price_components_handler_area_order_total in Commerce price by components 7
Defines an order total area handler that shows the order total field with its components listed in the footer of a View.
Hierarchy
- class \views_object
- class \views_handler
Expanded class hierarchy of commerce_price_components_handler_area_order_total
1 string reference to 'commerce_price_components_handler_area_order_total'
- commerce_price_components_views_data in includes/
views/ commerce_price_components.views.inc
File
- includes/
views/ handlers/ commerce_price_components_handler_area_order_total.inc, line 7
View source
class commerce_price_components_handler_area_order_total extends views_handler_area {
function option_definition() {
$options = parent::option_definition();
$components = commerce_price_component_titles();
foreach ($components as $key => $component) {
$options['commerce_price_components']['default'][$key] = $key == 'base_price' ? TRUE : '';
}
return $options;
}
function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
$form += commerce_price_components_settings_form($this->options);
$form['commerce_price_components']['#states'] = array(
'invisible' => array(
'input[name="options[info][total]"]' => array(
'checked' => FALSE,
),
),
);
}
function render($empty = FALSE) {
if (!$empty) {
// First look for an order_id argument.
foreach ($this->view->argument as $name => $argument) {
if ($argument instanceof commerce_order_handler_argument_order_order_id) {
// If it is single value...
if (count($argument->value) == 1) {
// Load the order.
$order = commerce_order_load(reset($argument->value));
// Get the components to filter those not selected.
$components = $order->commerce_order_total[LANGUAGE_NONE][0]['data']['components'];
// Only count enabled components
foreach ($components as $key => $component) {
if (!$this->options['commerce_price_components'][$component['name']]) {
unset($components[$key]);
}
}
// Calculate the correct order total for the current components.
$order->commerce_order_total[LANGUAGE_NONE][0]['data']['components'] = $components;
$price = commerce_price_component_total($order->commerce_order_total[LANGUAGE_NONE][0]);
$price['data']['components'] = $components;
$order->commerce_order_total[LANGUAGE_NONE][0] = $price;
// Prepare a display settings array.
$display = array(
'label' => 'hidden',
'type' => 'commerce_price_formatted_components',
'settings' => array(
'calculation' => FALSE,
),
);
// Render the order's order total field with the current display.
$field = field_view_field('commerce_order', $order, 'commerce_order_total', $display);
return '<div class="commerce-order-handler-area-order-total">' . drupal_render($field) . '</div>';
}
}
}
}
return '';
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
commerce_price_components_handler_area_order_total:: |
function |
Default options form that provides the label widget that all fields should
have. Overrides views_handler_area:: |
||
commerce_price_components_handler_area_order_total:: |
function |
Information about options for all kinds of purposes will be held here. Overrides views_handler_area:: |
||
commerce_price_components_handler_area_order_total:: |
function |
Render the area. Overrides views_handler_area:: |
||
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 | Determine if a handler can be exposed. | 2 |
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 | Form for exposed handler options. | 2 |
views_handler:: |
public | function | Set new exposed option defaults when exposed setting is flipped on. | 2 |
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 | 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 | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | 5 |
views_handler:: |
public | function | Validate the options form. | 4 |
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 expose/hide button. | 2 |
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 | Validates the handler against the complete View. | 1 |
views_handler_area:: |
public | function |
Provide extra data to the administration form. Overrides views_handler:: |
|
views_handler_area:: |
public | function |
Init the handler with necessary data. Overrides views_handler:: |
|
views_handler_area:: |
public | function | ||
views_handler_area:: |
public | function | Don't run a query. | 1 |
views_handler_area:: |
public | function |
Area handlers shouldn't have groupby. Overrides views_handler:: |
|
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 |