Utilidad URL

Las clases Url, UrlImmutable y UrlScript facilitan el manejo, análisis y manipulación de URLs.

→ Instalación y requisitos

Url

La clase Nette\Http\Url facilita el trabajo con la URL y sus componentes individuales, que se esbozan en este diagrama:

scheme  user  password  host   port    path        query  fragment
  |      |      |        |      |       |            |       |
/--\   /--\ /------\ /-------\ /--\/----------\ /--------\ /----\
http://john:xyz%2A12@nette.org:8080/en/download?name=param#footer
\______\__________________________/
    |               |
 hostUrl        authority

La generación de URL es intuitiva:

use Nette\Http\Url;

$url = new Url;
$url->setScheme('https')
	->setHost('localhost')
	->setPath('/edit')
	->setQueryParameter('foo', 'bar');

echo $url; // 'https://localhost/edit?foo=bar'

También puede analizar la URL y luego manipularla:

$url = new Url(
	'http://john:xyz%2A12@nette.org:8080/en/download?name=param#footer',
);

La clase Url implementa la interfaz JsonSerializable y proporciona el método __toString(), que permite imprimir el objeto o utilizarlo con json_encode().

echo $url;
echo json_encode([$url]);

URL Components

Los siguientes métodos están disponibles para obtener o cambiar componentes URL individuales:

Atención: Cuando trabaje con una URL obtenida de una petición HTTP, tenga en cuenta que no contendrá el fragmento, ya que el navegador no lo envía al servidor.

También podemos operar con parámetros de consulta individuales utilizando:

getDomain (int $level = 2): string

Devuelve la parte derecha o izquierda del host. Así es como funciona si el host es www.nette.org:

isEqual (string|Url $anotherUrl): bool

Comprueba si dos URL son idénticas.

$url->isEqual('https://nette.org');

Url::isAbsolute (string $url): bool

Comprueba si una URL es absoluta. Una URL se considera absoluta si comienza con un esquema (por ejemplo, http, https, ftp) seguido de dos puntos.

Url::isAbsolute('https://nette.org');    // true
Url::isAbsolute('//nette.org');          // false

Url::removeDotSegments (string $path): string

Normaliza una ruta URL eliminando los segmentos especiales . y ... Este método elimina los elementos redundantes de la ruta del mismo modo que lo hacen los navegadores.

Url::removeDotSegments('/path/../subtree/./file.txt');  // '/subtree/file.txt'
Url::removeDotSegments('/../foo/./bar');                // '/foo/bar'
Url::removeDotSegments('./today/../file.txt');          // 'file.txt'

UrlImmutable

La clase Nette\Http\UrlImmutable es una alternativa inmutable a la clase Url (similar a como DateTimeImmutable es una alternativa inmutable a DateTime en PHP). En lugar de setters, tiene withers, que no cambian el objeto sino que devuelven nuevas instancias con el valor modificado:

use Nette\Http\UrlImmutable;

$url = new UrlImmutable(
	'http://john:xyz%2A12@nette.org:8080/en/download?name=param#footer',
);

$newUrl = $url
	->withUser('')
	->withPassword('')
	->withPath('/en/');

echo $newUrl; // 'http://nette.org:8080/en/?name=param#footer'

La clase UrlImmutable implementa la interfaz JsonSerializable y proporciona el método __toString(), que permite imprimir el objeto o utilizarlo con json_encode().

echo $url;
echo json_encode([$url]);

URL Components

Los siguientes métodos están disponibles para obtener o cambiar componentes URL individuales:

El método withoutUserInfo() elimina user y password.

También podemos operar con parámetros de consulta individuales utilizando:

getDomain (int $level = 2): string

Devuelve la parte derecha o izquierda del host. Así es como funciona si el host es www.nette.org:

resolve (string $reference): UrlImmutable

Resuelve una URL absoluta del mismo modo que un navegador procesa los enlaces de una página HTML:

• Si el enlace es una URL absoluta (contiene un esquema), se utiliza sin cambios.
• Si el enlace empieza por //, sólo se aplica el esquema de la URL actual.
• Si el enlace comienza por /, se crea una ruta absoluta desde la raíz del dominio.
• En los demás casos, la URL se construye en relación con la ruta actual.

$url = new UrlImmutable('https://example.com/path/page');
echo $url->resolve('../foo');           // 'https://example.com/foo'
echo $url->resolve('/bar');             // 'https://example.com/bar'
echo $url->resolve('sub/page.html');    // 'https://example.com/path/sub/page.html'

isEqual (string|Url $anotherUrl): bool

Comprueba si dos URL son idénticas.

$url->isEqual('https://nette.org');

UrlScript

La clase Nette\Http\UrlScript es descendiente de UrlImmutable y la amplía con componentes URL virtuales adicionales, como el directorio raíz del proyecto, etc. Al igual que su clase madre, es un objeto inmutable.

El siguiente diagrama muestra los componentes que reconoce UrlScript:

     baseUrl    basePath  relativePath  relativeUrl
        |          |        |               |
/---------------/-----\/--------\---------------------------\
http://nette.org/admin/script.php/pathinfo/?name=param#footer
                \_______________/\________/
                       |              |
                  scriptPath       pathInfo

• baseUrl es la URL base de la aplicación incluyendo el dominio y parte de la ruta al directorio raíz de la aplicación
• basePath es parte de la ruta al directorio raíz de la aplicación
• scriptPath es la ruta al script actual
• relativePath es el nombre del script (y posiblemente segmentos adicionales de la ruta) relativo a basePath
• relativeUrl es toda la parte de la URL después de baseUrl, incluyendo la cadena de consulta y el fragmento.
• pathInfo es una parte de la URL, ahora raramente utilizada, después del nombre del script

Los siguientes métodos están disponibles para obtener estas partes:

No creamos el objeto UrlScript directamente, sino que el método Nette\Http\Request::getUrl() lo devuelve.