Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe FinderIndexerResult

Fonctions membres publiques

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

Champs de données

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

Attributs protégés

 $elements = array()
 
 $instructions
 
 $taxonomy = array()
 

Description détaillée

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.

Depuis
2.5

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( )

Constructor

Depuis
3.0.3

Documentation des fonctions membres

◆ __get()

__get (   $name)

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

Paramètres
string$nameThe name of the element.
Renvoie
mixed The value of the element if set, null otherwise.
Depuis
2.5

Références $name.

◆ __isset()

__isset (   $name)

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

Paramètres
string$nameThe name of the element.
Renvoie
boolean True if set, false otherwise.
Depuis
2.5

Références $name.

◆ __set()

__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$nameThe name of the element.
mixed$valueThe value of the element.
Renvoie
void
Depuis
2.5

Références $name, et $value.

◆ __unset()

__unset (   $name)

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

Paramètres
string$nameThe name of the element.
Renvoie
void
Depuis
2.5

Références $name.

◆ addInstruction()

addInstruction (   $group,
  $property 
)

Method to add a processing instruction for an item property.

Paramètres
string$groupThe group to associate the property with.
string$propertyThe property to process.
Renvoie
void
Depuis
2.5

◆ addTaxonomy()

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

Method to add a taxonomy map for an item.

Paramètres
string$branchThe title of the taxonomy branch to add the node to.
string$titleThe title of the taxonomy node.
integer$stateThe published state of the taxonomy node. [optional]
integer$accessThe access level of the taxonomy node. [optional]
Renvoie
void
Depuis
2.5

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

◆ getElement()

getElement (   $name)

Method to retrieve additional element values from the elements array.

Paramètres
string$nameThe name of the element.
Renvoie
mixed The value of the element if set, null otherwise.
Depuis
2.5

Références $name, et null.

◆ getElements()

getElements ( )

Method to retrieve all elements.

Renvoie
array The elements
Depuis
3.8.3

◆ getInstructions()

getInstructions ( )

Method to get all processing instructions.

Renvoie
array An array of processing instructions.
Depuis
2.5

◆ getTaxonomy()

getTaxonomy (   $branch = null)

Method to get the taxonomy maps for an item.

Paramètres
string$branchThe taxonomy branch to get. [optional]
Renvoie
array An array of taxonomy maps.
Depuis
2.5

Références null.

◆ removeInstruction()

removeInstruction (   $group,
  $property 
)

Method to remove a processing instruction for an item property.

Paramètres
string$groupThe group to associate the property with.
string$propertyThe property to process.
Renvoie
void
Depuis
2.5

Références $key.

◆ setElement()

setElement (   $name,
  $value 
)

Method to set additional element values in the elements array.

Paramètres
string$nameThe name of the element.
mixed$valueThe value of the element.
Renvoie
void
Depuis
2.5

Références $name, et $value.

◆ setLanguage()

setLanguage ( )

Method to set the item language

Renvoie
void
Depuis
3.0

Référencé par PlgFinderTags\index(), PlgFinderContacts\index(), et PlgFinderNewsfeeds\index().

Documentation des champs

◆ $access

$access

◆ $defaultLanguage

$defaultLanguage

◆ $description

◆ $elements

$elements = array()
protected

◆ $end_date

$end_date

◆ $instructions

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

◆ $language

$language = '*'

◆ $list_price

$list_price

◆ $publish_end_date

$publish_end_date

◆ $publish_start_date

$publish_start_date

◆ $published

$published

◆ $route

$route

◆ $sale_price

$sale_price

◆ $start_date

$start_date

◆ $state

$state

◆ $taxonomy

$taxonomy = array()
protected

◆ $title

◆ $type_id

$type_id

◆ $url

$url

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