Wiki - 1 output

/**
 * @representative property_name_1, property_name_2, etc.
 */
class A_Class

Cette annotation permet de déclarer la liste des propriétés ou chemins de propriétés qui contiendront les valeurs permettant à l’utilisateur d’identifier l’objet, de le différentier des autres objets de la même classe.

- Valeur par défaut : à défaut de déclaration, toutes les propriétés de la classe non-statiques et qui ne représentent pas un tableau seront considérées comme représentatives.
- On retrouve en principe dans @representative toutes les propriétés servant à générer la représentation textuelle de l’objet dans la méthode __toString().
- Il est conseillé de déclarer cette annotation dès lors qu’un affichage résumé, sous chaîne de caractère, est possible pour votre objet.
- Notamment toutes les classes @business devraient avoir une déclaration @representative.

Effets

- En l’absence d’ordre de tri défini par @sort, Le tri par défaut d’objets par Dao::sort() s’effectue dans l’ordre successif des propriétés @representative.
- Dans les listes, en l’absence propriétés définies pour les colonnes par @list, les propriétés @representative constitueront les colonnes affichées par défaut.
- Dans les zones de recherche des listes, lorsque l’utilisateur effectue une recherche sur une propriété de type objet, la recherche en base de données sera effectuée sur les valeurs stockées des propriétés @representative.
- Pendant l’import, les propriétés @representative sont considérées comme identifiant l’objet, pour savoir quel objet doit être mis à jour ou ajouté.
- Lors de la construction de requêtes SQL pour la lecture depuis la base de données, @representative sera utilisé pour retourner la représentation sous forme de texte d’un sous-objet.
- Pour les propriétés de classe abstraite, la vue SQL construite retient les valeurs concaténées des propriétés @representative comme l’affichage de valeur commune de l’ensemble des objets de classes différentes qui en résultera. La valeur sera visible dans le champs de la vue nommé representative.