Upload::setAdditionalOwners() - Code Metrics - Inspection of "Merge pull request #9 from PeeHaa/feature/media-up..." - PeeHaa/AsyncTwitter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c42e36...b38be8 )

unknown

created 2017-03-06 12:32 UTC

Upload::setAdditionalOwners() A

↳ Parent: Upload

Complexity

Conditions	4
Paths	4

Size

Total Lines	16
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	16
rs	9.2
c	0
b	0
f	0
cc	4
eloc	8
nc	4
nop	1

<?php declare(strict_types = 1);

namespace PeeHaa\AsyncTwitter\Api\Request\Media;

use PeeHaa\AsyncTwitter\Api\Request\Media\Response\UploadResponse;
use PeeHaa\AsyncTwitter\Exception;
use PeeHaa\AsyncTwitter\Request\FieldParameter;
use PeeHaa\AsyncTwitter\Request\FileParameter;

class Upload extends BaseRequest
{
    const METHOD   = 'POST';
    const ENDPOINT = '/media/upload.json';

    public function __construct()
    {
        parent::__construct(self::METHOD, self::ENDPOINT);
    }

    public function setAdditionalOwners(array $userIds)
    {
        if (count($userIds) > 100) {
            throw new Exception('A maximum of 100 addition owners can be specified for a media resource');
        }

        foreach ($userIds as $id) {
            if (!\ctype_digit((string)$id)) {
                throw new Exception('User IDs must be numeric');
            }
        }

        $this->parameters['additional_owners'] = implode(',', $userIds);

        return $this;
    }

    public function getParameters(): array
    {
        $parameters = [new FileParameter('media', $this->parameters['file_path'])];

        if (isset($this->parameters['additional_owners'])) {
            $parameters[] = new FieldParameter('additional_owners', $this->parameters['additional_owners']);
        }

        return $parameters;
    }

    public function handleResponse(array $responseData)
    {
        $mediaId = $responseData['media_id_string'] ?? '';
$a = "a";
$ab = "ab";
$abc = "abc";
        $size = (int)($responseData['size'] ?? 0);
$a = "a";
$ab = "ab";
$abc = "abc";
        $expiryTime = new \DateTimeImmutable('@' . (time() + ($responseData['expires_after_secs'] ?? 0)));
        $mimeType = $responseData['image']['image_type'] ?? '';
$a = "a";
$ab = "ab";
$abc = "abc";
        $width = (int)($responseData['image']['w'] ?? 0);
$a = "a";
$ab = "ab";
$abc = "abc";
        $height = (int)($responseData['image']['h'] ?? 0);
$a = "a";
$ab = "ab";
$abc = "abc";

        return new UploadResponse($mediaId, $size, $expiryTime, $mimeType, $width, $height);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }
}


1			<?php declare(strict_types = 1);
2
3			namespace PeeHaa\AsyncTwitter\Api\Request\Media;
4
5			use PeeHaa\AsyncTwitter\Api\Request\Media\Response\UploadResponse;
6			use PeeHaa\AsyncTwitter\Exception;
7			use PeeHaa\AsyncTwitter\Request\FieldParameter;
8			use PeeHaa\AsyncTwitter\Request\FileParameter;
9
10			class Upload extends BaseRequest
11			{
12			const METHOD = 'POST';
13			const ENDPOINT = '/media/upload.json';
14
15			public function __construct()
16			{
17			parent::__construct(self::METHOD, self::ENDPOINT);
18			}
19
20			public function setAdditionalOwners(array $userIds)
21			{
22			if (count($userIds) > 100) {
23			throw new Exception('A maximum of 100 addition owners can be specified for a media resource');
24			}
25
26			foreach ($userIds as $id) {
27			if (!\ctype_digit((string)$id)) {
28			throw new Exception('User IDs must be numeric');
29			}
30			}
31
32			$this->parameters['additional_owners'] = implode(',', $userIds);
33
34			return $this;
35			}
36
37			public function getParameters(): array
38			{
39			$parameters = [new FileParameter('media', $this->parameters['file_path'])];
40
41			if (isset($this->parameters['additional_owners'])) {
42			$parameters[] = new FieldParameter('additional_owners', $this->parameters['additional_owners']);
43			}
44
45			return $parameters;
46			}
47
48			public function handleResponse(array $responseData)
49			{
50			$mediaId = $responseData['media_id_string'] ?? '';
			0 ignored issues – show Coding Style introduced 2017-03-06 12:37 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
51			$size = (int)($responseData['size'] ?? 0);
			0 ignored issues – show Coding Style introduced 2017-03-06 12:37 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 7 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
52			$expiryTime = new \DateTimeImmutable('@' . (time() + ($responseData['expires_after_secs'] ?? 0)));
53			$mimeType = $responseData['image']['image_type'] ?? '';
			0 ignored issues – show Coding Style introduced 2017-03-06 12:37 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
54			$width = (int)($responseData['image']['w'] ?? 0);
			0 ignored issues – show Coding Style introduced 2017-03-06 12:37 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 6 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
55			$height = (int)($responseData['image']['h'] ?? 0);
			0 ignored issues – show Coding Style introduced 2017-03-06 12:37 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
56
57			return new UploadResponse($mediaId, $size, $expiryTime, $mimeType, $width, $height);
			0 ignored issues – show Bug Best Practice introduced 2017-03-06 12:37 UTC by Report Bug Copy Issue Report The return type of `return new \PeeHaa\Async...Type, $width, $height);` (`PeeHaa\AsyncTwitter\Api\...Response\UploadResponse`) is incompatible with the return type of the parent method `PeeHaa\AsyncTwitter\Api\...Request::handleResponse` of type `array`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
58			}
59			}
60

PeeHaa / AsyncTwitter

Push — master ( c42e36...b38be8 )

Upload::setAdditionalOwners() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like