class views_handler_area_text
Views area text handler.
Hierarchy
- class \views_object
- class \views_handler
- class \views_handler_area
- class \views_handler_area_text
- class \views_handler_area
- class \views_handler
Expanded class hierarchy of views_handler_area_text
Related topics
1 string reference to 'views_handler_area_text'
- views_views_data in modules/
views.views.inc - Implements hook_views_data().
File
- handlers/
views_handler_area_text.inc, line 13 - Definition of views_handler_area_text.
View source
class views_handler_area_text extends views_handler_area {
function option_definition() {
$options = parent::option_definition();
$options['content'] = array('default' => '', 'translatable' => TRUE, 'format_key' => 'format');
$options['format'] = array('default' => NULL);
$options['tokenize'] = array('default' => FALSE, 'bool' => TRUE);
return $options;
}
function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
$form['content'] = array(
'#type' => 'text_format',
'#default_value' => $this->options['content'],
'#rows' => 6,
'#format' => isset($this->options['format']) ? $this->options['format'] : filter_default_format(),
'#wysiwyg' => FALSE,
);
// @TODO: Refactor token handling into a base class.
$form['tokenize'] = array(
'#type' => 'checkbox',
'#title' => t('Use replacement tokens from the first row'),
'#default_value' => $this->options['tokenize'],
);
// Get a list of the available fields and arguments for token replacement.
$options = array();
foreach ($this->view->display_handler->get_handlers('field') as $field => $handler) {
$options[t('Fields')]["[$field]"] = $handler->ui_name();
}
$count = 0; // This lets us prepare the key as we want it printed.
foreach ($this->view->display_handler->get_handlers('argument') as $arg => $handler) {
$options[t('Arguments')]['%' . ++$count] = t('@argument title', array('@argument' => $handler->ui_name()));
$options[t('Arguments')]['!' . $count] = t('@argument input', array('@argument' => $handler->ui_name()));
}
if (!empty($options)) {
$output = '<p>' . t('The following tokens are available. If you would like to have the characters \'[\' and \']\' please use the html entity codes \'%5B\' or \'%5D\' or they will get replaced with empty space.' . '</p>');
foreach (array_keys($options) as $type) {
if (!empty($options[$type])) {
$items = array();
foreach ($options[$type] as $key => $value) {
$items[] = $key . ' == ' . check_plain($value);
}
$output .= theme('item_list',
array(
'items' => $items,
'type' => $type
));
}
}
$form['token_help'] = array(
'#type' => 'fieldset',
'#title' => t('Replacement patterns'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#value' => $output,
'#id' => 'edit-options-token-help',
'#dependency' => array(
'edit-options-tokenize' => array(1),
),
'#prefix' => '<div>',
'#suffix' => '</div>',
);
}
}
function options_submit(&$form, &$form_state) {
$form_state['values']['options']['format'] = $form_state['values']['options']['content']['format'];
$form_state['values']['options']['content'] = $form_state['values']['options']['content']['value'];
parent::options_submit($form, $form_state);
}
function render($empty = FALSE) {
$format = isset($this->options['format']) ? $this->options['format'] : filter_default_format();
if (!$empty || !empty($this->options['empty'])) {
return $this->render_textarea($this->options['content'], $format);
}
return '';
}
/**
* Render a text area, using the proper format.
*/
function render_textarea($value, $format) {
if ($value) {
if ($this->options['tokenize']) {
$value = $this->view->style_plugin->tokenize_value($value, 0);
}
return check_markup($value, $format, '', FALSE);
}
}
}
Members
Name | Modifiers | Type | Description |
---|---|---|---|
views_object:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | Always exports the option, regardless of the default value. | |
views_handler_area:: |
function |
Area handlers shouldn't have groupby. Overrides views_handler:: |
|
views_handler:: |
function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
views_handler:: |
function | Check whether current user has access to this handler. | |
views_handler_area_text:: |
function |
Default options form that provides the label widget that all fields
should have. Overrides views_handler_area:: |
|
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 | Determine if a handler can be exposed. | |
views_handler:: |
function | Determine if the argument needs a style plugin. | |
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_handler:: |
function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler_area:: |
function | Don't run a query | |
views_handler:: |
function | Ensure the main table for this handler is in the query. This is used a lot. | |
views_handler:: |
function | Form for exposed handler options. | |
views_handler:: |
function | Get information about the exposed form for the form renderer. | |
views_handler:: |
function | Get the join object that should be used for this handler. | |
views_handler_area:: |
function | Get this field's label. | |
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 | If set to remember exposed input in the session, store it there. | |
views_handler_area_text:: |
function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides views_handler_area:: |
|
views_object:: |
function | Let the handler know what its full definition is. | |
views_handler_area:: |
function |
Overrides views_handler::init(). Overrides views_handler:: |
|
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_area_text:: |
function |
Perform any necessary changes to the form values prior to storage.
There is no need for this function to actually store the data. Overrides views_handler:: |
|
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 | 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 | Provide a form for aggregation settings. | |
views_handler:: |
function | Provide a form for setting options. | |
views_handler:: |
function | Provide defaults for the handler. | |
views_handler_area:: |
function |
Provide extra data to the administration form Overrides views_handler:: |
|
views_handler:: |
function | Provides a unique placeholders for handlers. | |
views_handler_area_text:: |
function | Render a text area, using the proper format. | |
views_handler:: |
function | Render our chunk of the exposed handler form when selecting | |
views_handler_area_text:: |
function |
Render the area Overrides views_handler_area:: |
|
views_handler:: |
function | Return a string representing this handler's name in the UI. | |
views_handler:: |
function | Returns TRUE if the exposed filter works like a grouped filter. | |
views_handler:: |
function | Run after the view is executed, before the result is cached. | |
views_handler:: |
function | Run before the view is built. | |
views_handler:: |
function | Sanitize the value for output. | |
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_handler:: |
function | Set new exposed option defaults when exposed setting is flipped on. | |
views_handler:: |
function | Shortcut to display the expose/hide button. | |
views_handler:: |
function | Shortcut to display the exposed options form. | |
views_handler:: |
function | Shortcut to get a handler's raw field value. | |
views_handler:: |
function | Submit the exposed handler form | |
views_handler:: |
function | Take input from exposed handlers and assign to this handler, if necessary. | |
views_handler:: |
public | property | The alias of the table of this handler which is used in the query. |
views_handler:: |
function | Transform a string by a certain method. | |
views_object:: |
function | Unpack a single option definition. | |
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 | Unpacks each handler to store translatable texts. | |
views_handler:: |
function | Validate the exposed handler form | |
views_handler:: |
function | Validate the options form. | |
views_handler:: |
function | Validate the options form. | |
views_handler:: |
function | Validate the options form. | |
views_handler:: |
function | Validates the handler against the complete View. | |
views_object:: |
function | Views handlers use a special construct function so that we can more easily construct them with variable arguments. |