ElasticsearchActivityStorage::findByParent() - Code Metrics - Inspection of "Feature/setup" - sulu/activity-log-elasticsearch - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1)

unknown

created 2017-05-24 12:40 UTC

ElasticsearchActivityStorage::findByParent() A

↳ Parent: ElasticsearchActivityStorage

Complexity

Conditions	2
Paths	2

Size

Total Lines	12
Code Lines	7

Duplication

Lines	12
Ratio	100 %

Importance

Changes

Metric	Value
dl	12
loc	12
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	7
nc	2
nop	3

<?php

/*
 * This file is part of Sulu.
 *
 * (c) MASSIVE ART WebServices GmbH
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Sulu\Bundle\ElasticsearchActivityLogBundle\Storage;

use ONGR\ElasticsearchBundle\Service\Manager;
use ONGR\ElasticsearchBundle\Service\Repository;
use ONGR\ElasticsearchDSL\Aggregation\Bucketing\TermsAggregation;
use ONGR\ElasticsearchDSL\Query\Compound\BoolQuery;
use ONGR\ElasticsearchDSL\Query\MatchAllQuery;
use ONGR\ElasticsearchDSL\Query\TermLevel\TermQuery;
use ONGR\ElasticsearchDSL\Query\TermLevel\WildcardQuery;
use ONGR\ElasticsearchDSL\Search;
use ONGR\ElasticsearchDSL\Sort\FieldSort;
use Sulu\Bundle\ElasticsearchActivityLogBundle\Document\ActivityLoggerViewDocument;
use Sulu\Component\ActivityLog\Model\ActivityLogInterface;
use Sulu\Component\ActivityLog\Repository\UserRepositoryInterface;
use Sulu\Component\ActivityLog\Storage\ActivityLogStorageInterface;

/**
 * Implements activity-storage with elasticsearch.
 */
class ElasticsearchActivityStorage implements ActivityLogStorageInterface
{
    /**
     * @var Manager
     */
    private $manager;

    /**
     * @var Repository
     */
    private $repository;

    /**
     * @var UserRepositoryInterface
     */
    private $userRepository;

    /**
     * @param Manager $manager
     * @param UserRepositoryInterface $userRepository
     */
    public function __construct(Manager $manager, UserRepositoryInterface $userRepository)
    {
        $this->manager = $manager;
        $this->repository = $manager->getRepository(ActivityLoggerViewDocument::class);
        $this->userRepository = $userRepository;
    }

    /**
     * {@inheritdoc}
     */
    public function create($type, $uuid = null)
    {
        return new ActivityLoggerViewDocument($type, $uuid);
    }

    /**
     * {@inheritdoc}
     */
    public function find($uuid)
    {
        /** @var ActivityLoggerViewDocument $activityLog */
        $activityLog = $this->repository->find($uuid);

        if ($activityLog->getCreatorId()) {
            $activityLog->setCreator($this->userRepository->find($activityLog->getCreatorId()));
        }

        if ($activityLog->getParentUuid()) {
            $activityLog->setParent($this->find($activityLog->getParentUuid()));
        }

        return $activityLog;
    }

    /**
     * {@inheritdoc}
     */
    public function findAll($page = 1, $pageSize = null)

    {
        $search = $this->repository->createSearch()->addQuery(new MatchAllQuery());

        if (!$pageSize) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            $search->setScroll('10m');
        } else {
            $search = $search->setFrom(($page - 1) * $pageSize)->setSize($pageSize);
        }

        return $this->execute($search);
    }

    /**
     * {@inheritdoc}
     */
    public function findAllWithSearch(
        $query = null,
        $fields = null,
        $page = 1,
        $pageSize = null,
        $sortColumn = null,
        $sortOrder = null
    ) {
        $search = $this->createQueryForSearch($query, $fields);

        if ($sortColumn && $sortOrder) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $search->addSort(new FieldSort($sortColumn . '.raw', $sortOrder));
        }

        if (!$pageSize) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            $search->setScroll('10m');
        } else {
            $search = $search->setFrom(($page - 1) * $pageSize)->setSize($pageSize);
        }

        return $this->execute($search);
    }

    /**
     * {@inheritdoc}
     */
    public function getCountForAllWithSearch($query = null, $fields = null)
    {
        $search = $this->createQueryForSearch($query, $fields);

        $search->setScroll('10m');

        return $this->repository->count($search);

    }

    /**
     * {@inheritdoc}
     */
    public function findByParent(ActivityLogInterface $activityLog, $page = 1, $pageSize = null)

    {
        $search = $this->repository->createSearch()->addQuery(new TermQuery('parentUuid', $activityLog->getUuid()));

        if (!$pageSize) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            $search->setScroll('10m');
        } else {
            $search->setFrom(($page - 1) * $pageSize)->setSize($pageSize);
        }

        return $this->execute($search);
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());
}
    }

    /**
     * {@inheritdoc}
     */
    public function persist(ActivityLogInterface $activityLog)
    {
        $this->manager->persist($activityLog);

        return $activityLog;
    }

    /**
     * {@inheritdoc}
     */
    public function flush()
    {
        $this->manager->commit();
        $this->manager->flush();
    }

    /**
     * Executes given search and append parents and creators.
     *
     * @param Search $search
     *
     * @return ResultIterator
     */
    private function execute(Search $search)
    {
        $search->addAggregation(new TermsAggregation('parentUuid', 'parentUuid'))
            ->addAggregation(new TermsAggregation('creatorId', 'creatorId'));

        $result = $this->repository->findDocuments($search);

        $aggregation = $result->getAggregation('parentUuid');
        $parentUuids = [];
        foreach ($aggregation->getBuckets() as $bucket) {
            $parentUuids[] = $bucket->getValue();
        }

        $parents = null;
        if (0 < count($parentUuids)) {
            $parents = $this->repository->findByIds($parentUuids);
        }

        $aggregation = $result->getAggregation('creatorId');
        $creatorIds = [];
        foreach ($aggregation->getBuckets() as $bucket) {
            $creatorIds[] = $bucket->getValue();
        }

        $creators = null;
        if (0 < count($creatorIds)) {
            $creators = $this->userRepository->findBy(['id' => $creatorIds]);
        }

        return iterator_to_array(new ResultIterator($result, $parents, $creators));
    }

    /**
     * @param string $query
     * @param array $fields
     *
     * @return Search
     */
    private function createQueryForSearch($query = null, $fields = null)
    {
        $search = $this->repository->createSearch()->addQuery(new MatchAllQuery());

        if (isset($query)) {
            $boolQuery = new BoolQuery();

            foreach ($fields as $field) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                $boolQuery->add(new WildcardQuery($field, '*' . $query . '*'), BoolQuery::SHOULD);
            }

            $search->addQuery($boolQuery);
        }

        return $search;
    }
}


1		<?php
2
3		/*
4		* This file is part of Sulu.
5		*
6		* (c) MASSIVE ART WebServices GmbH
7		*
8		* This source file is subject to the MIT license that is bundled
9		* with this source code in the file LICENSE.
10		*/
11
12		namespace Sulu\Bundle\ElasticsearchActivityLogBundle\Storage;
13
14		use ONGR\ElasticsearchBundle\Service\Manager;
15		use ONGR\ElasticsearchBundle\Service\Repository;
16		use ONGR\ElasticsearchDSL\Aggregation\Bucketing\TermsAggregation;
17		use ONGR\ElasticsearchDSL\Query\Compound\BoolQuery;
18		use ONGR\ElasticsearchDSL\Query\MatchAllQuery;
19		use ONGR\ElasticsearchDSL\Query\TermLevel\TermQuery;
20		use ONGR\ElasticsearchDSL\Query\TermLevel\WildcardQuery;
21		use ONGR\ElasticsearchDSL\Search;
22		use ONGR\ElasticsearchDSL\Sort\FieldSort;
23		use Sulu\Bundle\ElasticsearchActivityLogBundle\Document\ActivityLoggerViewDocument;
24		use Sulu\Component\ActivityLog\Model\ActivityLogInterface;
25		use Sulu\Component\ActivityLog\Repository\UserRepositoryInterface;
26		use Sulu\Component\ActivityLog\Storage\ActivityLogStorageInterface;
27
28		/**
29		* Implements activity-storage with elasticsearch.
30		*/
31		class ElasticsearchActivityStorage implements ActivityLogStorageInterface
32		{
33		/**
34		* @var Manager
35		*/
36		private $manager;
37
38		/**
39		* @var Repository
40		*/
41		private $repository;
42
43		/**
44		* @var UserRepositoryInterface
45		*/
46		private $userRepository;
47
48		/**
49		* @param Manager $manager
50		* @param UserRepositoryInterface $userRepository
51		*/
52		public function __construct(Manager $manager, UserRepositoryInterface $userRepository)
53		{
54		$this->manager = $manager;
55		$this->repository = $manager->getRepository(ActivityLoggerViewDocument::class);
56		$this->userRepository = $userRepository;
57		}
58
59		/**
60		* {@inheritdoc}
61		*/
62		public function create($type, $uuid = null)
63		{
64		return new ActivityLoggerViewDocument($type, $uuid);
65		}
66
67		/**
68		* {@inheritdoc}
69		*/
70		public function find($uuid)
71		{
72		/** @var ActivityLoggerViewDocument $activityLog */
73		$activityLog = $this->repository->find($uuid);
74
75		if ($activityLog->getCreatorId()) {
76		$activityLog->setCreator($this->userRepository->find($activityLog->getCreatorId()));
77		}
78
79		if ($activityLog->getParentUuid()) {
80		$activityLog->setParent($this->find($activityLog->getParentUuid()));
81		}
82
83		return $activityLog;
84		}
85
86		/**
87		* {@inheritdoc}
88		*/
89	View Code Duplication	public function findAll($page = 1, $pageSize = null)
		0 ignored issues – show Duplication introduced 2017-05-24 11:49 UTC by Report Bug Copy Issue Report 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...
90		{
91		$search = $this->repository->createSearch()->addQuery(new MatchAllQuery());
92
93		if (!$pageSize) {
		0 ignored issues – show Bug Best Practice introduced 2017-05-24 11:49 UTC by Report Bug Copy Issue Report The expression `$pageSize` of type `integer\|null` is loosely compared to `false`; this is ambiguous if the integer can be zero. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
94		$search->setScroll('10m');
95		} else {
96		$search = $search->setFrom(($page - 1) * $pageSize)->setSize($pageSize);
97		}
98
99		return $this->execute($search);
100		}
101
102		/**
103		* {@inheritdoc}
104		*/
105		public function findAllWithSearch(
106		$query = null,
107		$fields = null,
108		$page = 1,
109		$pageSize = null,
110		$sortColumn = null,
111		$sortOrder = null
112		) {
113		$search = $this->createQueryForSearch($query, $fields);
114
115		if ($sortColumn && $sortOrder) {
		0 ignored issues – show Bug Best Practice introduced 2017-05-24 11:49 UTC by Report Bug Copy Issue Report The expression `$sortColumn` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history... Bug Best Practice introduced 2017-05-24 11:49 UTC by Report Bug Copy Issue Report The expression `$sortOrder` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
116		$search->addSort(new FieldSort($sortColumn . '.raw', $sortOrder));
117		}
118
119		if (!$pageSize) {
		0 ignored issues – show Bug Best Practice introduced 2017-05-24 11:49 UTC by Report Bug Copy Issue Report The expression `$pageSize` of type `integer\|null` is loosely compared to `false`; this is ambiguous if the integer can be zero. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
120		$search->setScroll('10m');
121		} else {
122		$search = $search->setFrom(($page - 1) * $pageSize)->setSize($pageSize);
123		}
124
125		return $this->execute($search);
126		}
127
128		/**
129		* {@inheritdoc}
130		*/
131		public function getCountForAllWithSearch($query = null, $fields = null)
132		{
133		$search = $this->createQueryForSearch($query, $fields);
134
135		$search->setScroll('10m');
136
137		return $this->repository->count($search);
		0 ignored issues – show Bug Compatibility introduced 2017-05-24 11:49 UTC by Report Bug Copy Issue Report The expression `$this->repository->count($search);` of type `integer\|array` adds the type `array` to the return on line 137 which is incompatible with the return type declared by the interface `Sulu\Component\ActivityL...etCountForAllWithSearch` of type `integer`. Loading history...
138		}
139
140		/**
141		* {@inheritdoc}
142		*/
143	View Code Duplication	public function findByParent(ActivityLogInterface $activityLog, $page = 1, $pageSize = null)
		0 ignored issues – show Duplication introduced 2017-05-24 11:49 UTC by Report Bug Copy Issue Report 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...
144		{
145		$search = $this->repository->createSearch()->addQuery(new TermQuery('parentUuid', $activityLog->getUuid()));
146
147		if (!$pageSize) {
		0 ignored issues – show Bug Best Practice introduced 2017-05-24 11:49 UTC by Report Bug Copy Issue Report The expression `$pageSize` of type `integer\|null` is loosely compared to `false`; this is ambiguous if the integer can be zero. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
148		$search->setScroll('10m');
149		} else {
150		$search->setFrom(($page - 1) * $pageSize)->setSize($pageSize);
151		}
152
153		return $this->execute($search);
		0 ignored issues – show Bug Best Practice introduced 2017-05-24 11:49 UTC by Report Bug Copy Issue Report The return type of `return $this->execute($search);` (`array`) is incompatible with the return type declared by the interface `Sulu\Component\ActivityL...Interface::findByParent` of type `Sulu\Component\ActivityL...el\ActivityLogInterface`. 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...
154		}
155
156		/**
157		* {@inheritdoc}
158		*/
159		public function persist(ActivityLogInterface $activityLog)
160		{
161		$this->manager->persist($activityLog);
162
163		return $activityLog;
164		}
165
166		/**
167		* {@inheritdoc}
168		*/
169		public function flush()
170		{
171		$this->manager->commit();
172		$this->manager->flush();
173		}
174
175		/**
176		* Executes given search and append parents and creators.
177		*
178		* @param Search $search
179		*
180		* @return ResultIterator
181		*/
182		private function execute(Search $search)
183		{
184		$search->addAggregation(new TermsAggregation('parentUuid', 'parentUuid'))
185		->addAggregation(new TermsAggregation('creatorId', 'creatorId'));
186
187		$result = $this->repository->findDocuments($search);
188
189		$aggregation = $result->getAggregation('parentUuid');
190		$parentUuids = [];
191		foreach ($aggregation->getBuckets() as $bucket) {
192		$parentUuids[] = $bucket->getValue();
193		}
194
195		$parents = null;
196		if (0 < count($parentUuids)) {
197		$parents = $this->repository->findByIds($parentUuids);
198		}
199
200		$aggregation = $result->getAggregation('creatorId');
201		$creatorIds = [];
202		foreach ($aggregation->getBuckets() as $bucket) {
203		$creatorIds[] = $bucket->getValue();
204		}
205
206		$creators = null;
207		if (0 < count($creatorIds)) {
208		$creators = $this->userRepository->findBy(['id' => $creatorIds]);
209		}
210
211		return iterator_to_array(new ResultIterator($result, $parents, $creators));
212		}
213
214		/**
215		* @param string $query
216		* @param array $fields
217		*
218		* @return Search
219		*/
220		private function createQueryForSearch($query = null, $fields = null)
221		{
222		$search = $this->repository->createSearch()->addQuery(new MatchAllQuery());
223
224		if (isset($query)) {
225		$boolQuery = new BoolQuery();
226
227		foreach ($fields as $field) {
		0 ignored issues – show Bug introduced 2017-05-24 11:49 UTC by Report Bug Copy Issue Report The expression `$fields` of type `array\|null` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
228		$boolQuery->add(new WildcardQuery($field, '' . $query . ''), BoolQuery::SHOULD);
229		}
230
231		$search->addQuery($boolQuery);
232		}
233
234		return $search;
235		}
236		}
237

sulu / activity-log-elasticsearch

Pull Request — master (#1)

ElasticsearchActivityStorage::findByParent() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like