Class: I2CE FileDump (4.0.2)

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

For other versions, see Class: I2CE_FileDump (versions) .

This article describes the class I2CE_FileDump .

Extends the class: I2CE_Page.
Location: Part of the module FileDump in the package I2CE 4.0.2-release
Source: Defined in the file modules/Pages/modules/FileDump/I2CE_FileDump.php on line 43
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.

Defined in i2ce/modules/Pages/modules/FileDump/I2CE_FileDump.php on line 48
Type: protected $default_categories

Methods

__construct()

Constructor method.

Defined in i2ce/modules/Pages/modules/FileDump/I2CE_FileDump.php on line 54
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")

Defined in i2ce/modules/Pages/modules/FileDump/I2CE_FileDump.php on line 129
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

Defined in i2ce/modules/Pages/modules/FileDump/I2CE_FileDump.php on line 98
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()

Defined in i2ce/modules/Pages/modules/FileDump/I2CE_FileDump.php on line 158
Signature: protected function dump($vars)
Parameters:
- $vars

initializeTemplate()

Handles creating hte I2CE_TemplateMeister templates and loading any default templates

Defined in i2ce/modules/Pages/modules/FileDump/I2CE_FileDump.php on line 81
Signature: protected function initializeTemplate()
Returns: boolean
true on success

Inherited Methods

_flattenRequestVars()

This public method is inherited from I2CE_Page->_flattenRequestVars()

fixupRequestVariables()

This public method is inherited from I2CE_Page->fixupRequestVariables()

flattenRequestVars()

This public method is inherited from I2CE_Page->flattenRequestVars()

get()

This public method is inherited from I2CE_Page->get()

getAccessedBaseURL()

This public method is inherited from I2CE_Page->getAccessedBaseURL()

getTemplate()

This public method is inherited from I2CE_Page->getTemplate()

getUser()

This public method is inherited from I2CE_Page->getUser()

get_exists()

This public method is inherited from I2CE_Page->get_exists()

hasPermission()

This public method is inherited from I2CE_Page->hasPermission()

isGet()

This public method is inherited from I2CE_Page->isGet()

isPost()

This public method is inherited from I2CE_Page->isPost()

module()

This public method is inherited from I2CE_Page->module()

page()

This public method is inherited from I2CE_Page->page()

pageRemainder()

This public method is inherited from I2CE_Page->pageRemainder()

pageRoot()

This public method is inherited from I2CE_Page->pageRoot()

post()

This public method is inherited from I2CE_Page->post()

post_exists()

This public method is inherited from I2CE_Page->post_exists()

redirect()

This public method is inherited from I2CE_Page->redirect()

request()

This public method is inherited from I2CE_Page->request()

request_exists()

This public method is inherited from I2CE_Page->request_exists()

rewrittenURLs()

This public method is inherited from I2CE_Page->rewrittenURLs()

session_req()

This public method is inherited from I2CE_Page->session_req()

session_req_exists()

This public method is inherited from I2CE_Page->session_req_exists()

setAccess()

This public method is inherited from I2CE_Page->setAccess()

setIsPost()

This public method is inherited from I2CE_Page->setIsPost()

setRedirect()

This public method is inherited from I2CE_Page->setRedirect()

_display()

This protected method is inherited from I2CE_Page->_display()

action()

This protected method is inherited from I2CE_Page->action()

actionCommandLine()

This protected method is inherited from I2CE_Page->actionCommandLine()

getAccess()

This protected method is inherited from I2CE_Page->getAccess()

getTitle()

This protected method is inherited from I2CE_Page->getTitle()

loadHTMLTemplates()

This protected method is inherited from I2CE_Page->loadHTMLTemplates()

setupGetPost()

This protected method is inherited from I2CE_Page->setupGetPost()

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

Inherited Variables

$template

Theis protected variable is inherited from I2CE_Page->$template

$defaultHTMLFile

Theis protected variable is inherited from I2CE_Page->$defaultHTMLFile

$role

Theis protected variable is inherited from I2CE_Page->$role

$user

Theis protected variable is inherited from I2CE_Page->$user

$post

Theis protected variable is inherited from I2CE_Page->$post

$get

Theis protected variable is inherited from I2CE_Page->$get

$page_root

Theis protected variable is inherited from I2CE_Page->$page_root

$page_remainder

Theis protected variable is inherited from I2CE_Page->$page_remainder

$args

Theis protected variable is inherited from I2CE_Page->$args

$request_remainder

Theis protected variable is inherited from I2CE_Page->$request_remainder

$permissionParser

Theis protected variable is inherited from I2CE_Page->$permissionParser

$page

Theis protected variable is inherited from I2CE_Page->$page

$module

Theis protected variable is inherited from I2CE_Page->$module

$is_post

Theis protected variable is inherited from I2CE_Page->$is_post

$session_req

Theis protected variable is inherited from I2CE_Page->$session_req

Inherited Fuzzy Methods

setDisplayData()

This method is inherited from I2CE_Page->setDisplayData()

setDisplayDataImmediate()

This method is inherited from I2CE_Page->setDisplayDataImmediate()

addFormWorm()

This method is inherited from I2CE_Page->addFormWorm()

getClassValue()

This method is inherited from I2CE_Page->getClassValue()

loadClassValues()

This method is inherited from I2CE_Page->loadClassValues()

setClassValue()

This method is inherited from I2CE_Page->setClassValue()

setClassValues()

This method is inherited from I2CE_Page->setClassValues()

addOption()

This method is inherited from I2CE_Page->addOption()

addOptions()

This method is inherited from I2CE_Page->addOptions()

addAutoCompleteInputTreeById()

This method is inherited from I2CE_Page->addAutoCompleteInputTreeById()

addAutoCompleteInputTree()

This method is inherited from I2CE_Page->addAutoCompleteInputTree()

setForm()

This method is inherited from I2CE_Page->setForm()

getField()

This method is inherited from I2CE_Page->getField()

setReview()

This method is inherited from I2CE_Page->setReview()

isReview()

This method is inherited from I2CE_Page->isReview()

setShowForm()

This method is inherited from I2CE_Page->setShowForm()

showForm()

This method is inherited from I2CE_Page->showForm()

makeJumper()

This method is inherited from I2CE_Page->makeJumper()

menuSelect()

This method is inherited from I2CE_Page->menuSelect()

addUpdateSelect()

This method is inherited from I2CE_Page->addUpdateSelect()

addAjaxUpdate()

This method is inherited from I2CE_Page->addAjaxUpdate()

addAjaxToggle()

This method is inherited from I2CE_Page->addAjaxToggle()

addAjaxRequestFunction()

This method is inherited from I2CE_Page->addAjaxRequestFunction()

addAjaxCompleteFunction()

This method is inherited from I2CE_Page->addAjaxCompleteFunction()

addAjaxToggleOnFunction()

This method is inherited from I2CE_Page->addAjaxToggleOnFunction()

addAjaxToggleOffFunction()

This method is inherited from I2CE_Page->addAjaxToggleOffFunction()

hasAjax()

This method is inherited from I2CE_Page->hasAjax()

setDataTypePriority()

This method is inherited from I2CE_Page->setDataTypePriority()

setData()

This method is inherited from I2CE_Page->setData()

getData()

This method is inherited from I2CE_Page->getData()

getDefaultData()

This method is inherited from I2CE_Page->getDefaultData()

removeData()

This method is inherited from I2CE_Page->removeData()

getDataNames()

This method is inherited from I2CE_Page->getDataNames()

ensureNode()

This method is inherited from I2CE_Page->ensureNode()

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()

Anonymous

Search