commerce_add_to_cart_extras_handler_field_quantity.inc in Commerce Add to Cart Extras 7

Views field handler. Adds the quantity field to the view. Implements the Views Form API.

File

commerce_add_to_cart_extras_handler_field_quantity.inc

<?php

/**
 * @file
 * Views field handler. Adds the quantity field to the view.
 * Implements the Views Form API.
 */

/**
 *  Views field handler.
 */
class commerce_add_to_cart_extras_handler_field_quantity extends views_handler_field {

  /**
   * {@inheritdoc}
   */
  public function render($values) {
    return '<!--form-item-' . $this->options['id'] . '--' . $this->view->row_index . '-->';
  }

  /**
   * {@inheritdoc}
   */
  public function option_definition() {
    $options = parent::option_definition();
    $options['default_quantity'] = array(
      'default' => 0,
    );
    $options['combine'] = array(
      'default' => TRUE,
    );
    $options['commerce_extra_quantity'] = array(
      'default' => TRUE,
    );
    $options['display_path'] = array(
      'default' => TRUE,
    );
    $options['display_path_option'] = array(
      'default' => 'page',
    );
    $options['display_path_other'] = array(
      'default' => '',
    );
    return $options;
  }

  /**
   * Provide the add to cart display options.
   */
  public function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['default_quantity'] = array(
      '#type' => 'textfield',
      '#title' => t('Default quantity'),
      '#default_value' => $this->options['default_quantity'],
      '#size' => 16,
    );
    $form['combine'] = array(
      '#type' => 'checkbox',
      '#title' => t('Attempt to combine same products on the same line item in the cart.'),
      '#description' => t('The line item type, referenced product, and data from fields exposed on the Add to Cart form must all match to combine.'),
      '#default_value' => $this->options['combine'],
    );
    if (module_exists('commerce_extra_quantity')) {
      $form['commerce_extra_quantity'] = array(
        '#type' => 'checkbox',
        '#title' => t('Use the plus/minus widget on the quantity field.'),
        '#default_value' => $this->options['commerce_extra_quantity'],
      );
    }
    $form['display_path'] = array(
      '#type' => 'checkbox',
      '#title' => t("Link products added to the cart by this form"),
      '#default_value' => $this->options['display_path'],
    );
    $form['display_path_option'] = array(
      '#type' => 'select',
      '#options' => array(
        'page' => t('Current page'),
        'referencing_product' => t('Referencing Product'),
        'custom' => t('Other...'),
      ),
      '#dependency' => array(
        'edit-options-display-path' => array(
          1,
        ),
      ),
      '#description' => t('If you are unsure, you should just select "Current page", as this will link them to the view page or the product page they were added from.'),
      '#title' => t('Where should products be linked to?'),
      '#default_value' => $this->options['display_path_option'],
    );
    $form['display_path_other'] = array(
      '#type' => 'textfield',
      '#default_value' => $this->options['display_path_other'],
      '#size' => 40,
      '#dependency' => array(
        'edit-options-display-path-option' => array(
          'custom',
        ),
      ),
      '#title' => t('Enter a custom path to link products in the cart to.'),
    );
  }

  /**
   * The form which replaces the placeholder from render().
   */
  public function views_form(&$form, &$form_state) {

    // The view is empty, abort.
    if (empty($this->view->result)) {
      $form['#access'] = FALSE;
      return;
    }
    $form[$this->options['id']] = array(
      '#tree' => TRUE,
    );

    // At this point, the query has already been run, so we can access the
    // results in order to get the product_id.
    foreach ($this->view->result as $row_index => $row) {
      $product_id = $this
        ->get_value($row);
      $form[$this->options['id']][$row_index] = array(
        '#type' => 'textfield',
        '#product_id' => $product_id,
        '#default_value' => $this->options['default_quantity'],
        '#size' => 5,
      );
    }
  }

  /**
   * {@inheritdoc}
   */
  public function views_form_validate($form, &$form_state) {
    $field_name = $this->options['id'];
    foreach (element_children($form[$field_name]) as $row_id) {

      // Ensure the quantity is actually a numeric value.
      if (!is_numeric($form_state['values'][$field_name][$row_id]) || $form_state['values'][$field_name][$row_id] < 0) {
        form_set_error($field_name . '][' . $row_id, t('You must specify a positive number for the quantity'));
      }

      // If the custom data type attribute of the quantity element is integer,
      // ensure we only accept whole number values.
      if ((int) $form_state['values'][$field_name][$row_id] != $form_state['values'][$field_name][$row_id]) {
        form_set_error($field_name . '][' . $row_id, t('You must specify a whole number for the quantity.'));
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function views_form_submit($form, &$form_state) {
    global $user;
    $field_name = $this->options['id'];
    $product_quantities = array();
    foreach (element_children($form[$field_name]) as $row_id) {

      // Don't add products that have quantity 0.
      $quantity = $form_state['values'][$field_name][$row_id];
      if ($quantity > 0) {
        $product_id = $form[$field_name][$row_id]['#product_id'];
        $product_quantities[$product_id] = $quantity;
      }
    }
    $products = commerce_product_load_multiple(array_keys($product_quantities));
    foreach ($products as $product_id => $product) {
      $quantity = $product_quantities[$product_id];
      $line_item = commerce_product_line_item_new($product, $quantity);
      $line_item->data['context']['product_ids'] = array(
        $product_id,
      );
      $line_item->data['context']['add_to_cart_combine'] = $this->options['combine'];

      // Add the display path to the line item's context data array if
      // specified.
      if ($this->options['display_path']) {
        if (empty($this->options['display_path_option']) || $this->options['display_path_option'] == 'page') {
          $path = current_path();
        }
        elseif ($this->options['display_path_option'] == 'referencing_product') {

          // Via: http://www.drupalcommerce.org/node/3176
          // Iterate thhrough fields which refer to products.
          foreach (commerce_info_fields('commerce_product_reference') as $field) {

            // Build query.
            $query = new EntityFieldQuery();
            $query
              ->entityCondition('entity_type', 'node', '=')
              ->fieldCondition($field['field_name'], 'product_id', $product->product_id, '=')
              ->range(0, 1);
            if ($result = $query
              ->execute()) {
              $array_keys = array_keys($result['node']);
              $path = 'node/' . reset($array_keys);
            }
          }

          // Generally, people would expect a path to be provided, so if it
          // doesn't work, set to the current page.
          if (empty($path)) {
            $path = current_path();
          }
        }
        elseif ($this->options['display_path_option'] == 'custom') {
          $path = !empty($this->options['display_path_other']) ? $this->options['display_path_other'] : '';
        }

        // Set the path on the line item.
        $line_item->data['context']['display_path'] = $path;
      }

      // Store the View data in the context data array as well.
      $line_item->data['context']['view'] = array(
        'view_name' => $this->view->name,
        'display_name' => $this->view->current_display,
        'human_name' => $this->view->human_name,
        'page' => $this->view->current_page,
      );
      commerce_cart_product_add($user->uid, $line_item, $this->options['combine']);
    }
    if (count($product_quantities)) {
      drupal_set_message(t('The selected products have been added to <a href="!cart-url">your cart</a>.', array(
        '!cart-url' => url('cart'),
      )));
    }
  }

}

Classes

Name	Description
commerce_add_to_cart_extras_handler_field_quantity	Views field handler.