Completed
Push — master ( ac3b8b...3c857d )
by Gaetano
18:21
created

LocationMatcher::findLocationsByLocationIds()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 10
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 6

Importance

Changes 0
Metric Value
dl 0
loc 10
c 0
b 0
f 0
rs 9.4285
ccs 0
cts 5
cp 0
cc 2
eloc 5
nc 2
nop 1
crap 6
1
<?php
2
3
namespace Kaliop\eZMigrationBundle\Core\Matcher;
4
5
use eZ\Publish\API\Repository\Values\Content\Query;
6
use Kaliop\eZMigrationBundle\API\Collection\LocationCollection;
7
use eZ\Publish\API\Repository\Values\Content\LocationQuery;
8
use eZ\Publish\API\Repository\Values\Content\Location;
9
10
class LocationMatcher extends QueryBasedMatcher
11
{
12
    use FlexibleKeyMatcherTrait;
13
14
    const MATCH_DEPTH = 'depth';
15
    const MATCH_IS_MAIN_LOCATION = 'is_main_location';
16
    const MATCH_PRIORITY = 'priority';
17
18
    protected $allowedConditions = array(
19
        self::MATCH_AND, self::MATCH_OR, self::MATCH_NOT,
20
        self::MATCH_CONTENT_ID, self::MATCH_LOCATION_ID, self::MATCH_CONTENT_REMOTE_ID, self::MATCH_LOCATION_REMOTE_ID,
21
        self::MATCH_ATTRIBUTE, self::MATCH_CONTENT_TYPE_ID, self::MATCH_CONTENT_TYPE_IDENTIFIER, self::MATCH_GROUP,
22
        self::MATCH_CREATION_DATE, self::MATCH_MODIFICATION_DATE, self::MATCH_OBJECT_STATE, self::MATCH_OWNER,
23
        self::MATCH_PARENT_LOCATION_ID, self::MATCH_PARENT_LOCATION_REMOTE_ID, self::MATCH_SECTION, self::MATCH_SUBTREE,
24
        self::MATCH_VISIBILITY,
25
        // aliases
26
        'content_type', 'content_type_id', 'content_type_identifier',
27
        // location-only
28
        self::MATCH_DEPTH, self::MATCH_IS_MAIN_LOCATION, self::MATCH_PRIORITY,
29
    );
30
    protected $returns = 'Location';
31
32 1
    /**
33
     * @param array $conditions key: condition, value: int / string / int[] / string[]
34 1
     * @return LocationCollection
35
     */
36
    public function match(array $conditions)
37
    {
38
        return $this->matchLocation($conditions);
39
    }
40
41 1
    /**
42
     * @param array $conditions key: condition, value: value: int / string / int[] / string[]
43 1
     * @return LocationCollection
44
     */
45 1
    public function matchLocation(array $conditions)
46
    {
47 1
        $this->validateConditions($conditions);
48 1
49 1
        foreach ($conditions as $key => $values) {
50
51
            $query = new LocationQuery();
52 1
            $query->limit = PHP_INT_MAX;
53
            $query->filter = $this->getQueryCriterion($key, $values);
54
            $results = $this->repository->getSearchService()->findLocations($query);
55 1
56 1
            $locations = [];
57
            foreach ($results->searchHits as $result) {
58 1
                $locations[$result->valueObject->id] = $result->valueObject;
59
            }
60
61 1
            return new LocationCollection($locations);
62 1
        }
63
    }
64
65
    /**
66
     * When matching by key, we accept location Id and remote Id only
67
     * @param int|string $key
68
     * @return array
69
     */
70
    protected function getConditionsFromKey($key)
71
    {
72
        if (is_int($key) || ctype_digit($key)) {
73
            return array(self::MATCH_LOCATION_ID => $key);
74
        }
75
        return array(self::MATCH_LOCATION_REMOTE_ID => $key);
76
    }
77
78
    protected function getQueryCriterion($key, $values)
79
    {
80
        if (!is_array($values)) {
81
            $values = array($values);
82
        }
83
84
        switch ($key) {
85 View Code Duplication
            case self::MATCH_DEPTH:
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
86
                $match = reset($values);
87
                $operator = key($values);
88
                if (!isset(self::$operatorsMap[$operator])) {
89
                    throw new \Exception("Can not use '$operator' as comparison operator for depth");
90
                }
91
                return new Query\Criterion\Location\Depth(self::$operatorsMap[$operator], $match);
0 ignored issues
show
Bug Best Practice introduced by
The return type of return new \eZ\Publish\A...ap[$operator], $match); (eZ\Publish\API\Repositor...riterion\Location\Depth) is incompatible with the return type of the parent method Kaliop\eZMigrationBundle...cher::getQueryCriterion of type eZ\Publish\API\Repositor...ry\Criterion\LogicalNot.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

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

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
92
93 View Code Duplication
            case self::MATCH_IS_MAIN_LOCATION:
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
Coding Style introduced by
There must be a comment when fall-through is intentional in a non-empty case body
Loading history...
94
                /// @todo error/warning if there is more than 1 value...
95
                $value = reset($values);
96
                if ($value) {
97
                    return new Query\Criterion\Location\IsMainLocation(Query\Criterion\Location\IsMainLocation::MAIN);
0 ignored issues
show
Bug Best Practice introduced by
The return type of return new \eZ\Publish\A...\IsMainLocation::MAIN); (eZ\Publish\API\Repositor...Location\IsMainLocation) is incompatible with the return type of the parent method Kaliop\eZMigrationBundle...cher::getQueryCriterion of type eZ\Publish\API\Repositor...ry\Criterion\LogicalNot.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

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

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
98
                } else {
99
                    return new Query\Criterion\Location\IsMainLocation(Query\Criterion\Location\IsMainLocation::NOT_MAIN);
0 ignored issues
show
Bug Best Practice introduced by
The return type of return new \eZ\Publish\A...ainLocation::NOT_MAIN); (eZ\Publish\API\Repositor...Location\IsMainLocation) is incompatible with the return type of the parent method Kaliop\eZMigrationBundle...cher::getQueryCriterion of type eZ\Publish\API\Repositor...ry\Criterion\LogicalNot.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

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

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
100
                }
101
102 View Code Duplication
            case self::MATCH_PRIORITY:
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
103
                $match = reset($values);
104
                $operator = key($values);
105
                if (!isset(self::$operatorsMap[$operator])) {
106
                    throw new \Exception("Can not use '$operator' as comparison operator for depth");
107
                }
108
                return new Query\Criterion\Location\Priority(self::$operatorsMap[$operator], $match);
0 ignored issues
show
Bug Best Practice introduced by
The return type of return new \eZ\Publish\A...ap[$operator], $match); (eZ\Publish\API\Repositor...erion\Location\Priority) is incompatible with the return type of the parent method Kaliop\eZMigrationBundle...cher::getQueryCriterion of type eZ\Publish\API\Repositor...ry\Criterion\LogicalNot.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

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

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
109
        }
110
111
        return parent::getQueryCriterion($key, $values);
112
    }
113 1
114
    /**
115 1
     * Returns all locations of a set of objects
116
     *
117 1
     * @param int[] $contentIds
118 1
     * @return Location[]
119 1
     * @deprecated
120
     */
121 1 View Code Duplication
    protected function findLocationsByContentIds(array $contentIds)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
122
    {
123
        $locations = [];
124
125
        foreach ($contentIds as $contentId) {
126
            $content = $this->repository->getContentService()->loadContent($contentId);
127
            foreach($this->repository->getLocationService()->loadLocations($content->contentInfo) as $location) {
128 1
                $locations[$location->id] = $location;
129
            }
130 1
        }
131
132 1
        return $locations;
133 1
    }
134 1
135
    /**
136 1
     * Returns all locations of a set of objects
137
     *
138
     * @param int[] $remoteContentIds
139
     * @return Location[]
140
     * @deprecated
141
     */
142 View Code Duplication
    protected function findLocationsByContentRemoteIds(array $remoteContentIds)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
143
    {
144
        $locations = [];
145
146
        foreach ($remoteContentIds as $remoteContentId) {
147
            $content = $this->repository->getContentService()->loadContentByRemoteId($remoteContentId);
148
            foreach($this->repository->getLocationService()->loadLocations($content->contentInfo) as $location) {
149
                $locations[$location->id] = $location;
150
            }
151
        }
152
153
        return $locations;
154
    }
155
156
    /**
157
     * @param int[] $locationIds
158
     * @return Location[]
159
     * @deprecated
160
     */
161
    protected function findLocationsByLocationIds(array $locationIds)
162
    {
163
        $locations = [];
164
165
        foreach ($locationIds as $locationId) {
166
            $locations[$locationId] = $this->repository->getLocationService()->loadLocation($locationId);
167
        }
168
169
        return $locations;
170
    }
171
172
    /**
173
     * @param int[] $locationRemoteIds
174
     * @return Location[]
175
     * @deprecated
176
     */
177
    protected function findLocationsByLocationRemoteIds($locationRemoteIds)
178
    {
179
        $locations = [];
180
181
        foreach ($locationRemoteIds as $locationRemoteId) {
182
            $location = $this->repository->getLocationService()->loadLocationByRemoteId($locationRemoteId);
183
            $locations[$location->id] = $location;
184
        }
185
186
        return $locations;
187
    }
188
189
    /**
190
     * @param int[] $parentLocationIds
191
     * @return Location[]
192
     * @deprecated
193
     */
194 View Code Duplication
    protected function findLocationsByParentLocationIds($parentLocationIds)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
195
    {
196
        $query = new LocationQuery();
197
        $query->limit = PHP_INT_MAX;
198
        $query->filter = new Query\Criterion\ParentLocationId($parentLocationIds);
199
200
        $results = $this->repository->getSearchService()->findLocations($query);
201
202
        $locations = [];
203
204
        foreach ($results->searchHits as $result) {
205
            $locations[$result->valueObject->id] = $result->valueObject;
206
        }
207
208
        return $locations;
209
    }
210
211
    /**
212
     * @param int[] $parentLocationRemoteIds
213
     * @return Location[]
214
     * @deprecated
215
     */
216 View Code Duplication
    protected function findLocationsByParentLocationRemoteIds($parentLocationRemoteIds)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
217
    {
218
        $locationIds = [];
219
220
        foreach ($parentLocationRemoteIds as $parentLocationRemoteId) {
221
            $location = $this->repository->getLocationService()->loadLocationByRemoteId($parentLocationRemoteId);
222
            $locationIds[$location->id] = $location->id;
223
        }
224
225
        return $this->findLocationsByParentLocationIds($locationIds);
0 ignored issues
show
Deprecated Code introduced by
The method Kaliop\eZMigrationBundle...nsByParentLocationIds() has been deprecated.

This method has been deprecated.

Loading history...
226
    }
227
}
228