Class FinderIndexerResult

Description

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.

  • since: 2.5

Located in /administrator/components/com_finder/helpers/indexer/result.php (line 26)


	
			
Variable Summary
integer $access
string $description
array $elements
string $end_date
string $language
mixed $list_price
integer $published
string $route
mixed $sale_price
string $start_date
integer $state
array $taxonomy
string $title
integer $type_id
string $url
Method Summary
void addInstruction (string $group, string $property)
void addTaxonomy (string $branch, string $title, [integer $state = 1], [integer $access = 1])
mixed getElement (string $name)
array getInstructions ()
array getTaxonomy ([string $branch = null])
void removeInstruction (string $group, string $property)
void setElement (string $name, mixed $value)
mixed __get (string $name)
boolean __isset (string $name)
void __set (string $name, mixed $value)
void __unset (string $name)
Variables
integer $access (line 115)

The content access level.

  • since: 2.5
  • access: public
string $description (line 91)

The content description.

  • since: 2.5
  • access: public
array $elements = array() (line 34)

An array of extra result properties.

  • since: 2.5
  • access: protected
string $end_date (line 155)

The generic end date.

  • since: 2.5
  • access: public
array $instructions = array(
FinderIndexer::TITLE_CONTEXT => array('title', 'subtitle', 'id'),FinderIndexer::TEXT_CONTEXT=>array('summary','body'),FinderIndexer::META_CONTEXT=>array('meta','list_price','sale_price'),FinderIndexer::PATH_CONTEXT=>array('path','alias'),FinderIndexer::MISC_CONTEXT=>array('comments'))
(line 43)

This array tells the indexer which properties should be indexed and what weights to use for those properties.

  • since: 2.5
  • access: protected
string $language = '*' (line 123)

The content language.

  • since: 2.5
  • access: public
mixed $list_price (line 163)

The item list price.

  • since: 2.5
  • access: public
integer $published (line 99)

The published state of the result.

  • since: 2.5
  • access: public
string $publish_end_date (line 139)

The publishing end date.

  • since: 2.5
  • access: public
string $publish_start_date (line 131)

The publishing start date.

  • since: 2.5
  • access: public
string $route (line 75)

The content route.

  • since: 2.5
  • access: public
mixed $sale_price (line 171)

The item sale price.

  • since: 2.5
  • access: public
string $start_date (line 147)

The generic start date.

  • since: 2.5
  • access: public
integer $state (line 107)

The content published state.

  • since: 2.5
  • access: public
array $taxonomy = array() (line 59)

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.

  • since: 2.5
  • access: protected
string $title (line 83)

The content title.

  • since: 2.5
  • access: public
integer $type_id (line 179)

The content type id. This is set by the adapter.

  • since: 2.5
  • access: public
string $url (line 67)

The content URL.

  • since: 2.5
  • access: public
Methods
addInstruction (line 309)

Method to add a processing instruction for an item property.

  • since: 2.5
  • access: public
void addInstruction (string $group, string $property)
  • string $group: The group to associate the property with.
  • string $property: The property to process.
addTaxonomy (line 384)

Method to add a taxonomy map for an item.

  • since: 2.5
  • access: public
void addTaxonomy (string $branch, string $title, [integer $state = 1], [integer $access = 1])
  • string $branch: The title of the taxonomy branch to add the node to.
  • string $title: The title of the taxonomy node.
  • integer $state: The published state of the taxonomy node. [optional]
  • integer $access: The access level of the taxonomy node. [optional]
getElement (line 259)

Method to retrieve additional element values from the elements array.

  • return: The value of the element if set, null otherwise.
  • since: 2.5
  • access: public
mixed getElement (string $name)
  • string $name: The name of the element.
getInstructions (line 294)

Method to get all processing instructions.

  • return: An array of processing instructions.
  • since: 2.5
  • access: public
array getInstructions ()
getTaxonomy (line 358)

Method to get the taxonomy maps for an item.

  • return: An array of taxonomy maps.
  • since: 2.5
  • access: public
array getTaxonomy ([string $branch = null])
  • string $branch: The taxonomy branch to get. [optional]
removeInstruction (line 333)

Method to remove a processing instruction for an item property.

  • since: 2.5
  • access: public
void removeInstruction (string $group, string $property)
  • string $group: The group to associate the property with.
  • string $property: The property to process.
setElement (line 282)

Method to set additional element values in the elements array.

  • since: 2.5
  • access: public
void setElement (string $name, mixed $value)
  • string $name: The name of the element.
  • mixed $value: The value of the element.
__get (line 207)

The magic get method is used to retrieve additional element values from the elements array.

  • return: The value of the element if set, null otherwise.
  • since: 2.5
  • access: public
mixed __get (string $name)
  • string $name: The name of the element.
__isset (line 230)

The magic isset method is used to check the state of additional element values in the elements array.

  • return: True if set, false otherwise.
  • since: 2.5
  • access: public
boolean __isset (string $name)
  • string $name: The name of the element.
__set (line 192)

The magic set method is used to push additional values into the elements array in order to preserve the cleanliness of the object.

  • since: 2.5
  • access: public
void __set (string $name, mixed $value)
  • string $name: The name of the element.
  • mixed $value: The value of the element.
__unset (line 245)

The magic unset method is used to unset additional element values in the elements array.

  • since: 2.5
  • access: public
void __unset (string $name)
  • string $name: The name of the element.

Documentation generated on Mon, 25 Jun 2012 13:59:17 -0500 by phpDocumentor 1.4.4