small but needed refactorings about naming convention

Author: Ricardo Fiorani

README.md

@@ -66,7 +66,7 @@ echo $video->getLargestThumbnail();
 ## Registering your own service video (it's easy !)
 If you want to register an implementation of some service your class just needs to implement the "RicardoFiorani\Adapter\VideoAdapterInterface" or extend the RicardoFiorani\Adapter\AbstractServiceAdapter
 
-A Fully functional example can be found [Here](https://github.com/ricardofiorani/php-video-url-parser/tree/master/example/RegisteringANewService.md).
+A Fully functional example can be found [Here](https://github.com/ricardofiorani/php-video-url-parser/tree/master/documentation/RegisteringANewService.md).
 
 PS: If you've made your awesome implementation of some well known service, feel free to send a Pull Request. All contributions are welcome :)
 
@@ -76,9 +76,9 @@ In this project I've used a simple renderer (which just does an echo of an ifram
 Here's an example:
 ### My Example Renderer Class
 ```php
+<?php
 namespace MyVendor\MyRenderer;
 
-
 class MyOwnRenderer implements \RicardoFiorani\Renderer\EmbedRendererInterface
 {
 
@@ -91,7 +91,7 @@ class MyOwnRenderer implements \RicardoFiorani\Renderer\EmbedRendererInterface
     public function render($embedUrl, $height, $width)
     {
         //Just for example porpoises
-        return "Hell yeah baby, you've rendered: ".addslashes($embedUrl);
+        return sprintf("Hello, I'm embedding %s", addslashes($embedUrl));
 
         //A functional example would be like
         //return '<iframe width="' . $width . '" height="' . $height . '" src="' . addslashes($embedUrl) . '" frameborder="0" webkitAllowFullScreen mozallowfullscreen allowFullScreen></iframe>';
@@ -100,6 +100,7 @@ class MyOwnRenderer implements \RicardoFiorani\Renderer\EmbedRendererInterface
 ```
 ### My Example Renderer Factory Class
 ```php
+<?php
 namespace MyVendor\MyRenderer\Factory;
 
 class MyOwnRendererFactory implements RendererFactoryInterface
@@ -128,7 +129,7 @@ $vsm->getServiceContainer()->setRenderer('MyOwnRenderer', 'MyVendor\\MyRenderer\
 
 $video = $vsm->parse('https://www.youtube.com/watch?v=PkOcm_XaWrw');
 
-//This will output "Hell yeah baby, you've rendered: http://www.youtube.com/embed/PkOcm_XaWrw"
+//This will output "Hello, I'm embedding http://www.youtube.com/embed/PkOcm_XaWrw"
 echo $video->getEmbedCode(500,500);
 
 ```
@@ -138,6 +139,3 @@ echo $video->getEmbedCode(500,500);
 * Vimeo
 * Dailymotion
 * Facebook Videos
-
-
-

example/RegisteringANewService.md renamed to documentation/RegisteringANewService.md

@@ -5,16 +5,14 @@
 <?php
 namespace MyVendor\ServiceAdapter;
 
-use RicardoFiorani\Adapter\AbstractServiceAdapter;
-use RicardoFiorani\Renderer\EmbedRendererInterface;
-
 //Your service Adapter must implement VideoAdapterInterface or Extend AbstractServiceAdapter
 class DailymotionServiceAdapter extends AbstractServiceAdapter
 {
     const THUMBNAIL_DEFAULT = 'thumbnail';
 
     /**
      * AbstractVideoAdapter constructor.
+     *
      * @param string $url
      * @param string $pattern
      * @param EmbedRendererInterface $renderer
@@ -27,9 +25,9 @@ class DailymotionServiceAdapter extends AbstractServiceAdapter
         return parent::__construct($url, $pattern, $renderer);
     }
 
-
     /**
-     * Returns the service name (ie: "Youtube" or "Vimeo")
+     * Returns the service name (ie: "Youtube" or "Vimeo").
+     *
      * @return string
      */
     public function getServiceName()
@@ -38,7 +36,8 @@ class DailymotionServiceAdapter extends AbstractServiceAdapter
     }
 
     /**
-     * Returns if the service has a thumbnail image
+     * Returns if the service has a thumbnail image.
+     *
      * @return bool
      */
     public function hasThumbnail()
@@ -47,7 +46,8 @@ class DailymotionServiceAdapter extends AbstractServiceAdapter
     }
 
     /**
-     * Returns all thumbnails available sizes
+     * Returns all thumbnails available sizes.
+     *
      * @return array
      */
     public function getThumbNailSizes()
@@ -59,64 +59,79 @@ class DailymotionServiceAdapter extends AbstractServiceAdapter
 
     /**
      * @param string $size
+     * @param bool $forceSecure
+     *
      * @return string
+     * @throws InvalidThumbnailSizeException
      */
-    public function getThumbnail($size)
+    public function getThumbnail($size, $forceSecure = false)
     {
         if (false == in_array($size, $this->getThumbNailSizes())) {
-            throw new \RicardoFiorani\Exception\InvalidThumbnailSizeException;
+            throw new InvalidThumbnailSizeException();
         }
 
-        return 'http://www.dailymotion.com/' . $size . '/video/' . $this->videoId;
+        return $this->getScheme($forceSecure) . '://www.dailymotion.com/' . $size . '/video/' . $this->videoId;
     }
 
     /**
-     * Returns the small thumbnail's url
+     * Returns the small thumbnail's url.
+     *
+     * @param bool $forceSecure
      * @return string
+     * @throws InvalidThumbnailSizeException
      */
-    public function getSmallThumbnail()
+    public function getSmallThumbnail($forceSecure = false)
     {
         //Since this service does not provide other thumbnails sizes we just return the default size
-        return $this->getThumbnail(self::THUMBNAIL_DEFAULT);
+        return $this->getThumbnail(self::THUMBNAIL_DEFAULT, $forceSecure);
     }
 
     /**
-     * Returns the medium thumbnail's url
+     * Returns the medium thumbnail's url.
+     *
+     * @param bool $forceSecure
      * @return string
+     * @throws InvalidThumbnailSizeException
      */
-    public function getMediumThumbnail()
+    public function getMediumThumbnail($forceSecure = false)
     {
         //Since this service does not provide other thumbnails sizes we just return the default size
-        return $this->getThumbnail(self::THUMBNAIL_DEFAULT);
+        return $this->getThumbnail(self::THUMBNAIL_DEFAULT, $forceSecure);
     }
 
     /**
-     * Returns the large thumbnail's url
+     * Returns the large thumbnail's url.
+     *
+     * @param bool $forceSecure
      * @return string
+     * @throws InvalidThumbnailSizeException
      */
-    public function getLargeThumbnail()
+    public function getLargeThumbnail($forceSecure = false)
     {
         //Since this service does not provide other thumbnails sizes we just return the default size
-        return $this->getThumbnail(self::THUMBNAIL_DEFAULT);
+        return $this->getThumbnail(self::THUMBNAIL_DEFAULT, $forceSecure);
     }
 
     /**
-     * Returns the largest thumnbnaail's url
+     * Returns the largest thumnbnaail's url.
+     * @param bool $forceSecure
      * @return string
+     * @throws InvalidThumbnailSizeException
      */
-    public function getLargestThumbnail()
+    public function getLargestThumbnail($forceSecure = false)
     {
         //Since this service does not provide other thumbnails sizes we just return the default size
-        return $this->getThumbnail(self::THUMBNAIL_DEFAULT);
+        return $this->getThumbnail(self::THUMBNAIL_DEFAULT, $forceSecure);
     }
 
     /**
-     * @param bool $autoplay
+     * @param bool $forceAutoplay
+     * @param bool $forceSecure
      * @return string
      */
-    public function getEmbedUrl($autoplay = false)
+    public function getEmbedUrl($forceAutoplay = false, $forceSecure = false)
     {
-        return '//www.dailymotion.com/embed/video/' . $this->videoId . ($autoplay ? '?amp&autoplay=1' : '');
+        return $this->getScheme($forceSecure) . '://www.dailymotion.com/embed/video/' . $this->videoId . ($forceAutoplay ? '?amp&autoplay=1' : '');
     }
 
     /**
@@ -133,7 +148,6 @@ class DailymotionServiceAdapter extends AbstractServiceAdapter
 <?php
 namespace MyVendor\ServiceAdapter\Factory;
 
-
 use MyVendor\ServiceAdapter\DailymotionServiceAdapter;
 use RicardoFiorani\Adapter\VideoAdapterInterface;
 use RicardoFiorani\Renderer\EmbedRendererInterface;
@@ -174,7 +188,7 @@ $patterns = array(
 );
 
 //Register the new service
-$vsd->getServiceContainer()->registerService($serviceName, $patterns, "\\MyVendor\\ServiceAdapter\\Factory\\DailymotionServiceAdapterFactory");
+$vsd->getServiceContainer()->registerService($serviceName, $patterns, MyVendor\ServiceAdapter\Factory\DailymotionServiceAdapterFactory::class);
 
 //This will get you an DailymotionServiceAdapter
 $video = $vsd->parse('http://www.dailymotion.com/video/x33ncwc_kittens-fight-in-tiny-boxing-ring_animals');

src/Adapter/AbstractServiceAdapter.php

@@ -115,29 +115,29 @@ public function setRenderer($renderer)
     /**
      * @param int $width
      * @param int $height
-     * @param bool $autoplay
+     * @param bool $forceAutoplay
+     * @param bool $forceSecure
      *
      * @return string
-     *
      * @throws NotEmbeddableException
      */
-    public function getEmbedCode($width, $height, $autoplay = false, $secure = false)
+    public function getEmbedCode($width, $height, $forceAutoplay = false, $forceSecure = false)
     {
         if (false == $this->isEmbeddable()) {
             throw new NotEmbeddableException();
         }
 
-        return $this->getRenderer()->renderVideoEmbedCode($this->getEmbedUrl($autoplay, $secure), $width, $height);
+        return $this->getRenderer()->renderVideoEmbedCode($this->getEmbedUrl($forceAutoplay, $forceSecure), $width, $height);
     }
 
     /**
      * Switches the protocol scheme between http and https
      *
-     * @param bool|false $secure
+     * @param bool|false $forceSecure
      * @return string
      */
-    public function getScheme($secure = false)
+    public function getScheme($forceSecure = false)
     {
-        return ($secure ? 'https' : 'http');
+        return ($forceSecure ? 'https' : 'http');
     }
 }

src/Adapter/Dailymotion/DailymotionServiceAdapter.php

@@ -64,79 +64,79 @@ public function getThumbNailSizes()
 
     /**
      * @param string $size
-     * @param bool $secure
+     * @param bool $forceSecure
      *
      * @return string
      * @throws InvalidThumbnailSizeException
      */
-    public function getThumbnail($size, $secure = false)
+    public function getThumbnail($size, $forceSecure = false)
     {
         if (false == in_array($size, $this->getThumbNailSizes())) {
             throw new InvalidThumbnailSizeException();
         }
 
-        return $this->getScheme($secure) . '://www.dailymotion.com/' . $size . '/video/' . $this->videoId;
+        return $this->getScheme($forceSecure) . '://www.dailymotion.com/' . $size . '/video/' . $this->videoId;
     }
 
     /**
      * Returns the small thumbnail's url.
      *
-     * @param bool $secure
+     * @param bool $forceSecure
      * @return string
      * @throws InvalidThumbnailSizeException
      */
-    public function getSmallThumbnail($secure = false)
+    public function getSmallThumbnail($forceSecure = false)
     {
         //Since this service does not provide other thumbnails sizes we just return the default size
-        return $this->getThumbnail(self::THUMBNAIL_DEFAULT, $secure);
+        return $this->getThumbnail(self::THUMBNAIL_DEFAULT, $forceSecure);
     }
 
     /**
      * Returns the medium thumbnail's url.
      *
-     * @param bool $secure
+     * @param bool $forceSecure
      * @return string
      * @throws InvalidThumbnailSizeException
      */
-    public function getMediumThumbnail($secure = false)
+    public function getMediumThumbnail($forceSecure = false)
     {
         //Since this service does not provide other thumbnails sizes we just return the default size
-        return $this->getThumbnail(self::THUMBNAIL_DEFAULT, $secure);
+        return $this->getThumbnail(self::THUMBNAIL_DEFAULT, $forceSecure);
     }
 
     /**
      * Returns the large thumbnail's url.
      *
-     * @param bool $secure
+     * @param bool $forceSecure
      * @return string
      * @throws InvalidThumbnailSizeException
      */
-    public function getLargeThumbnail($secure = false)
+    public function getLargeThumbnail($forceSecure = false)
     {
         //Since this service does not provide other thumbnails sizes we just return the default size
-        return $this->getThumbnail(self::THUMBNAIL_DEFAULT, $secure);
+        return $this->getThumbnail(self::THUMBNAIL_DEFAULT, $forceSecure);
     }
 
     /**
      * Returns the largest thumnbnaail's url.
-     * @param bool $secure
+     * @param bool $forceSecure
      * @return string
      * @throws InvalidThumbnailSizeException
      */
-    public function getLargestThumbnail($secure = false)
+    public function getLargestThumbnail($forceSecure = false)
     {
         //Since this service does not provide other thumbnails sizes we just return the default size
-        return $this->getThumbnail(self::THUMBNAIL_DEFAULT, $secure);
+        return $this->getThumbnail(self::THUMBNAIL_DEFAULT, $forceSecure);
     }
 
     /**
-     * @param bool $autoplay
-     * @param bool $secure
+     * @param bool $forceAutoplay
+     * @param bool $forceSecure
      * @return string
      */
-    public function getEmbedUrl($autoplay = false, $secure = false)
+    public function getEmbedUrl($forceAutoplay = false, $forceSecure = false)
     {
-        return $this->getScheme($secure) . '://www.dailymotion.com/embed/video/' . $this->videoId . ($autoplay ? '?amp&autoplay=1' : '');
+        return $this->getScheme($forceSecure) . '://www.dailymotion.com/embed/video/' . $this->videoId . ($forceAutoplay ? '?amp&autoplay=1' : '');
     }
 
     /**