Forum::getStatusChoices() - Code Metrics - Inspection of "Switch message-bundle to dev" - projet-normandie/forum-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( c95ce3...d0c957 )

by BENARD

created 2024-08-20 18:12 UTC

Forum::getStatusChoices() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	3
dl	0
loc	5
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

declare(strict_types=1);

namespace ProjetNormandie\ForumBundle\Entity;

use ApiPlatform\Doctrine\Common\Filter\DateFilterInterface;
use ApiPlatform\Doctrine\Orm\Filter\DateFilter;
use ApiPlatform\Doctrine\Orm\Filter\OrderFilter;
use ApiPlatform\Doctrine\Orm\Filter\SearchFilter;
use ApiPlatform\Metadata\ApiFilter;
use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\Get;
use ApiPlatform\Metadata\GetCollection;
use ApiPlatform\OpenApi\Model;
use ApiPlatform\Serializer\Filter\GroupFilter;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use Knp\DoctrineBehaviors\Contract\Entity\SluggableInterface;
use Knp\DoctrineBehaviors\Contract\Entity\TimestampableInterface;
use Knp\DoctrineBehaviors\Model\Sluggable\SluggableTrait;
use Knp\DoctrineBehaviors\Model\Timestampable\TimestampableTrait;
use ProjetNormandie\ForumBundle\Controller\GetHomeForums;
use ProjetNormandie\ForumBundle\Controller\ReadForum;
use ProjetNormandie\ForumBundle\Repository\ForumRepository;
use ProjetNormandie\ForumBundle\ValueObject\ForumStatus;
use Symfony\Component\Serializer\Annotation\Groups;
use Symfony\Component\Validator\Constraints as Assert;

#[ORM\Table(name:'pnf_forum')]
#[ORM\Entity(repositoryClass: ForumRepository::class)]
#[ORM\EntityListeners(["ProjetNormandie\ForumBundle\EventListener\Entity\ForumListener"])]
#[ORM\Index(name: "idx_position", columns: ["position"])]
#[ORM\Index(name: "idx_lib_forum", columns: ["lib_forum"])]
#[ApiResource(
    shortName: 'ForumForum',
    operations: [
        new GetCollection(
            uriTemplate: '/forum_forums',
        ),
        new Get(
            uriTemplate: '/forum_forums/{id}',
            security: 'object.getStatus() == "public" or is_granted(object.getRole())',
        ),
        new Get(
            uriTemplate: '/forum_forums/{id}/read',
            controller: ReadForum::class,
            security: 'is_granted("ROLE_USER")',
            openapi: new Model\Operation(
                summary: 'Mark forum as read',
                description: 'Mark forum as read'
            ),
        ),
    ],
    normalizationContext: ['groups' => ['forum:read']
    ]
)]
#[ApiFilter(
    SearchFilter::class,
    properties: [
        'parent' => 'exact',
    ]
)]
#[ApiFilter(
    OrderFilter::class,
    properties: [
        'lastMessage.id"' => 'DESC'
    ]
)]
#[ApiFilter(
    GroupFilter::class,
    arguments: [
        'parameterName' => 'groups',
        'overrideDefaultGroups' => true,
        'whitelist' => [
            'forum:read',
            'forum:last-message',
            'message:read',
            'forum:forum-user-1',
            'forum-user:read'
        ]
    ]
)]
#[ApiFilter(DateFilter::class, properties: ['lastMessage.createdAt' => DateFilterInterface::EXCLUDE_NULL])]
class Forum implements TimestampableInterface, SluggableInterface
{
    use TimestampableTrait;
    use SluggableTrait;

    #[Groups(['forum:read'])]
    #[ORM\Id, ORM\Column, ORM\GeneratedValue]
    private int $id;

    #[Groups(['forum:read'])]
    #[Assert\Length(max: 255)]
    #[ORM\Column(length: 255, nullable: false)]
    private string $libForum;

    #[Groups(['forum:read'])]
    #[Assert\Length(max: 255)]
    #[ORM\Column(length: 255, nullable: true)]
    private string $libForumFr;

    #[ORM\Column(nullable: true, options: ['default' => 0])]
    private int $position = 0;

    #[Groups(['forum:read'])]
    #[ORM\Column(length: 20, nullable: false)]
    private string $status = ForumStatus::PUBLIC;

    #[Groups(['forum:read'])]
    #[ORM\Column(length: 50, nullable: true)]
    private ?string $role = null;

    #[Groups(['forum:read'])]
    #[ORM\Column(nullable: true, options: ['default' => 0])]
    private int $nbMessage = 0;

    #[Groups(['forum:read'])]
    #[ORM\Column(nullable: true, options: ['default' => 0])]
    private int $nbTopic = 0;

    #[ORM\ManyToOne(targetEntity: Category::class, inversedBy: 'forums')]
    #[ORM\JoinColumn(name:'category_id', referencedColumnName:'id', nullable:true)]
    private ?Category $category;

    #[ORM\OneToMany(targetEntity: Topic::class, mappedBy: 'forum')]
    private Collection $topics;

    #[ORM\OneToMany(targetEntity: Forum::class, mappedBy: 'parent')]
    private Collection $childrens;

    #[Groups(['forum:read'])]
    #[ORM\ManyToOne(targetEntity: Forum::class, inversedBy: 'childrens')]
    #[ORM\JoinColumn(name:'parent_id', referencedColumnName:'id', nullable:true)]
    private ?Forum $parent;

    #[Groups(['forum:read'])]
    #[ORM\Column(nullable: false, options: ['default' => false])]
    private bool $isParent = false;

    #[Groups(['forum:last-message'])]
    #[ORM\ManyToOne(targetEntity: Message::class, cascade: ['persist'])]
    #[ORM\JoinColumn(name:'max_message_id', referencedColumnName:'id', nullable:true, onDelete: 'SET NULL')]
    private ?Message $lastMessage;

    #[Groups(['forum:forum-user'])]
    #[ORM\OneToMany(targetEntity: ForumUser::class, mappedBy: 'forum')]
    private Collection $forumUser;

    public function __construct()
    {
        $this->topics = new ArrayCollection();
        $this->forumUser = new ArrayCollection();
        $this->childrens = new ArrayCollection();
    }

    public function __toString()
    {
        return sprintf('%s [%s]', $this->getLibForum(), $this->getId());
    }

    public function setId(int $id): void
    {
        $this->id = $id;
    }

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

    public function setLibForum(string $libForum): void
    {
        $this->libForum = $libForum;
    }

    public function getLibForum(): string
    {
        return $this->libForum;
    }

    public function setLibForumFr(string $libForumFr): void
    {
        $this->libForumFr = $libForumFr;
    }

    public function getLibForumFr(): string
    {
        return $this->libForumFr;
    }

    public function setPosition(int $position): void
    {
        $this->position = $position;
    }

    public function getPosition(): int
    {
        return $this->position;
    }

    public function setStatus(string $status): void
    {
        $this->status = $status;
    }

    public function getStatus(): string
    {
        return $this->status;
    }

    public function setRole(string $role): void
    {
        $this->role = $role;
    }

    public function getRole(): ?string
    {
        return $this->role;
    }

    public function setNbMessage(int $nbMessage): void
    {
        $this->nbMessage = $nbMessage;
    }

    public function getNbMessage(): int
    {
        return $this->nbMessage;
    }

    public function setNbTopic(int $nbTopic): void
    {
        $this->nbTopic = $nbTopic;
    }


    public function getNbTopic(): int
    {
        return $this->nbTopic;
    }

    public function setCategory(Category $category = null): void
    {
        $this->category = $category;
    }

    public function getCategory(): ?Category
    {
        return $this->category;
    }

    public function setParent(Forum $forum = null): void
    {
        $this->parent = $forum;
    }

    public function getParent(): ?Forum
    {
        return $this->parent;
    }

    public function getTopics(): Collection
    {
        return $this->topics;
    }

    public function getChildrens(): Collection
    {
        return $this->childrens;
    }

    public function setLastMessage(Message $message = null): void
    {
        $this->lastMessage = $message;
    }

    public function getLastMessage(): ?Message
    {
        return $this->lastMessage;
    }

    public function getForumUser(): Collection
    {
        return $this->forumUser;
    }

    public function setIsParent(bool $isParent): void
    {
        $this->isParent = $isParent;
    }

    public function getIsParent(): bool
    {
        return $this->isParent;
    }

    #[Groups(['forum:forum-user-1'])]
    public function getForumUser1()
    {
        return $this->forumUser[0];
    }

    public function getSluggableFields(): array
    {
        return ['libForum'];
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace ProjetNormandie\ForumBundle\Entity;
6
7			use ApiPlatform\Doctrine\Common\Filter\DateFilterInterface;
8			use ApiPlatform\Doctrine\Orm\Filter\DateFilter;
9			use ApiPlatform\Doctrine\Orm\Filter\OrderFilter;
10			use ApiPlatform\Doctrine\Orm\Filter\SearchFilter;
11			use ApiPlatform\Metadata\ApiFilter;
12			use ApiPlatform\Metadata\ApiResource;
13			use ApiPlatform\Metadata\Get;
14			use ApiPlatform\Metadata\GetCollection;
15			use ApiPlatform\OpenApi\Model;
16			use ApiPlatform\Serializer\Filter\GroupFilter;
17			use Doctrine\Common\Collections\ArrayCollection;
18			use Doctrine\Common\Collections\Collection;
19			use Doctrine\ORM\Mapping as ORM;
20			use Knp\DoctrineBehaviors\Contract\Entity\SluggableInterface;
21			use Knp\DoctrineBehaviors\Contract\Entity\TimestampableInterface;
22			use Knp\DoctrineBehaviors\Model\Sluggable\SluggableTrait;
23			use Knp\DoctrineBehaviors\Model\Timestampable\TimestampableTrait;
24			use ProjetNormandie\ForumBundle\Controller\GetHomeForums;
25			use ProjetNormandie\ForumBundle\Controller\ReadForum;
26			use ProjetNormandie\ForumBundle\Repository\ForumRepository;
27			use ProjetNormandie\ForumBundle\ValueObject\ForumStatus;
28			use Symfony\Component\Serializer\Annotation\Groups;
29			use Symfony\Component\Validator\Constraints as Assert;
30
31			#[ORM\Table(name:'pnf_forum')]
32			#[ORM\Entity(repositoryClass: ForumRepository::class)]
33			#[ORM\EntityListeners(["ProjetNormandie\ForumBundle\EventListener\Entity\ForumListener"])]
34			#[ORM\Index(name: "idx_position", columns: ["position"])]
35			#[ORM\Index(name: "idx_lib_forum", columns: ["lib_forum"])]
36			#[ApiResource(
37			shortName: 'ForumForum',
38			operations: [
39			new GetCollection(
40			uriTemplate: '/forum_forums',
41			),
42			new Get(
43			uriTemplate: '/forum_forums/{id}',
44			security: 'object.getStatus() == "public" or is_granted(object.getRole())',
45			),
46			new Get(
47			uriTemplate: '/forum_forums/{id}/read',
48			controller: ReadForum::class,
49			security: 'is_granted("ROLE_USER")',
50			openapi: new Model\Operation(
51			summary: 'Mark forum as read',
52			description: 'Mark forum as read'
53			),
54			),
55			],
56			normalizationContext: ['groups' => ['forum:read']
57			]
58			)]
59			#[ApiFilter(
60			SearchFilter::class,
61			properties: [
62			'parent' => 'exact',
63			]
64			)]
65			#[ApiFilter(
66			OrderFilter::class,
67			properties: [
68			'lastMessage.id"' => 'DESC'
69			]
70			)]
71			#[ApiFilter(
72			GroupFilter::class,
73			arguments: [
74			'parameterName' => 'groups',
75			'overrideDefaultGroups' => true,
76			'whitelist' => [
77			'forum:read',
78			'forum:last-message',
79			'message:read',
80			'forum:forum-user-1',
81			'forum-user:read'
82			]
83			]
84			)]
85			#[ApiFilter(DateFilter::class, properties: ['lastMessage.createdAt' => DateFilterInterface::EXCLUDE_NULL])]
86			class Forum implements TimestampableInterface, SluggableInterface
87			{
88			use TimestampableTrait;
89			use SluggableTrait;
90
91			#[Groups(['forum:read'])]
92			#[ORM\Id, ORM\Column, ORM\GeneratedValue]
93			private int $id;
94
95			#[Groups(['forum:read'])]
96			#[Assert\Length(max: 255)]
97			#[ORM\Column(length: 255, nullable: false)]
98			private string $libForum;
99
100			#[Groups(['forum:read'])]
101			#[Assert\Length(max: 255)]
102			#[ORM\Column(length: 255, nullable: true)]
103			private string $libForumFr;
104
105			#[ORM\Column(nullable: true, options: ['default' => 0])]
106			private int $position = 0;
107
108			#[Groups(['forum:read'])]
109			#[ORM\Column(length: 20, nullable: false)]
110			private string $status = ForumStatus::PUBLIC;
111
112			#[Groups(['forum:read'])]
113			#[ORM\Column(length: 50, nullable: true)]
114			private ?string $role = null;
115
116			#[Groups(['forum:read'])]
117			#[ORM\Column(nullable: true, options: ['default' => 0])]
118			private int $nbMessage = 0;
119
120			#[Groups(['forum:read'])]
121			#[ORM\Column(nullable: true, options: ['default' => 0])]
122			private int $nbTopic = 0;
123
124			#[ORM\ManyToOne(targetEntity: Category::class, inversedBy: 'forums')]
125			#[ORM\JoinColumn(name:'category_id', referencedColumnName:'id', nullable:true)]
126			private ?Category $category;
127
128			#[ORM\OneToMany(targetEntity: Topic::class, mappedBy: 'forum')]
129			private Collection $topics;
130
131			#[ORM\OneToMany(targetEntity: Forum::class, mappedBy: 'parent')]
132			private Collection $childrens;
133
134			#[Groups(['forum:read'])]
135			#[ORM\ManyToOne(targetEntity: Forum::class, inversedBy: 'childrens')]
136			#[ORM\JoinColumn(name:'parent_id', referencedColumnName:'id', nullable:true)]
137			private ?Forum $parent;
138
139			#[Groups(['forum:read'])]
140			#[ORM\Column(nullable: false, options: ['default' => false])]
141			private bool $isParent = false;
142
143			#[Groups(['forum:last-message'])]
144			#[ORM\ManyToOne(targetEntity: Message::class, cascade: ['persist'])]
145			#[ORM\JoinColumn(name:'max_message_id', referencedColumnName:'id', nullable:true, onDelete: 'SET NULL')]
146			private ?Message $lastMessage;
147
148			#[Groups(['forum:forum-user'])]
149			#[ORM\OneToMany(targetEntity: ForumUser::class, mappedBy: 'forum')]
150			private Collection $forumUser;
151
152			public function __construct()
153			{
154			$this->topics = new ArrayCollection();
155			$this->forumUser = new ArrayCollection();
156			$this->childrens = new ArrayCollection();
157			}
158
159			public function __toString()
160			{
161			return sprintf('%s [%s]', $this->getLibForum(), $this->getId());
162			}
163
164			public function setId(int $id): void
165			{
166			$this->id = $id;
167			}
168
169			public function getId(): ?int
170			{
171			return $this->id;
172			}
173
174			public function setLibForum(string $libForum): void
175			{
176			$this->libForum = $libForum;
177			}
178
179			public function getLibForum(): string
180			{
181			return $this->libForum;
182			}
183
184			public function setLibForumFr(string $libForumFr): void
185			{
186			$this->libForumFr = $libForumFr;
187			}
188
189			public function getLibForumFr(): string
190			{
191			return $this->libForumFr;
192			}
193
194			public function setPosition(int $position): void
195			{
196			$this->position = $position;
197			}
198
199			public function getPosition(): int
200			{
201			return $this->position;
202			}
203
204			public function setStatus(string $status): void
205			{
206			$this->status = $status;
207			}
208
209			public function getStatus(): string
210			{
211			return $this->status;
212			}
213
214			public function setRole(string $role): void
215			{
216			$this->role = $role;
217			}
218
219			public function getRole(): ?string
220			{
221			return $this->role;
222			}
223
224			public function setNbMessage(int $nbMessage): void
225			{
226			$this->nbMessage = $nbMessage;
227			}
228
229			public function getNbMessage(): int
230			{
231			return $this->nbMessage;
232			}
233
234			public function setNbTopic(int $nbTopic): void
235			{
236			$this->nbTopic = $nbTopic;
237			}
238
239
240			public function getNbTopic(): int
241			{
242			return $this->nbTopic;
243			}
244
245			public function setCategory(Category $category = null): void
246			{
247			$this->category = $category;
248			}
249
250			public function getCategory(): ?Category
251			{
252			return $this->category;
253			}
254
255			public function setParent(Forum $forum = null): void
256			{
257			$this->parent = $forum;
258			}
259
260			public function getParent(): ?Forum
261			{
262			return $this->parent;
263			}
264
265			public function getTopics(): Collection
266			{
267			return $this->topics;
268			}
269
270			public function getChildrens(): Collection
271			{
272			return $this->childrens;
273			}
274
275			public function setLastMessage(Message $message = null): void
276			{
277			$this->lastMessage = $message;
278			}
279
280			public function getLastMessage(): ?Message
281			{
282			return $this->lastMessage;
283			}
284
285			public function getForumUser(): Collection
286			{
287			return $this->forumUser;
288			}
289
290			public function setIsParent(bool $isParent): void
291			{
292			$this->isParent = $isParent;
293			}
294
295			public function getIsParent(): bool
296			{
297			return $this->isParent;
298			}
299
300			#[Groups(['forum:forum-user-1'])]
301			public function getForumUser1()
302			{
303			return $this->forumUser[0];
304			}
305
306			public function getSluggableFields(): array
307			{
308			return ['libForum'];
309			}
310			}
311

projet-normandie / forum-bundle

Push — develop ( c95ce3...d0c957 )

Forum::getStatusChoices() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like