PHP HTTPStatusCode library

English version

Biblioteca PHP para obtener significado de códigos de estado de respuesta HTTP.

• Requisitos
• Instalación
• Métodos disponibles
• Cómo empezar
• Uso
• Listado en formato JSON
• Tests
• Tareas pendientes
• Contribuir
• Repositorio
• Licencia
• Copyright

Requisitos

Esta clase es soportada por versiones de PHP 5.6 o superiores y es compatible con versiones de HHVM 3.0 o superiores.

Instalación

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

Para instalar PHP HTTPStatusCode library, simplemente escribe:

$ composer require Josantonius/HTTPStatusCode

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

$ composer require Josantonius/HTTPStatusCode --prefer-source

También puedes clonar el repositorio completo con Git:

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

O instalarlo manualmente:

Descargar HTTPStatusCode.php:

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

Descargar HTTPStatusCodeCollection.php:

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

Métodos disponibles

Métodos disponibles en esta biblioteca:

- Obtener significado de un código de respuesta HTTP:

HTTPStatusCode::get($code, $lang, $size);

| Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $code| Código de respuesta HTTP. | mixed | Sí | | | $lang| Idioma para la definición: 'es' or 'en' | string | No | 'en' | | $size| Tamaño de la definición: 'short' or 'large' | string | No | 'short' |

# Return (string|false) ? definición del código de estado HTTP o falso si no existe

- Obtener todas las definiciones de códigos de estado en un array:

HTTPStatusCode::getAll($lang);

| Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $lang| Idioma para la definición: 'es' or 'en' | string | No | 'en' |

# Return (array|false) ? todas las definiciones de códigos de respuesta HTTP

Cómo empezar

Para utilizar esta biblioteca con Composer:

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

use Josantonius\HTTPStatusCode\HTTPStatusCode;

Si la instalaste manualmente, utiliza:

require_once __DIR__ . '/HTTPStatusCode.php';
require_once __DIR__ . '/HTTPStatusCodeCollection.php';

use Josantonius\HTTPStatusCode\HTTPStatusCode;

Uso

Ejemplo de uso para esta biblioteca:

- Obtener el significado corto en inglés de un código de respuesta HTTP:

HTTPStatusCode::get(200);

- Obtener el significado corto en español de un código de respuesta HTTP:

HTTPStatusCode::get(200, 'es');

- Obtener el significado detallado en inglés de un código de respuesta HTTP:

HTTPStatusCode::get(200, 'en', 'large');

- Obtener el significado detallado en español de un código de respuesta HTTP:

HTTPStatusCode::get(200, 'es', 'large');

- Obtener el significado corto en inglés de un código de respuesta HTTP:

HTTPStatusCode::get(200, 'en', 'short');

- Obtener el significado corto en español de un código de respuesta HTTP:

HTTPStatusCode::get(200, 'es', 'short');

- Obtener un array de códigos de respuesta HTTP en inglés:

HTTPStatusCode::getAll();

- Obtener un array de códigos de respuesta HTTP en español:

HTTPStatusCode::getAll('es');

List in Json format

Go to the resource.

Tests

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

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

$ cd PHP-HTTPStatusCode

$ 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.