https://github.com/dev-charles15531/ci4-fml

Codeigniter 4 File Manipulation Library
https://github.com/dev-charles15531/ci4-fml

Last synced: about 1 month ago
JSON representation

Codeigniter 4 File Manipulation Library

• Host: GitHub
• URL: https://github.com/dev-charles15531/ci4-fml
• Owner: dev-charles15531
• License: mit
• Created: 2020-12-26T16:16:20.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2021-01-22T06:03:17.000Z (almost 4 years ago)
• Last Synced: 2024-11-24T19:51:44.640Z (about 1 month ago)
• Language: PHP
• Size: 3.91 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ci4-FML

Codeigniter 4 File Manipulation Library

## How To Use:

**The Fml.php file is to be cloned or copied into your codeigniter 4 app/Libraries folder.**

- In your controller class, the library should be imported using;

````php

use App\Libraries\Fml; // Import library

````

- An instance of the library is created using;

````php

$file = new Fml($path); // create an instance of Library

````

Where $path is the path to the file to work with in **string**

- The following methods are accessible with the instantiated class:

````php

$file->isPresent() : bool

// Checks if the file is present and returns a boolean value of true if the file is found and false on the contray.

$file->calculateSize() : string

// Returns in string, the file size in bytes.

// An optional argument of "kilobyte", "megabyte" or "gigabyte" can be passed to the method to return the file size in kilobyte, megabyte or gigabyte respectively.

$file->deleteFile() : bool

// Deletes the file and returns true on success and false on error.

$file->getName() : string

// Returns in string format, the name of the file without extension.

// An optional parameter of TRUE can be passed to the method to return the file name with its extension.

$file->getExt() : string

// Returns the extension of the file in string format.

$file->getPath() : string

// Returns the path to the file without file name.

$file->duplicate() : bool 

// Duplicates the file and returns the value of true on success and false on error.

// The duplicated file is given the name of the original file, with '1' appended at the end of the name.

$file->setName(string $newName) : bool

// Gives the file a new name supplied as an argument in string format to the method.

// Returns true on success and false on error.

````

##  License

**ci4-FML** is released under the [MIT License](https://github.com/dev-charles15531/ci4-FML/blob/main/LICENSE).

Created by **[Charles Paul](https://github.com/dev-charles15531)**