class TaxonomyTermDepthLayoutAccess

@file Plugin to provide access control based upon taxonomy term depth.

Hierarchy

class LayoutHandler
- class LayoutAccess
  - class TaxonomyTermDepthLayoutAccess

Expanded class hierarchy of TaxonomyTermDepthLayoutAccess

2 string references to 'TaxonomyTermDepthLayoutAccess'

taxonomy_autoload_info in core/modules/taxonomy/taxonomy.module: Implements hook_autoload_info().
taxonomy_layout_access_info in core/modules/taxonomy/taxonomy.module: Implements hook_layout_access_info().

File

core/modules/taxonomy/layout/taxonomy_term_depth_access.inc, line 6: Plugin to provide access control based upon taxonomy term depth.

View source

class TaxonomyTermDepthLayoutAccess extends LayoutAccess {
  /**
   * Constructor for a Layout access rule.
   */
  public function __construct($plugin_name, array $data = array()) {
    parent::__construct($plugin_name, $data);
    $this->settings += array(
      'depth' => array()
    );
  }

  /**
   * {@inheritdoc}
   */
  public function form(&$form, &$form_state) {
    parent::form($form, $form_state);

    $form['depth'] = array(
      '#type' => 'number',
      '#title' => t('Depth'),
      '#description' => t('Depth is the level of nesting for a taxonomy term. See example below.'),
      '#default_value' => $this->settings['depth'],
    );

    $code = '<code>';
    $code .= t('State (1st level, <strong>depth 1</strong>)') . '<br />';
    $code .= '- ' . t('City (2nd level, <strong>depth 2</strong>)') . '<br />';
    $code .= '&nbsp; - ' . t('Neighborhood (3rd level, <strong>depth 3</strong>)');
    $code .= '</code>';

    $form['depth_example'] = array(
      '#type' => 'markup',
      '#markup' => $code,
    );
  }

  /**
   * {@inheritdoc}
   */
  public function formSubmit($form, &$form_state) {
    parent::formSubmit($form, $form_state);
    $this->settings['depth'] = $form_state['values']['depth'];
  }

  /**
   * {@inheritdoc}
   */
  public function summary() {
    if (isset($this->settings['depth'])) {
      return t('Taxonomy term depth: @depth', array('@depth' => $this->settings['depth']));
    }

    return '';
  }

  /**
   * {@inheritdoc}
   */
  public function checkAccess() {
    if (!isset($this->contexts['taxonomy_term']->data)) {
      return FALSE;
    }

    $tid = $this->contexts['taxonomy_term']->data->tid;
    $depth = $this->getTermDepth($tid);

    if ($depth == $this->settings['depth']) {
      return TRUE;
    }

    return FALSE;
  }

  /**
   * Gets the depth of a term.
   *
   * @param $tid
   *   The taxonomy term ID
   *
   * @return int
   *   An integer representing how many levels deep your term is nested.
   */
  protected function getTermDepth($tid) {
    $parent = db_query("SELECT parent FROM {taxonomy_term_hierarchy} WHERE tid = :tid", array(':tid' => $tid))->fetchField();
    if ($parent == 0) {
      return 1;
    }
    else {
      return 1 + $this->getTermDepth($parent);
    }
  }
}

Members

Name	Modifiers	Type	Description
LayoutAccess::formValidate		function	Validate handler for the settings form for this access item.
LayoutAccess::getRequiredContexts		function	Get a list of all context plugin names required for this access check.
LayoutAccess::setContexts		function	Sets the contexts for this item from the full list of layout contexts.
LayoutAccess::toArray		function	Convert this object's properties to an array. Overrides LayoutHandler::toArray
LayoutHandler::label		function	Assemble a human-readable label of this object.
TaxonomyTermDepthLayoutAccess::checkAccess	public	function	Checks for access based on the available context. Overrides LayoutAccess::checkAccess
TaxonomyTermDepthLayoutAccess::form	public	function	Settings form for configuring this access item. Overrides LayoutAccess::form
TaxonomyTermDepthLayoutAccess::formSubmit	public	function	Submit handler for the settings form for this access item. Overrides LayoutAccess::formSubmit
TaxonomyTermDepthLayoutAccess::getTermDepth	protected	function	Gets the depth of a term.
TaxonomyTermDepthLayoutAccess::summary	public	function	Provides a human-readable summary of this access check's behavior. Overrides LayoutAccess::summary
TaxonomyTermDepthLayoutAccess::__construct	public	function	Constructor for a Layout access rule. Overrides LayoutAccess::__construct