Chill-project/chill-bundles
6
0
Fork 0
mirror of https://gitlab.com/Chill-Projet/chill-bundles.git synced 2025-06-13 05:44:24 +00:00
Code Issues Actions Projects Releases Wiki Activity

Refactoring Entity/Person.php : better documentation

Browse Source
This commit is contained in:
Marc Ducobu 2015-08-11 15:44:48 +02:00
parent 03059c669b
commit 02193505be
1 changed files with 28 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

87
Entity/Person.php
View File

@ -31,93 +31,63 @@ use Chill\MainBundle\Entity\HasCenterInterface;
* Person * Person
*/ */
class Person implements HasCenterInterface { class Person implements HasCenterInterface {
/** /** @var integer The person's id */
* @var integer
*/
private $id; private $id;
/** /** @var string The person's first name */
* @var string
*/
private $firstName; private $firstName;
/** /** @var string The person's last name */
* @var string
*/
private $lastName; private $lastName;
/** /** @var \DateTime The person's birthdate */
* @var \DateTime private $dateOfBirth; //to change in birthdate
*/
private $dateOfBirth;
/** /** @var string The person's place of birth */
* @var string
*/
private $placeOfBirth = ''; private $placeOfBirth = '';
/** @var \CL\Chill\MainBundle\Entity\Country The person's country of birth */
private $countryOfBirth;
/** /** @var \CL\Chill\MainBundle\Entity\Country The person's nationality */
* @var string private $nationality;
*/
private $genre; /** @var string The person's gender */
private $genre; //to change in gender
/** const GENRE_MAN = 'man';
*
* @var \Chill\MainBundle\Entity\Center
*/
private $center;
const GENRE_MAN = 'man';
const GENRE_WOMAN = 'woman'; const GENRE_WOMAN = 'woman';
/** @var \Chill\MainBundle\Entity\Center The person's center */
private $center;
/** /** @var string A remark over the person */
* @var string private $memo = ''; // to change in remark
*/
private $memo = '';
/** /** @var string The person's email */
* @var string
*/
private $email = ''; private $email = '';
/** /**
* @var \CL\Chill\MainBundle\Entity\Country * @var \Doctrine\Common\Collections\ArrayCollection The person's
*/ * accompanying periods (when the person was accompanied by the center)*/
private $countryOfBirth;
/**
* @var \CL\Chill\MainBundle\Entity\Country
*/
private $nationality;
/**
*
* @var \Doctrine\Common\Collections\ArrayCollection
*/
private $accompanyingPeriods; private $accompanyingPeriods;
/** /**
*
* @var boolean * @var boolean
*/ */
private $proxyAccompanyingPeriodOpenState = false; private $proxyAccompanyingPeriodOpenState = false;
/** /** @var array Array where customfield's data are stored */
* The array where customfields data is stored
* @var array
*/
private $cFData; private $cFData;
/** /** @var string The person's phonenumber */
* @var string
*/
private $phonenumber = ''; private $phonenumber = '';
/** /**
* The spoken languages (ArrayCollection of Languages) * @var \Doctrine\Common\Collections\ArrayCollection The person's spoken
* @var \Doctrine\Common\Collections\ArrayCollection * languages (ArrayCollection of Languages)
*/ */
private $spokenLanguages; private $spokenLanguages;
public function __construct(\DateTime $opening = null) { public function __construct(\DateTime $opening = null) {
@ -132,7 +102,6 @@ class Person implements HasCenterInterface {
} }
/** /**
*
* @param \Chill\PersonBundle\Entity\AccompanyingPeriod $accompanyingPeriod * @param \Chill\PersonBundle\Entity\AccompanyingPeriod $accompanyingPeriod
* @uses AccompanyingPeriod::setPerson * @uses AccompanyingPeriod::setPerson
*/ */