class FacetapiDependencyFacet in Facet API Bonus 7

Adds a dependency on another facet being active.

Hierarchy

• class \FacetapiDependencyFacet extends \FacetapiDependency

1 string reference to 'FacetapiDependencyFacet'

facetapi_bonus_facetapi_dependencies in ./facetapi_bonus.module

Implements hook_facetapi_dependencies().

File

plugins/facetapi/dependency_facet.inc, line 18

Performs a dependency check against other specified facets/facet values

class FacetapiDependencyFacet extends FacetapiDependency {
  protected $defaultSettings;

  /**
   * Executes the dependency check.
   */
  public function execute() {

    // Show this facet, if it is active itself and forced deactivation isn't on.
    if (!$this->settings['force_deactivation'] && $this->activeItems[$this->facet['name']]) {
      return;
    }
    else {

      // Show this facet if no facet dependencies are configured.
      $facets = array_filter($this->settings['facets']);
      if (empty($facets)) {
        return;
      }
      else {

        // Check if any configured facet dependency is met.
        foreach ($facets as $facet_name) {
          if ($this->activeItems[$facet_name]) {

            // Show/hide if dependency is met without specific dependency items.
            if (empty($this->settings['facet_items_' . $facet_name])) {
              return !$this->settings['reverse_dependency'];
            }
            else {
              $items_string = trim($this->settings['facet_items_' . $facet_name]);
              $facet_items = drupal_explode_tags($items_string);

              // Show/hide if dependency is met without specific dependency items.
              if (empty($items_string) || empty($facet_items)) {
                return !$this->settings['reverse_dependency'];
              }
              else {
                foreach ($facet_items as $facet_item) {
                  foreach ($this->activeItems[$facet_name] as $active_facet_item_key => $active_facet_item_data) {
                    if (!empty($facet_item)) {
                      if (!$this->settings['regex']) {
                        if ($facet_item == $active_facet_item_key) {
                          return !$this->settings['reverse_dependency'];
                        }
                      }
                      else {
                        $facet_item = '/' . trim(str_replace('/', '\\/', $facet_item)) . '/';
                        if (preg_match($facet_item, $active_facet_item_key)) {
                          return !$this->settings['reverse_dependency'];
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }

        // Otherwise show/hide this facet.
        return $this->settings['reverse_dependency'];
      }
    }
  }

  /**
   * Adds dependency settings to the form.
   */
  public function settingsForm(&$form, &$form_state) {

    // Get enabled facets (minus this dependency's one).
    $facets = $this
      ->getEnabledFacets();
    $form[$this->id]['facets'] = array(
      '#type' => 'checkboxes',
      '#title' => t('Show this facet only for specific other facets'),
      '#default_value' => $this->settings['facets'],
      '#options' => array_map('check_plain', $facets),
      '#description' => t('Show this facet only if another one of these selected facet(s) is actively in use. If you select no other facets, the facet will be visible not depend on other facets.'),
    );
    $form[$this->id]['reverse_dependency'] = array(
      '#type' => 'checkbox',
      '#title' => t('Reverse dependency.'),
      '#default_value' => $this->settings['reverse_dependency'],
      '#description' => t('Reverse dependency logic: the facet will be deactivated in the dependency is met.'),
    );
    $form[$this->id]['force_deactivation'] = array(
      '#type' => 'checkbox',
      '#title' => t('Force deactivation for unmet dependency.'),
      '#default_value' => $this->settings['force_deactivation'],
      '#description' => t('Deactivate this facet if dependency is not met anymore, even if this facet has had active items itself (recommended)'),
    );
    $form[$this->id]['regex'] = array(
      '#title' => t('Regular expressions used'),
      '#type' => 'checkbox',
      '#description' => t('Interpret each facet item of each list below as a regular expression pattern.<br /><small>(Slashes are escaped automatically, patterns using a comma can be wrapped in "double quotes", and if such a pattern uses double quotes itself, just make them double-double-quotes (""))</small>.'),
      '#default_value' => $this->settings['regex'],
    );

    // Add optional value field and extend default settings for each facet.
    foreach ($facets as $facet_name => $facet_title) {
      $id = 'facet_items_' . $facet_name;
      $checkboxid = '#edit-facets-' . str_replace('_', '-', drupal_strtolower($facet_name));
      $form[$this->id][$id] = array(
        '#title' => t('Facet items for %facet', array(
          '%facet' => $facet_title,
        )),
        '#type' => 'textfield',
        '#description' => t("Comma separated list of facet items to depend on, matching against an facet item's value."),
        '#default_value' => isset($this->settings[$id]) ? $this->settings[$id] : NULL,
        '#states' => array(
          'visible' => array(
            $checkboxid => array(
              'checked' => TRUE,
            ),
          ),
        ),
      );
      $this->defaultSettings[$id] = '';
    }
  }

  /**
   * Returns defaults for settings.
   *
   * Has to be dynamic since we want a detail settings field for each dependency
   * but the enabled facets are not known yet (afaik, hence the add. property)
   */
  public function getDefaultSettings() {
    if (empty($this->defaultSettings)) {
      $this->defaultSettings = array(
        'facets' => array(),
        'reverse_dependency' => FALSE,
        'force_deactivation' => TRUE,
        'regex' => FALSE,
      );
    }
    return $this->defaultSettings;
  }

  /**
   * Determine enabled facets
   *
   * Returns an associative array facet name => title
   * of factes enabled for the given searcher
   */
  public function getEnabledFacets() {
    $facets = array();
    $enabled_facets = facetapi_get_enabled_facets($this->adapter
      ->getSearcher());
    unset($enabled_facets[$this->facet['name']]);
    foreach ($enabled_facets as $facet_key => $facet_object) {
      $facets[$facet_key] = $facet_object['label'] . ' (' . $facet_object['name'] . ')';
    }
    return $facets;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FacetapiDependencyFacet::$defaultSettings	protected	property
FacetapiDependencyFacet::execute	public	function	Executes the dependency check.
FacetapiDependencyFacet::getDefaultSettings	public	function	Returns defaults for settings.
FacetapiDependencyFacet::getEnabledFacets	public	function	Determine enabled facets
FacetapiDependencyFacet::settingsForm	public	function	Adds dependency settings to the form.