|
| 1 | +# PHP File library |
| 2 | + |
| 3 | +[](https://packagist.org/packages/josantonius/file) [](https://packagist.org/packages/josantonius/file) [](https://packagist.org/packages/josantonius/file) [](https://packagist.org/packages/josantonius/file) |
| 4 | + |
| 5 | +[English version](README.md) |
| 6 | + |
| 7 | +Librería PHP para manejo de archivos. |
| 8 | + |
| 9 | +--- |
| 10 | + |
| 11 | +- [Instalación](#instalación) |
| 12 | +- [Requisitos](#requisitos) |
| 13 | +- [Cómo empezar y ejemplos](#cómo-empezar-y-ejemplos) |
| 14 | +- [Métodos disponibles](#métodos-disponibles) |
| 15 | +- [Uso](#uso) |
| 16 | +- [Tests](#tests) |
| 17 | +- [Manejador de excepciones](#manejador-de-excepciones) |
| 18 | +- [Contribuir](#contribuir) |
| 19 | +- [Repositorio](#repositorio) |
| 20 | +- [Licencia](#licencia) |
| 21 | +- [Copyright](#copyright) |
| 22 | + |
| 23 | +--- |
| 24 | + |
| 25 | +### Instalación |
| 26 | + |
| 27 | +La mejor forma de instalar esta extensión es a través de [composer](http://getcomposer.org/download/). |
| 28 | + |
| 29 | +Para instalar PHP File library, simplemente escribe: |
| 30 | + |
| 31 | + $ composer require Josantonius/File |
| 32 | + |
| 33 | +El comando anterior solamente instalará los archivos necesarios, si prefieres descargar todo el código, incluyendo tests, puedes utilizar: |
| 34 | + |
| 35 | + $ composer require Josantonius/File --prefer-source |
| 36 | + |
| 37 | +También puedes clonar el repositorio completo con Git: |
| 38 | + |
| 39 | + $ git clone https://github.com/Josantonius/File.git |
| 40 | + |
| 41 | +### Requisitos |
| 42 | + |
| 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. |
| 44 | + |
| 45 | +### Cómo empezar y ejemplos |
| 46 | + |
| 47 | +Para utilizar esta librería, simplemente: |
| 48 | + |
| 49 | +```php |
| 50 | +require __DIR__ . '/vendor/autoload.php'; |
| 51 | + |
| 52 | +use Josantonius\File\File; |
| 53 | +``` |
| 54 | +### Métodos disponibles |
| 55 | + |
| 56 | +Métodos disponibles en esta librería: |
| 57 | + |
| 58 | +```php |
| 59 | +File::searchString(); |
| 60 | +``` |
| 61 | +### Uso |
| 62 | + |
| 63 | +Ejemplo de uso para esta librería: |
| 64 | + |
| 65 | +```php |
| 66 | +<?php |
| 67 | +require __DIR__ . '/vendor/autoload.php'; |
| 68 | + |
| 69 | +use Josantonius\File\File; |
| 70 | + |
| 71 | +$search = 'Morbi'; |
| 72 | + |
| 73 | +$filepath = getcwd() . '/' . 'resources/file.txt'; |
| 74 | + |
| 75 | +File::searchString($search, $filepath); /* bool(true) */ |
| 76 | +``` |
| 77 | + |
| 78 | +### Tests |
| 79 | + |
| 80 | +Para utilizar la clase de [pruebas](tests), simplemente: |
| 81 | + |
| 82 | +```php |
| 83 | +<?php |
| 84 | +$loader = require __DIR__ . '/vendor/autoload.php'; |
| 85 | + |
| 86 | +$loader->addPsr4('Josantonius\\File\\Tests\\', __DIR__ . '/vendor/josantonius/file/tests'); |
| 87 | + |
| 88 | +use Josantonius\File\Tests\FileTest; |
| 89 | +``` |
| 90 | +Métodos de prueba disponibles en esta librería: |
| 91 | + |
| 92 | +```php |
| 93 | +FileTest::testSearchString(); |
| 94 | +``` |
| 95 | + |
| 96 | +### Manejador de excepciones |
| 97 | + |
| 98 | +Esta librería utiliza [control de excepciones](src/Exception) que puedes personalizar a tu gusto. |
| 99 | +### Contribuir |
| 100 | +1. Comprobar si hay incidencias abiertas o abrir una nueva para iniciar una discusión en torno a un fallo o función. |
| 101 | +1. Bifurca la rama del repositorio en GitHub para iniciar la operación de ajuste. |
| 102 | +1. Escribe una o más pruebas para la nueva característica o expón el error. |
| 103 | +1. Haz cambios en el código para implementar la característica o reparar el fallo. |
| 104 | +1. Envía pull request para fusionar los cambios y que sean publicados. |
| 105 | + |
| 106 | +Esto está pensado para proyectos grandes y de larga duración. |
| 107 | + |
| 108 | +### Repositorio |
| 109 | + |
| 110 | +Los archivos de este repositorio se crearon y subieron automáticamente con [Reposgit Creator](https://github.com/Josantonius/BASH-Reposgit). |
| 111 | + |
| 112 | +### Licencia |
| 113 | + |
| 114 | +Este proyecto está licenciado bajo **licencia MIT**. Consulta el archivo [LICENSE](LICENSE) para más información. |
| 115 | + |
| 116 | +## Copyright |
| 117 | + |
| 118 | +2017 Josantonius, [josantonius.com](https://josantonius.com/) |
| 119 | + |
| 120 | +Si te ha resultado útil, házmelo saber :wink: |
| 121 | + |
| 122 | +Puedes contactarme en [Twitter ](https://twitter.com/Josantonius) o a través de mi [correo electrónico ](mailto:[email protected]). |
0 commit comments