views_plugin_argument_default_php.inc

<?php


/**
 * @file
 * Definition of views_plugin_argument_default_php.
 */

/**
 * Default argument plugin to provide a PHP code block.
 *
 * @ingroup views_argument_default_plugins
 */
class views_plugin_argument_default_php extends views_plugin_argument_default {
    
    /**
     * {@inheritdoc}
     */
    public function option_definition() {
        $options = parent::option_definition();
        $options['code'] = array(
            'default' => '',
        );
        return $options;
    }
    
    /**
     * {@inheritdoc}
     */
    public function options_form(&$form, &$form_state) {
        parent::options_form($form, $form_state);
        $form['code'] = array(
            '#type' => 'textarea',
            '#title' => t('PHP contextual filter code'),
            '#default_value' => $this->options['code'],
            '#description' => t('Enter PHP code that returns a value to use for this filter. Do not use &lt;?php ?&gt;. You must return only a single value for just this filter. Some variables are available: the view object will be "$view". The argument handler will be "$argument", for example you may change the title used for substitutions for this argument by setting "argument->validated_title"".'),
        );
        // Only do this if using one simple standard form gadget.
        $this->check_access($form, 'code');
    }
    
    /**
     * {@inheritdoc}
     */
    public function convert_options(&$options) {
        if (!isset($options['code']) && isset($this->argument->options['default_argument_php'])) {
            $options['code'] = $this->argument->options['default_argument_php'];
        }
    }
    
    /**
     * Only let users with PHP block visibility permissions set/modify this
     * default plugin.
     */
    public function access() {
        return user_access('use PHP for settings');
    }
    
    /**
     * {@inheritdoc}
     */
    public function get_argument() {
        ob_start();
        $result = eval($this->options['code']);
        ob_end_clean();
        return $result;
    }

}