views_plugin_argument_default.inc

<?php


/**
 * @file
 * Definition of views_plugin_argument_default.
 */

/**
 * @defgroup views_argument_default_plugins Views argument default plugins
 * @{
 * Allow specialized methods of filling in arguments when they aren't provided.
 *
 * @see hook_views_plugins()
 */

/**
 * The fixed argument default handler; also used as the base.
 */
class views_plugin_argument_default extends views_plugin {
    
    /**
     * Return the default argument.
     *
     * This needs to be overridden by every default argument handler to properly
     * do what is needed.
     */
    public function get_argument() {
    }
    
    /**
     * Initialize this plugin with the view and the argument it is linked to.
     */
    public function init(&$view, &$argument, $options) {
        $this->view =& $view;
        $this->argument =& $argument;
        $this->convert_options($options);
        $this->unpack_options($this->options, $options);
    }
    
    /**
     * Retrieve the options when this is a new access control plugin.
     */
    public function option_definition() {
        return array();
    }
    
    /**
     * Provide the default form for setting options.
     */
    public function options_form(&$form, &$form_state) {
    }
    
    /**
     * Provide the default form form for validating options.
     */
    public function options_validate(&$form, &$form_state) {
    }
    
    /**
     * Provide the default form form for submitting options.
     */
    public function options_submit(&$form, &$form_state, &$options = array()) {
    }
    
    /**
     * Determine if the administrator has the privileges to use this plugin.
     */
    public function access() {
        return TRUE;
    }
    
    /**
     * If we don't have access to the form but are showing it anyway, ensure that
     * the form is safe and cannot be changed from user input.
     *
     * This is only called by child objects if specified in the options_form(),
     * so it will not always be used.
     */
    public function check_access(&$form, $option_name) {
        if (!$this->access()) {
            $form[$option_name]['#disabled'] = TRUE;
            $form[$option_name]['#value'] = $form[$this->option_name]['#default_value'];
            $form[$option_name]['#description'] .= ' <strong>' . t('Note: you do not have permission to modify this. If you change the default filter type, this setting will be lost and you will NOT be able to get it back.') . '</strong>';
        }
    }
    
    /**
     * Convert options from the older style.
     *
     * In Views 3, the method of storing default argument options has changed
     * and each plugin now gets its own silo. This method can be used to
     * move arguments from the old style to the new style. See
     * views_plugin_argument_default_fixed for a good example of this method.
     */
    public function convert_options(&$options) {
    }

}

/**
 * @}
 */