Class: GenericLogic

Source Location: /lodel/scripts/genericlogic.php

Class GenericLogic

Class Overview

Classe des logiques métiers générique.

Cette classe définit la logique par défaut pour les objets dynamiques de l'interface : entrées, personnes par exemple

Located in /lodel/scripts/genericlogic.php [line 65]

Logic
   |
   --GenericLogic

Author(s):

Jean Lamy
Ghislain Picard

API Tags:

See:

logic.php

Information Tags:

Version:	CVS:$Id:
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ée depuis la version 0.8

Properties

$_publicfields_array

Methods

[ Top ]

Descendants

Child Class	Description
Entities_EditionLogic	Classe de logique des entités (gestion de l'édition)
EntriesLogic	Classe de logique des entrées

[ 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

mixed

$_publicfields_array

[ Top ]

Method Summary

GenericLogic	GenericLogic()	Constructeur de la classe
void	addGenericEquivalent()	Définition de l'équivalent générique permanent.
void	getGenericEquivalent()	Retourne un équivalent générique pour une classe et un champ donné
void	validateFields()	Validated the public fields and the unicity as usual and in addition the typescompatibility
string	viewAction()	Implémentation pour les objets générique de l'action permettant d'appeler l'affichage d'un objet.
bool	_is_unique()	Vérifie que la valeur d'un champ est unique (pas d'autre occurrence dans la table)
void	_moveFiles()	Déplacement des fichiers associés à l'objet dans le bon répertoire
void	_populateContextRelatedTables()	Implémentation par défaut de _populateContextRelatedTables
void	_populateObject()	Populate the object from the context. Only the public fields are inputted.
void	_publicfields()

[ Top ]

Properties

mixed $_publicfields_array [line 67]

[ Top ]

Methods

Constructor GenericLogic [line 75]

GenericLogic GenericLogic(
string
$classtype 
)

Constructeur de la classe

Définit le nom de la table type pour l'objet ainsi que le nom du champ identifiant unique.

Parameters:

string

$classtype:

le type d'objet generique, parmis : entities, entries et persons.

[ Top ]

addGenericEquivalent [line 426]

void addGenericEquivalent(
string
$class, string
$name, string
$value 
)

Définition de l'équivalent générique permanent.

Cette fonction utilise un cache statique (tableau global). Elle définit l'équivalent générique suivant la classe et le nom de l'objet.

Info :These functions simulate a static cache by using a global array PHP5 would solve the problem

Parameters:

string	$class:	le nom de la classe de l'objet.
string	$name:	le nom du champ.
string	$value:	la valeur associée au champ.

API Tags:

Access:

private

[ Top ]

getGenericEquivalent [line 438]

void getGenericEquivalent(
string
$class, string
$name 
)

Retourne un équivalent générique pour une classe et un champ donné

Parameters:

string	$class:	le nom de la classe de l'objet.
string	$name:	le nom du champ.

API Tags:

Access:

private

[ Top ]

validateFields [line 195]

void validateFields(

&$context, 
&$error, array
$context, array
$error 
)

Validated the public fields and the unicity as usual and in addition the typescompatibility

Validation des champs publics et de l'unicité comme dans la fonction de logic.php. Mais vérifie la compatibilité des types d'objet en plus.

Parameters:

array	$context:	le tableau des données passé par référence.
array	$error:	le tableau des erreurs rencontrées passé par référence.
	&$context:
	&$error:

Redefinition of:

Logic::validateFields(): Validated the public fields and the unicity.

[ Top ]

viewAction [line 104]

string viewAction(

&$context, 
&$error, array
$context, array
$error 
)

Implémentation pour les objets générique de l'action permettant d'appeler l'affichage d'un objet.

Cette fonction récupère les données de l'objet <em>via</em> la DAO de l'objet. Ensuite elle met ces données dans le context (utilisation de la fonction privée _populateContext())

view an object Action

Parameters:

array	$context:	le tableau des données passé par référence.
array	$error:	le tableau des erreurs rencontrées passé par référence.
	&$context:
	&$error:

API Tags:

Return:

les différentes valeurs possibles de retour d'une action (_ok, _back, _error ou xxxx).

Redefinition of:

Logic::viewAction(): Implémentation par défaut de l'action permettant d'appeler l'affichage d'un objet.

Redefined in descendants as:

Entities_EditionLogic::viewAction() : Affichage d'un objet
EntriesLogic::viewAction() : Affichage d'un objet (index ET persons)

[ Top ]

_is_unique [line 460]

bool _is_unique(
string
$class, string
$name, string
$value, 
$id 
)

Vérifie que la valeur d'un champ est unique (pas d'autre occurrence dans la table)

Parameters:

string	$class:	le nom de la classe de l'objet.
string	$name:	le nom du champ.
string	$value:	la valeur associée au champ.
	$id:

API Tags:

Return:	true si pas d'autre occurrence, false sinon
Access:	private

[ Top ]

_moveFiles [line 390]

void _moveFiles(
integer
$id, array
$files_to_move, object
&$vo 
)

Déplacement des fichiers associés à l'objet dans le bon répertoire

Parameters:

integer	$id:	l'identifiant numérique de l'objet
array	$files_to_move:	un tableau contenant les informations de tous les fichiers (nom et type)
object	&$vo:	l'objet virtuel correspondant à l'objet passé par référence

API Tags:

Access:

private

[ Top ]

_populateContextRelatedTables [line 448]

void _populateContextRelatedTables(

$vo, 
$context 
)

Implémentation par défaut de _populateContextRelatedTables

Parameters:

	$vo:
	$context:

API Tags:

Access:

private

Redefinition of:

Logic::_populateContextRelatedTables(): Used in viewAction to do extra populate in the context

Redefined in descendants as:

Entities_EditionLogic::_populateContextRelatedTables() : Utilisé dans la méthode viewAction() pour remplir le contexte d'information supplémentaire

[ Top ]

_populateObject [line 477]

void _populateObject(
object
&$vo, array
&$context 
)

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

GenericLogic can deal with related table by detecting the class of $vo

Parameters:

object	&$vo:	L'objet virtuel à remplir.
array	&$context:	Le tableau contenant les données.

API Tags:

Access:

private

Redefinition of:

Logic::_populateObject(): Populate the object from the context. Only the public fields are inputted.

[ Top ]

_publicfields [line 492]

void _publicfields(
)

API Tags:

Access:

private

Redefinition of:

Logic::_publicfields()

[ Top ]

Documentation generated on Thu, 19 Jun 2008 05:07:50 +0200 by phpDocumentor 1.4.0a2

	lodel

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