Class: I2CE Page BinaryField (Development): Difference between revisions

Latest revision as of 08:17, 6 May 2015

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

This article describes the class I2CE_Page_BinaryField .

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

@filesource Class I2CE_Page_BinaryField

Methods

actionCommandLine()

Perform some command line options for the BinField page

Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_Page_BinaryField.php on line 52
Signature: public function actionCommandLine($args,$request_remainder)
Parameters:
- array $args
- array $request_remainder

displayWeb()

Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_Page_BinaryField.php on line 270
Signature: public function displayWeb($supress_output)
Parameters:
- $supress_output
  - Default Value: false

initializeTemplate()

Handles creating hte I2CE_TemplateMeister templates and loading any default templates

Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_Page_BinaryField.php on line 40
Signature: protected function initializeTemplate()
Returns: boolean
true on success

processBlob()

Defined in i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_Page_BinaryField.php on line 246
Signature: static public function processBlob($value)
Parameters:
- $value

Inherited Methods

__construct()

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

_flattenRequestVars()

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

display()

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

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

getTitle()

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

getURLRoot()

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

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

displayCommandLine()

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

getAccess()

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

initPage()

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

loadHTMLTemplates()

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

setActiveMenu()

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

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

$redirect

Theis protected variable is inherited from I2CE_Page->$redirect

$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

$root_url

Theis protected variable is inherited from I2CE_Page->$root_url

$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

addDatePicker()

This method is inherited from I2CE_Page->addDatePicker()

selectOptionsImmediate()

This method is inherited from I2CE_Page->selectOptionsImmediate()

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

useDropDown()

This method is inherited from I2CE_Page->useDropDown()

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

getForm()

This method is inherited from I2CE_Page->getForm()

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

makeJumper()

This method is inherited from I2CE_Page->makeJumper()

makeScalingJumper()

This method is inherited from I2CE_Page->makeScalingJumper()

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

addAjaxLoad()

This method is inherited from I2CE_Page->addAjaxLoad()

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 2: / Line 2: @@
 This article describes the class ''I2CE_Page_BinaryField'' .
 *Extends the class: [[Class: I2CE_Page (Development) | I2CE_Page]].
-*Location: Part of the module [[I2CE Module List (Development)#BinField|BinField]] in the package [https://launchpad.net/i2ce I2CE] 4.0-dev
+*Location: Part of the module [[I2CE Module List (Development)#BinField|BinField]] in the package [https://launchpad.net/i2ce I2CE] 4.1-dev
-*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Binary_Files/lib/I2CE_Page_BinaryField.php#L33 modules/Forms/modules/Binary_Files/lib/I2CE_Page_BinaryField.php] on line 33
+*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Binary_Files/lib/I2CE_Page_BinaryField.php#L33 modules/Forms/modules/Binary_Files/lib/I2CE_Page_BinaryField.php] on line 33
 *Author: Carl Leitner <litlfred@ibiblio.org>
 *Since: v4.0.0
 @filesource Class I2CE_Page_BinaryField
 ==Methods==
-===display()===
+===actionCommandLine()===
-Handles GET requests for a binary field 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")
+Perform some command line options for the BinField page
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Binary_Files/lib/I2CE_Page_BinaryField.php#L59 i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_Page_BinaryField.php] on line 59
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Binary_Files/lib/I2CE_Page_BinaryField.php#L52 i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_Page_BinaryField.php] on line 52
-*Signature: public function display()
+*Signature: public function actionCommandLine($args,$request_remainder)
+*Parameters:
+** [http://www.php.net/manual/en/language.types.array.php array ] $args
+** [http://www.php.net/manual/en/language.types.array.php array ] $request_remainder
+===displayWeb()===
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Binary_Files/lib/I2CE_Page_BinaryField.php#L270 i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_Page_BinaryField.php] on line 270
+*Signature: public function displayWeb($supress_output)
+*Parameters:
+**$supress_output
+***Default Value: false
 ===initializeTemplate()===
 Handles creating hte I2CE_TemplateMeister templates and loading any default templates
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Binary_Files/lib/I2CE_Page_BinaryField.php#L40 i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_Page_BinaryField.php] on line 40
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Binary_Files/lib/I2CE_Page_BinaryField.php#L40 i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_Page_BinaryField.php] on line 40
 *Signature: protected function initializeTemplate()
 *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>true on success
+===processBlob()===
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Binary_Files/lib/I2CE_Page_BinaryField.php#L246 i2ce/modules/Forms/modules/Binary_Files/lib/I2CE_Page_BinaryField.php] on line 246
+*Signature: static public function processBlob($value)
+*Parameters:
+**$value
 ==Inherited Methods==
 ===__construct()===
@@ Line 23: / Line 37: @@
 ===_flattenRequestVars()===
 This public method is inherited from [[Class: I2CE_Page (Development)#_flattenRequestVars() | I2CE_Page->_flattenRequestVars()]]
+===display()===
+This public method is inherited from [[Class: I2CE_Page (Development)#display() | I2CE_Page->display()]]
 ===fixupRequestVariables()===
@@ Line 38: / Line 55: @@
 ===getTemplate()===
 This public method is inherited from [[Class: I2CE_Page (Development)#getTemplate() | I2CE_Page->getTemplate()]]
+===getTitle()===
+This public method is inherited from [[Class: I2CE_Page (Development)#getTitle() | I2CE_Page->getTitle()]]
+===getURLRoot()===
+This public method is inherited from [[Class: I2CE_Page (Development)#getURLRoot() | I2CE_Page->getURLRoot()]]
 ===getUser()===
@@ Line 105: / Line 128: @@
 This protected method is inherited from [[Class: I2CE_Page (Development)#action() | I2CE_Page->action()]]
-===actionCommandLine()===
+===displayCommandLine()===
-This protected method is inherited from [[Class: I2CE_Page (Development)#actionCommandLine() | I2CE_Page->actionCommandLine()]]
+This protected method is inherited from [[Class: I2CE_Page (Development)#displayCommandLine() | I2CE_Page->displayCommandLine()]]
 ===getAccess()===
 This protected method is inherited from [[Class: I2CE_Page (Development)#getAccess() | I2CE_Page->getAccess()]]
-===getTitle()===
+===initPage()===
-This protected method is inherited from [[Class: I2CE_Page (Development)#getTitle() | I2CE_Page->getTitle()]]
+This protected method is inherited from [[Class: I2CE_Page (Development)#initPage() | I2CE_Page->initPage()]]
 ===loadHTMLTemplates()===
 This protected method is inherited from [[Class: I2CE_Page (Development)#loadHTMLTemplates() | I2CE_Page->loadHTMLTemplates()]]
+===setActiveMenu()===
+This protected method is inherited from [[Class: I2CE_Page (Development)#setActiveMenu() | I2CE_Page->setActiveMenu()]]
 ===setupGetPost()===
@@ Line 134: / Line 160: @@
 ===$user===
 Theis protected variable is inherited from [[Class: I2CE_Page (Development)#$user | I2CE_Page->$user]]
+===$redirect===
+Theis protected variable is inherited from [[Class: I2CE_Page (Development)#$redirect | I2CE_Page->$redirect]]
 ===$post===
@@ Line 155: / Line 184: @@
 ===$permissionParser===
 Theis protected variable is inherited from [[Class: I2CE_Page (Development)#$permissionParser | I2CE_Page->$permissionParser]]
+===$root_url===
+Theis protected variable is inherited from [[Class: I2CE_Page (Development)#$root_url | I2CE_Page->$root_url]]
 ===$page===
@@ Line 179: / Line 211: @@
 ===addColorPickerTriple()===
 This method is inherited from [[Class: I2CE_Page (Development)#addColorPickerTriple() | I2CE_Page->addColorPickerTriple()]]
+===addReportSelector()===
+This method is inherited from [[Class: I2CE_Page (Development)#addReportSelector() | I2CE_Page->addReportSelector()]]
+===addDatePicker()===
+This method is inherited from [[Class: I2CE_Page (Development)#addDatePicker() | I2CE_Page->addDatePicker()]]
 ===selectOptionsImmediate()===
@@ Line 203: / Line 241: @@
 ===setClassValues()===
 This method is inherited from [[Class: I2CE_Page (Development)#setClassValues() | I2CE_Page->setClassValues()]]
+===useDropDown()===
+This method is inherited from [[Class: I2CE_Page (Development)#useDropDown() | I2CE_Page->useDropDown()]]
 ===addOption()===
@@ Line 218: / Line 259: @@
 ===setForm()===
 This method is inherited from [[Class: I2CE_Page (Development)#setForm() | I2CE_Page->setForm()]]
+===getForm()===
+This method is inherited from [[Class: I2CE_Page (Development)#getForm() | I2CE_Page->getForm()]]
 ===getField()===
@@ Line 227: / Line 271: @@
 ===isReview()===
 This method is inherited from [[Class: I2CE_Page (Development)#isReview() | I2CE_Page->isReview()]]
-===setShowForm()===
-This method is inherited from [[Class: I2CE_Page (Development)#setShowForm() | I2CE_Page->setShowForm()]]
-===showForm()===
-This method is inherited from [[Class: I2CE_Page (Development)#showForm() | I2CE_Page->showForm()]]
 ===makeJumper()===
 This method is inherited from [[Class: I2CE_Page (Development)#makeJumper() | I2CE_Page->makeJumper()]]
+===makeScalingJumper()===
+This method is inherited from [[Class: I2CE_Page (Development)#makeScalingJumper() | I2CE_Page->makeScalingJumper()]]
 ===menuSelect()===
@@ Line 245: / Line 286: @@
 ===addAjaxUpdate()===
 This method is inherited from [[Class: I2CE_Page (Development)#addAjaxUpdate() | I2CE_Page->addAjaxUpdate()]]
+===addAjaxLoad()===
+This method is inherited from [[Class: I2CE_Page (Development)#addAjaxLoad() | I2CE_Page->addAjaxLoad()]]
 ===addAjaxToggle()===

Anonymous

Search