Skip to content

Commit caf65e0

Browse files
committed
Updated to 1.1.4 version
1 parent 2da52d7 commit caf65e0

File tree

1,367 files changed

+1022
-119120
lines changed

Some content is hidden

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

1,367 files changed

+1022
-119120
lines changed

.gitattributes

+1-2
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

+1-1
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

+21-3
Original file line numberDiff line numberDiff line change
@@ -4,24 +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:
2029
- php: nightly
2130

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

2636
script:
27-
- 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

+30
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,35 @@
11
# CHANGELOG
22

3+
## 1.1.4 - 2017-10-30
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 `HTTPStatusCode/phpcs.ruleset.xml` file.
16+
17+
* Deleted `HTTPStatusCode/src/bootstrap.php` file.
18+
19+
* Deleted `HTTPStatusCode/tests/bootstrap.php` file.
20+
21+
* Deleted `HTTPStatusCode/tests/resources/http-status-code.jsond` file.
22+
23+
* Deleted `HTTPStatusCode/vendor` folder.
24+
25+
* Changed `Josantonius\HTTPStatusCode\Test\HTTPStatusCodeTest` class to `Josantonius\HTTPStatusCode\HTTPStatusCodeTest` class.
26+
27+
* Added `Josantonius\HTTPStatusCode\HTTPStatusCodeCollection` class.
28+
* Added `Josantonius\HTTPStatusCode\HTTPStatusCodeCollection::all()` method.
29+
* Added `Josantonius\HTTPStatusCode\HTTPStatusCodeCollection::get()` method.
30+
31+
* Deleted `Josantonius\HTTPStatusCode\HTTPStatusCode::load()` method.
32+
333
## 1.1.3 - 2017-09-13
434

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

README-ES.md

+117-74
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
# PHP HTTPStatusCode library
22

3-
[![Latest Stable Version](https://poser.pugx.org/josantonius/httpstatuscode/v/stable)](https://packagist.org/packages/josantonius/httpstatuscode) [![Total Downloads](https://poser.pugx.org/josantonius/httpstatuscode/downloads)](https://packagist.org/packages/josantonius/httpstatuscode) [![Latest Unstable Version](https://poser.pugx.org/josantonius/httpstatuscode/v/unstable)](https://packagist.org/packages/josantonius/httpstatuscode) [![License](https://poser.pugx.org/josantonius/httpstatuscode/license)](https://packagist.org/packages/josantonius/httpstatuscode) [![Travis](https://travis-ci.org/Josantonius/PHP-HTTPStatusCode.svg)](https://travis-ci.org/Josantonius/PHP-HTTPStatusCode)
3+
[![Latest Stable Version](https://poser.pugx.org/josantonius/HTTPStatusCode/v/stable)](https://packagist.org/packages/josantonius/HTTPStatusCode) [![Latest Unstable Version](https://poser.pugx.org/josantonius/HTTPStatusCode/v/unstable)](https://packagist.org/packages/josantonius/HTTPStatusCode) [![License](https://poser.pugx.org/josantonius/HTTPStatusCode/license)](LICENSE) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/166477cc273f4896a832580b77b2d8d7)](https://www.codacy.com/app/Josantonius/PHP-HTTPStatusCode?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=Josantonius/PHP-HTTPStatusCode&amp;utm_campaign=Badge_Grade)[![Total Downloads](https://poser.pugx.org/josantonius/HTTPStatusCode/downloads)](https://packagist.org/packages/josantonius/HTTPStatusCode) [![Travis](https://travis-ci.org/Josantonius/PHP-HTTPStatusCode.svg)](https://travis-ci.org/Josantonius/PHP-HTTPStatusCode) [![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-HTTPStatusCode/branch/master/graph/badge.svg)](https://codecov.io/gh/Josantonius/PHP-HTTPStatusCode)
44

55
[English version](README.md)
66

77
Biblioteca PHP para obtener significado de códigos de estado de respuesta HTTP.
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)
16+
- [Listado en formato JSON](#listado-en-formato-json)
1617
- [Tests](#tests)
1718
- [Tareas pendientes](#-tareas-pendientes)
1819
- [Contribuir](#contribuir)
@@ -22,127 +23,169 @@ Biblioteca PHP para obtener significado de códigos de estado de respuesta HTTP.
2223

2324
---
2425

25-
### Instalación
26+
## Requisitos
27+
28+
Esta clase es soportada por versiones de **PHP 5.6** o superiores y es compatible con versiones de **HHVM 3.0** o superiores.
29+
30+
## Instalación
2631

27-
La mejor forma de instalar esta extensión es a través de [composer](http://getcomposer.org/download/).
32+
La mejor forma de instalar esta extensión es a través de [Composer](http://getcomposer.org/download/).
2833

29-
Para instalar PHP HTTPStatusCode library, simplemente escribe:
34+
Para instalar **PHP HTTPStatusCode library**, simplemente escribe:
3035

3136
$ composer require Josantonius/HTTPStatusCode
3237

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:
38+
El comando anterior sólo instalará los archivos necesarios, si prefieres **descargar todo el código fuente** puedes utilizar:
3439

3540
$ composer require Josantonius/HTTPStatusCode --prefer-source
3641

37-
También puedes clonar el repositorio completo con Git:
42+
También puedes **clonar el repositorio** completo con Git:
3843

39-
$ git clone https://github.com/Josantonius/PHP-HTTPStatusCode.git
44+
$ git clone https://github.com/Josantonius/PHP-HTTPStatusCode.git
45+
46+
O **instalarlo manualmente**:
47+
48+
[Descargar HTTPStatusCode.php](https://raw.githubusercontent.com/Josantonius/PHP-HTTPStatusCode/master/src/HTTPStatusCode.php):
49+
50+
$ wget https://raw.githubusercontent.com/Josantonius/PHP-HTTPStatusCode/master/src/HTTPStatusCode.php
51+
52+
[Descargar HTTPStatusCodeCollection.php](https://raw.githubusercontent.com/Josantonius/PHP-HTTPStatusCode/master/src/HTTPStatusCodeCollection.php):
53+
54+
$ wget https://raw.githubusercontent.com/Josantonius/PHP-HTTPStatusCodeCollection/master/src/HTTPStatusCodeCollection.php
55+
56+
## Métodos disponibles
57+
58+
Métodos disponibles en esta biblioteca:
59+
60+
## - Obtener significado de un código de respuesta HTTP:
4061

41-
### Requisitos
62+
```php
63+
HTTPStatusCode::get($code, $lang, $size);
64+
```
65+
66+
| Atributo | Descripción | Tipo | Requerido | Predeterminado
67+
| --- | --- | --- | --- | --- |
68+
| $code| Código de respuesta HTTP. | mixed || |
69+
| $lang| Idioma para la definición: 'es' or 'en' | string | No | 'en' |
70+
| $size| Tamaño de la definición: 'short' or 'large' | string | No | 'short' |
71+
72+
**# Return** (string|false) → definición del código de estado HTTP o falso si no existe
73+
74+
## - Obtener todas las definiciones de códigos de estado en un array:
75+
76+
```php
77+
HTTPStatusCode::getAll($lang);
78+
```
79+
80+
| Atributo | Descripción | Tipo | Requerido | Predeterminado
81+
| --- | --- | --- | --- | --- |
82+
| $lang| Idioma para la definición: 'es' or 'en' | string | No | 'en' |
4283

43-
Esta biblioteca es soportada por versiones de PHP 5.6 o superiores y es compatible con versiones de HHVM 3.0 o superiores.
84+
**# Return** (array|false) → todas las definiciones de códigos de respuesta HTTP
4485

45-
### Cómo empezar y ejemplos
86+
## Cómo empezar
4687

47-
Para utilizar esta biblioteca, simplemente:
88+
Para utilizar esta biblioteca con **Composer**:
4889

4990
```php
5091
require __DIR__ . '/vendor/autoload.php';
5192

5293
use Josantonius\HTTPStatusCode\HTTPStatusCode;
5394
```
54-
### Métodos disponibles
5595

56-
Métodos disponibles en esta biblioteca:
96+
Si la instalaste **manualmente**, utiliza:
5797

5898
```php
59-
HTTPStatusCode::load();
60-
HTTPStatusCode::get();
61-
HTTPStatusCode::getAll();
99+
require_once __DIR__ . '/HTTPStatusCode.php';
100+
require_once __DIR__ . '/HTTPStatusCodeCollection.php';
101+
102+
use Josantonius\HTTPStatusCode\HTTPStatusCode;
62103
```
63-
### Uso
104+
105+
## Uso
64106

65107
Ejemplo de uso para esta biblioteca:
66108

67-
```php
68-
<?php
69-
require __DIR__ . '/vendor/autoload.php';
109+
### - Obtener el significado corto en inglés de un código de respuesta HTTP:
70110

71-
use Josantonius\HTTPStatusCode\HTTPStatusCode;
111+
```php
112+
HTTPStatusCode::get(200);
113+
```
72114

73-
### Obtener significado corto
115+
### - Obtener el significado corto en español de un código de respuesta HTTP:
74116

75-
echo "<br>[200] · " . HTTPStatusCode::get(100);
76-
echo "<br>[200] · " . HTTPStatusCode::get(100, 'es');
117+
```php
118+
HTTPStatusCode::get(200, 'es');
119+
```
77120

78-
/*
79-
[100] · Continue
80-
[100] · Continuar
81-
*/
121+
### - Obtener el significado detallado en inglés de un código de respuesta HTTP:
82122

83-
### Obtener significado detallado
123+
```php
124+
HTTPStatusCode::get(200, 'en', 'large');
125+
```
84126

85-
echo "<br>[100] · " . HTTPStatusCode::get(100, 'es', 'large');
86-
echo "<br>[100] · " . HTTPStatusCode::get(100, 'en', 'large');
127+
### - Obtener el significado detallado en español de un código de respuesta HTTP:
87128

88-
/*
89-
[100] · El navegador puede continuar realizando su petición (se utiliza para indicar que la primera parte de la petición del navegador se ha recibido correctamente).
90-
[100] · The server has received the request headers and the client should proceed to send the request body (in the case of a request for which a body needs to be sent; for example, a POST request). Sending a large request body to a server after a request has been rejected for inappropriate headers would be inefficient. To have a server check the request's headers, a client must send Expect: 100-continue as a header in its initial request and receive a 100 Continue status code in response before sending the body. The response 417 Expectation Failed indicates the request should not be continued.
91-
*/
129+
```php
130+
HTTPStatusCode::get(200, 'es', 'large');
131+
```
92132

93-
### Obtener un array con todos los significados y códigos de estado HTTP en inglés
133+
### - Obtener el significado corto en inglés de un código de respuesta HTTP:
94134

95-
$HTTPStatusCodes = HTTPStatusCode::getAll();
135+
```php
136+
HTTPStatusCode::get(200, 'en', 'short');
137+
```
96138

97-
echo '<pre>'; var_dump($HTTPStatusCodes); echo '</pre>';
139+
### - Obtener el significado corto en español de un código de respuesta HTTP:
98140

99-
/*
100-
array(67) {
101-
["1xx"]=>
102-
array(2) {
103-
["short"]=>
104-
string(13) "Informational"
105-
["large"]=>
106-
string(339) "Request received, continuing process. This class of status code indicates a provisional response, consisting only of the Status-Line and optional headers, and is terminated by an empty line. Since HTTP/1.0 did not define any 1xx status codes, servers must not send a 1xx response to an HTTP/1.0 client except under experimental conditions."
107-
}
108-
(...)
109-
*/
141+
```php
142+
HTTPStatusCode::get(200, 'es', 'short');
143+
```
110144

111-
### Obtener un array con todos los significados y códigos de estado HTTP en español
145+
### - Obtener un array de códigos de respuesta HTTP en inglés:
112146

113-
$HTTPStatusCodes = HTTPStatusCode::getAll('es');
147+
```php
148+
HTTPStatusCode::getAll();
149+
```
114150

115-
echo '<pre>'; var_dump($HTTPStatusCodes); echo '</pre>';
151+
### - Obtener un array de códigos de respuesta HTTP en español:
116152

117-
/*
118-
array(67) {
119-
["1xx"]=>
120-
array(2) {
121-
["short"]=>
122-
string(23) "Respuestas informativas"
123-
["large"]=>
124-
string(875) "Petición recibida, continuando proceso. Esta respuesta significa que el servidor ha recibido los encabezados de la petición, y que el cliente debería proceder a enviar el cuerpo de la misma (en el caso de peticiones para las cuales el cuerpo necesita ser enviado; por ejemplo, una petición Hypertext Transfer Protocol). Si el cuerpo de la petición es largo, es ineficiente enviarlo a un servidor, cuando la petición ha sido ya rechazada, debido a encabezados inapropiados. Para hacer que un servidor cheque si la petición podría ser aceptada basada únicamente en los encabezados de la petición, el cliente debe enviar Expect: 100-continue como un encabezado en su petición inicial (vea Plantilla:Web-RFC: Expect header) y verificar si un código de estado 100 Continue es recibido en respuesta, antes de continuar (o recibir 417 Expectation Failed y no continuar)."
125-
}
126-
(...)
127-
*/
153+
```php
154+
HTTPStatusCode::getAll('es');
128155
```
129156

130-
### Tests
157+
## List in Json format
158+
159+
[Go to the resource](https://gist.github.com/Josantonius/0a889ab6f18db2fcefda15a039613293).
160+
161+
## Tests
131162

132-
Para ejecutar las [pruebas](tests/HTTPStatusCode/test) simplemente:
163+
Para ejecutar las [pruebas](tests) necesitarás [Composer](http://getcomposer.org/download/) y seguir los siguientes pasos:
133164

134165
$ git clone https://github.com/Josantonius/PHP-HTTPStatusCode.git
135166

136167
$ cd PHP-HTTPStatusCode
137168

138-
$ phpunit
169+
$ composer install
170+
171+
Ejecutar pruebas unitarias con [PHPUnit](https://phpunit.de/):
172+
173+
$ composer phpunit
174+
175+
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):
176+
177+
$ composer phpcs
178+
179+
Ejecutar todas las pruebas anteriores:
180+
181+
$ composer tests
139182

140-
### ☑ Tareas pendientes
183+
## ☑ Tareas pendientes
141184

142185
- [x] Completar tests
143-
- [ ] Mejorar la documentación
186+
- [x] Mejorar la documentación
144187

145-
### Contribuir
188+
## Contribuir
146189

147190
1. Comprobar si hay incidencias abiertas o abrir una nueva para iniciar una discusión en torno a un fallo o función.
148191
1. Bifurca la rama del repositorio en GitHub para iniciar la operación de ajuste.
@@ -152,15 +195,15 @@ Para ejecutar las [pruebas](tests/HTTPStatusCode/test) simplemente:
152195

153196
Esto está pensado para proyectos grandes y de larga duración.
154197

155-
### Repositorio
198+
## Repositorio
156199

157200
Los archivos de este repositorio se crearon y subieron automáticamente con [Reposgit Creator](https://github.com/Josantonius/BASH-Reposgit).
158201

159-
### Licencia
202+
## Licencia
160203

161204
Este proyecto está licenciado bajo **licencia MIT**. Consulta el archivo [LICENSE](LICENSE) para más información.
162205

163-
### Copyright
206+
## Copyright
164207

165208
2016 -2017 Josantonius, [josantonius.com](https://josantonius.com/)
166209

0 commit comments

Comments
 (0)