Class: I2CE Dumper: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 7: Line 7:
===cacheFileLocation()===
===cacheFileLocation()===
*Signature: static public function cacheFileLocation($prefix,$file_name,$locale,$headers,$file_loc,$cacheTime,$ttl)
*Signature: static public function cacheFileLocation($prefix,$file_name,$locale,$headers,$file_loc,$cacheTime,$ttl)
Parameters:
*Parameters:
*$prefix  
*$prefix  
*$file_name  
*$file_name  
Line 17: Line 17:
===dumpCacheFileLocation()===
===dumpCacheFileLocation()===
*Signature: static public function dumpCacheFileLocation($prefix,$file_name)
*Signature: static public function dumpCacheFileLocation($prefix,$file_name)
Parameters:
*Parameters:
*$prefix  
*$prefix  
*$file_name  
*$file_name  
===dumpContents()===
===dumpContents()===
*Signature: static public function dumpContents($file_loc,$headers,$cacheTime)
*Signature: static public function dumpContents($file_loc,$headers,$cacheTime)
Parameters:
*Parameters:
*$file_loc  
*$file_loc  
*$headers  
*$headers  
Line 28: Line 28:
===dumpStaticURL()===
===dumpStaticURL()===
*Signature: static public function dumpStaticURL($key_prefix,$url_prefix)
*Signature: static public function dumpStaticURL($key_prefix,$url_prefix)
Parameters:
*Parameters:
*$key_prefix  
*$key_prefix  
*$url_prefix  
*$url_prefix  
**Default Value: 'file'
***Default Value: 'file'
===prepForDump()===
===prepForDump()===
*Signature: static public function prepForDump($file_mtime,$file_len,$headers,$cacheTime)
*Signature: static public function prepForDump($file_mtime,$file_len,$headers,$cacheTime)
Parameters:
*Parameters:
*$file_mtime  
*$file_mtime  
*$file_len  
*$file_len  

Revision as of 22:40, 16 October 2009

This article desrcibes the class I2CE_Dumper.

  • Location: Part of the module I2CE in the package I2CE
  • Source: Defined in the file lib/I2CE_Dumper.php
  • Author: Carl Leitner <litlfred@ibiblio.org>

I2CE_Dumper @todo Better Documentation

Methods

cacheFileLocation()

  • Signature: static public function cacheFileLocation($prefix,$file_name,$locale,$headers,$file_loc,$cacheTime,$ttl)
  • Parameters:
  • $prefix
  • $file_name
  • $locale
  • $headers
  • $file_loc
  • $cacheTime
  • $ttl

dumpCacheFileLocation()

  • Signature: static public function dumpCacheFileLocation($prefix,$file_name)
  • Parameters:
  • $prefix
  • $file_name

dumpContents()

  • Signature: static public function dumpContents($file_loc,$headers,$cacheTime)
  • Parameters:
  • $file_loc
  • $headers
  • $cacheTime

dumpStaticURL()

  • Signature: static public function dumpStaticURL($key_prefix,$url_prefix)
  • Parameters:
  • $key_prefix
  • $url_prefix
      • Default Value: 'file'

prepForDump()

  • Signature: static public function prepForDump($file_mtime,$file_len,$headers,$cacheTime)
  • Parameters:
  • $file_mtime
  • $file_len
  • $headers
  • $cacheTime