AttributeController::getManager()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
rs 10
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 0
1
<?php
2
/*
3
 * WellCommerce Open-Source E-Commerce Platform
4
 *
5
 * This file is part of the WellCommerce package.
6
 *
7
 * (c) Adam Piotrowski <[email protected]>
8
 *
9
 * For the full copyright and license information,
10
 * please view the LICENSE file that was distributed with this source code.
11
 */
12
13
namespace WellCommerce\Bundle\CatalogBundle\Controller\Admin;
14
15
use Symfony\Component\HttpFoundation\JsonResponse;
16
use Symfony\Component\HttpFoundation\Request;
17
use Symfony\Component\HttpFoundation\Response;
18
use WellCommerce\Bundle\CatalogBundle\Manager\AttributeManager;
19
use WellCommerce\Bundle\CoreBundle\Controller\Admin\AbstractAdminController;
20
21
/**
22
 * Class AttributeController
23
 *
24
 * @author  Adam Piotrowski <[email protected]>
25
 */
26
class AttributeController extends AbstractAdminController
27
{
28
    /**
29
     * Ajax action for listing attributes in variants editor
30
     *
31
     * @param Request $request
32
     *
33
     * @return Response
34
     */
35
    public function ajaxIndexAction(Request $request): Response
36
    {
37
        if (!$request->isXmlHttpRequest()) {
38
            return $this->redirectToAction('index');
39
        }
40
        
41
        $attributeGroupId = (int)$request->request->get('id');
42
        $attributeGroup   = $this->getManager()->findAttributeGroup($attributeGroupId);
43
        
44
        return $this->jsonResponse([
45
            'attributes' => $this->getManager()->getRepository()->getAttributeSet($attributeGroup),
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface WellCommerce\Bundle\Core...ory\RepositoryInterface as the method getAttributeSet() does only exist in the following implementations of said interface: WellCommerce\Bundle\Cata...ory\AttributeRepository.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
46
        ]);
47
    }
48
    
49
    /**
50
     * Adds new attribute value using ajax request
51
     *
52
     * @param Request $request
53
     *
54
     * @return Response
55
     */
56
    public function ajaxAddAction(Request $request): Response
57
    {
58
        if (!$request->isXmlHttpRequest()) {
59
            return $this->redirectToAction('index');
60
        }
61
        
62
        $attributeName    = $request->request->get('name');
63
        $attributeGroupId = (int)$request->request->get('set');
64
        
65
        try {
66
            $attribute = $this->getManager()->createAttribute($attributeName, $attributeGroupId);
67
            
68
            return $this->jsonResponse([
69
                'id' => $attribute->getId(),
70
            ]);
71
            
72
        } catch (\Exception $e) {
73
            
74
            return $this->jsonResponse([
75
                'error' => $e->getMessage(),
76
            ]);
77
        }
78
    }
79
    
80
    public function ajaxGenerateCartesianAction(Request $request): JsonResponse
81
    {
82
        $attributes    = $request->request->get('attributes');
83
        $attributesMap = [];
84
        
85
        foreach ($attributes as $attribute) {
86
            $attributesMap[$attribute['attribute']][] = $attribute['value'];
87
        }
88
        
89
        $variantsCombinations = $this->generateCartesianProduct($attributesMap);
90
        
91
        return $this->jsonResponse([
92
            'variants' => $variantsCombinations,
93
        ]);
94
    }
95
    
96
    protected function getManager(): AttributeManager
97
    {
98
        return parent::getManager();
99
    }
100
    
101
    private function generateCartesianProduct(array $input): array
102
    {
103
        $result = [];
104
        
105
        while (list($key, $values) = each($input)) {
106
            if (empty($values)) {
107
                continue;
108
            }
109
            
110
            if (empty($result)) {
111
                foreach ($values as $value) {
112
                    $result[] = [$key => $value];
113
                }
114
            } else {
115
                $append = [];
116
                
117
                foreach ($result as &$product) {
118
                    $product[$key] = array_shift($values);
119
                    $copy          = $product;
120
                    
121
                    foreach ($values as $item) {
122
                        $copy[$key] = $item;
123
                        $append[]   = $copy;
124
                    }
125
                    
126
                    array_unshift($values, $product[$key]);
127
                }
128
                
129
                $result = array_merge($result, $append);
130
            }
131
        }
132
        
133
        return $result;
134
    }
135
}
136