commerce_line_item_handler_area_line_item_summary.inc in Commerce Core 7

File

modules/line_item/includes/views/handlers/commerce_line_item_handler_area_line_item_summary.inc

<?php

/**
 * Defines a line item summary area handler so the summary can be plugged into
 *   the View itself.
 */
class commerce_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 (commerce_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 (commerce_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 = commerce_line_item_load_multiple($line_item_ids);

      // Add total information and the line item summary links.
      $quantity = commerce_line_items_quantity($line_items);
      $total = commerce_line_items_total($line_items);
      $currency = commerce_currency_load($total['currency_code']);
      $links = array();
      foreach (commerce_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('commerce_line_item_summary', $variables);
    }
    return '';
  }

}

Classes

Name	Description
commerce_line_item_handler_area_line_item_summary	Defines a line item summary area handler so the summary can be plugged into the View itself.