Merge pull request #32 from ARCANEDEV/patch-og_locale_alternate

Adding the ability to render mutliple metas with the same property name
ARCANEDEV · Nov 13, 2017 · 9dd4212 · 9dd4212
2 parents 067abc1 + b4f7786
commit 9dd4212
Show file tree

Hide file tree

Showing 13 changed files with 192 additions and 77 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -5,24 +5,23 @@ sudo: false
 php:
   - 7.0
   - 7.1
+  - 7.2
   - nightly
 
 matrix:
   allow_failures:
+    - php: 7.2
     - php: nightly
 
-env:
-  - TESTBENCH_VERSION=3.5.*
-
 before_script:
   - travis_retry composer self-update
-  - travis_retry composer require --prefer-source --no-interaction --dev "orchestra/testbench:${TESTBENCH_VERSION}"
+  - travis_retry composer install --prefer-source --no-interaction --dev
 
 script:
   - composer validate
   - mkdir -p build/logs
   - vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover
 
 after_script:
-  - if [ "$TRAVIS_PHP_VERSION" != "nightly" ]; then wget https://scrutinizer-ci.com/ocular.phar; fi
-  - if [ "$TRAVIS_PHP_VERSION" != "nightly" ]; then php ocular.phar code-coverage:upload --format=php-clover coverage.clover; fi
+  - if [ "$TRAVIS_PHP_VERSION" != "7.2" ] && [ "$TRAVIS_PHP_VERSION" != "nightly" ]; then wget https://scrutinizer-ci.com/ocular.phar; fi
+  - if [ "$TRAVIS_PHP_VERSION" != "7.2" ] && [ "$TRAVIS_PHP_VERSION" != "nightly" ]; then php ocular.phar code-coverage:upload --format=php-clover coverage.clover; fi
diff --git a/_docs/4-API.md b/_docs/4-API.md
@@ -633,8 +633,8 @@ interface TwitterCard extends Renderable
     /**
      * Add a meta to the card.
      *
-     * @param  string  $name
-     * @param  string  $content
+     * @param  string        $name
+     * @param  string|array  $content
      *
      * @return self
      */
@@ -707,10 +707,10 @@ interface Meta extends Renderable
     /**
      * Make Meta instance.
      *
-     * @param  string  $name
-     * @param  string  $content
-     * @param  string  $propertyName
-     * @param  string  $prefix
+     * @param  string        $name
+     * @param  string|array  $content
+     * @param  string        $propertyName
+     * @param  string        $prefix
      *
      * @return self
      */
@@ -1174,6 +1174,24 @@ interface SeoOpenGraph extends Renderable
      */
     public function setSiteName($siteName);
 
+    /** 
+     * Set the locale. 
+     * 
+     * @param  string  $locale 
+     * 
+     * @return \Arcanedev\SeoHelper\Entities\OpenGraph\Graph 
+     */ 
+    public function setLocale($locale); 
+
+    /** 
+     * Set the alternative locales. 
+     * 
+     * @param  array  $locales 
+     * 
+     * @return \Arcanedev\SeoHelper\Entities\OpenGraph\Graph 
+     */ 
+    public function setAlternativeLocales(array $locales); 
+
     /**
      * Add many open graph properties.
      *
@@ -1186,8 +1204,8 @@ interface SeoOpenGraph extends Renderable
     /**
      * Add an open graph property.
      *
-     * @param  string  $property
-     * @param  string  $content
+     * @param  string        $property
+     * @param  string|array  $content 
      *
      * @return self
      */

diff --git a/composer.json b/composer.json
@@ -21,8 +21,9 @@
         "arcanedev/support": "~4.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "~6.0",
-        "phpunit/phpcov":  "~4.0"
+        "orchestra/testbench": "~3.5.0",
+        "phpunit/phpunit":     "~6.0",
+        "phpunit/phpcov":      "~4.0"
     },
     "autoload": {
         "psr-4": {
@@ -35,9 +36,6 @@
             "Arcanedev\\SeoHelper\\Tests\\": "tests/"
         }
     },
-    "scripts": {
-        "testbench": "composer require --dev \"orchestra/testbench=~3.0\""
-    },
     "extra": {
         "laravel": {
             "providers": [

diff --git a/src/Bases/MetaCollection.php b/src/Bases/MetaCollection.php
@@ -90,8 +90,8 @@ public function addMany(array $metas)
     /**
      * Add a meta to collection.
      *
-     * @param  string  $name
-     * @param  string  $content
+     * @param  string        $name
+     * @param  string|array  $content
      *
      * @return \Arcanedev\SeoHelper\Bases\MetaCollection
      */
@@ -105,8 +105,8 @@ public function add($name, $content)
     /**
      * Make a meta and add it to collection.
      *
-     * @param  string  $name
-     * @param  string  $content
+     * @param  string        $name
+     * @param  string|array  $content
      *
      * @return \Arcanedev\SeoHelper\Bases\MetaCollection
      */

diff --git a/src/Contracts/Entities/MetaCollection.php b/src/Contracts/Entities/MetaCollection.php
@@ -17,8 +17,8 @@ interface MetaCollection extends Renderable
     /**
      * Add a meta to collection.
      *
-     * @param  string  $name
-     * @param  string  $content
+     * @param  string        $name
+     * @param  string|array  $content
      *
      * @return self
      */

diff --git a/src/Contracts/Entities/OpenGraph.php b/src/Contracts/Entities/OpenGraph.php
@@ -77,6 +77,24 @@ public function setImage($image);
      */
     public function setSiteName($siteName);
 
+    /**
+     * Set the locale.
+     *
+     * @param  string  $locale
+     *
+     * @return \Arcanedev\SeoHelper\Entities\OpenGraph\Graph
+     */
+    public function setLocale($locale);
+
+    /**
+     * Set the alternative locales.
+     *
+     * @param  array  $locales
+     *
+     * @return \Arcanedev\SeoHelper\Entities\OpenGraph\Graph
+     */
+    public function setAlternativeLocales(array $locales);
+
     /**
      * Add many open graph properties.
      *
@@ -89,8 +107,8 @@ public function addProperties(array $properties);
     /**
      * Add an open graph property.
      *
-     * @param  string  $property
-     * @param  string  $content
+     * @param  string        $property
+     * @param  string|array  $content
      *
      * @return self
      */

diff --git a/src/Contracts/Entities/TwitterCard.php b/src/Contracts/Entities/TwitterCard.php
@@ -83,8 +83,8 @@ public function addMetas(array $metas);
     /**
      * Add a meta to the card.
      *
-     * @param  string  $name
-     * @param  string  $content
+     * @param  string        $name
+     * @param  string|array  $content
      *
      * @return self
      */

diff --git a/src/Contracts/Helpers/Meta.php b/src/Contracts/Helpers/Meta.php
@@ -46,10 +46,10 @@ public function setNameProperty($nameProperty);
     /**
      * Make Meta instance.
      *
-     * @param  string  $name
-     * @param  string  $content
-     * @param  string  $propertyName
-     * @param  string  $prefix
+     * @param  string        $name
+     * @param  string|array  $content
+     * @param  string        $propertyName
+     * @param  string        $prefix
      *
      * @return self
      */

diff --git a/src/Entities/OpenGraph/Graph.php b/src/Entities/OpenGraph/Graph.php
@@ -152,6 +152,30 @@ public function setSiteName($siteName)
         return $this->addProperty('site_name', $siteName);
     }
 
+    /**
+     * Set the locale.
+     *
+     * @param  string  $locale
+     *
+     * @return \Arcanedev\SeoHelper\Entities\OpenGraph\Graph
+     */
+    public function setLocale($locale)
+    {
+        return $this->addProperty('locale', $locale);
+    }
+
+    /**
+     * Set the alternative locales.
+     *
+     * @param  array  $locales
+     *
+     * @return \Arcanedev\SeoHelper\Entities\OpenGraph\Graph
+     */
+    public function setAlternativeLocales(array $locales)
+    {
+        return $this->addProperty('locale:alternate', $locales);
+    }
+
     /**
      * Add many open graph properties.
      *
@@ -169,8 +193,8 @@ public function addProperties(array $properties)
     /**
      * Add an open graph property.
      *
-     * @param  string  $property
-     * @param  string  $content
+     * @param  string        $property
+     * @param  string|array  $content
      *
      * @return \Arcanedev\SeoHelper\Entities\OpenGraph\Graph
      */

diff --git a/src/Entities/Twitter/Card.php b/src/Entities/Twitter/Card.php
@@ -188,8 +188,8 @@ public function addMetas(array $metas)
     /**
      * Add a meta to the card.
      *
-     * @param  string  $name
-     * @param  string  $content
+     * @param  string        $name
+     * @param  string|array  $content
      *
      * @return \Arcanedev\SeoHelper\Entities\Twitter\Card
      */

diff --git a/src/Helpers/Meta.php b/src/Helpers/Meta.php
@@ -2,6 +2,7 @@
 
 use Arcanedev\SeoHelper\Contracts\Helpers\Meta as MetaContract;
 use Arcanedev\SeoHelper\Exceptions\InvalidArgumentException;
+use Illuminate\Support\Arr;
 
 /**
  * Class     Meta
@@ -40,9 +41,9 @@ class Meta implements MetaContract
     /**
      * Meta content.
      *
-     * @var string
+     * @var string|array
      */
-    protected $content = '';
+    protected $content;
 
     /* -----------------------------------------------------------------
      |  Constructor
@@ -52,10 +53,10 @@ class Meta implements MetaContract
     /**
      * Make Meta instance.
      *
-     * @param  string  $name
-     * @param  string  $content
-     * @param  string  $prefix
-     * @param  string  $propertyName
+     * @param  string        $name
+     * @param  string|array  $content
+     * @param  string        $prefix
+     * @param  string        $propertyName
      */
     public function __construct($name, $content, $propertyName = 'name', $prefix = '')
     {
@@ -141,25 +142,28 @@ private function setName($name)
     /**
      * Get the meta content.
      *
-     * @return string
+     * @return string|array
      */
     private function getContent()
     {
-        return $this->clean($this->content);
+        return is_array($this->content)
+            ? array_map(function ($content) { return $this->clean($content); }, $this->content)
+            : $this->clean($this->content);
     }
 
     /**
      * Set the meta content.
      *
-     * @param  string  $content
+     * @param  string|array  $content
      *
      * @return \Arcanedev\SeoHelper\Helpers\Meta
      */
     private function setContent($content)
     {
-        if (is_string($content)) {
+        if (is_array($content))
+            $this->content = $content;
+        elseif (is_string($content))
             $this->content = trim($content);
-        }
 
         return $this;
     }
@@ -171,10 +175,10 @@ private function setContent($content)
     /**
      * Make Meta instance.
      *
-     * @param  string  $name
-     * @param  string  $content
-     * @param  string  $propertyName
-     * @param  string  $prefix
+     * @param  string        $name
+     * @param  string|array  $content
+     * @param  string        $propertyName
+     * @param  string        $prefix
      *
      * @return \Arcanedev\SeoHelper\Helpers\Meta
      */
@@ -190,9 +194,7 @@ public static function make($name, $content, $propertyName = 'name', $prefix = '
      */
     public function render()
     {
-        return $this->isLink()
-            ? $this->renderLink()
-            : $this->renderMeta();
+        return $this->isLink() ? $this->renderLink() : $this->renderMeta();
     }
 
     /**
@@ -212,11 +214,11 @@ private function renderLink()
      */
     private function renderMeta()
     {
-        $output   = [];
-        $output[] = $this->nameProperty.'="'.$this->getName().'"';
-        $output[] = 'content="'.$this->getContent().'"';
+        $content = Arr::wrap($this->getContent());
 
-        return '<meta '.implode(' ', $output).'>';
+        return implode(PHP_EOL, array_map(function ($content) {
+            return "<meta {$this->nameProperty}=\"{$this->getName()}\" content=\"{$content}\">";
+        }, $content));
     }
 
     /**
@@ -268,7 +270,7 @@ private function checkNameProperty(&$nameProperty)
     {
         if ( ! is_string($nameProperty)) {
             throw new InvalidArgumentException(
-                'The meta name property is must be a string value, ' . gettype($nameProperty) . ' is given.'
+                'The meta name property is must be a string value, '.gettype($nameProperty).' is given.'
             );
         }
 
@@ -278,7 +280,7 @@ private function checkNameProperty(&$nameProperty)
         if ( ! in_array($name, $allowed)) {
             throw new InvalidArgumentException(
                 "The meta name property [$name] is not supported, ".
-                "the allowed name properties are ['". implode("', '", $allowed) . "']."
+                "the allowed name properties are ['".implode("', '", $allowed)."']."
             );
         }