Cookie

class AeonDigital\Http\Data\Cookie
Representa um cookie.
Parent:AeonDigital\BObject
Implements:AeonDigital\Interfaces\Http\Data\iCookie
Used traits:AeonDigitalTraitsMainCheckArgumentException

Properties

Methods

public AeonDigital\Http\Data\Cookie::setName($name)
Define o nome do cookie.
Parameters:
  • ‹ string › $name
    Nome do cookie.
Returns:

‹ void ›
Throws:

‹ InvalidArgumentException ›
Caso o valor indicado seja inválido.
public AeonDigital\Http\Data\Cookie::getName()
Retorna o nome identificador do cookie.
Returns:‹ string ›
public AeonDigital\Http\Data\Cookie::setValue($value)
Define o valor do cookie.
O valor será armazenado em percent-encode.
Parameters:
  • ‹ string › $value
    Valor do cookie.
Returns:

‹ void ›
public AeonDigital\Http\Data\Cookie::getValue($urldecoded=true)
Retorna o valor do cookie.
O valor será retornado usando percent-encode.
Parameters:
  • ‹ bool › $urldecoded
    Indica se o valor retornado deve ser convertido para o formato natural, sem percent-encode.
Returns:

‹ string ›
public AeonDigital\Http\Data\Cookie::setExpires($expires)
Define o Expires do cookie.
O valor null irá remover esta propriedade do cookie.
Parameters:
  • ‹ ?\AeonDigital\Http\Data\DateTime › $expires
    Data de expiração.
Returns:

‹ void ›
public AeonDigital\Http\Data\Cookie::getExpires()
Retorna o atual valor de Expires definido para este cookie em formato DateTime.
O valor null será retornado caso nenhum valor esteja definido para esta propriedade.
Returns:‹ ?\AeonDigital\Http\Data\DateTime ›
public AeonDigital\Http\Data\Cookie::getStrExpires()
Retorna o atual valor de Expires definido para este cookie.
O valor deve ser devolvido usando o modelo:

```
strDay(3 char), intDay strMonth(3 char) intYear intHour:intMinute:intSec UTC
```

O valor null será retornado caso nenhum valor esteja definido para esta propriedade.
Returns:‹ ?\DateTime ›
public AeonDigital\Http\Data\Cookie::setDomain($domain)
Define o Domain do cookie.
O valor null irá remover esta propriedade do cookie.
Parameters:
  • ‹ ?string › $domain
    Domain.
Returns:

‹ void ›
public AeonDigital\Http\Data\Cookie::getDomain()
Retorna o Domain definido para este cookie.
O velor deve ser devolvido em seu formato lowerCase.

O valor null será retornado caso nenhum valor esteja definido para esta propriedade.
Returns:‹ ?string ›
public AeonDigital\Http\Data\Cookie::setPath($path)
Define o Path do cookie.
O valor null irá remover esta propriedade do cookie.
Parameters:
  • ‹ ?string › $path
    Path.
Returns:

‹ void ›
public AeonDigital\Http\Data\Cookie::getPath()
Retorna o Path definido para este cookie.
O valor / será retornado caso nenhum valor esteja definido para esta propriedade.
Returns:‹ string ›
public AeonDigital\Http\Data\Cookie::setSecure($secure)
Define se o cookie é do tipo Secure.
Quando true significa que o cookie só deve trafegar em canais seguros (tipicamente
Http sobre uma camada TSL).

O valor null irá remover esta propriedade do cookie.
Parameters:
  • ‹ bool › $secure
    Secure.
Returns:

‹ void ›
public AeonDigital\Http\Data\Cookie::getSecure()
Indica se a diretiva Secure deve ser aplicada.
Quando true significa que o cookie só deve trafegar em canais seguros (tipicamente
Http sobre uma camada TSL).
Returns:‹ bool ›
public AeonDigital\Http\Data\Cookie::setHttpOnly($httpOnly)
Define se o cookie é do tipo HttpOnly.
Quando true significa que o cookie só deve trafegar em via Http.

O valor null irá remover esta propriedade do cookie.
Parameters:
  • ‹ bool › $httpOnly
    HttpOnly.
Returns:

‹ void ›
public AeonDigital\Http\Data\Cookie::getHttpOnly()
Indica se a diretiva HttpOnly deve ser aplicada.
Quando true significa que o cookie só deve trafegar em via Http.
Returns:‹ bool ›
public AeonDigital\Http\Data\Cookie::__construct($name, $value="", $expires=null, $domain=null, $path="/", $secure=false, $httpOnly=false)
Inicia um novo objeto Cookie.
Parameters:
  • ‹ string › $name
    Nome do cookie.
  • ‹ string › $value
    Valor do cookie.
  • ‹ ?\DateTime › $expires
    Data de expiração do cookie.
  • ‹ ?string › $domain
    Domínio.
  • ‹ ?string › $path
    Path.
  • ‹ bool › $secure
    Secure.
  • ‹ bool › $httpOnly
    HttpOnly.
Throws:

‹ InvalidArgumentException ›
Caso algum dos valores iniciais a serem definidos não seja aceito.
public AeonDigital\Http\Data\Cookie::toString($urldecoded=true)
Devolve uma string com o valor completo do Cookie.
```
name=value; [Expires=string;] [Domain=string;] [Path=string;] [Secure;] [HttpOnly;]
```
Parameters:
  • ‹ bool › $urldecoded
    Indica se o valor retornado deve ser convertido para o formato natural, sem percent-encode.
Returns:

‹ string ›
public AeonDigital\Http\Data\Cookie::defineCookie()
Cria o cookie e envia-o para o UA.
O retorno true apenas indica que a operação foi concluída mas não que o UA
aceitou o Cookie.
Returns:‹ bool ›
public AeonDigital\Http\Data\Cookie::removeCookie()
Remove o cookie atual.
O retorno true apenas indica que a operação foi concluída mas não que o UA
aceitou o Cookie.
Returns:‹ bool ›
public static AeonDigital\Http\Data\Cookie::fromString($str)
Converte a string passada em um objeto Cookie.
Parameters:
  • ‹ string › $str
    String do objeto Cookie.
Returns:

‹ \AeonDigital\Http\Data\Cookie ›
Throws:

‹ InvalidArgumentException ›
Se a conversão não for possível.
public static AeonDigital\Http\Data\Cookie::fromRawCookieHeader($str)
Converte uma string de dados brutos em um array de cookies correspondendo às informações
existentes para cada qual.
Retorna um array associativo onde:

```
["cookieName" => Cookie ]
```
Parameters:
  • ‹ string › $str
    String dos objetos Cookie.
Returns:

‹ array ›
Throws:

‹ InvalidArgumentException ›
Se a conversão não for possível.