chamilo/chamilo-lms

<?php

/* For licensing terms, see /license.txt */

declare(strict_types=1);

namespace Chamilo\CoreBundle\Entity;

use ApiPlatform\Doctrine\Orm\Filter\SearchFilter;
use ApiPlatform\Metadata\ApiFilter;
use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\Delete;
use ApiPlatform\Metadata\Get;
use ApiPlatform\Metadata\GetCollection;
use ApiPlatform\Metadata\Post;
use ApiPlatform\Metadata\Put;
use Chamilo\CoreBundle\Entity\Listener\UserRelUserListener;
use Chamilo\CoreBundle\State\UserRelUserStateProcessor;
use Chamilo\CoreBundle\Traits\TimestampableTypedEntity;
use Chamilo\CoreBundle\Traits\UserTrait;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
use Symfony\Component\Serializer\Annotation\Groups;
use Symfony\Component\Validator\Constraints as Assert;

/**
 * Associations between users.
 */
#[ApiResource(
    operations: [
        new Get(),
        new Put(security: "is_granted('EDIT', object)"),
        new Delete(security: "is_granted('DELETE', object)"),
        new GetCollection(),
        new Post(securityPostDenormalize: "is_granted('CREATE', object)"),
    ],
    normalizationContext: [
        'groups' => [
            'user_rel_user:read',
            'timestampable_created:read',
        ],
    ],
    denormalizationContext: [
        'groups' => ['user_rel_user:write'],
    ],
    security: 'is_granted("ROLE_USER")',
    processor: UserRelUserStateProcessor::class,
)]
#[UniqueEntity(
    fields: ['user', 'friend', 'relationType'],
    message: 'User-friend relation already exists',
    errorPath: 'User'
)]
#[ORM\Table(name: 'user_rel_user')]
#[ORM\Index(columns: ['user_id'], name: 'idx_user_rel_user__user')]
#[ORM\Index(columns: ['friend_user_id'], name: 'idx_user_rel_user__friend_user')]
#[ORM\Index(columns: ['user_id', 'friend_user_id'], name: 'idx_user_rel_user__user_friend_user')]
#[ORM\UniqueConstraint(name: 'user_friend_relation', columns: ['user_id', 'friend_user_id', 'relation_type'])]
#[ORM\Entity]
#[ORM\EntityListeners([UserRelUserListener::class])]
#[ApiFilter(
    filterClass: SearchFilter::class,
    properties: [
        'user' => 'exact',
        'friend' => 'exact',
        'relationType' => 'exact',
        'friend.username' => 'partial',
    ]
)]
class UserRelUser
{
    use TimestampableTypedEntity;
    use UserTrait;

    public const USER_UNKNOWN = 0;
    // public const USER_RELATION_TYPE_UNKNOWN = 1;
    // public const USER_RELATION_TYPE_PARENT = 2;
    public const USER_RELATION_TYPE_FRIEND = 3;
    public const USER_RELATION_TYPE_GOODFRIEND = 4;
    // should be deprecated is useless
    // public const USER_RELATION_TYPE_ENEMY = 5; // should be deprecated is useless
    public const USER_RELATION_TYPE_DELETED = 6;
    public const USER_RELATION_TYPE_RRHH = 7;
    public const USER_RELATION_TYPE_BOSS = 8;
    public const USER_RELATION_TYPE_HRM_REQUEST = 9;
    public const USER_RELATION_TYPE_FRIEND_REQUEST = 10;

    #[ORM\Column(name: 'id', type: 'integer')]
    #[ORM\Id]
    #[ORM\GeneratedValue]
    protected ?int $id = null;

    #[Assert\NotNull]
    #[Groups(['user_rel_user:read', 'user_rel_user:write'])]
    #[ORM\ManyToOne(targetEntity: User::class, inversedBy: 'friends')]
    #[ORM\JoinColumn(name: 'user_id', referencedColumnName: 'id', nullable: false, onDelete: 'CASCADE')]
    protected User $user;

    #[Assert\NotNull]
    #[Groups(['user_rel_user:read', 'user_rel_user:write'])]
    #[ORM\ManyToOne(targetEntity: User::class, inversedBy: 'friendsWithMe')]
    #[ORM\JoinColumn(name: 'friend_user_id', referencedColumnName: 'id', nullable: false, onDelete: 'CASCADE')]
    protected User $friend;

    #[Assert\NotBlank]
    #[Groups(['user_rel_user:read', 'user_rel_user:write'])]
    #[ORM\Column(name: 'relation_type', type: 'integer', nullable: false)]
    protected int $relationType;

    public function __construct()
    {
        $this->relationType = self::USER_RELATION_TYPE_FRIEND;
    }

    public function getUser(): User
    {
        return $this->user;
    }

    public function setUser(User $user): self
    {
        $this->user = $user;

        return $this;
    }

    public function getFriend(): User
    {
        return $this->friend;
    }

    public function setFriend(User $friend): self
    {
        $this->friend = $friend;

        return $this;
    }

    public function setRelationType(int $relationType): self
    {
        $this->relationType = $relationType;

        return $this;
    }

    public function getRelationType(): ?int
    {
        return $this->relationType;
    }

    public function getId(): ?int
    {
        return $this->id;
    }
}