FilesBackend class - Documentation for SproutCMS

Info Page:

Page options:

class FilesBackend

Abstract class for a backend storage for the database-managed files

File: /sprout/Helpers/FilesBackend.php
Namespace: Sprout\Helpers
This class is abstract

Functions

Name	Visibility	Description
absUrl	public	Returns the public URL for a given file, including domain.
cleanupLocalCopy	public	Remove a local copy of a file
createLocalCopy	public	Create a copy of the file in a temporary directory.
delete	public	Delete a file
exists	public	Returns TRUE if the file exists, and FALSE if it does not
getString	public	Returns file content as a string. Basically the same as file_get_contents
glob	public	Returns all files which match the specified mask.
imageSize	public	Returns the size of an image, or false on failure.
moveUpload	public	Moves an uploaded file into the repository.
mtime	public	Returns the modified time, in unix timestamp format, of the specified file
putExisting	public	Saves file content from an existing file
putStream	public	Saves file content from a stream. Basically just fopen/stream_copy_to_stream/fclose
putString	public	Saves file content as a string. Basically the same as file_put_contents
readfile	public	This is the equivalent of the php readfile function
relUrl	public	Returns the relative public URL for a given file.
resizeUrl	public	Returns the URL for a resized image. Does not include domain.
size	public	Returns the size, in bytes, of the specified file
touch	public	Sets access and modification time of file

public absUrl

void $FilesBackend->absUrl ( mixed $filename );

Returns the public URL for a given file, including domain.

public cleanupLocalCopy

void $FilesBackend->cleanupLocalCopy ( string $temp_filename );

Remove a local copy of a file

public createLocalCopy

string $FilesBackend->createLocalCopy ( string $filename );

Create a copy of the file in a temporary directory.
Don't forget to File::destroy_local_copy($temp_filename) when you're done!

public delete

void $FilesBackend->delete ( mixed $filename );

Delete a file

public exists

void $FilesBackend->exists ( mixed $filename );

Returns TRUE if the file exists, and FALSE if it does not

public getString

void $FilesBackend->getString ( mixed $filename );

Returns file content as a string. Basically the same as file_get_contents

public glob

void $FilesBackend->glob ( mixed $mask );

Returns all files which match the specified mask.
I have a feeling this returns other sizes (e.g. .small) as well - which may not be ideal.

public imageSize

void $FilesBackend->imageSize ( mixed $filename );

Returns the size of an image, or false on failure.

Output format is the same as getimagesize, but will be at a minimum:
  [0] => width, [1] => height, [2] => type

public moveUpload

void $FilesBackend->moveUpload ( mixed $src , mixed $filename );

Moves an uploaded file into the repository.
Returns TRUE on success, FALSE on failure.

public mtime

void $FilesBackend->mtime ( mixed $filename );

Returns the modified time, in unix timestamp format, of the specified file

public putExisting

void $FilesBackend->putExisting ( mixed $filename , mixed $existing );

Saves file content from an existing file

public putStream

void $FilesBackend->putStream ( mixed $filename , mixed $stream );

Saves file content from a stream. Basically just fopen/stream_copy_to_stream/fclose

public putString

void $FilesBackend->putString ( mixed $filename , mixed $content );

Saves file content as a string. Basically the same as file_put_contents

public readfile

void $FilesBackend->readfile ( mixed $filename );

This is the equivalent of the php readfile function

public relUrl

void $FilesBackend->relUrl ( mixed $filename );

Returns the relative public URL for a given file.
Doesn't contain ROOT/ or domain. Use for content areas.

public resizeUrl

void $FilesBackend->resizeUrl ( mixed $filename , mixed $size );

Returns the URL for a resized image. Does not include domain.
Size should be 'rWIDTHxHEIGHT' or 'cWIDTHxHEIGHT'.

public size

void $FilesBackend->size ( mixed $filename );

Returns the size, in bytes, of the specified file

public touch

void $FilesBackend->touch ( mixed $filename );

Sets access and modification time of file

SproutCMS

Search documentation