eXpansion\Bundle\LocalRecords\Plugins\ChatNotification

Complexity

Total Complexity

23

Size/Duplication

Total Lines	223
Duplicated Lines	6.28 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

100%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	13	1
A	onLocalRecordsFirstRecord()	0	4	1
A	onLocalRecordsSameScore()	0	4	1
A	sendMessage()	0	8	1
B	onLocalRecordsLoaded()	0	23	4
A	getSecuredBy()	0	14	3
A	messageFirstPlaceNew()	0	12	1
C	onLocalRecordsBetterPosition()	7	40	7
B	onLocalRecordsSamePosition()	7	30	4

<?php

namespace eXpansion\Bundle\LocalRecords\Plugins;

use eXpansion\Framework\Core\Helpers\ChatNotification as ChatNotificationHelper;
use eXpansion\Bundle\LocalRecords\DataProviders\Listener\RecordsDataListener;
use eXpansion\Bundle\LocalRecords\Entity\Record;
use eXpansion\Framework\Core\Helpers\Time;
use eXpansion\Framework\Core\Storage\PlayerStorage;


/**
 * Class ChatNotificaiton
 *
 * @package eXpansion\Bundle\LocalRecords\Plugins;
 * @author  oliver de Cramer <oliverde8@gmail.com>
 */
class ChatNotification implements RecordsDataListener
{
    /** @var ChatNotificationHelper */
    protected $chatNotification;

    /** @var  PlayerStorage */
    protected $playerStorage;

    /** @var Time */
    protected $timeFormater;

    /** @var string */
    protected $translationPrefix;

    /** @var int */
    protected $positionForPublicMessage;

    /**
     * ChatNotification constructor.
     *
     * @param ChatNotificationHelper $chatNotification
     * @param PlayerStorage          $playerStorage
     * @param Time                   $timeFormater
     * @param string                 $translationPrefix
     * @param int                    $positionForPublicMessage
     */
    public function __construct(
        ChatNotificationHelper $chatNotification,
        PlayerStorage $playerStorage,
        Time $timeFormater,
        $translationPrefix,
        $positionForPublicMessage
    ) {
        $this->chatNotification = $chatNotification;
        $this->playerStorage = $playerStorage;
        $this->timeFormater = $timeFormater;
        $this->translationPrefix = $translationPrefix;
        $this->positionForPublicMessage = $positionForPublicMessage;
    }

    /**
     * Called when local records are loaded.
     *
     * @param Record[] $records
     */
    public function onLocalRecordsLoaded($records)
    {
        if (!empty($records)) {
            $firstRecord = $records[0];

            $this->sendMessage('loaded.top1', null, [
               '%nickname%' => $firstRecord->getPlayerLogin(), // TODO get player nickname from database.
                '%score%' => $this->timeFormater->milisecondsToTrackmania($firstRecord->getScore(), true)
            ]);


            $onlinePlayers = $this->playerStorage->getOnline();
            for ($i = 1; $i < count($records); $i++) {

It seems like you are calling the size function count() as part of the test condition. You might want to compute the size beforehand, and not on each iteration.

                if (isset($onlinePlayers[$records[$i]->getPlayerLogin()])) {
                    $this->sendMessage('loaded.any', $records[$i]->getPlayerLogin(), [
                        '%nickname%' => $onlinePlayers[$records[$i]->getPlayerLogin()]->getNickName(),
                        '%score%' => $this->timeFormater->milisecondsToTrackmania($records[$i]->getScore(), true),
                        '%position%' => $i+1,
                    ]);
                }
            }
        }
    }

    /**
     * Called when a player finishes map for the very first time (basically first record).
     *
     * @param Record   $record
     * @param Record[] $records
     * @param          $position
     */
    public function onLocalRecordsFirstRecord(Record $record, $records, $position)
    {
        $this->messageFirstPlaceNew($record);
    }

    /**
     * Called when a player finishes map and does same time as before.
     *
     * @param Record   $record
     * @param Record   $oldRecord
     * @param Record[] $records
     *
     * @return mixed
     */
    public function onLocalRecordsSameScore(Record $record, Record $oldRecord, $records)
    {
        // Nothing.
    }

    /**
     * Called when a player finishes map with better time and has better position.
     *
     * @param Record   $record
     * @param Record   $oldRecord
     * @param Record[] $records
     * @param int      $position
     * @param int      $oldPosition
     */
    public function onLocalRecordsBetterPosition(Record $record, Record $oldRecord, $records, $position, $oldPosition)
    {
        if ($position == 1 && $oldPosition == null) {
            return $this->messageFirstPlaceNew($record);
        }

        // Check to who to send.
        $to = null;
        if ($position > $this->positionForPublicMessage) {
            $to = $record->getPlayerLogin();
        }

        // Check which message to send.
        $msg = 'better';
        if ($oldPosition == null) {
            $msg = 'new';
        }

        // Check for top status
        if ($position == 1) {

This code seems to be duplicated across your project.

            $msg .= '.top1';
        } else if ($position <= 5) {
            $msg .= '.top5';
        } else {
            $msg .= '.any';
        }

        $securedBy = $this->getSecuredBy($record, $oldRecord);
        $this->sendMessage(
            $msg,
            $to,
            [
                '%nickname%' => $this->playerStorage->getPlayerInfo($record->getPlayerLogin())->getNickName(),
                '%score%' => $this->timeFormater->milisecondsToTrackmania($record->getScore(), true),
                '%position%' => $position,
                '%old_position%' => $oldPosition,
                '%by%' => $securedBy
            ]
        );
    }

    /**
     * Called when a player finishes map with better time but keeps same position.
     *
     * @param Record   $record
     * @param Record   $oldRecord
     * @param Record[] $records
     * @param          $position
     *
     * @return mixed
     */
    public function onLocalRecordsSamePosition(Record $record, Record $oldRecord, $records, $position)
    {
        // Check to who to send.
        $to = null;
        if ($position > $this->positionForPublicMessage) {
            $to = $record->getPlayerLogin();
        }

        // Check which message to send.
        $msg = 'secures';
        if ($position == 1) {

This code seems to be duplicated across your project.

            $msg .= '.top1';
        } else if ($position <= 5) {
            $msg .= '.top5';
        } else {
            $msg .= '.any';
        }

        $securedBy = $this->getSecuredBy($record, $oldRecord);
        $this->sendMessage(
            $msg,
            $to,
            [
                '%nickname%' => $this->playerStorage->getPlayerInfo($record->getPlayerLogin())->getNickName(),
                '%score%' => $this->timeFormater->milisecondsToTrackmania($record->getScore(), true),
                '%position%' => $position,
                '%by%' => $securedBy
            ]
        );
    }

    protected function getSecuredBy(Record $record, Record $oldRecord)
    {
        $securedBy =$this->timeFormater->milisecondsToTrackmania($oldRecord->getScore() - $record->getScore(), true);

        if (substr($securedBy, 0, 4) === "00:0") {
            $securedBy = substr($securedBy, 4);
        } else {
            if (substr($securedBy, 0, 3) === "00:") {
                $securedBy = substr($securedBy, 3);
            }
        }

        return '-' . $securedBy;
    }

    protected function messageFirstPlaceNew(Record $record)
    {
        $this->sendMessage(
            'new.top1',
            null,
            [
                '%nickname%' => $this->playerStorage->getPlayerInfo($record->getPlayerLogin())->getNickName(),
                '%score%' => $this->timeFormater->milisecondsToTrackmania($record->getScore(), true),
                '%position%' => 1
            ]
        );
    }

    protected function sendMessage($message, $recipe, $params)
    {
        $this->chatNotification->sendMessage(
            $this->translationPrefix . '.' . $message,
            $recipe,
            $params
        );
    }
}