api/src/Solidary/Entity/SolidaryAsk.php
<?php
/**
* Copyright (c) 2018, MOBICOOP. All rights reserved.
* This project is dual licensed under AGPL and proprietary licence.
***************************
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <gnu.org/licenses>.
***************************
* Licence MOBICOOP described in the file
* LICENSE
**************************/
namespace App\Solidary\Entity;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use Doctrine\ORM\Events;
use ApiPlatform\Core\Annotation\ApiResource;
use ApiPlatform\Core\Annotation\ApiSubresource;
use App\Carpool\Entity\Ask;
use App\Carpool\Entity\Criteria;
use Symfony\Component\Serializer\Annotation\MaxDepth;
use Symfony\Component\Serializer\Annotation\Groups;
use Symfony\Component\Validator\Constraints as Assert;
/**
* A Solidary Ask
*
* @ORM\Entity
* @ORM\HasLifecycleCallbacks
* @ApiResource(
* attributes={
* "force_eager"=false,
* "normalization_context"={"groups"={"readSolidary"}, "enable_max_depth"="true"},
* "denormalization_context"={"groups"={"writeSolidary"}}
* },
* collectionOperations={
* "get"={
* "security"="is_granted('reject',object)",
* "swagger_context" = {
* "tags"={"Solidary"}
* }
* }
* },
* itemOperations={
* "get"={
* "security"="is_granted('reject',object)",
* "swagger_context" = {
* "tags"={"Solidary"}
* }
* }
* }
* )
* @author Maxime Bardot <maxime.bardot@mobicoop.org>
*/
class SolidaryAsk
{
const STATUS_ASKED = 0;
const STATUS_REFUSED = 1;
const STATUS_PENDING = 2;
const STATUS_LOOKING_FOR_SOLUTION = 3;
const STATUS_FOLLOW_UP = 4;
const STATUS_CLOSED = 5;
const STATUS_ACCEPTED = 6;
const DEFAULT_ID = 999999999999;
/**
* @var int The id of this solidary ask.
*
* @ORM\Id
* @ORM\GeneratedValue
* @ORM\Column(type="integer")
* @Groups({"readSolidary"})
*/
private $id;
/**
* @var int Solidary Ask status (1 = initiated; 2 = pending as driver, 3 = pending as passenger, 4 = accepted as driver; 5 = accepted as passenger, 6 = declined as driver, 7 = declined as passenger).
*
* @Assert\NotBlank
* @ORM\Column(type="smallint")
* @Groups({"readSolidary","writeSolidary"})
*/
private $status;
/**
* @var \DateTimeInterface Creation date of the solidary ask.
*
* @ORM\Column(type="datetime")
* @Groups({"readSolidary","writeSolidary"})
*/
private $createdDate;
/**
* @var \DateTimeInterface Updated date of the solidary ask.
*
* @ORM\Column(type="datetime", nullable=true)
* @Groups({"readSolidary","writeSolidary"})
*/
private $updatedDate;
/**
* @var SolidarySolution The solidary solution this Ask is for.
*
* @Assert\NotBlank
* @ORM\OneToOne(targetEntity="\App\Solidary\Entity\SolidarySolution", inversedBy="solidaryAsk")
* @ORM\JoinColumn(nullable=false, onDelete="CASCADE")
* @MaxDepth(1)
* @Groups({"readSolidary","writeSolidary"})
*/
private $solidarySolution;
/**
* @var ArrayCollection The ask history items linked with the ask.
*
* @ORM\OneToMany(targetEntity="\App\Solidary\Entity\SolidaryAskHistory", mappedBy="solidaryAsk", cascade={"persist"})
* @ORM\OrderBy({"id" = "ASC"})
* @Groups({"readSolidary","writeSolidary"})
* @MaxDepth(1)
* ApiSubresource(maxDepth=1)
*/
private $solidaryAskHistories;
/**
* @var string The internal message to sent to the volunteer
* @Groups({"writeSolidary"})
*/
private $message;
/**
* @var string The sms to sent to the volunteer
* @Groups({"writeSolidary"})
*/
private $sms;
/**
* @var Ask|null The Ask possibly linked to this SolidaryAsk
*
* @ORM\OneToOne(targetEntity="\App\Carpool\Entity\Ask", inversedBy="solidaryAsk", cascade={"persist"})
* @ORM\JoinColumn(onDelete="CASCADE")
* @Groups({"readSolidary","writeSolidary"})
*/
private $ask;
/**
* @var Criteria|null Criteria of this SolidaryAsk if the solution is a transport
*
* @ORM\OneToOne(targetEntity="\App\Carpool\Entity\Criteria", inversedBy="solidaryAsk", cascade={"persist"})
* @ORM\JoinColumn(onDelete="CASCADE")
* @Groups({"readSolidary","writeSolidary"})
*/
private $criteria;
/**
* @var SolidaryAsk|null The linked solidary ask for return trips.
*
* @ORM\OneToOne(targetEntity="\App\Solidary\Entity\SolidaryAsk", cascade={"persist"})
* @ORM\JoinColumn(onDelete="CASCADE")
* @MaxDepth(1)
*/
private $solidaryAskLinked;
public function __construct()
{
$this->id = self::DEFAULT_ID;
$this->solidaryAskHistories = new ArrayCollection();
}
public function getId(): ?int
{
return $this->id;
}
public function getStatus(): ?int
{
return $this->status;
}
public function setStatus(int $status): self
{
$this->status = $status;
return $this;
}
public function getCreatedDate(): ?\DateTimeInterface
{
return $this->createdDate;
}
public function setCreatedDate(\DateTimeInterface $createdDate): self
{
$this->createdDate = $createdDate;
return $this;
}
public function getUpdatedDate(): ?\DateTimeInterface
{
return $this->updatedDate;
}
public function setUpdatedDate(\DateTimeInterface $updatedDate): self
{
$this->updatedDate = $updatedDate;
return $this;
}
public function getSolidarySolution(): ?SolidarySolution
{
return $this->solidarySolution;
}
public function setSolidarySolution(SolidarySolution $solidarySolution): self
{
$this->solidarySolution = $solidarySolution;
return $this;
}
public function getSolidaryAskHistories()
{
return $this->solidaryAskHistories->getValues();
}
public function addSolidaryAskHistory(SolidaryAskHistory $solidaryAskHistory): self
{
if (!$this->solidaryAskHistories->contains($solidaryAskHistory)) {
$this->solidaryAskHistories[] = $solidaryAskHistory;
$solidaryAskHistory->setSolidaryAsk($this);
}
return $this;
}
public function removeSolidaryAskHistory(SolidaryAskHistory $solidaryAskHistory): self
{
if ($this->solidaryAskHistories->contains($solidaryAskHistory)) {
$this->solidaryAskHistories->removeElement($solidaryAskHistory);
// set the owning side to null (unless already changed)
if ($solidaryAskHistory->getSolidaryAsk() === $this) {
$solidaryAskHistory->setSolidaryAsk(null);
}
}
return $this;
}
public function getMessage(): ?string
{
return $this->message;
}
public function setMessage(string $message): self
{
$this->message = $message;
return $this;
}
public function getSms(): ?string
{
return $this->sms;
}
public function setSms(string $sms): self
{
$this->sms = $sms;
return $this;
}
public function getAsk(): ?Ask
{
return $this->ask;
}
public function setAsk(Ask $ask): self
{
$this->ask = $ask;
return $this;
}
public function getCriteria(): ?Criteria
{
return $this->criteria;
}
public function setCriteria(Criteria $criteria): self
{
$this->criteria = $criteria;
return $this;
}
public function getSolidaryAskLinked(): ?self
{
return $this->solidaryAskLinked;
}
public function setSolidaryAskLinked(?self $solidaryAskLinked): self
{
$this->solidaryAskLinked = $solidaryAskLinked;
// set (or unset) the owning side of the relation if necessary
$newSolidaryAskLinked = $solidaryAskLinked === null ? null : $this;
if (!is_null($solidaryAskLinked) && $newSolidaryAskLinked !== $solidaryAskLinked->getSolidaryAskLinked()) {
$solidaryAskLinked->setSolidaryAskLinked($newSolidaryAskLinked);
}
return $this;
}
// DOCTRINE EVENTS
/**
* Creation date.
*
* @ORM\PrePersist
*/
public function setAutoCreatedDate()
{
$this->setCreatedDate(new \Datetime());
}
/**
* Update date.
*
* @ORM\PreUpdate
*/
public function setAutoUpdatedDate()
{
$this->setUpdatedDate(new \Datetime());
}
}