This repository was archived by the owner on Aug 14, 2022. It is now read-only.

josantonius/php-file

Repository files navigation

Latest Stable VersionLicense

Versión en español

PHP library for file management.



This library is supported by PHP versions 5.6 or higher and is compatible with HHVM versions 3.0 or higher.

The preferred way to install this extension is through Composer.

To install PHP File library, simply:

composer require Josantonius/File

The previous command will only install the necessary files, if you prefer to download the entire source code you can use:

composer require Josantonius/File --prefer-source

You can also clone the complete repository with Git:

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

Or install it manually:

Download File.php:

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

Available methods in this library:

File::exists($file);
AttributeDescriptionTypeRequiredDefault
$filePath or file url.stringYes

# Return (boolean)

File::delete($file);
AttributeDescriptionTypeRequiredDefault
$fileFile path.stringYes

# Return (boolean)

File::createDir($path);
AttributeDescriptionTypeRequiredDefault
$pathPath where to create directory.stringYes

# Return (boolean)

File::copyDirRecursively($from, $to);
AttributeDescriptionTypeRequiredDefault
$fromPath from copy.stringYes
$toPath to copy.stringYes

# Return (boolean)

File::deleteEmptyDir($path);
AttributeDescriptionTypeRequiredDefault
$pathPath to delete.stringYes

# Return (boolean)

File::deleteDirRecursively($path);
AttributeDescriptionTypeRequiredDefault
$pathPath to delete.stringYes

# Return (boolean)

File::getFilesFromDir($path);
AttributeDescriptionTypeRequiredDefault
$pathPath where get file paths.stringYes

# Return (boolean)

To use this library with Composer:

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

use Josantonius\File\File;

Or If you installed it manually, use it:

require_once __DIR__ . '/File.php';

use Josantonius\File\File;

Example of use for this library:

File::exists('path/to/file.php');
File::exists('https://raw.usercontent.com/Josantonius/PHP-File/master/composer.json');
File::delete(__DIR__ . '/test.txt');
File::createDir(__DIR__ . '/test/');
File::deleteEmptyDir(__DIR__ . '/test/');
File::deleteDirRecursively(__DIR__ . '/test/');
File::copyDirRecursively(__DIR__ . '/test/', __DIR__ . '/copy/');
get_class(File::getFilesFromDir(__DIR__));

To run tests you just need composer and to execute the following:

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

cd PHP-File

composer install

Run unit tests with PHPUnit:

composer phpunit

Run PSR2 code standard tests with PHPCS:

composer phpcs

Run PHP Mess Detector tests to detect inconsistencies in code style:

composer phpmd

Run all previous tests:

composer tests

This repository is licensed under the MIT License.

Copyright © 2017 - 2022, Josantonius

About

PHP library for file and directory management.

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published

Languages