ComponentCollection::setLocation() - Code Metrics - Inspection of "Add a location field for component collections. Fr..." - components-web-app/api-components-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 5558e1...346da5 )

by Daniel

created 2020-06-18 17:45 UTC

ComponentCollection::setLocation() A

↳ Parent: ComponentCollection

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\Core\Annotation\ApiResource;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Silverback\ApiComponentsBundle\Annotation as Silverback;
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;

/**
 * @author Daniel West <[email protected]>
 *
 * @Silverback\Timestamped
 * @ApiResource(
 *     mercure=true,
 *     normalizationContext={ "groups"={"ComponentCollection:read"} },
 *     denormalizationContext={ "groups"={"ComponentCollection:write"} }
 * )
 * @UniqueEntity(fields={"reference"}, message="There is already a ComponentCollection resource with that reference.")
 */
class ComponentCollection
{
    use IdTrait;
    use TimestampedTrait;

    /**
     * @Assert\NotBlank(message="The reference cannot be blank.")
     * @Groups({"ComponentCollection:read", "ComponentCollection:write"})
     */
    public string $reference;

    /**
     * @Assert\NotBlank(message="The location cannot be blank.")
     * @Groups({"ComponentCollection:read", "ComponentCollection:write"})
     */
    public string $location;

    /**
     * @var Collection|Layout[]
     * @Groups({"ComponentCollection:read", "ComponentCollection:write"})
     */
    public $layouts;

    /**
     * @var Collection|Page[]
     * @Groups({"ComponentCollection:read", "ComponentCollection:write"})
     */
    public Collection $pages;

    /**
     * @var Collection|AbstractComponent[]
     * @Groups({"ComponentCollection:read", "ComponentCollection:write"})
     */
    public Collection $components;

    /**
     * @var Collection|ComponentPosition[]
     * @Groups({"ComponentCollection:read", "ComponentCollection:write"})
     */
    public Collection $componentPositions;

    /**
     * @Groups({"ComponentCollection:read", "ComponentCollection:write"})
     */
    public ?Collection $allowedComponents = null;

    public function __construct()
    {
        $this->layouts = new ArrayCollection();
        $this->pages = new ArrayCollection();
        $this->components = new ArrayCollection();
        $this->componentPositions = new ArrayCollection();
    }

    public function setReference(string $reference): self
    {
        $this->reference = $reference;

        return $this;
    }

    public function setLocation(string $location): self
    {
        $this->location = $location;

        return $this;
    }

    public function setLayouts(iterable $layouts): self
    {
        $this->layouts = new ArrayCollection();
        foreach ($layouts as $layout) {
            $this->addLayout($layout);
        }

        return $this;
    }

    public function addLayout(Layout $layout): self
    {
        if (!$this->layouts->contains($layout)) {
            $this->layouts->add($layout);
            $layout->addComponentCollection($this);
        }

        return $this;
    }

    public function setPages(iterable $pages): self
    {
        $this->pages = new ArrayCollection();
        foreach ($pages as $page) {
            $this->addPage($page);
        }

        return $this;
    }

    public function addPage(Page $page): self
    {
        if (!$this->pages->contains($page)) {
            $this->pages->add($page);
            $page->addComponentCollection($this);
        }

        return $this;
    }

    public function setComponents(iterable $components): self
    {
        $this->components = new ArrayCollection();
        foreach ($components as $component) {
            $this->addComponent($component);
        }

        return $this;
    }

    public function addComponent(AbstractComponent $component): self
    {
        if (!$this->components->contains($component)) {
            $this->components->add($component);
            $component->addComponentCollection($this);
        }

        return $this;
    }

    public function setComponentPositions(iterable $componentPositions): self
    {
        $this->componentPositions = new ArrayCollection();
        foreach ($componentPositions as $componentPosition) {
            $this->addComponentPosition($componentPosition);
        }

        return $this;
    }

    public function addComponentPosition(ComponentPosition $componentPosition): self
    {
        if (!$this->componentPositions->contains($componentPosition)) {
            $this->componentPositions->add($componentPosition);
        }

        return $this;
    }

    public function setAllowedComponents(iterable $allowedComponents): self
    {
        $this->allowedComponents = new ArrayCollection();
        foreach ($allowedComponents as $componentIri) {
            $this->addAllowedComponent($componentIri);
        }

        return $this;
    }

    public function addAllowedComponent(string $allowedComponent): self
    {
        $this->allowedComponents->add($allowedComponent);
                                  add($allowedComponent);

        return $this;
    }
}


components-web-app / api-components-bundle

Push — master ( 5558e1...346da5 )

ComponentCollection::setLocation() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like