PHP Classes

File: README-ES.md

Recommend this page to a friend!
  Classes of Josantonius   PHP Cookie   README-ES.md   Download  
File: README-ES.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: PHP Cookie
Store and retrieve cookie values
Author: By
Last change: Updated to 1.1.6 version
Updated to 1.1.6 version
Updated to 1.1.6 version
Date: 5 years ago
Size: 7,172 bytes
 

Contents

Class file image Download

PHP Cookie library

Latest Stable Version Latest Unstable Version License Codacy Badge Total Downloads Travis PSR2 PSR4 CodeCov

English version

Biblioteca PHP para el manejo de cookies.

Requisitos

Esta clase es soportada por versiones de PHP 5.6 o superiores.

Instalación

La mejor forma de instalar esta extensión es a través de Composer.

Para instalar PHP Cookie library, simplemente escribe:

$ composer require Josantonius/Cookie

El comando anterior sólo instalará los archivos necesarios, si prefieres descargar todo el código fuente puedes utilizar:

$ composer require Josantonius/Cookie --prefer-source

También puedes clonar el repositorio completo con Git:

$ git clone https://github.com/Josantonius/PHP-Cookie.git

O instalarlo manualmente:

Descargar Cookie.php:

$ wget https://raw.githubusercontent.com/Josantonius/PHP-Cookie/master/src/Cookie.php

Métodos disponibles

Métodos disponibles en esta biblioteca:

- Crear cookie:

Cookie::set($key, $value, $time);

| Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $key | Nombre de la cookie. | string | Sí | | | $value | Valores a guardar. | string | Sí | | | $time | Tiempo de expiración en días. | string | No | 365 |

# Return (boolean)

- Obtener valor de cookie:

Cookie::get($key);

| Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $key | Nombre de la cookie. | string | No | '' |

# Return (mixed|false) ? devuelve el valor de la cookie, todas las cookies o falso

- Extraer valor de cookie eliminarla:

Cookie::pull($key);

| Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $key | Nombre de la cookie. | string | Sí | |

# Return (string|false) ? valor de la cookie o falso si no existe

- Eliminar cookie:

Cookie::destroy($key);

| Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $key | Nombre de la cookie a eliminar. Si no se indica ninguna se eliminarán todas las cookies. | string | No | '' |

# Return (boolean)

- Establecer prefijo para cookies:

Cookie::setPrefix($prefix);

| Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $prefix | Prefijo para las cookies. | string | Sí | |

# Return (boolean)

- Obtener prefijo de cookies:

Cookie::getPrefix();

# Return (string) ? prefijo de cookies

Cómo empezar

Para utilizar esta clase con Composer:

require __DIR__ . '/vendor/autoload.php';

use Josantonius\Cookie\Cookie;

Si la instalaste manualmente, utiliza:

require_once __DIR__ . '/Cookie.php';

use Josantonius\Cookie\Cookie;

Uso

Ejemplo de uso para esta biblioteca:

- Agregar cookie:

Cookie::set('cookie_name', 'value', 365);

- Obtener valor de cookie:

Cookie::get('cookie_name');

- Obtener todas las cookies:

Cookie::get();

- Extraer y eliminar cookie:

Cookie::pull('cookie_name');

- Eliminar una cookie:

Cookie::destroy('cookie_name');

- Eliminar todas las cookies:

Cookie::destroy();

- Establecer prefijo para cookies:

Cookie::setPrefix('prefix_');

- Obtener prefijo de cookies:

Cookie::getPrefix();

Tests

Para ejecutar las pruebas necesitarás Composer y seguir los siguientes pasos:

$ git clone https://github.com/Josantonius/PHP-Cookie.git

$ cd PHP-Cookie

$ composer install

Ejecutar pruebas unitarias con PHPUnit:

$ composer phpunit

Ejecutar pruebas de estándares de código PSR2 con PHPCS:

$ composer phpcs

Ejecutar pruebas con PHP Mess Detector para detectar inconsistencias en el estilo de codificación:

$ composer phpmd

Ejecutar todas las pruebas anteriores:

$ composer tests

? Tareas pendientes

  • [ ] Añadir nueva funcionalidad.
  • [ ] Mejorar pruebas.
  • [ ] Mejorar documentación.
  • [ ] Refactorizar código para las reglas de estilo de código deshabilitadas. Ver phpmd.xml y .php_cs.dist.

Contribuir

Si deseas colaborar, puedes echar un vistazo a la lista de issues o tareas pendientes.

Pull requests

  • Fork and clone.
  • Ejecuta el comando `composer install` para instalar dependencias. Esto también instalará las dependencias de desarrollo.
  • Ejecuta el comando `composer fix` para estandarizar el código.
  • Ejecuta las pruebas.
  • Crea una nueva rama (branch), commit, push y envíame un pull request.

Repositorio

La estructura de archivos de este repositorio se creó con PHP-Skeleton.

Licencia

Este proyecto está licenciado bajo licencia MIT. Consulta el archivo LICENSE para más información.

Copyright

2016 - 2018 Josantonius, josantonius.com

Si te ha resultado útil, házmelo saber :wink:

Puedes contactarme en Twitter o a través de mi correo electrónico.