PHP Json library

English version

Biblioteca PHP para la gestión de archivos JSON.

• Requisitos
• Instalación
• Métodos disponibles
• Cómo empezar
• Uso
• Tests
• Manejador de excepciones
• 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 Json library, simplemente escribe:

$ composer require Josantonius/Json

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

$ composer require Josantonius/Json --prefer-source

También puedes clonar el repositorio completo con Git:

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

O instalarlo manualmente:

Descargar Json.php, JsonLastError.php y JsonException.php:

$ wget https://raw.githubusercontent.com/Josantonius/PHP-Json/master/src/Json.php
$ wget https://raw.githubusercontent.com/Josantonius/PHP-Json/master/src/JsonLastError.php
$ wget https://raw.githubusercontent.com/Josantonius/PHP-Json/master/src/Exception/JsonException.php

Métodos disponibles

Métodos disponibles en esta biblioteca:

- Crear archivo JSON desde array:

Json::arrayToFile($array, $file);

| Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $array | Array a guardar en archivo JSON. | array | Sí | | | $file | Ruta hacia el archivo. | string | Sí | |

# Return (boolean)

- Guardar en array el contenido de archivo JSON:

Json::fileToArray($file);

| Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $file | Ruta o URL externa al archivo JSON. | string | Sí | |

# Return (array|false)

- Comprobar si hay errores:

JsonLastError::check();

# Return (array|null) ? Null si no hay errores o array con código de estado y mensaje de error.

- Obtener recopilación de posibles errores:

JsonLastError::getCollection();

# Return (array) ? Recopilación de posibles errores.

Cómo empezar

Para utilizar esta biblioteca con Composer:

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

use Josantonius\Json\Json;

Si la instalaste manualmente, utiliza:

require_once __DIR__ . '/Json.php';
require_once __DIR__ . '/JsonLastError.php';
require_once __DIR__ . '/JsonException.php';

use Josantonius\Json\Json;

Uso

Ejemplo de uso para esta biblioteca:

- Crear archivo JSON desde array:

$array = [
	'name'  => 'Josantonius',
    'email' => 'info@josantonius.com',
    'url'   => 'https://github.com/josantonius/PHP-Json'
];

$pathfile = __DIR__ . '/filename.json';

Json::arrayToFile($array, $pathfile);

- Guardar en array el contenido de archivo JSON:

$pathfile = __DIR__ . '/filename.json';

$array = Json::fileToArray($pathfile);

- Comprobar si hay errores:

$lastError = JsonLastError::check();

if (!is_null($lastError)) {
    var_dump($lastError);
}

- Obtener recopilación de posibles errores:

$jsonLastErrorCollection = JsonLastError::getCollection();

Tests

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

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

$ cd PHP-Json

$ 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

Manejador de excepciones

Esta biblioteca utiliza control de excepciones que puedes personalizar a tu gusto.

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

¡Gracias a quienes ya habéis contribuido a este proyecto!

<img alt="peter279k" src="https://avatars2.githubusercontent.com/u/9021747?v=4&s=117" height="117" width="117"> | :---:| peter279k|

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.