aHierPartUri

class AeonDigital\Http\Uri\Abstracts\aHierPartUri

Implementa a interface iHierPartUri.

Parent:AeonDigital\Http\Uri\Abstracts\aBasicUri Implements:AeonDigital\Interfaces\Http\Uri\iHierPartUri

Properties

Methods

public AeonDigital\Http\Uri\Abstracts\aHierPartUri::getUser()

Retorna o componente user da URI ou '' caso ele não esteja especificado.

O valor será retornado usando percent-encoding.

Returns:‹ string ›

public AeonDigital\Http\Uri\Abstracts\aHierPartUri::withUser($user)

Este método DEVE manter o estado da instância atual e retornar uma nova instância

contendo o user especificado.

Parameters:

• ‹ ?string › $user
  O novo valor para user para a nova instância.

Returns:

‹ static ›

Throws:

‹ InvalidArgumentException ›
Caso seja definido um valor inválido para user.

public AeonDigital\Http\Uri\Abstracts\aHierPartUri::getPassword()

Retorna o componente password da URI.

Uma password pode ser uma string vazia, portanto o valor null indica quando ela

não está setada.

O valor será retornado usando percent-encoding.

Returns:‹ ?string ›

public AeonDigital\Http\Uri\Abstracts\aHierPartUri::withPassword($password=null)

Este método DEVE manter o estado da instância atual e retornar uma nova instância

contendo o password especificado.

Parameters:

• ‹ ?string › $password
  O novo valor para password para a nova instância. Se null for passado, o valor da password será removido.

Returns:

‹ static ›

Throws:

‹ InvalidArgumentException ›
Caso seja definido um valor inválido para password.

public AeonDigital\Http\Uri\Abstracts\aHierPartUri::getHost()

Retorna o componente host da URI ou '' caso ele não esteja especificado.

Returns:‹ string ›

public AeonDigital\Http\Uri\Abstracts\aHierPartUri::withHost($host)

Este método DEVE manter o estado da instância atual e retornar uma nova instância

contendo o host especificado.

Parameters:

• ‹ string › $host
  O novo valor para host para a nova instância.

Returns:

‹ static ›

Throws:

‹ InvalidArgumentException ›
Caso seja definido um valor inválido para host.

public AeonDigital\Http\Uri\Abstracts\aHierPartUri::getPort()

Retorna o componente port da URI ou null caso a porta definida seja a padrão

para o scheme que está sendo usado.

Returns:‹ ?int ›

public AeonDigital\Http\Uri\Abstracts\aHierPartUri::getDefaultPort()

Retorna a porta padrão para o scheme definido para este URI.

Se o scheme não possui uma porta padrão deverá ser retornado null.

Returns:‹ ?int ›

public AeonDigital\Http\Uri\Abstracts\aHierPartUri::withPort($port)

Este método DEVE manter o estado da instância atual e retornar uma nova instância

contendo o port especificado.

Parameters:

• ‹ ?int › $port
  O novo valor para port para a nova instância.

Returns:

‹ static ›

Throws:

‹ InvalidArgumentException ›
Caso seja definido um valor inválido para port.

public AeonDigital\Http\Uri\Abstracts\aHierPartUri::getUserInfo()

Componente user information da URI.

Se este componente não estiver presente na URI será retornado ''.

Os componentes que são armazenados usando percent-encoding serão retornados já usando

este formato.

A sintaxe padrão deste componente é:

```

[username[:password]]

```

Returns:‹ string ›

public AeonDigital\Http\Uri\Abstracts\aHierPartUri::withUserInfo($user, $password=null)

Este método DEVE manter o estado da instância atual e retornar uma nova instância

contendo o user information especificado.

Parameters:

• ‹ string › $user
  O novo valor para user na nova instância.
• ‹ string › $password
  O novo valor para password na nova instância.

Returns:

‹ static ›

Throws:

‹ InvalidArgumentException ›
Caso seja definido um valor inválido para algum argumento.

public AeonDigital\Http\Uri\Abstracts\aHierPartUri::getAuthority()

Componente authority da URI.

Os componentes que são armazenados usando percent-encoding serão retornados já usando

este formato.

A sintaxe padrão deste componente é:

```

[[user-info@]host[:port]]

```

O componente port deve ser omitido quando esta não estiver definida, ou, se for uma

das portas padrão para o scheme atualmente em uso.

See:https://tools.ietf.org/html/rfc3986#section-3.2 Returns:‹ string ›

public AeonDigital\Http\Uri\Abstracts\aHierPartUri::withAuthority($user="", $password=null, $host="", $port=null)

Este método DEVE manter o estado da instância atual e retornar uma nova instância

contendo a parte "autority" especificado.

Parameters:

• ‹ string › $user
  O novo valor para user na nova instância.
• ‹ ?string › $password
  O novo valor para password para a nova instância. Se null for passado, o valor da password será removido.
• ‹ string › $host
  O novo valor para host na nova instância.
• ‹ ?int › $port
  O novo valor para port na nova instância. Use null para ignorar usar o valor padrão para o scheme.

Returns:

‹ static ›

Throws:

‹ InvalidArgumentException ›
Caso seja definido um valor inválido para algum argumento.

public AeonDigital\Http\Uri\Abstracts\aHierPartUri::getPath()

Retorna o componente path da URI ou '' caso ele não esteja especificado.

O valor será retornado usando percent-encoding.

Returns:‹ string ›

public AeonDigital\Http\Uri\Abstracts\aHierPartUri::withPath($path)

Este método DEVE manter o estado da instância atual e retornar uma nova instância

contendo o path especificado.

Parameters:

• ‹ string › $path
  O novo valor para path para a nova instância.

Returns:

‹ static ›

Throws:

‹ InvalidArgumentException ›
Caso seja definido um valor inválido para path.

public AeonDigital\Http\Uri\Abstracts\aHierPartUri::__construct($scheme="", $user="", $password=null, $host="", $port=null, $path="")

Inicia uma instância authority de uma URI.

Parameters:

• ‹ string › $scheme
  Define o scheme usado pelo URI.
• ‹ string › $user
  Define o user usado pelo URI.
• ‹ ?string › $password
  Define o password usado pelo URI. Se null for passado, o valor da password não será removido.
• ‹ string › $host
  Define o host usado pelo URI.
• ‹ ?int › $port
  Define a port usado pelo URI. Use null para usar o valor padrão para do scheme.
• ‹ string › $path
  Define o path usado pelo URI.

Throws:

‹ InvalidArgumentException ›
Caso algum dos parametros passados seja inválido.

public AeonDigital\Http\Uri\Abstracts\aHierPartUri::getBase()

Retorna uma string que representa a parte básica da URI representada pela instância.

O resultado será uma string com o seguinte formato:

```

[ scheme ":" ][ "//" authority ]

```

Returns:‹ string ›

public AeonDigital\Http\Uri\Abstracts\aHierPartUri::getBasePath()

Retorna uma string que representa toda a parte hierarquica da URI representada pela

instância.

O resultado será uma string com o seguinte formato:

```

[ scheme ":" ][ "//" authority ][ "/" path ]

```

Returns:‹ string ›