Covivo/mobicoop

View on GitHub
client/src/MobicoopBundle/Community/Entity/CommunityUser.php

Summary

Maintainability
A
3 hrs
Test Coverage
<?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 Mobicoop\Bundle\MobicoopBundle\Community\Entity;

use Symfony\Component\Serializer\Annotation\Groups;
use Mobicoop\Bundle\MobicoopBundle\User\Entity\User;
use Mobicoop\Bundle\MobicoopBundle\Api\Entity\ResourceInterface;
use Mobicoop\Bundle\MobicoopBundle\Gamification\Entity\GamificationEntity;

/**
 * A user related to a community.
 */
class CommunityUser extends GamificationEntity implements ResourceInterface, \JsonSerializable
{
    const STATUS_PENDING = 0;
    const STATUS_ACCEPTED_AS_MEMBER = 1;
    const STATUS_ACCEPTED_AS_MODERATOR = 2;
    const STATUS_REFUSED = 3;

    /**
     * @var int The id of this community user.
     *
     * @Groups("post")
     */
    private $id;

    /**
     * @var string|null The iri of this community.
     */
    private $iri;
        
    /**
     * @var Community The community.
     *
     * @Groups({"post","put"})
     */
    private $community;

    /**
     * @var User The user.
     *
     * @Groups({"post","put"})
     */
    private $user;

    /**
     * @var int The status of the user (pending/accepted/refused).
     *
     * @Groups({"post","put"})
     */
    private $status;
    
    /**
     * @var User The user that validates/invalidates the registration.
     *
     * @Groups({"post","put"})
     */
    private $admin;

    /**
    * @var \DateTimeInterface Creation date of the community user.
    * @Groups({"post","put"})
    */
    private $createdDate;

    /**
     * @var \DateTimeInterface Updated date of the community user.
     *
     */
    private $updatedDate;

    /**
    * @var \DateTimeInterface Accepted date.
    * @Groups({"post","put"})
    */
    private $acceptedDate;

    /**
    * @var \DateTimeInterface Refusal date.
    * @Groups({"post","put"})
    */
    private $refusedDate;

    /**
     * @var string The login to join the community if the community is secured.
     *
     * @Groups({"put", "post"})
     */
    private $login;

    /**
     * @var string The password to join the community if the community is secured.
     *
     * @Groups({"put", "post"})
     */
    private $password;

    public function __construct($id=null)
    {
        if ($id) {
            $this->setId($id);
        }
    }
    
    public function getId(): ?int
    {
        return $this->id;
    }
    
    public function setId($id)
    {
        $this->id = $id;
    }

    public function getIri()
    {
        return $this->iri;
    }
    
    public function setIri($iri)
    {
        $this->iri = $iri;
    }
    
    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()
    {
        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)
    {
        $this->login = $login;
    }

    public function getPassword(): ?string
    {
        return $this->password;
    }
    
    public function setPassword(string $password)
    {
        $this->password = $password;
    }
    
    public function jsonSerialize()
    {
        return
        [
            'id'                        => $this->getId(),
            'iri'                       => $this->getIri(),
            'user'                      => $this->getUser(),
            'admin'                     => $this->getAdmin(),
            'createdDate'               => $this->getCreatedDate(),
            'acceptedDate'              => $this->getAcceptedDate(),
            'refusedDate'               => $this->getRefusedDate(),
            'status'                    => $this->getStatus(),
            'gamificationNotifications' => $this->getGamificationNotifications(),
        ];
    }
}