Class: Entities_IndexLogic

Source Location: /lodel/scripts/logic/class.entities_index.php

Class Entities_IndexLogic

Class Overview

Classe de logique des entités (gestion de l'indexation dans le moteur de recherche)

Located in /lodel/scripts/logic/class.entities_index.php [line 60]

Logic
   |
   --Entities_IndexLogic

Author(s):

Ghislain Picard
Jean Lamy

API Tags:

See:

logic.php

Information Tags:

Version:	CVS:$Id:
Copyright:	2003, Ghislain Picard, Marin Dacos, Luc Santeramo, Nicolas Nutten, Anne Gentil-Beccot
Copyright:	2001-2002, Ghislain Picard, Marin Dacos
Copyright:	2004, Ghislain Picard, Marin Dacos, Luc Santeramo, Anne Gentil-Beccot, Bruno Cénou
Copyright:	2005, Ghislain Picard, Marin Dacos, Luc Santeramo, Gautier Poupeau, Jean Lamy, Bruno Cénou
Copyright:	2006, Marin Dacos, Luc Santeramo, Bruno Cénou, Jean Lamy, Mikaël Cixous, Sophie Malafosse
Copyright:	2007, Marin Dacos, Bruno Cénou, Sophie Malafosse, Pierre-Alain Mignot
Since:	Classe ajouté depuis la version 0.8

Properties

$g_name

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From Logic

Logic::$maintable

Logic::$rankcriteria

Inherited From Logic

Logic::Logic()

Constructeur de la classe.

Logic::changeRankAction()

Implémentation par défaut de l'action qui permet de changer le rang d'un objet.

Logic::copyAction()

Implémentation par défaut de l'action de copie d'un objet.

Logic::deleteAction()

Implémentation par défaut de l'action qui permet de supprimer un objet.

Logic::editAction()

Implémenation de l'action d'ajout ou d'édition d'un objet.

Logic::isdeletelocked()

Implémentation par défaut de isdeletelocked()

Logic::rights()

Implémentation par défaut de la fonction right

Logic::validateFields()

Validated the public fields and the unicity.

Logic::viewAction()

Implémentation par défaut de l'action permettant d'appeler l'affichage d'un objet.

Logic::_calculateHistoryField()

special processing for particular types of field

Logic::_changeRank()

Change the rank of an Object

Logic::_deleteRelatedTables()

Used in deleteAction to do extra operation after the object has been deleted

Logic::_getMainTableDAO()

Logic::_isAuthorizedStatus()

Vérification de la valeur du statut (champ status dans les tables)

Logic::_populateContext()

Populate the context from the object. All fields are outputted.

Logic::_populateContextRelatedTables()

Used in viewAction to do extra populate in the context

Logic::_populateObject()

Populate the object from the context. Only the public fields are inputted.

Logic::_prepareDelete()

Used in deleteAction to do extra operation before the object is saved.

Logic::_prepareEdit()

Used in editAction to do extra operation before the object is saved.

Logic::_processSpecialFields()

process of particular type of fields

Logic::_publicfields()

Logic::_saveRelatedTables()

Used in editAction to do extra operation after the object has been saved

Logic::_uniqueFields()

[ Top ]

Property Summary

array

$g_name

Tableau des équivalents génériques

[ Top ]

Method Summary

Entities_IndexLogic	Entities_IndexLogic()	Constructeur
void	addIndexAction()	Add an object to the search_engine. An object is added only its type must be indexed and if its fields have weight defined > 0
void	cleanIndexAction()	clean the index of all objet
void	deleteIndexAction()	delete an objet from the index
void	rebuildIndexAction()	Rebuild entirely the Index
an	_cleanAndcountTokens()	Function to split a string into tokens
$text	_decode_html_entities()	Private function
void	_indexEntitiesRelations()	Generic function to index relations of type entries and persons : E and G relations
void	_indexField()	index a given field in the database (using dao_index)
an	_splitInTokens()	Split a string into tokens by given regs

[ Top ]

Properties

array $g_name [line 67]

Tableau des équivalents génériques

[ Top ]

Methods

Constructor Entities_IndexLogic [line 72]

Entities_IndexLogic Entities_IndexLogic(
)

Constructeur

[ Top ]

addIndexAction [line 84]

void addIndexAction(
array
&$context, array
&$error 
)

Add an object to the search_engine. An object is added only its type must be indexed and if its fields have weight defined > 0

Parameters:

array	&$context:	le contexte passé par référence
array	&$error:	le tableau des erreurs éventuelles passé par référence

[ Top ]

cleanIndexAction [line 149]

void cleanIndexAction(
array
&$context, array
&$error 
)

clean the index of all objet

Parameters:

array	&$context:	le contexte passé par référence
array	&$error:	le tableau des erreurs éventuelles passé par référence

[ Top ]

deleteIndexAction [line 134]

void deleteIndexAction(
array
&$context, array
&$error 
)

delete an objet from the index

needed parameters

object id

Parameters:

array	&$context:	le contexte passé par référence
array	&$error:	le tableau des erreurs éventuelles passé par référence

[ Top ]

rebuildIndexAction [line 163]

void rebuildIndexAction(
array
&$context, array
&$error 
)

Rebuild entirely the Index

Parameters:

array	&$context:	le contexte passé par référence
array	&$error:	le tableau des erreurs éventuelles passé par référence

[ Top ]

_cleanAndcountTokens [line 259]

an _cleanAndcountTokens(
$string
$string, [$regs
$regs = 0] 
)

Function to split a string into tokens

Parameters:

$string	$string:	the string to be clean and word count
$regs	$regs:	the regs used to clean the string

API Tags:

Return:	array with for each word its count
Access:	private

[ Top ]

_decode_html_entities [line 229]

$text _decode_html_entities(
$text
$text 
)

Private function

Description : decode HTML entities,

Parameters:

$text

$text:

the text where HTML entities must be decoded

API Tags:

Return:	the text with HTML entities decoded
Access:	private

[ Top ]

_indexEntitiesRelations [line 285]

void _indexEntitiesRelations(
$id
$id, $nature
$nature, $daoIndex
$daoIndex 
)

Generic function to index relations of type entries and persons : E and G relations

Parameters:

$id	$id:	the id of the entity
$nature	$nature:	the nature of the relation
$daoIndex	$daoIndex:	the DAO object

API Tags:

Access:

private

[ Top ]

_indexField [line 205]

void _indexField(
$id
$id, $fieldValue
$fieldValue, $fieldName
$fieldName, $fieldWeight
$fieldWeight, $daoIndex
$daoIndex, [$prefixtablefield
$prefixtablefield = ''] 
)

index a given field in the database (using dao_index)

Parameters:

$id	$id:	: entity database identifier
$fieldValue	$fieldValue:	: the value of the field
$fieldName	$fieldName:	: the name of the field
$fieldWeight	$fieldWeight:	: the weight used to ponderate the field
$daoIndex	$daoIndex:	: the dao to use to save the data
$prefixtablefield	$prefixtablefield:	: empty by default but used to prefix the field 'tablefield' (for entries or persons for example)

[ Top ]

_splitInTokens [line 243]

an _splitInTokens(
$string
$string, [$regs
$regs = 0] 
)

Split a string into tokens by given regs

Parameters:

$string	$string:	the string to be splitted
$regs	$regs:	the regs used to split the string

API Tags:

Return:	array of tokens
Access:	private

[ Top ]

Documentation generated on Thu, 24 Jul 2008 05:07:39 +0200 by phpDocumentor 1.4.0a2

	lodel-logic

[ class tree: lodel-logic ] [ index: lodel-logic ] [ all elements ]