Skip to content

Commit

Permalink
Updated to 1.1.4 version
Browse files Browse the repository at this point in the history
  • Loading branch information
josantonius committed Nov 1, 2017
1 parent e2301ac commit cd62a6e
Show file tree
Hide file tree
Showing 1,367 changed files with 629 additions and 118,606 deletions.
3 changes: 1 addition & 2 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
/tests export-ignore
/src/bootstrap.php export-ignore
/vendor export-ignore
.gitattributes export-ignore
.gitignore export-ignore
_config.yml export-ignore
Expand All @@ -10,6 +8,7 @@ phpunit.xml.dist export-ignore
CONDUCT.md export-ignore
contributors.txt export-ignore
README.md export-ignore
phpcs.ruleset.xml export-ignore
README-ES.md export-ignore
.editorconfig export-ignore
composer.lock export-ignore
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ composer.phar
composer.lock
composer-test.lock
build/artifacts/
artifacts/
vendor/
docs/_build
docs/*.pyc
.git*/
Expand Down
24 changes: 21 additions & 3 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,42 @@ sudo: false

dist: trusty

branches:
only:
- master

git:
depth: 5

php:
- 5.6
- 7.0
- 7.1
- 7.2
- hhvm
- nightly

matrix:
fast_finish: true
include:
- php: 7.1
env: PHPCS=PSR2

allow_failures:
- php: nightly

before_script:
- composer self-update
- composer install
- export PATH="./vendor/bin:$PATH"
- travis_retry composer self-update
- travis_retry composer install --no-interaction --prefer-source --dev

script:
- composer test
- phpunit
- |
if [[ "$PHPCS" ]] ; then
phpcs --standard=phpcs.ruleset.xml $(find . -name '*.php')
fi
phpunit --coverage-clover=coverage.xml
after_success:
- bash <(curl -s https://codecov.io/bash)
32 changes: 32 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,37 @@
# CHANGELOG

## 1.1.4 - 2017-11-01

* Implemented `PSR-4 autoloader standard` from all library files.

* Implemented `PSR-2 coding standard` from all library PHP files.

* Implemented `PHPCS` to ensure that PHP code complies with `PSR2` code standards.

* Implemented `Codacy` to automates code reviews and monitors code quality over time.

* Implemented `Codecov` to coverage reports.

* Added `LanguageCode/phpcs.ruleset.xml` file.

* Deleted `LanguageCode/src/bootstrap.php` file.

* Deleted `LanguageCode/tests/bootstrap.php` file.

* Deleted `LanguageCode/vendor` folder.

* Deleted `LanguageCode/resources/languageCodes.jsond` file.

* Changed `Josantonius\LanguageCode\Test\LanguageCodeTest` class to `Josantonius\LanguageCode\LanguageCodeTest` class.

* Added `Josantonius\LanguageCode\LanguageCodeCollection` class.
* Added `Josantonius\LanguageCode\LanguageCodeCollection::all()` method.
* Added `Josantonius\LanguageCode\LanguageCodeCollection::get()` method.

* Deleted `Josantonius\LanguageCode\LanguageCode::getAll()` method.

* Added `Josantonius\LanguageCode\LanguageCode::get()` method.

## 1.1.3 - 2017-09-14

* Unit tests supported by `PHPUnit` were added.
Expand Down
142 changes: 98 additions & 44 deletions README-ES.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
# PHP LanguageCode library

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

[Spanish version](README-ES.md)
[English version](README.md)

Lista de 217 códigos de idioma: ISO 639-1.

---

- [Instalación](#instalación)
- [Requisitos](#requisitos)
- [Cómo empezar y ejemplos](#cómo-empezar-y-ejemplos)
- [Instalación](#instalación)
- [Métodos disponibles](#métodos-disponibles)
- [Cómo empezar](#cómo-empezar)
- [Uso](#uso)
- [Listado en formato JSON](#listado-en-formato-json)
- [Tests](#tests)
- [Tareas pendientes](#-tareas-pendientes)
- [Contribuir](#contribuir)
Expand All @@ -22,71 +23,96 @@ Lista de 217 códigos de idioma: ISO 639-1.

---

### Instalación
## Requisitos

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

La mejor forma de instalar esta extensión es a través de [composer](http://getcomposer.org/download/).
## Instalación

Para instalar PHP LanguageCode library, simplemente escribe:
La mejor forma de instalar esta extensión es a través de [Composer](http://getcomposer.org/download/).

Para instalar **PHP LanguageCode library**, simplemente escribe:

$ composer require Josantonius/LanguageCode

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

$ composer require Josantonius/LanguageCode --prefer-source

También puedes clonar el repositorio completo con Git:
También puedes **clonar el repositorio** completo con Git:

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

### Requisitos
O **instalarlo manualmente**:

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):

Esta ĺibrería es soportada por versiones de PHP 5.6 o superiores y es compatible con versiones de HHVM 3.0 o superiores.
$ wget https://raw.githubusercontent.com/Josantonius/PHP-LanguageCode/master/src/LanguageCode.php
$ wget https://raw.githubusercontent.com/Josantonius/PHP-LanguageCode/master/src/LanguageCodeCollection.php

### Cómo empezar y ejemplos
## Métodos disponibles

Para utilizar esta biblioteca, simplemente:
Métodos disponibles en esta biblioteca:

### - Obtener array con todos los códigos de idioma:

```php
require __DIR__ . '/vendor/autoload.php';
LanguageCode::get();
```

use Josantonius\LanguageCode\LanguageCode;
**# Return** (array) → códigos y nombres de idiomas

### - Obtener el nombre del idioma desde código de idioma:

```php
LanguageCode::getLanguageFromCode($languageCode);
```
### Métodos disponibles

Métodos disponibles en esta biblioteca:
| Atributo | Descripción | Tipo | Requerido | Predeterminado
| --- | --- | --- | --- | --- |
| $languageCode | Código de idioma, e.g. 'es'. | string || |

**# Return** (tring|false) → nombre del país

### - Obtener código de idioma desde el nombre del idioma:

```php
LanguageCode::getLanguageFromCode();
LanguageCode::getCodeFromLanguage();
LanguageCode::getAll();
LanguageCode::getCodeFromLanguage($languageName);
```
### Uso

Ejemplo de uso para esta biblioteca:
| Atributo | Descripción | Tipo | Requerido | Predeterminado
| --- | --- | --- | --- | --- |
| $languageName | Nombre de idioma, e.g. 'Spanish'. | string || |

**# Return** (tring|false) → código de idioma

## Cómo empezar

Para utilizar esta biblioteca con **Composer**:

```php
<?php
require __DIR__ . '/vendor/autoload.php';

use Josantonius\LanguageCode\LanguageCode;
```

LanguageCode::getLanguageFromCode('es');

/* string(7) "Spanish" */

LanguageCode::getLanguageFromCode('abcd');
Si la instalaste **manualmente**, utiliza:

/* string(9) "undefined" */
```php
require_once __DIR__ . '/LanguageCode.php';
require_once __DIR__ . '/LanguageCodeCollection.php';

LanguageCode::getCodeFromLanguage('spanish');
use Josantonius\LanguageCode\LanguageCode;
```

/* string(2) "es" */
## Uso

LanguageCode::getCodeFromLanguage('abcd');
Ejemplo de uso para esta biblioteca:

/* string(9) "undefined" */
### - Obtener array con todos los códigos de idioma:

LanguageCode::getAll();
```php
LanguageCode::get();

/*
array(217) {
Expand All @@ -104,22 +130,50 @@ array(217) {
*/
```

### Tests
### - Obtener el nombre del idioma desde código de idioma:

```php
LanguageCode::getLanguageFromCode('es'); // string(7) "Spanish"
```

### - Obtener código de idioma desde el nombre del idioma:

```php
LanguageCode::getCodeFromLanguage('spanish'); // string(2) "es"
```

## List in Json format

Para ejecutar las [pruebas](tests/LanguageCode/test) simplemente:
[Go to the resource](https://gist.github.com/Josantonius/b455e315bc7f790d14b136d61d9ae469).

## Tests

Para ejecutar las [pruebas](tests) necesitarás [Composer](http://getcomposer.org/download/) y seguir los siguientes pasos:

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

$ cd PHP-LanguageCode

$ phpunit
$ composer install

Ejecutar pruebas unitarias con [PHPUnit](https://phpunit.de/):

$ composer phpunit

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):

$ composer phpcs

Ejecutar todas las pruebas anteriores:

$ composer tests

### ☑ Tareas pendientes
## ☑ Tareas pendientes

- [x] Completar tests
- [ ] Mejorar la documentación
- [x] Mejorar la documentación

### Contribuir
## Contribuir

1. Comprobar si hay incidencias abiertas o abrir una nueva para iniciar una discusión en torno a un fallo o función.
1. Bifurca la rama del repositorio en GitHub para iniciar la operación de ajuste.
Expand All @@ -129,17 +183,17 @@ Para ejecutar las [pruebas](tests/LanguageCode/test) simplemente:

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

### Repositorio
## Repositorio

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

### Licencia
## Licencia

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

### Copyright
## Copyright

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

Si te ha resultado útil, házmelo saber :wink:

Expand Down
Loading

0 comments on commit cd62a6e

Please sign in to comment.