\SearchVariantVersioned

Synopsis

class SearchVariantVersioned extends SearchVariant {
}

Hierarchy

Extends

Members

protected

  • $call_instances
    Holds a cache of SearchVariant_Caller instances, one for each class/includeSubclasses setting
  • $class_variants
    Holds a cache of the variants keyed by "class!" "1"? (1 = include subclasses)
  • $variants
    Holds a cache of all variants

Methods

public

Inherited from SearchVariant

protected

  • addFilterField() — Add new filter field to index safely.
  • mergeClasses() — Merge sets of (or individual) class names together for a search index field.

public

  • activateState() — Activate the passed state
  • activate_state() — Activate all the states in the passed argument
  • alterQuery() — Apply this variant to a search query
  • appliesTo() — Return true if this variant applies to the passed class & subclass
  • appliesToEnvironment() — Return false if there is something missing from the environment (probably a not installed module) that means this variant can't apply to any class
  • call() — A shortcut to with when calling without passing in a class,
  • currentState() — Return the current state
  • current_state() — Get the current state of every variant
  • reindexStates() — Return all states to step through to reindex all items
  • reindex_states() — Return an iterator that, when used in a for loop, activates one combination of reindex states per loop, and restores back to the original state at the end
  • variants() — Returns an array of variants.
  • with() — Lets you call any function on all variants that support it, in the same manner as "Object#extend" calls a method from extensions.