Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
PubObjectCache Class Reference

Public Member Functions

 _insertInternally (&$object, $cacheId, $id1, $id2=null)
 
 add (&$object, &$parent)
 
get ($cacheId, $id1, $id2=null)
 
 isCached ($cacheId, $id1, $id2=null)
 
 markComplete ($cacheId, $objectId)
 

Detailed Description

A cache for publication objects required during export.

...

Definition at line 17 of file PubObjectCache.inc.php.

Member Function Documentation

PubObjectCache::_insertInternally ( $object,
  $cacheId,
  $id1,
  $id2 = null 
)

Insert an object into the cache.

Parameters
$objectobject
$cacheIdstring
$id1integer
$id2integer

Definition at line 127 of file PubObjectCache.inc.php.

References isCached().

Referenced by add().

PubObjectCache::add ( $object,
$parent 
)

Add a publishing object to the cache.

Parameters
$objectIssue|PublishedArticle|ArticleGalley|SuppFile
$parentPublishedArticle|null Only required when adding a galley.

Definition at line 30 of file PubObjectCache.inc.php.

References _insertInternally().

& PubObjectCache::get (   $cacheId,
  $id1,
  $id2 = null 
)

Retrieve (an) object(s) from the cache.

NB: You must check whether an object is in the cache before you try to retrieve it with this method.

Parameters
$cacheIdstring
$id1integer
$id2integer
Returns
mixed

Definition at line 78 of file PubObjectCache.inc.php.

References isCached().

PubObjectCache::isCached (   $cacheId,
  $id1,
  $id2 = null 
)

Check whether a given object is in the cache.

Parameters
$cacheIdstring
$id1integer
$id2integer
Returns
boolean

Definition at line 98 of file PubObjectCache.inc.php.

Referenced by _insertInternally(), and get().

PubObjectCache::markComplete (   $cacheId,
  $objectId 
)

Marks the given cache id "complete", i.e. it contains all child objects for the given object id.

Parameters
$cacheId
$objectId

Definition at line 58 of file PubObjectCache.inc.php.


The documentation for this class was generated from the following file: