Skip to content

File

Caches data to the filesystem

  • Full name: \SimplePie\Cache\File
  • Warning: this class is deprecated. This means that this class will likely be removed in a future version.
  • This class implements: \SimplePie\Cache\Base

Properties

location

Location string

protected string $location

See Also:

  • \SimplePie\Cache\SimplePie::$cache_location -

filename

Filename

protected string $filename

extension

File extension

protected string $extension

name

File path

protected string $name

Methods

__construct

Create a new cache object

public __construct(string $location, string $name, \SimplePie\Cache\Base::TYPE_FEED|\SimplePie\Cache\Base::TYPE_IMAGE $type): mixed

Parameters:

Parameter Type Description
$location string Location string (from SimplePie::$cache_location)
$name string Unique ID for the cache
$type \SimplePie\Cache\Base::TYPE_FEED|\SimplePie\Cache\Base::TYPE_IMAGE Either TYPE_FEED for SimplePie data, or TYPE_IMAGE for image data

save

Save data to the cache

public save(array|\SimplePie\SimplePie $data): bool

Parameters:

Parameter Type Description
$data array|\SimplePie\SimplePie Data to store in the cache. If passed a SimplePie object, only cache the $data property

Return Value:

Successfulness


load

Retrieve the data saved to the cache

public load(): array

Return Value:

Data for SimplePie::$data


mtime

Retrieve the last modified time for the cache

public mtime(): int

Return Value:

Timestamp


touch

Set the last modified time to the current time

public touch(): bool

Return Value:

Success status


Remove the cache

public unlink(): bool

Return Value:

Success status



Automatically generated on 2025-03-18