class context_condition in Context 6

Base class for a context condition.

Hierarchy

• class \context_condition

2 string references to 'context_condition'

hook_context_plugins in ./context.api.php

CTools plugin API hook for Context. Note that a proper entry in hook_ctools_plugin_api() must exist for this hook to be called.

_context_context_plugins in ./context.plugins.inc

Context plugins.

File

plugins/context_condition.inc, line 6

class context_condition {
  var $plugin;
  var $title;
  var $description;
  var $values = array();

  /**
   * Clone our references when we're being cloned.
   *
   * PHP 5.3 performs 'shallow' clones when clone()'ing objects, meaning that
   * any objects or arrays referenced by this object will not be copied, the
   * cloned object will just reference our objects/arrays instead. By iterating
   * over our properties and serializing and unserializing them, we force PHP to
   * copy them.
   */
  function __clone() {
    foreach ($this as $key => $val) {
      if (is_object($val) || is_array($val)) {
        $this->{$key} = unserialize(serialize($val));
      }
    }
  }

  /**
   * Constructor. Do not override.
   */
  function __construct($plugin, $info) {
    $this->plugin = $plugin;
    $this->title = isset($info['title']) ? $info['title'] : $plugin;
    $this->description = isset($info['description']) ? $info['description'] : '';
  }

  /**
   * Condition values.
   */
  function condition_values() {
    return array();
  }

  /**
   * Condition form.
   */
  function condition_form($context) {
    return array(
      '#title' => $this->title,
      '#description' => $this->description,
      '#options' => $this
        ->condition_values(),
      '#type' => 'checkboxes',
      '#default_value' => $this
        ->fetch_from_context($context, 'values'),
    );
  }

  /**
   * Condition form submit handler.
   */
  function condition_form_submit($values) {
    ksort($values);

    // Editor forms are generally checkboxes -- do some checkbox processing.
    return drupal_map_assoc(array_keys(array_filter($values)));
  }

  /**
   * Options form. Provide additional options for your condition.
   */
  function options_form($context) {
    return array();
  }

  /**
   * Options form submit handler.
   */
  function options_form_submit($values) {
    return $values;
  }

  /**
   * Settings form. Provide variable settings for your condition.
   */
  function settings_form() {
    return array();
  }

  /**
   * Context editor form for conditions.
   */
  function editor_form($context) {
    $form = array();
    if (!empty($this->values)) {
      $options = $this
        ->condition_values();
      foreach ($this->values as $value => $contexts) {
        $label = "{$this->title}: ";
        $label .= isset($options[$value]) ? trim($options[$value], ' -') : $value;
        $form[$value] = array(
          '#type' => 'checkbox',
          '#title' => check_plain($label),
          '#default_value' => empty($context->name) ? TRUE : in_array($context->name, $contexts, TRUE),
        );
      }
    }
    return $form;
  }

  /**
   * Context editor form submit handler.
   */
  function editor_form_submit(&$context, $values) {

    // Merge existing values in from non-active conditions.
    $existing = $this
      ->fetch_from_context($context, 'values');
    $values += !empty($existing) ? $existing : array();
    ksort($values);

    // Editor forms are generally checkboxes -- do some checkbox processing.
    return drupal_map_assoc(array_keys(array_filter($values)));
  }

  /**
   * Public method that is called from hooks or other integration points with
   * Drupal. Note that it is not implemented in the base class, allowing
   * extending classes to change the function signature if necessary.
   *
   * function execute($value) {
   *   foreach ($this->get_contexts($value) as $context) {
   *     $this->condition_met($context, $value);
   *   }
   * }
   */

  /**
   * Marks a context as having met this particular condition.
   */
  function condition_met($context, $value = NULL) {
    if (isset($value)) {
      $this->values[$value] = isset($this->values[$value]) ? $this->values[$value] : array();
      $this->values[$value][] = $context->name;
    }
    context_condition_met($context, $this->plugin);
  }

  /**
   * Check whether this condition is used by any contexts. Can be used to
   * prevent expensive condition checks from being triggered when no contexts
   * use this condition.
   */
  function condition_used() {
    $map = context_condition_map();
    return !empty($map[$this->plugin]);
  }

  /**
   * Retrieve all contexts with the condition value provided.
   */
  function get_contexts($value = NULL) {
    $map = context_condition_map();
    $map = isset($map[$this->plugin]) ? $map[$this->plugin] : array();
    $contexts = array();
    if (isset($value) && (is_string($value) || is_numeric($value))) {
      if (isset($map[$value]) && is_array($map[$value])) {
        foreach ($map[$value] as $name) {
          if (!isset($contexts[$name])) {
            $context = context_load($name);
            $contexts[$context->name] = $context;
          }
        }
      }
    }
    else {
      foreach ($map as $submap) {
        foreach ($submap as $name) {
          if (!isset($contexts[$name])) {
            $context = context_load($name);
            $contexts[$context->name] = $context;
          }
        }
      }
    }
    return $contexts;
  }

  /**
   * Retrieve options from the context provided.
   */
  function fetch_from_context($context, $key = NULL) {
    if (isset($key)) {
      return isset($context->conditions[$this->plugin][$key]) ? $context->conditions[$this->plugin][$key] : array();
    }
    return isset($context->conditions[$this->plugin]) ? $context->conditions[$this->plugin] : array();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
context_condition::$description		property
context_condition::$plugin		property
context_condition::$title		property
context_condition::$values		property
context_condition::condition_form		function	Condition form.	3
context_condition::condition_form_submit		function	Condition form submit handler.	2
context_condition::condition_met		function	Marks a context as having met this particular condition.
context_condition::condition_used		function	Check whether this condition is used by any contexts. Can be used to prevent expensive condition checks from being triggered when no contexts use this condition.
context_condition::condition_values		function	Condition values.	9
context_condition::editor_form		function	Context editor form for conditions.	1
context_condition::editor_form_submit		function	Context editor form submit handler.
context_condition::fetch_from_context		function	Retrieve options from the context provided.
context_condition::get_contexts		function	Retrieve all contexts with the condition value provided.
context_condition::options_form		function	Options form. Provide additional options for your condition.	2
context_condition::options_form_submit		function	Options form submit handler.
context_condition::settings_form		function	Settings form. Provide variable settings for your condition.
context_condition::__clone		function	Clone our references when we're being cloned.
context_condition::__construct		function	Constructor. Do not override.