Route::setPath() - Code Metrics - Inspection of "Update interfaces, disable data transformers, upda..." - components-web-app/api-components-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — main (#140)

by Daniel

created 2022-05-14 01:33 UTC

Route::setPath() A

↳ Parent: Route

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	5
ccs	0
cts	3
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php

/*
 * This file is part of the Silverback API Components Bundle Project
 *
 * (c) Daniel West <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Silverback\ApiComponentsBundle\Entity\Core;

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 Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Silverback\ApiComponentsBundle\Annotation as Silverback;
use Silverback\ApiComponentsBundle\DataProvider\StateProvider\RouteStateProvider;
use Silverback\ApiComponentsBundle\Entity\Utility\IdTrait;
use Silverback\ApiComponentsBundle\Entity\Utility\TimestampedTrait;
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
use Symfony\Component\Serializer\Annotation\Groups;
use Symfony\Component\Validator\Constraints as Assert;

const REQUIREMENTS = ['id' => '(.+)'];
const SECURITY = "is_granted('read_route', object)";

/**
 * Although a user will be able to get the routes and the tree of data down to getting the ID for a component
 * fetching a component will be restricted based on the route it is within.
 *
 * @author Daniel West <[email protected]>
 */
#[Assert\Expression(
    '!(this.getPage() == null & this.getPageData() == null & this.getRedirect() == null)',
    message: 'Please specify either page, pageData or redirect.',
    groups: ['Route:generate:write', 'Default']
)]
#[Assert\Expression(
    '!(this.getPage() != null & this.getPageData() != null)',
    message: 'Please specify either page or pageData, not both.',
    groups: ['Route:generate:write', 'Default']
)]
#[UniqueEntity('name', 'This route name is already in use.')]
#[UniqueEntity('path', 'This path is already in use.')]
#[ApiResource(
    mercure: true,
    provider: RouteStateProvider::class
)]
#[Post]
#[GetCollection]
#[Delete(requirements: REQUIREMENTS, security: SECURITY)]
#[Put(requirements: REQUIREMENTS, security: SECURITY)]
#[Patch(requirements: REQUIREMENTS, security: SECURITY)]
#[Get(requirements: ['id' => "(?!.+\/redirects$).+"], security: SECURITY)]
#[Post(uriTemplate: '/routes/generate.{_format}', validationContext: ['groups' => ['Route:generate:write']], name: 'generate')]
#[Get(uriTemplate: '/routes/{id}/redirects.{_format}', defaults: ['_api_item_operation_name' => 'route_redirects'], requirements: REQUIREMENTS, normalizationContext: ['groups' => ['Route:redirect:read']], security: SECURITY, name: 'redirects')]
#[Silverback\Timestamped]
class Route
{
    use IdTrait;
    use TimestampedTrait;

    #[Assert\NotBlank]
    #[Groups(['Route:redirect:read'])]
    private string $path = '';

    #[Assert\NotNull]
    private string $name;

    private ?Route $redirect = null;

    #[Groups(['Route:redirect:read'])]
    private Collection $redirectedFrom;

    private ?Page $page = null;

    private ?AbstractPageData $pageData = null;

    public function __construct()
    {
        $this->redirectedFrom = new ArrayCollection();
    }

    public function getPath(): string
    {
        return $this->path;
    }

    public function setPath(string $path): self
    {
        $this->path = $path;

        return $this;
    }

    public function getName(): string
    {
        return $this->name;
    }

    public function setName(string $name): self
    {
        $this->name = $name;

        return $this;
    }

    public function getRedirect(): ?self
    {
        return $this->redirect;
    }

    public function setRedirect(?self $redirect): self
    {
        $this->redirect = $redirect;
        if ($redirect) {
            $redirect->addRedirectedFrom($this);
        }

        return $this;
    }

    /**
     * @return Collection|Route[]
     */
    public function getRedirectedFrom()
    {
        return $this->redirectedFrom;
    }

    /**
     * @param array|Collection $redirectedFrom
     */
    public function setRedirectedFrom($redirectedFrom): self
    {
        $isArray = \is_array($redirectedFrom);
        if (!$isArray && !$redirectedFrom instanceof Collection) {

            throw new \InvalidArgumentException('setRedirectedFrom requires an array or Collection');
        }
        $this->redirectedFrom = $isArray ? new ArrayCollection($redirectedFrom) : $redirectedFrom;
        $this->redirectedFrom = $isArray ? new ArrayCollection(/** @scrutinizer ignore-type */ $redirectedFrom) : $redirectedFrom;

        return $this;
    }

    public function addRedirectedFrom(self $redirectedFrom): self
    {
        if (!$this->redirectedFrom->contains($redirectedFrom)) {
            $this->redirectedFrom->add($redirectedFrom);
        }

        return $this;
    }

    public function getPage(): ?Page
    {
        return $this->page;
    }

    public function setPage(?Page $page): self
    {
        $this->page = $page;
        if ($this->page) {
            $this->page->setRoute($this);
        }

        return $this;
    }

    public function getPageData(): ?AbstractPageData
    {
        return $this->pageData;
    }

    public function setPageData(?AbstractPageData $pageData): self
    {
        $this->pageData = $pageData;
        if ($this->pageData) {
            $this->pageData->setRoute($this);
        }

        return $this;
    }
}


components-web-app / api-components-bundle

Pull Request — main (#140)

Route::setPath() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like