PHP Classes

File: README-ES.md

Recommend this page to a friend!
  Classes of Josantonius   PHP File   README-ES.md   Download  
File: README-ES.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: PHP File
Manipulate files and directories
Author: By
Last change: Updated to 1.1.7 version
Date: 5 years ago
Size: 7,691 bytes
 

Contents

Class file image Download

PHP File library

Latest Stable Version Latest Unstable Version License Codacy Badge Total Downloads Travis PSR2 PSR4 CodeCov

English version

Biblioteca PHP para manejo de archivos.

Requisitos

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

Instalación

La mejor forma de instalar esta extensión es a través de Composer.

Para instalar PHP File library, simplemente escribe:

$ composer require Josantonius/File

El comando anterior sólo instalará los archivos necesarios, si prefieres descargar todo el código fuente puedes utilizar:

$ composer require Josantonius/File --prefer-source

También puedes clonar el repositorio completo con Git:

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

O instalarlo manualmente:

Descargar File.php:

$ wget https://raw.githubusercontent.com/Josantonius/PHP-File/master/src/File.php

Métodos disponibles

Métodos disponibles en esta biblioteca:

- Comprobar si existe un archivo en una ruta o url:

File::exists($file);

| Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $file| Ruta o url del archivo. | string | Sí | |

# Return (boolean)

- Eliminar archivos si existe:

File::delete($file);

| Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $file| Ruta del archivo. | string | Sí | |

# Return (boolean)

- Crear directorio si no existe:

File::createDir($path);

| Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $path| Ruta donde crear directorio. | string | Sí | |

# Return (boolean)

- Copiar directorio recursivamente:

File::copyDirRecursively($from, $to);

| Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $from| Ruta del directorio a copiar. | string | Sí | | | $to| Ruta del directorio de destino. | string | Sí | |

# Return (boolean)

- Eliminar directorio vacío:

File::deleteEmptyDir($path);

| Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $path| Ruta del directorio a eliminar. | string | Sí | |

# Return (boolean)

- Eliminar directorio recursivamente:

File::deleteDirRecursively($path);

| Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $path| Ruta del directorio a eliminar. | string | Sí | |

# Return (boolean)

- Obtener archivos de un directorio:

File::getFilesFromDir($path);

| Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $path| Ruta a examinar. | string | Sí | |

# Return (boolean)

Cómo empezar

Para utilizar esta biblioteca con Composer:

require __DIR__ . '/vendor/autoload.php';

use Josantonius\File\File;

Si la instalaste ### - manualmente### - , utiliza:

require_once __DIR__ . '/File.php';

use Josantonius\File\File;

Uso

Ejemplo de uso para esta biblioteca:

- Comprobar si existe un archivo local:

<?php
File::exists('path/to/file.php');

- Comprobar si existe un archivo exteno:

<?php
File::exists('https://raw.githubusercontent.com/Josantonius/PHP-File/master/composer.json');

Eliminar un archivo local:

<?php
File::delete(__DIR__ . '/test.txt');

- Crear directorio:

<?php
File::createDir(__DIR__ . '/test/');

- Eliminar directorio vacío:

<?php
File::deleteEmptyDir(__DIR__ . '/test/');

- Eliminar directorio recursivamente:

<?php
File::deleteDirRecursively(__DIR__ . '/test/');

- Copiar directorio recursivamente:

<?php
File::copyDirRecursively(__DIR__ . '/test/', __DIR__ . '/copy/');

- Obtener archivos de un directorio:

<?php
get_class(File::getFilesFromDir(__DIR__));

Tests

Para ejecutar las pruebas necesitarás Composer y seguir los siguientes pasos:

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

$ cd PHP-File

$ composer install

Ejecutar pruebas unitarias con PHPUnit:

$ composer phpunit

Ejecutar pruebas de estándares de código PSR2 con PHPCS:

$ composer phpcs

Ejecutar pruebas con PHP Mess Detector para detectar inconsistencias en el estilo de codificación:

$ composer phpmd

Ejecutar todas las pruebas anteriores:

$ composer tests

? Tareas pendientes

  • [ ] Añadir nueva funcionalidad.
  • [ ] Mejorar pruebas.
  • [ ] Mejorar documentación.
  • [ ] Refactorizar código para las reglas de estilo de código deshabilitadas. Ver phpmd.xml y .php_cs.dist.

Contribuir

Si deseas colaborar, puedes echar un vistazo a la lista de issues o tareas pendientes.

Pull requests

  • Fork and clone.
  • Ejecuta el comando `composer install` para instalar dependencias. Esto también instalará las dependencias de desarrollo.
  • Ejecuta el comando `composer fix` para estandarizar el código.
  • Ejecuta las pruebas.
  • Crea una nueva rama (branch), commit, push y envíame un pull request.

Repositorio

La estructura de archivos de este repositorio se creó con PHP-Skeleton.

Licencia

Este proyecto está licenciado bajo licencia MIT. Consulta el archivo LICENSE para más información.

Copyright

2017 Josantonius, josantonius.com

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

Puedes contactarme en Twitter o a través de mi correo electrónico.