views_handler_field_user_name.inc

<?php


/**
 * @file
 * Definition of views_handler_field_user_name.
 */

/**
 * Field handler for a simple renderer that allows using a themed user link.
 *
 * @ingroup views_field_handlers
 */
class views_handler_field_user_name extends views_handler_field_user {
    
    /**
     * {@inheritdoc}
     */
    public function option_definition() {
        $options = parent::option_definition();
        $options['overwrite_anonymous'] = array(
            'default' => FALSE,
            'bool' => TRUE,
        );
        $options['anonymous_text'] = array(
            'default' => '',
            'translatable' => TRUE,
        );
        $options['format_username'] = array(
            'default' => TRUE,
            'bool' => TRUE,
        );
        return $options;
    }
    
    /**
     * {@inheritdoc}
     */
    public function options_form(&$form, &$form_state) {
        $form['format_username'] = array(
            '#title' => t('Use formatted username'),
            '#type' => 'checkbox',
            '#default_value' => !empty($this->options['format_username']),
            '#description' => t('If checked, the username will be formatted by the system. If unchecked, it will be displayed raw.'),
            '#fieldset' => 'more',
        );
        $form['overwrite_anonymous'] = array(
            '#title' => t('Overwrite the value to display for anonymous users'),
            '#type' => 'checkbox',
            '#default_value' => !empty($this->options['overwrite_anonymous']),
            '#description' => t('Enable to display different text for anonymous users.'),
            '#fieldset' => 'more',
        );
        $form['anonymous_text'] = array(
            '#title' => t('Text to display for anonymous users'),
            '#type' => 'textfield',
            '#default_value' => $this->options['anonymous_text'],
            '#dependency' => array(
                'edit-options-overwrite-anonymous' => array(
                    1,
                ),
            ),
            '#fieldset' => 'more',
        );
        parent::options_form($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function render_link($data, $values) {
        $account = new stdClass();
        $account->uid = $this->get_value($values, 'uid');
        $account->name = $this->get_value($values);
        // If we don't have a UID, we can't format anything.
        if (!isset($account->uid)) {
            return $data;
        }
        if (!empty($this->options['link_to_user']) || !empty($this->options['overwrite_anonymous'])) {
            if (!empty($this->options['overwrite_anonymous']) && !$account->uid) {
                // This is an anonymous user, and we're overriting the text.
                return check_plain($this->options['anonymous_text']);
            }
            elseif (!empty($this->options['link_to_user'])) {
                $account->name = $this->get_value($values);
                return theme('username', array(
                    'account' => $account,
                ));
            }
        }
        // If we want a formatted username, do that.
        if (!empty($this->options['format_username']) && !is_null($account->uid)) {
            return format_username($account);
        }
        // Otherwise, there's no special handling, so return the data directly.
        return $data;
    }

}