views_handler_field_custom.inc

Same filename in other branches
  1. 6.x-3.x handlers/views_handler_field_custom.inc

Definition of views_handler_field_custom.

File

handlers/views_handler_field_custom.inc

View source
<?php


/**
 * @file
 * Definition of views_handler_field_custom.
 */

/**
 * A handler to provide a field that is completely custom by the administrator.
 *
 * @ingroup views_field_handlers
 */
class views_handler_field_custom extends views_handler_field {
    
    /**
     * {@inheritdoc}
     */
    public function query() {
        // Do nothing -- to override the parent query.
    }
    
    /**
     * {@inheritdoc}
     */
    public function option_definition() {
        $options = parent::option_definition();
        // Override the alter text option to always alter the text.
        $options['alter']['contains']['alter_text'] = array(
            'default' => TRUE,
            'bool' => TRUE,
        );
        $options['hide_alter_empty'] = array(
            'default' => FALSE,
            'bool' => TRUE,
        );
        return $options;
    }
    
    /**
     * {@inheritdoc}
     */
    public function options_form(&$form, &$form_state) {
        parent::options_form($form, $form_state);
        // Remove the checkbox.
        unset($form['alter']['alter_text']);
        unset($form['alter']['text']['#dependency']);
        unset($form['alter']['text']['#process']);
        unset($form['alter']['help']['#dependency']);
        unset($form['alter']['help']['#process']);
        $form['#pre_render'][] = 'views_handler_field_custom_pre_render_move_text';
    }
    
    /**
     * {@inheritdoc}
     */
    public function render($values) {
        // Return the text, so the code never thinks the value is empty.
        return $this->options['alter']['text'];
    }

}

/**
 * Prerender function to move the textarea to the top.
 */
function views_handler_field_custom_pre_render_move_text($form) {
    $form['text'] = $form['alter']['text'];
    $form['help'] = $form['alter']['help'];
    unset($form['alter']['text']);
    unset($form['alter']['help']);
    return $form;
}

Functions

Title Deprecated Summary
views_handler_field_custom_pre_render_move_text Prerender function to move the textarea to the top.

Classes

Title Deprecated Summary
views_handler_field_custom A handler to provide a field that is completely custom by the administrator.