anekdotes / file
Provides an easier way to manipulate file for common use like move,rename etc.
Requires
- php: >=7.4.0
Requires (Dev)
- phpunit/phpunit: ^9
README
A library that provides an easy way to manipulate files for common uses such as move, rename etc.
Installation
Install via composer into your project:
composer require anekdotes/file
Usage
Use the class where ever you need it:
use Anekdotes\File\File;
Note : This requires autoloading namespaces. Using composer to do autoloading helps a lot.
Methods
Multiple static methods are available:
get
Get the content of a file.
- $path: path of the file
- $default: closure or string
File::get($path, $default = null);
exists
Check if file exists.
- $path: path of the file
File::exists($path)
Put
Create a new file.
- $path: path of the desired file location
- $contents: content of the file
File::put($path, $contents)
size
Get the file size in bytes.
- $path: path of the file
File::size($path)
delete
Delete a file.
- $path: path of the file
File::delete($path)
move
Move/rename a file.
- $path: path of the file to move
- $target: target of the file
File::move($path, $target)
copy
Copy a file.
- $path: path of the file to copy
- $target: target of the file
File::copy($path, $target)
extension
Get the file extension.
- $path: path of the file
File::extension($path)
```php
#### isDirectory
Check if path is a directory.
* **$path**: path of the directory
```php
isDirectory($directory)
glob
Returns an array of all files/folder inside a directory
- $path: path of the directory
File::glob($path)
directories
Returns an array of all folders inside a directory
- $path: path of the directory
File::directories($path)
files
Returns an array of all files inside a directory
- $directory: path of the directory
File::files($directory)
isFile
Check if path is a file.
- $path: path of the file
File::isFile($file)
makeDirectory
Create a directory.
- $path: desired path
- $mode: folder mod
File::makeDirectory($path, $mode = 0777)
deleteDirectory
Delete a directory.
- $directory: path of directory
File::deleteDirectory($directory)