Class: I2CE Dumper: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 1: Line 1:
This article describes the class ''I2CE_Dumper''.
This article describes the class ''I2CE_Dumper''.
*Location: Part of the module [[I2CE Module List#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE]
*Location: Part of the module [[I2CE Module List#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.1-release/annotate/head:/lib/I2CE_Dumper.php lib/I2CE_Dumper.php]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Dumper.php#L30 lib/I2CE_Dumper.php] on line 30
*Author: Carl Leitner <litlfred@ibiblio.org>
*Author: Carl Leitner <litlfred@ibiblio.org>
I2CE_Dumper  @todo Better Documentation
I2CE_Dumper  @todo Better Documentation
==Methods==
==Methods==
===cacheFileLocation()===
===cacheFileLocation()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Dumper.php#L32 i2ce/lib/I2CE_Dumper.php] on line 32
*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:
Line 16: Line 17:
**$ttl  
**$ttl  
===dumpCacheFileLocation()===
===dumpCacheFileLocation()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Dumper.php#L42 i2ce/lib/I2CE_Dumper.php] on line 42
*Signature: static public function dumpCacheFileLocation($prefix,$file_name)
*Signature: static public function dumpCacheFileLocation($prefix,$file_name)
*Parameters:
*Parameters:
Line 21: Line 23:
**$file_name  
**$file_name  
===dumpContents()===
===dumpContents()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Dumper.php#L126 i2ce/lib/I2CE_Dumper.php] on line 126
*Signature: static public function dumpContents($file_loc,$headers,$cacheTime)
*Signature: static public function dumpContents($file_loc,$headers,$cacheTime)
*Parameters:
*Parameters:
Line 27: Line 30:
**$cacheTime  
**$cacheTime  
===dumpStaticURL()===
===dumpStaticURL()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Dumper.php#L151 i2ce/lib/I2CE_Dumper.php] on line 151
*Signature: static public function dumpStaticURL($key_prefix,$url_prefix)
*Signature: static public function dumpStaticURL($key_prefix,$url_prefix)
*Parameters:
*Parameters:
Line 33: Line 37:
***Default Value: 'file'
***Default Value: 'file'
===prepForDump()===
===prepForDump()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Dumper.php#L65 i2ce/lib/I2CE_Dumper.php] on line 65
*Signature: static public function prepForDump($file_mtime,$file_len,$headers,$cacheTime)
*Signature: static public function prepForDump($file_mtime,$file_len,$headers,$cacheTime)
*Parameters:
*Parameters:

Revision as of 09:49, 10 November 2009

This article describes the class I2CE_Dumper.

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

I2CE_Dumper @todo Better Documentation

Methods

cacheFileLocation()

  • Defined in i2ce/lib/I2CE_Dumper.php on line 32
  • 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()

  • Defined in i2ce/lib/I2CE_Dumper.php on line 42
  • Signature: static public function dumpCacheFileLocation($prefix,$file_name)
  • Parameters:
    • $prefix
    • $file_name

dumpContents()

  • Defined in i2ce/lib/I2CE_Dumper.php on line 126
  • Signature: static public function dumpContents($file_loc,$headers,$cacheTime)
  • Parameters:
    • $file_loc
    • $headers
    • $cacheTime

dumpStaticURL()

  • Defined in i2ce/lib/I2CE_Dumper.php on line 151
  • Signature: static public function dumpStaticURL($key_prefix,$url_prefix)
  • Parameters:
    • $key_prefix
    • $url_prefix
      • Default Value: 'file'

prepForDump()

  • Defined in i2ce/lib/I2CE_Dumper.php on line 65
  • Signature: static public function prepForDump($file_mtime,$file_len,$headers,$cacheTime)
  • Parameters:
    • $file_mtime
    • $file_len
    • $headers
    • $cacheTime