GetGameScore::getMandatoryFields() - Code Metrics - Inspection of "Strict PHP inspection" - unreal4u/telegram-api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 54e92f...46abfb )

by Camilo

created 2017-01-08 02:33 UTC

GetGameScore::getMandatoryFields() A

↳ Parent: GetGameScore

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	0

<?php

declare(strict_types = 1);

namespace unreal4u\TelegramAPI\Telegram\Methods;

use Psr\Log\LoggerInterface;
use unreal4u\TelegramAPI\Abstracts\TelegramMethods;
use unreal4u\TelegramAPI\Abstracts\TelegramTypes;
use unreal4u\TelegramAPI\InternalFunctionality\TelegramRawData;
use unreal4u\TelegramAPI\Telegram\Types\Custom\GameHighScoreArray;

/**
 * Use this method to get data for high score tables. Will return the score of the specified user and several of his
 * neighbors in a game. On success, returns an Array of GameHighScore objects.
 *
 * This method will currently return scores for the target user, plus two of his closest neighbors on each side. Will
 * also return the top three users if the user and his neighbors are not among them. Please note that this behavior is
 * subject to change.
 *
 * Objects defined as-is January 2017
 *
 * @see https://core.telegram.org/bots/api#getgamescore
 */
class GetGameScore extends TelegramMethods
{
    /**
     * Target user id
     * @var int
     */
    public $user_id = 0;

    /**
     * Required if inline_message_id is not specified. Unique identifier for the target chat
     * @var int
     */
    public $chat_id;

    /**
     * Required if inline_message_id is not specified. Identifier of the sent message
     * @var int
     */
    public $message_id;

    /**
     * Required if chat_id and message_id are not specified. Identifier of the inline message
     * @var string
     */
    public $inline_message_id;

    public static function bindToObject(TelegramRawData $data, LoggerInterface $logger): TelegramTypes
    {
        return new GameHighScoreArray($data->getResult(), $logger);
    }

    public function getMandatoryFields(): array
    {
        // user_id and score are always mandatory
        $returnValue[] = 'user_id';
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        return $this->mandatoryUserOrInlineMessageId($returnValue);
    }
}


1			<?php
2
3			declare(strict_types = 1);
4
5			namespace unreal4u\TelegramAPI\Telegram\Methods;
6
7			use Psr\Log\LoggerInterface;
8			use unreal4u\TelegramAPI\Abstracts\TelegramMethods;
9			use unreal4u\TelegramAPI\Abstracts\TelegramTypes;
10			use unreal4u\TelegramAPI\InternalFunctionality\TelegramRawData;
11			use unreal4u\TelegramAPI\Telegram\Types\Custom\GameHighScoreArray;
12
13			/**
14			* Use this method to get data for high score tables. Will return the score of the specified user and several of his
15			* neighbors in a game. On success, returns an Array of GameHighScore objects.
16			*
17			* This method will currently return scores for the target user, plus two of his closest neighbors on each side. Will
18			* also return the top three users if the user and his neighbors are not among them. Please note that this behavior is
19			* subject to change.
20			*
21			* Objects defined as-is January 2017
22			*
23			* @see https://core.telegram.org/bots/api#getgamescore
24			*/
25			class GetGameScore extends TelegramMethods
26			{
27			/**
28			* Target user id
29			* @var int
30			*/
31			public $user_id = 0;
32
33			/**
34			* Required if inline_message_id is not specified. Unique identifier for the target chat
35			* @var int
36			*/
37			public $chat_id;
38
39			/**
40			* Required if inline_message_id is not specified. Identifier of the sent message
41			* @var int
42			*/
43			public $message_id;
44
45			/**
46			* Required if chat_id and message_id are not specified. Identifier of the inline message
47			* @var string
48			*/
49			public $inline_message_id;
50
51			public static function bindToObject(TelegramRawData $data, LoggerInterface $logger): TelegramTypes
52			{
53			return new GameHighScoreArray($data->getResult(), $logger);
54			}
55
56			public function getMandatoryFields(): array
57			{
58			// user_id and score are always mandatory
59			$returnValue[] = 'user_id';
			0 ignored issues – show Coding Style Comprehensibility introduced 2017-01-08 02:38 UTC by Report Bug Copy Issue Report `$returnValue` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$returnValue = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
60			return $this->mandatoryUserOrInlineMessageId($returnValue);
61			}
62			}
63

unreal4u / telegram-api

Push — master ( 54e92f...46abfb )

GetGameScore::getMandatoryFields() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like