Référence de la classe FinderIndexerResult

Liste de tous les membres

Fonctions membres publiques
	__set ($name, $value)
	__get ($name)
	__isset ($name)
	__unset ($name)
	getElement ($name)
	setElement ($name, $value)
	getInstructions ()
	addInstruction ($group, $property)
	removeInstruction ($group, $property)
	getTaxonomy ($branch=null)
	addTaxonomy ($branch, $title, $state=1, $access=1)

Attributs publics
	$url
	$route
	$title
	$description
	$published
	$state
	$access
	$language = '*'
	$publish_start_date
	$publish_end_date
	$start_date
	$end_date
	$list_price
	$sale_price
	$type_id

Attributs protégés
	$elements = array()
	$instructions
	$taxonomy = array()

---

Documentation des fonctions membres

FinderIndexerResult::__get

(

$name

)

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

Paramètres:

string

$name

The name of the element.

Renvoie:

mixed The value of the element if set, null otherwise.

Depuis:

2.5

Références $name, et null.

FinderIndexerResult::__isset

(

$name

)

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

Paramètres:

string

$name

The name of the element.

Renvoie:

boolean True if set, false otherwise.

Depuis:

2.5

Références $name.

FinderIndexerResult::__set	(		$name,
			$value
	)

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

Paramètres:

string	$name	The name of the element.
mixed	$value	The value of the element.

Renvoie:

void

Depuis:

2.5

Références $name.

FinderIndexerResult::__unset

(

$name

)

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

Paramètres:

string

$name

The name of the element.

Renvoie:

void

Depuis:

2.5

Références $name.

FinderIndexerResult::addInstruction	(		$group,
			$property
	)

Method to add a processing instruction for an item property.

Paramètres:

string	$group	The group to associate the property with.
string	$property	The property to process.

Renvoie:

void

Depuis:

2.5

Référencé par plgFinderCategories\index(), plgFinderContent\index(), plgFinderWeblinks\index(), plgFinderNewsfeeds\index(), et plgFinderContacts\index().

Voici le graphe des appelants de cette fonction :

FinderIndexerResult::addTaxonomy	(		$branch,
			$title,
			$state = 1,
			$access = 1
	)

Method to add a taxonomy map for an item.

Paramètres:

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]

Renvoie:

void

Depuis:

2.5

Références $state, et $title.

Référencé par plgFinderCategories\index(), plgFinderContent\index(), plgFinderWeblinks\index(), plgFinderNewsfeeds\index(), et plgFinderContacts\index().

Voici le graphe des appelants de cette fonction :

FinderIndexerResult::getElement

(

$name

)

Method to retrieve additional element values from the elements array.

Paramètres:

string

$name

The name of the element.

Renvoie:

mixed The value of the element if set, null otherwise.

Depuis:

2.5

Références $name, et null.

FinderIndexerResult::getInstructions

(

)

Method to get all processing instructions.

Renvoie:

array An array of processing instructions.

Depuis:

2.5

FinderIndexerResult::getTaxonomy

(

$branch = null

)

Method to get the taxonomy maps for an item.

Paramètres:

string

$branch

The taxonomy branch to get. [optional]

Renvoie:

array An array of taxonomy maps.

Depuis:

2.5

Références null.

FinderIndexerResult::removeInstruction	(		$group,
			$property
	)

Method to remove a processing instruction for an item property.

Paramètres:

string	$group	The group to associate the property with.
string	$property	The property to process.

Renvoie:

void

Depuis:

2.5

Références $key.

FinderIndexerResult::setElement	(		$name,
			$value
	)

Method to set additional element values in the elements array.

Paramètres:

string	$name	The name of the element.
mixed	$value	The value of the element.

Renvoie:

void

Depuis:

2.5

Références $name.

---

Documentation des données membres

FinderIndexerResult::$access

FinderIndexerResult::$description

FinderIndexerResult::$elements = array()

protected

FinderIndexerResult::$end_date

FinderIndexerResult::$instructions

protected

Valeur initiale :

 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')
        )

FinderIndexerResult::$language = '*'

FinderIndexerResult::$list_price

FinderIndexerResult::$publish_end_date

FinderIndexerResult::$publish_start_date

FinderIndexerResult::$published

FinderIndexerResult::$route

FinderIndexerResult::$sale_price

FinderIndexerResult::$start_date

FinderIndexerResult::$state

FinderIndexerResult::$taxonomy = array()

protected

FinderIndexerResult::$title

FinderIndexerResult::$type_id

FinderIndexerResult::$url

---

La documentation de cette classe a été générée à partir du fichier suivant :

• result.php