AbstractAdapter
in package
implements
AdapterInterface
Abstract storage adapter class
Tags
Interfaces, Classes, Traits and Enums
- AdapterInterface
- Storage adapter interface
Table of Contents
- $local : bool
- Is local flag
- $location : string
- Storage location
- __construct() : mixed
- Constructor
- copyFile() : void
- Copy file
- deleteFile() : void
- Delete
- fetchFile() : string
- Fetch file
- fileExists() : bool
- File exists
- getFileMTime() : int
- Get file modified time
- getFileSize() : int
- Get file size
- getFileType() : string
- Get file type
- getLocation() : string
- Get storage location
- isFile() : bool
- Check if file is a file
- isLocal() : bool
- Is storage local
- loadFile() : array<string|int, mixed>
- Load file lines into array
- md5File() : string
- Create MD5 checksum of the file
- mkdir() : void
- Make a directory
- renameFile() : void
- Rename file
- replaceFile() : void
- Replace file
- rmdir() : void
- Remove a directory
- setLocation() : AbstractAdapter
- Set storage location
- uploadFile() : string
- Upload file
- uploadFileStream() : string
- Upload file stream
- checkFileLocation() : string
- Load file lines into array
Properties
$local
Is local flag
protected
bool
$local
= false
$location
Storage location
protected
string
$location
= null
Methods
__construct()
Constructor
public
__construct(string $location) : mixed
Parameters
- $location : string
Return values
mixed —copyFile()
Copy file
public
copyFile(string $filename, string $to) : void
Parameters
- $filename : string
- $to : string
Return values
void —deleteFile()
Delete
public
deleteFile(string $filename) : void
Parameters
- $filename : string
Return values
void —fetchFile()
Fetch file
public
fetchFile(string $filename) : string
Parameters
- $filename : string
Return values
string —fileExists()
File exists
public
fileExists(string $filename) : bool
Parameters
- $filename : string
Return values
bool —getFileMTime()
Get file modified time
public
getFileMTime(string $filename) : int
Parameters
- $filename : string
Return values
int —getFileSize()
Get file size
public
getFileSize(string $filename) : int
Parameters
- $filename : string
Return values
int —getFileType()
Get file type
public
getFileType(string $filename) : string
Parameters
- $filename : string
Return values
string —getLocation()
Get storage location
public
getLocation() : string
Return values
string —isFile()
Check if file is a file
public
isFile(string $filename) : bool
Parameters
- $filename : string
Return values
bool —isLocal()
Is storage local
public
isLocal() : bool
Return values
bool —loadFile()
Load file lines into array
public
loadFile(string $filename) : array<string|int, mixed>
Parameters
- $filename : string
Return values
array<string|int, mixed> —md5File()
Create MD5 checksum of the file
public
abstract md5File(string $filename) : string
Parameters
- $filename : string
Return values
string —mkdir()
Make a directory
public
abstract mkdir(string $dir) : void
Parameters
- $dir : string
Return values
void —renameFile()
Rename file
public
renameFile(string $filename, string $to) : void
Parameters
- $filename : string
- $to : string
Return values
void —replaceFile()
Replace file
public
replaceFile(string $filename, string $contents) : void
Parameters
- $filename : string
- $contents : string
Return values
void —rmdir()
Remove a directory
public
abstract rmdir(string $dir) : void
Parameters
- $dir : string
Return values
void —setLocation()
Set storage location
public
setLocation(string $location) : AbstractAdapter
Parameters
- $location : string
Return values
AbstractAdapter —uploadFile()
Upload file
public
abstract uploadFile(mixed $file[, string $dest = null ][, Upload $upload = null ]) : string
Parameters
- $file : mixed
- $dest : string = null
- $upload : Upload = null
Return values
string —uploadFileStream()
Upload file stream
public
abstract uploadFileStream(string $fileStream, string $filename[, string $folder = null ]) : string
Parameters
- $fileStream : string
- $filename : string
- $folder : string = null
Return values
string —checkFileLocation()
Load file lines into array
protected
checkFileLocation(string $filename) : string
Parameters
- $filename : string