function views_handler_field::options_form

Default options form that provides the label widget that all fields should have.

Overrides views_handler::options_form

File

handlers/views_handler_field.inc, line 378

Class

views_handler_field

Base field handler that has no options and renders an unformatted field.

Code

function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    // Use prefix and suffix to fake a fieldset because we use #tree.
    $form['style_prefix'] = array(
        '#value' => '<fieldset id="views-validator-options"><legend>' . t('Style settings') . '</legend>',
    );
    $form['exclude'] = array(
        '#type' => 'checkbox',
        '#title' => t('Exclude from display'),
        '#default_value' => $this->options['exclude'],
        '#description' => t('Check this box to not display this field, but still load it in the view. Use this option to not show a grouping field in each record, or when doing advanced theming, or when you want to use this field as a token in other fields.'),
    );
    $form['element_type'] = array(
        '#title' => t('HTML element'),
        '#options' => $this->get_elements(),
        '#type' => 'select',
        '#default_value' => $this->options['element_type'],
        '#description' => t('Most styles provide wrappers for fields. If the chosen style supports wrappers, wrap the field in this HTML element. The default will usually be either DIV or SPAN.'),
    );
    $form['element_class'] = array(
        '#title' => t('Element class'),
        '#description' => t('The class to provide on the wrapper element. You may enter data from this view as per the "Replacement patterns" used in "Rewrite the output of this field".'),
        '#type' => 'textfield',
        '#default_value' => $this->options['element_class'],
    );
    $form['label'] = array(
        '#type' => 'textfield',
        '#title' => t('Label'),
        '#default_value' => isset($this->options['label']) ? $this->options['label'] : '',
        '#description' => t('The label for this field that will be displayed to end users if the style requires it.'),
    );
    $form['element_label_type'] = array(
        '#title' => t('Label HTML element'),
        '#options' => $this->get_elements(FALSE),
        '#type' => 'select',
        '#default_value' => $this->options['element_label_type'],
        '#description' => t('What HTML Element type to use to wrap the label.'),
    );
    $form['element_label_class'] = array(
        '#title' => t('Label class'),
        '#description' => t('The class to provide on the label wrapper element.'),
        '#type' => 'textfield',
        '#default_value' => $this->options['element_label_class'],
    );
    $form['element_label_colon'] = array(
        '#type' => 'checkbox',
        '#title' => t('Place a colon after the label'),
        '#default_value' => $this->options['element_label_colon'],
        '#description' => t('If the label is to be inline with the value, place a colon between them. Not valid for styles such as table where the label is not placed with the value.'),
    );
    $form['element_wrapper_type'] = array(
        '#title' => t('Wrapper HTML element'),
        '#options' => $this->get_elements(FALSE),
        '#type' => 'select',
        '#default_value' => $this->options['element_wrapper_type'],
        '#description' => t('What HTML Element type to use to wrap the field (and the label). This is not supported by some styles such as tables.'),
    );
    $form['element_wrapper_class'] = array(
        '#title' => t('Wrapper class'),
        '#description' => t('The class to provide on the wrapper element.'),
        '#type' => 'textfield',
        '#default_value' => $this->options['element_wrapper_class'],
    );
    $form['element_default_classes'] = array(
        '#type' => 'checkbox',
        '#title' => t('Add default classes'),
        '#default_value' => $this->options['element_default_classes'],
        '#description' => t('Use default Views classes to identify the field, field label and field content.'),
    );
    $form['style_suffix'] = array(
        '#value' => '</fieldset>',
    );
    $form['alter'] = array(
        '#title' => t('Rewriting'),
        '#type' => 'fieldset',
    );
    if ($this->allow_advanced_render()) {
        $form['alter']['#tree'] = TRUE;
        $form['alter']['alter_text'] = array(
            '#type' => 'checkbox',
            '#title' => t('Rewrite the output of this field'),
            '#description' => t('If checked, you can alter the output of this field by specifying a string of text with replacement tokens that can use any existing field output.'),
            '#default_value' => $this->options['alter']['alter_text'],
        );
        $form['alter']['text'] = array(
            '#title' => t('Text'),
            '#type' => 'textarea',
            '#default_value' => $this->options['alter']['text'],
            '#description' => t('The text to display for this field. You may include HTML. You may enter data from this view as per the "Replacement patterns" below.'),
            '#process' => array(
                'views_process_dependency',
            ),
            '#dependency' => array(
                'edit-options-alter-alter-text' => array(
                    1,
                ),
            ),
        );
        $form['alter']['make_link'] = array(
            '#type' => 'checkbox',
            '#title' => t('Output this field as a link'),
            '#description' => t('If checked, this field will be made into a link. The destination must be given below.'),
            '#default_value' => $this->options['alter']['make_link'],
        );
        $form['alter']['path'] = array(
            '#title' => t('Link path'),
            '#type' => 'textfield',
            '#default_value' => $this->options['alter']['path'],
            '#description' => t('The Drupal path or absolute URL for this link. You may enter data from this view as per the "Replacement patterns" below.'),
            '#process' => array(
                'views_process_dependency',
            ),
            '#dependency' => array(
                'edit-options-alter-make-link' => array(
                    1,
                ),
            ),
            '#maxlength' => 255,
        );
        $form['alter']['absolute'] = array(
            '#type' => 'checkbox',
            '#title' => t('Use absolute path'),
            '#default_value' => $this->options['alter']['absolute'],
            '#process' => array(
                'views_process_dependency',
            ),
            '#dependency' => array(
                'edit-options-alter-make-link' => array(
                    1,
                ),
            ),
        );
        $form['alter']['replace_spaces'] = array(
            '#type' => 'checkbox',
            '#title' => t('Replace spaces with dashes'),
            '#default_value' => $this->options['alter']['replace_spaces'],
            '#process' => array(
                'views_process_dependency',
            ),
            '#dependency' => array(
                'edit-options-alter-make-link' => array(
                    1,
                ),
            ),
        );
        $form['alter']['external'] = array(
            '#type' => 'checkbox',
            '#title' => t('External server URL'),
            '#default_value' => $this->options['alter']['external'],
            '#description' => t("Links to an external server using a full URL: e.g. 'http://www.example.com' or 'www.example.com'."),
            '#process' => array(
                'views_process_dependency',
            ),
            '#dependency' => array(
                'edit-options-alter-make-link' => array(
                    1,
                ),
            ),
        );
        $form['alter']['link_class'] = array(
            '#title' => t('Link class'),
            '#type' => 'textfield',
            '#default_value' => $this->options['alter']['link_class'],
            '#description' => t('The CSS class to apply to the link.'),
            '#process' => array(
                'views_process_dependency',
            ),
            '#dependency' => array(
                'edit-options-alter-make-link' => array(
                    1,
                ),
            ),
        );
        $form['alter']['alt'] = array(
            '#title' => t('Title text'),
            '#type' => 'textfield',
            '#default_value' => $this->options['alter']['alt'],
            '#description' => t('Text to place as "title" text which most browsers display as a tooltip when hovering over the link.'),
            '#process' => array(
                'views_process_dependency',
            ),
            '#dependency' => array(
                'edit-options-alter-make-link' => array(
                    1,
                ),
            ),
        );
        $form['alter']['rel'] = array(
            '#title' => t('Rel Text'),
            '#type' => 'textfield',
            '#default_value' => $this->options['alter']['rel'],
            '#description' => t('Include Rel attribute for use in lightbox2 or other javascript utility.'),
            '#process' => array(
                'views_process_dependency',
            ),
            '#dependency' => array(
                'edit-options-alter-make-link' => array(
                    1,
                ),
            ),
        );
        $form['alter']['prefix'] = array(
            '#title' => t('Prefix text'),
            '#type' => 'textfield',
            '#default_value' => $this->options['alter']['prefix'],
            '#description' => t('Any text to display before this link. You may include HTML.'),
            '#process' => array(
                'views_process_dependency',
            ),
            '#dependency' => array(
                'edit-options-alter-make-link' => array(
                    1,
                ),
            ),
        );
        $form['alter']['suffix'] = array(
            '#title' => t('Suffix text'),
            '#type' => 'textfield',
            '#default_value' => $this->options['alter']['suffix'],
            '#description' => t('Any text to display after this link. You may include HTML.'),
            '#process' => array(
                'views_process_dependency',
            ),
            '#dependency' => array(
                'edit-options-alter-make-link' => array(
                    1,
                ),
            ),
        );
        $form['alter']['target'] = array(
            '#title' => t('Target'),
            '#type' => 'textfield',
            '#default_value' => $this->options['alter']['target'],
            '#description' => t("Target of the link, such as _blank, _parent or an iframe's name. This field is rarely used."),
            '#process' => array(
                'views_process_dependency',
            ),
            '#dependency' => array(
                'edit-options-alter-make-link' => array(
                    1,
                ),
            ),
        );
        // 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();
            // We only use fields up to (and including) this one.
            if ($field == $this->options['id']) {
                break;
            }
        }
        $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(),
            ));
        }
        $this->document_self_tokens($options[t('Fields')]);
        // Default text.
        $output = t('<p>You must add some additional fields to this display before using this field. These fields may be marked as <em>Exclude from display</em> if you prefer. Note that due to rendering order, you cannot use fields that come after this field; if you need a field not listed here, rearrange your fields.</p>');
        // We have some options, so make a list.
        if (!empty($options)) {
            $output = t('<p>The following tokens are available for this field. Note that due to rendering order, you cannot use fields that come after this field; if you need a field not listed here, rearrange your fields.
If you would like to have the characters %5B and %5D 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 . ' == ' . $value;
                    }
                    $output .= theme('item_list', $items, $type);
                }
            }
        }
        // This construct uses 'hidden' and not markup because process doesn't
        // run. It also has an extra div because the dependency wants to hide
        // the parent in situations like this, so we need a second div to
        // make this work.
        $form['alter']['help'] = array(
            '#type' => 'hidden',
            '#id' => 'views-tokens-help',
            '#prefix' => '<div><fieldset id="views-tokens-help"><legend>' . t('Replacement patterns') . '</legend>' . $output . '</fieldset></div>',
            '#process' => array(
                'views_process_dependency',
            ),
            '#dependency' => array(
                'edit-options-alter-make-link' => array(
                    1,
                ),
                'edit-options-alter-alter-text' => array(
                    1,
                ),
            ),
        );
        $form['alter']['trim'] = array(
            '#type' => 'checkbox',
            '#title' => t('Trim this field to a maximum length'),
            '#description' => t('If checked, this field be trimmed to a maximum length in characters.'),
            '#default_value' => $this->options['alter']['trim'],
        );
        $form['alter']['max_length'] = array(
            '#title' => t('Maximum length'),
            '#type' => 'textfield',
            '#default_value' => $this->options['alter']['max_length'],
            '#description' => t('The maximum number of characters this field can be.'),
            '#process' => array(
                'views_process_dependency',
            ),
            '#dependency' => array(
                'edit-options-alter-trim' => array(
                    1,
                ),
            ),
        );
        $form['alter']['word_boundary'] = array(
            '#type' => 'checkbox',
            '#title' => t('Trim only on a word boundary'),
            '#description' => t('If checked, this field be trimmed only on a word boundary. This is guaranteed to be the maximum characters stated or less. If there are no word boundaries this could trim a field to nothing.'),
            '#default_value' => $this->options['alter']['word_boundary'],
            '#process' => array(
                'views_process_dependency',
            ),
            '#dependency' => array(
                'edit-options-alter-trim' => array(
                    1,
                ),
            ),
        );
        $form['alter']['ellipsis'] = array(
            '#type' => 'checkbox',
            '#title' => t('Add an ellipsis'),
            '#description' => t('If checked, a "..." will be added if a field was trimmed.'),
            '#default_value' => $this->options['alter']['ellipsis'],
            '#process' => array(
                'views_process_dependency',
            ),
            '#dependency' => array(
                'edit-options-alter-trim' => array(
                    1,
                ),
            ),
        );
        $form['alter']['html'] = array(
            '#type' => 'checkbox',
            '#title' => t('Field can contain HTML'),
            '#description' => t('If checked, HTML corrector will be run to ensure tags are properly closed after trimming.'),
            '#default_value' => $this->options['alter']['html'],
            '#process' => array(
                'views_process_dependency',
            ),
            '#dependency' => array(
                'edit-options-alter-trim' => array(
                    1,
                ),
            ),
        );
        $form['alter']['strip_tags'] = array(
            '#type' => 'checkbox',
            '#title' => t('Strip HTML tags'),
            '#description' => t('If checked, all HTML tags will be stripped.'),
            '#default_value' => $this->options['alter']['strip_tags'],
        );
        $form['alter']['trim_whitespace'] = array(
            '#type' => 'checkbox',
            '#title' => t('Remove whitespace'),
            '#description' => t('If checked, all whitespaces at the beginning and the end of the output will be removed.'),
            '#default_value' => $this->options['alter']['trim_whitespace'],
        );
        $form['alter']['preserve_tags'] = array(
            '#type' => 'textfield',
            '#title' => t('Preserve certain tags'),
            '#description' => t('List the tags that need to be preserved during the stripping process. example &quot;&lt;p&gt; &lt;br&gt;&quot; which will preserve all p and br elements'),
            '#default_value' => $this->options['alter']['preserve_tags'],
            '#dependency' => array(
                'edit-options-alter-strip-tags' => array(
                    1,
                ),
            ),
            '#process' => array(
                'views_process_dependency',
            ),
        );
        $form['alter']['nl2br'] = array(
            '#type' => 'checkbox',
            '#title' => t('Convert newlines to HTML &lt;br&gt; tags'),
            '#description' => t('If checked, all newlines chars (e.g. \\n) are converted into HTML &lt;br&gt; tags.'),
            '#default_value' => $this->options['alter']['nl2br'],
            '#process' => array(
                'views_process_dependency',
            ),
        );
    }
    // Use prefix and suffix to fake a fieldset because we use #tree.
    $form['empty_prefix'] = array(
        '#value' => '<fieldset id="views-validator-options"><legend>' . t('Empty field behavior') . '</legend>',
    );
    $form['empty'] = array(
        '#type' => 'textarea',
        '#title' => t('Empty text'),
        '#default_value' => $this->options['empty'],
        '#description' => t('Provide text to display if this field returns no results. You may include HTML. You may enter data from this view as per the "Replacement patterns" in the "Rewrite Results" section below.'),
    );
    $form['empty_zero'] = array(
        '#type' => 'checkbox',
        '#title' => t('Count the number 0 as empty'),
        '#default_value' => $this->options['empty_zero'],
        '#description' => t('If the field contains the number zero, display the empty text instead'),
    );
    $form['hide_empty'] = array(
        '#type' => 'checkbox',
        '#title' => t('Hide if empty'),
        '#default_value' => $this->options['hide_empty'],
        '#description' => t('Enable to hide this field if it is empty. Note that the field label or rewritten output may still be displayed. To hide labels, check the style or row style settings for empty fields. To hide rewritten content, check the "Hide rewriting if empty" checkbox.'),
        '#fieldset' => 'empty_field_behavior',
    );
    $form['hide_alter_empty'] = array(
        '#type' => 'checkbox',
        '#title' => t('Hide rewriting if empty'),
        '#default_value' => $this->options['hide_alter_empty'],
        '#description' => t('Do not display rewritten content if this field is empty.'),
        '#fieldset' => 'empty_field_behavior',
    );
    $form['empty_suffix'] = array(
        '#value' => '</fieldset>',
    );
}