VimeoServiceAdapter::getThumbnails() - Code Metrics - Inspection of "Merge pull request #5 from ricardofiorani/secure-o..." - ricardofiorani/php-video-url-parser - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 007be0...4b2a2e )

by Ricardo

created 2016-03-17 17:30 UTC

VimeoServiceAdapter::getThumbnails() A

↳ Parent: VimeoServiceAdapter::setThumbnails()

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php
/**
 * Created by PhpStorm.
 * User: Ricardo Fiorani
 * Date: 29/08/2015
 * Time: 14:56.
 */
namespace RicardoFiorani\Adapter\Vimeo;

use RicardoFiorani\Adapter\AbstractServiceAdapter;
use RicardoFiorani\Exception\InvalidThumbnailSizeException;
use RicardoFiorani\Exception\ServiceApiNotAvailable;
use RicardoFiorani\Renderer\EmbedRendererInterface;

class VimeoServiceAdapter extends AbstractServiceAdapter
{
    const THUMBNAIL_SMALL = 'thumbnail_small';
$a = "a";
$ab = "ab";
$abc = "abc";
    const THUMBNAIL_MEDIUM = 'thumbnail_medium';
    const THUMBNAIL_LARGE = 'thumbnail_large';
$a = "a";
$ab = "ab";
$abc = "abc";

    /**
     * @var string
     */
    public $title;

    /**
     * @var string
     */
    public $description;

    /**
     * @var array
     */
    public $thumbnails;

    /**
     * @param string $url
     * @param string $pattern
     * @param EmbedRendererInterface $renderer
     */
    public function __construct($url, $pattern, EmbedRendererInterface $renderer)
    {
        $videoId = $this->getVideoIdByPattern($url, $pattern);
        $this->setVideoId($videoId);
        $videoData = $this->getVideoDataFromServiceApi();

        $this->setThumbnails(array(
            self::THUMBNAIL_SMALL => $videoData[self::THUMBNAIL_SMALL],
            self::THUMBNAIL_MEDIUM => $videoData[self::THUMBNAIL_MEDIUM],
            self::THUMBNAIL_LARGE => $videoData[self::THUMBNAIL_LARGE],
        ));

        $this->setTitle($videoData['title']);
        $this->setDescription($videoData['description']);

        return parent::__construct($url, $pattern, $renderer);
    }

    /**
     * Returns the service name (ie: "Youtube" or "Vimeo").
     *
     * @return string
     */
    public function getServiceName()
    {
        return 'Vimeo';
    }

    /**
     * Returns if the service has a thumbnail image.
     *
     * @return bool
     */
    public function hasThumbnail()
    {
        return false == empty($this->thumbnails);

    }

    /**
     * @return string
     */
    public function getTitle()
    {
        return $this->title;
    }

    /**
     * @param string $title
     */
    public function setTitle($title)
    {
        $this->title = $title;
    }

    /**
     * @return string
     */
    public function getDescription()
    {
        return $this->description;
    }

    /**
     * @param string $description
     */
    public function setDescription($description)
    {
        $this->description = $description;
    }

    /**
     * @param array $thumbnails
     */
    private function setThumbnails(array $thumbnails)
    {
        foreach ($thumbnails as $key => $thumbnail) {
            $this->thumbnails[$key] = parse_url($thumbnail);
        }
    }

    /**
     * @param string $size
     *
     * @return string
     *
     * @throws InvalidThumbnailSizeException
     */
    public function getThumbnail($size, $secure = false)
    {
        if (false == in_array($size, $this->getThumbNailSizes())) {

            throw new InvalidThumbnailSizeException();
        }

        return $this->getScheme($secure) . '://' . $this->thumbnails[$size]['host'] . $this->thumbnails[$size]['path'];
    }

    /**
     * @param bool $autoplay
     *
     * @return string
     */
    public function getEmbedUrl($autoplay = false, $secure = false)
    {
        return $this->getScheme($secure) . '://player.vimeo.com/video/' . $this->getVideoId() . ($autoplay ? '?autoplay=1' : '');

    }

    /**
     * Returns all thumbnails available sizes.
     *
     * @return array

     */
    public function getThumbNailSizes()
    {
        return array(
            self::THUMBNAIL_SMALL,
            self::THUMBNAIL_MEDIUM,
            self::THUMBNAIL_LARGE,
        );
    }

    /**
     * Returns the small thumbnail's url.
     *
     * @param bool $secure
     * @return string
     * @throws InvalidThumbnailSizeException
     */
    public function getSmallThumbnail($secure = false)
    {
        return $this->getThumbnail(self::THUMBNAIL_SMALL,$secure);
    }

    /**
     * Returns the medium thumbnail's url.
     *
     * @param bool $secure
     * @return string
     * @throws InvalidThumbnailSizeException
     */
    public function getMediumThumbnail($secure = false)
    {
        return $this->getThumbnail(self::THUMBNAIL_MEDIUM,$secure);
    }

    /**
     * Returns the large thumbnail's url.
     *
     * @param bool $secure
     * @param $secure
     * @return string
     * @throws InvalidThumbnailSizeException
     */
    public function getLargeThumbnail($secure = false)
    {
        return $this->getThumbnail(self::THUMBNAIL_LARGE,$secure);
    }

    /**
     * Returns the largest thumnbnaail's url.
     *
     * @param bool $secure
     * @param $secure
     * @return string
     * @throws InvalidThumbnailSizeException
     */
    public function getLargestThumbnail($secure = false)
    {
        return $this->getThumbnail(self::THUMBNAIL_LARGE,$secure);
    }

    /**
     * @return bool
     */
    public function isEmbeddable()
    {
        return true;
    }

    /**
     * @param string $url
     * @param string $pattern
     *
     * @return int

     */
    private function getVideoIdByPattern($url, $pattern)
    {
        $match = array();
        preg_match($pattern, $url, $match);
        $videoId = $match[2];

        return $videoId;
    }

    /**
     * Uses the Vimeo video API to get video info.
     *
     * @todo make this better by using guzzle

     *
     * @return array
     *
     * @throws ServiceApiNotAvailable
     */
    private function getVideoDataFromServiceApi()
    {
        $contents = file_get_contents('http://vimeo.com/api/v2/video/' . $this->getVideoId() . '.php');
        if (false === $contents) {
            throw new ServiceApiNotAvailable('Vimeo Service Adapter could not reach Vimeo API Service. Check if your server has file_get_contents() function available.');

        }
        $hash = unserialize($contents);

        return reset($hash);
    }
}



1		<?php
2		/**
3		* Created by PhpStorm.
4		* User: Ricardo Fiorani
5		* Date: 29/08/2015
6		* Time: 14:56.
7		*/
8		namespace RicardoFiorani\Adapter\Vimeo;
9
10		use RicardoFiorani\Adapter\AbstractServiceAdapter;
11		use RicardoFiorani\Exception\InvalidThumbnailSizeException;
12		use RicardoFiorani\Exception\ServiceApiNotAvailable;
13		use RicardoFiorani\Renderer\EmbedRendererInterface;
14
15		class VimeoServiceAdapter extends AbstractServiceAdapter
16		{
17		const THUMBNAIL_SMALL = 'thumbnail_small';
		0 ignored issues – show Coding Style introduced 2016-02-11 16:29 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 2 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...
18		const THUMBNAIL_MEDIUM = 'thumbnail_medium';
19		const THUMBNAIL_LARGE = 'thumbnail_large';
		0 ignored issues – show Coding Style introduced 2016-02-11 16:29 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 2 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...
20
21		/**
22		* @var string
23		*/
24		public $title;
25
26		/**
27		* @var string
28		*/
29		public $description;
30
31		/**
32		* @var array
33		*/
34		public $thumbnails;
35
36		/**
37		* @param string $url
38		* @param string $pattern
39		* @param EmbedRendererInterface $renderer
40		*/
41	12	public function __construct($url, $pattern, EmbedRendererInterface $renderer)
42		{
43	12	$videoId = $this->getVideoIdByPattern($url, $pattern);
44	12	$this->setVideoId($videoId);
45	12	$videoData = $this->getVideoDataFromServiceApi();
46
47	12	$this->setThumbnails(array(
48	12	self::THUMBNAIL_SMALL => $videoData[self::THUMBNAIL_SMALL],
49	12	self::THUMBNAIL_MEDIUM => $videoData[self::THUMBNAIL_MEDIUM],
50	12	self::THUMBNAIL_LARGE => $videoData[self::THUMBNAIL_LARGE],
51	12	));
52
53	12	$this->setTitle($videoData['title']);
54	12	$this->setDescription($videoData['description']);
55
56	12	return parent::__construct($url, $pattern, $renderer);
57		}
58
59		/**
60		* Returns the service name (ie: "Youtube" or "Vimeo").
61		*
62		* @return string
63		*/
64	1	public function getServiceName()
65		{
66	1	return 'Vimeo';
67		}
68
69		/**
70		* Returns if the service has a thumbnail image.
71		*
72		* @return bool
73		*/
74	1	public function hasThumbnail()
75		{
76	1	return false == empty($this->thumbnails);
		0 ignored issues – show Coding Style Best Practice introduced 2016-02-11 16:29 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing two booleans. Considering using the strict comparison `===` instead. When comparing two booleans, it is generally considered safer to use the strict comparison operator. Loading history...
77		}
78
79		/**
80		* @return string
81		*/
82	1	public function getTitle()
83		{
84	1	return $this->title;
85		}
86
87		/**
88		* @param string $title
89		*/
90	12	public function setTitle($title)
91		{
92	12	$this->title = $title;
93	12	}
94
95		/**
96		* @return string
97		*/
98	1	public function getDescription()
99		{
100	1	return $this->description;
101		}
102
103		/**
104		* @param string $description
105		*/
106	12	public function setDescription($description)
107		{
108	12	$this->description = $description;
109	12	}
110
111		/**
112		* @param array $thumbnails
113		*/
114	1	private function setThumbnails(array $thumbnails)
115		{
116	1	foreach ($thumbnails as $key => $thumbnail) {
117		$this->thumbnails[$key] = parse_url($thumbnail);
118		}
119		}
120
121		/**
122	12	* @param string $size
123		*
124	12	* @return string
125	12	*
126		* @throws InvalidThumbnailSizeException
127		*/
128		public function getThumbnail($size, $secure = false)
129		{
130		if (false == in_array($size, $this->getThumbNailSizes())) {
		0 ignored issues – show Coding Style Best Practice introduced 2016-02-11 16:29 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing two booleans. Considering using the strict comparison `===` instead. When comparing two booleans, it is generally considered safer to use the strict comparison operator. Loading history...
131		throw new InvalidThumbnailSizeException();
132		}
133
134	2	return $this->getScheme($secure) . '://' . $this->thumbnails[$size]['host'] . $this->thumbnails[$size]['path'];
135		}
136	2
137	1	/**
138		* @param bool $autoplay
139		*
140	1	* @return string
141		*/
142		public function getEmbedUrl($autoplay = false, $secure = false)
143		{
144		return $this->getScheme($secure) . '://player.vimeo.com/video/' . $this->getVideoId() . ($autoplay ? '?autoplay=1' : '');
		0 ignored issues – show Coding Style introduced 2016-03-17 17:28 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 129 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
145		}
146
147		/**
148	1	* Returns all thumbnails available sizes.
149		*
150	1	* @return array
		0 ignored issues – show Documentation introduced 2016-02-11 16:29 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `string[]`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
151		*/
152		public function getThumbNailSizes()
153		{
154		return array(
155		self::THUMBNAIL_SMALL,
156		self::THUMBNAIL_MEDIUM,
157		self::THUMBNAIL_LARGE,
158	3	);
159		}
160
161	3	/**
162	3	* Returns the small thumbnail's url.
163	3	*
164	3	* @param bool $secure
165		* @return string
166		* @throws InvalidThumbnailSizeException
167		*/
168		public function getSmallThumbnail($secure = false)
169		{
170		return $this->getThumbnail(self::THUMBNAIL_SMALL,$secure);
171		}
172	1
173		/**
174	1	* Returns the medium thumbnail's url.
175		*
176		* @param bool $secure
177		* @return string
178		* @throws InvalidThumbnailSizeException
179		*/
180		public function getMediumThumbnail($secure = false)
181		{
182	1	return $this->getThumbnail(self::THUMBNAIL_MEDIUM,$secure);
183		}
184	1
185		/**
186		* Returns the large thumbnail's url.
187		*
188		* @param bool $secure
189		* @param $secure
190		* @return string
191		* @throws InvalidThumbnailSizeException
192	1	*/
193		public function getLargeThumbnail($secure = false)
194	1	{
195		return $this->getThumbnail(self::THUMBNAIL_LARGE,$secure);
196		}
197
198		/**
199		* Returns the largest thumnbnaail's url.
200		*
201		* @param bool $secure
202	1	* @param $secure
203		* @return string
204	1	* @throws InvalidThumbnailSizeException
205		*/
206		public function getLargestThumbnail($secure = false)
207		{
208		return $this->getThumbnail(self::THUMBNAIL_LARGE,$secure);
209		}
210	1
211		/**
212	1	* @return bool
213		*/
214		public function isEmbeddable()
215		{
216		return true;
217		}
218
219		/**
220		* @param string $url
221	12	* @param string $pattern
222		*
223	12	* @return int
		0 ignored issues – show Documentation introduced 2016-02-11 16:29 UTC by Report Bug Copy Issue Report Should the return type not be `string`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
224	12	*/
225	12	private function getVideoIdByPattern($url, $pattern)
226		{
227	12	$match = array();
228		preg_match($pattern, $url, $match);
229		$videoId = $match[2];
230
231		return $videoId;
232		}
233
234		/**
235		* Uses the Vimeo video API to get video info.
236		*
237		* @todo make this better by using guzzle
		0 ignored issues – show Coding Style introduced 2016-02-11 16:29 UTC by Report Bug Copy Issue Report Comment refers to a TODO task This check looks `TODO` comments that have been left in the code. ``TODO``s show that something is left unfinished and should be attended to. Loading history...
238		*
239	12	* @return array
240		*
241	12	* @throws ServiceApiNotAvailable
242	12	*/
243		private function getVideoDataFromServiceApi()
244		{
245	12	$contents = file_get_contents('http://vimeo.com/api/v2/video/' . $this->getVideoId() . '.php');
246		if (false === $contents) {
247	12	throw new ServiceApiNotAvailable('Vimeo Service Adapter could not reach Vimeo API Service. Check if your server has file_get_contents() function available.');
		0 ignored issues – show Coding Style introduced 2016-02-11 16:29 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 170 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
248		}
249		$hash = unserialize($contents);
250
251		return reset($hash);
252		}
253		}
		0 ignored issues – show Coding Style introduced 2016-02-11 16:29 UTC by Report Bug Copy Issue Report As per coding style, files should not end with a newline character. This check marks files that end in a newline character, i.e. an empy line. Loading history...
254

ricardofiorani / php-video-url-parser

Push — master ( 007be0...4b2a2e )

VimeoServiceAdapter::getThumbnails() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like