You are here

Home » API reference » Commerce Coupon 7.2 » commerce_coupon_handler_area_cart_form.inc

class commerce_coupon_handler_area_cart_form in Commerce Coupon 7.2

Same name and namespace in other branches
  1. 7 includes/views/handlers/commerce_coupon_handler_area_cart_form.inc \commerce_coupon_handler_area_cart_form

@file Display a commerce coupon form field on the cart form.

Most of this logic has been taken from commerce_coupon.checkout_pane.inc. There is probably quite a bit of room for improvement here by reusing code instead of copying it.

Hierarchy

Expanded class hierarchy of commerce_coupon_handler_area_cart_form

1 string reference to 'commerce_coupon_handler_area_cart_form'
commerce_coupon_views_data_alter in includes/views/commerce_coupon.views.inc
Alter the views data to enable some additional features for coupons in views.

File

includes/views/handlers/commerce_coupon_handler_area_cart_form.inc, line 11
Display a commerce coupon form field on the cart form.

View source 
class commerce_coupon_handler_area_cart_form extends views_handler_area {
  function option_definition() {
    $options = parent::option_definition();
    $options['coupon_cart_form_view']['default'] = 'order_coupon_list|checkout';
    $options['weight']['default'] = 99;
    return $options;
  }

  /**
   * Options form
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    unset($form['empty']);

    // Build an options array of Views available for the cart contents pane.
    $options = array();

    // Generate an option list from all user defined and module defined views.
    foreach (views_get_all_views() as $view_id => $view_value) {

      // Only include line item Views.
      if ($view_value->base_table == 'commerce_coupon') {
        foreach ($view_value->display as $display_id => $display_value) {
          $options[check_plain($view_id)][$view_id . '|' . $display_id] = check_plain($display_value->display_title);
        }
      }
    }
    $form['coupon_cart_form_view'] = array(
      '#type' => 'select',
      '#title' => t('Coupons Cart View'),
      '#description' => t('Specify the View to render the cart summary.'),
      '#options' => array(
        'none' => t('None'),
      ) + $options,
      '#default_value' => $this->options['coupon_cart_form_view'],
    );
    $form['weight'] = array(
      '#type' => 'textfield',
      '#title' => t('Form item weight'),
      '#default_value' => $this->options['weight'],
      '#required' => TRUE,
    );
  }
  function options_validate(&$form, &$form_state) {
    $weight = $form_state['values']['options']['weight'];

    // Weight must be an integer:
    if (!is_null($weight) && !is_numeric($weight) || (int) $weight != $weight) {
      form_set_error('options][weight', t('!name field must be an integer.', array(
        '!name' => $form['weight']['#title'],
      )));
    }
  }
  function render($values = FALSE) {

    // Render a Views form item placeholder.
    // This causes Views to wrap the View in a form.
    return '<!--form-item-' . $this->options['id'] . '-->';
  }

  /**
   * This handler never outputs data when the view is empty.
   */
  function views_form_empty($empty) {
    return $empty;
  }
  function views_form(&$form, &$form_state) {

    // Ensure this include file is loaded when the form is rebuilt from the cache.
    $form_state['build_info']['files']['coupon_cart_form'] = drupal_get_path('module', 'commerce_coupon') . '/includes/views/handlers/commerce_coupon_handler_area_cart_form.inc';
    $form[$this->options['id']] = array(
      '#prefix' => '<div id="commerce-coupon-cart-form-wrapper">',
      '#suffix' => '</div>',
      '#weight' => $this->options['weight'],
    );
    $form[$this->options['id']]['coupon_code'] = array(
      '#type' => 'textfield',
      '#title' => t('Coupon code'),
      '#description' => t('Enter your coupon code here.'),
    );
    $form[$this->options['id']]['coupon_add'] = array(
      '#type' => 'submit',
      '#value' => t('Add coupon'),
      '#name' => 'coupon_add',
      // Limit validation to the coupon code.
      '#limit_validation_errors' => array(
        array(
          'coupon_code',
        ),
      ),
      '#validate' => array(
        'commerce_coupon_handler_area_cart_form_validate',
      ),
      '#submit' => array(
        'commerce_coupon_handler_area_cart_form_submit',
      ),
    );

    // Attach ajax if views ajax enabled.
    if ($this->view->use_ajax) {

      // @todo implement AJAX.
    }

    // 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) {
          $order_id = reset($argument->value);
          break;
        }
      }
    }
    $order = !empty($order_id) ? commerce_order_load($order_id) : commerce_cart_order_load($GLOBALS['user']->uid);

    // Extract the View and display keys from the cart contents pane setting.
    $coupon_summary_view = $this->options['coupon_cart_form_view'];
    if ($coupon_summary_view != 'none') {
      list($view_id, $display_id) = explode('|', $coupon_summary_view);
      if (!empty($view_id) && !empty($display_id) && views_get_view($view_id)) {
        $form[$this->options['id']]['redeemed_coupons'] = array(
          '#type' => 'markup',
          '#markup' => commerce_embed_view($view_id, $display_id, array(
            $order->order_id,
          )),
        );
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
commerce_coupon_handler_area_cart_form::options_form function Options form Overrides views_handler_area::options_form
commerce_coupon_handler_area_cart_form::options_validate function Validate the options form. Overrides views_handler::options_validate
commerce_coupon_handler_area_cart_form::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_handler_area::option_definition
commerce_coupon_handler_area_cart_form::render function Render the area. Overrides views_handler_area::render
commerce_coupon_handler_area_cart_form::views_form function
commerce_coupon_handler_area_cart_form::views_form_empty function This handler never outputs data when the view is empty.
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::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