deal with opening/closing the files

This commit is contained in:
2013-11-26 23:00:30 +01:00
parent e390c891d8
commit 377a69d26f
20 changed files with 1262 additions and 22 deletions

View File

@@ -3,6 +3,7 @@
namespace CL\Chill\PersonBundle\Entity;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Validator\ExecutionContextInterface;
/**
* Person
@@ -87,14 +88,168 @@ ou une valeur vide lorsque la donnée nest pas connue*/
private $email = '';
/**
* @var \Doctrine\Common\Collections\Collection
* @var \CL\Chill\MainBundle\Entity\Country
*/
private $countryOfBirth;
/**
* @var \Doctrine\Common\Collections\Collection
* @var \CL\Chill\MainBundle\Entity\Country
*/
private $nationality;
private $nationality;
/**
*
* @var \Doctrine\Common\Collections\ArrayCollection
*/
private $history;
/**
*
* @var boolean
*/
private $proxyHistoryOpenState = false;
public function __construct(\DateTime $opening = null) {
$this->history = new \Doctrine\Common\Collections\ArrayCollection();
if ($opening === null) {
$opening = new \DateTime();
}
$this->open($opening);
}
/**
*
* @param \CL\Chill\PersonBundle\Entity\PersonHistoryFile $history
* @uses PersonHistoryFile::setPerson
*/
public function addHistoryFile(PersonHistoryFile $history) {
$history->setPerson($this);
$this->history->add($history);
}
/**
* set the Person file as open at the given date.
*
* For updating a opening's date, you should update PersonHistoryFile instance
* directly.
*
* For closing a file, @see this::close
*
* To check if the Person and his history is consistent, use validation.
*
* @param \DateTime $date
*/
public function open(\DateTime $date, $memo = '') {
$history = new PersonHistoryFile($date);
$history->setMemo($memo);
$this->proxyHistoryOpenState = true;
$this->addHistoryFile($history);
}
/**
*
* Set the Person file as closed at the given date.
*
* For update a closing date, you should update PersonHistoryFile instance
* directly.
*
* To check if the Person and his history are consistent, use validation.
*
* @param \DateTime $date
* @param string $motive
* @param string $memo
* @throws \Exception if two lines of history are open.
*/
public function close(\DateTime $date, $motive, $memo = '') {
$histories = $this->history;
$found = false;
foreach ($histories as $history) {
if ($history->isOpen()) {
if ($found === true) {
throw new \Exception('two open line in history were found. This should not happen.');
}
$history->setDateClosing($date);
$history->setMotive($motive);
$history->setMemo($memo);
$this->proxyHistoryOpenState = false;
$found = true;
}
}
}
/**
*
* @return null|PersonHistoryFile
*/
public function getCurrentHistory() {
if ($this->proxyHistoryOpenState === false) {
return null;
}
foreach ($this->history as $history) {
if ($history->isOpen()) {
return $history;
}
}
}
/**
*
* @return \Doctrine\Common\Collections\ArrayCollection
*/
public function getHistories() {
return $this->history;
}
/**
*
* @return PersonHistoryFile[]
*/
public function getHistoriesOrdered() {
$histories = $this->getHistories()->toArray();
//order by date :
usort($histories, function($a, $b) {
$dateA = $a->getDateOpening();
$dateB = $b->getDateOpening();
if ($dateA == $dateB) {
$dateEA = $a->getDateClosing();
$dateEB = $b->getDateClosing();
if ($dateEA == $dateEB) {
return 0;
}
if ($dateEA < $dateEB) {
return -1;
} else {
return +1;
}
}
if ($dateA < $dateB) {
return -1 ;
} else {
return 1;
}
});
return $histories;
}
public function isOpen() {
return $this->proxyHistoryOpenState;
}
/**
* Get id
@@ -433,4 +588,110 @@ ou une valeur vide lorsque la donnée nest pas connue*/
public function __toString() {
return $this->getLabel();
}
// VALIDATION
public function isHistoryValid(ExecutionContextInterface $context) {
$r = $this->checkHistoryIsNotCovering();
if ($r !== true) {
if ($r['result'] === self::ERROR_OPENING_NOT_CLOSED_IS_BEFORE_NEW_LINE) {
$context->addViolationAt('history',
'validation.Person.constraint.history.open_history_without_closing',
array() );
return;
}
$context->addViolationAt('history',
'validation.Person.constraint.history.opening_is_before_closing',
array(
'%dateOpening%' => $r['dateOpening']->format('d-m-Y'),
'%dateClosing%' => $r['dateClosing']->format('d-m-Y'),
'%date%' => $r['date']->format('d-m-Y')
)
);
}
}
const ERROR_OPENING_IS_INSIDE_CLOSING = 1;
const ERROR_OPENING_NOT_CLOSED_IS_BEFORE_NEW_LINE = 2;
const ERROR_OPENING_NOT_CLOSE_IS_INSIDE_CLOSED_HISTORY_LINE = 3;
public function checkHistoryIsNotCovering() {
$histories = $this->getHistoriesOrdered();
//check order :
$oldOpening = array();
$oldClosing = array();
$i = 0;
foreach ($histories as $key => $history) {
//history is open : we must check the arent any history after
if ($history->isOpen()) {
foreach ($histories as $subKey => $against) {
//if we are checking the same, continue
if ($key === $subKey) {
continue;
}
if ($history->getDateOpening() > $against->getDateOpening()
&& $history->getDateOpening() < $against->getDateOpening()) {
// the history date opening is inside another opening line
return array(
'result' => self::ERROR_OPENING_NOT_CLOSE_IS_INSIDE_CLOSED_HISTORY_LINE,
'dateOpening' => $against->getDateOpening(),
'dateClosing' => $against->getDateClosing(),
'date' => $history->getDateOpening()
);
}
//if we have an aopening later...
if ($history->getDateOpening() < $against->getDateClosing()) {
return array( 'result' => self::ERROR_OPENING_NOT_CLOSED_IS_BEFORE_NEW_LINE,
'dateOpening' => $against->getDateOpening(),
'dateClosing' => $against->getDateClosing(),
'date' => $history->getDateOpening()
);
}
}
} else {
//we must check there is not covering lines
foreach ($histories as $subKey => $against) {
//check if dateOpening is inside an `against` line
if ($history->getDateOpening() > $against->getDateOpening()
&& $history->getDateOpening() < $against->getDateClosing()) {
return array(
'result' => self::ERROR_OPENING_IS_INSIDE_CLOSING,
'dateOpening' => $against->getDateOpening(),
'dateClosing' => $against->getDateClosing(),
'date' => $history->getDateOpening()
);
}
}
}
}
return true;
}
}

View File

@@ -0,0 +1,231 @@
<?php
namespace CL\Chill\PersonBundle\Entity;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Validator\ExecutionContextInterface;
/**
* PersonHistoryFile
*/
class PersonHistoryFile
{
/**
* @var integer
*/
private $id;
/**
* @var \DateTime
*/
private $date_opening;
/**
* @var \DateTime
*/
private $date_closing;
/**
* @var string
*/
private $motive = '';
/**
* @var string
*/
private $memo = '';
/**
* @var \CL\Chill\PersonBundle\Entity\Person
*/
private $person;
/**
*
* @param \DateTime $dateOpening
* @uses PersonHistoryFile::setDateClosing()
*/
public function __construct(\DateTime $dateOpening) {
$this->setDateOpening($dateOpening);
}
/**
* Get id
*
* @return integer
*/
public function getId()
{
return $this->id;
}
/**
* Set date_opening
*
* @param \DateTime $dateOpening
* @return PersonHistoryFile
*/
public function setDateOpening($dateOpening)
{
$this->date_opening = $dateOpening;
return $this;
}
/**
* Get date_opening
*
* @return \DateTime
*/
public function getDateOpening()
{
return $this->date_opening;
}
/**
* Set date_closing
*
* For closing a Person file, you should use Person::setClosed instead.
*
* @param \DateTime $dateClosing
* @return PersonHistoryFile
*
*/
public function setDateClosing($dateClosing)
{
$this->date_closing = $dateClosing;
return $this;
}
/**
* Get date_closing
*
* @return \DateTime
*/
public function getDateClosing()
{
return $this->date_closing;
}
/**
*
* @return boolean
*/
public function isOpen() {
if ($this->getDateClosing() === null) {
return true;
} else {
return false;
}
}
/**
* Set motive
*
* @param string $motive
* @return PersonHistoryFile
*/
public function setMotive($motive)
{
$this->motive = $motive;
return $this;
}
/**
* Get motive
*
* @return string
*/
public function getMotive()
{
return $this->motive;
}
/**
* Set memo
*
* @param string $memo
* @return PersonHistoryFile
*/
public function setMemo($memo)
{
if ($memo === null) {
$memo = '';
}
$this->memo = $memo;
return $this;
}
/**
* Get memo
*
* @return string
*/
public function getMemo()
{
return $this->memo;
}
/**
* Set person.
*
* For consistency, you should use Person::addHistoryFile instead.
*
* @param \CL\Chill\PersonBundle\Entity\Person $person
* @return PersonHistoryFile
* @see Person::addHistoryFile
*/
public function setPerson(\CL\Chill\PersonBundle\Entity\Person $person = null)
{
$this->person = $person;
return $this;
}
/**
* Get person
*
* @return \CL\Chill\PersonBundle\Entity\Person
*/
public function getPerson()
{
return $this->person;
}
/// VALIDATION function
public function isDateConsistent(ExecutionContextInterface $context) {
if ($this->isOpen()) {
return;
}
if ($this->isClosingAfterOpening() === false) {
$context->addViolationAt('dateClosing',
'validation.PersonHistoryFile.constraint.dateOfClosing_before_dateOfOpening',
array(), null);
}
}
/**
*
* @return boolean
*/
public function isClosingAfterOpening() {
$diff = $this->getDateOpening()->diff($this->getDateClosing());
if ($diff->invert === 0) {
return true;
} else {
return false;
}
}
}