Class: I2CE Page BinaryField: Difference between revisions

Revision as of 19:58, 16 October 2009

This article desrcibes the class I2CE_Page_BinaryFieldwhich extends the class I2CE_Page It is contained in the module BinField in the package I2CE The class is defined in the file: modules/Forms/modules/Binary_Files/lib/I2CE_Page_BinaryField.php @subpackage i2ce @author Carl Leitner <litlfred@ibiblio.org> @version v4.0.0 @since v4.0.0 @filesource Class I2CE_Page_BinaryField

@access public

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 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 desrcibes the class '''I2CE_Page_BinaryField'''which extends the class I2CE_Page
+This article desrcibes the class '''I2CE_Page_BinaryField'''which extends the class [[Class: I2CE_Page | I2CE_Page]]
 It is contained in the module [[iHRIS Module List#BinField|BinField]] in the package [https://launchpad.net/i2ce I2CE]
 The class is defined in the file: [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/files/head:modules/Forms/modules/Binary_Files/lib/I2CE_Page_BinaryField.php modules/Forms/modules/Binary_Files/lib/I2CE_Page_BinaryField.php]
@@ Line 25: / Line 25: @@
 *Signature: protected function initializeTemplate()
 *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean] true on success
+==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()===
@@ Line 142: / Line 187: @@
 ===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