class views_handler_area_text

Views area text handler.

Hierarchy

Expanded class hierarchy of views_handler_area_text

Related topics

Views area handlers
Handlers to tell Views what can display in header, footer
and empty text in a view.
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

View source 
class views_handler_area_text extends views_handler_area {
    
    /**
     * {@inheritdoc}
     */
    public 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;
    }
    
    /**
     * {@inheritdoc}
     */
    public 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 $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>',
            );
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public 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);
    }
    
    /**
     * {@inheritdoc}
     */
    public 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.
     */
    public 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

Title Deprecated Modifiers Object type Summary Overriden Title Overrides
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 &#039;broken&#039;. 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&#039;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 &#039;extra options&#039; 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 &#039;exposed&#039;, 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::ui_name public function Return a string representing this handler&#039;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&#039;t run a query. 1
views_handler_area::use_group_by public function Area handlers shouldn&#039;t have groupby. Overrides views_handler::use_group_by
views_handler_area_text::options_form public function Default options form that provides the label widget that all fields should
have. 		Overrides views_handler_area::options_form 1
views_handler_area_text::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. 		Overrides views_handler::options_submit 1
views_handler_area_text::option_definition public function Information about options for all kinds of purposes will be held here. Overrides views_handler_area::option_definition 1
views_handler_area_text::render public function Render the area. Overrides views_handler_area::render 1
views_handler_area_text::render_textarea public function Render a text area, using the proper format.
views_object::$definition public property Handler&#039;s definition.
views_object::$options public property Except for displays, options for the object will be held here. 1
views_object::altered_option_definition public function Collect this handler&#039;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&#039;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