Xhgui_Profiles

Complexity

Total Complexity

22

Size/Duplication

Total Lines	216
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	query()	0	4	1
A	get()	0	4	1
A	getForUrl()	0	11	1
A	paginate()	0	22	2
B	getPercentileForUrl()	0	31	6
A	getAll()	0	4	1
A	insert()	0	4	1
A	delete()	0	4	1
A	truncate()	0	4	1
A	wrap()	0	16	4
A	getStorage()	0	4	1
A	setStorage()	0	4	1

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

    /**
     * Xhgui_Profiles constructor.
     * @param Xhgui_StorageInterface $storage
     */
    public function __construct(\Xhgui_StorageInterface $storage)
    {
        $this->storage = $storage;
    }

    /**
     * @param $conditions
     * @param null $fields
     * @return mixed
     */
    public function query($conditions, $fields = null)
    {
        return $this->storage->find($conditions, $fields);

$fields is of type null, but the function expects a boolean.

    }

    /**
     * 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));

The expression $this->wrap($this->storage->findOne($id)); of type Xhgui_Profile|array adds the type array to the return on line 40 which is incompatible with the return type documented by Xhgui_Profiles::get of type Xhgui_Profile.

    }

    /**
     * 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);

$options is of type array, but the function expects a object<Xhgui_Storage_Filter>.

    }

    /**
     * @param Xhgui_Storage_Filter $filter
     * @return array
     * @throws Exception
     */
    public function paginate(Xhgui_Storage_Filter $filter)
    {
        $projection = false;

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

null is of type null, but the function expects a boolean.

        } 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

There is no parameter named $search. Was it maybe removed?

     * @return array Array of metrics grouped by date
     */
    public function getPercentileForUrl($percentile, $url, $filter)

The parameter $url is not used and could be removed.

    {
        $col = '$meta.request_date';

        $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) {
            if ($result['_id'] instanceof MongoDate) {
                $result['date'] = date('Y-m-d H:i:s', $result['_id']->sec);
            } else {
                $result['date'] = $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.

There is no parameter named $options. Was it maybe removed?

     * @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);

It seems like $data defined by parameter $data on line 188 can also be of type object<MongoCursor>; however, Xhgui_Profile::__construct() does only seem to accept array, maybe add an additional type check?

        }

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

    /**
     * @return Xhgui_StorageInterface
     */
    public function getStorage()
    {
        return $this->storage;
    }

    /**
     * @param Xhgui_StorageInterface $storage
     */
    public function setStorage($storage)
    {
        $this->storage = $storage;
    }
}