Class: I2CE Page BinaryField: Difference between revisions

Revision as of 12:20, 19 October 2009

This article describes the class I2CE_Page_BinaryField.

Extends the class: I2CE_Page.
Location: Part of the module BinField in the package I2CE
Source: Defined in the file modules/Forms/modules/Binary_Files/lib/I2CE_Page_BinaryField.php
Author: Carl Leitner <litlfred@ibiblio.org>
Since: v4.0.0

@filesource Class I2CE_Page_BinaryField

Methods

display()

Handles GET requests for a binary field 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()

initializeTemplate()

Handles creating hte I2CE_TemplateMeister templates and loading any default templates

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

Inherited Methods

__construct()

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

_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()

@@ Line 1: / Line 1: @@
 This article describes the class ''I2CE_Page_BinaryField''.
 *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#BinField|BinField]] 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/Forms/modules/Binary_Files/lib/I2CE_Page_BinaryField.php modules/Forms/modules/Binary_Files/lib/I2CE_Page_BinaryField.php]
@@ Line 15: / Line 14: @@
 *Signature: protected function initializeTemplate()
 *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>true on success
+==Inherited Methods==
+===__construct()===
+This public method is inherited from [[Class: I2CE_Page#__construct() | I2CE_Page->__construct()]]
+===_flattenRequestVars()===
+This public method is inherited from [[Class: I2CE_Page#_flattenRequestVars() | I2CE_Page->_flattenRequestVars()]]
+===fixupRequestVariables()===
+This public method is inherited from [[Class: I2CE_Page#fixupRequestVariables() | I2CE_Page->fixupRequestVariables()]]
+===flattenRequestVars()===
+This public method is inherited from [[Class: I2CE_Page#flattenRequestVars() | I2CE_Page->flattenRequestVars()]]
+===get()===
+This public method is inherited from [[Class: I2CE_Page#get() | I2CE_Page->get()]]
+===getAccessedBaseURL()===
+This public method is inherited from [[Class: I2CE_Page#getAccessedBaseURL() | I2CE_Page->getAccessedBaseURL()]]
+===getTemplate()===
+This public method is inherited from [[Class: I2CE_Page#getTemplate() | I2CE_Page->getTemplate()]]
+===getUser()===
+This public method is inherited from [[Class: I2CE_Page#getUser() | I2CE_Page->getUser()]]
+===get_exists()===
+This public method is inherited from [[Class: I2CE_Page#get_exists() | I2CE_Page->get_exists()]]
+===hasPermission()===
+This public method is inherited from [[Class: I2CE_Page#hasPermission() | I2CE_Page->hasPermission()]]
+===isGet()===
+This public method is inherited from [[Class: I2CE_Page#isGet() | I2CE_Page->isGet()]]
+===isPost()===
+This public method is inherited from [[Class: I2CE_Page#isPost() | I2CE_Page->isPost()]]
+===module()===
+This public method is inherited from [[Class: I2CE_Page#module() | I2CE_Page->module()]]
+===page()===
+This public method is inherited from [[Class: I2CE_Page#page() | I2CE_Page->page()]]
+===pageRemainder()===
+This public method is inherited from [[Class: I2CE_Page#pageRemainder() | I2CE_Page->pageRemainder()]]
+===pageRoot()===
+This public method is inherited from [[Class: I2CE_Page#pageRoot() | I2CE_Page->pageRoot()]]
+===post()===
+This public method is inherited from [[Class: I2CE_Page#post() | I2CE_Page->post()]]
+===post_exists()===
+This public method is inherited from [[Class: I2CE_Page#post_exists() | I2CE_Page->post_exists()]]
+===redirect()===
+This public method is inherited from [[Class: I2CE_Page#redirect() | I2CE_Page->redirect()]]
+===request()===
+This public method is inherited from [[Class: I2CE_Page#request() | I2CE_Page->request()]]
+===request_exists()===
+This public method is inherited from [[Class: I2CE_Page#request_exists() | I2CE_Page->request_exists()]]
+===rewrittenURLs()===
+This public method is inherited from [[Class: I2CE_Page#rewrittenURLs() | I2CE_Page->rewrittenURLs()]]
+===session_req()===
+This public method is inherited from [[Class: I2CE_Page#session_req() | I2CE_Page->session_req()]]
+===session_req_exists()===
+This public method is inherited from [[Class: I2CE_Page#session_req_exists() | I2CE_Page->session_req_exists()]]
+===setAccess()===
+This public method is inherited from [[Class: I2CE_Page#setAccess() | I2CE_Page->setAccess()]]
+===setIsPost()===
+This public method is inherited from [[Class: I2CE_Page#setIsPost() | I2CE_Page->setIsPost()]]
+===setRedirect()===
+This public method is inherited from [[Class: I2CE_Page#setRedirect() | I2CE_Page->setRedirect()]]
+===_display()===
+This protected method is inherited from [[Class: I2CE_Page#_display() | I2CE_Page->_display()]]
+===action()===
+This protected method is inherited from [[Class: I2CE_Page#action() | I2CE_Page->action()]]
+===actionCommandLine()===
+This protected method is inherited from [[Class: I2CE_Page#actionCommandLine() | I2CE_Page->actionCommandLine()]]
+===getAccess()===
+This protected method is inherited from [[Class: I2CE_Page#getAccess() | I2CE_Page->getAccess()]]
+===getTitle()===
+This protected method is inherited from [[Class: I2CE_Page#getTitle() | I2CE_Page->getTitle()]]
+===loadHTMLTemplates()===
+This protected method is inherited from [[Class: I2CE_Page#loadHTMLTemplates() | I2CE_Page->loadHTMLTemplates()]]
+===setupGetPost()===
+This protected method is inherited from [[Class: I2CE_Page#setupGetPost() | I2CE_Page->setupGetPost()]]
+===_hasMethod()===
+This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
+==Inherited Variables==
+===$template===
+Theis protected variable is inherited from [[Class: I2CE_Page#$template | I2CE_Page->$template]]
+===$defaultHTMLFile===
+Theis protected variable is inherited from [[Class: I2CE_Page#$defaultHTMLFile | I2CE_Page->$defaultHTMLFile]]
+===$role===
+Theis protected variable is inherited from [[Class: I2CE_Page#$role | I2CE_Page->$role]]
+===$user===
+Theis protected variable is inherited from [[Class: I2CE_Page#$user | I2CE_Page->$user]]
+===$post===
+Theis protected variable is inherited from [[Class: I2CE_Page#$post | I2CE_Page->$post]]
+===$get===
+Theis protected variable is inherited from [[Class: I2CE_Page#$get | I2CE_Page->$get]]
+===$page_root===
+Theis protected variable is inherited from [[Class: I2CE_Page#$page_root | I2CE_Page->$page_root]]
+===$page_remainder===
+Theis protected variable is inherited from [[Class: I2CE_Page#$page_remainder | I2CE_Page->$page_remainder]]
+===$args===
+Theis protected variable is inherited from [[Class: I2CE_Page#$args | I2CE_Page->$args]]
+===$request_remainder===
+Theis protected variable is inherited from [[Class: I2CE_Page#$request_remainder | I2CE_Page->$request_remainder]]
+===$permissionParser===
+Theis protected variable is inherited from [[Class: I2CE_Page#$permissionParser | I2CE_Page->$permissionParser]]
+===$page===
+Theis protected variable is inherited from [[Class: I2CE_Page#$page | I2CE_Page->$page]]
+===$module===
+Theis protected variable is inherited from [[Class: I2CE_Page#$module | I2CE_Page->$module]]
+===$is_post===
+Theis protected variable is inherited from [[Class: I2CE_Page#$is_post | I2CE_Page->$is_post]]
+===$session_req===
+Theis protected variable is inherited from [[Class: I2CE_Page#$session_req | I2CE_Page->$session_req]]
+==Inherited Fuzzy Methods==
+===launchBackgroundProcess()===
+This method is inherited from [[Class: I2CE_Page#launchBackgroundProcess() | I2CE_Page->launchBackgroundProcess()]]
+===launchBackgroundPHPScript()===
+This method is inherited from [[Class: I2CE_Page#launchBackgroundPHPScript() | I2CE_Page->launchBackgroundPHPScript()]]
+===launchBackgroundPage()===
+This method is inherited from [[Class: I2CE_Page#launchBackgroundPage() | I2CE_Page->launchBackgroundPage()]]
+===addColorPickerTriple()===
+This method is inherited from [[Class: I2CE_Page#addColorPickerTriple() | I2CE_Page->addColorPickerTriple()]]
+===selectOptionsImmediate()===
+This method is inherited from [[Class: I2CE_Page#selectOptionsImmediate() | I2CE_Page->selectOptionsImmediate()]]
+===setDisplayData()===
+This method is inherited from [[Class: I2CE_Page#setDisplayData() | I2CE_Page->setDisplayData()]]
+===setDisplayDataImmediate()===
+This method is inherited from [[Class: I2CE_Page#setDisplayDataImmediate() | I2CE_Page->setDisplayDataImmediate()]]
+===addFormWorm()===
+This method is inherited from [[Class: I2CE_Page#addFormWorm() | I2CE_Page->addFormWorm()]]
+===getClassValue()===
+This method is inherited from [[Class: I2CE_Page#getClassValue() | I2CE_Page->getClassValue()]]
+===loadClassValues()===
+This method is inherited from [[Class: I2CE_Page#loadClassValues() | I2CE_Page->loadClassValues()]]
+===setClassValue()===
+This method is inherited from [[Class: I2CE_Page#setClassValue() | I2CE_Page->setClassValue()]]
+===setClassValues()===
+This method is inherited from [[Class: I2CE_Page#setClassValues() | I2CE_Page->setClassValues()]]
+===addOption()===
+This method is inherited from [[Class: I2CE_Page#addOption() | I2CE_Page->addOption()]]
+===addOptions()===
+This method is inherited from [[Class: I2CE_Page#addOptions() | I2CE_Page->addOptions()]]
+===addAutoCompleteInputTreeById()===
+This method is inherited from [[Class: I2CE_Page#addAutoCompleteInputTreeById() | I2CE_Page->addAutoCompleteInputTreeById()]]
+===addAutoCompleteInputTree()===
+This method is inherited from [[Class: I2CE_Page#addAutoCompleteInputTree() | I2CE_Page->addAutoCompleteInputTree()]]
+===setForm()===
+This method is inherited from [[Class: I2CE_Page#setForm() | I2CE_Page->setForm()]]
+===getField()===
+This method is inherited from [[Class: I2CE_Page#getField() | I2CE_Page->getField()]]
+===setReview()===
+This method is inherited from [[Class: I2CE_Page#setReview() | I2CE_Page->setReview()]]
+===isReview()===
+This method is inherited from [[Class: I2CE_Page#isReview() | I2CE_Page->isReview()]]
+===setShowForm()===
+This method is inherited from [[Class: I2CE_Page#setShowForm() | I2CE_Page->setShowForm()]]
+===showForm()===
+This method is inherited from [[Class: I2CE_Page#showForm() | I2CE_Page->showForm()]]
+===makeJumper()===
+This method is inherited from [[Class: I2CE_Page#makeJumper() | I2CE_Page->makeJumper()]]
+===menuSelect()===
+This method is inherited from [[Class: I2CE_Page#menuSelect() | I2CE_Page->menuSelect()]]
+===addUpdateSelect()===
+This method is inherited from [[Class: I2CE_Page#addUpdateSelect() | I2CE_Page->addUpdateSelect()]]
+===addAjaxUpdate()===
+This method is inherited from [[Class: I2CE_Page#addAjaxUpdate() | I2CE_Page->addAjaxUpdate()]]
+===addAjaxToggle()===
+This method is inherited from [[Class: I2CE_Page#addAjaxToggle() | I2CE_Page->addAjaxToggle()]]
+===addAjaxRequestFunction()===
+This method is inherited from [[Class: I2CE_Page#addAjaxRequestFunction() | I2CE_Page->addAjaxRequestFunction()]]
+===addAjaxCompleteFunction()===
+This method is inherited from [[Class: I2CE_Page#addAjaxCompleteFunction() | I2CE_Page->addAjaxCompleteFunction()]]
+===addAjaxToggleOnFunction()===
+This method is inherited from [[Class: I2CE_Page#addAjaxToggleOnFunction() | I2CE_Page->addAjaxToggleOnFunction()]]
+===addAjaxToggleOffFunction()===
+This method is inherited from [[Class: I2CE_Page#addAjaxToggleOffFunction() | I2CE_Page->addAjaxToggleOffFunction()]]
+===hasAjax()===
+This method is inherited from [[Class: I2CE_Page#hasAjax() | I2CE_Page->hasAjax()]]
+===setDataTypePriority()===
+This method is inherited from [[Class: I2CE_Page#setDataTypePriority() | I2CE_Page->setDataTypePriority()]]
+===setData()===
+This method is inherited from [[Class: I2CE_Page#setData() | I2CE_Page->setData()]]
+===getData()===
+This method is inherited from [[Class: I2CE_Page#getData() | I2CE_Page->getData()]]
+===getDefaultData()===
+This method is inherited from [[Class: I2CE_Page#getDefaultData() | I2CE_Page->getDefaultData()]]
+===removeData()===
+This method is inherited from [[Class: I2CE_Page#removeData() | I2CE_Page->removeData()]]
+===getDataNames()===
+This method is inherited from [[Class: I2CE_Page#getDataNames() | I2CE_Page->getDataNames()]]
+===ensureNode()===
+This method is inherited from [[Class: I2CE_Page#ensureNode() | I2CE_Page->ensureNode()]]
+===userMessage()===
+This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
 [[Category:Class Documentation]]

Anonymous

Search