Skip to content

Commit 2a05c67

Browse files
committed
Updated to 1.1.4 version
1 parent ace8e0b commit 2a05c67

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+1100
-636
lines changed

.gitattributes

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
/tests export-ignore
2-
/src/bootstrap.php export-ignore
3-
/vendor export-ignore
42
.gitattributes export-ignore
53
.gitignore export-ignore
64
_config.yml export-ignore
@@ -10,6 +8,7 @@ phpunit.xml.dist export-ignore
108
CONDUCT.md export-ignore
119
contributors.txt export-ignore
1210
README.md export-ignore
11+
phpcs.ruleset.xml export-ignore
1312
README-ES.md export-ignore
1413
.editorconfig export-ignore
1514
composer.lock export-ignore

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ composer.phar
33
composer.lock
44
composer-test.lock
55
build/artifacts/
6-
artifacts/
6+
vendor/
77
docs/_build
88
docs/*.pyc
99
.git*/

.travis.yml

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,42 @@ sudo: false
44

55
dist: trusty
66

7+
branches:
8+
only:
9+
- master
10+
711
git:
812
depth: 5
913

1014
php:
1115
- 5.6
1216
- 7.0
1317
- 7.1
18+
- 7.2
1419
- hhvm
1520
- nightly
1621

1722
matrix:
1823
fast_finish: true
24+
include:
25+
- php: 7.1
26+
env: PHPCS=PSR2
27+
1928
allow_failures:
20-
- php: hhvm
2129
- php: nightly
2230

2331
before_script:
24-
- composer self-update
25-
- composer install
32+
- export PATH="./vendor/bin:$PATH"
33+
- travis_retry composer self-update
34+
- travis_retry composer install --no-interaction --prefer-source --dev
2635

2736
script:
28-
- composer test
37+
- phpunit
38+
- |
39+
if [[ "$PHPCS" ]] ; then
40+
phpcs --standard=phpcs.ruleset.xml $(find . -name '*.php')
41+
fi
42+
phpunit --coverage-clover=coverage.xml
43+
44+
after_success:
45+
- bash <(curl -s https://codecov.io/bash)

CHANGELOG.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,27 @@
11
# CHANGELOG
22

3+
## 1.1.4 - 2017-10-25
4+
5+
* Implemented `PSR-4 autoloader standard` from all library files.
6+
7+
* Implemented `PSR-2 coding standard` from all library PHP files.
8+
9+
* Implemented `PHPCS` to ensure that PHP code complies with `PSR2` code standards.
10+
11+
* Implemented `Codacy` to automates code reviews and monitors code quality over time.
12+
13+
* Implemented `Codecov` to coverage reports.
14+
15+
* Added `Cookie/phpcs.ruleset.xml` file.
16+
17+
* Deleted `Cookie/src/bootstrap.php` file.
18+
19+
* Deleted `Cookie/tests/bootstrap.php` file.
20+
21+
* Deleted `Cookie/vendor` folder.
22+
23+
* Changed `Josantonius\Cookie\Test\CookieTest` class to `Josantonius\Cookie\CookieTest` class .
24+
325
## 1.1.3 - 2017-09-11
426

527
* Unit tests supported by `PHPUnit` were added.

README-ES.md

Lines changed: 119 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
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+
[![Latest Stable Version](https://poser.pugx.org/josantonius/Cookie/v/stable)](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)](LICENSE) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/e51e4c06b0b54ce493454d4f895a3ef3)](https://www.codacy.com/app/Josantonius/PHP-Cookie?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=Josantonius/PHP-Cookie&amp;utm_campaign=Badge_Grade) [![Total Downloads](https://poser.pugx.org/josantonius/Cookie/downloads)](https://packagist.org/packages/josantonius/Cookie) [![Travis](https://travis-ci.org/Josantonius/PHP-Cookie.svg)](https://travis-ci.org/Josantonius/PHP-Cookie) [![PSR2](https://img.shields.io/badge/PSR-2-1abc9c.svg)](http://www.php-fig.org/psr/psr-2/) [![PSR4](https://img.shields.io/badge/PSR-4-9b59b6.svg)](http://www.php-fig.org/psr/psr-4/) [![CodeCov](https://codecov.io/gh/Josantonius/PHP-Cookie/branch/master/graph/badge.svg)](https://codecov.io/gh/Josantonius/PHP-Cookie)
44

55
[English version](README.md)
66

77
Biblioteca 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 || |
64+
| $value | Valores a guardar. | string || |
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 || |
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
50110
require __DIR__ . '/vendor/autoload.php';
51111

52112
use 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

67125
Ejemplo 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

Comments
 (0)