File class - Documentation for SproutCMS

Info Page:

Page options:

class File

File-based Cache driver.

Name	Visibility	Description
`$directory`

Name	Visibility	Description
__construct	public	Tests that the storage location is a directory and is writable.
delete	public	Deletes a cache item by id or tag
deleteExpired	public	Deletes all cache files that are older than the current time.
exists	public	Finds an array of files matching the given id or tag.
expired	protected	Check if a cache file has expired by filename.
find	public	Finds an array of ids for a given tag.
get	public	Fetches a cache item. This will delete the item if it is expired or if
set	public	Sets a cache item to the given data, tags, and lifetime.

void $File->__construct ( mixed $directory );

Tests that the storage location is a directory and is writable.

boolean $File->delete ( string $id [, boolean $tag ] );

Deletes a cache item by id or tag

void $File->deleteExpired ( );

Deletes all cache files that are older than the current time.

array $File->exists ( string $id [, bool $tag ] );

Finds an array of files matching the given id or tag.

bool $File->expired ( string $file );

Check if a cache file has expired by filename.

array $File->find ( string $tag );

Finds an array of ids for a given tag.

NULL|mixed $File->get ( string $id );

Fetches a cache item. This will delete the item if it is expired or if
the hash does not match the stored hash.

bool $File->set ( string $id , string $data [, array $tags , integer $lifetime ] );

Sets a cache item to the given data, tags, and lifetime.