11# PHP Json library
22
3- [ ![ Latest Stable Version] ( https://poser.pugx.org/josantonius/json/v/stable )] ( https://packagist.org/packages/josantonius/json ) [ ![ Total Downloads] ( https://poser.pugx.org/josantonius/json/downloads )] ( https://packagist.org/packages/josantonius/json ) [ ![ Latest Unstable Version] ( https://poser.pugx.org/josantonius/json/v/unstable )] ( https://packagist.org/packages/josantonius/json ) [ ![ License] ( https://poser.pugx.org/josantonius/json/license )] ( https://packagist.org/packages/josantonius/json ) [ ![ Travis] ( https://travis-ci.org/Josantonius/PHP-Json.svg )] ( https://travis-ci.org/Josantonius/PHP-Json )
3+ [](https://packagist.org/packages/josantonius/Json) [](https://packagist.org/packages/josantonius/Json) [](LICENSE) [](https://www.codacy.com/app/Josantonius/PHP-Json?utm_source=github.com&utm_medium=referral&utm_content=Josantonius/PHP-Json&utm_campaign=Badge_Grade) [](https://packagist.org/packages/josantonius/Json) [](https://travis-ci.org/Josantonius/PHP-Json) [](http://www.php-fig.org/psr/psr-2/) [](http://www.php-fig.org/psr/psr-4/) [](https://codecov.io/gh/Josantonius/PHP-Json)
44
55[ English version] ( README.md )
66
77Biblioteca PHP para la gestión de archivos JSON.
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- [ Manejador de excepciones] ( #manejador-de-excepciones )
@@ -23,52 +23,86 @@ Biblioteca PHP para la gestión de archivos JSON.
2323
2424---
2525
26- ### 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.
2729
28- La mejor forma de instalar esta extensión es a través de [ composer ] ( http://getcomposer.org/download/ ) .
30+ ## Instalación
2931
30- Para instalar PHP Json library, simplemente escribe:
32+ La mejor forma de instalar esta extensión es a través de [ Composer] ( http://getcomposer.org/download/ ) .
33+
34+ Para instalar ** PHP Json library** , simplemente escribe:
3135
3236 $ composer require Josantonius/Json
3337
34- 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:
3539
3640 $ composer require Josantonius/Json --prefer-source
3741
38- También puedes clonar el repositorio completo con Git:
42+ También puedes ** clonar el repositorio** completo con Git:
43+
44+ $ git clone https://github.com/Josantonius/PHP-Json.git
3945
40- $ git clone https://github.com/Josantonius/PHP-Json.git
46+ O ** instalarlo manualmente ** :
4147
42- ### Requisitos
48+ [ Descargar Json.php ] ( https://raw.githubusercontent.com/Josantonius/PHP-Json/master/src/Json.php ) :
4349
44- Esta ĺibrería es soportada por versiones de PHP 5.6 o superiores y es compatible con versiones de HHVM 3.0 o superiores.
50+ $ wget https://raw.githubusercontent.com/Josantonius/PHP-Json/master/src/Json.php
4551
46- ### Cómo empezar y ejemplos
52+ ## Métodos disponibles
4753
48- Para utilizar esta biblioteca, simplemente:
54+ Métodos disponibles en esta biblioteca:
55+
56+ ### - Crear archivo JSON desde array:
57+
58+ ``` php
59+ Json::arrayToFile($array, $file);
60+ ```
61+
62+ | Atributo | Descripción | Tipo | Requerido | Predeterminado
63+ | --- | --- | --- | --- | --- |
64+ | $array | Array a guardar en archivo JSON. | array | Sí | |
65+ | $file | Ruta hacia el archivo. | string | Sí | |
66+
67+ ** # Return** (boolean)
68+
69+ ### - Guardar en array el contenido de archivo JSON:
70+
71+ ``` php
72+ Json::fileToArray($file);
73+ ```
74+
75+ | Atributo | Descripción | Tipo | Requerido | Predeterminado
76+ | --- | --- | --- | --- | --- |
77+ | $file | Ruta o URL externa al archivo JSON. | string | Sí | |
78+
79+ ** # Return** (array|false)
80+
81+ ## Cómo empezar
82+
83+ Para utilizar esta biblioteca con ** Composer** :
4984
5085``` php
5186require __DIR__ . '/vendor/autoload.php';
5287
5388use Josantonius\Json\Json;
5489```
55- ### Métodos disponibles
5690
57- Métodos disponibles en esta biblioteca :
91+ Si la instalaste ** manualmente ** , utiliza :
5892
5993``` php
60- Json::arrayToFile();
61- Json::fileToArray();
94+ require_once __DIR__ . '/Json.php';
95+
96+ use Josantonius\Json\Json;
6297```
63- ### Uso
98+
99+ ## Uso
64100
65101Ejemplo de uso para esta biblioteca:
66102
67- ``` php
68- <?php
69- require __DIR__ . '/vendor/autoload.php';
103+ ### - Crear archivo JSON desde array:
70104
71- use Josantonius\Json\Json;
105+ ``` php
72106
73107$array = [
74108 'name' => 'Josantonius',
@@ -78,31 +112,51 @@ $array = [
78112
79113$pathfile = __DIR__ . '/filename.json';
80114
81- var_dump(Json::arrayToFile($array, $pathfile)); //bool(true)
115+ Json::arrayToFile($array, $pathfile);
116+
117+ ```
118+
119+ ### - Guardar en array el contenido de archivo JSON:
120+
121+ ``` php
122+ $pathfile = __DIR__ . '/filename.json';
123+
124+ $array = Json::fileToArray($pathfile);
82125
83- /* Esto creará el archivo "filename.json" en el directorio "tests". */
84126```
85127
86- ### Tests
128+ ## Tests
87129
88- Para ejecutar las [ pruebas] ( tests/Json/Test ) simplemente :
130+ Para ejecutar las [ pruebas] ( tests ) necesitarás [ Composer ] ( http://getcomposer.org/download/ ) y seguir los siguientes pasos :
89131
90132 $ git clone https://github.com/Josantonius/PHP-Json.git
91133
92134 $ cd PHP-Json
93135
94- $ phpunit
136+ $ composer install
137+
138+ Ejecutar pruebas unitarias con [ PHPUnit] ( https://phpunit.de/ ) :
139+
140+ $ composer phpunit
141+
142+ 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 ) :
143+
144+ $ composer phpcs
145+
146+ Ejecutar todas las pruebas anteriores:
147+
148+ $ composer tests
95149
96- ### Manejador de excepciones
150+ ## Manejador de excepciones
97151
98152Esta biblioteca utiliza [ control de excepciones] ( src/Exception ) que puedes personalizar a tu gusto.
99153
100- ### ☑ Tareas pendientes
154+ ## ☑ Tareas pendientes
101155
102156- [x] Completar tests
103- - [ ] Mejorar la documentación
157+ - [x ] Mejorar la documentación
104158
105- ### Contribuir
159+ ## Contribuir
106160
1071611 . Comprobar si hay incidencias abiertas o abrir una nueva para iniciar una discusión en torno a un fallo o función.
1081621 . Bifurca la rama del repositorio en GitHub para iniciar la operación de ajuste.
@@ -112,15 +166,15 @@ Esta biblioteca utiliza [control de excepciones](src/Exception) que puedes perso
112166
113167Esto está pensado para proyectos grandes y de larga duración.
114168
115- ### Repositorio
169+ ## Repositorio
116170
117171Los archivos de este repositorio se crearon y subieron automáticamente con [ Reposgit Creator] ( https://github.com/Josantonius/BASH-Reposgit ) .
118172
119- ### Licencia
173+ ## Licencia
120174
121175Este proyecto está licenciado bajo ** licencia MIT** . Consulta el archivo [ LICENSE] ( LICENSE ) para más información.
122176
123- ### Copyright
177+ ## Copyright
124178
1251792016 -2017 Josantonius, [ josantonius.com] ( https://josantonius.com/ )
126180
0 commit comments