You are here

Home » API reference » Commerce Core 7 » commerce_order_handler_area_order_total.inc

class commerce_order_handler_area_order_total in Commerce Core 7

Defines an area handler that renders an order's total field.

Hierarchy

Expanded class hierarchy of commerce_order_handler_area_order_total

1 string reference to 'commerce_order_handler_area_order_total'
commerce_order_views_data in modules/order/includes/views/commerce_order.views.inc
Implements hook_views_data()

File

modules/order/includes/views/handlers/commerce_order_handler_area_order_total.inc, line 6

View source 
class commerce_order_handler_area_order_total extends views_handler_area {
  function option_definition() {
    $options = parent::option_definition();
    $options['label_display'] = array(
      'default' => FALSE,
      'bool' => TRUE,
    );
    $options['label_custom'] = array(
      'default' => t('Order total'),
      'translatable' => TRUE,
    );
    $options['label_position'] = array(
      'default' => 'inline',
    );
    $options['formatter'] = array(
      'default' => 'commerce_price_formatted_components',
    );
    return $options;
  }
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['empty']['#description'] = t("Even if selected, this area handler will never render if a valid order cannot be found in the View's arguments.");
    $form['label_display'] = array(
      '#type' => 'checkbox',
      '#title' => t('Display a custom label for this field'),
      '#description' => t('Displaying a custom label may require updates to your theme to maintain the default alignment of the field without a label.'),
      '#default_value' => $this->options['label_display'],
    );
    $form['label_custom'] = array(
      '#type' => 'textfield',
      '#title' => t('Custom label'),
      '#default_value' => $this->options['label_custom'],
      '#dependency' => array(
        'edit-options-label-display' => array(
          1,
        ),
      ),
    );
    $form['label_position'] = array(
      '#type' => 'select',
      '#title' => t('Label position'),
      '#default_value' => $this->options['label_position'],
      '#dependency' => array(
        'edit-options-label-display' => array(
          1,
        ),
      ),
      '#options' => array(
        'inline' => t('Inline'),
        'above' => t('Above'),
      ),
    );

    // Load the formatter options for the commerce_order_total field.
    module_load_include('inc', 'field_ui', 'field_ui.admin');
    $field = field_info_field('commerce_order_total');
    $form['formatter'] = array(
      '#type' => 'select',
      '#title' => t('Formatter'),
      '#options' => field_ui_formatter_options($field['type']),
      '#default_value' => $this->options['formatter'],
    );
  }
  function render($empty = FALSE) {
    if (!$empty || !empty($this->options['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.
            if ($order = commerce_order_load(reset($argument->value))) {

              // Prepare a display settings array.
              $display = array(
                'label' => empty($this->options['label_display']) ? 'hidden' : $this->options['label_position'],
                'type' => $this->options['formatter'],
                '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);
              if (!empty($this->options['label_display'])) {
                $field['#title'] = $this->options['label_custom'];
              }
              return '<div class="commerce-order-handler-area-order-total">' . drupal_render($field) . '</div>';
            }
          }
        }
      }
    }
    return '';
  }

}

Members

Namesort descending Modifiers Type Description Overrides
commerce_order_handler_area_order_total::options_form function Default options form that provides the label widget that all fields should have. Overrides views_handler_area::options_form
commerce_order_handler_area_order_total::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_handler_area::option_definition
commerce_order_handler_area_order_total::render function Render the area. Overrides views_handler_area::render
views_handler::$handler_type public property The type of the handler, for example filter/footer/field.
views_handler::$query public property Where the $query object will reside:. 1
views_handler::$real_field public property The actual field in the database table, maybe different on other kind of query plugins/special handlers.
views_handler::$relationship public property The relationship used for this field.
views_handler::$table_alias public property The alias of the table of this handler which is used in the query.
views_handler::$view public property The top object of a view. Overrides views_object::$view
views_handler::accept_exposed_input public function Take input from exposed handlers and assign to this handler, if necessary. 1
views_handler::access public function Check whether current user has access to this handler. 10
views_handler::broken public function Determine if the handler is considered 'broken'. 6
views_handler::can_expose public function Determine if a handler can be exposed. 2
views_handler::case_transform public function Transform a string by a certain method.
views_handler::ensure_my_table public function Ensure the main table for this handler is in the query. This is used a lot. 8
views_handler::exposed_form public function Render our chunk of the exposed handler form when selecting. 1
views_handler::exposed_info public function Get information about the exposed form for the form renderer. 1
views_handler::exposed_submit public function Submit the exposed handler form.
views_handler::exposed_validate public function Validate the exposed handler form. 4
views_handler::expose_form public function Form for exposed handler options. 2
views_handler::expose_options public function Set new exposed option defaults when exposed setting is flipped on. 2
views_handler::expose_submit 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::expose_validate public function Validate the options form. 1
views_handler::extra_options public function Provide defaults for the handler.
views_handler::extra_options_form public function Provide a form for setting options. 1
views_handler::extra_options_submit 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::extra_options_validate public function Validate the options form.
views_handler::get_field public function Shortcut to get a handler's raw field value.
views_handler::get_join public function Get the join object that should be used for this handler.
views_handler::groupby_form public function Provide a form for aggregation settings. 1
views_handler::groupby_form_submit 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::has_extra_options public function If a handler has 'extra options' it will get a little settings widget and another form called extra_options. 1
views_handler::is_a_group public function Returns TRUE if the exposed filter works like a grouped filter. 1
views_handler::is_exposed public function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::multiple_exposed_input 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::needs_style_plugin public function Determine if the argument needs a style plugin. 1
views_handler::options_submit 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::options_validate public function Validate the options form. 4
views_handler::placeholder public function Provides a unique placeholders for handlers.
views_handler::post_execute public function Run after the view is executed, before the result is cached. 1
views_handler::pre_query public function Run before the view is built. 1
views_handler::sanitize_value public function Sanitize the value for output.
views_handler::set_relationship public function Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::show_expose_button public function Shortcut to display the expose/hide button. 2
views_handler::show_expose_form public function Shortcut to display the exposed options form.
views_handler::store_exposed_input public function If set to remember exposed input in the session, store it there. 1
views_handler::ui_name public function Return a string representing this handler's name in the UI. 9
views_handler::validate public function Validates the handler against the complete View. 1
views_handler_area::admin_summary public function Provide extra data to the administration form. Overrides views_handler::admin_summary
views_handler_area::init public function Init the handler with necessary data. Overrides views_handler::init
views_handler_area::label public function
views_handler_area::query public function Don't run a query. 1
views_handler_area::use_group_by public function Area handlers shouldn't have groupby. Overrides views_handler::use_group_by
views_object::$definition public property Handler's definition.
views_object::$options public property Except for displays, options for the object will be held here. 1
views_object::altered_option_definition function Collect this handler's option definition and alter them, ready for use.
views_object::construct public function Views handlers use a special construct function. 4
views_object::destroy public function Destructor. 2
views_object::export_option public function 1
views_object::export_options public function
views_object::export_option_always public function Always exports the option, regardless of the default value.
views_object::options Deprecated public function Set default options on this object. 1
views_object::set_default_options public function Set default options.
views_object::set_definition public function Let the handler know what its full definition is.
views_object::unpack_options public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable public function Unpack a single option definition.
views_object::unpack_translatables public function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults public function