Uri::create renamed Uri::createFromBaseUri

thephpleague · Jun 1, 2019 · 46576c6 · 46576c6
1 parent 495dccd
commit 46576c6
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 24 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,19 +8,29 @@ All Notable changes to `League\Uri` will be documented in this file
 
 - `League\Uri\UriInfo`: to get RFC3986 information from an URI object
 - `League\Uri\UriResolver`: to resolve or relativize an URI object
-- `League\Uri\UriString`: to parse or build an URL into or from its component
+- `League\Uri\UriString`: to parse or build an URL into or from its components
+- `League\Uri\Uri::createFromBaseUri` named constructor
+- `League\Uri\Uri::createFromDataPath` named constructor
+- `League\Uri\Uri::createFromPsr7` named constructor
+- `League\Uri\Uri::createFromUnixPath` named constructor
+- `League\Uri\Uri::createFromWindowsPath` named constructor
+- `League\Uri\Http::createFromBaseUri` named constructor
 
 ### Fixed
 
 - Improve parsing and building URI
 - All URI object are now finals and supports parameter type widening
+- `League\Uri\Uri` implements the `JsonSerializable` interface
+- `League\Uri\Http` implements the `JsonSerializable` interface
 
 ### Deprecated
 
 - None
 
 ### Remove
 
+- support for PHP7.1 and PHP7.0
+- `create` function defined in the  `League\Uri` namespace replaced by `League\Uri\Uri::createFromBaseUri`
 - `League\Uri\Factory` replaced by `League\Uri\Uri`
 - `League\Uri\Data` replaced by `League\Uri\Uri`
 - `League\Uri\File` replaced by `League\Uri\Uri`
@@ -29,8 +39,7 @@ All Notable changes to `League\Uri` will be documented in this file
 - `League\Uri\UriException` replaced by `League\Uri\Contract\UriException`
 - `League\Uri\AbstractUri` internal, replaced by `League\Uri\Uri`
 - `League\Uri\Schemes` namespace and all classes inside
-- all functions defined in the  `League\Uri` namespace replaced by `League\Uri\Uri::create` public static method
-- support for PHP7.1 and PHP7.0
+- `League\Uri\Uri` no longer implements `League\Uri\UriInterface`
 
 ## 5.3.0 - 2018-03-14
 

diff --git a/README.md b/README.md
@@ -27,7 +27,9 @@ Full documentation can be found at [uri.thephpleague.com][].
 System Requirements
 -------
 
-You require **PHP >= 7.2** but the latest stable version of PHP is recommended.
+You need **PHP >= 7.2** but the latest stable version of PHP is recommended
+
+In order to handle IDN host you are required to also install the `intl` extension otherwise an exception will be thrown when attempting to validate such host.
 
 Dependencies
 -------

diff --git a/phpstan.src.neon b/phpstan.src.neon
@@ -3,5 +3,4 @@ includes:
     - vendor/phpstan/phpstan-phpunit/rules.neon
 parameters:
     ignoreErrors:
-        - '#Method League\\Uri\\Uri::create\(\) should return League\\Uri\\Contract\\UriInterface but returns League\\Uri\\Contract\\UriInterface\|Psr\\Http\\Message\\UriInterface.#'
     reportUnmatchedIgnoredErrors: true
diff --git a/src/Http.php b/src/Http.php
@@ -102,9 +102,9 @@ public static function createFromServer(array $server): self
      * @param mixed $uri      the input URI to create
      * @param mixed $base_uri the base URI used for reference
      */
-    public static function create($uri, $base_uri = null): self
+    public static function createFromBaseUri($uri, $base_uri = null): self
     {
-        return new self(Uri::create($uri, $base_uri));
+        return new self(Uri::createFromBaseUri($uri, $base_uri));
     }
 
     /**

diff --git a/src/Uri.php b/src/Uri.php
@@ -538,7 +538,7 @@ public static function __set_state(array $components): self
      * @param mixed $uri      the input URI to create
      * @param mixed $base_uri the base URI used for reference
      */
-    public static function create($uri, $base_uri = null): UriInterface
+    public static function createFromBaseUri($uri, $base_uri = null): UriInterface
     {
         if (!$uri instanceof UriInterface) {
             $uri = self::createFromString($uri);
@@ -553,7 +553,10 @@ public static function create($uri, $base_uri = null): UriInterface
                 return $uri;
             }
 
-            return UriResolver::resolve($uri, $uri->withFragment(null)->withQuery(null)->withPath(''));
+            /** @var UriInterface $uri */
+            $uri = UriResolver::resolve($uri, $uri->withFragment(null)->withQuery(null)->withPath(''));
+
+            return $uri;
         }
 
         if (!$base_uri instanceof UriInterface) {
@@ -564,7 +567,10 @@ public static function create($uri, $base_uri = null): UriInterface
             throw new SyntaxError(sprintf('the base URI `%s` must be absolute', (string) $base_uri));
         }
 
-        return UriResolver::resolve($uri, $base_uri);
+        /** @var UriInterface $uri */
+        $uri = UriResolver::resolve($uri, $base_uri);
+
+        return $uri;
     }
 
     /**

diff --git a/tests/FactoryTest.php b/tests/FactoryTest.php
@@ -356,13 +356,13 @@ public function testFailCreateFromServerWithoutInvalidUserInfo(): void
     }
 
     /**
-     * @covers ::create
+     * @covers ::createFromBaseUri
      *
      * @dataProvider createProvider
      */
-    public function testCreate(string $base_uri, string $uri, string $expected): void
+    public function testCreateFromBaseUri(string $base_uri, string $uri, string $expected): void
     {
-        self::assertSame($expected, (string) Uri::create($uri, $base_uri));
+        self::assertSame($expected, (string) Uri::createFromBaseUri($uri, $base_uri));
     }
     public function createProvider(): array
     {
@@ -412,42 +412,42 @@ public function createProvider(): array
     }
 
     /**
-     * @covers ::create
+     * @covers ::createFromBaseUri
      */
     public function testCreateThrowExceptionWithBaseUriNotAbsolute(): void
     {
         self::expectException(SyntaxError::class);
-        Uri::create('/path/to/you', '//example.com');
+        Uri::createFromBaseUri('/path/to/you', '//example.com');
     }
 
     /**
-     * @covers ::create
+     * @covers ::createFromBaseUri
      */
     public function testCreateThrowExceptionWithUriNotAbsolute(): void
     {
         self::expectException(SyntaxError::class);
-        Uri::create('/path/to/you');
+        Uri::createFromBaseUri('/path/to/you');
     }
 
     /**
-     * @covers ::create
+     * @covers ::createFromBaseUri
      */
     public function testCreateWithUriWithoutAuthority(): void
     {
         self::assertSame(
             'data:text/plain;charset=us-ascii,',
-            (string) Uri::create('data:text/plain;charset=us-ascii,')
+            (string) Uri::createFromBaseUri('data:text/plain;charset=us-ascii,')
         );
     }
 
     /**
-     * @covers ::create
+     * @covers ::createFromBaseUri
      */
     public function testCreateWithAbasoluteUriWithoutBaseUri(): void
     {
         self::assertSame(
             'scheme://host/sky?q#f',
-            (string) Uri::create('scheme://host/path/../sky?q#f')
+            (string) Uri::createFromBaseUri('scheme://host/path/../sky?q#f')
         );
     }
 }
diff --git a/tests/HttpTest.php b/tests/HttpTest.php
@@ -128,13 +128,13 @@ public function testCreateFromComponents(): void
     }
 
     /**
-     * @covers ::create
+     * @covers ::createFromBaseUri
      */
-    public function testCreate(): void
+    public function testCreateFromBaseUri(): void
     {
         self::assertEquals(
             Http::createFromString('http://0:0@0/0?0#0'),
-            Http::create('0?0#0', 'http://0:0@0/')
+            Http::createFromBaseUri('0?0#0', 'http://0:0@0/')
         );
     }