Merge pull request #27 from ARCANEDEV/feature-set_image_method

Feature set image method + Fixing misc stuff
ARCANEDEV · Feb 27, 2017 · 070f80c · 070f80c
2 parents abd274e + 74e8358
commit 070f80c
Show file tree

Hide file tree

Showing 38 changed files with 433 additions and 407 deletions.
diff --git a/_docs/4-API.md b/_docs/4-API.md
@@ -37,9 +37,9 @@
 
 interface Renderable
 {
-    /* ------------------------------------------------------------------------------------------------
-     |  Main Functions
-     | ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
+     |  Main Methods
+     | -----------------------------------------------------------------
      */
     /**
      * Render the tag.
@@ -68,9 +68,9 @@ use Arcanedev\SeoHelper\Contracts\Renderable;
 
 interface Title extends Renderable
 {
-    /* ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
      |  Getters & Setters
-     | ------------------------------------------------------------------------------------------------
+     | -----------------------------------------------------------------
      */
     /**
      * Get title only (without site name or separator).
@@ -157,9 +157,9 @@ interface Title extends Renderable
      */
     public function setMax($max);
 
-    /* ------------------------------------------------------------------------------------------------
-     |  Main Functions
-     | ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
+     |  Main Methods
+     | -----------------------------------------------------------------
      */
     /**
      * Make a Title instance.
@@ -183,9 +183,9 @@ use Arcanedev\SeoHelper\Contracts\Renderable;
 
 interface Description extends Renderable
 {
-    /* ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
      |  Getters & Setters
-     | ------------------------------------------------------------------------------------------------
+     | -----------------------------------------------------------------
      */
     /**
      * Get raw description content.
@@ -226,9 +226,9 @@ interface Description extends Renderable
      */
     public function setMax($max);
 
-    /* ------------------------------------------------------------------------------------------------
-     |  Main Functions
-     | ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
+     |  Main Methods
+     | -----------------------------------------------------------------
      */
     /**
      * Make a description instance.
@@ -251,9 +251,9 @@ use Arcanedev\SeoHelper\Contracts\Renderable;
 
 interface Keywords extends Renderable
 {
-    /* ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
      |  Getters & Setters
-     | ------------------------------------------------------------------------------------------------
+     | -----------------------------------------------------------------
      */
     /**
      * Get content.
@@ -271,9 +271,9 @@ interface Keywords extends Renderable
      */
     public function set($content);
 
-    /* ------------------------------------------------------------------------------------------------
-     |  Main Functions
-     | ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
+     |  Main Methods
+     | -----------------------------------------------------------------
      */
     /**
      * Make Keywords instance.
@@ -313,9 +313,9 @@ use Arcanedev\SeoHelper\Contracts\Renderable;
 
 interface MiscTags extends Renderable
 {
-    /* ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
      |  Getters & Setters
-     | ------------------------------------------------------------------------------------------------
+     | -----------------------------------------------------------------
      */
     /**
      * Get the current URL.
@@ -333,9 +333,9 @@ interface MiscTags extends Renderable
      */
     public function setUrl($url);
 
-    /* ------------------------------------------------------------------------------------------------
-     |  Main Functions
-     | ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
+     |  Main Methods
+     | -----------------------------------------------------------------
      */
     /**
      * Make MiscTags instance.
@@ -392,9 +392,9 @@ use Arcanedev\SeoHelper\Contracts\Renderable;
 
 interface Webmasters extends Renderable
 {
-    /* ------------------------------------------------------------------------------------------------
-     |  Main Functions
-     | ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
+     |  Main Methods
+     | -----------------------------------------------------------------
      */
     /**
      * Make Webmaster instance.
@@ -433,9 +433,9 @@ use Arcanedev\SeoHelper\Contracts\Renderable;
 
 interface Analytics extends Renderable
 {
-    /* ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
      |  Getters & Setters
-     | ------------------------------------------------------------------------------------------------
+     | -----------------------------------------------------------------
      */
     /**
      * Set Google Analytics code.
@@ -457,9 +457,9 @@ use Arcanedev\SeoHelper\Contracts\Renderable;
 
 interface OpenGraph extends Renderable
 {
-    /* ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
      |  Getters & Setters
-     | ------------------------------------------------------------------------------------------------
+     | -----------------------------------------------------------------
      */
     /**
      * Set the open graph prefix.
@@ -560,9 +560,9 @@ use Arcanedev\SeoHelper\Contracts\Renderable;
  */
 interface TwitterCard extends Renderable
 {
-    /* ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
      |  Constants
-     | ------------------------------------------------------------------------------------------------
+     | -----------------------------------------------------------------
      */
     const TYPE_APP                 = 'app';
     const TYPE_GALLERY             = 'gallery';
@@ -572,9 +572,9 @@ interface TwitterCard extends Renderable
     const TYPE_SUMMARY             = 'summary';
     const TYPE_SUMMARY_LARGE_IMAGE = 'summary_large_image';
 
-    /* ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
      |  Getters & Setters
-     | ------------------------------------------------------------------------------------------------
+     | -----------------------------------------------------------------
      */
     /**
      * Set the card type.
@@ -647,9 +647,9 @@ interface TwitterCard extends Renderable
      */
     public function types();
 
-    /* ------------------------------------------------------------------------------------------------
-     |  Main Functions
-     | ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
+     |  Main Methods
+     | -----------------------------------------------------------------
      */
     /**
      * Reset the card.
@@ -671,9 +671,9 @@ use Arcanedev\SeoHelper\Contracts\Renderable;
 
 interface Meta extends Renderable
 {
-    /* ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
      |  Getters and Setters
-     | ------------------------------------------------------------------------------------------------
+     | -----------------------------------------------------------------
      */
     /**
      * Get the meta name.
@@ -700,9 +700,9 @@ interface Meta extends Renderable
      */
     public function setNameProperty($nameProperty);
 
-    /* ------------------------------------------------------------------------------------------------
-     |  Main Functions
-     | ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
+     |  Main Methods
+     | -----------------------------------------------------------------
      */
     /**
      * Make Meta instance.
@@ -740,9 +740,9 @@ interface Meta extends Renderable
  */
 interface SeoHelper extends Renderable
 {
-    /* ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
      |  Getters & Setters
-     | ------------------------------------------------------------------------------------------------
+     | -----------------------------------------------------------------
      */
     /**
      * Get SeoMeta instance.
@@ -811,6 +811,16 @@ interface SeoHelper extends Renderable
      * @return self
      */
     public function setTitle($title, $siteName = null, $separator = null);
+
+    /**
+     * Set the site name.
+     *
+     * @param  string  $siteName
+     *
+     * @return self
+     */
+    public function setSiteName($siteName);
+
     /**
      * Set description.
      *
@@ -830,17 +840,17 @@ interface SeoHelper extends Renderable
     public function setKeywords($keywords);
 
     /**
-     * Set the site name.
+     * Set Image.
      *
-     * @param  string  $siteName
+     * @param  string  $imageUrl
      *
      * @return self
      */
-    public function setSiteName($siteName);
+    public function setImage($imageUrl);
 
-    /* ------------------------------------------------------------------------------------------------
-     |  Main Functions
-     | ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
+     |  Main Methods
+     | -----------------------------------------------------------------
      */
     /**
      * Render all seo tags with HtmlString object.
@@ -898,9 +908,9 @@ use Arcanedev\SeoHelper\Contracts\Entities\Webmasters as WebmastersContract;
  */
 interface SeoMeta extends Renderable
 {
-    /* ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
      |  Getters & Setters
-     | ------------------------------------------------------------------------------------------------
+     | -----------------------------------------------------------------
      */
     /**
      * Set the Title instance.
@@ -1031,9 +1041,9 @@ interface SeoMeta extends Renderable
      */
     public function setGoogleAnalytics($code);
 
-    /* ------------------------------------------------------------------------------------------------
-     |  Main Functions
-     | ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
+     |  Main Methods
+     | -----------------------------------------------------------------
      */
     /**
      * Add a meta tag.
@@ -1088,9 +1098,9 @@ use Arcanedev\SeoHelper\Contracts\Entities\OpenGraph as OpenGraphContract;
 
 interface SeoOpenGraph extends Renderable
 {
-    /* ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
      |  Getters & Setters
-     | ------------------------------------------------------------------------------------------------
+     | -----------------------------------------------------------------
      */
     /**
      * Set the Open Graph instance.
@@ -1194,9 +1204,9 @@ use Arcanedev\SeoHelper\Entities\Twitter\Card as CardContract;
 
 interface SeoTwitter extends Renderable
 {
-    /* ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
      |  Getters & Setters
-     | ------------------------------------------------------------------------------------------------
+     | -----------------------------------------------------------------
      */
     /**
      * Set the twitter card instance.
@@ -1271,9 +1281,9 @@ interface SeoTwitter extends Renderable
      */
     public function addMeta($name, $content);
 
-    /* ------------------------------------------------------------------------------------------------
-     |  Main Functions
-     | ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
+     |  Main Methods
+     | -----------------------------------------------------------------
      */
     /**
      * Reset the twitter card.