11# PHP LanguageCode library
22
3- [ ![ Latest Stable Version] ( https://poser.pugx.org/josantonius/languagecode/v/stable )] ( https://packagist.org/packages/josantonius/languagecode ) [ ![ Total Downloads] ( https://poser.pugx.org/josantonius/languagecode/downloads )] ( https://packagist.org/packages/josantonius/languagecode ) [ ![ Latest Unstable Version] ( https://poser.pugx.org/josantonius/languagecode/v/unstable )] ( https://packagist.org/packages/josantonius/languagecode ) [ ![ License] ( https://poser.pugx.org/josantonius/languagecode/license )] ( https://packagist.org/packages/josantonius/languagecode ) [ ![ Travis] ( https://travis-ci.org/Josantonius/PHP-LanguageCode.svg )] ( https://travis-ci.org/Josantonius/PHP-LanguageCode )
3+ [](https://packagist.org/packages/josantonius/LanguageCode) [](https://packagist.org/packages/josantonius/LanguageCode) [](LICENSE) [](https://www.codacy.com/app/Josantonius/PHP-LanguageCode?utm_source=github.com&utm_medium=referral&utm_content=Josantonius/PHP-LanguageCode&utm_campaign=Badge_Grade) [](https://packagist.org/packages/josantonius/LanguageCode) [](https://travis-ci.org/Josantonius/PHP-LanguageCode) [](http://www.php-fig.org/psr/psr-2/) [](http://www.php-fig.org/psr/psr-4/) [](https://codecov.io/gh/Josantonius/PHP-LanguageCode)
44
5- [ Spanish version] ( README-ES .md )
5+ [ English version] ( README.md )
66
77Lista de 217 códigos de idioma: ISO 639-1.
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,71 +23,96 @@ Lista de 217 códigos de idioma: ISO 639-1.
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.
2629
27- La mejor forma de instalar esta extensión es a través de [ composer ] ( http://getcomposer.org/download/ ) .
30+ ## Instalación
2831
29- Para instalar PHP LanguageCode 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 LanguageCode library** , simplemente escribe:
3035
3136 $ composer require Josantonius/LanguageCode
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/LanguageCode --prefer-source
3641
37- También puedes clonar el repositorio completo con Git:
42+ También puedes ** clonar el repositorio** completo con Git:
3843
3944 $ git clone https://github.com/Josantonius/PHP-LanguageCode.git
4045
41- ### Requisitos
46+ O ** instalarlo manualmente** :
47+
48+ Descargar [ LanguageCode.php] ( https://raw.githubusercontent.com/Josantonius/PHP-LanguageCode/master/src/LanguageCode.php ) y [ anguageCodeCollection.php] ( https://raw.githubusercontent.com/Josantonius/PHP-LanguageCode/master/src/LanguageCodeCollection.php ) :
4249
43- 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-LanguageCode/master/src/LanguageCode.php
51+ $ wget https://raw.githubusercontent.com/Josantonius/PHP-LanguageCode/master/src/LanguageCodeCollection.php
4452
45- ### Cómo empezar y ejemplos
53+ ## Métodos disponibles
4654
47- Para utilizar esta biblioteca, simplemente:
55+ Métodos disponibles en esta biblioteca:
56+
57+ ### - Obtener array con todos los códigos de idioma:
4858
4959``` php
50- require __DIR__ . '/vendor/autoload.php';
60+ LanguageCode::get();
61+ ```
5162
52- use Josantonius\LanguageCode\LanguageCode;
63+ ** # Return** (array) → códigos y nombres de idiomas
64+
65+ ### - Obtener el nombre del idioma desde código de idioma:
66+
67+ ``` php
68+ LanguageCode::getLanguageFromCode($languageCode);
5369```
54- ### Métodos disponibles
5570
56- Métodos disponibles en esta biblioteca:
71+ | Atributo | Descripción | Tipo | Requerido | Predeterminado
72+ | --- | --- | --- | --- | --- |
73+ | $languageCode | Código de idioma, e.g. 'es'. | string | Sí | |
74+
75+ ** # Return** (tring|false) → nombre del país
76+
77+ ### - Obtener código de idioma desde el nombre del idioma:
5778
5879``` php
59- LanguageCode::getLanguageFromCode();
60- LanguageCode::getCodeFromLanguage();
61- LanguageCode::getAll();
80+ LanguageCode::getCodeFromLanguage($languageName);
6281```
63- ### Uso
6482
65- Ejemplo de uso para esta biblioteca:
83+ | Atributo | Descripción | Tipo | Requerido | Predeterminado
84+ | --- | --- | --- | --- | --- |
85+ | $languageName | Nombre de idioma, e.g. 'Spanish'. | string | Sí | |
86+
87+ ** # Return** (tring|false) → código de idioma
88+
89+ ## Cómo empezar
90+
91+ Para utilizar esta biblioteca con ** Composer** :
6692
6793``` php
68- <?php
6994require __DIR__ . '/vendor/autoload.php';
7095
7196use Josantonius\LanguageCode\LanguageCode;
97+ ```
7298
73- LanguageCode::getLanguageFromCode('es');
74-
75- /* string(7) "Spanish" */
76-
77- LanguageCode::getLanguageFromCode('abcd');
99+ Si la instalaste ** manualmente** , utiliza:
78100
79- /* string(9) "undefined" */
101+ ``` php
102+ require_once __DIR__ . '/LanguageCode.php';
103+ require_once __DIR__ . '/LanguageCodeCollection.php';
80104
81- LanguageCode::getCodeFromLanguage('spanish');
105+ use Josantonius\LanguageCode\LanguageCode;
106+ ```
82107
83- /* string(2) "es" */
108+ ## Uso
84109
85- LanguageCode::getCodeFromLanguage('abcd');
110+ Ejemplo de uso para esta biblioteca:
86111
87- /* string(9) "undefined" */
112+ ### - Obtener array con todos los códigos de idioma:
88113
89- LanguageCode::getAll();
114+ ``` php
115+ LanguageCode::get();
90116
91117/*
92118array(217) {
@@ -104,22 +130,50 @@ array(217) {
104130*/
105131```
106132
107- ### Tests
133+ ### - Obtener el nombre del idioma desde código de idioma:
134+
135+ ``` php
136+ LanguageCode::getLanguageFromCode('es'); // string(7) "Spanish"
137+ ```
138+
139+ ### - Obtener código de idioma desde el nombre del idioma:
140+
141+ ``` php
142+ LanguageCode::getCodeFromLanguage('spanish'); // string(2) "es"
143+ ```
144+
145+ ## List in Json format
108146
109- Para ejecutar las [ pruebas] ( tests/LanguageCode/test ) simplemente:
147+ [ Go to the resource] ( https://gist.github.com/Josantonius/b455e315bc7f790d14b136d61d9ae469 ) .
148+
149+ ## Tests
150+
151+ Para ejecutar las [ pruebas] ( tests ) necesitarás [ Composer] ( http://getcomposer.org/download/ ) y seguir los siguientes pasos:
110152
111153 $ git clone https://github.com/Josantonius/PHP-LanguageCode.git
112154
113155 $ cd PHP-LanguageCode
114156
115- $ phpunit
157+ $ composer install
158+
159+ Ejecutar pruebas unitarias con [ PHPUnit] ( https://phpunit.de/ ) :
160+
161+ $ composer phpunit
162+
163+ 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 ) :
164+
165+ $ composer phpcs
166+
167+ Ejecutar todas las pruebas anteriores:
168+
169+ $ composer tests
116170
117- ### ☑ Tareas pendientes
171+ ## ☑ Tareas pendientes
118172
119173- [x] Completar tests
120- - [ ] Mejorar la documentación
174+ - [x ] Mejorar la documentación
121175
122- ### Contribuir
176+ ## Contribuir
123177
1241781 . Comprobar si hay incidencias abiertas o abrir una nueva para iniciar una discusión en torno a un fallo o función.
1251791 . Bifurca la rama del repositorio en GitHub para iniciar la operación de ajuste.
@@ -129,17 +183,17 @@ Para ejecutar las [pruebas](tests/LanguageCode/test) simplemente:
129183
130184Esto está pensado para proyectos grandes y de larga duración.
131185
132- ### Repositorio
186+ ## Repositorio
133187
134188Los archivos de este repositorio se crearon y subieron automáticamente con [ Reposgit Creator] ( https://github.com/Josantonius/BASH-Reposgit ) .
135189
136- ### Licencia
190+ ## Licencia
137191
138192Este proyecto está licenciado bajo ** licencia MIT** . Consulta el archivo [ LICENSE] ( LICENSE ) para más información.
139193
140- ### Copyright
194+ ## Copyright
141195
142- 2017 Josantonius, [ josantonius.com] ( https://josantonius.com/ )
196+ 2016 - 2017 Josantonius, [ josantonius.com] ( https://josantonius.com/ )
143197
144198Si te ha resultado útil, házmelo saber :wink :
145199
0 commit comments