Game::getCurrentDown() - Code Metrics - Inspection of "Added badges" - maxalmonte14/nfl-scores - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 652e57...3ec9c1 )

by Max

created 2018-10-30 19:37 UTC

Game::getCurrentDown() A

↳ Parent: Game

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	2.0078

Importance

Changes

Metric	Value
cc	2
eloc	7
nc	2
nop	0
dl	0
loc	11
ccs	7
cts	8
cp	0.875
crap	2.0078
rs	10
c	0
b	0
f	0

<?php

namespace NFLScores\Models;

use NFLScores\Exceptions\NonExistingPropertyException;

/**
 * Represents a NFL game.
 */
class Game
{
    /**
     * The data about the game.
     *
     * @var array
     */
    private $data;

    /**
     * Populate the $data array.
     *
     * @param array $data
     */
    public function __construct(array $data)
    {
        $this->data = $data;
    }

    /**
     * Return the index stored in the $data
     * property, if doesn't exist throw an
     * exception.
     *
     * @param string $name
     *
     * @throws \NFLScores\Exceptions\NonExistingPropertyException
     *
     * @return mixed
     */
    public function __get(string $name)
    {
        if (array_key_exists($name, $this->data)) {
            return $this->data[$name];
        }

        throw new NonExistingPropertyException(sprintf('There is not property called %s in this object', $name));
    }

    /**
     * Return the the current down,
     * if the game hasn't started return null.
     *
     * @return string|null
     */
    public function getCurrentDown(): ?string
    {
        if ($this->score['down'] === 0) {

            return null;
        }

        return sprintf(
            '%d%s & %d',
            $this->score['down'],
            getOrdinalSuffix($this->score['down']),
            $this->score['yardsToGo']
        );
    }

    /**
     * Return the team with the current
     * ball possesion, if the game hasn't
     * started return null.
     *
     * @return string|null
     */
    public function getPossesionTeam(): ?string
    {
        return !$this->isFinished() ? $this->score['possessionTeamAbbr'] : null;

    }

    /**
     * Return the the current quarter,
     * if the game hasn't started return null.
     *
     * @return string|null
     */
    public function getCurrentQuarter(): ?string
    {
        return $this->score['phaseDescription'];

    }

    /**
     * Return whether the game is
     * finished or not.
     *
     * @return bool
     */
    public function isFinished(): bool
    {
        return in_array($this->score['phase'], ['FINAL', 'FINAL OVERTIME']);

    }

    /**
     * Return whether the game is
     * suspended or not.
     *
     * @return bool
     */
    public function isSuspended(): bool
    {
        return $this->score['phase'] === 'SUSPENDED';

    }
}


1		<?php
2
3		namespace NFLScores\Models;
4
5		use NFLScores\Exceptions\NonExistingPropertyException;
6
7		/**
8		* Represents a NFL game.
9		*/
10		class Game
11		{
12		/**
13		* The data about the game.
14		*
15		* @var array
16		*/
17		private $data;
18
19		/**
20		* Populate the $data array.
21		*
22		* @param array $data
23		*/
24	1	public function __construct(array $data)
25		{
26	1	$this->data = $data;
27	1	}
28
29		/**
30		* Return the index stored in the $data
31		* property, if doesn't exist throw an
32		* exception.
33		*
34		* @param string $name
35		*
36		* @throws \NFLScores\Exceptions\NonExistingPropertyException
37		*
38		* @return mixed
39		*/
40	9	public function __get(string $name)
41		{
42	9	if (array_key_exists($name, $this->data)) {
43	9	return $this->data[$name];
44		}
45
46	1	throw new NonExistingPropertyException(sprintf('There is not property called %s in this object', $name));
47		}
48
49		/**
50		* Return the the current down,
51		* if the game hasn't started return null.
52		*
53		* @return string\|null
54		*/
55	1	public function getCurrentDown(): ?string
56		{
57	1	if ($this->score['down'] === 0) {
		0 ignored issues – show Bug Best Practice introduced 2018-10-30 19:41 UTC by Report Bug Copy Issue Report The property `score` does not exist on `NFLScores\Models\Game`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
58		return null;
59		}
60
61	1	return sprintf(
62	1	'%d%s & %d',
63	1	$this->score['down'],
64	1	getOrdinalSuffix($this->score['down']),
65	1	$this->score['yardsToGo']
66		);
67		}
68
69		/**
70		* Return the team with the current
71		* ball possesion, if the game hasn't
72		* started return null.
73		*
74		* @return string\|null
75		*/
76	1	public function getPossesionTeam(): ?string
77		{
78	1	return !$this->isFinished() ? $this->score['possessionTeamAbbr'] : null;
		0 ignored issues – show Bug Best Practice introduced 2018-10-30 19:41 UTC by Report Bug Copy Issue Report The property `score` does not exist on `NFLScores\Models\Game`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
79		}
80
81		/**
82		* Return the the current quarter,
83		* if the game hasn't started return null.
84		*
85		* @return string\|null
86		*/
87	1	public function getCurrentQuarter(): ?string
88		{
89	1	return $this->score['phaseDescription'];
		0 ignored issues – show Bug Best Practice introduced 2018-10-30 19:41 UTC by Report Bug Copy Issue Report The property `score` does not exist on `NFLScores\Models\Game`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
90		}
91
92		/**
93		* Return whether the game is
94		* finished or not.
95		*
96		* @return bool
97		*/
98	1	public function isFinished(): bool
99		{
100	1	return in_array($this->score['phase'], ['FINAL', 'FINAL OVERTIME']);
		0 ignored issues – show Bug Best Practice introduced 2018-10-30 19:41 UTC by Report Bug Copy Issue Report The property `score` does not exist on `NFLScores\Models\Game`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
101		}
102
103		/**
104		* Return whether the game is
105		* suspended or not.
106		*
107		* @return bool
108		*/
109		public function isSuspended(): bool
110		{
111		return $this->score['phase'] === 'SUSPENDED';
		0 ignored issues – show Bug Best Practice introduced 2018-10-30 19:41 UTC by Report Bug Copy Issue Report The property `score` does not exist on `NFLScores\Models\Game`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
112		}
113		}
114

maxalmonte14 / nfl-scores

Push — master ( 652e57...3ec9c1 )

Game::getCurrentDown() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like