11# PHP Cookie library
22
3- [ ![ Latest Stable Version] ( https://poser.pugx.org/josantonius/cookie/v/stable )] ( https://packagist.org/packages/josantonius/cookie ) [ ![ Total Downloads] ( https://poser.pugx.org/josantonius/cookie/downloads )] ( https://packagist.org/packages/josantonius/cookie ) [ ![ Latest Unstable Version] ( https://poser.pugx.org/josantonius/cookie/v/unstable )] ( https://packagist.org/packages/josantonius/cookie ) [ ![ License] ( https://poser.pugx.org/josantonius/cookie/license )] ( https://packagist.org/packages/josantonius/cookie ) [ ![ Travis] ( https://travis-ci.org/Josantonius/PHP-Cookie.svg )] ( https://travis-ci.org/Josantonius/PHP-Cookie )
3+ [](https://packagist.org/packages/josantonius/Cookie) [](https://packagist.org/packages/josantonius/Cookie) [](LICENSE) [](https://www.codacy.com/app/Josantonius/PHP-Cookie?utm_source=github.com&utm_medium=referral&utm_content=Josantonius/PHP-Cookie&utm_campaign=Badge_Grade) [](https://packagist.org/packages/josantonius/Cookie) [](https://travis-ci.org/Josantonius/PHP-Cookie) [](http://www.php-fig.org/psr/psr-2/) [](http://www.php-fig.org/psr/psr-4/) [](https://codecov.io/gh/Josantonius/PHP-Cookie)
44
55[ English version] ( README.md )
66
77Biblioteca PHP para el manejo de cookies.
88
99---
1010
11- - [ Instalación] ( #instalación )
1211- [ Requisitos] ( #requisitos )
13- - [ Cómo empezar y ejemplos ] ( #cómo-empezar-y-ejemplos )
12+ - [ Instalación ] ( #instalación )
1413- [ Métodos disponibles] ( #métodos-disponibles )
14+ - [ Cómo empezar] ( #cómo-empezar )
1515- [ Uso] ( #uso )
1616- [ Tests] ( #tests )
1717- [ Tareas pendientes] ( #-tareas-pendientes )
@@ -22,83 +22,170 @@ Biblioteca PHP para el manejo de cookies.
2222
2323---
2424
25+ ### Requisitos
26+
27+ Esta clase es soportada por versiones de ` PHP 5.6 ` o superiores y es compatible con versiones de ` HHVM 3.0 ` o superiores.
28+
2529### Instalación
2630
27- La mejor forma de instalar esta extensión es a través de [ composer ] ( http://getcomposer.org/download/ ) .
31+ La mejor forma de instalar esta extensión es a través de [ Composer ] ( http://getcomposer.org/download/ ) .
2832
29- Para instalar PHP Cookie library, simplemente escribe:
33+ Para instalar ` PHP Cookie library ` , simplemente escribe:
3034
3135 $ composer require Josantonius/Cookie
3236
33- El comando anterior sólo instalará los archivos necesarios, si prefieres descargar todo el código fuente (incluyendo tests, directorio vendor, excepciones no utilizadas, documentos...) puedes utilizar:
37+ El comando anterior sólo instalará los archivos necesarios, si prefieres ** descargar todo el código fuente** puedes utilizar:
3438
3539 $ composer require Josantonius/Cookie --prefer-source
3640
37- También puedes clonar el repositorio completo con Git:
41+ También puedes ** clonar el repositorio** completo con Git:
3842
39- $ git clone https://github.com/Josantonius/Cookie.git
40-
41- ### Requisitos
43+ $ git clone https://github.com/Josantonius/PHP-Cookie.git
44+
45+ O ** instalarlo manualmente** :
46+
47+ [ Descargar Cookie.php] ( https://raw.githubusercontent.com/Josantonius/PHP-Cookie/master/src/Cookie.php ) :
48+
49+ $ wget https://raw.githubusercontent.com/Josantonius/PHP-Cookie/master/src/Cookie.php
50+
51+ ### Métodos disponibles
52+
53+ Métodos disponibles en esta biblioteca:
54+
55+ ` Crear cookie: `
56+
57+ ``` php
58+ Cookie::set($key, $value, $time);
59+ ```
4260
43- Esta biblioteca es soportada por versiones de PHP 5.6 o superiores y es compatible con versiones de HHVM 3.0 o superiores.
61+ | Atributo | Descripción | Tipo | Requerido | Predeterminado
62+ | --- | --- | --- | --- | --- |
63+ | $key | Nombre de la cookie. | string | Sí | |
64+ | $value | Valores a guardar. | string | Sí | |
65+ | $time | Tiempo de expiración en días. | string | No | 365 |
4466
45- ### Cómo empezar y ejemplos
67+ ** # Return ** (boolean)
4668
47- Para utilizar esta biblioteca, simplemente:
69+ ` Obtener valor de cookie: `
70+
71+ ``` php
72+ Cookie::get($key);
73+ ```
74+
75+ | Atributo | Descripción | Tipo | Requerido | Predeterminado
76+ | --- | --- | --- | --- | --- |
77+ | $key | Nombre de la cookie. | string | No | '' |
78+
79+ ** # Return** (mixed|false) → devuelve el valor de la cookie, todas las cookies o falso
80+
81+ ` Extraer valor de cookie eliminarla: `
82+
83+ ``` php
84+ Cookie::pull($key);
85+ ```
86+
87+ | Atributo | Descripción | Tipo | Requerido | Predeterminado
88+ | --- | --- | --- | --- | --- |
89+ | $key | Nombre de la cookie. | string | Sí | |
90+
91+ ** # Return** (string|false) → valor de la cookie o falso si no existe
92+
93+ ` Eliminar cookie: `
94+
95+ ``` php
96+ Cookie::destroy($key);
97+ ```
98+
99+ | Atributo | Descripción | Tipo | Requerido | Predeterminado
100+ | --- | --- | --- | --- | --- |
101+ | $key | Nombre de la cookie a eliminar. Si no se indica ninguna se eliminarán todas las cookies. | string | No | '' |
102+
103+ ** # Return** (boolean)
104+
105+ ### Cómo empezar
106+
107+ Para utilizar esta clase con ` Composer ` :
48108
49109``` php
50110require __DIR__ . '/vendor/autoload.php';
51111
52112use Josantonius\Cookie\Cookie;
53113```
54- ### Métodos disponibles
55114
56- Métodos disponibles en esta biblioteca :
115+ Si la instalaste ` manualmente ` , utiliza :
57116
58117``` php
59- Cookie::set();
60- Cookie::pull();
61- Cookie::get();
62- Cookie::display();
63- Cookie::destroy();
118+ require_once __DIR__ . '/Cookie.php';
119+
120+ use Josantonius\Cookie\Cookie;
64121```
122+
65123### Uso
66124
67125Ejemplo de uso para esta biblioteca:
68126
127+ ** Agregar cookie:**
128+
69129``` php
70- <?php
71- require __DIR__ . '/vendor/autoload.php';
130+ Cookie::set('cookie_name', 'value', 365);
131+ ```
72132
73- use Josantonius\Cookie\Cookie;
133+ ** Obtener valor de cookie: **
74134
75- /* Crear cookie */
135+ ``` php
136+ Cookie::get('cookie_name');
137+ ```
76138
77- Cookie::set('CookieName', 'value', 365);
139+ ** Obtener todas las cookies: **
78140
79- /* Obtener cookie */
141+ ``` php
142+ Cookie::get();
143+ ```
144+
145+ ** Extraer y eliminar cookie:**
146+
147+ ``` php
148+ Cookie::pull('cookie_name');
149+ ```
150+
151+ ** Eliminar una cookie:**
80152
81- Cookie::get('CookieName');
153+ ``` php
154+ Cookie::destroy('cookie_name');
155+ ```
82156
83- /* Destruir cookie */
157+ ** Eliminar todas las cookies: **
84158
85- Cookie::destroy('CookieName');
159+ ``` php
160+ Cookie::destroy();
86161```
87162
88163### Tests
89164
90- Para ejecutar las [ pruebas] ( tests/cookie/Test ) simplemente :
165+ Para ejecutar las [ pruebas] ( tests ) necesitarás [ Composer ] ( http://getcomposer.org/download/ ) y seguir los siguientes pasos :
91166
92167 $ git clone https://github.com/Josantonius/PHP-Cookie.git
93168
94169 $ cd PHP-Cookie
95170
96- $ phpunit
171+ $ composer install
172+
173+ Ejecutar pruebas unitarias con [ PHPUnit] ( https://phpunit.de/ ) :
174+
175+ $ composer phpunit
176+
177+ Ejecutar pruebas de estándares de código [ PSR2] ( http://www.php-fig.org/psr/psr-2/ ) con [ PHPCS] ( https://github.com/squizlabs/PHP_CodeSniffer ) :
178+
179+ $ composer phpcs
180+
181+ Ejecutar todas las pruebas anteriores:
182+
183+ $ composer tests
97184
98185### ☑ Tareas pendientes
99186
100187- [x] Completar tests
101- - [ ] Mejorar la documentación
188+ - [x ] Mejorar la documentación
102189
103190### Contribuir
104191
0 commit comments