api/src/Payment/Ressource/PaymentPeriod.php
<?php
/**
* Copyright (c) 2020, 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\Payment\Ressource;
use ApiPlatform\Core\Annotation\ApiProperty;
use ApiPlatform\Core\Annotation\ApiResource;
use Symfony\Component\Serializer\Annotation\Groups;
use App\Geography\Entity\Address;
/**
* Period containing payments (for regular carpools).
*
* @ApiResource(
* attributes={
* "force_eager"=false,
* "normalization_context"={"groups"={"readPayment"}, "enable_max_depth"="true"}
* },
* collectionOperations={
* "get"={
* "swagger_context" = {
* "tags"={"Payment"}
* }
* }
* },
* itemOperations={
* "get"={
* "security"="is_granted('reject',object)",
* "swagger_context" = {
* "tags"={"Payment"}
* }
* }
* }
* )
* @author Sylvain Briat <sylvain.briat@mobicoop.org>
*/
class PaymentPeriod
{
const DEFAULT_ID = 999999999999;
/**
* @var int The id of this payment period.
* @Groups({"readPayment"})
*
* @ApiProperty(identifier=true)
*/
private $id;
/**
* @var \DateTimeInterface|null The start date of the period.
* @Groups({"readPayment"})
*
* @ApiProperty(
* attributes={
* "swagger_context"={"type"="string", "format"="date"}
* }
* )
*/
private $fromDate;
/**
* @var \DateTimeInterface|null The end date of the period.
* @Groups({"readPayment"})
*
* @ApiProperty(
* attributes={
* "swagger_context"={"type"="string", "format"="date"}
* }
* )
*/
private $toDate;
/**
* @var array|null The week days where there are carpooling planned.
* The array contains the representation of the week day, from 0 (sunday) to 6 (saturday).
*
* @Groups({"readPayment"})
*/
private $days;
public function __construct($id = null)
{
$this->id = self::DEFAULT_ID;
if ($id) {
$this->id = $id;
}
}
public function getId(): int
{
return $this->id;
}
public function setId(int $id): self
{
$this->id = $id;
return $this;
}
public function getFromDate(): ?\DateTimeInterface
{
return $this->fromDate;
}
public function setFromDate(\DateTimeInterface $fromDate): self
{
$this->fromDate = $fromDate;
return $this;
}
public function getToDate(): ?\DateTimeInterface
{
return $this->toDate;
}
public function setToDate(?\DateTimeInterface $toDate): self
{
$this->toDate = $toDate;
return $this;
}
public function getDays(): ?array
{
return $this->days;
}
public function setDays(array $days): self
{
$this->days = $days;
return $this;
}
}