Skip to content

Latest commit

 

History

History
398 lines (343 loc) · 17.7 KB

README.md

File metadata and controls

398 lines (343 loc) · 17.7 KB

Stag File Manager

StagPHP File Manager Image Stag File Manager is the core part of StagPHP framework. It comes with built-in core library. It is used to mange files and folders on the server. It is fast and high performance file manger with advance functionalites and top notch security. Follow the tutorial below to use this in your StagPHP application or on another framework.

Stag File Manager, is simply a php script. So, you can use it as a standalone library (PHP script) for file management, in your custom PHP project or any other PHP framework. You just need to follow the instructions given below.

  • This library is capable of doing several complex file operation smoothly. Such as recursive copy, move, delete etc.
  • It is tested and compatible with Linux, Windows and Unix environment running PHP.
  • It is also compatible with latest PHP version 7.x.x
  • It includes file downloader and zip archive manager

Requirements

  • PHP 5.7 or higer
  • libcurl & libzip extensions required. These are common PHP extenstions. Installed and enabled by default in most of the hosting environments.

Installation

On StagPHP

Just include this library in your StagPHP application, it comes built-in. And call the methods defined.

On another PHP framework

It is really simple, no brainer. Just include the file in your script and initialize the object of stag_file_manager class with root directory. And call the methods from the object initialized.

  1. First, you need to copy the files inside the dist (distribution) folder to your project folder. Include stag-file-manager.php in your PHP script or application at a root level.
  2. Define ABSPATH in your root level script.
if(!defined('ABSPATH')) define('ABSPATH',  dirname(__FILE__));
  1. After including the file, initialize the object of stag_file_manager class with root directory.
  2. Use the object Initialized, to manage files and folder using the methods defined.

Methods defined and usage are listed below.

Stag File Manager Operations

Lists of Methods:

Method Name Explanation
Get Info Returns information about the file or directory
Get File Properties Returns file properties (Detailed Information)
Get Directory Properties Returns directory properties (Detailed Information)
Scan Directory Scan the directory for files and folders
Deep Scan Directory Deeply scan the directory for its entire files and folders
Create File Creates the file only if does not exists
Update File Updates the file and creates it if does not exists
Copy File Creates a copy of a file
Move File Move file to another location
Rename File Rename file
Delete File Deletes the file permanently
Create Directory Creates a empty directory
Copy Directory Create a copy of the directory (recursively)
Move Directory Move directory to another location (recursively)
Rename Directory Rename directory
Delete Directory Deletes the directory permanently (recursively)
Download File Download a file from remote URL
Get Remote File Content Get remote file content from remote URL
Compress File Compress file to zip
Compress Directory Compress entire directory to zip
Extract Zip Extract Zip file

Popular Hacks:

Hacks Explanation
Change file extension Change the file extension, not type
Move to trash Move files and directories to trash

Get Info

Basic Information

You can follow the below listed example to get the basic information about the file or directory.

/** Root Directory */
$root_directory = "/";

/** File Manager Object Initialize */
$file_manager  =  new stag_file_manager($root_directory);

/** Get Info
 *
 * Basic Information about file
 * 
 * @returns: array - status, type, is_writable */
$basic_info = $file_manager->get_info('/filename.extension', FALSE);

/** 
 * Basic Information about directory (just pass
 * directory path in place of file path)
 * 
 * @returns: array - status, type, is_writable */
$basic_info = $file_manager->get_info('/directory/', FALSE);

Parameters to be passed:

Parameter Explanation
Relative path of a file or directory (string) Must be relative to root
Detailed Information Flag (boolean) Use FALSE for basic information

Array of values returned after execution:

Returned keys Explanation
status (boolean) In boolean, TRUE if file exists
type (string) file or directory depending upon the argument passed
is_writable (boolean) In boolean, TRUE if file is writable

Detailed Information

You can follow the below listed example to get the detailed information about the file or directory. As this method checks for multiple parameters, it takes slightly more server resource and execution time than the previous method.

$file_manager  =  new  stag_file_manager;

/** 
 * Detailed Information about file
 * 
 * @returns: array - status, type, size,
 * is_writable, permission, modified_time */
$full_info = $file_manager->get_info('/filename.extension', TRUE);

/** 
 * Detailed Information about directory (just pass
 * directory path in place of file path)
 * 
 * @returns: array - status, type, size,
 * is_writable, permission, modified_time */
$full_info = $file_manager->get_info('/directory/', TRUE);

Parameters to be passed:

Parameter Explanation
Relative path of a file or directory (string) Must be relative to root
Detailed Information Flag (boolean) Use TRUE for Detailed information

Array of values returned after execution:

Returned keys Explanation
status (boolean) In boolean, TRUE if file exists
type (string) View MIME Types (inode/directory in case of directory)
size (integer) File or Directory (including sub folders and files) in bytes
is_writable (boolean) In boolean, TRUE if file is writable
permission (string) File permissions in a octal numbers more info.
modified_time (string) Last modified time of a file or directory YYYY-12-30 24:60:60

Scan Directory

You can follow the below listed example to scan directory. This method scans the directory on the level specified. That means, it will not scan the contents of the sub directory inside this directory. For sub directory, you can call this method again. We have restricted the method to scan only single level in order to boost performance.

$file_manager  =  new  stag_file_manager;

/** 
 * Scan directory
 * 
 * @returns: array - status, array of files,
 * array of directories */
$result = $file_manager->scan_directory('/test/');

Parameters to be passed:

Parameter Explanation
Relative path of a file or directory (string) Path must be relative

Array of values returned after execution:

Returned keys Explanation
status (boolean) In boolean, TRUE if directory exists
directories (string) Array of directory names
files (string) Array of file names

Create or Update File

You can follow the below listed example to create a new file or update the existing file. It creates a file when specified file does not exists and updates a file when it exists. This method also creates the directory if does not exists.

$file_manager  =  new  stag_file_manager;

/** 
 * Create or Update File
 * 
 * @returns: array - status, array of files,
 * array of directories */
$result = $file_manager->update_file('/directory/'.$file_name, $file_content);

Parameters to be passed:

Parameter Explanation
Relative path of a file (string) Path of the file, which needs to be updated or where it needs to be created. Must be relative to root
File content (string) File content

Array of values returned after execution:

Returned keys Explanation
status (boolean) In boolean, TRUE if operation was successful
description (string) Success or Error message in case of failure

Copy File

You can follow the below listed example to copy a new file from one directory location to another. This method also creates the directory if does not exists.

$file_manager  =  new  stag_file_manager;

/** 
 * Copy File
 * 
 * @returns: array - status, array of files,
 * array of directories */
$result = $file_manager->copy_file('/directory/'.$file_name, '/new-directory/'.$file_name);

Parameters to be passed:

Parameter Explanation
Relative path of a file (string) Path of the file, which needs to be copied
Relative path of a file (string) New path of the file, where it needs to be copied

Array of values returned after execution:

Returned keys Explanation
status (boolean) In boolean, TRUE if operation was successful
description (string) Success or Error message in case of failure

Move File

You can follow the below listed example to move a file from one directory location to another. This method also creates the directory if does not exists.

$file_manager  =  new  stag_file_manager;

/** 
 * Move File
 * 
 * @returns: array - status, array of files,
 * array of directories */
$result = $file_manager->move_file('/directory/'.$file_name, '/new-directory/'.$file_name);

Parameters to be passed:

Parameter Explanation
Relative path of a file (string) Path of the file, which needs to be moved
Relative path of a file (string) New path of the file, where it needs to be moved

Array of values returned after execution:

Returned keys Explanation
status (boolean) In boolean, TRUE if operation was successful
description (string) Success or Error message in case of failure

Delete File

You can follow the below listed example to delete a file. This operation is nor reversible, so it deletes the file permanently.

$file_manager  =  new  stag_file_manager;

/** 
 * Delete File
 * 
 * @returns: array - status, description */
$result = $file_manager->delete_file('/directory/'.$file_name);

Parameters to be passed:

Parameter Explanation
Relative path of a file (string) Path of the file, which needs to be deleted

Array of values returned after execution:

Returned keys Explanation
status (boolean) In boolean, TRUE if operation was successful
description (string) Success or Error message in case of failure

Download File

You can follow the below listed example to download a file from remote destination and save file to specified location. This method also creates the directory if does not exists.

$file_manager  =  new  stag_file_manager;

/** Remote URL from where file needed to be fetched */
$remote_url = 'https://stagphp.github.io/stag-file-manager/README.md';

/** 
 * Download File
 * 
 * @returns: array - status, description */
$result = $file_manager->download_file($remote_url, '/directory/file.extension');

Parameters to be passed:

Parameter Explanation
Remote URL (string) Remote URL must be complete including http protocol
Save location (string) Relative location of the file, with filename and extension

Array of values returned after execution:

Returned keys Explanation
status (boolean) In boolean, TRUE if operation was successful
description (string) Success or Error message in case of failure

Get Remote File Content

You can follow the below listed example to get remote file content from remote destination URL. Content will be returend in a form of a string. This method also creates the directory if does not exists.

$file_manager  =  new  stag_file_manager;

/** Remote URL from where file needed to be fetched */
$remote_url = 'https://stagphp.github.io/stag-file-manager/README.md';

/** 
 * Download File
 * 
 * @returns: array - status, description */
$result = $file_manager->get_remote_file_content($remote_url);

Parameters to be passed:

Parameter Explanation
Remote URL (string) Remote URL must be complete including http protocol

Array of values returned after execution:

Returned keys Explanation
status (boolean) In boolean, TRUE if operation was successful
description (string) Success or Error message in case of failure

Create Directory

You can follow the below listed example to creates a new empty directory. This fails if directory already exists.

$file_manager  =  new  stag_file_manager;

/** 
 * Create Directory
 * 
 * @returns: array - status, description */
$result = $file_manager->delete_directory('/new-directory/');

Parameters to be passed:

Parameter Explanation
Relative path of a file (string) Path of the file, which needs to be deleted

Array of values returned after execution:

Returned keys Explanation
status (boolean) In boolean, TRUE if operation was successful
description (string) Success or Error message in case of failure

Copy Directory

You can follow the below listed example to copy a existing directory to new location (inside another directory). This is recursive operation. This method also creates the directory if does not exists.

$file_manager  =  new  stag_file_manager;

/** 
 * Copy Directory
 * 
 * @returns: array - status, description */
$result = $file_manager->copy_directory('/directory/', '/new-loc/directory/');

Parameters to be passed:

Parameter Explanation
Directory Path (string) Path of the directory, which needs to be copied
Directory Path (string) Path to new location, where directory needs to be copied

Array of values returned after execution:

Returned keys Explanation
status (boolean) In boolean, TRUE if operation was successful
description (string) Success or Error message in case of failure

Move Directory

You can follow the below listed example to move a existing directory to new location (inside another directory). This is recursive operation. This method also creates the directory if does not exists.

$file_manager  =  new  stag_file_manager;

/** 
 * Move Directory
 * 
 * @returns: array - status, description */
$result = $file_manager->move_directory('/directory/', '/new-loc/directory/');

Parameters to be passed:

Parameter Explanation
Directory Path (string) Path of the directory, which needs to be moved
Directory Path (string) Path to new location, where directory needs to be moved

Array of values returned after execution:

Returned keys Explanation
status (boolean) In boolean, TRUE if operation was successful
description (string) Success or Error message in case of failure

Delete Directory

You can follow the below listed example to delete a directory. This is recursive operation. This operation is nor reversible, so it deletes the directory and entire files and sub directories permanently inside this directory.

$file_manager  =  new  stag_file_manager;

/** 
 * Delete Directory
 * 
 * @returns: array - status, description */
$result = $file_manager->delete_directory('/directory/');

Parameters to be passed:

Parameter Explanation
Directory Path (string) Path of the directory, which needs to be deleted

Array of values returned after execution:

Returned keys Explanation
status (boolean) In boolean, TRUE if operation was successful
description (string) Success or Error message in case of failure