Merge pull request #304 from chescos/update-facade-phpdoc-methods

Update PHPDoc methods of Facades
artesaos · May 5, 2023 · 8f05ef8 · 8f05ef8
2 parents 5358a7d + abbba84
commit 8f05ef8
Show file tree

Hide file tree

Showing 8 changed files with 18 additions and 17 deletions.
diff --git a/src/SEOTools/Contracts/MetaTags.php b/src/SEOTools/Contracts/MetaTags.php
@@ -134,7 +134,7 @@ public function removeMeta($key);
      * Add a custom meta tag.
      *
      * @param string|array $meta
-     * @param string       $value
+     * @param string|null  $value
      * @param string       $name
      *
      * @return static

diff --git a/src/SEOTools/Contracts/OpenGraph.php b/src/SEOTools/Contracts/OpenGraph.php
@@ -259,7 +259,7 @@ public function setBook($attributes = []);
     /**
      * Add Video properties.
      *
-     * @param string $source
+     * @param string|null $source
      * @param array  $attributes
      *
      * @return static
@@ -269,7 +269,7 @@ public function addVideo($source = null, $attributes = []);
     /**
      * Add audio properties.
      *
-     * @param string $source
+     * @param string|null $source
      * @param array  $attributes
      *
      * @return static

diff --git a/src/SEOTools/Facades/JsonLd.php b/src/SEOTools/Facades/JsonLd.php
@@ -10,15 +10,15 @@
  * @see \Artesaos\SEOTools\Contracts\JsonLd
  * @method static string generate(bool $minify = false)
  * @method static bool isEmpty()
- * @method static \Artesaos\SEOTools\Contracts\JsonLd addValue(string $key, array|string $value)
+ * @method static \Artesaos\SEOTools\Contracts\JsonLd addValue(string $key, string|array $value)
  * @method static \Artesaos\SEOTools\Contracts\JsonLd addValues(array $values)
  * @method static \Artesaos\SEOTools\Contracts\JsonLd setType(string $type)
  * @method static \Artesaos\SEOTools\Contracts\JsonLd setTitle(string $title)
  * @method static \Artesaos\SEOTools\Contracts\JsonLd setSite(string $site)
  * @method static \Artesaos\SEOTools\Contracts\JsonLd setDescription(string $description)
- * @method static \Artesaos\SEOTools\Contracts\JsonLd setUrl(string $url)
- * @method static \Artesaos\SEOTools\Contracts\JsonLd addImage(array|string $image)
- * @method static \Artesaos\SEOTools\Contracts\JsonLd setImages(array $images)
+ * @method static \Artesaos\SEOTools\Contracts\JsonLd setUrl(string|null|bool $url)
+ * @method static \Artesaos\SEOTools\Contracts\JsonLd addImage(string|array $image)
+ * @method static \Artesaos\SEOTools\Contracts\JsonLd setImages(string|array $images)
  */
 class JsonLd extends Facade
 {

diff --git a/src/SEOTools/Facades/JsonLdMulti.php b/src/SEOTools/Facades/JsonLdMulti.php
@@ -12,15 +12,15 @@
  * @method static \Artesaos\SEOTools\Contracts\JsonLdMulti newJsonLd()
  * @method static \Artesaos\SEOTools\Contracts\JsonLdMulti isEmpty()
  * @method static \Artesaos\SEOTools\Contracts\JsonLdMulti select(int $index)
- * @method static \Artesaos\SEOTools\Contracts\JsonLdMulti addValue(string $key, array|string $value)
+ * @method static \Artesaos\SEOTools\Contracts\JsonLdMulti addValue(string $key, string|array $value)
  * @method static \Artesaos\SEOTools\Contracts\JsonLdMulti addValues(array $values)
  * @method static \Artesaos\SEOTools\Contracts\JsonLdMulti setType(string $type)
  * @method static \Artesaos\SEOTools\Contracts\JsonLdMulti setTitle(string $title)
  * @method static \Artesaos\SEOTools\Contracts\JsonLdMulti setSite(string $site)
  * @method static \Artesaos\SEOTools\Contracts\JsonLdMulti setDescription(string $description)
- * @method static \Artesaos\SEOTools\Contracts\JsonLdMulti setUrl(string $url)
+ * @method static \Artesaos\SEOTools\Contracts\JsonLdMulti setUrl(string|null|bool $url)
  * @method static \Artesaos\SEOTools\Contracts\JsonLdMulti addImage(array|string $image)
- * @method static \Artesaos\SEOTools\Contracts\JsonLdMulti setImages(array $images)
+ * @method static \Artesaos\SEOTools\Contracts\JsonLdMulti setImages(string|array $images)
  */
 class JsonLdMulti extends Facade
 {

diff --git a/src/SEOTools/Facades/OpenGraph.php b/src/SEOTools/Facades/OpenGraph.php
@@ -10,7 +10,7 @@
  * @see \Artesaos\SEOTools\Contracts\OpenGraph
  *
  * @method static string generate(bool $minify = false)
- * @method static \Artesaos\SEOTools\Contracts\OpenGraph addProperty(string $key, array|string $value)
+ * @method static \Artesaos\SEOTools\Contracts\OpenGraph addProperty(string $key, string|array $value)
  * @method static \Artesaos\SEOTools\Contracts\OpenGraph removeProperty(string $key)
  * @method static \Artesaos\SEOTools\Contracts\OpenGraph addImage(string $url, array $attributes = [])
  * @method static \Artesaos\SEOTools\Contracts\OpenGraph addImages(array $urls)

diff --git a/src/SEOTools/Facades/SEOMeta.php b/src/SEOTools/Facades/SEOMeta.php
@@ -14,10 +14,10 @@
  * @method static \Artesaos\SEOTools\Contracts\MetaTags setTitleDefault(string $default)
  * @method static \Artesaos\SEOTools\Contracts\MetaTags setTitleSeparator(string $separator)
  * @method static \Artesaos\SEOTools\Contracts\MetaTags setDescription(string $description)
- * @method static \Artesaos\SEOTools\Contracts\MetaTags setKeywords(array|string $keywords)
- * @method static \Artesaos\SEOTools\Contracts\MetaTags addKeyword(string $keyword)
+ * @method static \Artesaos\SEOTools\Contracts\MetaTags setKeywords(string|array $keywords)
+ * @method static \Artesaos\SEOTools\Contracts\MetaTags addKeyword(string|array $keyword)
  * @method static \Artesaos\SEOTools\Contracts\MetaTags removeMeta(string $key)
- * @method static \Artesaos\SEOTools\Contracts\MetaTags addMeta(array|string $meta, string|null $value = null, string $name = 'name')
+ * @method static \Artesaos\SEOTools\Contracts\MetaTags addMeta(string|array $meta, string|null $value = null, string $name = 'name')
  * @method static \Artesaos\SEOTools\Contracts\MetaTags setCanonical(string $url)
  * @method static \Artesaos\SEOTools\Contracts\MetaTags setPrev(string $url)
  * @method static \Artesaos\SEOTools\Contracts\MetaTags setNext(string $url)

diff --git a/src/SEOTools/Facades/SEOTools.php b/src/SEOTools/Facades/SEOTools.php
@@ -18,7 +18,7 @@
  * @method static \Artesaos\SEOTools\Contracts\SEOTools setTitle(string $title, bool $appendDefault = true)
  * @method static \Artesaos\SEOTools\Contracts\SEOTools setDescription(string $description)
  * @method static \Artesaos\SEOTools\Contracts\SEOTools setCanonical(string $url)
- * @method static \Artesaos\SEOTools\Contracts\SEOTools addImages(array $urls)
+ * @method static \Artesaos\SEOTools\Contracts\SEOTools addImages(array|string $urls)
  * @method static string getTitle(bool $session = false)
  */
 class SEOTools extends Facade

diff --git a/src/SEOTools/Facades/TwitterCard.php b/src/SEOTools/Facades/TwitterCard.php
@@ -10,14 +10,15 @@
  * @see \Artesaos\SEOTools\Contracts\TwitterCards
  *
  * @method static string generate(bool $minify = false)
- * @method static \Artesaos\SEOTools\Contracts\TwitterCards addValue(string $key, array|string $value)
+ * @method static \Artesaos\SEOTools\Contracts\TwitterCards addValue(string $key, string|array $value)
  * @method static \Artesaos\SEOTools\Contracts\TwitterCards setType(string $type)
  * @method static \Artesaos\SEOTools\Contracts\TwitterCards setTitle(string $title)
  * @method static \Artesaos\SEOTools\Contracts\TwitterCards setSite(string $site)
  * @method static \Artesaos\SEOTools\Contracts\TwitterCards setDescription(string $description)
  * @method static \Artesaos\SEOTools\Contracts\TwitterCards setUrl(string $url)
  * @method static \Artesaos\SEOTools\Contracts\TwitterCards addImage(string|array $image)
- * @method static \Artesaos\SEOTools\Contracts\TwitterCards setImages(array $images)
+ * @method static \Artesaos\SEOTools\Contracts\TwitterCards setImages(string|array $images)
+ * @method static \Artesaos\SEOTools\Contracts\TwitterCards setImage(string|array $images)
  */
 class TwitterCard extends Facade
 {