CBlog::getOwner() - Code Metrics - Inspection of "Dropbox: Re-enable blogs tool - refs #6823" - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( e9e739...1e7f19 )

by Yannick

created 2025-09-30 23:58 UTC

CBlog::getOwner() A

↳ Parent: CBlog

Complexity

Conditions	6
Paths	9

Size

Total Lines	15
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
eloc	9
nc	9
nop	0
dl	0
loc	15
rs	9.2222
c	0
b	0
f	0

<?php

declare(strict_types=1);

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

namespace Chamilo\CourseBundle\Entity;

use ApiPlatform\Doctrine\Orm\Filter\OrderFilter;
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\Patch;
use ApiPlatform\Metadata\Post;
use ApiPlatform\Metadata\Put;
use Chamilo\CoreBundle\Controller\Api\CreateCBlogAction;
use Chamilo\CoreBundle\Controller\Api\UpdateVisibilityBlog;
use Chamilo\CoreBundle\Entity\AbstractResource;
use Chamilo\CoreBundle\Entity\ResourceLink;
use Chamilo\CoreBundle\Entity\ResourceInterface;
use Chamilo\CourseBundle\Repository\CBlogRepository;
use DateTime;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use Stringable;
use Symfony\Component\Serializer\Annotation\Groups;
use Symfony\Component\Validator\Constraints as Assert;

#[ORM\Entity(repositoryClass: CBlogRepository::class)]
#[ORM\Table(name: 'c_blog')]
#[ApiResource(
    operations: [
        new GetCollection(),
        new Post(
            controller: CreateCBlogAction::class,
            openapiContext: [
                'summary' => 'Create a new blog project',
                'requestBody' => [
                    'content' => [
                        'application/json' => [
                            'schema' => [
                                'type' => 'object',
                                'properties' => [
                                    'title' => ['type' => 'string'],
                                    'blogSubtitle' => ['type' => 'string'],
                                    'parentResourceNodeId' => ['type' => 'integer'],
                                    'resourceLinkList' => [
                                        'oneOf' => [
                                            ['type' => 'array'],
                                            ['type' => 'string'],
                                        ],
                                    ],
                                    'showOnHomepage' => ['type' => 'boolean'],
                                ],
                                'required' => ['title'],
                            ],
                        ],
                    ],
                ],
            ],
            security: "is_granted('ROLE_CURRENT_COURSE_TEACHER') or is_granted('ROLE_CURRENT_COURSE_SESSION_TEACHER') or is_granted('ROLE_TEACHER')",
            validationContext: ['groups' => ['Default','blog:write']],
            deserialize: false
        ),
        new Get(security: "is_granted('VIEW', object.resourceNode)"),
        new Patch(security: "is_granted('ROLE_USER')"),
        new Delete(security: "is_granted('ROLE_USER')"),
        new Put(
            uriTemplate: '/c_blogs/{iid}/toggle_visibility',
            controller: UpdateVisibilityBlog::class,
            security: "is_granted('EDIT', object.resourceNode)",
            deserialize: false
        ),
    ],
    normalizationContext: ['groups' => ['blog:read']],
    denormalizationContext: ['groups' => ['blog:write', 'resource_node:write']],
    paginationEnabled: true
)]
#[ApiFilter(SearchFilter::class, properties: [
    'title' => 'partial',
    'blogSubtitle' => 'partial',
])]
#[ApiFilter(OrderFilter::class, properties: [
    'dateCreation',
    'title',
], arguments: ['orderParameterName' => 'order'])]
class CBlog extends AbstractResource implements ResourceInterface, Stringable
{
    #[Groups(['blog:read'])]
    #[ORM\Id, ORM\Column(name: 'iid', type: 'integer'), ORM\GeneratedValue]
    protected ?int $iid = null;

    #[Assert\NotBlank]
    #[Groups(['blog:read','blog:write'])]
    #[ORM\Column(name: 'title', type: 'text', nullable: false)]
    protected string $title;

    #[Groups(['blog:read','blog:write'])]
    #[ORM\Column(name: 'blog_subtitle', type: 'string', length: 250, nullable: true)]
    protected ?string $blogSubtitle = null;

    #[Groups(['blog:read'])]
    #[ORM\Column(name: 'date_creation', type: 'datetime', nullable: false)]
    protected DateTime $dateCreation;

    #[Groups(['blog:read'])]
    #[ORM\OneToMany(mappedBy: 'blog', targetEntity: CBlogAttachment::class, cascade: ['persist', 'remove'])]
    private Collection $attachments;

    public function __construct()
    {
        $this->attachments = new ArrayCollection();
        $this->dateCreation = new DateTime();
    }

    public function getIid(): ?int { return $this->iid; }

    public function getTitle(): string { return $this->title; }
    public function setTitle(string $title): self { $this->title = $title; return $this; }

    public function getBlogSubtitle(): ?string { return $this->blogSubtitle; }
    public function setBlogSubtitle(?string $blogSubtitle): self { $this->blogSubtitle = $blogSubtitle; return $this; }

    public function getDateCreation(): DateTime { return $this->dateCreation; }
    public function setDateCreation(DateTime $dateCreation): self { $this->dateCreation = $dateCreation; return $this; }

    /** @return Collection<int, CBlogAttachment> */
    public function getAttachments(): Collection { return $this->attachments; }
    public function addAttachment(CBlogAttachment $attachment): self
    {
        if (!$this->attachments->contains($attachment)) {
            $this->attachments->add($attachment);
            $attachment->setBlog($this);
        }
        return $this;
    }
    public function removeAttachment(CBlogAttachment $attachment): self
    {
        if ($this->attachments->removeElement($attachment)) {
            if ($attachment->getBlog() === $this) {
                $attachment->setBlog(null);
            }
        }
        return $this;
    }

    #[Groups(['blog:read'])]
    public function getCreatedAt(): string
    {
        return $this->getDateCreation()->format('Y-m-d');
    }

    #[Groups(['blog:read'])]
    public function getOwner(): array
    {
        if (method_exists($this, 'getCreator') && null !== $this->getCreator()) {
            $u = $this->getCreator();
            $name = method_exists($u, 'getCompleteName') ? $u->getCompleteName()
                : (method_exists($u, 'getUsername') ? $u->getUsername() : 'Owner');

            return [
                'id'   => method_exists($u, 'getId') ? $u->getId() : null,
                'name' => $name,
            ];
        }

        return ['id' => null, 'name' => 'Owner'];
    }

    #[Groups(['blog:read', 'blog:write'])]
    public function getVisible(): bool
    {
        $link = $this->getFirstResourceLink();
        if (!$link instanceof ResourceLink) {
            return true;
        }

        return ResourceLink::VISIBILITY_PUBLISHED === $link->getVisibility();
    }

    public function setVisible(bool $visible): self
    {
        $link = $this->getFirstResourceLink();
        if ($link instanceof ResourceLink) {
            $link->setVisibility(
                $visible ? ResourceLink::VISIBILITY_PUBLISHED : ResourceLink::VISIBILITY_DRAFT
            );
        }
        return $this;
    }

    #[Groups(['blog:read'])]
    public function getVisibilityName(): string
    {
        $link = $this->getFirstResourceLink();
        if ($link instanceof ResourceLink) {
            return (string) $link->getVisibilityName();
        }

        return 'published';
    }

    // === ResourceInterface ===
    public function getResourceIdentifier(): int { return (int) ($this->getIid() ?? 0); }
    public function getResourceName(): string { return $this->getTitle(); }
    public function setResourceName(string $name): self { return $this->setTitle($name); }

    public function __toString(): string { return $this->getTitle(); }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/* For licensing terms, see /license.txt */
6
7			namespace Chamilo\CourseBundle\Entity;
8
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\Delete;
14			use ApiPlatform\Metadata\Get;
15			use ApiPlatform\Metadata\GetCollection;
16			use ApiPlatform\Metadata\Patch;
17			use ApiPlatform\Metadata\Post;
18			use ApiPlatform\Metadata\Put;
19			use Chamilo\CoreBundle\Controller\Api\CreateCBlogAction;
20			use Chamilo\CoreBundle\Controller\Api\UpdateVisibilityBlog;
21			use Chamilo\CoreBundle\Entity\AbstractResource;
22			use Chamilo\CoreBundle\Entity\ResourceLink;
23			use Chamilo\CoreBundle\Entity\ResourceInterface;
24			use Chamilo\CourseBundle\Repository\CBlogRepository;
25			use DateTime;
26			use Doctrine\Common\Collections\ArrayCollection;
27			use Doctrine\Common\Collections\Collection;
28			use Doctrine\ORM\Mapping as ORM;
29			use Stringable;
30			use Symfony\Component\Serializer\Annotation\Groups;
31			use Symfony\Component\Validator\Constraints as Assert;
32
33			#[ORM\Entity(repositoryClass: CBlogRepository::class)]
34			#[ORM\Table(name: 'c_blog')]
35			#[ApiResource(
36			operations: [
37			new GetCollection(),
38			new Post(
39			controller: CreateCBlogAction::class,
40			openapiContext: [
41			'summary' => 'Create a new blog project',
42			'requestBody' => [
43			'content' => [
44			'application/json' => [
45			'schema' => [
46			'type' => 'object',
47			'properties' => [
48			'title' => ['type' => 'string'],
49			'blogSubtitle' => ['type' => 'string'],
50			'parentResourceNodeId' => ['type' => 'integer'],
51			'resourceLinkList' => [
52			'oneOf' => [
53			['type' => 'array'],
54			['type' => 'string'],
55			],
56			],
57			'showOnHomepage' => ['type' => 'boolean'],
58			],
59			'required' => ['title'],
60			],
61			],
62			],
63			],
64			],
65			security: "is_granted('ROLE_CURRENT_COURSE_TEACHER') or is_granted('ROLE_CURRENT_COURSE_SESSION_TEACHER') or is_granted('ROLE_TEACHER')",
66			validationContext: ['groups' => ['Default','blog:write']],
67			deserialize: false
68			),
69			new Get(security: "is_granted('VIEW', object.resourceNode)"),
70			new Patch(security: "is_granted('ROLE_USER')"),
71			new Delete(security: "is_granted('ROLE_USER')"),
72			new Put(
73			uriTemplate: '/c_blogs/{iid}/toggle_visibility',
74			controller: UpdateVisibilityBlog::class,
75			security: "is_granted('EDIT', object.resourceNode)",
76			deserialize: false
77			),
78			],
79			normalizationContext: ['groups' => ['blog:read']],
80			denormalizationContext: ['groups' => ['blog:write', 'resource_node:write']],
81			paginationEnabled: true
82			)]
83			#[ApiFilter(SearchFilter::class, properties: [
84			'title' => 'partial',
85			'blogSubtitle' => 'partial',
86			])]
87			#[ApiFilter(OrderFilter::class, properties: [
88			'dateCreation',
89			'title',
90			], arguments: ['orderParameterName' => 'order'])]
91			class CBlog extends AbstractResource implements ResourceInterface, Stringable
92			{
93			#[Groups(['blog:read'])]
94			#[ORM\Id, ORM\Column(name: 'iid', type: 'integer'), ORM\GeneratedValue]
95			protected ?int $iid = null;
96
97			#[Assert\NotBlank]
98			#[Groups(['blog:read','blog:write'])]
99			#[ORM\Column(name: 'title', type: 'text', nullable: false)]
100			protected string $title;
101
102			#[Groups(['blog:read','blog:write'])]
103			#[ORM\Column(name: 'blog_subtitle', type: 'string', length: 250, nullable: true)]
104			protected ?string $blogSubtitle = null;
105
106			#[Groups(['blog:read'])]
107			#[ORM\Column(name: 'date_creation', type: 'datetime', nullable: false)]
108			protected DateTime $dateCreation;
109
110			#[Groups(['blog:read'])]
111			#[ORM\OneToMany(mappedBy: 'blog', targetEntity: CBlogAttachment::class, cascade: ['persist', 'remove'])]
112			private Collection $attachments;
113
114			public function __construct()
115			{
116			$this->attachments = new ArrayCollection();
117			$this->dateCreation = new DateTime();
118			}
119
120			public function getIid(): ?int { return $this->iid; }
121
122			public function getTitle(): string { return $this->title; }
123			public function setTitle(string $title): self { $this->title = $title; return $this; }
124
125			public function getBlogSubtitle(): ?string { return $this->blogSubtitle; }
126			public function setBlogSubtitle(?string $blogSubtitle): self { $this->blogSubtitle = $blogSubtitle; return $this; }
127
128			public function getDateCreation(): DateTime { return $this->dateCreation; }
129			public function setDateCreation(DateTime $dateCreation): self { $this->dateCreation = $dateCreation; return $this; }
130
131			/** @return Collection<int, CBlogAttachment> */
132			public function getAttachments(): Collection { return $this->attachments; }
133			public function addAttachment(CBlogAttachment $attachment): self
134			{
135			if (!$this->attachments->contains($attachment)) {
136			$this->attachments->add($attachment);
137			$attachment->setBlog($this);
138			}
139			return $this;
140			}
141			public function removeAttachment(CBlogAttachment $attachment): self
142			{
143			if ($this->attachments->removeElement($attachment)) {
144			if ($attachment->getBlog() === $this) {
145			$attachment->setBlog(null);
146			}
147			}
148			return $this;
149			}
150
151			#[Groups(['blog:read'])]
152			public function getCreatedAt(): string
153			{
154			return $this->getDateCreation()->format('Y-m-d');
155			}
156
157			#[Groups(['blog:read'])]
158			public function getOwner(): array
159			{
160			if (method_exists($this, 'getCreator') && null !== $this->getCreator()) {
161			$u = $this->getCreator();
162			$name = method_exists($u, 'getCompleteName') ? $u->getCompleteName()
163			: (method_exists($u, 'getUsername') ? $u->getUsername() : 'Owner');
164
165			return [
166			'id' => method_exists($u, 'getId') ? $u->getId() : null,
167			'name' => $name,
168			];
169			}
170
171			return ['id' => null, 'name' => 'Owner'];
172			}
173
174			#[Groups(['blog:read', 'blog:write'])]
175			public function getVisible(): bool
176			{
177			$link = $this->getFirstResourceLink();
178			if (!$link instanceof ResourceLink) {
179			return true;
180			}
181
182			return ResourceLink::VISIBILITY_PUBLISHED === $link->getVisibility();
183			}
184
185			public function setVisible(bool $visible): self
186			{
187			$link = $this->getFirstResourceLink();
188			if ($link instanceof ResourceLink) {
189			$link->setVisibility(
190			$visible ? ResourceLink::VISIBILITY_PUBLISHED : ResourceLink::VISIBILITY_DRAFT
191			);
192			}
193			return $this;
194			}
195
196			#[Groups(['blog:read'])]
197			public function getVisibilityName(): string
198			{
199			$link = $this->getFirstResourceLink();
200			if ($link instanceof ResourceLink) {
201			return (string) $link->getVisibilityName();
202			}
203
204			return 'published';
205			}
206
207			// === ResourceInterface ===
208			public function getResourceIdentifier(): int { return (int) ($this->getIid() ?? 0); }
209			public function getResourceName(): string { return $this->getTitle(); }
210			public function setResourceName(string $name): self { return $this->setTitle($name); }
211
212			public function __toString(): string { return $this->getTitle(); }
213			}
214

chamilo / chamilo-lms

Push — master ( e9e739...1e7f19 )

CBlog::getOwner() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like