Alias
-
/** * @alias city */ public $name;
Défini un alias au nom de la propriété, destiné à l’affichage dans les sous-formulaires.
Dans cet exemple :- Le nom de la propriété affiché sera
name
dans les vues dont le contexte est la classe de la propriété (listes, formulaires, etc.) - Si la propriété est présente dans un sous-formulaire de collection, map ou intégré par l’annotation @integrated, l’alias
city
sera affiché à la place.
Exemple d’utilisation
L’intérêt est d’éviter la confusion d’un nom de champ avec le nom de champ parent, principalement dans les formulaires intégrés par l’annotation @integrated .
Exemple d’une application carnet d’adresse (extrait de l’ERP B-APPLI) :
class Address { /** * @integrated * @link Object * @var City */ public $city; /** * @var string */ public $name; } class City { /** * @alias city * @var string */ public $name; }
Dans le contexte d’une classe ville
City
, considérer la propriété ‘nom de la ville’$name
est le plus simple. toutefois dans la classeAddress
qui est elle-même identifiée par un$name
, si l’on intègre le sous-formulaire pour permettre la saisie du nom de la ville avec l’annotation @integrated, le formulaire sera moins compréhensible pour l’utilisateur car proposera deux champs de saisienom
.En ajoutant l’annotation @alias city, le formulaire de l’adresse affichera
ville
pour demander la saisie du nom de la fille, différenciant ainsi ce champ dunom
de l’adresse. - Le nom de la propriété affiché sera