Adding PHP8.4 support and Deprecated attribute

thephpleague · Dec 4, 2024 · c83f88b · c83f88b
1 parent eb091b8
commit c83f88b
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 1 deletion.
diff --git a/Http.php b/Http.php
@@ -13,6 +13,7 @@
 
 namespace League\Uri;
 
+use Deprecated;
 use JsonSerializable;
 use League\Uri\Contracts\UriException;
 use League\Uri\Contracts\UriInterface;
@@ -253,6 +254,7 @@ public function withFragment(string $fragment): self
      *
      * Create a new instance from a string.
      */
+    #[Deprecated(message:'use League\Uri\Http::new() instead', since:'league/uri:7.0.0')]
     public static function createFromString(Stringable|string $uri = ''): self
     {
         return self::new($uri);
@@ -270,6 +272,7 @@ public static function createFromString(Stringable|string $uri = ''): self
      * @param InputComponentMap $components a hash representation of the URI similar
      *                                      to PHP parse_url function result
      */
+    #[Deprecated(message:'use League\Uri\Http::fromComponents() instead', since:'league/uri:7.0.0')]
     public static function createFromComponents(array $components): self
     {
         return self::fromComponents($components);
@@ -284,6 +287,7 @@ public static function createFromComponents(array $components): self
      *
      * Create a new instance from the environment.
      */
+    #[Deprecated(message:'use League\Uri\Http::fromServer() instead', since:'league/uri:7.0.0')]
     public static function createFromServer(array $server): self
     {
         return self::fromServer($server);
@@ -298,6 +302,7 @@ public static function createFromServer(array $server): self
      *
      * Create a new instance from a URI object.
      */
+    #[Deprecated(message:'use League\Uri\Http::new() instead', since:'league/uri:7.0.0')]
     public static function createFromUri(Psr7UriInterface|UriInterface $uri): self
     {
         return self::new($uri);
@@ -314,6 +319,7 @@ public static function createFromUri(Psr7UriInterface|UriInterface $uri): self
      *
      * The returned URI must be absolute.
      */
+    #[Deprecated(message:'use League\Uri\Http::fromBaseUri() instead', since:'league/uri:7.0.0')]
     public static function createFromBaseUri(Stringable|string $uri, Stringable|string|null $baseUri = null): self
     {
         return self::fromBaseUri($uri, $baseUri);

diff --git a/Uri.php b/Uri.php
@@ -13,6 +13,7 @@
 
 namespace League\Uri;
 
+use Deprecated;
 use finfo;
 use League\Uri\Contracts\UriComponentInterface;
 use League\Uri\Contracts\UriException;
@@ -692,7 +693,7 @@ private static function fetchHostname(array $server): array
     /**
      * Returns the environment path.
      *
-     * @return non-empty-array{0:?string, 1:?string}
+     * @return list<?string>
      */
     private static function fetchRequestUri(array $server): array
     {
@@ -1194,6 +1195,7 @@ public function withFragment(Stringable|string|null $fragment): UriInterface
      *
      * @return ComponentMap
      */
+    #[Deprecated(message:'use League\Uri\Uri::toComponents() instead', since:'league/uri:7.5.0')]
     public function getComponents(): array
     {
         return $this->toComponents();
@@ -1206,6 +1208,7 @@ public function getComponents(): array
      * @codeCoverageIgnore
      * @see Uri::new()
      */
+    #[Deprecated(message:'use League\Uri\Uri::new() instead', since:'league/uri:7.0.0')]
     public static function createFromString(Stringable|string $uri = ''): self
     {
         return self::new($uri);
@@ -1220,6 +1223,7 @@ public static function createFromString(Stringable|string $uri = ''): self
      *
      * @param InputComponentMap $components a hash representation of the URI similar to PHP parse_url function result
      */
+    #[Deprecated(message:'use League\Uri\Uri::fromComponents() instead', since:'league/uri:7.0.0')]
     public static function createFromComponents(array $components = []): self
     {
         return self::fromComponents($components);
@@ -1237,6 +1241,7 @@ public static function createFromComponents(array $components = []): self
      * @deprecated Since version 7.0.0
      * @codeCoverageIgnore
      */
+    #[Deprecated(message:'use League\Uri\Uri::fromDataPath() instead', since:'league/uri:7.0.0')]
     public static function createFromDataPath(string $path, $context = null): self
     {
         return self::fromFileContents($path, $context);
@@ -1253,6 +1258,7 @@ public static function createFromDataPath(string $path, $context = null): self
      *
      * The returned URI must be absolute.
      */
+    #[Deprecated(message:'use League\Uri\Uri::fromBaseUri() instead', since:'league/uri:7.0.0')]
     public static function createFromBaseUri(
         Stringable|UriInterface|String $uri,
         Stringable|UriInterface|String|null $baseUri = null
@@ -1269,6 +1275,7 @@ public static function createFromBaseUri(
      *
      * Create a new instance from a Unix path string.
      */
+    #[Deprecated(message:'use League\Uri\Uri::fromUnixPath() instead', since:'league/uri:7.0.0')]
     public static function createFromUnixPath(string $uri = ''): self
     {
         return self::fromUnixPath($uri);
@@ -1283,6 +1290,7 @@ public static function createFromUnixPath(string $uri = ''): self
      *
      * Create a new instance from a local Windows path string.
      */
+    #[Deprecated(message:'use League\Uri\Uri::fromWindowsPath() instead', since:'league/uri:7.0.0')]
     public static function createFromWindowsPath(string $uri = ''): self
     {
         return self::fromWindowsPath($uri);
@@ -1297,6 +1305,7 @@ public static function createFromWindowsPath(string $uri = ''): self
      *
      * Create a new instance from a URI object.
      */
+    #[Deprecated(message:'use League\Uri\Uri::new() instead', since:'league/uri:7.0.0')]
     public static function createFromUri(Psr7UriInterface|UriInterface $uri): self
     {
         return self::new($uri);
@@ -1311,6 +1320,7 @@ public static function createFromUri(Psr7UriInterface|UriInterface $uri): self
      *
      * Create a new instance from the environment.
      */
+    #[Deprecated(message:'use League\Uri\Uri::fromServer() instead', since:'league/uri:7.0.0')]
     public static function createFromServer(array $server): self
     {
         return self::fromServer($server);

diff --git a/UriInfo.php b/UriInfo.php
@@ -13,6 +13,7 @@
 
 namespace League\Uri;
 
+use Deprecated;
 use League\Uri\Contracts\UriInterface;
 use Psr\Http\Message\UriInterface as Psr7UriInterface;
 
@@ -33,6 +34,7 @@ private function __construct()
     /**
      * Tells whether the URI represents an absolute URI.
      */
+    #[Deprecated(message:'use League\Uri\BaseUri::isAbsolute() instead', since:'league/uri:7.0.0')]
     public static function isAbsolute(Psr7UriInterface|UriInterface $uri): bool
     {
         return BaseUri::from($uri)->isAbsolute();
@@ -41,6 +43,7 @@ public static function isAbsolute(Psr7UriInterface|UriInterface $uri): bool
     /**
      * Tell whether the URI represents a network path.
      */
+    #[Deprecated(message:'use League\Uri\BaseUri::isNetworkPath() instead', since:'league/uri:7.0.0')]
     public static function isNetworkPath(Psr7UriInterface|UriInterface $uri): bool
     {
         return BaseUri::from($uri)->isNetworkPath();
@@ -49,6 +52,7 @@ public static function isNetworkPath(Psr7UriInterface|UriInterface $uri): bool
     /**
      * Tells whether the URI represents an absolute path.
      */
+    #[Deprecated(message:'use League\Uri\BaseUri::isAbsolutePath() instead', since:'league/uri:7.0.0')]
     public static function isAbsolutePath(Psr7UriInterface|UriInterface $uri): bool
     {
         return BaseUri::from($uri)->isAbsolutePath();
@@ -58,6 +62,7 @@ public static function isAbsolutePath(Psr7UriInterface|UriInterface $uri): bool
      * Tell whether the URI represents a relative path.
      *
      */
+    #[Deprecated(message:'use League\Uri\BaseUri::isRelativePath() instead', since:'league/uri:7.0.0')]
     public static function isRelativePath(Psr7UriInterface|UriInterface $uri): bool
     {
         return BaseUri::from($uri)->isRelativePath();
@@ -66,6 +71,7 @@ public static function isRelativePath(Psr7UriInterface|UriInterface $uri): bool
     /**
      * Tells whether both URI refers to the same document.
      */
+    #[Deprecated(message:'use League\Uri\BaseUri::isSameDocument() instead', since:'league/uri:7.0.0')]
     public static function isSameDocument(Psr7UriInterface|UriInterface $uri, Psr7UriInterface|UriInterface $baseUri): bool
     {
         return BaseUri::from($baseUri)->isSameDocument($uri);
@@ -80,6 +86,7 @@ public static function isSameDocument(Psr7UriInterface|UriInterface $uri, Psr7Ur
      * For URI with the file scheme the method will return null (as this is left to the implementation decision)
      * For URI with a special scheme the method returns the scheme followed by its authority (without the userinfo part)
      */
+    #[Deprecated(message:'use League\Uri\BaseUri::origin() instead', since:'league/uri:7.0.0')]
     public static function getOrigin(Psr7UriInterface|UriInterface $uri): ?string
     {
         return BaseUri::from($uri)->origin()?->__toString();
@@ -90,6 +97,7 @@ public static function getOrigin(Psr7UriInterface|UriInterface $uri): ?string
      *
      * @see UriInfo::getOrigin()
      */
+    #[Deprecated(message:'use League\Uri\BaseUri::isCrossOrigin() instead', since:'league/uri:7.0.0')]
     public static function isCrossOrigin(Psr7UriInterface|UriInterface $uri, Psr7UriInterface|UriInterface $baseUri): bool
     {
         return BaseUri::from($baseUri)->isCrossOrigin($uri);

diff --git a/UriResolver.php b/UriResolver.php
@@ -13,6 +13,7 @@
 
 namespace League\Uri;
 
+use Deprecated;
 use League\Uri\Contracts\UriInterface;
 use Psr\Http\Message\UriInterface as Psr7UriInterface;
 
@@ -32,6 +33,7 @@ final class UriResolver
      * This method MUST be transparent when dealing with error and exceptions.
      * It MUST not alter or silence them apart from validating its own parameters.
      */
+    #[Deprecated(message:'use League\Uri\BaseUri::resolve() instead', since:'league/uri:7.0.0')]
     public static function resolve(Psr7UriInterface|UriInterface $uri, Psr7UriInterface|UriInterface $baseUri): Psr7UriInterface|UriInterface
     {
         return BaseUri::from($baseUri)->resolve($uri)->getUri();
@@ -46,6 +48,7 @@ public static function resolve(Psr7UriInterface|UriInterface $uri, Psr7UriInterf
      * This method MUST be transparent when dealing with error and exceptions.
      * It MUST not alter or silence them apart from validating its own parameters.
      */
+    #[Deprecated(message:'use League\Uri\BaseUri::relativize() instead', since:'league/uri:7.0.0')]
     public static function relativize(Psr7UriInterface|UriInterface $uri, Psr7UriInterface|UriInterface $baseUri): Psr7UriInterface|UriInterface
     {
         return BaseUri::from($baseUri)->relativize($uri)->getUri();

diff --git a/UriTemplate/Expression.php b/UriTemplate/Expression.php
@@ -13,6 +13,7 @@
 
 namespace League\Uri\UriTemplate;
 
+use Deprecated;
 use League\Uri\Exceptions\SyntaxError;
 use Stringable;
 
@@ -71,6 +72,7 @@ public static function new(Stringable|string $expression): self
      * @deprecated Since version 7.0.0
      * @codeCoverageIgnore
      */
+    #[Deprecated(message:'use League\Uri\UriTemplate\Exppression::new() instead', since:'league/uri:7.0.0')]
     public static function createFromString(Stringable|string $expression): self
     {
         return self::new($expression);

diff --git a/UriTemplate/Template.php b/UriTemplate/Template.php
@@ -13,6 +13,7 @@
 
 namespace League\Uri\UriTemplate;
 
+use Deprecated;
 use League\Uri\Exceptions\SyntaxError;
 use Stringable;
 
@@ -136,6 +137,7 @@ public function __toString(): string
      * Create a new instance from a string.
      *
      */
+    #[Deprecated(message:'use League\Uri\UriTemplate\Template::new() instead', since:'league/uri:7.0.0')]
     public static function createFromString(Stringable|string $template): self
     {
         return self::new($template);