@@ -22,15 +22,15 @@ Biblioteca PHP para manejo de archivos.
22
22
23
23
---
24
24
25
- ### Requisitos
25
+ ## Requisitos
26
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.
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
28
29
- ### Instalación
29
+ ## Instalación
30
30
31
31
La mejor forma de instalar esta extensión es a través de [ Composer] ( http://getcomposer.org/download/ ) .
32
32
33
- Para instalar ` PHP File library ` , simplemente escribe:
33
+ Para instalar ** PHP File library** , simplemente escribe:
34
34
35
35
$ composer require Josantonius/File
36
36
@@ -48,11 +48,11 @@ O **instalarlo manualmente**:
48
48
49
49
$ wget https://raw.githubusercontent.com/Josantonius/PHP-File/master/src/File.php
50
50
51
- ### Métodos disponibles
51
+ ## Métodos disponibles
52
52
53
53
Métodos disponibles en esta biblioteca:
54
54
55
- ` Comprobar si existe un archivo en una ruta o url: `
55
+ ### - Comprobar si existe un archivo en una ruta o url:
56
56
57
57
``` php
58
58
File::exists($file);
@@ -64,7 +64,7 @@ File::exists($file);
64
64
65
65
** # Return** (boolean)
66
66
67
- ` Eliminar archivos si existe: `
67
+ ### - Eliminar archivos si existe:
68
68
69
69
``` php
70
70
File::delete($file);
@@ -76,7 +76,7 @@ File::delete($file);
76
76
77
77
** # Return** (boolean)
78
78
79
- ` Crear directorio si no existe: `
79
+ ### - Crear directorio si no existe:
80
80
81
81
``` php
82
82
File::createDir($path);
@@ -88,7 +88,7 @@ File::createDir($path);
88
88
89
89
** # Return** (boolean)
90
90
91
- ` Copiar directorio recursivamente: `
91
+ ### - Copiar directorio recursivamente:
92
92
93
93
``` php
94
94
File::copyDirRecursively($from, $to);
@@ -101,7 +101,7 @@ File::copyDirRecursively($from, $to);
101
101
102
102
** # Return** (boolean)
103
103
104
- ` Eliminar directorio vacío: `
104
+ ### - Eliminar directorio vacío:
105
105
106
106
``` php
107
107
File::deleteEmptyDir($path);
@@ -113,7 +113,7 @@ File::deleteEmptyDir($path);
113
113
114
114
** # Return** (boolean)
115
115
116
- ` Eliminar directorio recursivamente: `
116
+ ### - Eliminar directorio recursivamente:
117
117
118
118
``` php
119
119
File::deleteDirRecursively($path);
@@ -125,7 +125,7 @@ File::deleteDirRecursively($path);
125
125
126
126
** # Return** (boolean)
127
127
128
- ` Obtener archivos de un directorio: `
128
+ ### - Obtener archivos de un directorio:
129
129
130
130
``` php
131
131
File::getFilesFromDir($path);
@@ -137,82 +137,84 @@ File::getFilesFromDir($path);
137
137
138
138
** # Return** (boolean)
139
139
140
- ### Cómo empezar
140
+ ## Cómo empezar
141
+
142
+ Para utilizar esta biblioteca con ** Composer** :
141
143
142
144
``` php
143
145
require __DIR__ . '/vendor/autoload.php';
144
146
145
147
use Josantonius\File\File;
146
148
```
147
149
148
- Si la instalaste ` manualmente ` , utiliza:
150
+ Si la instalaste ### - manualmente### - , utiliza:
149
151
150
152
``` php
151
153
require_once __DIR__ . '/File.php';
152
154
153
155
use Josantonius\File\File;
154
156
```
155
157
156
- ### Uso
158
+ ## Uso
157
159
158
160
Ejemplo de uso para esta biblioteca:
159
161
160
- ** Comprobar si existe un archivo local:**
162
+ ### - Comprobar si existe un archivo local:
161
163
162
164
``` php
163
165
<?php
164
166
File::exists('path/to/file.php');
165
167
```
166
168
167
- ** Comprobar si existe un archivo exteno:**
169
+ ### - Comprobar si existe un archivo exteno:
168
170
169
171
``` php
170
172
<?php
171
173
File::exists('https://raw.githubusercontent.com/Josantonius/PHP-File/master/composer.json');
172
174
```
173
- Eliminar un archivo local:**
175
+ Eliminar un archivo local:
174
176
175
177
``` php
176
178
<?php
177
179
File::delete(__DIR__ . '/test.txt');
178
180
```
179
181
180
- ** Crear directorio:**
182
+ ### - Crear directorio:
181
183
182
184
``` php
183
185
<?php
184
186
File::createDir(__DIR__ . '/test/');
185
187
```
186
188
187
- ** Eliminar directorio vacío:**
189
+ ### - Eliminar directorio vacío:
188
190
189
191
``` php
190
192
<?php
191
193
File::deleteEmptyDir(__DIR__ . '/test/');
192
194
```
193
195
194
- ** Eliminar directorio recursivamente:**
196
+ ### - Eliminar directorio recursivamente:
195
197
196
198
``` php
197
199
<?php
198
200
File::deleteDirRecursively(__DIR__ . '/test/');
199
201
```
200
202
201
- ** Copiar directorio recursivamente:**
203
+ ### - Copiar directorio recursivamente:
202
204
203
205
``` php
204
206
<?php
205
207
File::copyDirRecursively(__DIR__ . '/test/', __DIR__ . '/copy/');
206
208
```
207
209
208
- ** Obtener archivos de un directorio:**
210
+ ### - Obtener archivos de un directorio:
209
211
210
212
``` php
211
213
<?php
212
214
get_class(File::getFilesFromDir(__DIR__));
213
215
```
214
216
215
- ### Tests
217
+ ## Tests
216
218
217
219
Para ejecutar las [ pruebas] ( tests/File/Test ) simplemente:
218
220
@@ -227,7 +229,7 @@ Para ejecutar las [pruebas](tests/File/Test) simplemente:
227
229
- [x] Completar tests
228
230
- [x] Mejorar la documentación
229
231
230
- ### Contribuir
232
+ ## Contribuir
231
233
1 . Comprobar si hay incidencias abiertas o abrir una nueva para iniciar una discusión en torno a un fallo o función.
232
234
1 . Bifurca la rama del repositorio en GitHub para iniciar la operación de ajuste.
233
235
1 . Escribe una o más pruebas para la nueva característica o expón el error.
@@ -236,15 +238,15 @@ Para ejecutar las [pruebas](tests/File/Test) simplemente:
236
238
237
239
Esto está pensado para proyectos grandes y de larga duración.
238
240
239
- ### Repositorio
241
+ ## Repositorio
240
242
241
243
Los archivos de este repositorio se crearon y subieron automáticamente con [ Reposgit Creator] ( https://github.com/Josantonius/BASH-Reposgit ) .
242
244
243
- ### Licencia
245
+ ## Licencia
244
246
245
247
Este proyecto está licenciado bajo ** licencia MIT** . Consulta el archivo [ LICENSE] ( LICENSE ) para más información.
246
248
247
- ### Copyright
249
+ ## Copyright
248
250
249
251
2017 Josantonius, [ josantonius.com] ( https://josantonius.com/ )
250
252
0 commit comments