class merci_line_item_handler_area_line_item_summary in MERCI (Manage Equipment Reservations, Checkout and Inventory) 7.3
Defines a line item summary area handler so the summary can be plugged into the View itself.
Hierarchy
- class \views_object
- class \views_handler
Expanded class hierarchy of merci_line_item_handler_area_line_item_summary
1 string reference to 'merci_line_item_handler_area_line_item_summary'
- merci_line_item_views_data in merci_line_item/
includes/ views/ merci_line_item.views.inc - Implements hook_views_data()
File
- merci_line_item/
includes/ views/ handlers/ merci_line_item_handler_area_line_item_summary.inc, line 7
View source
class merci_line_item_handler_area_line_item_summary extends views_handler_area {
function option_definition() {
$options = parent::option_definition();
// Define an option to control the links displayed in the summary.
$options['links'] = array(
'default' => array(),
);
foreach (merci_line_item_summary_links() as $name => $link) {
$options['links']['default'][$name] = 0;
}
// Define an option to control the info displayed in the summary.
$options['info'] = array(
'default' => array(
'quantity' => 1,
'total' => 1,
),
);
return $options;
}
function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
// Add checkboxes for the summary links if any are available.
$options = array();
foreach (merci_line_item_summary_links() as $name => $link) {
$options[$name] = $link['title'];
}
if (!empty($options)) {
$form['links'] = array(
'#type' => 'checkboxes',
'#title' => t('Links'),
'#description' => t('Select the links you want to appear beneath the summary.'),
'#options' => $options,
'#default_value' => $this->options['links'],
);
}
$form['info'] = array(
'#type' => 'checkboxes',
'#title' => t('Info'),
'#description' => t('Select what info you want displayed in the summary.'),
'#options' => array(
'quantity' => t('Item quantity'),
'total' => t('Total'),
),
'#default_value' => $this->options['info'],
);
}
/**
* Get a value used for rendering.
*
* @param $values
* An object containing all retrieved values.
* @param $field
* Optional name of the field where the value is stored.
*/
function get_value($values, $field = NULL) {
// Find the alias for the line_item_id field.
$field_alias = '';
foreach ($this->view->query->fields as $key => $value) {
if ($value['field'] == 'line_item_id') {
$field_alias = $value['alias'];
}
}
if (isset($values->{$field_alias})) {
return $values->{$field_alias};
}
}
function render($empty = FALSE) {
if (!$empty || !empty($this->options['empty'])) {
// Build an array of line item IDs from the View results that we will load
// and use for calculating totals.
$line_item_ids = array();
foreach ($this->view->result as $result) {
$line_item_id = $this
->get_value($result);
if ($line_item_id) {
$line_item_ids[] = $line_item_id;
}
}
$line_items = merci_line_item_load_multiple($line_item_ids);
// Add total information and the line item summary links.
$quantity = merci_line_items_quantity($line_items);
$total = merci_line_items_total($line_items);
$currency = commerce_currency_load($total['currency_code']);
$links = array();
foreach (merci_line_item_summary_links() as $name => $link) {
if ($this->options['links'][$name] === $name && $link['access']) {
$links[str_replace('_', '-', 'line-item-summary-' . $name)] = $link;
}
}
// Build the variables array to send to the template.
$variables = array(
'view' => $this->view,
'links' => theme('links', array(
'links' => $links,
'attributes' => array(
'class' => array(
'links',
'inline',
),
),
)),
);
if ($this->options['info']['quantity']) {
$variables = array(
'quantity_raw' => $quantity,
'quantity_label' => format_plural($quantity, 'item', 'items', array(), array(
'context' => 'product count on a Commerce order',
)),
'quantity' => format_plural($quantity, '1 item', '@count items', array(), array(
'context' => 'product count on a Commerce order',
)),
) + $variables;
}
if ($this->options['info']['total']) {
$variables = array(
'total_raw' => number_format(commerce_currency_round($total['amount'], $currency), $currency['decimals']),
'total_label' => t('Total:'),
'total' => commerce_currency_format($total['amount'], $total['currency_code'], $this->view),
) + $variables;
}
return theme('merci_line_item_summary', $variables);
}
return '';
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
merci_line_item_handler_area_line_item_summary:: |
function | Get a value used for rendering. | ||
merci_line_item_handler_area_line_item_summary:: |
function |
Default options form that provides the label widget that all fields should
have. Overrides views_handler_area:: |
||
merci_line_item_handler_area_line_item_summary:: |
function |
Information about options for all kinds of purposes will be held here. Overrides views_handler_area:: |
||
merci_line_item_handler_area_line_item_summary:: |
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 |