class commerce_coupon_handler_area_cart_form in Commerce Coupon 7

@file Displays a commerce coupon form field item on cart's form:

Hierarchy

• class \views_object
  • class \views_handler
    • class \views_handler_area
      • class \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 7

Displays a commerce coupon form field item on cart's form:

class commerce_coupon_handler_area_cart_form extends views_handler_area {
  function construct() {
    parent::construct();
    $this->additional_fields['order_id'] = 'order_id';
  }
  function query() {
    $this
      ->ensure_my_table();
    $fields = $this->additional_fields;

    // Rip off add_additional_fields method. Use it when
    // http://drupal.org/node/1321018 is fixed.
    $group_params = array();
    if ($this->options['group_type'] != 'group') {
      $group_params = array(
        'function' => $this->options['group_type'],
      );
    }
    if (!empty($fields) && is_array($fields)) {
      foreach ($fields as $identifier => $info) {
        if (is_array($info)) {
          if (isset($info['table'])) {
            $table_alias = $this->query
              ->ensure_table($info['table'], $this->relationship);
          }
          else {
            $table_alias = $this->table_alias;
          }
          if (empty($table_alias)) {
            debug(t('Handler @handler tried to add additional_field @identifier but @table could not be added!', array(
              '@handler' => $this->definition['handler'],
              '@identifier' => $identifier,
              '@table' => $info['table'],
            )));
            $this->aliases[$identifier] = 'broken';
            continue;
          }
          $params = array();
          if (!empty($info['params'])) {
            $params = $info['params'];
          }
          $params += $group_params;
          $this->aliases[$identifier] = $this->query
            ->add_field($table_alias, $info['field'], NULL, $params);
        }
        else {
          $this->aliases[$info] = $this->query
            ->add_field($this->table_alias, $info, NULL, $group_params);
        }
      }
    }
  }
  function option_definition() {
    $options = parent::option_definition();
    $options['cart_coupon_view']['default'] = 'commerce_coupon_review_pane|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['cart_coupon_view'] = array(
      '#type' => 'select',
      '#title' => t('Coupon view to display'),
      '#description' => t('Specify the View to use under the cart. Select \'none\' to not display anything.'),
      '#options' => array(
        'none' => t('None'),
      ) + $options,
      '#default_value' => $this->options['cart_coupon_view'],
    );
    $form['weight'] = array(
      '#type' => 'textfield',
      '#title' => t('Form item weight'),
      '#description' => t('Sets the weight of the form so it\'s displayed at the bottom. Do not change this unless you have several forms in the same area'),
      '#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($empty = NULL) {

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

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

  /**
   * Views form.
   */
  function views_form(&$form, &$form_state) {
    $form[$this->options['id']] = array(
      '#type' => 'container',
      '#prefix' => '<div class="commerce-coupon-handler-area-cart-form">',
      '#suffix' => '</div>',
      '#weight' => $this->options['weight'],
    );
    $form[$this->options['id']]['coupon_code'] = array(
      '#type' => 'textfield',
      '#title' => t('Coupon code'),
      '#description' => t('Enter here your coupon code.'),
    );
    $form[$this->options['id']]['coupon_add'] = array(
      '#type' => 'submit',
      '#name' => 'coupon_add',
      '#value' => t('Add coupon'),
      '#validate' => array(
        'commerce_coupon_handler_area_cart_form_validate',
      ),
      '#submit' => array(
        'commerce_coupon_handler_area_cart_form_submit',
      ),
    );
    $orders = $this->view->query
      ->get_result_entities($this->view->result);
    $order = reset($orders[1]);
    $cart_coupon_view = $this->options['cart_coupon_view'];
    if ($cart_coupon_view != 'none') {
      list($view_id, $display_id) = explode('|', $cart_coupon_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

Name	Modifiers	Type	Description	Overrides
commerce_coupon_handler_area_cart_form::construct		function	Views handlers use a special construct function. Overrides views_object::construct
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::query		function	Don't run a query. Overrides views_handler_area::query
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	Views form.
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::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::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