1
1
# PHP File library
2
2
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)
3
+ [ ![ Latest Stable Version] ( https://poser.pugx.org/josantonius/File/v/stable )] ( https://packagist.org/packages/josantonius/File )
4
+ [ ![ License] ( https://poser.pugx.org/josantonius/File/license )] ( LICENSE )
4
5
5
- [ English version] ( README.md )
6
+ [ English version] ( README.md )
6
7
7
8
Biblioteca PHP para manejo de archivos.
8
9
@@ -13,46 +14,41 @@ Biblioteca PHP para manejo de archivos.
13
14
- [ Métodos disponibles] ( #métodos-disponibles )
14
15
- [ Cómo empezar] ( #cómo-empezar )
15
16
- [ Uso] ( #uso )
16
- - [ Tests] ( #tests )
17
- - [ Tareas pendientes] ( #-tareas-pendientes )
18
- - [ Contribuir] ( #contribuir )
19
- - [ Repositorio] ( #repositorio )
20
17
- [ Licencia] ( #licencia )
21
- - [ Copyright] ( #copyright )
22
18
23
19
---
24
20
25
21
## Requisitos
26
22
27
23
Esta clase es soportada por versiones de ** PHP 5.6** o superiores y es compatible con versiones de ** HHVM 3.0** o superiores.
28
24
29
- ## Instalación
25
+ ## Instalación
30
26
31
27
La mejor forma de instalar esta extensión es a través de [ Composer] ( http://getcomposer.org/download/ ) .
32
28
33
29
Para instalar ** PHP File library** , simplemente escribe:
34
30
35
- $ composer require Josantonius/File
31
+ composer require Josantonius/File
36
32
37
33
El comando anterior sólo instalará los archivos necesarios, si prefieres ** descargar todo el código fuente** puedes utilizar:
38
34
39
- $ composer require Josantonius/File --prefer-source
35
+ composer require Josantonius/File --prefer-source
40
36
41
37
También puedes ** clonar el repositorio** completo con Git:
42
38
43
- $ git clone https://github.com/Josantonius/PHP-File.git
39
+ $ git clone < https://github.com/Josantonius/PHP-File.git >
44
40
45
41
O ** instalarlo manualmente** :
46
42
47
43
[ Descargar File.php] ( https://raw.githubusercontent.com/Josantonius/PHP-File/master/src/File.php ) :
48
44
49
- $ wget https://raw.githubusercontent.com/Josantonius/PHP-File/master/src/File.php
45
+ wget https://raw.githubusercontent.com/Josantonius/PHP-File/master/src/File.php
50
46
51
47
## Métodos disponibles
52
48
53
49
Métodos disponibles en esta biblioteca:
54
50
55
- ### - Comprobar si existe un archivo en una ruta o url:
51
+ ### - Comprobar si existe un archivo en una ruta o url
56
52
57
53
``` php
58
54
File::exists($file);
@@ -64,7 +60,7 @@ File::exists($file);
64
60
65
61
** # Return** (boolean)
66
62
67
- ### - Eliminar archivos si existe:
63
+ ### - Eliminar archivos si existe
68
64
69
65
``` php
70
66
File::delete($file);
@@ -76,7 +72,7 @@ File::delete($file);
76
72
77
73
** # Return** (boolean)
78
74
79
- ### - Crear directorio si no existe:
75
+ ### - Crear directorio si no existe
80
76
81
77
``` php
82
78
File::createDir($path);
@@ -88,7 +84,7 @@ File::createDir($path);
88
84
89
85
** # Return** (boolean)
90
86
91
- ### - Copiar directorio recursivamente:
87
+ ### - Copiar directorio recursivamente
92
88
93
89
``` php
94
90
File::copyDirRecursively($from, $to);
@@ -101,7 +97,7 @@ File::copyDirRecursively($from, $to);
101
97
102
98
** # Return** (boolean)
103
99
104
- ### - Eliminar directorio vacío:
100
+ ### - Eliminar directorio vacío
105
101
106
102
``` php
107
103
File::deleteEmptyDir($path);
@@ -113,7 +109,7 @@ File::deleteEmptyDir($path);
113
109
114
110
** # Return** (boolean)
115
111
116
- ### - Eliminar directorio recursivamente:
112
+ ### - Eliminar directorio recursivamente
117
113
118
114
``` php
119
115
File::deleteDirRecursively($path);
@@ -125,7 +121,7 @@ File::deleteDirRecursively($path);
125
121
126
122
** # Return** (boolean)
127
123
128
- ### - Obtener archivos de un directorio:
124
+ ### - Obtener archivos de un directorio
129
125
130
126
``` php
131
127
File::getFilesFromDir($path);
@@ -159,121 +155,90 @@ use Josantonius\File\File;
159
155
160
156
Ejemplo de uso para esta biblioteca:
161
157
162
- ### - Comprobar si existe un archivo local:
158
+ ### - Comprobar si existe un archivo local
163
159
164
160
``` php
165
161
<?php
166
162
File::exists('path/to/file.php');
167
163
```
168
164
169
- ### - Comprobar si existe un archivo exteno:
165
+ ### - Comprobar si existe un archivo exteno
170
166
171
167
``` php
172
168
<?php
173
169
File::exists('https://raw.githubusercontent.com/Josantonius/PHP-File/master/composer.json');
174
170
```
171
+
175
172
Eliminar un archivo local:
176
173
177
174
``` php
178
175
<?php
179
176
File::delete(__DIR__ . '/test.txt');
180
177
```
181
178
182
- ### - Crear directorio:
179
+ ### - Crear directorio
183
180
184
181
``` php
185
182
<?php
186
183
File::createDir(__DIR__ . '/test/');
187
184
```
188
185
189
- ### - Eliminar directorio vacío:
186
+ ### - Eliminar directorio vacío
190
187
191
188
``` php
192
189
<?php
193
190
File::deleteEmptyDir(__DIR__ . '/test/');
194
191
```
195
192
196
- ### - Eliminar directorio recursivamente:
193
+ ### - Eliminar directorio recursivamente
197
194
198
195
``` php
199
196
<?php
200
197
File::deleteDirRecursively(__DIR__ . '/test/');
201
198
```
202
199
203
- ### - Copiar directorio recursivamente:
200
+ ### - Copiar directorio recursivamente
204
201
205
202
``` php
206
203
<?php
207
204
File::copyDirRecursively(__DIR__ . '/test/', __DIR__ . '/copy/');
208
205
```
209
206
210
- ### - Obtener archivos de un directorio:
207
+ ### - Obtener archivos de un directorio
211
208
212
209
``` php
213
210
<?php
214
211
get_class(File::getFilesFromDir(__DIR__));
215
212
```
216
213
217
- ## Tests
214
+ ## Tests
218
215
219
216
Para ejecutar las [ pruebas] ( tests ) necesitarás [ Composer] ( http://getcomposer.org/download/ ) y seguir los siguientes pasos:
220
217
221
- $ git clone https://github.com/Josantonius/PHP-File.git
218
+ git clone https://github.com/Josantonius/PHP-File.git
222
219
223
- $ cd PHP-File
220
+ cd PHP-File
224
221
225
- $ composer install
222
+ composer install
226
223
227
224
Ejecutar pruebas unitarias con [ PHPUnit] ( https://phpunit.de/ ) :
228
225
229
- $ composer phpunit
226
+ composer phpunit
230
227
231
228
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 ) :
232
229
233
- $ composer phpcs
230
+ composer phpcs
234
231
235
232
Ejecutar pruebas con [ PHP Mess Detector] ( https://phpmd.org/ ) para detectar inconsistencias en el estilo de codificación:
236
233
237
- $ composer phpmd
234
+ composer phpmd
238
235
239
236
Ejecutar todas las pruebas anteriores:
240
237
241
- $ composer tests
242
-
243
- ## ☑ Tareas pendientes
244
-
245
- - [ ] Añadir nueva funcionalidad.
246
- - [ ] Mejorar pruebas.
247
- - [ ] Mejorar documentación.
248
- - [ ] Refactorizar código para las reglas de estilo de código deshabilitadas. Ver [ phpmd.xml] ( phpmd.xml ) y [ .php_cs.dist] ( .php_cs.dist ) .
249
-
250
- ## Contribuir
251
-
252
- Si deseas colaborar, puedes echar un vistazo a la lista de
253
- [ issues] ( https://github.com/Josantonius/PHP-File/issues ) o [ tareas pendientes] ( #-tareas-pendientes ) .
254
-
255
- ** Pull requests**
256
-
257
- * [ Fork and clone] ( https://help.github.com/articles/fork-a-repo ) .
258
- * Ejecuta el comando ` composer install ` para instalar dependencias.
259
- Esto también instalará las [ dependencias de desarrollo] ( https://getcomposer.org/doc/03-cli.md#install ) .
260
- * Ejecuta el comando ` composer fix ` para estandarizar el código.
261
- * Ejecuta las [ pruebas] ( #tests ) .
262
- * Crea una nueva rama (** branch** ), ** commit** , ** push** y envíame un
263
- [ pull request] ( https://help.github.com/articles/using-pull-requests ) .
264
-
265
- ## Repositorio
266
-
267
- La estructura de archivos de este repositorio se creó con [ PHP-Skeleton] ( https://github.com/Josantonius/PHP-Skeleton ) .
238
+ composer tests
268
239
269
240
## Licencia
270
241
271
- Este proyecto está licenciado bajo ** licencia MIT** . Consulta el archivo [ LICENSE] ( LICENSE ) para más información.
272
-
273
- ## Copyright
274
-
275
- 2017 Josantonius, [ josantonius.com] ( https://josantonius.com/ )
276
-
277
- Si te ha resultado útil, házmelo saber :wink :
242
+ Este repositorio tiene una licencia [ MIT License] ( LICENSE ) .
278
243
279
- Puedes contactarme en [ Twitter ] ( https://twitter .com/Josantonius ) o a través de mi [ correo electrónico ] ( mailto:hello@ josantonius.com ) .
244
+ Copyright © 2017 - 2022, [ Josantonius ] ( https://github .com/josantonius/lang/es-ES/README.md#contacto )
0 commit comments