|
|
| (12 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| This article describes the class ''I2CE_Page''.
| | #REDIRECT [[Class: I2CE_Page (4.1.7)]] |
| *Extends the class: [[Class: I2CE_Fuzzy | I2CE_Fuzzy]].
| |
| *Child Classes:
| |
| ** [[Class: I2CE_Page_BackgroundProcess | I2CE_Page_BackgroundProcess]]
| |
| ** [[Class: I2CE_Page_Run_SQL | I2CE_Page_Run_SQL]]
| |
| ** [[Class: I2CE_Page_BinaryField | I2CE_Page_BinaryField]]
| |
| ** [[Class: I2CE_Page_CachedForm | I2CE_Page_CachedForm]]
| |
| ** [[Class: I2CE_Page_CustomReports | I2CE_Page_CustomReports]]
| |
| ** [[Class: I2CE_FileDump | I2CE_FileDump]]
| |
| ** [[Class: I2CE_PageViewList | I2CE_PageViewList]]
| |
| *** [[Class: iHRIS_PageViewList | iHRIS_PageViewList]]
| |
| **** [[Class: iHRIS_PageViewListQualify | iHRIS_PageViewListQualify]]
| |
| ** [[Class: I2CE_PageFeedback | I2CE_PageFeedback]]
| |
| ** [[Class: I2CE_PageForgot | I2CE_PageForgot]]
| |
| ** [[Class: I2CE_PageLogin | I2CE_PageLogin]]
| |
| ** [[Class: I2CE_PageLogout | I2CE_PageLogout]]
| |
| ** [[Class: I2CE_PagePassword | I2CE_PagePassword]]
| |
| ** [[Class: iHRIS_PageView | iHRIS_PageView]]
| |
| ** [[Class: I2CE_PageAdmin | I2CE_PageAdmin]]
| |
| ** [[Class: I2CE_PageFormBrowser | I2CE_PageFormBrowser]]
| |
| ** [[Class: I2Ce_Page_FormDocumentor | I2Ce_Page_FormDocumentor]]
| |
| ** [[Class: I2CE_PageForm | I2CE_PageForm]]
| |
| *** [[Class: I2CE_PageFormLists | I2CE_PageFormLists]]
| |
| **** [[Class: iHRIS_PageFormLists | iHRIS_PageFormLists]]
| |
| *** [[Class: iHRIS_PageFormParentPerson | iHRIS_PageFormParentPerson]]
| |
| **** [[Class: iHRIS_PageFormContact | iHRIS_PageFormContact]]
| |
| **** [[Class: iHRIS_PageFormDeparture | iHRIS_PageFormDeparture]]
| |
| **** [[Class: iHRIS_PageFormMakeOffer | iHRIS_PageFormMakeOffer]]
| |
| **** [[Class: iHRIS_PageFormGraduate | iHRIS_PageFormGraduate]]
| |
| *** [[Class: iHRIS_PageFormPerson | iHRIS_PageFormPerson]]
| |
| **** [[Class: iHRIS_PageFormPersonManage | iHRIS_PageFormPersonManage]]
| |
| **** [[Class: iHRIS_PageFormPersonQualify | iHRIS_PageFormPersonQualify]]
| |
| *** [[Class: I2CE_PageFormUser | I2CE_PageFormUser]]
| |
| **** [[Class: iHRIS_PageFormUser | iHRIS_PageFormUser]]
| |
| *** [[Class: iHRIS_PageFormSalary | iHRIS_PageFormSalary]]
| |
| *** [[Class: iHRIS_PageFormFacilityInstitution | iHRIS_PageFormFacilityInstitution]]
| |
| *** [[Class: iHRIS_PageFormParentTraining | iHRIS_PageFormParentTraining]]
| |
| **** [[Class: iHRIS_PageFormDisciplinaryAction | iHRIS_PageFormDisciplinaryAction]]
| |
| **** [[Class: iHRIS_PageFormDisciplinaryReinstate | iHRIS_PageFormDisciplinaryReinstate]]
| |
| **** [[Class: iHRIS_PageFormLicense | iHRIS_PageFormLicense]]
| |
| **** [[Class: iHRIS_PageFormRenew | iHRIS_PageFormRenew]]
| |
| **** [[Class: iHRIS_PageFormTrainingDisrupt | iHRIS_PageFormTrainingDisrupt]]
| |
| **** [[Class: iHRIS_PageFormTrainingResume | iHRIS_PageFormTrainingResume]]
| |
| *** [[Class: iHRIS_PageFormTrainingProgram | iHRIS_PageFormTrainingProgram]]
| |
| *** [[Class: iHRIS_PageForm_Person_Scheduled_Training_Course | iHRIS_PageForm_Person_Scheduled_Training_Course]]
| |
| *** [[Class: iHRIS_PageFormParentTrainingInstitution | iHRIS_PageFormParentTrainingInstitution]]
| |
| *** [[Class: iHRIS_PageForm_Evaluate_Course_Competencies | iHRIS_PageForm_Evaluate_Course_Competencies]]
| |
| ** [[Class: iHRIS_PageConfigure | iHRIS_PageConfigure]]
| |
| ** [[Class: iHRIS_PageFieldHistory | iHRIS_PageFieldHistory]]
| |
| ** [[Class: iHRIS_PageHistory | iHRIS_PageHistory]]
| |
| *** [[Class: iHRIS_PageHistoryQualify | iHRIS_PageHistoryQualify]]
| |
| ** [[Class: iHRIS_PageIndex | iHRIS_PageIndex]]
| |
| ** [[Class: iHRIS_PageManage | iHRIS_PageManage]]
| |
| ** [[Class: iHRIS_PageSearch | iHRIS_PageSearch]]
| |
| ** [[Class: iHRIS_PageViewJob | iHRIS_PageViewJob]]
| |
| ** [[Class: iHRIS_PageViewPosition | iHRIS_PageViewPosition]]
| |
| ** [[Class: iHRIS_SalaryHistoryPage | iHRIS_SalaryHistoryPage]]
| |
| ** [[Class: iHRIS_PageViewTraining | iHRIS_PageViewTraining]]
| |
| ** [[Class: I2CE_Page_LocaleAdmin | I2CE_Page_LocaleAdmin]]
| |
| ** [[Class: I2CE_Page_MagicDataBrowser | I2CE_Page_MagicDataBrowser]]
| |
| ** [[Class: I2CE_Page_MagicDataExport | I2CE_Page_MagicDataExport]]
| |
| *** [[Class: I2CE_Page_Report_MagicDataExport | I2CE_Page_Report_MagicDataExport]]
| |
| ** [[Class: I2Ce_Page_ModDocumentor | I2Ce_Page_ModDocumentor]]
| |
| ** [[Class: iHRIS_Page_Person_Competency_Evaluation_History | iHRIS_Page_Person_Competency_Evaluation_History]]
| |
| ** [[Class: I2CE_Page_Stub | I2CE_Page_Stub]]
| |
| ** [[Class: I2CE_Page_Stub_Ajax_Test | I2CE_Page_Stub_Ajax_Test]]
| |
| ** [[Class: I2CE_Page_SwissConfig | I2CE_Page_SwissConfig]]
| |
| ** [[Class: I2CE_Page_SwissMagic | I2CE_Page_SwissMagic]]
| |
| ** [[Class: I2CE_Page_TasksAndRoles | I2CE_Page_TasksAndRoles]]
| |
| *Location: Part of the module [[I2CE Module List#pages|pages]] in the package [https://launchpad.net/i2ce I2CE]
| |
| *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L37 modules/Pages/lib/I2CE_Page.php] on line 37
| |
| ==Variables==
| |
| ===$template===
| |
| The template object for handling the HTML templates and data to be displayed.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L42 i2ce/modules/Pages/lib/I2CE_Page.php] on line 42
| |
| *Type: protected [[Class: I2CE_Template | I2CE_Template]] $template
| |
| | |
| ===$defaultHTMLFile===
| |
| The default HTML/XML files to be displayed by the template. of string
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L47 i2ce/modules/Pages/lib/I2CE_Page.php] on line 47
| |
| *Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $defaultHTMLFile
| |
| | |
| ===$role===
| |
| The role that can view this page.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L52 i2ce/modules/Pages/lib/I2CE_Page.php] on line 52
| |
| *Type: protected [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $role
| |
| | |
| ===$user===
| |
| The user viewing this page.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L57 i2ce/modules/Pages/lib/I2CE_Page.php] on line 57
| |
| *Type: protected [[Class: I2CE_User | I2CE_User]] $user
| |
| | |
| ===$access===
| |
| The access level required for this page.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L62 i2ce/modules/Pages/lib/I2CE_Page.php] on line 62
| |
| *Type: private integer $access
| |
| | |
| ===$redirect===
| |
| A url to redirect to instead of displaying the page.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L67 i2ce/modules/Pages/lib/I2CE_Page.php] on line 67
| |
| *Type: private [http://www.php.net/manual/en/language.types.string.php string ] $redirect
| |
| | |
| ===$post===
| |
| Holds a reference to the $_POST array which is a list of all data sent from a form.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L72 i2ce/modules/Pages/lib/I2CE_Page.php] on line 72
| |
| *Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $post
| |
| | |
| ===$get===
| |
| Holds a reference to the $_GET array which is a list of all variables sent in the URL or from a form with an action of "GET."
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L78 i2ce/modules/Pages/lib/I2CE_Page.php] on line 78
| |
| *Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $get
| |
| | |
| ===$page_root===
| |
| the page root -- this is the URL relative to the site base that is used to get to this page.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L169 i2ce/modules/Pages/lib/I2CE_Page.php] on line 169
| |
| *Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $page_root
| |
| | |
| ===$page_remainder===
| |
| the page remainder -- this is the remainder of the URL relative to the site base that is used to get to this page.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L189 i2ce/modules/Pages/lib/I2CE_Page.php] on line 189
| |
| *Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $page_remainder
| |
| | |
| ===$args===
| |
| The arguments passed in the constructor. @param protected array $args
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L208 i2ce/modules/Pages/lib/I2CE_Page.php] on line 208
| |
| *Type: protected $args
| |
| | |
| ===$request_remainder===
| |
| The remainder of the page request -- everything after (option_module_name/)page_name(/reminder/of/the/request) @param protected array $request_remainder
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L213 i2ce/modules/Pages/lib/I2CE_Page.php] on line 213
| |
| *Type: protected $request_remainder
| |
| | |
| ===$permissionParser===
| |
| The permission parser for the user of this page. @param I2CE_PermissionParser $permissionParser
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L218 i2ce/modules/Pages/lib/I2CE_Page.php] on line 218
| |
| *Type: protected $permissionParser
| |
| | |
| ===$page===
| |
| . The requested page
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L430 i2ce/modules/Pages/lib/I2CE_Page.php] on line 430
| |
| *Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $page
| |
| | |
| ===$module===
| |
| . The module that contains this page.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L434 i2ce/modules/Pages/lib/I2CE_Page.php] on line 434
| |
| *Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $module
| |
| | |
| ===$is_post===
| |
| -- true if this page is a post.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L621 i2ce/modules/Pages/lib/I2CE_Page.php] on line 621
| |
| *Type: protected [http://www.php.net/manual/en/language.types.boolean.php boolean ] $is_post
| |
| | |
| ===$session_req===
| |
| Holds a reference to a session request array if one has been requested and exists in the session.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L757 i2ce/modules/Pages/lib/I2CE_Page.php] on line 757
| |
| *Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $session_req
| |
| | |
| ===$request_vars===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L827 i2ce/modules/Pages/lib/I2CE_Page.php] on line 827
| |
| *Type: private $request_vars
| |
| | |
| ==Methods==
| |
| ===__construct()===
| |
| Create a new instance of a page. The default constructor should be called by any pages extending this object. It creates the [[Class: I2CE_Template | ]] and [[Class: I2CE_User | ]] objects and sets up the basic member variables.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L239 i2ce/modules/Pages/lib/I2CE_Page.php] on line 239
| |
| *Signature: public function __construct($args,$request_remainder,$get,$post)
| |
| *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 <br/>The remainder of the request path
| |
| **$get
| |
| ***Default Value: null
| |
| **$post
| |
| ***Default Value: null
| |
| ===_display()===
| |
| Display the template as HTML/XML. Sets the header and displays any buffered warnings/echoed text.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L499 i2ce/modules/Pages/lib/I2CE_Page.php] on line 499
| |
| *Signature: protected function _display($supress_output)
| |
| *Parameters:
| |
| **$supress_output
| |
| ===_flattenRequestVars()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L388 i2ce/modules/Pages/lib/I2CE_Page.php] on line 388
| |
| *Signature: static public function _flattenRequestVars($vars,$req,$prefix)
| |
| *Parameters:
| |
| **$vars
| |
| **&$req
| |
| **$prefix
| |
| ===action()===
| |
| Perform any actions to load the HTML templates. The default action simply loads all the HTML template files.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L142 i2ce/modules/Pages/lib/I2CE_Page.php] on line 142
| |
| *Signature: protected function action()
| |
| *Returns: boolean.<br/>true on sucess
| |
| ===actionCommandLine()===
| |
| The business method if this page is called from the commmand line
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L567 i2ce/modules/Pages/lib/I2CE_Page.php] on line 567
| |
| *Signature: protected function actionCommandLine($args,$request_remainder)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $args <br/>the array of unix style command line arguments Arguements are link that in: http://us3.php.net/manual/en/features.commandline.php#78651 If we were called as: index.php --page=/module/page/some/thing/else --long -AB 2 -C -D 'ostrich' --eggs==good Then $request_remainder = array('some','thing','else') and $args = array('long'=>true, 'A'=>true, 'B'=>2, 'C'=>true, 'D'=>'ostrich', 'eggs'=>'good')
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $request_remainder <br/>the remainder of the request after the page specfication.
| |
| ===display()===
| |
| Calls the appropriate action for the page. Then it Displays or redirects the page as appropriate. This will check to make sure the page can be seen by this user and if not redirect them to an error page. If the redirect variable has been set then the page will be redirected to the new page. Otherwise the [[Class: I2CE_Template | ::display() template display]] method will be called to output the combined template files to the browser.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L447 i2ce/modules/Pages/lib/I2CE_Page.php] on line 447
| |
| *Signature: public function display($supress_output)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $supress_output <br/>defaults to false. set to true to supress the output of a webpage
| |
| ***Default Value: false
| |
| ===fixupRequestVariables()===
| |
| Applies any transformations (make sure magic quotes is off, nesting, and json decoding) to an array variables @param boolean $transform. Defaults to true
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L359 i2ce/modules/Pages/lib/I2CE_Page.php] on line 359
| |
| *Signature: static public function fixupRequestVariables($vars)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $vars
| |
| *Returns: $vars;
| |
| ===flattenRequestVars()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L381 i2ce/modules/Pages/lib/I2CE_Page.php] on line 381
| |
| *Signature: static public function flattenRequestVars($vars)
| |
| *Parameters:
| |
| **$vars
| |
| ===get()===
| |
| Gets/sets the [[#$get | $get]] value for the given key.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L720 i2ce/modules/Pages/lib/I2CE_Page.php] on line 720
| |
| *Signature: public function get($key,$val)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $key <br/>Defaults to null meaning we return all of the post variables (it is not slash escaped).
| |
| ***Default Value: null
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $val <br/>Defaults to null. If non-null we set the post value for $key to $val
| |
| ***Default Value: null
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>if no val is set: string if a key is given and found. null if key is given nut not found. array otherwise
| |
| ===getAccess()===
| |
| Get the access level required to view this page. If the access level requirements change after the page object has been instantiated this method is used to set a new access level for the [[#$access | $access]] variable.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L591 i2ce/modules/Pages/lib/I2CE_Page.php] on line 591
| |
| *Signature: protected function getAccess()
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>of string
| |
| ===getAccessedBaseURL()===
| |
| Returns the base url from which the site was accessed. If no .htaccess is used, ths will include the index.php. If rewrites are used (via .htacces) this will no include the index.php. Point is... this is the base url from which the site was accessed, no questions asked. This of course assumes that you are now accessing the site via the command line
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L93 i2ce/modules/Pages/lib/I2CE_Page.php] on line 93
| |
| *Signature: static public function getAccessedBaseURL()
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===getTemplate()===
| |
| Get the template associated to this page
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L160 i2ce/modules/Pages/lib/I2CE_Page.php] on line 160
| |
| *Signature: public function getTemplate()
| |
| ===getTitle()===
| |
| Return the title for this page.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L153 i2ce/modules/Pages/lib/I2CE_Page.php] on line 153
| |
| *Signature: protected function getTitle()
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===getUser()===
| |
| Get the user of this page
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L607 i2ce/modules/Pages/lib/I2CE_Page.php] on line 607
| |
| *Signature: public function getUser()
| |
| *Returns: [[Class: I2CE_User | I2CE_User]]
| |
| ===get_exists()===
| |
| Check to see if a key exists in the [[#$get | $get]] array.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L699 i2ce/modules/Pages/lib/I2CE_Page.php] on line 699
| |
| *Signature: public function get_exists($key)
| |
| *Parameters:
| |
| **$key
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===hasPermission()===
| |
| Parse a permission string to see if we have permission.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L227 i2ce/modules/Pages/lib/I2CE_Page.php] on line 227
| |
| *Signature: public function hasPermission($permission,$node)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $permission
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $node <br/>Defaults to null. If set, it is the node in the page's template that we get the data for.
| |
| ***Default Value: null
| |
| *Returns: boolean.<br/>Null on failure.
| |
| ===initializeTemplate()===
| |
| Handles creating hte I2CE_TemplateMeister templates and loading any default templates
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L268 i2ce/modules/Pages/lib/I2CE_Page.php] on line 268
| |
| *Signature: protected function initializeTemplate()
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>true on success
| |
| ===isGet()===
| |
| Check to see if the current page is a GET request or not
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L636 i2ce/modules/Pages/lib/I2CE_Page.php] on line 636
| |
| *Signature: public function isGet()
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===isPost()===
| |
| Check to see if the current page is a POST form submission or not.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L627 i2ce/modules/Pages/lib/I2CE_Page.php] on line 627
| |
| *Signature: public function isPost()
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===loadHTMLTemplates()===
| |
| Load the template (HTML or XML) files to the template object.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L120 i2ce/modules/Pages/lib/I2CE_Page.php] on line 120
| |
| *Signature: protected function loadHTMLTemplates()
| |
| ===module()===
| |
| Sets/Gets the module.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L406 i2ce/modules/Pages/lib/I2CE_Page.php] on line 406
| |
| *Signature: public function module($module)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $module <br/>If non-null sets the module's name to $module.
| |
| ***Default Value: null
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>if $module was non-null
| |
| ===page()===
| |
| Sets/Gets the page.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L418 i2ce/modules/Pages/lib/I2CE_Page.php] on line 418
| |
| *Signature: public function page($page)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $page <br/>If non-null sets the page's name to $page.
| |
| ***Default Value: null
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>if $page was non-null
| |
| ===pageRemainder()===
| |
| Get/set the page remainder -- this is the remainder of the URL relative to the site base that is used to get to this page. @param $page_remainder Defaults to null. If non-null we set the page remainder. If null we get the page remainder.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L196 i2ce/modules/Pages/lib/I2CE_Page.php] on line 196
| |
| *Signature: public function pageRemainder($page_remainder)
| |
| *Parameters:
| |
| **$page_remainder
| |
| ***Default Value: null
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>if $page_remainder was null(default)
| |
| ===pageRoot()===
| |
| Get/set the page root -- this is the URL relative to the site base that is used to get to this page. @param $page_root Defaults to null. If non-null we set the page root. If null we get the page root.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L176 i2ce/modules/Pages/lib/I2CE_Page.php] on line 176
| |
| *Signature: public function pageRoot($page_root)
| |
| *Parameters:
| |
| **$page_root
| |
| ***Default Value: null
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>if $page_root was null(default)
| |
| ===post()===
| |
| Get/set the [[#$post | $post]] value for the given key.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L665 i2ce/modules/Pages/lib/I2CE_Page.php] on line 665
| |
| *Signature: public function post($key,$val)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $key <br/>Defaults to null meaning we return all of the post variables (it is not slash escaped).
| |
| ***Default Value: null
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $val <br/>Defaults to null. If non-null we set the post value for $key to $val
| |
| ***Default Value: null
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>if no val is set: string if a key is given and found. null if key is given nut not found. array otherwise
| |
| ===post_exists()===
| |
| Check to see if a key exists in the [[#$post | $post]] array.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L644 i2ce/modules/Pages/lib/I2CE_Page.php] on line 644
| |
| *Signature: public function post_exists($key)
| |
| *Parameters:
| |
| **$key
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===redirect()===
| |
| Send the redirect header with the given URL.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L102 i2ce/modules/Pages/lib/I2CE_Page.php] on line 102
| |
| *Signature: public function redirect($url)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $url
| |
| ===request()===
| |
| Return the given value for the key in one of the request arrays.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L833 i2ce/modules/Pages/lib/I2CE_Page.php] on line 833
| |
| *Signature: public function request($key)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $key
| |
| ***Default Value: null
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]
| |
| ===request_exists()===
| |
| Checks all the request arrays for the given key and returns true if it exists.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L821 i2ce/modules/Pages/lib/I2CE_Page.php] on line 821
| |
| *Signature: public function request_exists($key)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $key
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===rewrittenURLs()===
| |
| returns true if the url's have been written. false if not
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L83 i2ce/modules/Pages/lib/I2CE_Page.php] on line 83
| |
| *Signature: static public function rewrittenURLs()
| |
| ===session_req()===
| |
| Gets/sets the [[#$session_req | $session_req]] value for the given key.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L783 i2ce/modules/Pages/lib/I2CE_Page.php] on line 783
| |
| *Signature: public function session_req($key,$val)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $key <br/>Defaults to null meaning we return all of the post variables (it is not slash escaped).
| |
| ***Default Value: null
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $val <br/>Defaults to null. If non-null we set the post value for $key to $val
| |
| ***Default Value: null
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>if no val is set: string if a key is given and found. null if key is given nut not found. array otherwise
| |
| ===session_req_exists()===
| |
| Check to see if a key exists in the [[#$session_req | $session_req]] array.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L762 i2ce/modules/Pages/lib/I2CE_Page.php] on line 762
| |
| *Signature: public function session_req_exists($key)
| |
| *Parameters:
| |
| **$key
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===setAccess()===
| |
| Change the access level required to view this page. If the access level requirements change after the page object has been instantiated this method is used to set a new access level for the [[#$access | $access]] variable. @param array of string
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L578 i2ce/modules/Pages/lib/I2CE_Page.php] on line 578
| |
| *Signature: public function setAccess($access)
| |
| *Parameters:
| |
| **$access
| |
| ===setIsPost()===
| |
| Sets if this pages is a post or not
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L614 i2ce/modules/Pages/lib/I2CE_Page.php] on line 614
| |
| *Signature: public function setIsPost($post)
| |
| *Parameters:
| |
| **$post
| |
| ===setRedirect()===
| |
| Set the URL to be redirected to instead of displaying this page.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L865 i2ce/modules/Pages/lib/I2CE_Page.php] on line 865
| |
| *Signature: public function setRedirect($url)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $url
| |
| ===setupGetPost()===
| |
| setup of the get and post variables. @param array $psot. If null (default) it will be $_POST if it is a HTTP array request. otherwise it is the empty array
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/lib/I2CE_Page.php#L308 i2ce/modules/Pages/lib/I2CE_Page.php] on line 308
| |
| *Signature: protected function setupGetPost($get,$post,$strip)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $get <br/>If null (default) it will be $_GET if it is a HTTP request. otherwise it is the empty array
| |
| ***Default Value: null
| |
| **$post
| |
| ***Default Value: null
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $strip <br/>Defauls to true. If true it will try to strip off magic quotes if they exist for a HTTP request.
| |
| ***Default Value: true
| |
| ==Inherited Methods==
| |
| ===_hasMethod()===
| |
| This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
| |
| ==Inherited Fuzzy Methods==
| |
| ===userMessage()===
| |
| This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
| |
| ==Fuzzy Methods==
| |
| ===launchBackgroundProcess()===
| |
| This method is implemented by [[Class: I2CE_BackgroundProcess#launchBackgroundProcess() | I2CE_BackgroundProcess->launchBackgroundProcess() ]]
| |
| ===launchBackgroundPHPScript()===
| |
| This method is implemented by [[Class: I2CE_BackgroundProcess#launchBackgroundPHPScript() | I2CE_BackgroundProcess->launchBackgroundPHPScript() ]]
| |
| ===launchBackgroundPage()===
| |
| This method is implemented by [[Class: I2CE_BackgroundProcess#launchBackgroundPage() | I2CE_BackgroundProcess->launchBackgroundPage() ]]
| |
| ===addColorPickerTriple()===
| |
| This method is implemented by [[Class: I2CE_Module_ColorPicker#addColorPickerTriple() | I2CE_Module_ColorPicker->addColorPickerTriple() ]]
| |
| ===selectOptionsImmediate()===
| |
| This method is implemented by [[Class: I2CE_DisplayData#selectOptionsImmediate() | I2CE_DisplayData->selectOptionsImmediate() ]]
| |
| ===setDisplayData()===
| |
| This method is implemented by [[Class: I2CE_DisplayData#setDisplayData() | I2CE_DisplayData->setDisplayData() ]]
| |
| ===setDisplayDataImmediate()===
| |
| This method is implemented by [[Class: I2CE_DisplayData#setDisplayDataImmediate() | I2CE_DisplayData->setDisplayDataImmediate() ]]
| |
| ===addFormWorm()===
| |
| This method is implemented by [[Class: I2CE_Module_FormWorm#addFormWorm() | I2CE_Module_FormWorm->addFormWorm() ]]
| |
| ===getClassValue()===
| |
| This method is implemented by [[Class: I2CE_MootoolsCore#getClassValue() | I2CE_MootoolsCore->getClassValue() ]]
| |
| ===loadClassValues()===
| |
| This method is implemented by [[Class: I2CE_MootoolsCore#loadClassValues() | I2CE_MootoolsCore->loadClassValues() ]]
| |
| ===setClassValue()===
| |
| This method is implemented by [[Class: I2CE_MootoolsCore#setClassValue() | I2CE_MootoolsCore->setClassValue() ]]
| |
| ===setClassValues()===
| |
| This method is implemented by [[Class: I2CE_MootoolsCore#setClassValues() | I2CE_MootoolsCore->setClassValues() ]]
| |
| ===addOption()===
| |
| This method is implemented by [[Class: I2CE_Template_Options#addOption() | I2CE_Template_Options->addOption() ]]
| |
| ===addOptions()===
| |
| This method is implemented by [[Class: I2CE_Template_Options#addOptions() | I2CE_Template_Options->addOptions() ]]
| |
| ===addAutoCompleteInputTreeById()===
| |
| This method is implemented by [[Class: I2CE_Module_TreeSelect#addAutoCompleteInputTreeById() | I2CE_Module_TreeSelect->addAutoCompleteInputTreeById() ]]
| |
| ===addAutoCompleteInputTree()===
| |
| This method is implemented by [[Class: I2CE_Module_TreeSelect#addAutoCompleteInputTree() | I2CE_Module_TreeSelect->addAutoCompleteInputTree() ]]
| |
| ===setForm()===
| |
| This method is implemented by [[Class: I2CE_Module_Forms#setForm() | I2CE_Module_Forms->setForm() ]]
| |
| ===getField()===
| |
| This method is implemented by [[Class: I2CE_Module_Forms#getField() | I2CE_Module_Forms->getField() ]]
| |
| ===setReview()===
| |
| This method is implemented by [[Class: I2CE_Module_Forms#setReview() | I2CE_Module_Forms->setReview() ]]
| |
| ===isReview()===
| |
| This method is implemented by [[Class: I2CE_Module_Forms#isReview() | I2CE_Module_Forms->isReview() ]]
| |
| ===setShowForm()===
| |
| This method is implemented by [[Class: I2CE_Module_Forms#setShowForm() | I2CE_Module_Forms->setShowForm() ]]
| |
| ===showForm()===
| |
| This method is implemented by [[Class: I2CE_Module_Forms#showForm() | I2CE_Module_Forms->showForm() ]]
| |
| ===makeJumper()===
| |
| This method is implemented by [[Class: I2CE_Module_Jumper#makeJumper() | I2CE_Module_Jumper->makeJumper() ]]
| |
| ===menuSelect()===
| |
| This method is implemented by [[Class: I2CE_Module_MenuSelect#menuSelect() | I2CE_Module_MenuSelect->menuSelect() ]]
| |
| ===addUpdateSelect()===
| |
| This method is implemented by [[Class: I2CE_Module_MenuSelect#addUpdateSelect() | I2CE_Module_MenuSelect->addUpdateSelect() ]]
| |
| ===addAjaxUpdate()===
| |
| This method is implemented by [[Class: I2CE_Stub#addAjaxUpdate() | I2CE_Stub->addAjaxUpdate() ]]
| |
| ===addAjaxToggle()===
| |
| This method is implemented by [[Class: I2CE_Stub#addAjaxToggle() | I2CE_Stub->addAjaxToggle() ]]
| |
| ===addAjaxRequestFunction()===
| |
| This method is implemented by [[Class: I2CE_Stub#addAjaxRequestFunction() | I2CE_Stub->addAjaxRequestFunction() ]]
| |
| ===addAjaxCompleteFunction()===
| |
| This method is implemented by [[Class: I2CE_Stub#addAjaxCompleteFunction() | I2CE_Stub->addAjaxCompleteFunction() ]]
| |
| ===addAjaxToggleOnFunction()===
| |
| This method is implemented by [[Class: I2CE_Stub#addAjaxToggleOnFunction() | I2CE_Stub->addAjaxToggleOnFunction() ]]
| |
| ===addAjaxToggleOffFunction()===
| |
| This method is implemented by [[Class: I2CE_Stub#addAjaxToggleOffFunction() | I2CE_Stub->addAjaxToggleOffFunction() ]]
| |
| ===hasAjax()===
| |
| This method is implemented by [[Class: I2CE_Stub#hasAjaxFuzzy() | I2CE_Stub->hasAjaxFuzzy() ]]
| |
| ===setDataTypePriority()===
| |
| This method is implemented by [[Class: I2CE_Module_TemplateData#setDataTypePriority() | I2CE_Module_TemplateData->setDataTypePriority() ]]
| |
| ===setData()===
| |
| This method is implemented by [[Class: I2CE_Module_TemplateData#setData() | I2CE_Module_TemplateData->setData() ]]
| |
| ===getData()===
| |
| This method is implemented by [[Class: I2CE_Module_TemplateData#getData() | I2CE_Module_TemplateData->getData() ]]
| |
| ===getDefaultData()===
| |
| This method is implemented by [[Class: I2CE_Module_TemplateData#getDefaultData() | I2CE_Module_TemplateData->getDefaultData() ]]
| |
| ===removeData()===
| |
| This method is implemented by [[Class: I2CE_Module_TemplateData#removeData() | I2CE_Module_TemplateData->removeData() ]]
| |
| ===getDataNames()===
| |
| This method is implemented by [[Class: I2CE_Module_TemplateData#getDataNames() | I2CE_Module_TemplateData->getDataNames() ]]
| |
| ===ensureNode()===
| |
| This method is implemented by [[Class: I2CE_Module_TemplateData#ensureNode() | I2CE_Module_TemplateData->ensureNode() ]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
