Volume::__isset() - Code Metrics - Inspection of "Implement `__isset` on Bookshelf and Volumn class" - scriptotek/php-google-books - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6c5b86...657a58 )

by Dan Michael O.

created 2018-02-03 15:50 UTC

Volume::__isset() A

↳ Parent: Volume

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	0
loc	4
rs	10
c	1
b	0
f	0
cc	2
eloc	2
nc	2
nop	1

<?php

namespace Scriptotek\GoogleBooks;

class Volume
{
    protected $client;
    protected $data;
    protected $full = false;

    protected static $coverSizes = [
        "extraLarge",
        "large",
        "medium",
        "small",
        "thumbnail",
        "smallThumbnail",
    ];

    public function __construct($client, $data, $full=false)

    {
        $this->client = $client;
        $this->data = $data;
    }

    /**
     * Returns cover of size $preferredSize or smaller if a cover of size $preferredSize does not exist.
     *
     * @param string $preferredSize
     * @return mixed|null
     */
    public function getCover($preferredSize='extraLarge')
    {
        $url = null;

        if (!isset($this->data->volumeInfo) || !isset($this->data->volumeInfo->imageLinks)) {
            return null;
        }

        if (!$this->full && !in_array($preferredSize, ['thumbnail', 'smallThumbnail'])) {
            // Need to fetch the full record
            $this->data = $this->client->getItem('volumes/' . $this->id);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }

        $idx = array_search($preferredSize, self::$coverSizes);
        if ($idx === false) {
            throw new \InvalidArgumentException('Invalid size: ' . $preferredSize);
        }

        foreach (self::$coverSizes as $n => $size) {
            if ($n >= $idx && isset($this->data->volumeInfo->imageLinks->{$size})) {
                $url = $this->data->volumeInfo->imageLinks->{$size};
                break;
            }
        }

        return $this->removeCoverEdge($url);
    }

    protected function removeCoverEdge($url) {
        // Remove cover edge
        if (is_null($url)) {
            return null;
        }
        return str_replace('&edge=curl', '&edge=none', $url);
    }

    public function __get($key)
    {
        if (isset($this->data->volumeInfo->{$key})) {
            return $this->data->volumeInfo->{$key};
        } else if (isset($this->data->{$key})) {
            return $this->data->{$key};
        }
    }
    
    public function __isset($key)
    {
        return isset($this->data->volumeInfo->{$key}) || isset($this->data->{$key});
    }

    public function __toString()
    {
        return json_encode($this->data);
    }
}


1			<?php
2
3			namespace Scriptotek\GoogleBooks;
4
5			class Volume
6			{
7			protected $client;
8			protected $data;
9			protected $full = false;
10
11			protected static $coverSizes = [
12			"extraLarge",
13			"large",
14			"medium",
15			"small",
16			"thumbnail",
17			"smallThumbnail",
18			];
19
20			public function __construct($client, $data, $full=false)
			0 ignored issues – show Unused Code introduced 2017-11-04 03:03 UTC by Report Bug Copy Issue Report The parameter `$full` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
21			{
22			$this->client = $client;
23			$this->data = $data;
24			}
25
26			/**
27			* Returns cover of size $preferredSize or smaller if a cover of size $preferredSize does not exist.
28			*
29			* @param string $preferredSize
30			* @return mixed\|null
31			*/
32			public function getCover($preferredSize='extraLarge')
33			{
34			$url = null;
35
36			if (!isset($this->data->volumeInfo) \|\| !isset($this->data->volumeInfo->imageLinks)) {
37			return null;
38			}
39
40			if (!$this->full && !in_array($preferredSize, ['thumbnail', 'smallThumbnail'])) {
41			// Need to fetch the full record
42			$this->data = $this->client->getItem('volumes/' . $this->id);
			0 ignored issues – show Documentation introduced 2016-09-20 21:38 UTC by Report Bug Copy Issue Report The property `id` does not exist on `object<Scriptotek\GoogleBooks\Volume>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
43			}
44
45			$idx = array_search($preferredSize, self::$coverSizes);
46			if ($idx === false) {
47			throw new \InvalidArgumentException('Invalid size: ' . $preferredSize);
48			}
49
50			foreach (self::$coverSizes as $n => $size) {
51			if ($n >= $idx && isset($this->data->volumeInfo->imageLinks->{$size})) {
52			$url = $this->data->volumeInfo->imageLinks->{$size};
53			break;
54			}
55			}
56
57			return $this->removeCoverEdge($url);
58			}
59
60			protected function removeCoverEdge($url) {
61			// Remove cover edge
62			if (is_null($url)) {
63			return null;
64			}
65			return str_replace('&edge=curl', '&edge=none', $url);
66			}
67
68			public function __get($key)
69			{
70			if (isset($this->data->volumeInfo->{$key})) {
71			return $this->data->volumeInfo->{$key};
72			} else if (isset($this->data->{$key})) {
73			return $this->data->{$key};
74			}
75			}
76
77			public function __isset($key)
78			{
79			return isset($this->data->volumeInfo->{$key}) \|\| isset($this->data->{$key});
80			}
81
82			public function __toString()
83			{
84			return json_encode($this->data);
85			}
86			}
87

scriptotek / php-google-books

Push — master ( 6c5b86...657a58 )

Volume::__isset() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like