Url
in package
implements
Stringable
Read onlyYes
URL。
Table of Contents
Interfaces
- Stringable
Properties
- $fragment : string|null
- $host : string
- $password : string
- $path : UrlPath
- $port : int|null
- $query : UrlQuery
- $scheme : string
- $user : string
Methods
- __construct() : mixed
- 生成。
- __toString() : string
- changeAuthentication() : self
- 認証情報を変更。
- changeFragment() : self
- フラグメントを変更。
- changeHost() : self
- ホストを変更。
- changePath() : self
- パスを変更。
- changePort() : self
- ポートを変更。
- changeQuery() : self
- クエリを変更。
- changeScheme() : self
- スキームを変更。
- clearAuthentication() : self
- 認証情報を破棄。
- parse() : self
- 文字列から生成。
- toString() : string
- tryParse() : bool
- 文字列から生成。
- getDecodedValue() : string|null
- 配列からURL・文字列をデコードした値を取得。
Properties
$fragment
public
string|null
$fragment
$host
public
string
$host
$password
public
string
$password
$path
public
UrlPath
$path
$port
public
int|null
$port
$query
public
UrlQuery
$query
$scheme
public
string
$scheme
$user
public
string
$user
Methods
__construct()
生成。
public
__construct(non-empty-string $scheme, string $user, string $password, non-empty-string $host, int|null $port, UrlPath $path, UrlQuery $query, string|null $fragment) : mixed
基本的には tryParse
/parse
を使用する想定。
Parameters
- $scheme : non-empty-string
- $user : string
- $password : string
- $host : non-empty-string
- $port : int|null
-
null
は未指定 - $path : UrlPath
- $query : UrlQuery
-
null
は未指定 - $fragment : string|null
-
null
は未指定
Tags
__toString()
public
__toString() : string
Return values
stringchangeAuthentication()
認証情報を変更。
public
changeAuthentication(string $user, string $password) : self
Parameters
- $user : string
- $password : string
Return values
self —変更された新規URL
changeFragment()
フラグメントを変更。
public
changeFragment(string|null $fragment) : self
Parameters
- $fragment : string|null
Return values
self —変更された新規URL
changeHost()
ホストを変更。
public
changeHost(non-empty-string $host) : self
Parameters
- $host : non-empty-string
Return values
self —変更された新規URL
changePath()
パスを変更。
public
changePath(UrlPath $path) : self
Parameters
- $path : UrlPath
Return values
self —変更された新規URL
changePort()
ポートを変更。
public
changePort(int $port) : self
Parameters
- $port : int
Tags
Return values
self —変更された新規URL
changeQuery()
クエリを変更。
public
changeQuery(UrlQuery $query) : self
Parameters
- $query : UrlQuery
Return values
self —変更された新規URL
changeScheme()
スキームを変更。
public
changeScheme(non-empty-string $scheme) : self
Parameters
- $scheme : non-empty-string
Return values
self —変更された新規URL
clearAuthentication()
認証情報を破棄。
public
clearAuthentication() : self
Return values
self —変更された新規URL
parse()
文字列から生成。
public
static parse(string $url[, UrlEncoding|null $urlEncoding = null ]) : self
失敗時に例外。
Parameters
- $url : string
-
URL 文字列。
- $urlEncoding : UrlEncoding|null = null
-
URLエンコーディング。
Return values
selftoString()
public
toString([UrlEncoding|null $urlEncoding = null ][, bool $trailingSlash = false ]) : string
Parameters
- $urlEncoding : UrlEncoding|null = null
- $trailingSlash : bool = false
Return values
stringtryParse()
文字列から生成。
public
static tryParse(string $url, self|null &$result[, UrlEncoding|null $urlEncoding = null ]) : bool
parse_url
ラッパー。
Parameters
- $url : string
-
URL 文字列。
- $result : self|null
-
結果格納。成功時に格納される。
- $urlEncoding : UrlEncoding|null = null
-
URLエンコーディング。
Tags
Return values
bool —成功。
getDecodedValue()
配列からURL・文字列をデコードした値を取得。
private
static getDecodedValue(array<string|int, mixed> $elements, string $key, string|null $default, UrlEncoding $urlEncoding) : string|null
Parameters
- $elements : array<string|int, mixed>
- $key : string
- $default : string|null
- $urlEncoding : UrlEncoding
Return values
string|null —デコードされた値か、取得失敗時のデフォルト値