Merge pull request #18 from stefandoorn/interface-improvements

Be more strict on alternative URLs input (demand string) and less strict on return type of alternatives (iterable now, instead of array)
stefandoorn · Oct 14, 2017 · bce3aa4 · bce3aa4
2 parents 3adc13a + f56df39
commit bce3aa4
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 8 deletions.
diff --git a/src/Model/SitemapUrl.php b/src/Model/SitemapUrl.php
@@ -38,15 +38,15 @@ class SitemapUrl implements SitemapUrlInterface
     /**
      * {@inheritdoc}
      */
-    public function addAlternative($location, $locale): void
+    public function addAlternative(string $location, string $locale): void
     {
         $this->alternatives[$locale] = $location;
     }
 
     /**
      * {@inheritdoc}
      */
-    public function setAlternatives(array $alternatives): void
+    public function setAlternatives(iterable $alternatives): void
     {
         $this->alternatives = $alternatives;
     }

diff --git a/src/Model/SitemapUrlInterface.php b/src/Model/SitemapUrlInterface.php
@@ -21,17 +21,18 @@ public function getLocalization(): ?string;
     public function setLocalization(string $localization): void;
 
     /**
-     * {@inheritdoc}
+     * @param string $location
+     * @param string $locale
      */
-    public function addAlternative($location, $locale): void;
+    public function addAlternative(string $location, string $locale): void;
 
     /**
-     * {@inheritdoc}
+     * @param iterable $alternatives
      */
-    public function setAlternatives(array $alternatives): void;
+    public function setAlternatives(iterable $alternatives): void;
 
     /**
-     * {@inheritdoc}
+     * @return iterable
      */
     public function getAlternatives(): iterable;
 
@@ -46,7 +47,7 @@ public function getLastModification(): ?DateTimeInterface;
     public function setLastModification(DateTimeInterface $lastModification): void;
 
     /**
-     * @return ChangeFrequency
+     * @return string
      */
     public function getChangeFrequency(): string;