Download php cookie - download do código-fonte php cookie

biblioteca php cookie

Traduções : espanhol

Biblioteca PHP para manipulação de cookies.

Requisitos
Instalação
Aulas disponíveis
- Aula de biscoitos
- Fachada de biscoito
Exceções usadas
Uso
Sobre a expiração de cookies
Testes
PENDÊNCIA
Registro de alterações
Contribuição
Patrocinador
Licença

Requisitos

Sistema operacional: Linux.
Versões do PHP: 8.1 | 8.2 | 8.3.

Instalação

A forma preferida de instalar esta extensão é através do Composer.

Para instalar a biblioteca php cookie , simplesmente:

 composer require josantonius/cookie

O comando anterior irá instalar apenas os arquivos necessários, caso prefira baixar todo o código fonte você pode usar:

 composer require josantonius/cookie --prefer-source

Você também pode clonar o repositório completo com Git:

 git clone https://github.com/josantonius/php-cookie.git

Aulas disponíveis

Aula de biscoitos

JosantoniusCookieCookie

Define opções de cookies:

 /**
 * Cookie options:
 * 
 * domain:   Domain for which the cookie is available.
 * expires:  The time the cookie will expire.
 * httpOnly: If cookie will only be available through the HTTP protocol.
 * path:     Path for which the cookie is available.
 * raw:      If cookie will be sent as a raw string.
 * sameSite: Enforces the use of a Lax or Strict SameSite policy.
 * secure:   If cookie will only be available through the HTTPS protocol.
 * 
 * These settings will be used to create and delete cookies.
 * 
 * @throws CookieException if $sameSite value is wrong.
 *
 * @see https://www.php.net/manual/en/datetime.formats.php for date formats.
 * @see https://www.php.net/manual/en/function.setcookie.php for more information.
 */
public function __construct(
    private string              $ domain   = '' ,
    private int | string | DateTime $ expires  = 0 ,
    private bool                $ httpOnly = false ,
    private string              $ path     = ' / ' ,
    private bool                $ raw      = false ,
    private null | string         $ sameSite = null ,
    private bool                $ secure   = false
);

Define um cookie por nome:

 /**
 * @throws CookieException if headers already sent.
 * @throws CookieException if failure in date/time string analysis.
 */
public function set(
    string $ name ,
    mixed $ value ,
    null | int | string | DateTime $ expires = null
): void ;

Define vários cookies de uma vez:

 /**
 * If cookies exist they are replaced, if they do not exist they are created.
 *
 * @throws CookieException if headers already sent.
 */
public function replace(
    array $ data ,
    null | int | string | DateTime $ expires = null
): void ;

Obtém um cookie pelo nome:

 /**
 * Optionally defines a default value when the cookie does not exist.
 */
public function get( string $ name , mixed $ default = null ): mixed ;

Obtém todos os cookies:

 public function all(): array ;

Verifique se existe um cookie:

 public function has( string $ name ): bool ;

Exclui um cookie pelo nome e retorna seu valor:

 /**
 * Optionally defines a default value when the cookie does not exist.
 * 
 * @throws CookieException if headers already sent.
 */
public function pull( string $ name , mixed $ default = null ): mixed ;

Exclui um cookie pelo nome:

 /**
 * @throws CookieException if headers already sent.
 * @throws CookieException if failure in date/time string analysis.
 */
public function remove( string $ name ): void ;

Fachada de biscoito

JosantoniusCookieFacadesCookie

Define opções de cookies:

 /**
 * Cookie options:
 * 
 * domain:   Domain for which the cookie is available.
 * expires:  The time the cookie will expire.
 * httpOnly: If cookie will only be available through the HTTP protocol.
 * path:     Path for which the cookie is available.
 * raw:      If cookie will be sent as a raw string.
 * sameSite: Enforces the use of a Lax or Strict SameSite policy.
 * secure:   If cookie will only be available through the HTTPS protocol.
 * 
 * These settings will be used to create and delete cookies.
 * 
 * @throws CookieException if $sameSite value is wrong.
 *
 * @see https://www.php.net/manual/en/datetime.formats.php for date formats.
 * @see https://www.php.net/manual/en/function.setcookie.php for more information.
 */
public static function options(
    string              $ domain   = '' ,
    int | string | DateTime $ expires  = 0 ,
    bool                $ httpOnly = false ,
    string              $ path     = ' / ' ,
    bool                $ raw      = false ,
    null | string         $ sameSite = null ,
    bool                $ secure   = false
): void ;

Define um cookie por nome:

 /**
 * @throws CookieException if headers already sent.
 * @throws CookieException if failure in date/time string analysis.
 */
public static function set(
    string $ name ,
    mixed $ value ,
    null | int | string | DateTime $ expires = null
): void ;

Define vários cookies de uma vez:

 /**
 * If cookies exist they are replaced, if they do not exist they are created.
 *
 * @throws CookieException if headers already sent.
 */
public static function replace(
    array $ data ,
    null | int | string | DateTime $ expires = null
): void ;

Obtém um cookie pelo nome:

 /**
 * Optionally defines a default value when the cookie does not exist.
 */
public static function get( string $ name , mixed $ default = null ): mixed ;

Obtém todos os cookies:

 public static function all(): array ;

Verifique se existe um cookie:

 public static function has( string $ name ): bool ;

Exclui um cookie pelo nome e retorna seu valor:

 /**
 * Optionally defines a default value when the cookie does not exist.
 * 
 * @throws CookieException if headers already sent.
 */
public static function pull( string $ name , mixed $ default = null ): mixed ;

Exclui um cookie pelo nome:

 /**
 * @throws CookieException if headers already sent.
 * @throws CookieException if failure in date/time string analysis.
 */
public static function remove( string $ name ): void ;

Exceções usadas

 use Josantonius  Cookie  Exceptions  CookieException ;

Uso

Exemplo de uso para esta biblioteca:

Criar instância de cookie com opções padrão

 use Josantonius  Cookie  Cookie ;

$ cookie = new Cookie ();

 use Josantonius  Cookie  Facades  Cookie ;

Cookie:: options ();

Crie uma instância de cookie com opções personalizadas

 use Josantonius  Cookie  Cookie ;

$ cookie = new Cookie (
    domain: ' example.com ' ,
    expires: time () + 3600 ,
    httpOnly: true ,
    path: ' /foo ' ,
    raw: true ,
    sameSite: ' Strict ' ,
    secure: true ,
);

 use Josantonius  Cookie  Facades  Cookie ;

Cookie:: options (
    expires: ' now +1 hour ' ,
    httpOnly: true ,
);

Define um cookie por nome

 use Josantonius  Cookie  Cookie ;

$ cookie = new Cookie ();

$ cookie -> set ( ' foo ' , ' bar ' );

 use Josantonius  Cookie  Facades  Cookie ;

Cookie:: set ( ' foo ' , ' bar ' );

Define um cookie por nome modificando o tempo de expiração

 use Josantonius  Cookie  Cookie ;

$ cookie = new Cookie ();

$ cookie -> set ( ' foo ' , ' bar ' , time () + 3600 );

 use Josantonius  Cookie  Facades  Cookie ;

Cookie:: set ( ' foo ' , ' bar ' , new DateTime ( ' now +1 hour ' ));

Define vários cookies de uma vez

 use Josantonius  Cookie  Cookie ;

$ cookie = new Cookie ();

$ cookie -> replace ([
    ' foo ' => ' bar ' ,
    ' bar ' => ' foo '
]);

 use Josantonius  Cookie  Facades  Cookie ;

Cookie:: replace ([
    ' foo ' => ' bar ' ,
    ' bar ' => ' foo '
], time () + 3600 );

Define vários cookies de uma vez modificando o tempo de expiração

 use Josantonius  Cookie  Cookie ;

$ cookie = new Cookie ();

$ cookie -> replace ([
    ' foo ' => ' bar ' ,
    ' bar ' => ' foo '
], time () + 3600 );

 use Josantonius  Cookie  Facades  Cookie ;

Cookie:: replace ([
    ' foo ' => ' bar ' ,
    ' bar ' => ' foo '
], time () + 3600 );

Obtém um cookie pelo nome

 use Josantonius  Cookie  Cookie ;

$ cookie = new Cookie ();

$ cookie -> get ( ' foo ' ); // null if the cookie does not exist

 use Josantonius  Cookie  Facades  Cookie ;

Cookie:: get ( ' foo ' ); // null if the cookie does not exist

Obtém um cookie por nome com valor padrão se o cookie não existir

 use Josantonius  Cookie  Cookie ;

$ cookie = new Cookie ();

$ cookie -> get ( ' foo ' , false ); // false if cookie does not exist

 use Josantonius  Cookie  Facades  Cookie ;

Cookie:: get ( ' foo ' , false ); // false if cookie does not exist

Obtém todos os cookies

 use Josantonius  Cookie  Cookie ;

$ cookie = new Cookie ();

$ cookie -> all ();

 use Josantonius  Cookie  Facades  Cookie ;

Cookie:: all ();

Verifique se existe um cookie

 use Josantonius  Cookie  Cookie ;

$ cookie = new Cookie ();

$ cookie -> has ( ' foo ' );

 use Josantonius  Cookie  Facades  Cookie ;

Cookie:: has ( ' foo ' );

Exclui um cookie pelo nome e retorna seu valor

 use Josantonius  Cookie  Cookie ;

$ cookie = new Cookie ();

$ cookie -> pull ( ' foo ' ); // null if attribute does not exist

 use Josantonius  Cookie  Facades  Cookie ;

Cookie:: pull ( ' foo ' ); // null if attribute does not exist

Exclui um cookie e retorna seu valor ou valor padrão se não existir

 use Josantonius  Cookie  Cookie ;

$ cookie = new Cookie ();

$ cookie -> pull ( ' foo ' , false ); // false if attribute does not exist

 use Josantonius  Cookie  Facades  Cookie ;

Cookie:: pull ( ' foo ' , false ); // false if attribute does not exist

Exclui um cookie pelo nome

 use Josantonius  Cookie  Cookie ;

$ cookie = new Cookie ();

$ cookie -> remove ( ' foo ' );

 use Josantonius  Cookie  Facades  Cookie ;

Cookie:: remove ( ' foo ' );

Sobre o cookie expira

O parâmetro expires utilizado em diversos métodos desta biblioteca aceita os seguintes tipos: int|string|DateTime .
- Integers serão tratados como tempo unix, exceto zero.
- Strings serão tratadas como formatos de data/hora. Consulte Formatos de data e hora suportados para obter mais informações.
```
 $ cookie = new Cookie (
    expires: ' 2016-12-15 +1 day '
);
```
  Seria semelhante a:
```
 $ cookie = new Cookie (
    expires: new DateTime ( ' 2016-12-15 +1 day ' )
);
```
- Objetos DateTime serão usados para obter a hora unix.

Se o parâmetro expires for usado nos métodos set ou replace , ele será usado no lugar do valor expires definido nas opções de cookie.

 $ cookie = new Cookie (
    expires: ' now +1 minute '
);

$ cookie -> set ( ' foo ' , ' bar ' );                        // Expires in 1 minute

$ cookie -> set ( ' bar ' , ' foo ' , ' now +8 days ' );         // Expires in 8 days

$ cookie -> replace ([ ' foo ' => ' bar ' ]);                // Expires in 1 minute

$ cookie -> replace ([ ' foo ' => ' bar ' ], time () + 3600 ); // Expires in 1 hour

Se o parâmetro expires passado nas opções for uma string de data/hora, ele será formatado ao usar o método set ou replace e não ao definir as opções.

 $ cookie = new Cookie (
    expires: ' now +1 minute ' , // It will not be formatted as unix time yet
);

$ cookie -> set ( ' foo ' , ' bar ' );   // It is will formatted now and expires in 1 minute

Testes

Para rodar testes você só precisa do compositor e executar o seguinte:

 git clone https://github.com/josantonius/php-cookie.git

 cd php-cookie

 composer install

Execute testes unitários com PHPUnit:

 composer phpunit

Execute testes padrão de código com PHPCS:

 composer phpcs

Execute testes do PHP Mess Detector para detectar inconsistências no estilo do código:

 composer phpmd

Execute todos os testes anteriores:

 composer tests

PENDÊNCIA

Adicionar novo recurso
Melhorar os testes
Melhorar a documentação
Melhore a tradução em inglês no arquivo README
Refatore o código para regras de estilo de código desabilitadas (consulte phpmd.xml e phpcs.xml)

Registro de alterações

As alterações detalhadas de cada versão estão documentadas nas notas de versão.

Contribuição

Certifique-se de ler o Guia de Contribuição antes de fazer uma solicitação pull, iniciar uma discussão ou relatar um problema.

Obrigado a todos os contribuidores! ❤️

Patrocinador

Se este projeto ajudar você a reduzir seu tempo de desenvolvimento, você pode me patrocinar para apoiar meu trabalho de código aberto?

Licença

Este repositório está licenciado sob a licença MIT.

Expandir