CShortcut::getUrlOverride() - 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

CShortcut::getUrlOverride() A

↳ Parent: CShortcut

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

declare(strict_types=1);

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

namespace Chamilo\CourseBundle\Entity;

use Chamilo\CoreBundle\Entity\AbstractResource;
use Chamilo\CoreBundle\Entity\ResourceInterface;
use Chamilo\CoreBundle\Entity\ResourceNode;
use Chamilo\CourseBundle\Repository\CShortcutRepository;
use Doctrine\ORM\Mapping as ORM;
use Stringable;
use Symfony\Component\Serializer\Annotation\Groups;
use Symfony\Component\Validator\Constraints as Assert;

#[ORM\Table(name: 'c_shortcut')]
#[ORM\Entity(repositoryClass: CShortcutRepository::class)]
class CShortcut extends AbstractResource implements ResourceInterface, Stringable
{
    #[ORM\Column(name: 'id', type: 'integer')]
    #[ORM\Id]
    #[ORM\GeneratedValue]
    protected ?int $id = null;

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

    #[ORM\OneToOne(targetEntity: ResourceNode::class, inversedBy: 'shortCut')]
    #[ORM\JoinColumn(name: 'shortcut_node_id', referencedColumnName: 'id', onDelete: 'CASCADE')]
    protected ResourceNode $shortCutNode;

    #[Groups(['cshortcut:read'])]
    protected string $url;

    #[Groups(['cshortcut:read'])]
    protected string $tool;

    #[Groups(['cshortcut:read'])]
    protected string $type;

    #[Groups(['cshortcut:read'])]
    private ?string $customImageUrl = null;

    #[Groups(['cshortcut:read'])]
    public ?string $target = null;

    /**
     * Optional custom URL to override the default /r/.../link format.
     * Example (for blogs): /resources/blog/{courseNodeId}/{blogId}/posts?cid=...&sid=...&gid=0
     */
    #[Groups(['cshortcut:read'])]
    private ?string $urlOverride = null;

    /**
     * Optional icon name (e.g., 'mdi-notebook-outline' for CBlog).
     */
    #[Groups(['cshortcut:read'])]
    private ?string $icon = null;

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

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

    }

    public function getResourceIdentifier(): int
    {
        return $this->id;

    }

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

    public function setResourceName(string $name): self
    {
        return $this->setTitle($name);
    }

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

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

        return $this;
    }

    public function getShortCutNode(): ResourceNode
    {
        return $this->shortCutNode;
    }

    public function setShortCutNode(ResourceNode $shortCutNode): self
    {
        $this->shortCutNode = $shortCutNode;

        return $this;
    }

    /**
     * Main URL for the shortcut:
     * - If a custom URL was set (e.g., for CBlog), return that one.
     * - Otherwise, fallback to the legacy /r/{tool}/{type}/{nodeId}/link pattern.
     */
    public function getUrl(): string
    {
        if (!empty($this->urlOverride)) {
            return $this->urlOverride;
        }

        return '/r/'.
            $this->getShortCutNode()->getResourceType()->getTool()->getTitle().'/'.
            $this->getShortCutNode()->getResourceType()->getTitle().'/'.
            $this->getShortCutNode()->getId().
            '/link';
    }

    /**
     * Tool name (derived from the shortcut node).
     */
    public function getTool(): string
    {
        return $this->getShortCutNode()
            ->getResourceType()
            ->getTool()
            ->getTitle();
    }

    /**
     * Resource type name (derived from the shortcut node).
     */
    public function getType(): string
    {
        return $this->getShortCutNode()
            ->getResourceType()
            ->getTitle();
    }

    public function getCustomImageUrl(): ?string
    {
        return $this->customImageUrl;
    }

    public function setCustomImageUrl(?string $customImageUrl): self
    {
        $this->customImageUrl = $customImageUrl;

        return $this;
    }

    /**
     * Set a custom URL that will be returned by getUrl().
     * Use it, for example, to point a CBlog shortcut to:
     *   /resources/blog/{courseNodeId}/{blogId}/posts?cid=...&sid=...&gid=0
     */
    public function setUrlOverride(?string $url): self
    {
        $this->urlOverride = $url;

        return $this;
    }

    public function getUrlOverride(): ?string
    {
        return $this->urlOverride;
    }

    /**
     * Set an icon name (e.g., 'mdi-notebook-outline').
     */
    public function setIcon(?string $icon): self
    {
        $this->icon = $icon;

        return $this;
    }

    public function getIcon(): ?string
    {
        return $this->icon;
    }
}


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 Chamilo\CoreBundle\Entity\AbstractResource;
10			use Chamilo\CoreBundle\Entity\ResourceInterface;
11			use Chamilo\CoreBundle\Entity\ResourceNode;
12			use Chamilo\CourseBundle\Repository\CShortcutRepository;
13			use Doctrine\ORM\Mapping as ORM;
14			use Stringable;
15			use Symfony\Component\Serializer\Annotation\Groups;
16			use Symfony\Component\Validator\Constraints as Assert;
17
18			#[ORM\Table(name: 'c_shortcut')]
19			#[ORM\Entity(repositoryClass: CShortcutRepository::class)]
20			class CShortcut extends AbstractResource implements ResourceInterface, Stringable
21			{
22			#[ORM\Column(name: 'id', type: 'integer')]
23			#[ORM\Id]
24			#[ORM\GeneratedValue]
25			protected ?int $id = null;
26
27			#[Assert\NotBlank]
28			#[Groups(['cshortcut:read'])]
29			#[ORM\Column(name: 'title', type: 'string', length: 255, nullable: false)]
30			protected string $title;
31
32			#[ORM\OneToOne(targetEntity: ResourceNode::class, inversedBy: 'shortCut')]
33			#[ORM\JoinColumn(name: 'shortcut_node_id', referencedColumnName: 'id', onDelete: 'CASCADE')]
34			protected ResourceNode $shortCutNode;
35
36			#[Groups(['cshortcut:read'])]
37			protected string $url;
38
39			#[Groups(['cshortcut:read'])]
40			protected string $tool;
41
42			#[Groups(['cshortcut:read'])]
43			protected string $type;
44
45			#[Groups(['cshortcut:read'])]
46			private ?string $customImageUrl = null;
47
48			#[Groups(['cshortcut:read'])]
49			public ?string $target = null;
50
51			/**
52			* Optional custom URL to override the default /r/.../link format.
53			* Example (for blogs): /resources/blog/{courseNodeId}/{blogId}/posts?cid=...&sid=...&gid=0
54			*/
55			#[Groups(['cshortcut:read'])]
56			private ?string $urlOverride = null;
57
58			/**
59			* Optional icon name (e.g., 'mdi-notebook-outline' for CBlog).
60			*/
61			#[Groups(['cshortcut:read'])]
62			private ?string $icon = null;
63
64			public function __toString(): string
65			{
66			return $this->getTitle();
67			}
68
69			public function getId(): int
70			{
71			return $this->id;
			0 ignored issues – show Bug Best Practice introduced 2022-05-25 14:30 UTC by Report Bug Copy Issue Report The expression `return $this->id` could return the type `null` which is incompatible with the type-hinted return `integer`. Consider adding an additional type-check to rule them out. Loading history...
72			}
73
74			public function getResourceIdentifier(): int
75			{
76			return $this->id;
			0 ignored issues – show Bug Best Practice introduced 2022-05-25 14:30 UTC by Report Bug Copy Issue Report The expression `return $this->id` could return the type `null` which is incompatible with the type-hinted return `integer`. Consider adding an additional type-check to rule them out. Loading history...
77			}
78
79			public function getResourceName(): string
80			{
81			return $this->getTitle();
82			}
83
84			public function setResourceName(string $name): self
85			{
86			return $this->setTitle($name);
87			}
88
89			public function getTitle(): string
90			{
91			return $this->title;
92			}
93
94			public function setTitle(string $title): self
95			{
96			$this->title = $title;
97
98			return $this;
99			}
100
101			public function getShortCutNode(): ResourceNode
102			{
103			return $this->shortCutNode;
104			}
105
106			public function setShortCutNode(ResourceNode $shortCutNode): self
107			{
108			$this->shortCutNode = $shortCutNode;
109
110			return $this;
111			}
112
113			/**
114			* Main URL for the shortcut:
115			* - If a custom URL was set (e.g., for CBlog), return that one.
116			* - Otherwise, fallback to the legacy /r/{tool}/{type}/{nodeId}/link pattern.
117			*/
118			public function getUrl(): string
119			{
120			if (!empty($this->urlOverride)) {
121			return $this->urlOverride;
122			}
123
124			return '/r/'.
125			$this->getShortCutNode()->getResourceType()->getTool()->getTitle().'/'.
126			$this->getShortCutNode()->getResourceType()->getTitle().'/'.
127			$this->getShortCutNode()->getId().
128			'/link';
129			}
130
131			/**
132			* Tool name (derived from the shortcut node).
133			*/
134			public function getTool(): string
135			{
136			return $this->getShortCutNode()
137			->getResourceType()
138			->getTool()
139			->getTitle();
140			}
141
142			/**
143			* Resource type name (derived from the shortcut node).
144			*/
145			public function getType(): string
146			{
147			return $this->getShortCutNode()
148			->getResourceType()
149			->getTitle();
150			}
151
152			public function getCustomImageUrl(): ?string
153			{
154			return $this->customImageUrl;
155			}
156
157			public function setCustomImageUrl(?string $customImageUrl): self
158			{
159			$this->customImageUrl = $customImageUrl;
160
161			return $this;
162			}
163
164			/**
165			* Set a custom URL that will be returned by getUrl().
166			* Use it, for example, to point a CBlog shortcut to:
167			* /resources/blog/{courseNodeId}/{blogId}/posts?cid=...&sid=...&gid=0
168			*/
169			public function setUrlOverride(?string $url): self
170			{
171			$this->urlOverride = $url;
172
173			return $this;
174			}
175
176			public function getUrlOverride(): ?string
177			{
178			return $this->urlOverride;
179			}
180
181			/**
182			* Set an icon name (e.g., 'mdi-notebook-outline').
183			*/
184			public function setIcon(?string $icon): self
185			{
186			$this->icon = $icon;
187
188			return $this;
189			}
190
191			public function getIcon(): ?string
192			{
193			return $this->icon;
194			}
195			}
196

chamilo / chamilo-lms

Push — master ( e9e739...1e7f19 )

CShortcut::getUrlOverride() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like