Download the PHP package josantonius/file without Composer
On this page you can find all versions of the php package josantonius/file. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download josantonius/file
More information about josantonius/file
Files in josantonius/file
Informations about the package file
PHP File library
Versión en español
PHP library for file management.
- Requirements
- Installation
- Available Methods
- Quick Start
- Usage
- Tests
- License
Requirements
This library is supported by PHP versions 5.6 or higher and is compatible with HHVM versions 3.0 or higher.
Installation
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://github.com/Josantonius/PHP-File.git
Or install it manually:
wget https://raw.githubusercontent.com/Josantonius/PHP-File/master/src/File.php
Available Methods
Available methods in this library:
- Check if a file exists in a path or url
Attribute | Description | Type | Required | Default |
---|---|---|---|---|
$file | Path or file url. | string | Yes |
# Return (boolean)
- Delete file if exists
Attribute | Description | Type | Required | Default |
---|---|---|---|---|
$file | File path. | string | Yes |
# Return (boolean)
- Create directory if not exists
Attribute | Description | Type | Required | Default |
---|---|---|---|---|
$path | Path where to create directory. | string | Yes |
# Return (boolean)
- Copy directory recursively
Attribute | Description | Type | Required | Default |
---|---|---|---|---|
$from | Path from copy. | string | Yes | |
$to | Path to copy. | string | Yes |
# Return (boolean)
- Delete empty directory
Attribute | Description | Type | Required | Default |
---|---|---|---|---|
$path | Path to delete. | string | Yes |
# Return (boolean)
- Delete directory recursively
Attribute | Description | Type | Required | Default |
---|---|---|---|---|
$path | Path to delete. | string | Yes |
# Return (boolean)
- Get files from directory
Attribute | Description | Type | Required | Default |
---|---|---|---|---|
$path | Path where get file paths. | string | Yes |
# Return (boolean)
Quick Start
To use this library with Composer:
Or If you installed it manually, use it:
Usage
Example of use for this library:
- Check if a local file exists
- Check if a external file exists
- Delete a local file
- Create directory
- Delete empty directory
- Delete directory recursively
- Copy directory recursively
- Get file paths from directory
Tests
To run composer and to execute the following:
git clone https://github.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
License
This repository is licensed under the MIT License.
Copyright © 2017 - 2022, Josantonius