11# PHP File library
22
3- [ ![ Latest Stable Version] ( https://poser.pugx.org/josantonius/file/v/stable )] ( https://packagist.org/packages/josantonius/file ) [ ![ Total Downloads] ( https://poser.pugx.org/josantonius/file/downloads )] ( https://packagist.org/packages/josantonius/file ) [ ![ Latest Unstable Version] ( https://poser.pugx.org/josantonius/file/v/unstable )] ( https://packagist.org/packages/josantonius/file ) [ ![ License] ( https://poser.pugx.org/josantonius/file/license )] ( https://packagist.org/packages/josantonius/file ) [ ![ Travis] ( https://travis-ci.org/Josantonius/PHP-File.svg )] ( https://travis-ci.org/Josantonius/PHP-File )
3+ [](https://packagist.org/packages/josantonius/File) [](https://packagist.org/packages/josantonius/File) [](LICENSE) [](https://www.codacy.com/app/Josantonius/PHP-File?utm_source=github.com&utm_medium=referral&utm_content=Josantonius/PHP-File&utm_campaign=Badge_Grade) [](https://packagist.org/packages/josantonius/File) [](https://travis-ci.org/Josantonius/PHP-File) [](http://www.php-fig.org/psr/psr-2/) [](http://www.php-fig.org/psr/psr-4/) [](https://codecov.io/gh/Josantonius/PHP-File)
44
55[ English version] ( README.md )
66
77Biblioteca PHP para manejo de archivos.
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- [ Tareas pendientes] ( #-tareas-pendientes )
@@ -22,57 +22,194 @@ Biblioteca PHP para manejo de archivos.
2222
2323---
2424
25+ ### Requisitos
26+
27+ Esta clase es soportada por versiones de ` PHP 5.6 ` o superiores y es compatible con versiones de ` HHVM 3.0 ` o superiores.
28+
2529### Instalación
2630
27- La mejor forma de instalar esta extensión es a través de [ composer ] ( http://getcomposer.org/download/ ) .
31+ La mejor forma de instalar esta extensión es a través de [ Composer ] ( http://getcomposer.org/download/ ) .
2832
29- Para instalar PHP File library, simplemente escribe:
33+ Para instalar ` PHP File library ` , simplemente escribe:
3034
3135 $ composer require Josantonius/File
3236
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:
37+ El comando anterior sólo instalará los archivos necesarios, si prefieres ** descargar todo el código fuente** puedes utilizar:
3438
3539 $ composer require Josantonius/File --prefer-source
3640
37- También puedes clonar el repositorio completo con Git:
41+ También puedes ** clonar el repositorio** completo con Git:
3842
39- $ git clone https://github.com/Josantonius/File.git
40-
41- ### Requisitos
43+ $ git clone https://github.com/Josantonius/PHP-File.git
44+
45+ O ** instalarlo manualmente** :
46+
47+ [ Descargar File.php] ( https://raw.githubusercontent.com/Josantonius/PHP-File/master/src/File.php ) :
48+
49+ $ wget https://raw.githubusercontent.com/Josantonius/PHP-File/master/src/File.php
50+
51+ ### Métodos disponibles
52+
53+ Métodos disponibles en esta biblioteca:
54+
55+ ` Comprobar si existe un archivo en una ruta o url: `
56+
57+ ``` php
58+ File::exists($file);
59+ ```
60+
61+ | Atributo | Descripción | Tipo | Requerido | Predeterminado
62+ | --- | --- | --- | --- | --- |
63+ | $file| Ruta o url del archivo. | string | Sí | |
64+
65+ ** # Return** (boolean)
66+
67+ ` Eliminar archivos si existe: `
68+
69+ ``` php
70+ File::delete($file);
71+ ```
72+
73+ | Atributo | Descripción | Tipo | Requerido | Predeterminado
74+ | --- | --- | --- | --- | --- |
75+ | $file| Ruta del archivo. | string | Sí | |
76+
77+ ** # Return** (boolean)
78+
79+ ` Crear directorio si no existe: `
80+
81+ ``` php
82+ File::createDir($path);
83+ ```
84+
85+ | Atributo | Descripción | Tipo | Requerido | Predeterminado
86+ | --- | --- | --- | --- | --- |
87+ | $path| Ruta donde crear directorio. | string | Sí | |
88+
89+ ** # Return** (boolean)
90+
91+ ` Copiar directorio recursivamente: `
92+
93+ ``` php
94+ File::copyDirRecursively($from, $to);
95+ ```
96+
97+ | Atributo | Descripción | Tipo | Requerido | Predeterminado
98+ | --- | --- | --- | --- | --- |
99+ | $from| Ruta del directorio a copiar. | string | Sí | |
100+ | $to| Ruta del directorio de destino. | string | Sí | |
101+
102+ ** # Return** (boolean)
103+
104+ ` Eliminar directorio vacío: `
105+
106+ ``` php
107+ File::deleteEmptyDir($path);
108+ ```
109+
110+ | Atributo | Descripción | Tipo | Requerido | Predeterminado
111+ | --- | --- | --- | --- | --- |
112+ | $path| Ruta del directorio a eliminar. | string | Sí | |
113+
114+ ** # Return** (boolean)
115+
116+ ` Eliminar directorio recursivamente: `
117+
118+ ``` php
119+ File::deleteDirRecursively($path);
120+ ```
42121
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.
122+ | Atributo | Descripción | Tipo | Requerido | Predeterminado
123+ | --- | --- | --- | --- | --- |
124+ | $path| Ruta del directorio a eliminar. | string | Sí | |
44125
45- ### Cómo empezar y ejemplos
126+ ** # Return ** (boolean)
46127
47- Para utilizar esta biblioteca, simplemente:
128+ ` Obtener archivos de un directorio: `
129+
130+ ``` php
131+ File::getFilesFromDir($path);
132+ ```
133+
134+ | Atributo | Descripción | Tipo | Requerido | Predeterminado
135+ | --- | --- | --- | --- | --- |
136+ | $path| Ruta a examinar. | string | Sí | |
137+
138+ ** # Return** (boolean)
139+
140+ ### Cómo empezar
48141
49142``` php
50143require __DIR__ . '/vendor/autoload.php';
51144
52145use Josantonius\File\File;
53146```
54- ### Métodos disponibles
55147
56- Métodos disponibles en esta biblioteca :
148+ Si la instalaste ` manualmente ` , utiliza :
57149
58150``` php
59- File::exists();
60- File::delete();
61- File::createDir();
62- File::deleteEmptyDir();
63- File::CopyDirRecursively();
64- File::deleteDirRecursively();
65- File::getFilesFromDir();
151+ require_once __DIR__ . '/File.php';
152+
153+ use Josantonius\File\File;
66154```
155+
67156### Uso
68157
69158Ejemplo de uso para esta biblioteca:
70159
160+ ** Comprobar si existe un archivo local:**
161+
71162``` php
72163<?php
73- require __DIR__ . '/vendor/autoload.php';
164+ File::exists('path/to/file.php');
165+ ```
74166
75- use Josantonius\File\File;
167+ ** Comprobar si existe un archivo exteno:**
168+
169+ ``` php
170+ <?php
171+ File::exists('https://raw.githubusercontent.com/Josantonius/PHP-File/master/composer.json');
172+ ```
173+ Eliminar un archivo local:**
174+
175+ ``` php
176+ <?php
177+ File::delete(__DIR__ . '/test.txt');
178+ ```
179+
180+ ** Crear directorio:**
181+
182+ ``` php
183+ <?php
184+ File::createDir(__DIR__ . '/test/');
185+ ```
186+
187+ ** Eliminar directorio vacío:**
188+
189+ ``` php
190+ <?php
191+ File::deleteEmptyDir(__DIR__ . '/test/');
192+ ```
193+
194+ ** Eliminar directorio recursivamente:**
195+
196+ ``` php
197+ <?php
198+ File::deleteDirRecursively(__DIR__ . '/test/');
199+ ```
200+
201+ ** Copiar directorio recursivamente:**
202+
203+ ``` php
204+ <?php
205+ File::copyDirRecursively(__DIR__ . '/test/', __DIR__ . '/copy/');
206+ ```
207+
208+ ** Obtener archivos de un directorio:**
209+
210+ ``` php
211+ <?php
212+ get_class(File::getFilesFromDir(__DIR__));
76213```
77214
78215### Tests
0 commit comments