class views_handler_field_numeric
- 3.x handlers/views_handler_field_numeric.inc views_handler_field_numeric
- 2.x handlers/views_handler_field_numeric.inc views_handler_field_numeric
Render a field as a numeric value
Definition terms:
- float: If true this field contains a decimal value. If unset this field will be assumed to be integer.
Hierarchy
- class \views_object
- class \views_handler
- class \views_handler_field
- class \views_handler_field_numeric
- class \views_handler_field
- class \views_handler
Expanded class hierarchy of views_handler_field_numeric
Related topics
11 string references to 'views_handler_field_numeric'
- aggregator_views_data in modules/
aggregator.views.inc - Implements hook_views_data().
- book_views_data in modules/
book.views.inc - Implements hook_views_data().
- comment_views_data in modules/
comment.views.inc - field_views_field_default_views_data in modules/
field.views.inc - Default views data implementation for a field.
- hook_views_data in ./
views.api.php - Describes data tables (or the equivalent) to Views.
File
- handlers/
views_handler_field_numeric.inc, line 17 - Definition of views_handler_field_numeric.
View source
class views_handler_field_numeric extends views_handler_field {
function option_definition() {
$options = parent::option_definition();
$options['set_precision'] = array('default' => FALSE, 'bool' => TRUE);
$options['precision'] = array('default' => 0);
$options['decimal'] = array('default' => '.', 'translatable' => TRUE);
$options['separator'] = array('default' => ',', 'translatable' => TRUE);
$options['format_plural'] = array('default' => FALSE, 'bool' => TRUE);
$options['format_plural_singular'] = array('default' => '1');
$options['format_plural_plural'] = array('default' => '@count');
$options['prefix'] = array('default' => '', 'translatable' => TRUE);
$options['suffix'] = array('default' => '', 'translatable' => TRUE);
return $options;
}
function options_form(&$form, &$form_state) {
if (!empty($this->definition['float'])) {
$form['set_precision'] = array(
'#type' => 'checkbox',
'#title' => t('Round'),
'#description' => t('If checked, the number will be rounded.'),
'#default_value' => $this->options['set_precision'],
);
$form['precision'] = array(
'#type' => 'textfield',
'#title' => t('Precision'),
'#default_value' => $this->options['precision'],
'#description' => t('Specify how many digits to print after the decimal point.'),
'#dependency' => array('edit-options-set-precision' => array(TRUE)),
'#size' => 2,
);
$form['decimal'] = array(
'#type' => 'textfield',
'#title' => t('Decimal point'),
'#default_value' => $this->options['decimal'],
'#description' => t('What single character to use as a decimal point.'),
'#size' => 2,
);
}
$form['separator'] = array(
'#type' => 'select',
'#title' => t('Thousands marker'),
'#options' => array(
'' => t('- None -'),
',' => t('Comma'),
' ' => t('Space'),
'.' => t('Decimal'),
'\'' => t('Apostrophe'),
),
'#default_value' => $this->options['separator'],
'#description' => t('What single character to use as the thousands separator.'),
'#size' => 2,
);
$form['format_plural'] = array(
'#type' => 'checkbox',
'#title' => t('Format plural'),
'#description' => t('If checked, special handling will be used for plurality.'),
'#default_value' => $this->options['format_plural'],
);
$form['format_plural_singular'] = array(
'#type' => 'textfield',
'#title' => t('Singular form'),
'#default_value' => $this->options['format_plural_singular'],
'#description' => t('Text to use for the singular form.'),
'#dependency' => array('edit-options-format-plural' => array(TRUE)),
);
$form['format_plural_plural'] = array(
'#type' => 'textfield',
'#title' => t('Plural form'),
'#default_value' => $this->options['format_plural_plural'],
'#description' => t('Text to use for the plural form, @count will be replaced with the value.'),
'#dependency' => array('edit-options-format-plural' => array(TRUE)),
);
$form['prefix'] = array(
'#type' => 'textfield',
'#title' => t('Prefix'),
'#default_value' => $this->options['prefix'],
'#description' => t('Text to put before the number, such as currency symbol.'),
);
$form['suffix'] = array(
'#type' => 'textfield',
'#title' => t('Suffix'),
'#default_value' => $this->options['suffix'],
'#description' => t('Text to put after the number, such as currency symbol.'),
);
parent::options_form($form, $form_state);
}
function render($values) {
$value = $this->get_value($values);
if (!empty($this->options['set_precision'])) {
$value = number_format($value, $this->options['precision'], $this->options['decimal'], $this->options['separator']);
}
else {
$remainder = abs($value) - intval(abs($value));
$value = $value > 0 ? floor($value) : ceil($value);
$value = number_format($value, 0, '', $this->options['separator']);
if ($remainder) {
// The substr may not be locale safe.
$value .= $this->options['decimal'] . substr($remainder, 2);
}
}
// Check to see if hiding should happen before adding prefix and suffix.
if ($this->options['hide_empty'] && empty($value) && ($value !== 0 || $this->options['empty_zero'])) {
return '';
}
// Should we format as a plural.
if (!empty($this->options['format_plural'])) {
$value = format_plural($value, $this->options['format_plural_singular'], $this->options['format_plural_plural']);
}
return $this->sanitize_value($this->options['prefix'], 'xss')
. $this->sanitize_value($value)
. $this->sanitize_value($this->options['suffix'], 'xss');
}
}
Members
Name | Modifiers | Type | Description |
---|---|---|---|
views_handler_field_numeric:: |
function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides views_handler_field:: |
|
views_handler_field_numeric:: |
function |
Default options form that provides the label widget that all fields
should have. Overrides views_handler_field:: |
|
views_handler_field_numeric:: |
function |
Render the field. Overrides views_handler_field:: |
|
views_handler_field:: |
function |
Construct a new field handler. Overrides views_object:: |
|
views_handler_field:: |
function | Determine if this field can allow advanced rendering. | |
views_handler_field:: |
function |
init the handler with necessary data. Overrides views_handler:: |
|
views_handler_field:: |
function | Called to add the field to a query. | |
views_handler_field:: |
function | Add 'additional' fields to the query. | |
views_handler_field:: |
function | Called to determine what to tell the clicksorter. | |
views_handler_field:: |
function | Determine if this field is click sortable. | |
views_handler_field:: |
function | Get this field's label. | |
views_handler_field:: |
function | Return an HTML element based upon the field's element type. | |
views_handler_field:: |
function | Return an HTML element for the label based upon the field's element type. | |
views_handler_field:: |
function | Return an HTML element for the wrapper based upon the field's element type. | |
views_handler_field:: |
function | Provide a list of elements valid for field HTML. | |
views_handler_field:: |
function | Return the class of the field. | |
views_handler_field:: |
function | Replace a value with tokens from the last field. | |
views_handler_field:: |
function | Return the class of the field's label. | |
views_handler_field:: |
function | Return the class of the field's wrapper. | |
views_handler_field:: |
function | Get the value that's supposed to be rendered. | |
views_handler_field:: |
function | Determines if this field will be available as an option to group the result by in the style settings. | |
views_handler_field:: |
function |
Performs some cleanup tasks on the options array before saving it. Overrides views_handler:: |
|
views_handler_field:: |
function |
Provide extra data to the administration form Overrides views_handler:: |
|
views_handler_field:: |
function | Run before any fields are rendered. | |
views_handler_field:: |
function | Render a field using advanced settings. | |
views_handler_field:: |
function | Checks if a field value is empty. | |
views_handler_field:: |
function | Perform an advanced text render for the item. | |
views_handler_field:: |
function | Render this field as altered text, from a fieldset set by the user. | |
views_handler_field:: |
function | Trim the field down to the specified length. | |
views_handler_field:: |
function | Render this field as a link, with the info from a fieldset set by the user. | |
views_handler_field:: |
function | Get the 'render' tokens to use for advanced rendering. | |
views_handler_field:: |
function | Recursive function to add replacements for nested query string parameters. | |
views_handler_field:: |
function | Add any special tokens this field might use for itself. | |
views_handler_field:: |
function | Document any special tokens this field might use for itself. | |
views_handler_field:: |
function | Call out to the theme() function, which probably just calls render() but allows sites to override output fairly easily. | |
views_handler_field:: |
function | ||
views_handler_field:: |
function |
Return a string representing this handler's name in the UI. Overrides views_handler:: |
|
views_handler:: |
function | Shortcut to get a handler's raw field value. | |
views_handler:: |
function | Sanitize the value for output. | |
views_handler:: |
function | Transform a string by a certain method. | |
views_handler:: |
function | Validate the options form. | |
views_handler:: |
function | Provides the handler some groupby. | |
views_handler:: |
function | Provide a form for aggregation settings. | |
views_handler:: |
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:: |
function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | |
views_handler:: |
function | Provide defaults for the handler. | |
views_handler:: |
function | Provide a form for setting options. | |
views_handler:: |
function | Validate the options form. | |
views_handler:: |
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:: |
function | Determine if a handler can be exposed. | |
views_handler:: |
function | Set new exposed option defaults when exposed setting is flipped on. | |
views_handler:: |
function | Get information about the exposed form for the form renderer. | |
views_handler:: |
function | Render our chunk of the exposed handler form when selecting | |
views_handler:: |
function | Validate the exposed handler form | |
views_handler:: |
function | Submit the exposed handler form | |
views_handler:: |
function | Form for exposed handler options. | |
views_handler:: |
function | Validate the options form. | |
views_handler:: |
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:: |
function | Shortcut to display the expose/hide button. | |
views_handler:: |
function | Shortcut to display the exposed options form. | |
views_handler:: |
function | Check whether current user has access to this handler. | |
views_handler:: |
function | Run before the view is built. | |
views_handler:: |
function | Run after the view is executed, before the result is cached. | |
views_handler:: |
function | Provides a unique placeholders for handlers. | |
views_handler:: |
function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
views_handler:: |
function | Ensure the main table for this handler is in the query. This is used a lot. | |
views_handler:: |
function | Determine if the argument needs a style plugin. | |
views_handler:: |
function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler:: |
function | Returns TRUE if the exposed filter works like a grouped filter. | |
views_handler:: |
function | Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. | |
views_handler:: |
function | Take input from exposed handlers and assign to this handler, if necessary. | |
views_handler:: |
function | If set to remember exposed input in the session, store it there. | |
views_handler:: |
function | Get the join object that should be used for this handler. | |
views_handler:: |
function | Validates the handler against the complete View. | |
views_handler:: |
function | Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. | |
views_object:: |
function | Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility. | |
views_object:: |
function | Set default options. For backward compatibility, it sends the options array; this is a feature that will likely disappear at some point. | |
views_object:: |
function | ||
views_object:: |
function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
views_object:: |
function | Let the handler know what its full definition is. | |
views_object:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | Always exports the option, regardless of the default value. | |
views_object:: |
function | Unpacks each handler to store translatable texts. | |
views_object:: |
function | Unpack a single option definition. | |
views_handler_field:: |
public | property | The field value prior to any rewriting. |
views_handler:: |
public | property | The alias of the table of this handler which is used in the query. |