|
|
| (16 intermediate revisions by one other user not shown) |
| Line 1: |
Line 1: |
| This article describes the class ''I2CE_FileDump''.
| | #REDIRECT [[Class: I2CE_FileDump (4.1.12)]] |
| *Extends the class: [[Class: I2CE_Page | I2CE_Page]].
| |
| *Parent Classses: [[Class: I2CE_Page | I2CE_Page]] [[Class: I2CE_Fuzzy | I2CE_Fuzzy]]
| |
| *Location: Part of the module [[I2CE Module List#FileDump|FileDump]] in the package [https://launchpad.net/i2ce I2CE]
| |
| *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/modules/Pages/modules/FileDump/I2CE_FileDump.php 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 <ul> <li>name -- (Required) the name the file </li> <li>cat -- (Required) the category of the file as registered with I2CE_FileSearch</li> <li>content -- (Optional) If set, it will be the content-type: for the header. It will overide the following options: </li> <li>ext -- (Optional) If set, it will be the extension used to determine the mime/type/content type for the file. Useful for misnamed files</li> <li>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.</li> </ul>
| |
| ==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: <ul><li> cat -- the I2CE_FileSearch category we should be looking for</li> <li> name -- the filename we are looking for</li> </ul> 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 file''s mime type. Defaults to null. Will be overidden if $ext is not empty
| |
| *Signature: public function doHeader($file,$ext,$content,$apdContent)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $file <br/>the file''s name
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $ext <br/>the file''s (possible forced) extension -- lower case. If null/empty it is not used.
| |
| **$content
| |
| **$apdContent
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>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: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>true on success
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
