mQueue\Model\StatusMapper

Complexity

Total Complexity

25

Size/Duplication

Total Lines	224
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

97.44%

Importance

Changes	4
Bugs	2	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	find()	0	6	1
B	set()	0	31	2
C	findAll()	0	35	7
B	getStatistics()	0	29	4
C	getGraph()	0	63	8
A	getActivityQuery()	0	14	3

<?php

namespace mQueue\Model;

use DateTime;
use DateTimeZone;

abstract class StatusMapper extends AbstractMapper
{
    /**
     * Define the status for a movie-user tuple. If an existing satus exists and
     * is very recent, it will be updated, otherwise a new status will be created.
     * IMPORTANT: This is the only allowed way to modify status.
     * @param \mQueue\Model\Movie $movie
     * @param \mQueue\Model\User $user
     * @param int $rating @see \mQueue\Model\Status
     * @return \mQueue\Model\Status
     */
    public static function set(Movie $movie, User $user, $rating)

This method's name is shorter than the configured minimum length of 4 characters.

    {
        $db = self::getDbTable()->getAdapter();

Avoid variables with short names like $db. Configured minimum length is 3.

        $db->beginTransaction();

        // Find out if a very recent status exist to be replaced, so user can change their mind "quickly"
        $select = self::getDbTable()->select()
                ->where('idUser = ?', $user->id)

The property id does not exist on object<mQueue\Model\User>. Since you implemented __get, maybe consider adding a @property annotation.

                ->where('idMovie = ?', $movie->id)

The property id does not exist on object<mQueue\Model\Movie>. Since you implemented __get, maybe consider adding a @property annotation.

                ->where('dateUpdate > DATE_SUB(NOW(), INTERVAL 5 MINUTE)');

        $status = self::getDbTable()->fetchRow($select);

        // Otherwise create a brand new one and set all existing one as "old"
        if (!$status) {
            $status = self::getDbTable()->createRow();
            $status->idUser = $user->id;

The property id does not exist on object<mQueue\Model\User>. Since you implemented __set, maybe consider adding a @property annotation.

            $status->idMovie = $movie->id;

The property id does not exist on object<mQueue\Model\Movie>. Since you implemented __set, maybe consider adding a @property annotation.

            $status->isLatest = true;

            // Here we must set dateUpdate to itself to avoid auto-update of the timestamp field by MySql
            $db->query('UPDATE `status` SET isLatest = 0, dateUpdate = dateUpdate WHERE idUser = ? AND idMovie = ?', [$user->id, $movie->id]);

The property id does not exist on object<mQueue\Model\User>. Since you implemented __get, maybe consider adding a @property annotation.

The property id does not exist on object<mQueue\Model\Movie>. Since you implemented __get, maybe consider adding a @property annotation.

        }

        $status->rating = $rating;
        $status->save();

        $db->commit();

        return $status;
    }

    /**
     * Find a status by its user and movie. If not found it will be created (but not saved).
     * @param int $idMovie
     * @param \mQueue\Model\User|null $user
     * @return \mQueue\Model\Status
     */
    public static function find($idMovie, User $user = null)
    {
        $statuses = self::findAll([$idMovie], $user);

        return reset($statuses);
    }

    /**
     * Returns an array of Status containing all statuses for specified ids
     * (if they don't exist in database, they will be created with default values but not saved)
     *
     * @param array $idMovies
     * @param \mQueue\Model\User|null $user
     * @return array of \mQueue\Model\Status
     */
    public static function findAll(array $idMovies, User $user = null)
    {
        $statuses = [];
        if (!count($idMovies)) {
            return $statuses;
        }

        // Do not hit database if we know there won't be any result anyway
        if ($user) {
            $select = self::getDbTable()->select()
                    ->where('idUser = ?', $user->id)

The property id does not exist on object<mQueue\Model\User>. Since you implemented __get, maybe consider adding a @property annotation.

                    ->where('idMovie IN (?)', $idMovies)
                    ->where('isLatest = 1');

            $records = self::getDbTable()->fetchAll($select);

            foreach ($records as $record) {
                $statuses[$record->idMovie] = $record;
            }
        }

        // Fill non existing statuses in databases
        foreach ($idMovies as $id) {
            if (!array_key_exists($id, $statuses)) {
                $status = self::getDbTable()->createRow();
                if ($user) {
                    $status->idUser = $user->id;

The property id does not exist on object<mQueue\Model\User>. Since you implemented __set, maybe consider adding a @property annotation.

                }
                $status->idMovie = $id;
                $statuses[$status->idMovie] = $status;
            }
        }

        return $statuses;
    }

    /**
     * Build statistic for the given user.
     * @param \mQueue\Model\User $user
     * @return array statistics

Consider making the return type a bit more specific; maybe use array<*,integer>.

     */
    public static function getStatistics(User $user)
    {
        $select = self::getDbTable()->select()->setIntegrityCheck(false)
                ->from('status', [
                    'rating' => 'IFNULL(rating, 0)',
                    'count' => 'COUNT(IFNULL(rating, 0))', ])
                ->joinRight('movie', 'movie.id = status.idMovie AND status.idUser = ' . $user->id, [])

The property id does not exist on object<mQueue\Model\User>. Since you implemented __get, maybe consider adding a @property annotation.

                ->where('isLatest = 1 OR isLatest IS NULL')
                ->group('IFNULL(rating, 0)');

        $records = self::getDbTable()->fetchAll($select);

        // Set all count to 0
        $result = ['total' => 0, 'rated' => 0, Status::Nothing => 0];
        foreach (Status::$ratings as $val => $name) {
            $result[$val] = 0;
        }

        // Fetch real counts
        foreach ($records->toArray() as $row) {
            $result[$row['rating']] = $row['count'];
            if ($row['rating'] != Status::Nothing) {
                $result['rated'] += $row['count'];
            }
            $result['total'] += $row['count'];
        }

        return $result;
    }

    /**
     * Build statistic for the given user.
     * @param \mQueue\Model\User $user

Should the type for parameter $user not be null|User?

     * @return array statistics
     */
    public static function getGraph(User $user = null, $percent = false)
    {
        $select = self::getDbTable()->select()
                ->order('dateUpdate');

        if ($user) {
            $select->where('idUser = ?', $user->id);

The property id does not exist on object<mQueue\Model\User>. Since you implemented __get, maybe consider adding a @property annotation.

        }

        $records = self::getDbTable()->fetchAll($select);

        // Set all count to 0
        $cumulatedStatuses = [Status::Nothing => 0];
        $graphData = [];
        foreach (Status::$ratings as $val => $name) {
            $cumulatedStatuses[$val] = 0;
            $graphData[$val] = [];
        }

        // Fetch real counts
        $lastStatuses = [];
        foreach ($records as $row) {

            // Add new status
            ++$cumulatedStatuses[$row->rating];
            $changed = [$row->rating];

            // Substract old status
            if (isset($lastStatuses[$row->idUser][$row->idMovie])) {
                --$cumulatedStatuses[$lastStatuses[$row->idUser][$row->idMovie]];
                $changed [] = $lastStatuses[$row->idUser][$row->idMovie];
            }
            $lastStatuses[$row->idUser][$row->idMovie] = $row->rating;

            $time = new DateTime($row->dateUpdate);
            $time->setTimezone(new DateTimeZone('GMT'));
            $epoch = (int) $time->format('U') * 1000;

            // If we are in percent mode, we need all status for each timestamp
            if ($percent) {
                $changed = array_keys(Status::$ratings);
            }

            // Keep for the graph only the changed values (and overwrite previous value if it happened at exactly the same time)
            foreach ($changed as $val) {
                $graphData[$val][$epoch] = [
                    $epoch,
                    $cumulatedStatuses[$val],
                ];
            }
        }

        // Format everything in a more output friendly way
        $result = [];
        foreach (Status::$ratings as $val => $name) {
            $result[] = [
                'name' => $name,
                'data' => array_values($graphData[$val]),
            ];
        }

        return $result;
    }

    /**
     * Returns the query to get activity for either the whole system, or a specific user, or a specific movie
     * @param \mQueue\Model\User|\mQueue\Model\Movie|null $item
     * @return Zend_Db_Table_Select
     */
    public static function getActivityQuery($item = null)
    {
        $select = self::getDbTable()->select()
                ->from('status')
                ->order('dateUpdate DESC');

        if ($item instanceof User) {
            $select->where('idUser = ?', $item->id);

The property id does not exist on object<mQueue\Model\User>. Since you implemented __get, maybe consider adding a @property annotation.

        } elseif ($item instanceof Movie) {
            $select->where('idMovie = ?', $item->id);

The property id does not exist on object<mQueue\Model\Movie>. Since you implemented __get, maybe consider adding a @property annotation.

        }

        return $select;
    }
}