class context_condition_keywords in Context Keywords 7

Expose keywordss as a context condition.

Hierarchy

• class \context_condition
  • class \context_condition_keywords

2 string references to 'context_condition_keywords'

context_keywords_context_plugins in ./context_keywords.module

Make module compatible with context 3 Implement hook_context_plugins().

context_keywords_context_registry in ./context_keywords.module

Make module compatible with context 3 Implement hook_context_registry().

File

./context_condition_keywords.inc, line 6

class context_condition_keywords extends context_condition {

  /**
   * Omit condition values. We will provide a custom input form for our conditions.
   */
  function condition_values() {
    return array();
  }

  /**
   * Condition form.
   */
  function condition_form($context) {
    $form = parent::condition_form($context);
    unset($form['#options']);
    $form['#type'] = 'textarea';
    $form['#default_value'] = implode("\n", $this
      ->fetch_from_context($context, 'values'));
    return $form;
  }

  /**
   * Condition form submit handler.
   */
  function condition_form_submit($values) {
    $parsed = array();
    $items = explode("\n", $values);
    if (!empty($items)) {
      foreach ($items as $v) {
        $v = trim($v);
        if (!empty($v)) {
          $parsed[$v] = $v;
        }
      }
    }
    return $parsed;
  }

  /**
   * Execute.
   */
  function execute() {
    if ($this
      ->condition_used()) {

      // Include both the keywords alias and normal keywords for matching.
      if (!isset($_SESSION['HTTP_REFERER'])) {
        $_SESSION['HTTP_REFERER'] = $_SERVER['HTTP_REFERER'];
      }
      $url = $_SESSION['HTTP_REFERER'];

      // Check to see if $_GET["keywords"], if it does, check if it's a URL or individual arguments.
      $query = drupal_get_query_parameters();
      if (isset($query['keywords'])) {
        if (strpos($query['keywords'], '/')) {
          $current_keywords[] = context_keywords_provider_parse_url($query['keywords']);
        }
        else {
          $current_keywords[] = $query['keywords'];
        }
      }
      else {
        $current_keywords[] = context_keywords_provider_parse_url($url);
      }
      $default = TRUE;
      foreach ($this
        ->get_contexts() as $context) {
        $keywords = $this
          ->fetch_from_context($context, 'values');
        if ($this
          ->match($current_keywords, $keywords, FALSE)) {
          $default = FALSE;
          $this
            ->condition_met($context);
        }
      }
      if ($default) {
        foreach ($this
          ->get_contexts() as $context) {
          $keywords = $this
            ->fetch_from_context($context, 'values');
          if ($this
            ->match($current_keywords, $keywords, TRUE)) {
            $this
              ->condition_met($context);
          }
        }
      }
    }
  }

  /**
   * Match the subject against a set of regex patterns.
   * Similar to drupal_match_keywords() but also handles negation through the use
   * of the ~ character.
   *
   * @param mixed $subject
   *   The subject string or an array of strings to be matched.
   * @param array $patterns
   *   An array of patterns. Any patterns that begin with ~ are considered
   *   negative or excluded conditions.
   * @param boolean $keywords
   *   Whether the given subject should be matched as a Drupal keywords. If TRUE,
   *   '<front>' will be replaced with the site frontpage when matching against
   *   $patterns.
   *   '<default>' will activate if no contexts activate when $patterns = FALSE
   *
   */
  protected function match($subject, $patterns, $keywords = FALSE) {
    static $regexps;
    $match = FALSE;
    $positives = $negatives = 0;
    $subject = !is_array($subject) ? array(
      $subject,
    ) : $subject;
    foreach ($patterns as $pattern) {
      $pattern = strtolower($pattern);
      if (strpos($pattern, '~') === 0) {
        $negate = TRUE;
        $negatives++;
      }
      else {
        $negate = FALSE;
        $positives++;
      }
      $pattern = ltrim($pattern, '~');
      if (!isset($regexps[$pattern])) {
        $regexps[$pattern] = '/^(' . preg_replace(array(
          '/(\\r\\n?|\\n)/',
          '/\\\\\\*/',
        ), array(
          '|',
          '.*',
        ), preg_quote($pattern, '/')) . ')$/';
      }
      foreach ($subject as $value) {
        $value = strtolower($value);
        if (preg_match($regexps[$pattern], $value)) {
          if ($negate) {
            return FALSE;
          }
          $match = TRUE;
        }
      }
      if ($keywords && $pattern == '<default>') {
        $match = TRUE;
      }
    }

    // If there are **only** negative conditions and we've gotten this far none
    // we actually have a match.
    if ($positives === 0 && $negatives) {
      return TRUE;
    }
    return $match;
  }

}

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_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::editor_form		function	Context editor form for conditions.	2
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.	2
context_condition::options_form		function	Options form. Provide additional options for your condition.	4
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.
context_condition_keywords::condition_form		function	Condition form. Overrides context_condition::condition_form
context_condition_keywords::condition_form_submit		function	Condition form submit handler. Overrides context_condition::condition_form_submit
context_condition_keywords::condition_values		function	Omit condition values. We will provide a custom input form for our conditions. Overrides context_condition::condition_values
context_condition_keywords::execute		function	Execute.
context_condition_keywords::match	protected	function	Match the subject against a set of regex patterns. Similar to drupal_match_keywords() but also handles negation through the use of the ~ character.