\FinderIndexerResult

Result class for the Finder indexer package.

This class uses magic __get() and __set() methods to prevent properties
being added that might confuse the system. All properties not explicitly
declared will be pushed into the elements array and can be accessed
explicitly using the getElement() method.

Synopsis

class FinderIndexerResult {

• // members
• protected  $elements;
• protected  $instructions;
• protected  $taxonomy;
• public  $url;
• public  $route;
• public  $title;
• public  $description;
• public  $published;
• public  $state;
• public  $access;
• public  $language;
• public  $publish_start_date;
• public  $publish_end_date;
• public  $start_date;
• public  $end_date;
• public  $list_price;
• public  $sale_price;
• public  $type_id;
• public  $defaultLanguage;
• // methods
• public void __construct()
• public void __set()
• public mixed __get()
• public boolean __isset()
• public void __unset()
• public mixed getElement()
• public void setElement()
• public array getInstructions()
• public void addInstruction()
• public void removeInstruction()
• public array getTaxonomy()
• public void addTaxonomy()
• public void setLanguage()
}


Members

protected

• $elements — array
  An array of extra result properties.
• $instructions — array
  This array tells the indexer which properties should be indexed and what weights to use for those properties.
• $taxonomy — array
  The indexer will use this data to create taxonomy mapping entries for the item so that it can be filtered by type, label, category, or whatever.

public

• $access — integer
  The content access level.
• $defaultLanguage — string
  The default language for content.
• $description — string
  The content description.
• $end_date — string
  The generic end date.
• $language — string
  The content language.
• $list_price — mixed
  The item list price.
• $publish_end_date — string
  The publishing end date.
• $publish_start_date — string
  The publishing start date.
• $published — integer
  The published state of the result.
• $route — string
  The content route.
• $sale_price — mixed
  The item sale price.
• $start_date — string
  The generic start date.
• $state — integer
  The content published state.
• $title — string
  The content title.
• $type_id — integer
  The content type id. This is set by the adapter.
• $url — string
  The content URL.

Methods

public

• __construct() — Constructor
• __get() — The magic get method is used to retrieve additional element values from the elements array.
• __isset() — The magic isset method is used to check the state of additional element values in the elements array.
• __set() — The magic set method is used to push additional values into the elements array in order to preserve the cleanliness of the object.
• __unset() — The magic unset method is used to unset additional element values in the elements array.
• addInstruction() — Method to add a processing instruction for an item property.
• addTaxonomy() — Method to add a taxonomy map for an item.
• getElement() — Method to retrieve additional element values from the elements array.
• getInstructions() — Method to get all processing instructions.
• getTaxonomy() — Method to get the taxonomy maps for an item.
• removeInstruction() — Method to remove a processing instruction for an item property.
• setElement() — Method to set additional element values in the elements array.
• setLanguage() — Method to set the item language