[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

/wp-includes/SimplePie/src/Cache/ -> Base.php (summary)

SimplePie A PHP-Based RSS and Atom Feed Framework. Takes the hard work out of managing a complete RSS/Atom solution.

Author: Ryan Parman
Author: Sam Sneddon
Author: Ryan McCue
Copyright: 2004-2016 Ryan Parman, Sam Sneddon, Ryan McCue
License: http://www.opensource.org/licenses/bsd-license.php BSD License
File Size: 119 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Base:: (6 methods):
  __construct()
  save()
  load()
  mtime()
  touch()
  unlink()


Interface: Base  - X-Ref

Base for cache objects

Classes to be used with {@see \SimplePie\Cache::register()} are expected
to implement this interface.

__construct($location, $name, $type)   X-Ref
Create a new cache object

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

save($data)   X-Ref
Save data to the cache

return: bool Successfulness
param: array|\SimplePie\SimplePie $data Data to store in the cache. If passed a SimplePie object, only cache the $data property

load()   X-Ref
Retrieve the data saved to the cache

return: array Data for SimplePie::$data

mtime()   X-Ref
Retrieve the last modified time for the cache

return: int Timestamp

touch()   X-Ref
Set the last modified time to the current time

return: bool Success status

unlink()   X-Ref
Remove the cache

return: bool Success status



Generated : Sat Dec 21 08:20:01 2024 Cross-referenced by PHPXref