Phlack::__construct() - Code Metrics - Inspection of "style: Revert previous StyleCI changes to specs" - mcrumm/phlack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#33)

by Michael

created 2016-06-01 03:12 UTC

Phlack::__construct() A

↳ Parent: Phlack

Complexity

Conditions	4
Paths	3

Size

Total Lines	16
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	12
CRAP Score	4

Importance

Changes	3
Bugs	1	Features	1

Metric	Value
c	3
b	1
f	1
dl	0
loc	16
ccs	12
cts	12
cp	1
rs	9.2
cc	4
eloc	10
nc	3
nop	1
crap	4

<?php

namespace Crummy\Phlack;

use Crummy\Phlack\Bridge\Guzzle\PhlackClient;
use Crummy\Phlack\Bridge\Guzzle\Response\MessageResponse;
use Crummy\Phlack\Common\Exception\UnexpectedTypeException;
use Guzzle\Common\Collection;
use JsonSerializable;

class Phlack extends Collection
{
    /**
     * Phlack Constructor.
     *
     * @param mixed $client
     *
     * @throws UnexpectedTypeException
     */
    public function __construct($client)
    {
        if (is_string($client) || is_array($client)) {
            $client = new PhlackClient($client);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        } elseif (!$client instanceof PhlackClient) {
            throw new UnexpectedTypeException($client, ['string', 'array', 'Crummy\Phlack\Bridge\Guzzle\PhlackClient']);
        }

        parent::__construct([
            'client'   => $client,
            'builders' => [],
            'commands' => [
                'send' => 'Send',
            ],
        ]);
    }

    /**
     * Phlack Factory.
     *
     * @param array|string $config
     *
     * @return Phlack
     */
    public static function factory($config = [])
    {
        return new self(new PhlackClient($config));

    }

    /**
     * @return Phlack
     */
    public static function fromConfig(array $config = [], array $defaults = [], array $required = [])
    {
        return new self(new PhlackClient($config));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * @param string|array|JsonSerializable $message
     *
     * @throws UnexpectedTypeException
     *
     * @return MessageResponse
     */
    public function send($message)
    {
        return $this['client']->getCommand($this['commands']['send'], $this->toParameters($message))->execute();
    }

    /**
     * @return Bridge\Guzzle\PhlackClient
     */
    public function getClient()
    {
        return $this['client'];
    }

    /**
     * @return Builder\MessageBuilder
     */
    public function getMessageBuilder()
    {
        if (!isset($this['builders']['message'])) {
            $this->setPath('builders/message', new Builder\MessageBuilder());
        }

        return $this['builders']['message'];
    }

    /**
     * @return Builder\AttachmentBuilder
     */
    public function getAttachmentBuilder()
    {
        if (!isset($this['builders']['attachment'])) {
            $this->setPath('builders/attachment', new Builder\AttachmentBuilder());
        }

        return $this['builders']['attachment'];
    }

    /**
     * @param mixed $message
     *
     * @throws UnexpectedTypeException
     *
     * @return array
     */
    private function toParameters($message)
    {
        if (is_string($message)) {
            return $this->getMessageBuilder()->setText($message)->create()->jsonSerialize();
        } elseif (is_array($message)) {
            return $message;
        } elseif ($message instanceof JsonSerializable) {
            return $message->jsonSerialize();
        }

        throw new UnexpectedTypeException($message, ['string', 'array', 'JsonSerializable']);
    }
}


1		<?php
2
3		namespace Crummy\Phlack;
4
5		use Crummy\Phlack\Bridge\Guzzle\PhlackClient;
6		use Crummy\Phlack\Bridge\Guzzle\Response\MessageResponse;
7		use Crummy\Phlack\Common\Exception\UnexpectedTypeException;
8		use Guzzle\Common\Collection;
9		use JsonSerializable;
10
11		class Phlack extends Collection
12		{
13		/**
14		* Phlack Constructor.
15		*
16		* @param mixed $client
17		*
18		* @throws UnexpectedTypeException
19		*/
20	15	public function __construct($client)
21		{
22	15	if (is_string($client) \|\| is_array($client)) {
23	2	$client = new PhlackClient($client);
		0 ignored issues – show Bug introduced 2016-05-02 12:25 UTC by Report Bug Copy Issue Report It seems like `$client` defined by `new \Crummy\Phlack\Bridg...e\PhlackClient($client)` on line `23` can also be of type `array`; however, `Crummy\Phlack\Bridge\Guz...ckClient::__construct()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
24	15	} elseif (!$client instanceof PhlackClient) {
25	1	throw new UnexpectedTypeException($client, ['string', 'array', 'Crummy\Phlack\Bridge\Guzzle\PhlackClient']);
26		}
27
28	14	parent::__construct([
29	14	'client' => $client,
30	14	'builders' => [],
31		'commands' => [
32	14	'send' => 'Send',
33	14	],
34	14	]);
35	14	}
36
37		/**
38		* Phlack Factory.
39		*
40		* @param array\|string $config
41		*
42		* @return Phlack
43		*/
44	2	public static function factory($config = [])
45		{
46	2	return new self(new PhlackClient($config));
		0 ignored issues – show Bug introduced 2016-05-02 12:25 UTC by Report Bug Copy Issue Report It seems like `$config` defined by parameter `$config` on line 44 can also be of type `array`; however, `Crummy\Phlack\Bridge\Guz...ckClient::__construct()` does only seem to accept `string`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
47		}
48
49		/**
50		* @return Phlack
51		*/
52	1	public static function fromConfig(array $config = [], array $defaults = [], array $required = [])
53		{
54	1	return new self(new PhlackClient($config));
		0 ignored issues – show Documentation introduced 2015-12-27 19:07 UTC by Report Bug Copy Issue Report `$config` is of type `array`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
55		}
56
57		/**
58		* @param string\|array\|JsonSerializable $message
59		*
60		* @throws UnexpectedTypeException
61		*
62		* @return MessageResponse
63		*/
64	5	public function send($message)
65		{
66	5	return $this['client']->getCommand($this['commands']['send'], $this->toParameters($message))->execute();
67		}
68
69		/**
70		* @return Bridge\Guzzle\PhlackClient
71		*/
72	6	public function getClient()
73		{
74	6	return $this['client'];
75		}
76
77		/**
78		* @return Builder\MessageBuilder
79		*/
80	2	public function getMessageBuilder()
81		{
82	2	if (!isset($this['builders']['message'])) {
83	2	$this->setPath('builders/message', new Builder\MessageBuilder());
84	2	}
85
86	2	return $this['builders']['message'];
87		}
88
89		/**
90		* @return Builder\AttachmentBuilder
91		*/
92	1	public function getAttachmentBuilder()
93		{
94	1	if (!isset($this['builders']['attachment'])) {
95	1	$this->setPath('builders/attachment', new Builder\AttachmentBuilder());
96	1	}
97
98	1	return $this['builders']['attachment'];
99		}
100
101		/**
102		* @param mixed $message
103		*
104		* @throws UnexpectedTypeException
105		*
106		* @return array
107		*/
108	5	private function toParameters($message)
109		{
110	5	if (is_string($message)) {
111	1	return $this->getMessageBuilder()->setText($message)->create()->jsonSerialize();
112	4	} elseif (is_array($message)) {
113	1	return $message;
114	3	} elseif ($message instanceof JsonSerializable) {
115	2	return $message->jsonSerialize();
116		}
117
118	1	throw new UnexpectedTypeException($message, ['string', 'array', 'JsonSerializable']);
119		}
120		}
121

mcrumm / phlack

Pull Request — develop (#33)

Phlack::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like