Nette Documentation Preview

syntax 
URL の操作
*******

.[perex]
[#Url]、[#UrlImmutable]、[#UrlScript]のクラスは、URL の生成、解析、加工を簡単にします。

→ [インストールと要件 |@home#インストール]


Url
===

[api:Nette\Http\Url]クラスは、URL とその個々の部分を簡単に扱えるようにします。図のとおりです。

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

URL の生成は直感的です。

```php
use Nette\Http\Url;

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

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

URL を解析してから加工することもできます。

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

`Url` クラスは `JsonSerializable` インターフェースを実装し、`__toString()` メソッドを持つので、このオブジェクトはそのまま出力できますし、`json_encode()` に渡すデータの中でも使えます。

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


URL の部分
-------

URL の個々の部分を取り出したり変えたりするのに、次のメソッドが使えます。

.[language-php]
| セッター									| ゲッター						| 返される値
|--------------------------------------------------------------------------------------------
| `setScheme(string $scheme)`				| `getScheme(): string`			| `'http'`
| `setUser(string $user)`					| `getUser(): string`			| `'john'`
| `setPassword(string $password)`			| `getPassword(): string`		| `'xyz*12'`
| `setHost(string $host)`					| `getHost(): string`			| `'nette.org'`
| `setPort(int $port)`						| `getPort(): ?int`				| `8080`
|											| `getDefaultPort(): ?int`		| `80`
| `setPath(string $path)`					| `getPath(): string`			| `'/en/download'`
| `setQuery(string\|array $query)`			| `getQuery(): string`			| `'name=param'`
| `setFragment(string $fragment)`			| `getFragment(): string`		| `'footer'`
| 											| `getAuthority(): string`		| `'john:xyz%2A12@nette.org:8080'`
| 											| `getHostUrl(): string`		| `'http://john:xyz%2A12@nette.org:8080'`
| 											| `getAbsoluteUrl(): string` 	| URL 全体

`getUser()`、`getPassword()`、`setUser()`、`setPassword()` のメソッドは非推奨です。資格情報を URL に直接埋め込むことは勧められないからです。

注意: [HTTP のリクエスト |request]から得た URL を扱うときは、ブラウザがフラグメントをサーバーへ送らないので、そこにフラグメントは入っていないことを忘れないでください。

個々のクエリのパラメータも次のもので扱えます。

.[language-php]
| セッター									| ゲッター
|---------------------------------------------------
| `setQuery(string\|array $query)`  		| `getQueryParameters(): array`
| `setQueryParameter(string $name, $val)`	| `getQueryParameter(string $name)`
| `appendQuery(string|array $query)`	    |


getDomain(int $level = 2): string .[method]
-------------------------------------------
ホストの右側または左側の部分を返します。ホストが `www.nette.org` のときの働きは次のとおりです。

.[language-php]
| `getDomain(1)`  |  `'org'`
| `getDomain(2)`  |  `'nette.org'`
| `getDomain(3)`  |  `'www.nette.org'`
| `getDomain(0)`  |  `'www.nette.org'`
| `getDomain(-1)` |  `'www.nette'`
| `getDomain(-2)` |  `'www'`
| `getDomain(-3)` |  `''`


isEqual(string|Url $url): bool .[method]
----------------------------------------
2 つの URL が同一かを調べます。

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


canonicalize() .[method]
------------------------
URL を正式な形に変えます。ホスト名を小文字にし、パスを整えます（パーセントの符号化と余計な文字の除去）。クエリの文字列はそのままです。


Url::isAbsolute(string $url): bool .[method]{data-version:3.3.2}
----------------------------------------------------------------
URL が絶対かを調べます。URL はスキーム（たとえば http、https、ftp）とそれに続くコロンで始まるとき、絶対と見なされます。

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


Url::removeDotSegments(string $path): string .[method]{data-version:3.3.2}
--------------------------------------------------------------------------
特別な部分 `.` と `..` を取り除いて URL のパスを整えます。このメソッドは、ウェブブラウザと同じやり方で余計なパスの要素を取り除きます。

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


UrlImmutable
============

[api:Nette\Http\UrlImmutable]クラスは [#Url]クラスの、変更できない側の選択肢です（PHP で `DateTimeImmutable` が `DateTime` の変更できない側の選択肢であるのと同じです）。セッターの代わりに wither があり、それはオブジェクトを変えずに、値を変えた新しいインスタンスを返します。

```php
use Nette\Http\UrlImmutable;

$url = new UrlImmutable(
	'https://nette.org:8080/en/download?name=param#footer',
);

$newUrl = $url
	->withHost('example.com')
	->withPath('/en/')
	->withQueryParameter('name', 'value');

echo $newUrl; // 'https://example.com:8080/en/?name=value#footer'
```

`UrlImmutable` クラスは `JsonSerializable` インターフェースを実装し、`__toString()` メソッドを持つので、このオブジェクトはそのまま出力できますし、`json_encode()` に渡すデータの中でも使えます。

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


URL の部分
-------

URL の個々の部分を取り出したり変えたりするのに、次のメソッドが使えます。

.[language-php]
| Wither									| ゲッター						| 返される値
|--------------------------------------------------------------------------------------------
| `withScheme(string $scheme)`				| `getScheme(): string`			| `'http'`
| `withUser(string $user)`					| `getUser(): string`			| `'john'`
| `withPassword(string $password)`			| `getPassword(): string`		| `'xyz*12'`
| `withHost(string $host)`					| `getHost(): string`			| `'nette.org'`
| `withPort(int $port)`						| `getPort(): ?int`				| `8080`
|											| `getDefaultPort(): ?int`		| `80`
| `withPath(string $path)`					| `getPath(): string`			| `'/en/download'`
| `withQuery(string\|array $query)`			| `getQuery(): string`			| `'name=param'`
| `withFragment(string $fragment)`			| `getFragment(): string`		| `'footer'`
| 											| `getAuthority(): string`		| `'john:xyz%2A12@nette.org:8080'`
| 											| `getHostUrl(): string`		| `'http://john:xyz%2A12@nette.org:8080'`
| 											| `getAbsoluteUrl(): string` 	| URL 全体

`getUser()`、`getPassword()`、`withUser()`、`withPassword()`、`withoutUserInfo()` のメソッドは非推奨です。資格情報を URL に直接埋め込むことは勧められないからです。

個々のクエリのパラメータも次のもので扱えます。

.[language-php]
| Wither								| ゲッター
|-----------------------------------------------
| `withQuery(string\|array $query)` 	    | `getQueryParameters(): array`
| `withQueryParameter(string $name, $val)`  | `getQueryParameter(string $name)`


getDomain(int $level = 2): string .[method]
-------------------------------------------
ホストの右側または左側の部分を返します。ホストが `www.nette.org` のときの働きは次のとおりです。

.[language-php]
| `getDomain(1)`  |  `'org'`
| `getDomain(2)`  |  `'nette.org'`
| `getDomain(3)`  |  `'www.nette.org'`
| `getDomain(0)`  |  `'www.nette.org'`
| `getDomain(-1)` |  `'www.nette'`
| `getDomain(-2)` |  `'www'`
| `getDomain(-3)` |  `''`


resolve(string $reference): UrlImmutable .[method]{data-version:3.3.2}
----------------------------------------------------------------------
ブラウザが HTML のページのリンクを処理するのと同じやり方で、絶対 URL を解決します。
- リンクが絶対 URL（スキームを含む）なら、そのまま使われます
- リンクが `//` で始まるなら、今の URL のスキームだけが受け継がれます
- リンクが `/` で始まるなら、ドメインの根からの絶対パスが作られます
- そのほかの場合、URL は今のパスからの相対で組み立てられます

```php
$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 $url): bool .[method]
----------------------------------------
2 つの URL が同一かを調べます。

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


UrlScript
=========

[api:Nette\Http\UrlScript]クラスは [#UrlImmutable]の子孫で、プロジェクトの根のディレクトリなど、仮想的な URL の部分をさらに足します。親のクラスと同じく、変更できないオブジェクトです。

次の図は UrlScript が見分ける部分を示します。

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

- `baseUrl` はアプリケーションの基本の URL で、ドメインとアプリケーションの根のディレクトリまでのパスの部分を含みます
- `basePath` はアプリケーションの根のディレクトリまでのパスの部分です
- `scriptPath` は今のスクリプトへのパスです
- `relativePath` は `basePath` からの相対でのスクリプトの名前（とそれに続くパスの部分）です
- `relativeUrl` は `baseUrl` のあとの URL の部分すべてで、クエリの文字列とフラグメントも含みます
- `pathInfo` は今ではめったに使われない、スクリプトの名前のあとの URL の部分です

これらの URL の部分を取り出すのに、次のメソッドが使えます。

.[language-php]
| ゲッター						| 返される値
|------------------------------------------------
| `getScriptPath(): string`		| `'/admin/script.php'`
| `getBasePath(): string`		| `'/admin/'`
| `getBaseUrl(): string`		| `'http://nette.org/admin/'`
| `getRelativePath(): string`	| `'script.php/pathinfo/'`
| `getRelativeUrl(): string`	| `'script.php/pathinfo/?name=param#footer'`
| `getPathInfo(): string`		| `'/pathinfo/'`

ふつう `UrlScript` オブジェクトを自分で作ることはありません。代わりに [Nette\Http\Request::getUrl() |request]メソッドが、今の HTTP のリクエストに合わせて各部分が正しく設定されたものを返します。

URL の操作

Url、UrlImmutable、UrlScriptのクラスは、URL の生成、解析、加工を簡単にします。

→ インストールと要件

Url

Nette\Http\Urlクラスは、URL とその個々の部分を簡単に扱えるようにします。図のとおりです。

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

URL の生成は直感的です。

use Nette\Http\Url;

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

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

URL を解析してから加工することもできます。

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

Url クラスは JsonSerializable インターフェースを実装し、__toString() メソッドを持つので、このオブジェクトはそのまま出力できますし、json_encode() に渡すデータの中でも使えます。

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

URL の部分

URL の個々の部分を取り出したり変えたりするのに、次のメソッドが使えます。

セッター ゲッター 返される値
setScheme(string $scheme) getScheme(): string 'http'
setUser(string $user) getUser(): string 'john'
setPassword(string $password) getPassword(): string 'xyz*12'
setHost(string $host) getHost(): string 'nette.org'
setPort(int $port) getPort(): ?int 8080
  getDefaultPort(): ?int 80
setPath(string $path) getPath(): string '/en/download'
setQuery(string|array $query) getQuery(): string 'name=param'
setFragment(string $fragment) getFragment(): string 'footer'
  getAuthority(): string 'john:xyz%2A12@nette.org:8080'
  getHostUrl(): string 'http://john:xyz%2A12@nette.org:8080'
  getAbsoluteUrl(): string URL 全体

getUser()、getPassword()、setUser()、setPassword() のメソッドは非推奨です。資格情報を URL に直接埋め込むことは勧められないからです。

注意: HTTP のリクエストから得た URL を扱うときは、ブラウザがフラグメントをサーバーへ送らないので、そこにフラグメントは入っていないことを忘れないでください。

個々のクエリのパラメータも次のもので扱えます。

セッター ゲッター
setQuery(string|array $query) getQueryParameters(): array
setQueryParameter(string $name, $val) getQueryParameter(string $name)
`appendQuery(string array $query)`

getDomain(int $level = 2): string

ホストの右側または左側の部分を返します。ホストが www.nette.org のときの働きは次のとおりです。

getDomain(1) 'org'
getDomain(2) 'nette.org'
getDomain(3) 'www.nette.org'
getDomain(0) 'www.nette.org'
getDomain(-1) 'www.nette'
getDomain(-2) 'www'
getDomain(-3) ''

isEqual(string|Url $url): bool

2 つの URL が同一かを調べます。

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

canonicalize()

URL を正式な形に変えます。ホスト名を小文字にし、パスを整えます（パーセントの符号化と余計な文字の除去）。クエリの文字列はそのままです。

Url::isAbsolute(string $url): bool

URL が絶対かを調べます。URL はスキーム（たとえば http、https、ftp）とそれに続くコロンで始まるとき、絶対と見なされます。

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

Url::removeDotSegments(string $path): string

特別な部分 . と .. を取り除いて URL のパスを整えます。このメソッドは、ウェブブラウザと同じやり方で余計なパスの要素を取り除きます。

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

UrlImmutable

Nette\Http\UrlImmutableクラスは Urlクラスの、変更できない側の選択肢です（PHP で DateTimeImmutable が DateTime の変更できない側の選択肢であるのと同じです）。セッターの代わりに wither があり、それはオブジェクトを変えずに、値を変えた新しいインスタンスを返します。

use Nette\Http\UrlImmutable;

$url = new UrlImmutable(
	'https://nette.org:8080/en/download?name=param#footer',
);

$newUrl = $url
	->withHost('example.com')
	->withPath('/en/')
	->withQueryParameter('name', 'value');

echo $newUrl; // 'https://example.com:8080/en/?name=value#footer'

UrlImmutable クラスは JsonSerializable インターフェースを実装し、__toString() メソッドを持つので、このオブジェクトはそのまま出力できますし、json_encode() に渡すデータの中でも使えます。

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

URL の部分

URL の個々の部分を取り出したり変えたりするのに、次のメソッドが使えます。

Wither ゲッター 返される値
withScheme(string $scheme) getScheme(): string 'http'
withUser(string $user) getUser(): string 'john'
withPassword(string $password) getPassword(): string 'xyz*12'
withHost(string $host) getHost(): string 'nette.org'
withPort(int $port) getPort(): ?int 8080
  getDefaultPort(): ?int 80
withPath(string $path) getPath(): string '/en/download'
withQuery(string|array $query) getQuery(): string 'name=param'
withFragment(string $fragment) getFragment(): string 'footer'
  getAuthority(): string 'john:xyz%2A12@nette.org:8080'
  getHostUrl(): string 'http://john:xyz%2A12@nette.org:8080'
  getAbsoluteUrl(): string URL 全体

getUser()、getPassword()、withUser()、withPassword()、withoutUserInfo() のメソッドは非推奨です。資格情報を URL に直接埋め込むことは勧められないからです。

個々のクエリのパラメータも次のもので扱えます。

Wither ゲッター
withQuery(string|array $query) getQueryParameters(): array
withQueryParameter(string $name, $val) getQueryParameter(string $name)

getDomain(int $level = 2): string

ホストの右側または左側の部分を返します。ホストが www.nette.org のときの働きは次のとおりです。

getDomain(1) 'org'
getDomain(2) 'nette.org'
getDomain(3) 'www.nette.org'
getDomain(0) 'www.nette.org'
getDomain(-1) 'www.nette'
getDomain(-2) 'www'
getDomain(-3) ''

resolve(string $reference): UrlImmutable

ブラウザが HTML のページのリンクを処理するのと同じやり方で、絶対 URL を解決します。

  • リンクが絶対 URL（スキームを含む）なら、そのまま使われます
  • リンクが // で始まるなら、今の URL のスキームだけが受け継がれます
  • リンクが / で始まるなら、ドメインの根からの絶対パスが作られます
  • そのほかの場合、URL は今のパスからの相対で組み立てられます
$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 $url): bool

2 つの URL が同一かを調べます。

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

UrlScript

Nette\Http\UrlScriptクラスは UrlImmutableの子孫で、プロジェクトの根のディレクトリなど、仮想的な URL の部分をさらに足します。親のクラスと同じく、変更できないオブジェクトです。

次の図は UrlScript が見分ける部分を示します。

     baseUrl    basePath  relativePath  relativeUrl
        |          |        |               |
/---------------/-----\/--------\---------------------------\
http://nette.org/admin/script.php/pathinfo/?name=param#footer
                \_______________/\________/
                       |              |
                  scriptPath       pathInfo
  • baseUrl はアプリケーションの基本の URL で、ドメインとアプリケーションの根のディレクトリまでのパスの部分を含みます
  • basePath はアプリケーションの根のディレクトリまでのパスの部分です
  • scriptPath は今のスクリプトへのパスです
  • relativePath は basePath からの相対でのスクリプトの名前（とそれに続くパスの部分）です
  • relativeUrl は baseUrl のあとの URL の部分すべてで、クエリの文字列とフラグメントも含みます
  • pathInfo は今ではめったに使われない、スクリプトの名前のあとの URL の部分です

これらの URL の部分を取り出すのに、次のメソッドが使えます。

ゲッター 返される値
getScriptPath(): string '/admin/script.php'
getBasePath(): string '/admin/'
getBaseUrl(): string 'http://nette.org/admin/'
getRelativePath(): string 'script.php/pathinfo/'
getRelativeUrl(): string 'script.php/pathinfo/?name=param#footer'
getPathInfo(): string '/pathinfo/'

ふつう UrlScript オブジェクトを自分で作ることはありません。代わりに Nette\Http\Request::getUrl()メソッドが、今の HTTP のリクエストに合わせて各部分が正しく設定されたものを返します。