Use structured URLs throughout

lib/Entry.php

@@ -18,9 +18,9 @@ class Entry {
     public $id;
     /** @var string $lang The human language of the entry */
     public $lang;
-    /** @var string $link The URL of the entry as published somwehere else, usually on the World Wide Web */
+    /** @var \JKingWeb\Lax\Url $link The URL of the entry as published somwehere else, usually on the World Wide Web */
     public $link;
-    /** @var string $relatedLink The URL of an article related to the entry. For example, if the entry is a commentary on an essay, this property might provide the URL of that essay */
+    /** @var \JKingWeb\Lax\Url $relatedLink The URL of an article related to the entry. For example, if the entry is a commentary on an essay, this property might provide the URL of that essay */
     public $relatedLink;
     /** @var \JKingWeb\Lax\Text $title The title of the entry */
     public $title;

lib/Feed.php

@@ -39,7 +39,7 @@ class Feed {
     public $id;
     /** @var string $url The feed's canonical URL. This may differ from the URL used to fetch the newsfeed */
     public $url;
-    /** @var string $link The URL  of the Web page associated with the feed */
+    /** @var \JKingWeb\Lax\Url $link The URL of the Web page associated with the feed */
     public $link;
     /** @var \JKingWeb\Lax\Text $title The title of the newsfeed */
     public $title;
@@ -50,9 +50,9 @@ class Feed {
      * This property only records a date embedded in the newsfeed itself, not any dates from HTTP or the file system
      */
     public $dateModified;
-    /** @var string $icon URL to a small icon for the newsfeed */
+    /** @var \JKingWeb\Lax\Url $icon URL to a small icon for the newsfeed */
     public $icon;
-    /** @var string $image URL to a large banner or poster image for the newsfeed */
+    /** @var \JKingWeb\Lax\Url $image URL to a large banner or poster image for the newsfeed */
     public $image;
     
     /** @var \JKingWeb\Lax\Category\Collection $categories A list of categories associated with the newsfeed as a whole */

lib/Parser/Construct.php

@@ -28,11 +28,6 @@ trait Construct {
         }
     }
 
-    /** Resolves a relative URL against a base URL */
-    protected function resolveUrl(string $url, string $base = null): string {
-        return \Sabre\Uri\resolve($base ?? "", $url);
-    }
-
     /** Tests whether a string is a valid e-mail address
      * 
      * Accepts IDN hosts and (with PHP 7.1 and above) Unicode localparts

lib/Parser/Entry.php

@@ -11,6 +11,7 @@ use JKingWeb\Lax\Category\Collection as CategoryCollection;
 use JKingWeb\Lax\Enclosure\Collection as EnclosureCollection;
 use JKingWeb\Lax\Date;
 use JKingWeb\Lax\Text;
+use JKingWeb\Lax\Url;
 
 interface Entry {
     /** Returns the globally unique identifier of the entry; this is usually a URI */
@@ -23,10 +24,10 @@ interface Entry {
     public function getTitle(): ?Text;
 
     /** Returns the URL of the published article this entry summarizes */
-    public function getLink(): ?string;
+    public function getLink(): ?Url;
 
     /** Returns the URL of an article related to the entry */
-    public function getRelatedLink(): ?string;
+    public function getRelatedLink(): ?Url;
 
     /** Returns the content of the entry, either in plain text or HTML */
     public function getContent(): ?Text;
@@ -44,7 +45,7 @@ interface Entry {
      * 
      * This is only used by JSON Feed entries
      */
-    public function getBanner(): ?string;
+    public function getBanner(): ?Url;
 
     /** Returns a collection of categories associated with the entry */
     public function getCategories(): CategoryCollection;

lib/Parser/Feed.php

@@ -11,6 +11,7 @@ use JKingWeb\Lax\Category\Collection as CategoryCollection;
 use JKingWeb\Lax\Date;
 use JKingWeb\Lax\Text;
 use JKingWeb\Lax\Feed as FeedStruct;
+use JKingWeb\Lax\Url;
 
 interface Feed {
     /** Returns the globally unique identifier of the newsfeed; this is usually a URI */
@@ -20,13 +21,13 @@ interface Feed {
     public function getLang(): ?string;
 
     /** Returns the canonical URL of the newsfeed, as contained in the document itself */
-    public function getUrl(): ?string;
+    public function getUrl(): ?Url;
 
     /** Returns the title text of the newsfeed, which may be plain text or HTML */
     public function getTitle(): ?Text;
 
     /** Returns the URL of the publication this newsfeed summarizes */
-    public function getLink(): ?string;
+    public function getLink(): ?Url;
 
     /** Returns a short description of the newsfeed, either in plain text or HTML */
     public function getSummary(): ?Text;
@@ -35,10 +36,10 @@ interface Feed {
     public function getDateModified(): ?Date;
 
     /** Returns the URL of a small image used as an icon to identify the newsfeed */
-    public function getIcon(): ?string;
+    public function getIcon(): ?Url;
 
     /** Returns the URL of a large image used as a poster or banner to identify the newsfeed */
-    public function getImage(): ?string;
+    public function getImage(): ?Url;
 
     /** Returns a collection of categories associated with the newsfeed as a whole. Each category is a structured Category object */
     public function getCategories(): CategoryCollection;

lib/Parser/JSON/Construct.php

@@ -10,6 +10,7 @@ use JKingWeb\Lax\Date;
 use JKingWeb\Lax\Text;
 use JKingWeb\Lax\Person\Collection as PersonCollection;
 use JKingWeb\Lax\Person\Person;
+use JKingWeb\Lax\Url;
 
 trait Construct {
     use \JKingWeb\Lax\Parser\Construct;
@@ -33,9 +34,13 @@ trait Construct {
     }
 
     /** Returns an object member as a resolved and normalized URL */
-    protected function fetchUrl(string $key, \stdClass $obj = null): ?string {
+    protected function fetchUrl(string $key, \stdClass $obj = null): ?Url {
         $url = $this->fetchMember($key, "str", $obj);
-        return (!is_null($url)) ? $this->resolveUrl($url, $this->url) : null;
+        try {
+            return (!is_null($url)) ? new Url($url, $this->url) : null;
+        } catch (\InvalidArgumentException $e) {
+            return null;
+        }
     }
 
     /** Returns an object member as a parsed date */

lib/Parser/JSON/Entry.php

@@ -15,6 +15,7 @@ use JKingWeb\Lax\Category\Category;
 use JKingWeb\Lax\Date;
 use JKingWeb\Lax\Enclosure\Enclosure;
 use JKingWeb\Lax\Text;
+use JKingWeb\Lax\Url;
 
 class Entry implements \JKingWeb\Lax\Parser\Entry {
     use Construct;
@@ -28,7 +29,7 @@ class Entry implements \JKingWeb\Lax\Parser\Entry {
     public function __construct(\stdClass $data, FeedStruct $feed) {
         $this->data = $data;
         $this->feed = $feed;
-        $this->url = $feed->meta->url ?? "";
+        $this->url = $feed->meta->url ?? null;
     }
 
     protected function init(EntryStruct $entry): EntryStruct {
@@ -109,11 +110,11 @@ class Entry implements \JKingWeb\Lax\Parser\Entry {
         return $this->fetchDate("date_published");
     }
 
-    public function getLink(): ?string {
+    public function getLink(): ?Url {
         return $this->fetchUrl("url");
     }
 
-    public function getRelatedLink(): ?string {
+    public function getRelatedLink(): ?Url {
         return $this->fetchUrl("external_url");
     }
 
@@ -135,7 +136,7 @@ class Entry implements \JKingWeb\Lax\Parser\Entry {
         return $out;
     }
 
-    public function getBanner(): ?string {
+    public function getBanner(): ?Url {
         return $this->fetchUrl("banner_image");
     }
 
@@ -152,7 +153,7 @@ class Entry implements \JKingWeb\Lax\Parser\Entry {
                 $m->duration = $this->fetchMember("duration_in_seconds", "int", $attachment);
                 // detect media type from file name if no type is provided
                 if (!$m->type) {
-                    $ext = "";
+                    $ext = substr();
                     $m->type = ($this->mime ?? ($this->mime = new \Mimey\MimeTypes))->getMimeType($ext);
                 }
                 $out[] = $m;

lib/Parser/JSON/Feed.php

@@ -14,6 +14,7 @@ use JKingWeb\Lax\Person\Collection as PersonCollection;
 use JKingWeb\Lax\Category\Collection as CategoryCollection;
 use JKingWeb\Lax\Parser\Exception;
 use JKingWeb\Lax\Parser\JSON\Entry as EntryParser;
+use JKingWeb\Lax\Url;
 
 class Feed implements \JKingWeb\Lax\Parser\Feed {
     use Construct;
@@ -36,7 +37,9 @@ class Feed implements \JKingWeb\Lax\Parser\Feed {
     public function __construct(string $data, string $contentType = null, string $url = null) {
         $this->data = $data;
         $this->contentType = $contentType;
-        $this->url = $url;
+        if (strlen($url ?? "")) {
+            $this->url = new Url($url);
+        }
     }
 
     /** Performs format-specific preparation and validation */
@@ -83,18 +86,18 @@ class Feed implements \JKingWeb\Lax\Parser\Feed {
      * For JSON feeds this is always the feed URL specified in the feed
     */
     public function getId(): ?string {
-        return $this->fetchUrl("feed_url");
+        return $this->fetchMember("feed_url", "str");
     }
 
     public function getLang(): ?string {
         return $this->fetchMember("language", "str");
     }
 
-    public function getUrl(): ?string {
+    public function getUrl(): ?Url {
         return $this->fetchUrl("feed_url");
     }
 
-    public function getLink(): ?string {
+    public function getLink(): ?Url {
         return $this->fetchUrl("home_page_url");
     }
 
@@ -126,11 +129,11 @@ class Feed implements \JKingWeb\Lax\Parser\Feed {
         return $this->getAuthorsV1() ?? $this->getAuthorV1() ?? new PersonCollection;
     }
 
-    public function getIcon(): ?string {
+    public function getIcon(): ?Url {
         return $this->fetchUrl("favicon");
     }
 
-    public function getImage(): ?string {
+    public function getImage(): ?Url {
         return $this->fetchUrl("icon");
     }
 

lib/Parser/XML/Entry.php

@@ -11,6 +11,7 @@ use JKingWeb\Lax\Category\Collection as CategoryCollection;
 use JKingWeb\Lax\Enclosure\Collection as EnclosureCollection;
 use JKingWeb\Lax\Date;
 use JKingWeb\Lax\Text;
+use JKingWeb\Lax\Url;
 
 class Entry implements \JKingWeb\Lax\Parser\Entry {
     use Construct;
@@ -80,7 +81,7 @@ class Entry implements \JKingWeb\Lax\Parser\Entry {
     }
 
     /** General function to fetch the Web URL of the entry */
-    public function getLink(): ?string {
+    public function getLink(): ?Url {
         return $this->getLinkAtom() ?? $this->getLinkRss1() ?? $this->getLinkRss2() ?? "";
     }
 
@@ -88,11 +89,11 @@ class Entry implements \JKingWeb\Lax\Parser\Entry {
      * 
      * This is only reliable with Atom feeds
      */
-    public function getRelatedLink(): ?string {
+    public function getRelatedLink(): ?Url {
         return $this->getRelatedLinkAtom() ?? "";
     }
 
-    public function getBanner(): ?string {
+    public function getBanner(): ?Url {
         return null;
     }
 

lib/Parser/XML/Feed.php

@@ -11,6 +11,7 @@ use JKingWeb\Lax\Category\Collection as CategoryCollection;
 use JKingWeb\Lax\Feed as FeedStruct;
 use JKingWeb\Lax\Date;
 use JKingWeb\Lax\Text;
+use JKingWeb\Lax\Url;
 
 class Feed implements \JKingWeb\Lax\Parser\Feed {
     use Construct;
@@ -81,7 +82,7 @@ class Feed implements \JKingWeb\Lax\Parser\Feed {
      * 
      * If the feed does not include a canonical URL, the request URL is returned instead
      */
-    public function getUrl(): string {
+    public function getUrl(): ?Url {
         return $this->getUrlAtom() ?? $this->getUrlRss1() ?? $this->getUrlPod() ?? $this->reqUrl;
     }
     
@@ -91,7 +92,7 @@ class Feed implements \JKingWeb\Lax\Parser\Feed {
     }
 
     /** General function to fetch the feed's Web-representation URL */
-    public function getLink(): string {
+    public function getLink(): ?Url {
         return $this->getLinkAtom() ?? $this->getLinkRss1() ?? $this->getLinkRss2() ?? "";
     }
 
@@ -107,7 +108,7 @@ class Feed implements \JKingWeb\Lax\Parser\Feed {
     }
 
     /** General function to fetch the feed identifier */
-    public function getId(): string {
+    public function getId(): ?string {
         return $this->getIdAtom() ?? $this->getIdDC() ?? $this->getIdRss2() ?? "";
     }
 
@@ -138,11 +139,11 @@ class Feed implements \JKingWeb\Lax\Parser\Feed {
         return null;
     }
 
-    public function getIcon(): ?string {
+    public function getIcon(): ?Url {
         return null;
     }
 
-    public function getImage(): ?string {
+    public function getImage(): ?Url {
         return null;
     }
 }

tests/cases/JSON/JSONTest.php

@@ -13,7 +13,7 @@ use JKingWeb\Lax\Feed;
 use JKingWeb\Lax\Text;
 use JKingWeb\Lax\Person\Person;
 use JKingWeb\Lax\Person\Collection as PersonCollection;
-
+use JKingWeb\Lax\Url;
 
 /** @covers JKingWeb\Lax\Parser\JSON\Feed<extended> */
 class JSONTest extends \PHPUnit\Framework\TestCase {
@@ -75,6 +75,8 @@ class JSONTest extends \PHPUnit\Framework\TestCase {
                 foreach ($v as $kk => $vv) {
                     $f->$k->$kk = $vv;
                 }
+            } elseif (in_array($k, ["url", "link", "icon", "image"])) {
+                $f->$k = new Url($v);
             } else {
                 $f->$k = $v;
             }
@@ -85,7 +87,11 @@ class JSONTest extends \PHPUnit\Framework\TestCase {
     protected function makeEntry(\stdClass $entry): Entry {
         $e = new Entry;
         foreach ($entry as $k => $v) {
-            $e->$k = $v;
+            if (in_array($k, ["url", "link", "icon", "image"])) {
+                $e->$k = new Url($v);
+            } else {
+                $e->$k = $v;
+            }
         }
         return $e;
     }

tests/cases/Util/UrlTest.php

@@ -11,7 +11,6 @@ use JKingWeb\Lax\TestCase\Util\Url\AbstractUriTestCase;
 
 /** @covers JKingWeb\Lax\Url<extended> */
 class UrlTest extends AbstractUriTestCase {
-//class UrlTest extends \PHPUnit\Framework\TestCase {
     protected function createUri($uri = '') {
         return new Url($uri);
     }