api/src/Community/Entity/CommunityUser.php
<?php
/**
* Copyright (c) 2019, 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\Community\Entity;
use ApiPlatform\Core\Annotation\ApiFilter;
use ApiPlatform\Core\Annotation\ApiProperty;
use ApiPlatform\Core\Annotation\ApiResource;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\NumericFilter;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\OrderFilter;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\SearchFilter;
use App\Community\Controller\LeaveCommunityAction;
use App\User\Entity\User;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
use Symfony\Component\Serializer\Annotation\Groups;
use Symfony\Component\Serializer\Annotation\MaxDepth;
use Symfony\Component\Validator\Constraints as Assert;
/**
* A member of a community.
* Additional properties could be added so we need this entity (could be useless without extra properties => if so it would be a 'classic' manytomany relation).
*
* @ORM\Entity
*
* @UniqueEntity(
* fields={"community", "user"},
* errorPath="user",
* message="This user already asked to join this community."
* )
*
* @ORM\HasLifecycleCallbacks
*
* @ApiResource(
* attributes={
* "force_eager"=false,
* "normalization_context"={"groups"={"readCommunityUser"}, "enable_max_depth"="true"},
* "denormalization_context"={"groups"={"write"}}
* },
* collectionOperations={
* "get"={
* "security_post_denormalize"="is_granted('community_list',object)",
* "swagger_context" = {
* "tags"={"Communities"}
* }
* },
* "post"={
* "security_post_denormalize"="is_granted('community_join',object)",
* "swagger_context" = {
* "tags"={"Communities"}
* }
* },
* "ADMIN_get"={
* "path"="/admin/communities/{id}/members",
* "method"="GET",
* "normalization_context"={
* "groups"={"aRead"},
* "skip_null_values"=false
* },
* "security"="is_granted('admin_community_read',object)",
* "swagger_context" = {
* "tags"={"Administration"}
* }
* },
* "ADMIN_post"={
* "path"="/admin/community_members",
* "method"="POST",
* "normalization_context"={"groups"={"aRead"}},
* "denormalization_context"={"groups"={"aWrite"}},
* "security"="is_granted('admin_community_membership',object)",
* "swagger_context" = {
* "tags"={"Administration"}
* }
* },
* "ADMIN_associate_campaign"={
* "path"="/admin/community_members/associate-campaign",
* "method"="GET",
* "normalization_context"={
* "groups"={"aRead"},
* "skip_null_values"=false
* },
* "security"="is_granted('admin_community_membership',object)",
* "swagger_context" = {
* "tags"={"Administration"}
* }
* },
* "ADMIN_send_campaign"={
* "path"="/admin/community_members/send-campaign",
* "method"="GET",
* "normalization_context"={
* "groups"={"aRead"},
* "skip_null_values"=false
* },
* "security"="is_granted('admin_community_membership',object)",
* "swagger_context" = {
* "tags"={"Administration"}
* }
* },
* "add"={
* "method"="POST",
* "path"="/community_users/add",
* "security_post_denormalize"="is_granted('community_membership',object)",
* "swagger_context" = {
* "tags"={"Administration"}
* }
* }
* },
* itemOperations={
* "get"={
* "swagger_context" = {
* "tags"={"Communities"}
* }
* },
* "put"={
* "method"="PUT",
* "security"="is_granted('community_update',object)",
* "swagger_context" = {
* "tags"={"Communities"}
* }
* },
* "delete"={
* "controller"=LeaveCommunityAction::class,
* "swagger_context" = {
* "tags"={"Communities"}
* }
* },
* "ADMIN_patch"={
* "path"="/admin/community_members/{id}",
* "method"="PATCH",
* "normalization_context"={"groups"={"aRead"}},
* "denormalization_context"={"groups"={"aWrite"}},
* "security"="is_granted('admin_community_member_update',object)",
* "swagger_context" = {
* "tags"={"Administration"}
* }
* },
* "ADMIN_delete"={
* "path"="/admin/community_members/{id}",
* "method"="DELETE",
* "normalization_context"={"groups"={"aRead"}},
* "denormalization_context"={"groups"={"aWrite"}},
* "security"="is_granted('admin_community_member_delete',object)",
* "swagger_context" = {
* "tags"={"Administration"}
* }
* }
* }
* )
*
* @ApiFilter(NumericFilter::class, properties={"user.id","community.id","status"})
* @ApiFilter(SearchFilter::class, properties={"community":"exact","user":"exact"})
* @ApiFilter(OrderFilter::class, properties={"id","status","givenName","familyName","user.givenName","acceptedDate","createdDate","refusedDate"}, arguments={"orderParameterName"="order"})
*/
class CommunityUser
{
public const STATUS_PENDING = 0;
public const STATUS_ACCEPTED_AS_MEMBER = 1;
public const STATUS_ACCEPTED_AS_MODERATOR = 2;
public const STATUS_REFUSED = 3;
/**
* @var int the id of this community user
*
* @ORM\Id
*
* @ORM\GeneratedValue
*
* @ORM\Column(type="integer")
*
* @Groups({"aRead","readCommunity","readCommunityUser","readUserAdmin","readUser"})
*/
private $id;
/**
* @var Community the community
*
* @ApiProperty(push=true)
*
* @ORM\ManyToOne(targetEntity="\App\Community\Entity\Community", inversedBy="communityUsers")
*
* @ORM\JoinColumn(nullable=false, onDelete="CASCADE")
*
* @Groups({"aWrite","readCommunity","readCommunityUser","write","results","existsCommunity","communities","readCommunityPublic","readUserAdmin"})
*
* @MaxDepth(1)
*
* @Assert\NotBlank
*/
private $community;
/**
* @var User the user
*
* @ApiProperty(push=true)
*
* @ORM\ManyToOne(targetEntity="\App\User\Entity\User", inversedBy="communityUsers")
*
* @ORM\JoinColumn(nullable=false, onDelete="CASCADE")
*
* @Groups({"aWrite","readCommunity","readCommunityUser","write","results","existsCommunity","communities","readUserAdmin"})
*
* @MaxDepth(1)
*
* @Assert\NotBlank
*/
private $user;
/**
* @var int the status of the membership
*
* @ORM\Column(type="smallint")
*
* @Groups({"aRead","aWrite","readCommunity","readCommunityUser","write","readUserAdmin"})
*/
private $status;
/**
* @var User the user that validates/invalidates the registration
*
* @ORM\ManyToOne(targetEntity="\App\User\Entity\User")
*
* @Groups({"readCommunityUser","write"})
*
* @MaxDepth(1)
*/
private $admin;
/**
* @var \DateTimeInterface creation date of the community user
*
* @ORM\Column(type="datetime")
*
* @Groups({"aRead","readCommunityUser","write"})
*/
private $createdDate;
/**
* @var \DateTimeInterface updated date of the community user
*
* @ORM\Column(type="datetime", nullable=true)
*/
private $updatedDate;
/**
* @var \DateTimeInterface accepted date
*
* @ORM\Column(type="datetime", nullable=true)
*
* @Groups({"aRead","readCommunity","readCommunityUser","write"})
*/
private $acceptedDate;
/**
* @var \DateTimeInterface refusal date
*
* @ORM\Column(type="datetime", nullable=true)
*
* @Groups({"aRead","readCommunityUser","write"})
*/
private $refusedDate;
/**
* @var \DateTimeInterface last activity date
*
* @Groups({"aRead"})
*/
private $lastActivityDate;
/**
* @var string the login to join the community if the community is secured
*
* @Groups("write")
*/
private $login;
/**
* @var string the password to join the community if the community is secured
*
* @Groups("write")
*/
private $password;
/**
* @var bool if the user is also the creator of the community
*
* @Groups("readCommunityUser")
*/
private $creator;
/**
* @var string The username of the member
*
* @Groups("aRead")
*/
private $username;
/**
* @var string The givenName of the member
*
* @Groups("aRead")
*/
private $givenName;
/**
* @var string The familyName of the member
*
* @Groups("aRead")
*/
private $familyName;
/**
* @var null|string The member avatar
*
* @Groups({"aRead"})
*/
private $avatar;
/**
* @var bool The member accepts emailing
*
* @Groups("aRead")
*/
private $newsSubscription;
/**
* @var null|int Ad type for the user (0 = none, 1 = as driver only, 2 = as passenger only, 3 = as driver and passenger)
*
* @Groups("aRead")
*/
private $adType;
/**
* @var int user id
*
* @Groups("aRead")
*/
private $userId;
public function getId(): ?int
{
return $this->id;
}
public function getCommunity(): ?Community
{
return $this->community;
}
public function setCommunity(?Community $community): self
{
$this->community = $community;
return $this;
}
public function getUser(): ?User
{
return $this->user;
}
public function setUser(?User $user): self
{
$this->user = $user;
return $this;
}
public function getStatus(): ?int
{
return $this->status;
}
public function setStatus(?int $status)
{
$this->status = $status;
}
public function getAdmin(): ?User
{
return $this->admin;
}
public function setAdmin(?User $admin): self
{
$this->admin = $admin;
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 getAcceptedDate(): ?\DateTimeInterface
{
return $this->acceptedDate;
}
public function setAcceptedDate(?\DateTimeInterface $acceptedDate): self
{
$this->acceptedDate = $acceptedDate;
return $this;
}
public function getRefusedDate(): ?\DateTimeInterface
{
return $this->refusedDate;
}
public function setRefusedDate(?\DateTimeInterface $refusedDate): self
{
$this->refusedDate = $refusedDate;
return $this;
}
public function getLogin(): ?string
{
return $this->login;
}
public function setLogin(?string $login): self
{
$this->login = $login;
return $this;
}
public function getPassword(): ?string
{
return $this->password;
}
public function setPassword(?string $password): self
{
$this->password = $password;
return $this;
}
public function isCreator(): ?bool
{
return $this->creator;
}
public function setCreator(?bool $isCreator): self
{
$this->creator = boolval($isCreator);
return $this;
}
public function getUsername(): ?string
{
return ucfirst(strtolower($this->getUser()->getGivenName())).' '.$this->getUser()->getShortFamilyName();
}
public function getGivenName(): ?string
{
return ucfirst(strtolower($this->getUser()->getGivenName()));
}
public function getFamilyName(): ?string
{
return ucfirst(strtolower($this->getUser()->getFamilyName()));
}
public function hasNewsSubscription()
{
return $this->getUser()->hasNewsSubscription();
}
public function getAvatar(): ?string
{
if (count($this->getUser()->getAvatars()) > 0) {
return $this->getUser()->getAvatars()[0];
}
return null;
}
public function getLastActivityDate(): ?\DateTimeInterface
{
return $this->getUser()->getLastActivityDate();
}
public function getUserId(): ?int
{
return $this->getUser()->getId();
}
// DOCTRINE EVENTS
/**
* Creation date.
*
* @ORM\PrePersist
*/
public function setAutoCreatedDate()
{
$this->setCreatedDate(new \DateTime());
$this->setAutoAcceptedOrRefusedDate();
}
/**
* Update date.
*
* @ORM\PreUpdate
*/
public function setAutoUpdatedDate()
{
$this->setUpdatedDate(new \DateTime());
}
/**
* Default status.
*
* @ORM\PrePersist
*/
public function setAutoStatus()
{
if ($this->getUser()->getId() == $this->getCommunity()->getUser()->getId()) {
$this->setStatus(self::STATUS_ACCEPTED_AS_MODERATOR);
} elseif (self::STATUS_ACCEPTED_AS_MODERATOR != $this->getStatus() && Community::MANUAL_VALIDATION != $this->getCommunity()->getValidationType()) {
$this->setStatus(self::STATUS_ACCEPTED_AS_MEMBER);
} elseif (self::STATUS_ACCEPTED_AS_MODERATOR != $this->getStatus()) {
$this->setStatus(self::STATUS_PENDING);
}
$this->setAutoAcceptedOrRefusedDate();
}
/**
* Accepted / refused date.
*
* @ORM\PreUpdate
*/
public function setAutoAcceptedOrRefusedDate()
{
if (self::STATUS_ACCEPTED_AS_MEMBER == $this->status && is_null($this->acceptedDate)) {
$this->setAcceptedDate(new \DateTime());
$this->setRefusedDate(null);
} elseif (self::STATUS_ACCEPTED_AS_MODERATOR == $this->status && is_null($this->acceptedDate)) {
$this->setAcceptedDate(new \DateTime());
$this->setRefusedDate(null);
} elseif (self::STATUS_REFUSED == $this->status && is_null($this->refusedDate)) {
$this->setRefusedDate(new \DateTime());
$this->setAcceptedDate(null);
} elseif (self::STATUS_PENDING == $this->status) {
$this->setAcceptedDate(null);
$this->setRefusedDate(null);
}
}
}