class FeedCachable extends Feed implements CachableInterface

Properties

$id from Feed

Methods

setProtocol($protocol)

No description

getProtocol()

No description

setVersion($version)

No description

getVersion()

No description

setNamespaces(array $namespaces)

No description

getNamespaces()

No description

getNamespace($index)

No description

hasNamespace($index)

No description

setXml(SimpleXMLElement $xml)

No description

from XMLObject
getXml()

No description

from XMLObject
exists()

No description

from XMLObject
addData($name, $value)

No description

setData($data)

No description

getData($limit = null, $offset)

No description

get($entry, $default = null)

No description

set($entry, $value)

No description

__get($entry)

No description

__set($entry, $value)

No description

__construct($feed_url, $feed_name = null)

No description

getRawXml()

No description

from Feed
getChannel()

No description

from Feed
hasItems($limit = null, $offset)

No description

from Feed
getItemsCount()

No description

from Feed
getItems($limit = null, $offset)

No description

from Feed
getItemById($id)

No description

from Feed
getItemsCategories($limit = null, $offset)

No description

from Feed
getItem($index)

No description

from Feed
getItemsCollection()

No description

from Feed
getItemsCollectionByCategorie($category, $limit = null, $offset)

No description

from Feed
setFeedUrl($feed_url)

No description

from Feed
getFeedUrl()

No description

from Feed
setFeedName($feed_name)

No description

from Feed
getFeedName()

No description

from Feed
__toString()

No description

from Feed
getTagItem($tag_name)

No description

from Feed
read()

No description

parse()

No description

from Feed
setCacheKey($str)

No description

getCacheKey()

No description

getCacheDirname()

No description

string
buildCacheKey()

Get the key of the current cached item

bool
isCached()

Test if an item is already cached and if its cache is still valid

mixed
getCache()

Get a cache content for an item

bool
setCache(mixed $content)

Set a cache content for an item

bool
invalidateCache()

Clear a cache content for an item

Details

in SimpleObject at line 46
setProtocol($protocol)

Parameters

$protocol

in SimpleObject at line 57
getProtocol()

in SimpleObject at line 62
setVersion($version)

Parameters

$version

in SimpleObject at line 68
getVersion()

in SimpleObject at line 73
setNamespaces(array $namespaces)

Parameters

array $namespaces

in SimpleObject at line 79
getNamespaces()

in SimpleObject at line 84
getNamespace($index)

Parameters

$index

in SimpleObject at line 89
hasNamespace($index)

Parameters

$index

in XMLObject at line 43
setXml(SimpleXMLElement $xml)

Parameters

SimpleXMLElement $xml

in XMLObject at line 49
getXml()

in XMLObject at line 54
exists()

in XMLDataObject at line 47
addData($name, $value)

Parameters

$name
$value

in XMLDataObject at line 56
setData($data)

Parameters

$data

in XMLDataObject at line 70
getData($limit = null, $offset)

Parameters

$limit
$offset

in XMLDataObject at line 88
get($entry, $default = null)

Parameters

$entry
$default

in XMLDataObject at line 96
set($entry, $value)

Parameters

$entry
$value

in XMLDataObject at line 101
__get($entry)

Parameters

$entry

in XMLDataObject at line 106
__set($entry, $value)

Parameters

$entry
$value

at line 39
__construct($feed_url, $feed_name = null)

Parameters

$feed_url
$feed_name

in Feed at line 58
getRawXml()

in Feed at line 63
getChannel()

in Feed at line 68
hasItems($limit = null, $offset)

Parameters

$limit
$offset

in Feed at line 73
getItemsCount()

in Feed at line 78
getItems($limit = null, $offset)

Parameters

$limit
$offset

in Feed at line 83
getItemById($id)

Parameters

$id

in Feed at line 93
getItemsCategories($limit = null, $offset)

Parameters

$limit
$offset

in Feed at line 111
getItem($index)

Parameters

$index

in Feed at line 116
getItemsCollection()

in Feed at line 121
getItemsCollectionByCategorie($category, $limit = null, $offset)

Parameters

$category
$limit
$offset

in Feed at line 140
setFeedUrl($feed_url)

Parameters

$feed_url

in Feed at line 147
getFeedUrl()

in Feed at line 152
setFeedName($feed_name)

Parameters

$feed_name

in Feed at line 158
getFeedName()

in Feed at line 167
__toString()

in Feed at line 176
getTagItem($tag_name)

Parameters

$tag_name

at line 45
read()

in Feed at line 238
parse()

at line 63
setCacheKey($str)

Parameters

$str

at line 69
getCacheKey()

at line 78
getCacheDirname()

at line 94
string buildCacheKey()

Get the key of the current cached item

This should transform an item identifier (such as a title) into a uniq key.

Return Value

string

at line 113
bool isCached()

Test if an item is already cached and if its cache is still valid

This may check if a cache exists for the item and if it seems always valid ; validity may be tested for a static duration time (a max_cache_time) and could be checked comparing the creation time of the cache entry and the last modification time of the source if it is possible.

Return Value

bool

at line 130
mixed getCache()

Get a cache content for an item

This must return the exact same content passed at the setCache() method.

Return Value

mixed

at line 151
bool setCache(mixed $content)

Set a cache content for an item

This must store the content in association with the item key ; the method could return a boolean indicates if the caching process succeeded.

Parameters

mixed $content

Return Value

bool

at line 168
bool invalidateCache()

Clear a cache content for an item

This must clear the cached content associated with the item key ; the method could return a boolean indicates if the deletion process succeeded.

Return Value

bool