SimpleFile
extends File
in package
SimpleFile.
The 'SimpleFile' class is used to easily add read-only immutable files to the directory structure. One usecase would be to add a 'readme.txt' to a root of a webserver with some standard content.
Tags
Table of Contents
- $contents : string
- File contents.
- $mimeType : string
- A mimetype, such as 'text/plain' or 'text/html'.
- $name : string
- Name of this resource.
- __construct() : mixed
- Creates this node.
- delete() : mixed
- Deletes the current node.
- get() : mixed
- Returns the data.
- getContentType() : string
- Returns the mime-type for a file.
- getETag() : string
- Returns the ETag for a file.
- getLastModified() : int
- Returns the last modification time as a unix timestamp.
- getName() : string
- Returns the node name for this file.
- getSize() : int
- Returns the size of the file, in bytes.
- put() : string|null
- Replaces the contents of the file.
- setName() : mixed
- Renames the node.
Properties
$contents
File contents.
protected
string
$contents
= []
$mimeType
A mimetype, such as 'text/plain' or 'text/html'.
protected
string
$mimeType
$name
Name of this resource.
protected
string
$name
Methods
__construct()
Creates this node.
public
__construct(string $name, string $contents[, string|null $mimeType = null ]) : mixed
The name of the node must be passed, as well as the contents of the file.
Parameters
- $name : string
- $contents : string
- $mimeType : string|null = null
Return values
mixed —delete()
Deletes the current node.
public
delete() : mixed
Tags
Return values
mixed —get()
Returns the data.
public
get() : mixed
This method may either return a string or a readable stream resource
Return values
mixed —getContentType()
Returns the mime-type for a file.
public
getContentType() : string
If null is returned, we'll assume application/octet-stream
Return values
string —getETag()
Returns the ETag for a file.
public
getETag() : string
An ETag is a unique identifier representing the current version of the file. If the file changes, the ETag MUST change. The ETag is an arbitrary string, but MUST be surrounded by double-quotes.
Return null if the ETag can not effectively be determined
Return values
string —getLastModified()
Returns the last modification time as a unix timestamp.
public
getLastModified() : int
If the information is not available, return null.
Return values
int —getName()
Returns the node name for this file.
public
getName() : string
This name is used to construct the url.
Return values
string —getSize()
Returns the size of the file, in bytes.
public
getSize() : int
Return values
int —put()
Replaces the contents of the file.
public
put(string|resource $data) : string|null
The data argument is a readable stream resource.
After a successful put operation, you may choose to return an ETag. The etag must always be surrounded by double-quotes. These quotes must appear in the actual string you're returning.
Clients may use the ETag from a PUT request to later on make sure that when they update the file, the contents haven't changed in the mean time.
If you don't plan to store the file byte-by-byte, and you return a different object on a subsequent GET you are strongly recommended to not return an ETag, and just return null.
Parameters
- $data : string|resource
Return values
string|null —setName()
Renames the node.
public
setName(string $name) : mixed
Parameters
- $name : string
-
The new name