Xhgui_Searcher_Mongo::get() - Code Metrics - Inspection of "WIP: Backend decoupling" - perftools/xhgui - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#244)

by Marcel

created 2018-07-08 19:24 UTC

Xhgui_Searcher_Mongo::get() A

↳ Parent: Xhgui_Searcher_Mongo

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php

/**
 * A Searcher for a MongoDB backend.
 */
class Xhgui_Searcher_Mongo implements Xhgui_Searcher_Interface
namespace YourVendor;

class YourClass { }
{
    protected $_collection;

    protected $_mapper;

    public function __construct(MongoDb $db)
    {
        $this->_collection = $db->results;

        $this->_mapper = new Xhgui_Db_Mapper();
    }

    /**
     * {@inheritdoc}
     */
    public function latest()
    {
        $cursor = $this->_collection->find()
            ->sort(array('meta.request_date' => -1))
            ->limit(1);
        $result = $cursor->getNext();
        return $this->_wrap($result);

    }

    /**
     * {@inheritdoc}
     */
    public function query($conditions, $limit, $fields = [])
    {
        $result = $this->_collection->find($conditions, $fields)
            ->limit($limit);

        return iterator_to_array($result);
    }

    /**
     * {@inheritdoc}
     */
    public function get($id)
    {
        return $this->_wrap($this->_collection->findOne(array(

            '_id' => new MongoId($id)
        )));
    }

    /**
     * {@inheritdoc}
     */
    public function getForUrl($url, $options, $conditions = array())
    {
        $conditions = array_merge(
            (array)$conditions,
            array('simple_url' => $url)
        );
        $options = array_merge($options, array(
            'conditions' => $conditions,
        ));
        return $this->paginate($options);
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 getPercentileForUrl($percentile, $url, $search = array())
    {
        $result = $this->_mapper->convert(array(
            'conditions' => $search + array('simple_url' => $url)
        ));
        $match = $result['conditions'];

        $col = '$meta.request_date';
        if (!empty($search['limit']) && $search['limit'][0] == "P") {

            $col = '$meta.request_ts';
        }

        $results = $this->_collection->aggregate(array(
            array('$match' => $match),
            array(
                '$project' => array(
                    'date' => $col,
                    'profile.main()' => 1
                )
            ),
            array(
                '$group' => array(
                    '_id' => '$date',
                    'row_count' => array('$sum' => 1),
                    'wall_times' => array('$push' => '$profile.main().wt'),
                    'cpu_times' => array('$push' => '$profile.main().cpu'),
                    'mu_times' => array('$push' => '$profile.main().mu'),
                    'pmu_times' => array('$push' => '$profile.main().pmu'),
                )
            ),
            array(
                '$project' => array(
                    'date' => '$date',
                    'row_count' => '$row_count',
                    'raw_index' => array(
                        '$multiply' => array(
                            '$row_count',
                            $percentile / 100
                        )
                    ),
                    'wall_times' => '$wall_times',
                    'cpu_times' => '$cpu_times',
                    'mu_times' => '$mu_times',
                    'pmu_times' => '$pmu_times',
                )
            ),
            array('$sort' => array('_id' => 1)),
            ),
            array('cursor' => array('batchSize' => 0))
        );

        if (empty($results['result'])) {
            return array();
        }
        $keys = array(
            'wall_times' => 'wt',
            'cpu_times' => 'cpu',
            'mu_times' => 'mu',
            'pmu_times' => 'pmu'
        );
        foreach ($results['result'] as &$result) {
            $result['date'] = ($result['_id'] instanceof MongoDate) ? date('Y-m-d H:i:s', $result['_id']->sec) : $result['_id'];
            unset($result['_id']);
            $index = max(round($result['raw_index']) - 1, 0);
            foreach ($keys as $key => $out) {
                sort($result[$key]);
                $result[$out] = isset($result[$key][$index]) ? $result[$key][$index] : null;
                unset($result[$key]);
            }
        }
        return $results['result'];
    }

    /**
     * {@inheritdoc}
     */
    public function getAvgsForUrl($url, $search = array())
    {
        $match = array('meta.simple_url' => $url);
        if (isset($search['date_start'])) {
            $match['meta.request_date']['$gte'] = (string)$search['date_start'];
        }
        if (isset($search['date_end'])) {
            $match['meta.request_date']['$lte'] = (string)$search['date_end'];
        }
        $results = $this->_collection->aggregate(array(
            array('$match' => $match),
            array(
                '$project' => array(
                    'date' => '$meta.request_date',
                    'profile.main()' => 1,
                )
            ),
            array(
                '$group' => array(
                    '_id' => '$date',
                    'avg_wt' => array('$avg' => '$profile.main().wt'),
                    'avg_cpu' => array('$avg' => '$profile.main().cpu'),
                    'avg_mu' => array('$avg' => '$profile.main().mu'),
                    'avg_pmu' => array('$avg' => '$profile.main().pmu'),
                )
            ),
            array('$sort' => array('_id' => 1))
        ),
            array('cursor' => array('batchSize' => 0))
        );
        if (empty($results['result'])) {
            return array();
        }
        foreach ($results['result'] as $i => $result) {
            $results['result'][$i]['date'] = $result['_id'];
            unset($results['result'][$i]['_id']);
        }
        return $results['result'];
    }

    /**
     * {@inheritdoc}
     */
    public function getAll($options = array())
    {
        return $this->paginate($options);
    }

    /**
     * {@inheritdoc}
     */
    public function insert($profile)
    {
        return $this->_collection->insert($profile, array('w' => 0));
    }

    /**
     * {@inheritdoc}
     */
    public function delete($id)
    {
        $this->_collection->remove(array('_id' => new MongoId($id)), array());
    }

    /**
     * {@inheritdoc}
     */
    public function truncate()
    {
        return $this->_collection->drop();
    }

    private function paginate($options)
    {
        $opts = $this->_mapper->convert($options);

        $totalRows = $this->_collection->find(
            $opts['conditions'],
            array('_id' => 1))->count();

        $totalPages = max(ceil($totalRows / $opts['perPage']), 1);
        $page = 1;
        if (isset($options['page'])) {
            $page = min(max($options['page'], 1), $totalPages);
        }

        $projection = false;
        if (isset($options['projection'])) {
            if ($options['projection'] === true) {
                $projection = array('meta' => 1, 'profile.main()' => 1);
            } else {
                $projection = $options['projection'];
            }
        }

        if ($projection === false) {
            $cursor = $this->_collection->find($opts['conditions'])
                ->sort($opts['sort'])
                ->skip((int)($page - 1) * $opts['perPage'])
                ->limit($opts['perPage']);
        } else {
            $cursor = $this->_collection->find($opts['conditions'], $projection)
                ->sort($opts['sort'])
                ->skip((int)($page - 1) * $opts['perPage'])
                ->limit($opts['perPage']);
        }

        return array(
            'results' => $this->_wrap($cursor),
            'sort' => $opts['sort'],
            'direction' => $opts['direction'],
            'page' => $page,
            'perPage' => $opts['perPage'],
            'totalPages' => $totalPages
        );
    }

    /**
     * Converts arrays + MongoCursors into Xhgui_Profile instances.
     *
     * @param array|MongoCursor $data The data to transform.
     *
     * @return Xhgui_Profile[] The transformed/wrapped results.
     */
    protected function _wrap($data)
    {
        if ($data === null) {
            throw new Exception('No profile data found.');
        }

        if (is_array($data)) {
            $data['_id'] = (string) $data['_id'];
            return new Xhgui_Profile($data);
        }
        $results = array();
        foreach ($data as $row) {
            $row['_id'] = (string) $row['_id'];
            $results[] = new Xhgui_Profile($row);
        }
        return $results;
    }
}


1		<?php
2
3		/**
4		* A Searcher for a MongoDB backend.
5		*/
6		class Xhgui_Searcher_Mongo implements Xhgui_Searcher_Interface
		0 ignored issues – show Coding Style Compatibility introduced 2016-02-22 04:48 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
7		{
8		protected $_collection;
9
10		protected $_mapper;
11
12		public function __construct(MongoDb $db)
13		{
14		$this->_collection = $db->results;
		0 ignored issues – show Bug introduced 2016-02-22 04:48 UTC by Report Bug Copy Issue Report The property `results` does not seem to exist in `MongoDB`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
15		$this->_mapper = new Xhgui_Db_Mapper();
16		}
17
18		/**
19		* {@inheritdoc}
20		*/
21		public function latest()
22		{
23		$cursor = $this->_collection->find()
24		->sort(array('meta.request_date' => -1))
25		->limit(1);
26		$result = $cursor->getNext();
27		return $this->_wrap($result);
		0 ignored issues – show Bug Compatibility introduced 2018-07-08 19:27 UTC by Report Bug Copy Issue Report The expression `$this->_wrap($result);` of type `Xhgui_Profile\|array` adds the type `array` to the return on line 27 which is incompatible with the return type declared by the interface `Xhgui_Searcher_Interface::latest` of type `Xhgui_Profile`. Loading history...
28		}
29
30		/**
31		* {@inheritdoc}
32		*/
33		public function query($conditions, $limit, $fields = [])
34		{
35		$result = $this->_collection->find($conditions, $fields)
36		->limit($limit);
37
38		return iterator_to_array($result);
39		}
40
41		/**
42		* {@inheritdoc}
43		*/
44		public function get($id)
45		{
46		return $this->_wrap($this->_collection->findOne(array(
		0 ignored issues – show Bug Compatibility introduced 2018-07-08 19:27 UTC by Report Bug Copy Issue Report The expression `$this->_wrap($this->_col...> new \MongoId($id))));` of type `Xhgui_Profile\|array` adds the type `array` to the return on line 46 which is incompatible with the return type declared by the interface `Xhgui_Searcher_Interface::get` of type `Xhgui_Profile`. Loading history...
47		'_id' => new MongoId($id)
48		)));
49		}
50
51		/**
52		* {@inheritdoc}
53		*/
54		public function getForUrl($url, $options, $conditions = array())
55		{
56		$conditions = array_merge(
57		(array)$conditions,
58		array('simple_url' => $url)
59		);
60		$options = array_merge($options, array(
61		'conditions' => $conditions,
62		));
63		return $this->paginate($options);
		0 ignored issues – show Bug Best Practice introduced 2018-07-08 19:27 UTC by Report Bug Copy Issue Report The return type of `return $this->paginate($options);` (`array`) is incompatible with the return type declared by the interface `Xhgui_Searcher_Interface::getForUrl` of type `MongoCursor`. 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...
64		}
65
66		/**
67		* {@inheritdoc}
68		*/
69		public function getPercentileForUrl($percentile, $url, $search = array())
70		{
71		$result = $this->_mapper->convert(array(
72		'conditions' => $search + array('simple_url' => $url)
73		));
74		$match = $result['conditions'];
75
76		$col = '$meta.request_date';
77	View Code Duplication	if (!empty($search['limit']) && $search['limit'][0] == "P") {
		0 ignored issues – show Duplication introduced 2016-02-22 04:48 UTC by Report Bug Copy Issue Report 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...
78		$col = '$meta.request_ts';
79		}
80
81		$results = $this->_collection->aggregate(array(
82		array('$match' => $match),
83		array(
84		'$project' => array(
85		'date' => $col,
86		'profile.main()' => 1
87		)
88		),
89		array(
90		'$group' => array(
91		'_id' => '$date',
92		'row_count' => array('$sum' => 1),
93		'wall_times' => array('$push' => '$profile.main().wt'),
94		'cpu_times' => array('$push' => '$profile.main().cpu'),
95		'mu_times' => array('$push' => '$profile.main().mu'),
96		'pmu_times' => array('$push' => '$profile.main().pmu'),
97		)
98		),
99		array(
100		'$project' => array(
101		'date' => '$date',
102		'row_count' => '$row_count',
103		'raw_index' => array(
104		'$multiply' => array(
105		'$row_count',
106		$percentile / 100
107		)
108		),
109		'wall_times' => '$wall_times',
110		'cpu_times' => '$cpu_times',
111		'mu_times' => '$mu_times',
112		'pmu_times' => '$pmu_times',
113		)
114		),
115		array('$sort' => array('_id' => 1)),
116		),
117		array('cursor' => array('batchSize' => 0))
118		);
119
120		if (empty($results['result'])) {
121		return array();
122		}
123		$keys = array(
124		'wall_times' => 'wt',
125		'cpu_times' => 'cpu',
126		'mu_times' => 'mu',
127		'pmu_times' => 'pmu'
128		);
129		foreach ($results['result'] as &$result) {
130		$result['date'] = ($result['_id'] instanceof MongoDate) ? date('Y-m-d H:i:s', $result['_id']->sec) : $result['_id'];
131		unset($result['_id']);
132		$index = max(round($result['raw_index']) - 1, 0);
133		foreach ($keys as $key => $out) {
134		sort($result[$key]);
135		$result[$out] = isset($result[$key][$index]) ? $result[$key][$index] : null;
136		unset($result[$key]);
137		}
138		}
139		return $results['result'];
140		}
141
142		/**
143		* {@inheritdoc}
144		*/
145		public function getAvgsForUrl($url, $search = array())
146		{
147		$match = array('meta.simple_url' => $url);
148		if (isset($search['date_start'])) {
149		$match['meta.request_date']['$gte'] = (string)$search['date_start'];
150		}
151		if (isset($search['date_end'])) {
152		$match['meta.request_date']['$lte'] = (string)$search['date_end'];
153		}
154		$results = $this->_collection->aggregate(array(
155		array('$match' => $match),
156		array(
157		'$project' => array(
158		'date' => '$meta.request_date',
159		'profile.main()' => 1,
160		)
161		),
162		array(
163		'$group' => array(
164		'_id' => '$date',
165		'avg_wt' => array('$avg' => '$profile.main().wt'),
166		'avg_cpu' => array('$avg' => '$profile.main().cpu'),
167		'avg_mu' => array('$avg' => '$profile.main().mu'),
168		'avg_pmu' => array('$avg' => '$profile.main().pmu'),
169		)
170		),
171		array('$sort' => array('_id' => 1))
172		),
173		array('cursor' => array('batchSize' => 0))
174		);
175		if (empty($results['result'])) {
176		return array();
177		}
178		foreach ($results['result'] as $i => $result) {
179		$results['result'][$i]['date'] = $result['_id'];
180		unset($results['result'][$i]['_id']);
181		}
182		return $results['result'];
183		}
184
185		/**
186		* {@inheritdoc}
187		*/
188		public function getAll($options = array())
189		{
190		return $this->paginate($options);
191		}
192
193		/**
194		* {@inheritdoc}
195		*/
196		public function insert($profile)
197		{
198		return $this->_collection->insert($profile, array('w' => 0));
199		}
200
201		/**
202		* {@inheritdoc}
203		*/
204		public function delete($id)
205		{
206		$this->_collection->remove(array('_id' => new MongoId($id)), array());
207		}
208
209		/**
210		* {@inheritdoc}
211		*/
212		public function truncate()
213		{
214		return $this->_collection->drop();
215		}
216
217		private function paginate($options)
218		{
219		$opts = $this->_mapper->convert($options);
220
221		$totalRows = $this->_collection->find(
222		$opts['conditions'],
223		array('_id' => 1))->count();
224
225		$totalPages = max(ceil($totalRows / $opts['perPage']), 1);
226		$page = 1;
227		if (isset($options['page'])) {
228		$page = min(max($options['page'], 1), $totalPages);
229		}
230
231		$projection = false;
232		if (isset($options['projection'])) {
233		if ($options['projection'] === true) {
234		$projection = array('meta' => 1, 'profile.main()' => 1);
235		} else {
236		$projection = $options['projection'];
237		}
238		}
239
240		if ($projection === false) {
241		$cursor = $this->_collection->find($opts['conditions'])
242		->sort($opts['sort'])
243		->skip((int)($page - 1) * $opts['perPage'])
244		->limit($opts['perPage']);
245		} else {
246		$cursor = $this->_collection->find($opts['conditions'], $projection)
247		->sort($opts['sort'])
248		->skip((int)($page - 1) * $opts['perPage'])
249		->limit($opts['perPage']);
250		}
251
252		return array(
253		'results' => $this->_wrap($cursor),
254		'sort' => $opts['sort'],
255		'direction' => $opts['direction'],
256		'page' => $page,
257		'perPage' => $opts['perPage'],
258		'totalPages' => $totalPages
259		);
260		}
261
262		/**
263		* Converts arrays + MongoCursors into Xhgui_Profile instances.
264		*
265		* @param array\|MongoCursor $data The data to transform.
266		*
267		* @return Xhgui_Profile[] The transformed/wrapped results.
268		*/
269		protected function _wrap($data)
270		{
271		if ($data === null) {
272		throw new Exception('No profile data found.');
273		}
274
275		if (is_array($data)) {
276		$data['_id'] = (string) $data['_id'];
277		return new Xhgui_Profile($data);
278		}
279		$results = array();
280		foreach ($data as $row) {
281		$row['_id'] = (string) $row['_id'];
282		$results[] = new Xhgui_Profile($row);
283		}
284		return $results;
285		}
286		}
287

perftools / xhgui

Pull Request — master (#244)

Xhgui_Searcher_Mongo::get() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like