Image::delete() - Code Metrics - mechpave/imgur-client - Measure and Improve Code Quality continuously with Scrutinizer

Image::delete() A
last analyzed 2016-01-03 17:41 UTC

↳ Parent: Image

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	8
ccs	0
cts	7
cp	0
rs	9.4286
cc	1
eloc	4
nc	1
nop	1
crap	2

<?php

namespace Mechpave\ImgurClient\Api;

use Mechpave\ImgurClient\Entity\ImageInterface;
use Mechpave\ImgurClient\Http\HttpClientInterface;
use Mechpave\ImgurClient\Mapper\ImageMapper;
use Mechpave\ImgurClient\Model\ImageModel;

/**
 * Class Image
 * @package Mechpave\ImgurClient\Api
 * @see http://api.imgur.com/endpoints/image
 */
class Image extends AbstractApi
{
    /**
     * @var ImageMapper
     */
    protected $imageMapper;

    /**
     * Image constructor.
     * @param HttpClientInterface $httpClient
     * @param ImageMapper $imageMapper
     */
    public function __construct(HttpClientInterface $httpClient, ImageMapper $imageMapper)
    {
        parent::__construct($httpClient);
        $this->imageMapper = $imageMapper;
    }

    /**
     * Get image Information endpoint
     *
     * @param $id
     * @return ImageInterface
     */
    public function get($id)
    {
        $response = $this->httpClient->get(
            'image/' . $id
        );

        $image = $this->imageMapper->buildImage($response->getBody()['data']);

        return $image;
    }

    /**
     * Upload Image to Imgur
     *
     * @param string $image A binary file (path to file), base64 data, or a URL for an image. (up to 10MB)
     * @param string $type Image type. Use Mechpave\ImgurClient\Model\ImageModel
     * @param string $title The title of the image
     * @param string $description The description of the image
     * @param string $album The id of the album you want to add the image to. For anonymous albums, {album} should be the deletehash that is returned at creation.
     * @param string $name The name of the file
     * @throws \UnexpectedValueException
     * @return ImageInterface
     */
    public function upload(
        $image,
        $type,
        $title = null,
        $description = null,
        $album = null,
        $name = null
    )
    {
        if ($type == ImageModel::TYPE_FILE) {
            //check if file exists and get its contents

            if (!file_exists($image)) {
                throw new \UnexpectedValueException('Provided file does not exist');
            }

            $contents = file_get_contents($image);
            if (!$contents) {
                throw new \UnexpectedValueException('Could not get file contents');
            }

            $image = $contents;
        }

        $postData = [
            'image' => $image,
            'type' => $type,
        ];

        if ($title) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $postData['title'] = $title;
        }
        if ($name) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $postData['name'] = $name;
        }
        if ($description) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $postData['description'] = $description;
        }
        if ($album) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $postData['album'] = $album;
        }

        $response = $this->httpClient->post(
            'image',
            $postData
        );

        $image = $this->imageMapper->buildImage($response->getBody()['data']);

        return $image;
    }

    /**
     * Update uploaded image. You can only update title or description of the image
     *
     * @param string $id Imgur Id of the image. For anonymous image it must be deleteHash
     * @param string $title The title of the image.
     * @param string $description The description of the image
     * @return bool
     */
    public function update(
        $id,
        $title = null,
        $description = null
    )
    {
        $postData = [];

        if ($title) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $postData['title'] = $title;
        }
        if ($description) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $postData['description'] = $description;
        }

        $response = $this->httpClient->post(
            'image/' . $id,
            $postData
        );

        return $response->getBody()['success'];
    }

    /**
     * Delete image from Imgur
     *
     * @param string $id Imgur Id of the image. For anonymous image it must be deleteHash
     * @return bool
     */
    public function delete($id)
    {
        $response = $this->httpClient->delete(
            'image/' . $id
        );

        return $response->getBody()['success'];
    }

    /**
     * Favorite an image with the given ID. The user is required to be logged in to favorite the image.
     *
     * @param string $id Imgur Id of the image.
     * @return bool
     */
    public function favorite($id)
    {
        $response = $this->httpClient->post(
            'image/' . $id . '/favorite'
        );

        return $response->getBody()['success'];
    }
}

1			<?php
2
3			namespace Mechpave\ImgurClient\Api;
4
5			use Mechpave\ImgurClient\Entity\ImageInterface;
6			use Mechpave\ImgurClient\Http\HttpClientInterface;
7			use Mechpave\ImgurClient\Mapper\ImageMapper;
8			use Mechpave\ImgurClient\Model\ImageModel;
9
10			/**
11			* Class Image
12			* @package Mechpave\ImgurClient\Api
13			* @see http://api.imgur.com/endpoints/image
14			*/
15			class Image extends AbstractApi
16			{
17			/**
18			* @var ImageMapper
19			*/
20			protected $imageMapper;
21
22			/**
23			* Image constructor.
24			* @param HttpClientInterface $httpClient
25			* @param ImageMapper $imageMapper
26			*/
27			public function __construct(HttpClientInterface $httpClient, ImageMapper $imageMapper)
28			{
29			parent::__construct($httpClient);
30			$this->imageMapper = $imageMapper;
31			}
32
33			/**
34			* Get image Information endpoint
35			*
36			* @param $id
37			* @return ImageInterface
38			*/
39			public function get($id)
40			{
41			$response = $this->httpClient->get(
42			'image/' . $id
43			);
44
45			$image = $this->imageMapper->buildImage($response->getBody()['data']);
46
47			return $image;
48			}
49
50			/**
51			* Upload Image to Imgur
52			*
53			* @param string $image A binary file (path to file), base64 data, or a URL for an image. (up to 10MB)
54			* @param string $type Image type. Use Mechpave\ImgurClient\Model\ImageModel
55			* @param string $title The title of the image
56			* @param string $description The description of the image
57			* @param string $album The id of the album you want to add the image to. For anonymous albums, {album} should be the deletehash that is returned at creation.
58			* @param string $name The name of the file
59			* @throws \UnexpectedValueException
60			* @return ImageInterface
61			*/
62			public function upload(
63			$image,
64			$type,
65			$title = null,
66			$description = null,
67			$album = null,
68			$name = null
69			)
70			{
71			if ($type == ImageModel::TYPE_FILE) {
72			//check if file exists and get its contents
73
74			if (!file_exists($image)) {
75			throw new \UnexpectedValueException('Provided file does not exist');
76			}
77
78			$contents = file_get_contents($image);
79			if (!$contents) {
80			throw new \UnexpectedValueException('Could not get file contents');
81			}
82
83			$image = $contents;
84			}
85
86			$postData = [
87			'image' => $image,
88			'type' => $type,
89			];
90
91			if ($title) {
			0 ignored issues – show Bug Best Practice introduced 2016-01-03 15:31 UTC by Report Bug Copy Issue Report The expression `$title` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
92			$postData['title'] = $title;
93			}
94			if ($name) {
			0 ignored issues – show Bug Best Practice introduced 2016-01-03 15:31 UTC by Report Bug Copy Issue Report The expression `$name` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
95			$postData['name'] = $name;
96			}
97			if ($description) {
			0 ignored issues – show Bug Best Practice introduced 2016-01-03 15:31 UTC by Report Bug Copy Issue Report The expression `$description` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
98			$postData['description'] = $description;
99			}
100			if ($album) {
			0 ignored issues – show Bug Best Practice introduced 2016-01-03 15:31 UTC by Report Bug Copy Issue Report The expression `$album` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
101			$postData['album'] = $album;
102			}
103
104			$response = $this->httpClient->post(
105			'image',
106			$postData
107			);
108
109			$image = $this->imageMapper->buildImage($response->getBody()['data']);
110
111			return $image;
112			}
113
114			/**
115			* Update uploaded image. You can only update title or description of the image
116			*
117			* @param string $id Imgur Id of the image. For anonymous image it must be deleteHash
118			* @param string $title The title of the image.
119			* @param string $description The description of the image
120			* @return bool
121			*/
122			public function update(
123			$id,
124			$title = null,
125			$description = null
126			)
127			{
128			$postData = [];
129
130			if ($title) {
			0 ignored issues – show Bug Best Practice introduced 2016-01-03 15:31 UTC by Report Bug Copy Issue Report The expression `$title` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
131			$postData['title'] = $title;
132			}
133			if ($description) {
			0 ignored issues – show Bug Best Practice introduced 2016-01-03 15:31 UTC by Report Bug Copy Issue Report The expression `$description` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
134			$postData['description'] = $description;
135			}
136
137			$response = $this->httpClient->post(
138			'image/' . $id,
139			$postData
140			);
141
142			return $response->getBody()['success'];
143			}
144
145			/**
146			* Delete image from Imgur
147			*
148			* @param string $id Imgur Id of the image. For anonymous image it must be deleteHash
149			* @return bool
150			*/
151			public function delete($id)
152			{
153			$response = $this->httpClient->delete(
154			'image/' . $id
155			);
156
157			return $response->getBody()['success'];
158			}
159
160			/**
161			* Favorite an image with the given ID. The user is required to be logged in to favorite the image.
162			*
163			* @param string $id Imgur Id of the image.
164			* @return bool
165			*/
166			public function favorite($id)
167			{
168			$response = $this->httpClient->post(
169			'image/' . $id . '/favorite'
170			);
171
172			return $response->getBody()['success'];
173			}
174			}

mechpave / imgur-client

Image::delete() A last analyzed 2016-01-03 17:41 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Image::delete() A
last analyzed 2016-01-03 17:41 UTC