Docs For Class Logic

Methods

Constructor Logic [line 96]

Logic Logic(
string
$maintable 
)

Constructeur de la classe.

Positionne simplement le nom de la table principale.

Parameters:

string

$maintable:

le nom de la table principale.

[ Top ]

changeRankAction [line 218]

string changeRankAction(

&$context, 
&$error, [string
$groupfields = ""], [string
$status = "status>0"], array
$context, array
$error 
)

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

Cette action modifie la rang (rank) d'un objet. Peut-être restreinte à un status particulier et à un étage particulier (groupe).

Change rank action Default implementation

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.
string	$groupfields:	champ de groupe. Utilisé pour limité le changement de rang à un étage. Par défaut vide.
string	$status:	utilisé pour changer le rang d'objets ayant un status particulier. il s'agit d'une condition. Par défaut est : status>0
	&$context:
	&$error:

API Tags:

Return:

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

Redefined in descendants as:

TasksLogic::changeRankAction() : Changement du rang d'un objet
OptiongroupsLogic::changeRankAction() : Changement du rang d'un objet
TypesLogic::changeRankAction() : Changement du rang d'un objet
TableFieldsLogic::changeRankAction() : Changement du rang d'un objet
UserOptionGroupsLogic::changeRankAction() : Changement du rang d'un objet
EntitiesLogic::changeRankAction() : Changement du rang d'un objet
TablefieldgroupsLogic::changeRankAction() : Changement du rang d'un objet
OptionsLogic::changeRankAction() : Changement du rang d'un objet
EntriesLogic::changeRankAction() : Changement du rang d'un objet (index seulement)

[ Top ]

copyAction [line 140]

string copyAction(

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

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

Récupère l'objet que l'on veut créer et le copie en ajoutant un prefixe devant.

copy 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).

Redefined in descendants as:

UserOptionGroupsLogic::copyAction() : Change rank action

[ Top ]

deleteAction [line 249]

string deleteAction(

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

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

Cette action vérifie tout d'abord que l'objet peut-être supprimé puis prépare la suppression (fonction _prepareDelete()) et enfin utilise la DAO pour supprimer l'objet

Delete Default implementation

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

Redefined in descendants as:

OptiongroupsLogic::deleteAction() : Suppression d'un objet
UserOptionGroupsLogic::deleteAction() : Delete
EntitiesLogic::deleteAction() : Suppression d'un objet
OptionsLogic::deleteAction() : Suppression d'un objet

[ Top ]

editAction [line 172]

string editAction(

&$context, 
&$error, [boolean
$clean = false], array
$context, array
$error 
)

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

Cette fonction crée un nouvel objet ou édite un objet existant. Dans un premier temps les données sont validées (suivant leur type) puis elles sont rentrées dans la base de données <em>via</em> la DAO associée à l'objet. Utilise _prepareEdit() pour effectuer des opérations de préparation avant l'édition de l'objet puis _populateContext() pour ajouter des informations supplémentaires au context. Et enfin _saveRelatedTables() pour sauver d'éventuelles informations dans des tables liées.

add/edit 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.
boolean	$clean:	false si on ne doit pas nettoyer les données (par défaut à false).
	&$context:
	&$error:

API Tags:

Return:

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

Redefined in descendants as:

TasksLogic::editAction() : add/edit Action
OptiongroupsLogic::editAction() : Ajout d'un nouvel objet ou Edition d'un objet existant
TableFieldsLogic::editAction() : Ajout d'un nouvel objet ou Edition d'un objet existant
IndexTableFieldsLogic::editAction() : edit/add an object Action
ClassesLogic::editAction() : Implémenation de l'action d'ajout ou d'édition d'un objet.
TextsLogic::editAction() : add/edit Action
UserOptionGroupsLogic::editAction()
ServOOConfLogic::editAction() : add/edit Action
EntitiesLogic::editAction() : Ajout d'un nouvel objet ou Edition d'un objet existant
OptionsLogic::editAction() : Ajout d'un nouvel objet ou Edition d'un objet existant
TranslationsLogic::editAction() : add/edit Action
Entities_EditionLogic::editAction() : Ajout d'un nouvel objet ou Edition d'un objet existant
EntriesLogic::editAction() : Ajout d'un nouvel objet ou Edition d'un objet existant (index seulement)
PersonsLogic::editAction() : Ajout d'un nouvel objet ou Edition d'un objet existant

[ Top ]

isdeletelocked [line 294]

boolean isdeletelocked(
integer
$id, [integer
$status = 0] 
)

Implémentation par défaut de isdeletelocked()

Indique si un objet donné est supprimable pour l'utilisateur courant.

Say whether an object (given by its id and status if possible) is deletable by the current user or not

Parameters:

integer	$id:	l'identifiant numérique de l'objet
integer	$status:	status de l'objet. Par défaut vaut 0.

API Tags:

Return:

un booléen indiquant si l'objet peut être supprimé.

Redefined in descendants as:

Restricted_UsersLogic::isdeletelocked() : Indique si un objet est protégé en suppression
TasksLogic::isdeletelocked() : Indique si un objet est protégé en suppression
OptiongroupsLogic::isdeletelocked() : Indique si un objet est protégé en suppression
TypesLogic::isdeletelocked() : Indique si un objet est protégé en suppression
ClassesLogic::isdeletelocked() : Indique si un objet est protégé en suppression
PersonTypesLogic::isdeletelocked() : Indique si un objet est protégé en suppression
TablefieldgroupsLogic::isdeletelocked() : Indique si un objet est protégé en suppression
EntryTypesLogic::isdeletelocked() : Indique si un objet est protégé en suppression
UsersLogic::isdeletelocked() : Indique si un objet est protégé en suppression
EntriesLogic::isdeletelocked() : Indique si un objet est protégé en suppression (index ET persons)

[ Top ]

rights [line 278]

integer rights(
string
$access 
)

Implémentation par défaut de la fonction right

Cette fonction permet de retourner les droits pour un niveau d'accès particulier

Return the right for a given kind of access

Parameters:

string

$access:

le niveau d'accès

API Tags:

Return:

entier représentant le droit pour l'accès demandé.

[ Top ]

validateFields [line 366]

return validateFields(

&$context, 
&$error 
)

Validated the public fields and the unicity.

Parameters:

	&$context:
	&$error:

API Tags:

Return:	an array containing the error and warning, null otherwise.
Access:	private

Redefined in descendants as:

Restricted_UsersLogic::validateFields()
UsersLogic::validateFields()
GenericLogic::validateFields() : Validated the public fields and the unicity as usual and in addition the typescompatibility

[ Top ]

viewAction [line 113]

string viewAction(

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

Implémentation par défaut 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).

Redefined in descendants as:

TasksLogic::viewAction() : Affichage d'un objet
TypesLogic::viewAction() : Affichage d'un objet
Entities_AdvancedLogic::viewAction() : Affichage d'un objet
TableFieldsLogic::viewAction() : Affichage d'un objet
UserOptionGroupsLogic::viewAction() : Affichage d'un objet
ServOOConfLogic::viewAction() : view Action
EntitiesLogic::viewAction() : Affichage d'un objet
GenericLogic::viewAction() : Implémentation pour les objets générique de l'action permettant d'appeler l'affichage d'un objet.
Entities_EditionLogic::viewAction() : Affichage d'un objet
EntriesLogic::viewAction() : Affichage d'un objet (index ET persons)

[ Top ]

_calculateHistoryField [line 533]

void _calculateHistoryField(

&$value, 
&$context, [
$status = 0], string
$value, array
$context 
)

special processing for particular types of field

Parameters:

string	$value:	the current value of the field
array	$context:	the current context
	&$value:
	&$context:
	$status:

API Tags:

Access:

private

[ Top ]

_changeRank [line 325]

void _changeRank(

$id, 
$dir, 
$criteria 
)

Change the rank of an Object

Parameters:

	$id:
	$dir:
	$criteria:

API Tags:

Access:

private

[ Top ]

_deleteRelatedTables [line 487]

void _deleteRelatedTables(

$id 
)

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

Parameters:

$id:

API Tags:

Access:

private

Redefined in descendants as:

Restricted_UsersLogic::_deleteRelatedTables()
TypesLogic::_deleteRelatedTables()
TableFieldsLogic::_deleteRelatedTables() : Suppression dans les tables liées
IndexTableFieldsLogic::_deleteRelatedTables()
ClassesLogic::_deleteRelatedTables() : Suppression éventuelle dans des tables liées
TextsLogic::_deleteRelatedTables()
PersonTypesLogic::_deleteRelatedTables()
EntryTypesLogic::_deleteRelatedTables()
OptionsLogic::_deleteRelatedTables() : Suppression dans les tables liées
UsersLogic::_deleteRelatedTables()
TranslationsLogic::_deleteRelatedTables()
EntriesLogic::_deleteRelatedTables() : Used in deleteAction to do extra operation after the object has been deleted (index ET persons)

[ Top ]

_getMainTableDAO [line 316]

void &_getMainTableDAO(
)

API Tags:

Access:

private

[ Top ]

_isAuthorizedStatus [line 580]

bool _isAuthorizedStatus(
int
$status 
)

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

Parameters:

int

$status:

la valeur du statut à insérer dans la base

API Tags:

Return:	true si le paramètre $status correspond à une valeur autorisée, sinon déclenche une erreur php
Access:	private

[ Top ]

_populateContext [line 454]

void _populateContext(

&$vo, 
&$context 
)

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

Parameters:

	&$vo:
	&$context:

API Tags:

Access:

private

Redefined in descendants as:

TableFieldsLogic::_populateContext() : Special treatment for allowedtags, from/to the context

[ Top ]

_populateContextRelatedTables [line 492]

void _populateContextRelatedTables(

&$vo, 
&$context 
)

Used in viewAction to do extra populate in the context

Parameters:

	&$vo:
	&$context:

API Tags:

Access:

private

Redefined in descendants as:

Restricted_UsersLogic::_populateContextRelatedTables()
UsersLogic::_populateContextRelatedTables()
GenericLogic::_populateContextRelatedTables() : Implémentation par défaut de _populateContextRelatedTables
Entities_EditionLogic::_populateContextRelatedTables() : Utilisé dans la méthode viewAction() pour remplir le contexte d'information supplémentaire

[ Top ]

_populateObject [line 442]

void _populateObject(

&$vo, 
&$context 
)

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

Parameters:

	&$vo:
	&$context:

API Tags:

Access:

private

Information Tags:

Private:

Redefined in descendants as:

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

[ Top ]

_prepareDelete [line 477]

void _prepareDelete(

$dao, 
&$context 
)

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

Usually it gather information used after in _deleteRelatedTables

Parameters:

	$dao:
	&$context:

API Tags:

Access:

private

Redefined in descendants as:

TableFieldsLogic::_prepareDelete() : Appelé avant l'action delete
IndexTableFieldsLogic::_prepareDelete() : Appelé avant l'action delete
ClassesLogic::_prepareDelete() : Appelé avant l'action delete
PersonTypesLogic::_prepareDelete() : Appelé avant l'action delete
EntryTypesLogic::_prepareDelete() : Appelé avant l'action delete
EntriesLogic::_prepareDelete() : Appelé avant l'action delete (index ET persons)

[ Top ]

_prepareEdit [line 471]

void _prepareEdit(

$dao, 
&$context 
)

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

Usually it gather information used after in _saveRelatedTables

Parameters:

	$dao:
	&$context:

API Tags:

Access:

private

Redefined in descendants as:

Restricted_UsersLogic::_prepareEdit() : Préparation de l'action Edit
OptiongroupsLogic::_prepareEdit() : Préparation de l'action Edit
TableFieldsLogic::_prepareEdit() : Préparation de l'action Edit
IndexTableFieldsLogic::_prepareEdit() : Préparation de l'action Edit
ClassesLogic::_prepareEdit() : Préparation de l'action Edit
PersonTypesLogic::_prepareEdit() : Préparation de l'action Edit
EntryTypesLogic::_prepareEdit() : Préparation de l'action Edit
UsersLogic::_prepareEdit() : Préparation de l'action Edit

[ Top ]

_processSpecialFields [line 500]

void _processSpecialFields(
string
$type, array
$context, [int
$status = 0] 
)

process of particular type of fields

Parameters:

string	$type:	the type of the field
array	$context:	the context
int	$status:	the status; by default 0 if no status changed

API Tags:

Access:

private

[ Top ]

_publicfields [line 427]

void _publicfields(
)

API Tags:

Access:

private

Redefined in descendants as:

Restricted_UsersLogic::_publicfields() : Retourne la liste des champs publics
CharacterstylesLogic::_publicfields() : Retourne la liste des champs publics
TasksLogic::_publicfields() : Retourne la liste des champs publics
OptiongroupsLogic::_publicfields() : Retourne la liste des champs publics
InternalstylesLogic::_publicfields() : Retourne la liste des champs publics
TypesLogic::_publicfields() : Retourne la liste des champs publics
Entities_AdvancedLogic::_publicfields()
TableFieldsLogic::_publicfields() : Retourne la liste des champs publics
IndexTableFieldsLogic::_publicfields() : Retourne la liste des champs publics
ClassesLogic::_publicfields() : Retourne la liste des champs publics
TextsLogic::_publicfields() : Retourne la liste des champs publics
SitesLogic::_publicfields() : Retourne la liste des champs publics
PersonTypesLogic::_publicfields() : Retourne la liste des champs publics
ServOOConfLogic::_publicfields()
EntitiesLogic::_publicfields() : Retourne la liste des champs publics
TablefieldgroupsLogic::_publicfields() : Retourne la liste des champs publics
EntryTypesLogic::_publicfields() : Retourne la liste des champs publics
OptionsLogic::_publicfields() : Retourne la liste des champs publics
UsersLogic::_publicfields() : Retourne la liste des champs publics
TranslationsLogic::_publicfields() : Retourne la liste des champs publics
GenericLogic::_publicfields()

[ Top ]

_saveRelatedTables [line 482]

void _saveRelatedTables(

$vo, 
&$context 
)

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

Parameters:

	$vo:
	&$context:

API Tags:

Access:

private

Redefined in descendants as:

Restricted_UsersLogic::_saveRelatedTables() : Sauve des données dans des tables liées éventuellement
OptiongroupsLogic::_saveRelatedTables() : Sauve des données dans des tables liées éventuellement
TypesLogic::_saveRelatedTables() : Sauve des données dans des tables liées éventuellement
TableFieldsLogic::_saveRelatedTables() : Sauve des données dans des tables liées éventuellement
IndexTableFieldsLogic::_saveRelatedTables() : Sauve des données dans des tables liées éventuellement
ClassesLogic::_saveRelatedTables() : Sauve des données dans des tables liées éventuellement
TextsLogic::_saveRelatedTables() : Sauve des données dans des tables liées éventuellement
PersonTypesLogic::_saveRelatedTables() : Sauve des données dans des tables liées éventuellement
EntryTypesLogic::_saveRelatedTables() : Sauve des données dans des tables liées éventuellement
OptionsLogic::_saveRelatedTables() : Sauve des données dans des tables liées éventuellement
UsersLogic::_saveRelatedTables() : Sauve des données dans des tables liées éventuellement
TranslationsLogic::_saveRelatedTables() : Sauve des données dans des tables liées éventuellement
Entities_EditionLogic::_saveRelatedTables() : Sauve des données dans des tables liées éventuellement

[ Top ]

_uniqueFields [line 433]

void _uniqueFields(
)

API Tags:

Access:

private

Redefined in descendants as:

Restricted_UsersLogic::_uniqueFields() : Retourne la liste des champs uniques
CharacterstylesLogic::_uniqueFields() : Retourne la liste des champs uniques
OptiongroupsLogic::_uniqueFields() : Retourne la liste des champs uniques
InternalstylesLogic::_uniqueFields() : Retourne la liste des champs uniques
TypesLogic::_uniqueFields() : Retourne la liste des champs uniques
TableFieldsLogic::_uniqueFields() : Retourne la liste des champs uniques
IndexTableFieldsLogic::_uniqueFields() : Retourne la liste des champs uniques
ClassesLogic::_uniqueFields() : Retourne la liste des champs uniques
TextsLogic::_uniqueFields()
PersonTypesLogic::_uniqueFields() : Retourne la liste des champs uniques
ServOOConfLogic::_uniqueFields()
TablefieldgroupsLogic::_uniqueFields() : Retourne la liste des champs uniques
EntryTypesLogic::_uniqueFields() : Retourne la liste des champs uniques
OptionsLogic::_uniqueFields() : Retourne la liste des champs uniques
UsersLogic::_uniqueFields() : Retourne la liste des champs uniques
TranslationsLogic::_uniqueFields() : Retourne la liste des champs uniques

[ Top ]

	lodel

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

Class: Logic

Class Logic