class views_plugin_argument_default_ancestor in Node Hierarchy 7.4

Default argument plugin to extract an ancestor node id of the currently active node.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_argument_default
      • class \views_plugin_argument_default_ancestor

File

includes/views/views_plugin_argument_default_ancestor.inc, line 10

Contains the node from URL argument default plugin.

class views_plugin_argument_default_ancestor extends views_plugin_argument_default {
  function argument_form(&$form, &$form_state) {
    $form['default_argument_ancestor_depth'] = array(
      '#title' => t('Ancestor Depth'),
      '#type' => 'textfield',
      '#default_value' => isset($this->argument->options['default_argument_ancestor_depth']) ? $this->argument->options['default_argument_ancestor_depth'] : -1,
      '#description' => t('Specify a the depth of the ancestor to use. You can specify from the top of the ancestor chain with a positive integer or from the bottom with a negative integer. For example: 1 would be the top level ancester, while -1 would be the current node\'s immediate parent.'),
      '#process' => array(
        'views_process_dependency',
      ),
      '#dependency' => array(
        'radio:options[default_action]' => array(
          'default',
        ),
        'radio:options[default_argument_type]' => array(
          $this->id,
        ),
      ),
      '#dependency_count' => 2,
    );
  }
  function get_argument() {
    foreach (range(1, 3) as $i) {
      $node = menu_get_object('node', $i);
      if (!empty($node) && ($ancestors = nodehierarchy_get_node_ancestor_nids($node->nid))) {
        $idx = $this->argument->options['default_argument_ancestor_depth'];
        if ($idx < 0) {
          $idx = count($ancestors) + $idx - 1;
        }
        return $ancestors[$idx];
      }
    }
    return NULL;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
views_object::$definition	public	property	Handler's definition.
views_object::$options	public	property	Except for displays, options for the object will be held here.	1
views_object::altered_option_definition		function	Collect this handler's option definition and alter them, ready for use.
views_object::construct	public	function	Views handlers use a special construct function.	4
views_object::destroy	public	function	Destructor.	2
views_object::export_option	public	function		1
views_object::export_options	public	function
views_object::export_option_always	public	function	Always exports the option, regardless of the default value.
views_object::options Deprecated	public	function	Set default options on this object.	1
views_object::set_default_options	public	function	Set default options.
views_object::set_definition	public	function	Let the handler know what its full definition is.
views_object::unpack_options	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable	public	function	Unpack a single option definition.
views_object::unpack_translatables	public	function	Unpacks each handler to store translatable texts.
views_object::_set_option_defaults	public	function
views_plugin::$display	public	property	The current used views display.
views_plugin::$plugin_name	public	property	The plugin name of this plugin, for example table or full.
views_plugin::$plugin_type	public	property	The plugin type of this plugin, for example style or query.
views_plugin::$view	public	property	The top object of a view. Overrides views_object::$view	1
views_plugin::additional_theme_functions	public	function	Provide a list of additional theme functions for the theme info page.
views_plugin::plugin_title	public	function	Return the human readable name of the display.
views_plugin::query	public	function	Add anything to the query that we might need to.	7
views_plugin::summary_title	public	function	Returns the summary of the settings in the display.	8
views_plugin::theme_functions	public	function	Provide a full list of possible theme templates used by this style.
views_plugin::validate	public	function	Validate that the plugin is correct and can be saved.	3
views_plugin_argument_default::access	public	function	Determine if the administrator has the privileges to use this plugin.	1
views_plugin_argument_default::check_access	public	function	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.
views_plugin_argument_default::convert_options	public	function	Convert options from the older style.	3
views_plugin_argument_default::init	public	function	Initialize this plugin with the view and the argument it is linked to.	1
views_plugin_argument_default::options_form	public	function	Provide the default form for setting options. Overrides views_plugin::options_form	5
views_plugin_argument_default::options_submit	public	function	Provide the default form form for submitting options. Overrides views_plugin::options_submit	1
views_plugin_argument_default::options_validate	public	function	Provide the default form form for validating options. Overrides views_plugin::options_validate
views_plugin_argument_default::option_definition	public	function	Retrieve the options when this is a new access control plugin. Overrides views_object::option_definition	5
views_plugin_argument_default_ancestor::argument_form		function
views_plugin_argument_default_ancestor::get_argument		function	Return the default argument. Overrides views_plugin_argument_default::get_argument