Class DOMIT_cache

Description

A simple caching mechanism for a DOMIT_Document

Located in /includes/domit/xml_domit_cache.php (line 17)


	
			
Method Summary
boolean cacheExists (string $xmlFileName)
Object &fromCache (string $xmlFileName)
boolean removeFromCache (string $xmlFileName)
void toCache (string $xmlFileName, Object &$doc, [string $writeAttributes = 'w'])
Methods
cacheExists (line 55)

Determines whether a cached version of the specified document exists

  • return: True if a cache of the specified document exists
boolean cacheExists (string $xmlFileName)
  • string $xmlFileName: The name of the xml file to be retrieved
fromCache (line 39)

Unserializes a cached DOMIT! document

  • return: The retrieved document
Object &fromCache (string $xmlFileName)
  • string $xmlFileName: The name of the xml file to be retrieved
removeFromCache (line 67)

Removes a cache of the specified document

  • return: True if a cache has been removed
boolean removeFromCache (string $xmlFileName)
  • string $xmlFileName: The name of the xml file to be retrieved
toCache (line 24)

Serializes and caches the specified DOMIT! document

void toCache (string $xmlFileName, Object &$doc, [string $writeAttributes = 'w'])
  • string $xmlFileName: The name of the xml file to be saved
  • Object &$doc: A reference to the document to be saved
  • string $writeAttributes: The write attributes for the saved document ('w' or 'wb')

Documentation generated on Fri, 4 Mar 2005 13:57:33 +1000 by phpDocumentor 1.3.0RC3