Class: I2CE FileDump

This article describes the class I2CE_FileDump.

• Extends the class: I2CE_Page.
• Parent Classses: I2CE_Page I2CE_Fuzzy
• Location: Part of the module FileDump in the package I2CE
• Source: Defined in the file modules/Pages/modules/FileDump/I2CE_FileDump.php
• Author: Carl Leitner <litlfred@ibiblio.org>

class that will dump out a requested file that is found using a I2CE_FileSearch It recogonizes the following GET REQUEST Variables

• name -- (Required) the name the file
• cat -- (Required) the category of the file as registered with I2CE_FileSearch
• content -- (Optional) If set, it will be the content-type: for the header. It will overide the following options:
• ext -- (Optional) If set, it will be the extension used to determine the mime/type/content type for the file. Useful for misnamed files
• apdContent -- (Optional) A string to append to the content-type. Useful, for example, if it is a text file, somefile.txt, but you would like to specify the character set.

Variables

$default_categories

protected @var array $default_categories -- an array of default categories for file extensions.

• Type: protected $default_categories

Methods

__construct()

Constructor method.

• Signature: public function __construct($args,$request_remainder)
• Parameters:
  • $args
  • $request_remainder

display()

Handles GET requests for a file. The relevant get variables are:

• cat -- the I2CE_FileSearch category we should be looking for
• name -- the filename we are looking for

As an alternative (mainly b/c libxml's xmlSetProp (which is used by PHP's DOM) which will automatically escape &) you can set the variable encoded=ENC_BLAH where ENC_BLAH is an urlencoded string with the cat and name variables set e.g urlencode("cat=SCRIPTS&name=somescript.js")

• Signature: public function display()

doHeader()

Function to return the proper header type from a file's extension some of the code extracted gratefully from http://us3.php.net/manual/en/function.fread.php#72716 @param string $mime_type the files mime type. Defaults to null. Will be overidden if $ext is not empty

• Signature: public function doHeader($file,$ext,$content,$apdContent)
• Parameters:
  • string $file
    the files name
  • string $ext
    the files (possible forced) extension -- lower case. If null/empty it is not used.
  • $content
  • $apdContent
• Returns: array
  of string. the headers;

dump()

• Signature: protected function dump($vars)
• Parameters:
  • $vars

initializeTemplate()

Handles creating hte I2CE_TemplateMeister templates and loading any default templates

• Signature: protected function initializeTemplate()
• Returns: boolean
  true on success