class FacetapiDependencyBundle in Facet API 7.2

Dependency plugin adding bundle conditions.

The bundle dependency plugin adds conditions based on active bundle facets. For example, the administrator can configure whether a facet is displayed based on whether certain bundles are active. If a facet stores field data, then an option is exposed to only show the facet if a bundle the field is attached to is active. This is most commonly used with taxonomy facets.

Hierarchy

• class \FacetapiDependency
  • class \FacetapiDependencyBundle

See also

http://drupal.org/node/551620

2 string references to 'FacetapiDependencyBundle'

facetapi_facetapi_dependencies in ./facetapi.facetapi.inc

Implements hook_facetapi_dependencies().

hook_facetapi_dependencies in ./facetapi.api.php

Define all dependency plugins provided by the module.

File

plugins/facetapi/dependency_bundle.inc, line 19

The bundle dependency class.

class FacetapiDependencyBundle extends FacetapiDependency {

  /**
   * Implements FacetapiDependency::execute().
   */
  public function execute() {
    switch ($this->settings['bundle']) {
      case 'referenced':

        // @todo Do we need defensive coding here?
        $field_info = field_info_field($this->facet['field api name']);

        // Iterate over field info, collect bundles this field is attached to.
        $field_bundles = array();
        foreach ($field_info['bundles'] as $entity => $bundles) {
          $field_bundles[$entity] = array_flip($bundles);
        }

        // Check match between the field's bundles and active bundle items.
        foreach ($this
          ->getEnabledBundleFacets() as $facet) {
          foreach ($facet['field api bundles'] as $entity) {
            $bundles = isset($field_bundles[$entity]) ? $field_bundles[$entity] : array();
            if (array_intersect_key($this->activeItems[$facet['name']], $bundles)) {
              return NULL;
            }
          }
        }

        // There was no match.
        return FALSE;
      case 'selected':

        // Check match between selected bundles and active bundle items.
        $selected = array_filter($this->settings['bundle_selected']);
        foreach ($this
          ->getEnabledBundleFacets() as $facet) {
          if (array_intersect_key($this->activeItems[$facet['name']], $selected)) {
            return NULL;
          }
        }

        // There was no match.
        return FALSE;
    }
  }

  /**
   * Returns an array of enabled facets that filter by bundle.
   *
   * @return array
   *   An array of enabled bundle facets.
   *
   * @see FacetapiDependencyBundle::filterBundleFacets()
   */
  public function getEnabledBundleFacets() {
    $enabled = array_filter($this->adapter
      ->getEnabledFacets(), array(
      $this,
      'filterBundleFacets',
    ));
    $active = array_filter($this->activeItems);
    return array_intersect_key($enabled, $active);
  }

  /**
   * Returns TRUE if the facet contains bundle information.
   *
   * @param array $facet
   *   The facet definition as returned by facetapi_facet_load().
   *
   * @return
   *   A boolean flagging whether the item should remain in the array.
   *
   * @see array_filter()
   */
  public function filterBundleFacets($facet) {
    return !empty($facet['field api bundles']);
  }

  /**
   * Overrides FacetapiDependency::settingsForm().
   */
  public function settingsForm(&$form, &$form_state) {

    // Builds array of options.
    $options = array();
    $options['none'] = t('No dependencies.');
    if ($this->facet['field api name']) {
      $options['referenced'] = t('A bundle this field is attached to must be active.');
    }
    $options['selected'] = t('At least one of the selected bundles must be active.');
    $form[$this->id]['bundle'] = array(
      '#title' => t('Dependency settings'),
      '#type' => 'radios',
      '#options' => $options,
      '#default_value' => $this->settings['bundle'],
    );
    $form[$this->id]['bundle_selected'] = array(
      '#title' => t('Required bundles'),
      '#type' => 'checkboxes',
      '#options' => $this
        ->getBundleOptions($form['#facetapi']['adapter']
        ->getTypes()),
      '#default_value' => $this->settings['bundle_selected'],
      '#states' => array(
        'visible' => array(
          'input[name="bundle"]' => array(
            'value' => 'selected',
          ),
        ),
      ),
      '#description' => t('At least one of the selected bundles must be active for this facet to be rendered.'),
    );
  }

  /**
   * Returns an array of bundles suitable for use as options in FAPI elements.
   *
   * @param array $entity_types
   *   An array containing the machine names of entities to gather bundles for.
   *
   * @return array
   *   An associative array keyed by machine name of the bundles to escaped
   *   bundle labels.
   */
  public function getBundleOptions(array $entity_types) {
    $options = array();
    foreach ($entity_types as $entity_type) {
      if ($entity_info = entity_get_info($entity_type)) {
        foreach ($entity_info['bundles'] as $bundle => $bundle_info) {
          $options[$bundle] = check_plain($bundle_info['label']);
        }
      }
    }
    return $options;
  }

  /**
   * Overrides FacetapiDependency::getDefaultSettings().
   */
  public function getDefaultSettings() {
    return array(
      'bundle' => 'none',
      'bundle_selected' => array(),
    );
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FacetapiDependency::$activeItems	protected	property	The facet's active items as returned by FacetapiAdapter::getActiveItems().
FacetapiDependency::$adapter	protected	property	The adapter associated with facet whose dependencies are being checked.
FacetapiDependency::$facet	protected	property	The facet definition as returned by facetapi_facet_load().
FacetapiDependency::$id	protected	property	The machine name of the plugin associated with this instance.
FacetapiDependency::$settings	protected	property	An array of dependency settings.
FacetapiDependency::getFacet	public	function	Gets the facet definition as returned by facetapi_facet_load().
FacetapiDependency::getId	public	function	Gets the machine name of the plugin.
FacetapiDependency::__construct	public	function	Constructs a FacetapiDependency object.
FacetapiDependencyBundle::execute	public	function	Implements FacetapiDependency::execute(). Overrides FacetapiDependency::execute
FacetapiDependencyBundle::filterBundleFacets	public	function	Returns TRUE if the facet contains bundle information.
FacetapiDependencyBundle::getBundleOptions	public	function	Returns an array of bundles suitable for use as options in FAPI elements.
FacetapiDependencyBundle::getDefaultSettings	public	function	Overrides FacetapiDependency::getDefaultSettings(). Overrides FacetapiDependency::getDefaultSettings
FacetapiDependencyBundle::getEnabledBundleFacets	public	function	Returns an array of enabled facets that filter by bundle.
FacetapiDependencyBundle::settingsForm	public	function	Overrides FacetapiDependency::settingsForm(). Overrides FacetapiDependency::settingsForm