Completed
Pull Request — master (#34)
by Igor
04:25
created

ProductsAwareTrait::hasProducts()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 1
nc 1
nop 0
dl 0
loc 3
rs 10
c 0
b 0
f 0
1
<?php
2
3
declare(strict_types=1);
4
5
namespace Loevgaard\SyliusBrandPlugin\Entity;
6
7
use Doctrine\Common\Collections\ArrayCollection;
8
use Doctrine\Common\Collections\Collection;
9
use Sylius\Component\Core\Model\ProductInterface;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, Loevgaard\SyliusBrandPlu...Entity\ProductInterface. Consider defining an alias.

Let?s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let?s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
10
11
trait ProductsAwareTrait
12
{
13
    /** @var Collection|BrandAwareInterface[]|ProductInterface[] */
14
    protected $products;
15
16
    /**
17
     * {@inheritdoc}
18
     */
19
    public function initializeProductsCollection(): void
20
    {
21
        $this->products = new ArrayCollection();
22
    }
23
24
    /**
25
     * {@inheritdoc}
26
     */
27
    public function hasProducts(): bool
28
    {
29
        return $this->products->count() > 0;
30
    }
31
32
    /**
33
     * {@inheritdoc}
34
     */
35
    public function getProducts(): Collection
36
    {
37
        return $this->products;
0 ignored issues
show
Bug Best Practice introduced by
The expression return $this->products could return the type Loevgaard\SyliusBrandPlu...odel\ProductInterface[] which is incompatible with the type-hinted return Doctrine\Common\Collections\Collection. Consider adding an additional type-check to rule them out.
Loading history...
38
    }
39
40
    /**
41
     * {@inheritdoc}
42
     */
43
    public function hasProduct(BrandAwareInterface $product): bool
44
    {
45
        return $this->products->contains($product);
46
    }
47
48
    /**
49
     * {@inheritdoc}
50
     */
51
    public function addProduct(BrandAwareInterface $product): void
52
    {
53
        if (false === $this->hasProduct($product)) {
54
            /** @var ProductsAwareInterface $this */
55
            $product->setBrand($this);
56
            $this->products->add($product);
0 ignored issues
show
Bug introduced by
Accessing products on the interface Loevgaard\SyliusBrandPlu...\ProductsAwareInterface suggest that you code against a concrete implementation. How about adding an instanceof check?
Loading history...
57
        }
58
    }
59
60
    /**
61
     * {@inheritdoc}
62
     */
63
    public function removeProduct(BrandAwareInterface $product): void
64
    {
65
        if (true === $this->hasProduct($product)) {
66
            $product->setBrand(null);
67
            $this->products->removeElement($product);
68
        }
69
    }
70
}
71