class CurrencyAmountViewsHandlerField in Currency 7.2

A Views field handler for currency amounts.

This handler has two definition properties, that function identically to and provide default values for the handler's options:

currency_code
currency_code_field
currency_code_table See $this->option_definition() for a detailed explanation.

Hierarchy

class \views_object
- class \views_handler
  - class \views_handler_field
    class \CurrencyAmountViewsHandlerField

Expanded class hierarchy of CurrencyAmountViewsHandlerField

2 string references to 'CurrencyAmountViewsHandlerField'

CurrencyAmountViewsHandlerFieldWebTestCase::viewsData in currency/tests/CurrencyAmountViewsHandlerFieldWebTestCase.test: Overrides parent::viewsData();
currency_exchange_rate_db_table_views_data in currency_exchange_rate_db_table/currency_exchange_rate_db_table.views.inc: Implements hook_views_data().

File

currency/includes/CurrencyAmountViewsHandlerField.inc, line 18: Contains class CurrencyAmountViewsHandlerField.

View source

class CurrencyAmountViewsHandlerField extends views_handler_field {

  /**
   * Implements the undocumented views_object::definition property.
   *
   * @var array
   */
  public $definition = array(
    // A default currency code to use for the amounts.
    'currency_code' => 'XXX',
    // The name of the database field the currency code is in.
    'currency_code_field' => NULL,
    // The name of the database table currency_field is in. Defaults to the
    // same table this handler is used on.
    'currency_code_table' => NULL,
  );

  /**
   * Overrides parent::set_definition().
   */
  function set_definition($definition) {
    $this->definition = array_merge($this->definition, $definition);
    if (isset($definition['field'])) {
      $this->real_field = $definition['field'];
    }
  }

  /**
   * Overrides parent::query().
   */
  function query() {
    $this
      ->ensure_my_table();
    if ($this->definition['currency_code_field']) {
      $this->additional_fields['currency_code_field'] = array(
        'field' => $this->definition['currency_code_field'],
        'table' => $this->definition['currency_code_table'] ? $this->definition['currency_code_table'] : $this->table_alias,
      );
    }
    parent::query();
  }

  /**
   * Overrides parent::option_definition().
   *
   * @var array
   */
  function option_definition() {
    $options = parent::option_definition();

    // Whether to round amounts.
    $options['currency_round'] = array(
      'default' => FALSE,
    );
    return $options;
  }

  /**
   * Overrides parent::options_form().
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['currency_round'] = array(
      '#type' => 'checkbox',
      '#title' => t('Round amounts based on their currencies'),
      '#default_value' => $this->options['currency_round'],
    );
  }

  /**
   * Overrides parent::render().
   *
   * @throws RuntimeException
   */
  function render($values) {
    $currency = $this
      ->getCurrency($values);
    $amount = $this
      ->getAmount($values);
    if ($this->options['currency_round']) {
      $amount = $currency
        ->roundAmount($amount);
    }
    return $currency
      ->format($amount);
  }

  /**
   * Loads the Currency for this field.
   *
   * @throws RuntimeException
   *
   * @param stdClass $values
   *   A values object as received by $this->render().
   *
   * @return Currency
   */
  function getCurrency(stdClass $values) {
    $currency = NULL;
    if ($this->definition['currency_code_field']) {
      $currency_code = $this
        ->get_value($values, 'currency_code_field');
      if ($currency_code) {
        $currency = currency_load($currency_code);
      }
    }
    if (!$currency) {
      $currency = currency_load($this->definition['currency_code']);
    }
    if (!$currency) {
      $currency = currency_load('XXX');
    }
    if (!$currency) {
      throw new RuntimeException(t('Could not load currency with ISO 4217 code XXX.'));
    }
    return $currency;
  }

  /**
   * Gets this field's.
   *
   * If the amount cannot be fetched from your implementation's database field
   * as a numeric string, you should override this method so it returns a
   * numeric/decimal representation of the amount.
   *
   * @param stdClass $values
   *   A values object as received by $this->render().
   *
   * @return string
   *   A numeric string.
   */
  function getAmount(stdClass $values) {
    return $this
      ->get_value($values);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CurrencyAmountViewsHandlerField::$definition	public	property	Implements the undocumented views_object::definition property. Overrides views_object::$definition
CurrencyAmountViewsHandlerField::getAmount		function	Gets this field's.
CurrencyAmountViewsHandlerField::getCurrency		function	Loads the Currency for this field.
CurrencyAmountViewsHandlerField::options_form		function	Overrides parent::options_form(). Overrides views_handler_field::options_form
CurrencyAmountViewsHandlerField::option_definition		function	Overrides parent::option_definition(). Overrides views_handler_field::option_definition
CurrencyAmountViewsHandlerField::query		function	Overrides parent::query(). Overrides views_handler_field::query
CurrencyAmountViewsHandlerField::render		function	Overrides parent::render(). Overrides views_handler_field::render
CurrencyAmountViewsHandlerField::set_definition		function	Overrides parent::set_definition(). Overrides views_object::set_definition
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_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::use_group_by	public	function	Provides the handler some groupby.	2
views_handler::validate	public	function	Validates the handler against the complete View.	1
views_handler_field::$additional_fields	public	property	Stores additional fields which get added to the query. The generated aliases are stored in $aliases.
views_handler_field::$aliases	public	property
views_handler_field::$field_alias	public	property
views_handler_field::$last_render_index	protected	property	Keeps track of the last render index.
views_handler_field::$original_value	public	property	The field value prior to any rewriting.
views_handler_field::add_additional_fields	public	function	Add 'additional' fields to the query.
views_handler_field::add_self_tokens	public	function	Add any special tokens this field might use for itself.	4
views_handler_field::admin_summary	public	function	Provide extra data to the administration form Overrides views_handler::admin_summary
views_handler_field::advanced_render	public	function	Render a field using advanced settings.
views_handler_field::allow_advanced_render	public	function	Determine if this field can allow advanced rendering.	1
views_handler_field::click_sort	public	function	Called to determine what to tell the clicksorter.	1
views_handler_field::click_sortable	public	function	Determine if this field is click sortable.	1
views_handler_field::construct	public	function	Construct a new field handler. Overrides views_object::construct	17
views_handler_field::document_self_tokens	public	function	Document any special tokens this field might use for itself.	4
views_handler_field::element_classes	public	function	Return the class of the field.
views_handler_field::element_label_classes	public	function	Return the class of the field's label.
views_handler_field::element_label_type	public	function	Return an HTML element for the label based upon the field's element type.
views_handler_field::element_type	public	function	Return an HTML element based upon the field's element type.	2
views_handler_field::element_wrapper_classes	public	function	Return the class of the field's wrapper.
views_handler_field::element_wrapper_type	public	function	Return an HTML element for the wrapper based upon the field's element type.
views_handler_field::get_elements	public	function	Provide a list of elements valid for field HTML.
views_handler_field::get_render_tokens	public	function	Get the 'render' tokens to use for advanced rendering.
views_handler_field::get_token_values_recursive	public	function	Recursive function to add replacements for nested query string parameters.
views_handler_field::get_value	public	function	Get the value that's supposed to be rendered.	3
views_handler_field::init	public	function	Init the handler with necessary data. Overrides views_handler::init	11
views_handler_field::is_value_empty	public	function	Checks if a field value is empty.
views_handler_field::label	public	function	Get this field's label.
views_handler_field::options_submit	public	function	Performs some cleanup tasks on the options array before saving it. Overrides views_handler::options_submit	1
views_handler_field::pre_render	public	function	Run before any fields are rendered.	8
views_handler_field::render_altered	public	function	Render this field as altered text, from a fieldset set by the user.
views_handler_field::render_as_link	public	function	Render this field as a link, with info from a fieldset set by the user.
views_handler_field::render_text	public	function	Perform an advanced text render for the item.
views_handler_field::render_trim_text	public	function	Trim the field down to the specified length.
views_handler_field::theme	public	function	Call out to the theme() function.
views_handler_field::theme_functions	public	function	Build a list of suitable theme functions for this view.
views_handler_field::tokenize_value	public	function	Replace a value with tokens from the last field.
views_handler_field::ui_name	public	function	Return a string representing this handler's name in the UI. Overrides views_handler::ui_name	1
views_handler_field::use_string_group_by	public	function	Determines if this field will be available as an option to group the result by in the style settings.
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::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

You are here

class CurrencyAmountViewsHandlerField in Currency 7.2

Hierarchy

File

Members

API Navigation