Xhgui_Profiles::_wrap() - Code Metrics - Inspection of "Introduce multiple storage drivers" - perftools/xhgui - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#268)

unknown

created 2019-06-09 22:21 UTC

Xhgui_Profiles::_wrap() A

↳ Parent: Xhgui_Profiles

Complexity

Conditions	4
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	16
rs	9.7333
c	0
b	0
f	0
cc	4
nc	4
nop	1

<?php
/**
 * Contains logic for getting/creating/removing profile records.
 */
class Xhgui_Profiles
{
    protected $storage;

    public function __construct(\Xhgui_StorageInterface $storage)
    {
        $this->storage = $storage;
    }

    /**
     * Get the latest profile data.
     *
     * @return Xhgui_Profile
     * @throws Exception
     */
    public function latest()
    {
        $cursor = $this->storage->find()

                                ->sort(array('meta.request_date' => -1))
                                ->limit(1);
        $result = $cursor->getNext();
        return $this->_wrap($result);

    }

    public function query($conditions, $fields = null)
    {
        return $this->storage->find($conditions, $fields);
    }

    /**
     * Get a single profile run by id.
     *
     * @param string $id The id of the profile to get.
     * @return Xhgui_Profile
     * @throws Exception
     */
    public function get($id)
    {
        return $this->_wrap($this->storage->findOne($id));

    }

    /**
     * Get the list of profiles for a simplified url.
     *
     * @param string $url The url to load profiles for.
     * @param array $options Pagination options to use.
     * @param array $conditions The search options.
     * @return MongoCursor
     */
    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);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

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

        if ($projection === false) {
            $result = $this->storage->find($filter, null);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        } else {
            $result = $this->storage->find($filter, $projection);
        }

        $totalRows = $this->storage->count($filter);
        $totalPages = max(ceil($totalRows / $filter->getPerPage()), 1);

        return array(
            'results'       => $this->_wrap($result),
            'sort'          => $filter->getSort(),
            'direction'     => $filter->getDirection(),
            'page'          => $filter->getPage(),
            'perPage'       => $filter->getPerPage(),
            'totalPages'    => $totalPages
        );
    }

    /**
     * Get the Percentile metrics for a URL
     *
     * This will group data by date and returns only the
     * percentile + date, making the data ideal for time series graphs
     *
     * @param integer $percentile The percentile you want. e.g. 90.
     * @param string $url
     * @param array $search Search options containing startDate and or endDate
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return array Array of metrics grouped by date
     */
    public function getPercentileForUrl($percentile, $url, $filter)

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

        $results = $this->storage->aggregate($filter, $col, $percentile);
        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 array_values($results['result']);
    }

    /**
     * Get a paginated set of results.
     *
     * @param array $options The find options to use.
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return array An array of result data.
     */
    public function getAll($filter)
    {
        return $this->paginate($filter);
    }

    /**
     * Insert a profile run.
     *
     * Does unchecked inserts.
     *
     * @param array $profile The profile data to save.
     * @return
     */
    public function insert($profile)
    {
        return $this->storage->insert($profile);
    }

    /**
     * Delete a profile run.
     *
     * @param string $id The profile id to delete.
     * @return array|bool
     */
    public function delete($id)
    {
        return $this->storage->remove($id);
    }

    /**
     * Used to truncate a collection.
     *
     * Primarly used in test cases to reset the test db.
     *
     * @return boolean
     */
    public function truncate()
    {
        return $this->storage->drop();
    }

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

        if (!($data instanceof \Xhgui_Storage_ResultSet)) {
            return new Xhgui_Profile($data, true);

        }

        $results = array();
        foreach ($data as $row) {
            $results[] = new Xhgui_Profile($row, true);
        }
        return $results;
    }
}


1			<?php
2			/**
3			* Contains logic for getting/creating/removing profile records.
4			*/
5			class Xhgui_Profiles
6			{
7			protected $storage;
8
9			public function __construct(\Xhgui_StorageInterface $storage)
10			{
11			$this->storage = $storage;
12			}
13
14			/**
15			* Get the latest profile data.
16			*
17			* @return Xhgui_Profile
18			* @throws Exception
19			*/
20			public function latest()
21			{
22			$cursor = $this->storage->find()
			0 ignored issues – show Bug introduced 2019-05-19 16:38 UTC by Report Bug Copy Issue Report The call to `find()` misses a required argument `$filter`. This check looks for function calls that miss required arguments. Loading history...
23			->sort(array('meta.request_date' => -1))
24			->limit(1);
25			$result = $cursor->getNext();
26			return $this->_wrap($result);
			0 ignored issues – show Bug Compatibility introduced 2016-02-22 04:48 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 26 which is incompatible with the return type documented by `Xhgui_Profiles::latest` of type `Xhgui_Profile`. Loading history...
27			}
28
29			public function query($conditions, $fields = null)
30			{
31			return $this->storage->find($conditions, $fields);
32			}
33
34			/**
35			* Get a single profile run by id.
36			*
37			* @param string $id The id of the profile to get.
38			* @return Xhgui_Profile
39			* @throws Exception
40			*/
41			public function get($id)
42			{
43			return $this->_wrap($this->storage->findOne($id));
			0 ignored issues – show Bug Compatibility introduced 2019-05-19 16:38 UTC by Report Bug Copy Issue Report The expression `$this->_wrap($this->storage->findOne($id));` of type `Xhgui_Profile\|array` adds the type `array` to the return on line 43 which is incompatible with the return type documented by `Xhgui_Profiles::get` of type `Xhgui_Profile`. Loading history...
44			}
45
46			/**
47			* Get the list of profiles for a simplified url.
48			*
49			* @param string $url The url to load profiles for.
50			* @param array $options Pagination options to use.
51			* @param array $conditions The search options.
52			* @return MongoCursor
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 Documentation introduced 2019-05-19 16:38 UTC by Report Bug Copy Issue Report `$options` is of type `array`, but the function expects a `object<Xhgui_Storage_Filter>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
64			}
65
66			public function paginate(Xhgui_Storage_Filter $filter)
67			{
68			$projection = false;
69			// if (isset($options['projection'])) {
70			// if ($options['projection'] === true) {
71			// $projection = array('meta' => 1, 'profile.main()' => 1);
72			// } else {
73			// $projection = $options['projection'];
74			// }
75			// }
76
77			if ($projection === false) {
78			$result = $this->storage->find($filter, null);
			0 ignored issues – show Documentation introduced 2019-05-19 16:38 UTC by Report Bug Copy Issue Report `null` is of type `null`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
79			} else {
80			$result = $this->storage->find($filter, $projection);
81			}
82
83			$totalRows = $this->storage->count($filter);
84			$totalPages = max(ceil($totalRows / $filter->getPerPage()), 1);
85
86			return array(
87			'results' => $this->_wrap($result),
88			'sort' => $filter->getSort(),
89			'direction' => $filter->getDirection(),
90			'page' => $filter->getPage(),
91			'perPage' => $filter->getPerPage(),
92			'totalPages' => $totalPages
93			);
94			}
95
96			/**
97			* Get the Percentile metrics for a URL
98			*
99			* This will group data by date and returns only the
100			* percentile + date, making the data ideal for time series graphs
101			*
102			* @param integer $percentile The percentile you want. e.g. 90.
103			* @param string $url
104			* @param array $search Search options containing startDate and or endDate
			0 ignored issues – show Bug introduced 2019-05-19 16:38 UTC by Report Bug Copy Issue Report There is no parameter named `$search`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
105			* @return array Array of metrics grouped by date
106			*/
107			public function getPercentileForUrl($percentile, $url, $filter)
			0 ignored issues – show Unused Code introduced 2019-05-19 16:38 UTC by Report Bug Copy Issue Report The parameter `$url` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
108			{
109			$col = '$meta.request_date';
110			// if (!empty($search['limit']) && $search['limit'][0] == "P") {
111			// $col = '$meta.request_ts';
112			// }
113
114			$results = $this->storage->aggregate($filter, $col, $percentile);
115			if (empty($results['result'])) {
116			return array();
117			}
118			$keys = array(
119			'wall_times' => 'wt',
120			'cpu_times' => 'cpu',
121			'mu_times' => 'mu',
122			'pmu_times' => 'pmu'
123			);
124			foreach ($results['result'] as &$result) {
125			$result['date'] = ($result['_id'] instanceof MongoDate) ? date('Y-m-d H:i:s', $result['_id']->sec) : $result['_id'];
126			unset($result['_id']);
127			$index = max(round($result['raw_index']) - 1, 0);
128			foreach ($keys as $key => $out) {
129			sort($result[$key]);
130			$result[$out] = isset($result[$key][$index]) ? $result[$key][$index] : null;
131			unset($result[$key]);
132			}
133			}
134			return array_values($results['result']);
135			}
136
137			/**
138			* Get a paginated set of results.
139			*
140			* @param array $options The find options to use.
			0 ignored issues – show Bug introduced 2019-05-19 16:38 UTC by Report Bug Copy Issue Report There is no parameter named `$options`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
141			* @return array An array of result data.
142			*/
143			public function getAll($filter)
144			{
145			return $this->paginate($filter);
146			}
147
148			/**
149			* Insert a profile run.
150			*
151			* Does unchecked inserts.
152			*
153			* @param array $profile The profile data to save.
154			* @return
155			*/
156			public function insert($profile)
157			{
158			return $this->storage->insert($profile);
159			}
160
161			/**
162			* Delete a profile run.
163			*
164			* @param string $id The profile id to delete.
165			* @return array\|bool
166			*/
167			public function delete($id)
168			{
169			return $this->storage->remove($id);
170			}
171
172			/**
173			* Used to truncate a collection.
174			*
175			* Primarly used in test cases to reset the test db.
176			*
177			* @return boolean
178			*/
179			public function truncate()
180			{
181			return $this->storage->drop();
182			}
183
184			/**
185			* Converts arrays + MongoCursors into Xhgui_Profile instances.
186			*
187			* @param array\|MongoCursor $data The data to transform.
188			* @return Xhgui_Profile\|array The transformed/wrapped results.
189			* @throws Exception
190			*/
191			protected function _wrap($data)
192			{
193			if ($data === null) {
194			throw new Exception('No profile data found.');
195			}
196
197			if (!($data instanceof \Xhgui_Storage_ResultSet)) {
198			return new Xhgui_Profile($data, true);
			0 ignored issues – show Bug introduced 2019-05-19 16:38 UTC by Report Bug Copy Issue Report It seems like `$data` defined by parameter `$data` on line 191 can also be of type `object<MongoCursor>`; however, `Xhgui_Profile::__construct()` does only seem to accept `array`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
199			}
200
201			$results = array();
202			foreach ($data as $row) {
203			$results[] = new Xhgui_Profile($row, true);
204			}
205			return $results;
206			}
207			}
208

perftools / xhgui

Pull Request — master (#268)

Xhgui_Profiles::_wrap() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like