Class: I2CE Page (Development): Difference between revisions
No edit summary |
No edit summary |
||
Line 7: | Line 7: | ||
** [[Class: I2CE_Page_BinaryField (Development) | I2CE_Page_BinaryField]] | ** [[Class: I2CE_Page_BinaryField (Development) | I2CE_Page_BinaryField]] | ||
** [[Class: I2CE_Page_CachedForm (Development) | I2CE_Page_CachedForm]] | ** [[Class: I2CE_Page_CachedForm (Development) | I2CE_Page_CachedForm]] | ||
** [[Class: iHRIS_PageCalendar (Development) | iHRIS_PageCalendar]] | |||
*** [[Class: iHRIS_PageCalendarTraining (Development) | iHRIS_PageCalendarTraining]] | |||
** [[Class: I2CE_PageReportAction (Development) | I2CE_PageReportAction]] | |||
*** [[Class: iHRIS_PageMassDeleteSearchList (Development) | iHRIS_PageMassDeleteSearchList]] | |||
*** [[Class: iHRIS_PageMassDeleteFacilityList (Development) | iHRIS_PageMassDeleteFacilityList]] | |||
*** [[Class: iHRIS_PageEditStudents (Development) | iHRIS_PageEditStudents]] | |||
** [[Class: I2CE_Page_CustomReports (Development) | I2CE_Page_CustomReports]] | ** [[Class: I2CE_Page_CustomReports (Development) | I2CE_Page_CustomReports]] | ||
*** [[Class: iHRIS_PageUserStatistics (Development) | iHRIS_PageUserStatistics]] | |||
** [[Class: I2CE_Page_ShowReport (Development) | I2CE_Page_ShowReport]] | |||
*** [[Class: iHRIS_Page_SelfService_View (Development) | iHRIS_Page_SelfService_View]] | |||
*** [[Class: iHRIS_PageSearch (Development) | iHRIS_PageSearch]] | |||
** [[Class: iHRIS_PageDashboard (Development) | iHRIS_PageDashboard]] | |||
** [[Class: iHRIS_Page_ExportDHISDashboard (Development) | iHRIS_Page_ExportDHISDashboard]] | |||
** [[Class: iHRIS_DHIS_DashboardSubmit (Development) | iHRIS_DHIS_DashboardSubmit]] | |||
** [[Class: iHRIS_DHIS_MetadataUpload (Development) | iHRIS_DHIS_MetadataUpload]] | |||
** [[Class: I2CE_PageDashboard (Development) | I2CE_PageDashboard]] | |||
** [[Class: I2CE_FileDump (Development) | I2CE_FileDump]] | ** [[Class: I2CE_FileDump (Development) | I2CE_FileDump]] | ||
** [[Class: I2CE_PageAutoList (Development) | I2CE_PageAutoList]] | |||
** [[Class: I2CE_PageRemap (Development) | I2CE_PageRemap]] | |||
** [[Class: I2CE_PageViewList (Development) | I2CE_PageViewList]] | ** [[Class: I2CE_PageViewList (Development) | I2CE_PageViewList]] | ||
*** [[Class: iHRIS_PageViewList (Development) | iHRIS_PageViewList]] | *** [[Class: iHRIS_PageViewList (Development) | iHRIS_PageViewList]] | ||
Line 17: | Line 34: | ||
** [[Class: I2CE_PageLogout (Development) | I2CE_PageLogout]] | ** [[Class: I2CE_PageLogout (Development) | I2CE_PageLogout]] | ||
** [[Class: I2CE_PagePassword (Development) | I2CE_PagePassword]] | ** [[Class: I2CE_PagePassword (Development) | I2CE_PagePassword]] | ||
** [[Class: | ** [[Class: I2CE_Page_TreeSelectData (Development) | I2CE_Page_TreeSelectData]] | ||
** [[Class: I2CE_PageOpenLayers (Development) | I2CE_PageOpenLayers]] | |||
** [[Class: I2CE_Page_PrintedForms (Development) | I2CE_Page_PrintedForms]] | ** [[Class: I2CE_Page_PrintedForms (Development) | I2CE_Page_PrintedForms]] | ||
** [[Class: I2CE_Page_ArchiveReport (Development) | I2CE_Page_ArchiveReport]] | ** [[Class: I2CE_Page_ArchiveReport (Development) | I2CE_Page_ArchiveReport]] | ||
** [[Class: | ** [[Class: I2CE_PageViewUser (Development) | I2CE_PageViewUser]] | ||
*** [[Class: iHRIS_PageViewUser (Development) | iHRIS_PageViewUser]] | |||
** [[Class: iHRIS_PageViewByChild (Development) | iHRIS_PageViewByChild]] | |||
** [[Class: I2CE_PageAdmin (Development) | I2CE_PageAdmin]] | ** [[Class: I2CE_PageAdmin (Development) | I2CE_PageAdmin]] | ||
** [[Class: | ** [[Class: I2CE_PageCron (Development) | I2CE_PageCron]] | ||
** [[Class: I2CE_Page_DeleteRecord (Development) | I2CE_Page_DeleteRecord]] | |||
** [[Class: I2CE_Page_ExportReport (Development) | I2CE_Page_ExportReport]] | |||
** [[Class: I2CE_PageFormBrowser (Development) | I2CE_PageFormBrowser]] | ** [[Class: I2CE_PageFormBrowser (Development) | I2CE_PageFormBrowser]] | ||
** [[Class: I2Ce_Page_FormDocumentor (Development) | I2Ce_Page_FormDocumentor]] | ** [[Class: I2Ce_Page_FormDocumentor (Development) | I2Ce_Page_FormDocumentor]] | ||
** [[Class: I2CE_PageForm (Development) | I2CE_PageForm]] | ** [[Class: I2CE_PageActionRelationship (Development) | I2CE_PageActionRelationship]] | ||
*** [[Class: I2CE_PageFormLists (Development) | I2CE_PageFormLists]] | *** [[Class: I2CE_PageEditRelationship (Development) | I2CE_PageEditRelationship]] | ||
**** [[Class: I2CE_Page_CustomReport_ArchiveMenu (Development) | I2CE_Page_CustomReport_ArchiveMenu]] | *** [[Class: I2CE_PageGenerateRelationshipTemplate (Development) | I2CE_PageGenerateRelationshipTemplate]] | ||
**** [[Class: | **** [[Class: iHRIS_PageActionStudentCertificates (Development) | iHRIS_PageActionStudentCertificates]] | ||
*** [[Class: iHRIS_PageFormParentPerson (Development) | iHRIS_PageFormParentPerson]] | *** [[Class: I2CE_PageViewRelationship (Development) | I2CE_PageViewRelationship]] | ||
**** [[Class: iHRIS_PageFormContact (Development) | iHRIS_PageFormContact]] | ** [[Class: I2CE_PageFormBase (Development) | I2CE_PageFormBase]] | ||
**** [[Class: iHRIS_PageFormDeparture (Development) | iHRIS_PageFormDeparture]] | *** [[Class: I2CE_PageForm (Development) | I2CE_PageForm]] | ||
**** [[Class: iHRIS_PageFormMakeOffer (Development) | iHRIS_PageFormMakeOffer]] | **** [[Class: iHRIS_PageFormDataElement (Development) | iHRIS_PageFormDataElement]] | ||
**** [[Class: iHRIS_PageFormGraduate (Development) | iHRIS_PageFormGraduate]] | **** [[Class: iHRIS_PageFormDataSet (Development) | iHRIS_PageFormDataSet]] | ||
*** [[Class: iHRIS_PageFormPerson (Development) | iHRIS_PageFormPerson]] | **** [[Class: iHRIS_PageViewDHIS (Development) | iHRIS_PageViewDHIS]] | ||
**** [[Class: iHRIS_PageFormPersonManage (Development) | iHRIS_PageFormPersonManage]] | **** [[Class: I2CE_PageFormLists (Development) | I2CE_PageFormLists]] | ||
**** [[Class: iHRIS_PageFormPersonQualify (Development) | iHRIS_PageFormPersonQualify]] | ***** [[Class: I2CE_Page_CustomReport_ArchiveMenu (Development) | I2CE_Page_CustomReport_ArchiveMenu]] | ||
*** [[Class: I2CE_PageFormUser (Development) | I2CE_PageFormUser]] | **** [[Class: iHRIS_Page_SelfService_Apply (Development) | iHRIS_Page_SelfService_Apply]] | ||
**** [[Class: iHRIS_PageFormUser (Development) | iHRIS_PageFormUser]] | **** [[Class: iHRIS_PageFormParentPerson (Development) | iHRIS_PageFormParentPerson]] | ||
*** [[Class: iHRIS_PageFormSalary (Development) | iHRIS_PageFormSalary]] | ***** [[Class: iHRIS_PageFormContact (Development) | iHRIS_PageFormContact]] | ||
*** [[Class: iHRIS_PageFormFacilityInstitution (Development) | iHRIS_PageFormFacilityInstitution]] | ***** [[Class: iHRIS_Page_UserMap (Development) | iHRIS_Page_UserMap]] | ||
*** [[Class: iHRIS_PageFormParentTraining (Development) | iHRIS_PageFormParentTraining]] | ***** [[Class: iHRIS_PageFormChangePosition (Development) | iHRIS_PageFormChangePosition]] | ||
**** [[Class: iHRIS_PageFormDisciplinaryAction (Development) | iHRIS_PageFormDisciplinaryAction]] | ***** [[Class: iHRIS_PageFormDeparture (Development) | iHRIS_PageFormDeparture]] | ||
**** [[Class: iHRIS_PageFormDisciplinaryReinstate (Development) | iHRIS_PageFormDisciplinaryReinstate]] | ***** [[Class: iHRIS_PageFormMakeOffer (Development) | iHRIS_PageFormMakeOffer]] | ||
**** [[Class: iHRIS_PageFormLicense (Development) | iHRIS_PageFormLicense]] | ***** [[Class: iHRIS_PageFormGraduate (Development) | iHRIS_PageFormGraduate]] | ||
**** [[Class: iHRIS_PageFormRenew (Development) | iHRIS_PageFormRenew]] | **** [[Class: iHRIS_PageFormPerson (Development) | iHRIS_PageFormPerson]] | ||
**** [[Class: iHRIS_PageFormTrainingDisrupt (Development) | iHRIS_PageFormTrainingDisrupt]] | ***** [[Class: iHRIS_PageFormPersonManage (Development) | iHRIS_PageFormPersonManage]] | ||
**** [[Class: iHRIS_PageFormTrainingResume (Development) | iHRIS_PageFormTrainingResume]] | ***** [[Class: iHRIS_PageFormPersonQualify (Development) | iHRIS_PageFormPersonQualify]] | ||
*** [[Class: iHRIS_PageFormTrainingProgram (Development) | iHRIS_PageFormTrainingProgram]] | **** [[Class: iHRIS_Page_SelfService_Register (Development) | iHRIS_Page_SelfService_Register]] | ||
*** [[Class: iHRIS_PageForm_Person_Scheduled_Training_Course (Development) | iHRIS_PageForm_Person_Scheduled_Training_Course]] | **** [[Class: I2CE_PageForm_UserRequestEmail (Development) | I2CE_PageForm_UserRequestEmail]] | ||
*** [[Class: iHRIS_PageFormParentTrainingInstitution (Development) | iHRIS_PageFormParentTrainingInstitution]] | **** [[Class: I2CE_PageFormParentUser (Development) | I2CE_PageFormParentUser]] | ||
*** [[Class: iHRIS_PageForm_Evaluate_Course_Competencies (Development) | iHRIS_PageForm_Evaluate_Course_Competencies]] | ***** [[Class: iHRIS_PageFormParentUser (Development) | iHRIS_PageFormParentUser]] | ||
**** [[Class: I2CE_PageFormUser (Development) | I2CE_PageFormUser]] | |||
***** [[Class: iHRIS_PageFormUser (Development) | iHRIS_PageFormUser]] | |||
**** [[Class: I2CE_PageFormAuto (Development) | I2CE_PageFormAuto]] | |||
***** [[Class: I2CE_PageAutoListEdit (Development) | I2CE_PageAutoListEdit]] | |||
**** [[Class: I2CE_PageFormParent (Development) | I2CE_PageFormParent]] | |||
**** [[Class: iHRIS_PageFormSalary (Development) | iHRIS_PageFormSalary]] | |||
**** [[Class: iHRIS_PageFormFacilityInstitution (Development) | iHRIS_PageFormFacilityInstitution]] | |||
**** [[Class: iHRIS_PageFormParentTraining (Development) | iHRIS_PageFormParentTraining]] | |||
***** [[Class: iHRIS_PageFormDisciplinaryAction (Development) | iHRIS_PageFormDisciplinaryAction]] | |||
***** [[Class: iHRIS_PageFormDisciplinaryReinstate (Development) | iHRIS_PageFormDisciplinaryReinstate]] | |||
***** [[Class: iHRIS_PageFormLicense (Development) | iHRIS_PageFormLicense]] | |||
***** [[Class: iHRIS_PageFormRenew (Development) | iHRIS_PageFormRenew]] | |||
***** [[Class: iHRIS_PageFormTrainingDisrupt (Development) | iHRIS_PageFormTrainingDisrupt]] | |||
***** [[Class: iHRIS_PageFormTrainingResume (Development) | iHRIS_PageFormTrainingResume]] | |||
**** [[Class: iHRIS_PageFormTrainingProgram (Development) | iHRIS_PageFormTrainingProgram]] | |||
**** [[Class: iHRIS_PageForm_Person_Scheduled_Training_Course (Development) | iHRIS_PageForm_Person_Scheduled_Training_Course]] | |||
**** [[Class: iHRIS_Page_FormExam (Development) | iHRIS_Page_FormExam]] | |||
**** [[Class: iHRIS_PageFormParentTrainingInstitution (Development) | iHRIS_PageFormParentTrainingInstitution]] | |||
**** [[Class: iHRIS_PageForm_Evaluate_Course_Competencies (Development) | iHRIS_PageForm_Evaluate_Course_Competencies]] | |||
*** [[Class: I2CE_PageFormCSV (Development) | I2CE_PageFormCSV]] | |||
**** [[Class: iHRIS_PageUploadTraining (Development) | iHRIS_PageUploadTraining]] | |||
*** [[Class: I2CE_PageMultiForm (Development) | I2CE_PageMultiForm]] | |||
** [[Class: I2CE_PageViewChildren (Development) | I2CE_PageViewChildren]] | |||
*** [[Class: iHRIS_PageView (Development) | iHRIS_PageView]] | |||
*** [[Class: I2CE_PageTabbed (Development) | I2CE_PageTabbed]] | |||
** [[Class: iHRIS_PageConfigure (Development) | iHRIS_PageConfigure]] | ** [[Class: iHRIS_PageConfigure (Development) | iHRIS_PageConfigure]] | ||
** [[Class: iHRIS_PageFieldHistory (Development) | iHRIS_PageFieldHistory]] | ** [[Class: iHRIS_PageFieldHistory (Development) | iHRIS_PageFieldHistory]] | ||
Line 57: | Line 104: | ||
*** [[Class: iHRIS_PageHistoryQualify (Development) | iHRIS_PageHistoryQualify]] | *** [[Class: iHRIS_PageHistoryQualify (Development) | iHRIS_PageHistoryQualify]] | ||
** [[Class: iHRIS_PageIndex (Development) | iHRIS_PageIndex]] | ** [[Class: iHRIS_PageIndex (Development) | iHRIS_PageIndex]] | ||
** [[Class: iHRIS_PageMassDeleteSearchAction (Development) | iHRIS_PageMassDeleteSearchAction]] | |||
** [[Class: iHRIS_PageRecentForm (Development) | iHRIS_PageRecentForm]] | ** [[Class: iHRIS_PageRecentForm (Development) | iHRIS_PageRecentForm]] | ||
** [[Class: iHRIS_PageManage (Development) | iHRIS_PageManage]] | ** [[Class: iHRIS_PageManage (Development) | iHRIS_PageManage]] | ||
** [[Class: iHRIS_PageViewJob (Development) | iHRIS_PageViewJob]] | ** [[Class: iHRIS_PageViewJob (Development) | iHRIS_PageViewJob]] | ||
** [[Class: iHRIS_PageMassDeleteFacilityAction (Development) | iHRIS_PageMassDeleteFacilityAction]] | |||
** [[Class: iHRIS_PageViewPosition (Development) | iHRIS_PageViewPosition]] | ** [[Class: iHRIS_PageViewPosition (Development) | iHRIS_PageViewPosition]] | ||
** [[Class: iHRIS_SalaryHistoryPage (Development) | iHRIS_SalaryHistoryPage]] | ** [[Class: iHRIS_SalaryHistoryPage (Development) | iHRIS_SalaryHistoryPage]] | ||
Line 69: | Line 117: | ||
*** [[Class: I2CE_Page_Report_MagicDataExport (Development) | I2CE_Page_Report_MagicDataExport]] | *** [[Class: I2CE_Page_Report_MagicDataExport (Development) | I2CE_Page_Report_MagicDataExport]] | ||
** [[Class: I2Ce_Page_ModDocumentor (Development) | I2Ce_Page_ModDocumentor]] | ** [[Class: I2Ce_Page_ModDocumentor (Development) | I2Ce_Page_ModDocumentor]] | ||
** [[Class: I2CE_PagePChart (Development) | I2CE_PagePChart]] | |||
*** [[Class: I2CE_PagePChartFile (Development) | I2CE_PagePChartFile]] | |||
** [[Class: iHRIS_Page_Person_Competency_Evaluation_History (Development) | iHRIS_Page_Person_Competency_Evaluation_History]] | ** [[Class: iHRIS_Page_Person_Competency_Evaluation_History (Development) | iHRIS_Page_Person_Competency_Evaluation_History]] | ||
** [[Class: I2CE_Page_Stub (Development) | I2CE_Page_Stub]] | ** [[Class: I2CE_Page_Stub (Development) | I2CE_Page_Stub]] | ||
Line 75: | Line 125: | ||
** [[Class: I2CE_Page_SwissMagic (Development) | I2CE_Page_SwissMagic]] | ** [[Class: I2CE_Page_SwissMagic (Development) | I2CE_Page_SwissMagic]] | ||
** [[Class: I2CE_Page_TasksAndRoles (Development) | I2CE_Page_TasksAndRoles]] | ** [[Class: I2CE_Page_TasksAndRoles (Development) | I2CE_Page_TasksAndRoles]] | ||
*Location: Part of the module [[I2CE Module List (Development)#pages|pages]] in the package [https://launchpad.net/i2ce I2CE] 4. | ** [[Class: iHRIS_PageActionStudents (Development) | iHRIS_PageActionStudents]] | ||
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | ** [[Class: I2CE_WebService (Development) | I2CE_WebService]] | ||
*** [[Class: I2CE_WebService_Lists (Development) | I2CE_WebService_Lists]] | |||
*Location: Part of the module [[I2CE Module List (Development)#pages|pages]] in the package [https://launchpad.net/i2ce I2CE] 4.1-dev | |||
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L37 modules/Pages/lib/I2CE_Page.php] on line 37 | |||
==Variables== | ==Variables== | ||
===$template=== | ===$template=== | ||
The template object for handling the HTML templates and data to be displayed. | The template object for handling the HTML templates and data to be displayed. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L42 i2ce/modules/Pages/lib/I2CE_Page.php] on line 42 | ||
*Type: protected [[Class: I2CE_Template (Development) | I2CE_Template]] $template | *Type: protected [[Class: I2CE_Template (Development) | I2CE_Template]] $template | ||
===$defaultHTMLFile=== | ===$defaultHTMLFile=== | ||
The default HTML/XML files to be displayed by the template. of string | The default HTML/XML files to be displayed by the template. of string | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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 | *Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $defaultHTMLFile | ||
===$role=== | ===$role=== | ||
The role that can view this page. | The role that can view this page. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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 | *Type: protected [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $role | ||
===$user=== | ===$user=== | ||
The user viewing this page. | The user viewing this page. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L57 i2ce/modules/Pages/lib/I2CE_Page.php] on line 57 | ||
*Type: protected [[Class: I2CE_User (Development) | I2CE_User]] $user | *Type: protected [[Class: I2CE_User (Development) | I2CE_User]] $user | ||
===$access=== | ===$access=== | ||
The access level required for this page. | The access level required for this page. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L62 i2ce/modules/Pages/lib/I2CE_Page.php] on line 62 | ||
*Type: private integer $access | *Type: private integer $access | ||
===$redirect=== | ===$redirect=== | ||
A url to redirect to instead of displaying the page. | A url to redirect to instead of displaying the page. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L67 i2ce/modules/Pages/lib/I2CE_Page.php] on line 67 | ||
*Type: | *Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $redirect | ||
===$post=== | ===$post=== | ||
Holds a reference to the $_POST array which is a list of all data sent from a form. | 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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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 | *Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $post | ||
===$get=== | ===$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." | 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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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 | *Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $get | ||
===$page_root=== | ===$page_root=== | ||
the page root -- this is the URL relative to the site base that is used to get to this page. | 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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L170 i2ce/modules/Pages/lib/I2CE_Page.php] on line 170 | ||
*Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $page_root | *Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $page_root | ||
===$page_remainder=== | ===$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. | 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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L190 i2ce/modules/Pages/lib/I2CE_Page.php] on line 190 | ||
*Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $page_remainder | *Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $page_remainder | ||
===$args=== | ===$args=== | ||
The arguments passed in the constructor. @param protected array $args | The arguments passed in the constructor. @param protected array $args | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L241 i2ce/modules/Pages/lib/I2CE_Page.php] on line 241 | ||
*Type: protected $args | *Type: protected $args | ||
===$request_remainder=== | ===$request_remainder=== | ||
The remainder of the page request -- everything after (option_module_name/)page_name(/reminder/of/the/request) @param protected array $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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L246 i2ce/modules/Pages/lib/I2CE_Page.php] on line 246 | ||
*Type: protected $request_remainder | *Type: protected $request_remainder | ||
===$permissionParser=== | ===$permissionParser=== | ||
The permission parser for the user of this page. @param I2CE_PermissionParser $permissionParser | The permission parser for the user of this page. @param I2CE_PermissionParser $permissionParser | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L251 i2ce/modules/Pages/lib/I2CE_Page.php] on line 251 | ||
*Type: protected $permissionParser | *Type: protected $permissionParser | ||
===$root_url=== | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L265 i2ce/modules/Pages/lib/I2CE_Page.php] on line 265 | |||
*Type: protected $root_url | |||
===$page=== | ===$page=== | ||
. The requested page | . The requested page | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L477 i2ce/modules/Pages/lib/I2CE_Page.php] on line 477 | ||
*Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $page | *Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $page | ||
===$module=== | ===$module=== | ||
. The module that contains this page. | . The module that contains this page. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L481 i2ce/modules/Pages/lib/I2CE_Page.php] on line 481 | ||
*Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $module | *Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $module | ||
===$is_post=== | ===$is_post=== | ||
-- true if this page is a post. | -- true if this page is a post. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L716 i2ce/modules/Pages/lib/I2CE_Page.php] on line 716 | ||
*Type: protected [http://www.php.net/manual/en/language.types.boolean.php boolean ] $is_post | *Type: protected [http://www.php.net/manual/en/language.types.boolean.php boolean ] $is_post | ||
===$session_req=== | ===$session_req=== | ||
Holds a reference to a session request array if one has been requested and exists in the session. | 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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L865 i2ce/modules/Pages/lib/I2CE_Page.php] on line 865 | ||
*Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $session_req | *Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $session_req | ||
===$request_vars=== | ===$request_vars=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L935 i2ce/modules/Pages/lib/I2CE_Page.php] on line 935 | ||
*Type: private $request_vars | *Type: private $request_vars | ||
Line 170: | Line 227: | ||
===__construct()=== | ===__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 (Development) | ]] and [[Class: I2CE_User (Development) | ]] objects and sets up the basic member variables. | 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 (Development) | ]] and [[Class: I2CE_User (Development) | ]] objects and sets up the basic member variables. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L274 i2ce/modules/Pages/lib/I2CE_Page.php] on line 274 | ||
*Signature: public function __construct($args,$request_remainder,$get,$post) | *Signature: public function __construct($args,$request_remainder,$get,$post) | ||
*Parameters: | *Parameters: | ||
Line 181: | Line 238: | ||
===_display()=== | ===_display()=== | ||
Display the template as HTML/XML. Sets the header and displays any buffered warnings/echoed text. | 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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L593 i2ce/modules/Pages/lib/I2CE_Page.php] on line 593 | ||
*Signature: protected function _display($supress_output) | *Signature: protected function _display($supress_output) | ||
*Parameters: | *Parameters: | ||
**$supress_output | **$supress_output | ||
===_flattenRequestVars()=== | ===_flattenRequestVars()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L435 i2ce/modules/Pages/lib/I2CE_Page.php] on line 435 | ||
*Signature: static public function _flattenRequestVars($vars,$req,$prefix) | *Signature: static public function _flattenRequestVars($vars,$req,$prefix) | ||
*Parameters: | *Parameters: | ||
Line 193: | Line 250: | ||
**$prefix | **$prefix | ||
===action()=== | ===action()=== | ||
Perform any actions | Perform any actions | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L144 i2ce/modules/Pages/lib/I2CE_Page.php] on line 144 | ||
*Signature: protected function action() | *Signature: protected function action() | ||
*Returns: boolean.<br/>true on sucess | *Returns: boolean.<br/>true on sucess | ||
===actionCommandLine()=== | ===actionCommandLine()=== | ||
The business method if this page is called from the commmand line | The business method if this page is called from the commmand line | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L662 i2ce/modules/Pages/lib/I2CE_Page.php] on line 662 | ||
*Signature: protected function actionCommandLine($args,$request_remainder) | *Signature: protected function actionCommandLine($args,$request_remainder) | ||
*Parameters: | *Parameters: | ||
Line 206: | Line 263: | ||
===display()=== | ===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 (Development) | ::display() template display]] method will be called to output the combined template files to the browser. | 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 (Development) | ::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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L509 i2ce/modules/Pages/lib/I2CE_Page.php] on line 509 | ||
*Signature: public function display($supress_output) | *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 | |||
===displayCommandLine()=== | |||
Main display method for command line interface | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L520 i2ce/modules/Pages/lib/I2CE_Page.php] on line 520 | |||
*Signature: protected function displayCommandLine() | |||
===displayWeb()=== | |||
Main display method for web interface | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L532 i2ce/modules/Pages/lib/I2CE_Page.php] on line 532 | |||
*Signature: protected function displayWeb($supress_output) | |||
*Parameters: | *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 | ** [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 | ||
Line 213: | Line 281: | ||
===fixupRequestVariables()=== | ===fixupRequestVariables()=== | ||
Applies any transformations (make sure magic quotes is off, nesting, and json decoding) to an array variables @param boolean $transform. Defaults to true | 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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L406 i2ce/modules/Pages/lib/I2CE_Page.php] on line 406 | ||
*Signature: static public function fixupRequestVariables($vars) | *Signature: static public function fixupRequestVariables($vars) | ||
*Parameters: | *Parameters: | ||
Line 219: | Line 287: | ||
*Returns: $vars; | *Returns: $vars; | ||
===flattenRequestVars()=== | ===flattenRequestVars()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L428 i2ce/modules/Pages/lib/I2CE_Page.php] on line 428 | ||
*Signature: static public function flattenRequestVars($vars) | *Signature: static public function flattenRequestVars($vars) | ||
*Parameters: | *Parameters: | ||
Line 225: | Line 293: | ||
===get()=== | ===get()=== | ||
Gets/sets the [[#$get | $get]] value for the given key. | Gets/sets the [[#$get | $get]] value for the given key. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L822 i2ce/modules/Pages/lib/I2CE_Page.php] on line 822 | ||
*Signature: public function get($key,$val) | *Signature: public function get($key,$val) | ||
*Parameters: | *Parameters: | ||
Line 235: | Line 303: | ||
===getAccess()=== | ===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. | 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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L686 i2ce/modules/Pages/lib/I2CE_Page.php] on line 686 | ||
*Signature: protected function getAccess() | *Signature: protected function getAccess() | ||
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>of string | *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>of string | ||
===getAccessedBaseURL()=== | ===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 | 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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L93 i2ce/modules/Pages/lib/I2CE_Page.php] on line 93 | ||
*Signature: static public function getAccessedBaseURL() | *Signature: static public function getAccessedBaseURL() | ||
*Returns: [http://www.php.net/manual/en/language.types.string.php string ] | *Returns: [http://www.php.net/manual/en/language.types.string.php string ] | ||
===getTemplate()=== | ===getTemplate()=== | ||
Get the template associated to this page | Get the template associated to this page | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L161 i2ce/modules/Pages/lib/I2CE_Page.php] on line 161 | ||
*Signature: public function getTemplate() | *Signature: public function getTemplate() | ||
===getTitle()=== | ===getTitle()=== | ||
Return the title for this page. | Return the title for this page. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L154 i2ce/modules/Pages/lib/I2CE_Page.php] on line 154 | ||
*Signature: | *Signature: public function getTitle() | ||
*Returns: [http://www.php.net/manual/en/language.types.string.php string ] | *Returns: [http://www.php.net/manual/en/language.types.string.php string ] | ||
===getURLRoot()=== | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L207 i2ce/modules/Pages/lib/I2CE_Page.php] on line 207 | |||
*Signature: public function getURLRoot($page_remainder) | |||
*Parameters: | |||
**$page_remainder | |||
***Default Value: null | |||
===getUser()=== | ===getUser()=== | ||
Get the user of this page | Get the user of this page | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L702 i2ce/modules/Pages/lib/I2CE_Page.php] on line 702 | ||
*Signature: public function getUser() | *Signature: public function getUser() | ||
*Returns: [[Class: I2CE_User (Development) | I2CE_User]] | *Returns: [[Class: I2CE_User (Development) | I2CE_User]] | ||
===get_exists()=== | ===get_exists()=== | ||
Check to see if a key exists in the [[#$get | $get]] array. | Check to see if a key exists in the [[#$get | $get]] array. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L801 i2ce/modules/Pages/lib/I2CE_Page.php] on line 801 | ||
*Signature: public function get_exists($key) | *Signature: public function get_exists($key) | ||
*Parameters: | *Parameters: | ||
Line 266: | Line 340: | ||
===hasPermission()=== | ===hasPermission()=== | ||
Parse a permission string to see if we have permission. | Parse a permission string to see if we have permission. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L260 i2ce/modules/Pages/lib/I2CE_Page.php] on line 260 | ||
*Signature: public function hasPermission($permission,$node) | *Signature: public function hasPermission($permission,$node) | ||
*Parameters: | *Parameters: | ||
Line 273: | Line 347: | ||
***Default Value: null | ***Default Value: null | ||
*Returns: boolean.<br/>Null on failure. | *Returns: boolean.<br/>Null on failure. | ||
===initPage()=== | |||
Initializes any data for the page | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L495 i2ce/modules/Pages/lib/I2CE_Page.php] on line 495 | |||
*Signature: protected function initPage() | |||
*Returns: boolean.<br/>True on sucess. False on failture | |||
===initializeTemplate()=== | ===initializeTemplate()=== | ||
Handles creating hte I2CE_TemplateMeister templates and loading any default templates | Handles creating hte I2CE_TemplateMeister templates and loading any default templates | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L313 i2ce/modules/Pages/lib/I2CE_Page.php] on line 313 | ||
*Signature: protected function initializeTemplate() | *Signature: protected function initializeTemplate() | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>true on success | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>true on success | ||
===isGet()=== | ===isGet()=== | ||
Check to see if the current page is a GET request or not | Check to see if the current page is a GET request or not | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L731 i2ce/modules/Pages/lib/I2CE_Page.php] on line 731 | ||
*Signature: public function isGet() | *Signature: public function isGet() | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===isPost()=== | ===isPost()=== | ||
Check to see if the current page is a POST form submission or not. | Check to see if the current page is a POST form submission or not. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L722 i2ce/modules/Pages/lib/I2CE_Page.php] on line 722 | ||
*Signature: public function isPost() | *Signature: public function isPost() | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===loadHTMLTemplates()=== | ===loadHTMLTemplates()=== | ||
Load the template (HTML or XML) files to the template object. | Load the template (HTML or XML) files to the template object. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L123 i2ce/modules/Pages/lib/I2CE_Page.php] on line 123 | ||
*Signature: protected function loadHTMLTemplates() | *Signature: protected function loadHTMLTemplates() | ||
===module()=== | ===module()=== | ||
Sets/Gets the module. | Sets/Gets the module. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L453 i2ce/modules/Pages/lib/I2CE_Page.php] on line 453 | ||
*Signature: public function module($module) | *Signature: public function module($module) | ||
*Parameters: | *Parameters: | ||
Line 302: | Line 381: | ||
===page()=== | ===page()=== | ||
Sets/Gets the page. | Sets/Gets the page. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L465 i2ce/modules/Pages/lib/I2CE_Page.php] on line 465 | ||
*Signature: public function page($page) | *Signature: public function page($page) | ||
*Parameters: | *Parameters: | ||
Line 310: | Line 389: | ||
===pageRemainder()=== | ===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. | 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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L197 i2ce/modules/Pages/lib/I2CE_Page.php] on line 197 | ||
*Signature: public function pageRemainder($page_remainder) | *Signature: public function pageRemainder($page_remainder) | ||
*Parameters: | *Parameters: | ||
Line 318: | Line 397: | ||
===pageRoot()=== | ===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. | 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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L177 i2ce/modules/Pages/lib/I2CE_Page.php] on line 177 | ||
*Signature: public function pageRoot($page_root) | *Signature: public function pageRoot($page_root) | ||
*Parameters: | *Parameters: | ||
Line 326: | Line 405: | ||
===post()=== | ===post()=== | ||
Get/set the [[#$post | $post]] value for the given key. | Get/set the [[#$post | $post]] value for the given key. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L760 i2ce/modules/Pages/lib/I2CE_Page.php] on line 760 | ||
*Signature: public function post($key,$val) | *Signature: public function post($key,$val) | ||
*Parameters: | *Parameters: | ||
Line 336: | Line 415: | ||
===post_exists()=== | ===post_exists()=== | ||
Check to see if a key exists in the [[#$post | $post]] array. | Check to see if a key exists in the [[#$post | $post]] array. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L739 i2ce/modules/Pages/lib/I2CE_Page.php] on line 739 | ||
*Signature: public function post_exists($key) | *Signature: public function post_exists($key) | ||
*Parameters: | *Parameters: | ||
Line 343: | Line 422: | ||
===redirect()=== | ===redirect()=== | ||
Send the redirect header with the given URL. | Send the redirect header with the given URL. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L102 i2ce/modules/Pages/lib/I2CE_Page.php] on line 102 | ||
*Signature: public function redirect($url) | *Signature: public function redirect($url) | ||
*Parameters: | *Parameters: | ||
Line 349: | Line 428: | ||
===request()=== | ===request()=== | ||
Return the given value for the key in one of the request arrays. | Return the given value for the key in one of the request arrays. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L941 i2ce/modules/Pages/lib/I2CE_Page.php] on line 941 | ||
*Signature: public function request($key) | *Signature: public function request($key) | ||
*Parameters: | *Parameters: | ||
Line 357: | Line 436: | ||
===request_exists()=== | ===request_exists()=== | ||
Checks all the request arrays for the given key and returns true if it 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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L929 i2ce/modules/Pages/lib/I2CE_Page.php] on line 929 | ||
*Signature: public function request_exists($key) | *Signature: public function request_exists($key) | ||
*Parameters: | *Parameters: | ||
Line 364: | Line 443: | ||
===rewrittenURLs()=== | ===rewrittenURLs()=== | ||
returns true if the url's have been written. false if not | returns true if the url's have been written. false if not | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L83 i2ce/modules/Pages/lib/I2CE_Page.php] on line 83 | ||
*Signature: static public function rewrittenURLs() | *Signature: static public function rewrittenURLs() | ||
===session_req()=== | ===session_req()=== | ||
Gets/sets the [[#$session_req | $session_req]] value for the given key. | Gets/sets the [[#$session_req | $session_req]] value for the given key. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L891 i2ce/modules/Pages/lib/I2CE_Page.php] on line 891 | ||
*Signature: public function session_req($key,$val) | *Signature: public function session_req($key,$val) | ||
*Parameters: | *Parameters: | ||
Line 378: | Line 457: | ||
===session_req_exists()=== | ===session_req_exists()=== | ||
Check to see if a key exists in the [[#$session_req | $session_req]] array. | Check to see if a key exists in the [[#$session_req | $session_req]] array. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L870 i2ce/modules/Pages/lib/I2CE_Page.php] on line 870 | ||
*Signature: public function session_req_exists($key) | *Signature: public function session_req_exists($key) | ||
*Parameters: | *Parameters: | ||
Line 385: | Line 464: | ||
===setAccess()=== | ===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 | 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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L673 i2ce/modules/Pages/lib/I2CE_Page.php] on line 673 | ||
*Signature: public function setAccess($access) | *Signature: public function setAccess($access) | ||
*Parameters: | *Parameters: | ||
**$access | **$access | ||
===setActiveMenu()=== | |||
Set the active menu | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L486 i2ce/modules/Pages/lib/I2CE_Page.php] on line 486 | |||
*Signature: protected function setActiveMenu() | |||
===setIsPost()=== | ===setIsPost()=== | ||
Sets if this pages is a post or not | Sets if this pages is a post or not | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L709 i2ce/modules/Pages/lib/I2CE_Page.php] on line 709 | ||
*Signature: public function setIsPost($post) | *Signature: public function setIsPost($post) | ||
*Parameters: | *Parameters: | ||
Line 397: | Line 480: | ||
===setRedirect()=== | ===setRedirect()=== | ||
Set the URL to be redirected to instead of displaying this page. | Set the URL to be redirected to instead of displaying this page. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L973 i2ce/modules/Pages/lib/I2CE_Page.php] on line 973 | ||
*Signature: public function setRedirect($url) | *Signature: public function setRedirect($url) | ||
*Parameters: | *Parameters: | ||
Line 403: | Line 486: | ||
===setupGetPost()=== | ===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 | 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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/lib/I2CE_Page.php#L354 i2ce/modules/Pages/lib/I2CE_Page.php] on line 354 | ||
*Signature: protected function setupGetPost($get,$post,$strip) | *Signature: protected function setupGetPost($get,$post,$strip) | ||
*Parameters: | *Parameters: | ||
Line 427: | Line 510: | ||
===addColorPickerTriple()=== | ===addColorPickerTriple()=== | ||
This method is implemented by [[Class: I2CE_Module_ColorPicker (Development)#addColorPickerTriple() | I2CE_Module_ColorPicker->addColorPickerTriple() ]] | This method is implemented by [[Class: I2CE_Module_ColorPicker (Development)#addColorPickerTriple() | I2CE_Module_ColorPicker->addColorPickerTriple() ]] | ||
===addReportSelector()=== | |||
This method is implemented by [[Class: I2CE_Module_ReportSelector (Development)#addReportSelector() | I2CE_Module_ReportSelector->addReportSelector() ]] | |||
===addDatePicker()=== | ===addDatePicker()=== | ||
This method is implemented by [[Class: I2CE_Module_DatePicker (Development)#addDatePicker() | I2CE_Module_DatePicker->addDatePicker() ]] | This method is implemented by [[Class: I2CE_Module_DatePicker (Development)#addDatePicker() | I2CE_Module_DatePicker->addDatePicker() ]] | ||
Line 445: | Line 530: | ||
===setClassValues()=== | ===setClassValues()=== | ||
This method is implemented by [[Class: I2CE_MootoolsCore (Development)#setClassValues() | I2CE_MootoolsCore->setClassValues() ]] | This method is implemented by [[Class: I2CE_MootoolsCore (Development)#setClassValues() | I2CE_MootoolsCore->setClassValues() ]] | ||
===useDropDown()=== | |||
This method is implemented by [[Class: I2CE_MootoolsCore (Development)#useDropDown() | I2CE_MootoolsCore->useDropDown() ]] | |||
===addOption()=== | ===addOption()=== | ||
This method is implemented by [[Class: I2CE_Template_Options (Development)#addOption() | I2CE_Template_Options->addOption() ]] | This method is implemented by [[Class: I2CE_Template_Options (Development)#addOption() | I2CE_Template_Options->addOption() ]] | ||
Line 455: | Line 542: | ||
===setForm()=== | ===setForm()=== | ||
This method is implemented by [[Class: I2CE_Module_Forms (Development)#setForm() | I2CE_Module_Forms->setForm() ]] | This method is implemented by [[Class: I2CE_Module_Forms (Development)#setForm() | I2CE_Module_Forms->setForm() ]] | ||
===getForm()=== | |||
This method is implemented by [[Class: I2CE_Module_Forms (Development)#getForm() | I2CE_Module_Forms->getForm() ]] | |||
===getField()=== | ===getField()=== | ||
This method is implemented by [[Class: I2CE_Module_Forms (Development)#getField() | I2CE_Module_Forms->getField() ]] | This method is implemented by [[Class: I2CE_Module_Forms (Development)#getField() | I2CE_Module_Forms->getField() ]] | ||
Line 461: | Line 550: | ||
===isReview()=== | ===isReview()=== | ||
This method is implemented by [[Class: I2CE_Module_Forms (Development)#isReview() | I2CE_Module_Forms->isReview() ]] | This method is implemented by [[Class: I2CE_Module_Forms (Development)#isReview() | I2CE_Module_Forms->isReview() ]] | ||
===makeJumper()=== | ===makeJumper()=== | ||
This method is implemented by [[Class: I2CE_Module_Jumper (Development)#makeJumper() | I2CE_Module_Jumper->makeJumper() ]] | This method is implemented by [[Class: I2CE_Module_Jumper (Development)#makeJumper() | I2CE_Module_Jumper->makeJumper() ]] | ||
===makeScalingJumper()=== | |||
This method is implemented by [[Class: I2CE_Module_Jumper (Development)#makeScalingJumper() | I2CE_Module_Jumper->makeScalingJumper() ]] | |||
===menuSelect()=== | ===menuSelect()=== | ||
This method is implemented by [[Class: I2CE_Module_MenuSelect (Development)#menuSelect() | I2CE_Module_MenuSelect->menuSelect() ]] | This method is implemented by [[Class: I2CE_Module_MenuSelect (Development)#menuSelect() | I2CE_Module_MenuSelect->menuSelect() ]] | ||
Line 473: | Line 560: | ||
===addAjaxUpdate()=== | ===addAjaxUpdate()=== | ||
This method is implemented by [[Class: I2CE_Stub (Development)#addAjaxUpdate() | I2CE_Stub->addAjaxUpdate() ]] | This method is implemented by [[Class: I2CE_Stub (Development)#addAjaxUpdate() | I2CE_Stub->addAjaxUpdate() ]] | ||
===addAjaxLoad()=== | |||
This method is implemented by [[Class: I2CE_Stub (Development)#addAjaxLoad() | I2CE_Stub->addAjaxLoad() ]] | |||
===addAjaxToggle()=== | ===addAjaxToggle()=== | ||
This method is implemented by [[Class: I2CE_Stub (Development)#addAjaxToggle() | I2CE_Stub->addAjaxToggle() ]] | This method is implemented by [[Class: I2CE_Stub (Development)#addAjaxToggle() | I2CE_Stub->addAjaxToggle() ]] |
Latest revision as of 09:16, 6 May 2015
This article describes the class I2CE_Page .
- Extends the class: I2CE_Fuzzy.
- Child Classes:
- I2CE_Page_BackgroundProcess
- I2CE_Page_Run_SQL
- I2CE_Page_BinaryField
- I2CE_Page_CachedForm
- iHRIS_PageCalendar
- I2CE_PageReportAction
- I2CE_Page_CustomReports
- I2CE_Page_ShowReport
- iHRIS_PageDashboard
- iHRIS_Page_ExportDHISDashboard
- iHRIS_DHIS_DashboardSubmit
- iHRIS_DHIS_MetadataUpload
- I2CE_PageDashboard
- I2CE_FileDump
- I2CE_PageAutoList
- I2CE_PageRemap
- I2CE_PageViewList
- I2CE_PageFeedback
- I2CE_PageForgot
- I2CE_PageLogin
- I2CE_PageLogout
- I2CE_PagePassword
- I2CE_Page_TreeSelectData
- I2CE_PageOpenLayers
- I2CE_Page_PrintedForms
- I2CE_Page_ArchiveReport
- I2CE_PageViewUser
- iHRIS_PageViewByChild
- I2CE_PageAdmin
- I2CE_PageCron
- I2CE_Page_DeleteRecord
- I2CE_Page_ExportReport
- I2CE_PageFormBrowser
- I2Ce_Page_FormDocumentor
- I2CE_PageActionRelationship
- I2CE_PageFormBase
- I2CE_PageForm
- iHRIS_PageFormDataElement
- iHRIS_PageFormDataSet
- iHRIS_PageViewDHIS
- I2CE_PageFormLists
- iHRIS_Page_SelfService_Apply
- iHRIS_PageFormParentPerson
- iHRIS_PageFormPerson
- iHRIS_Page_SelfService_Register
- I2CE_PageForm_UserRequestEmail
- I2CE_PageFormParentUser
- I2CE_PageFormUser
- I2CE_PageFormAuto
- I2CE_PageFormParent
- iHRIS_PageFormSalary
- iHRIS_PageFormFacilityInstitution
- iHRIS_PageFormParentTraining
- iHRIS_PageFormTrainingProgram
- iHRIS_PageForm_Person_Scheduled_Training_Course
- iHRIS_Page_FormExam
- iHRIS_PageFormParentTrainingInstitution
- iHRIS_PageForm_Evaluate_Course_Competencies
- I2CE_PageFormCSV
- I2CE_PageMultiForm
- I2CE_PageForm
- I2CE_PageViewChildren
- iHRIS_PageConfigure
- iHRIS_PageFieldHistory
- iHRIS_PageHistory
- iHRIS_PageIndex
- iHRIS_PageMassDeleteSearchAction
- iHRIS_PageRecentForm
- iHRIS_PageManage
- iHRIS_PageViewJob
- iHRIS_PageMassDeleteFacilityAction
- iHRIS_PageViewPosition
- iHRIS_SalaryHistoryPage
- iHRIS_PageViewTraining
- I2CE_Page_LocaleAdmin
- I2CE_Page_MagicDataBrowser
- I2CE_Page_MagicDataExport
- I2Ce_Page_ModDocumentor
- I2CE_PagePChart
- iHRIS_Page_Person_Competency_Evaluation_History
- I2CE_Page_Stub
- I2CE_Page_Stub_Ajax_Test
- I2CE_Page_SwissConfig
- I2CE_Page_SwissMagic
- I2CE_Page_TasksAndRoles
- iHRIS_PageActionStudents
- I2CE_WebService
- Location: Part of the module pages in the package I2CE 4.1-dev
- Source: Defined in the file 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 i2ce/modules/Pages/lib/I2CE_Page.php on line 42
- Type: protected I2CE_Template $template
$defaultHTMLFile
The default HTML/XML files to be displayed by the template. of string
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 47
- Type: protected array $defaultHTMLFile
$role
The role that can view this page.
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 52
- Type: protected mixed $role
$user
The user viewing this page.
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 57
- Type: protected I2CE_User $user
$access
The access level required for this page.
- Defined in 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 i2ce/modules/Pages/lib/I2CE_Page.php on line 67
- Type: protected string $redirect
$post
Holds a reference to the $_POST array which is a list of all data sent from a form.
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 72
- Type: protected 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 i2ce/modules/Pages/lib/I2CE_Page.php on line 78
- Type: protected 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 i2ce/modules/Pages/lib/I2CE_Page.php on line 170
- Type: protected 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 i2ce/modules/Pages/lib/I2CE_Page.php on line 190
- Type: protected string $page_remainder
$args
The arguments passed in the constructor. @param protected array $args
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 241
- 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 i2ce/modules/Pages/lib/I2CE_Page.php on line 246
- Type: protected $request_remainder
$permissionParser
The permission parser for the user of this page. @param I2CE_PermissionParser $permissionParser
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 251
- Type: protected $permissionParser
$root_url
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 265
- Type: protected $root_url
$page
. The requested page
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 477
- Type: protected string $page
$module
. The module that contains this page.
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 481
- Type: protected string $module
$is_post
-- true if this page is a post.
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 716
- Type: protected 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 i2ce/modules/Pages/lib/I2CE_Page.php on line 865
- Type: protected array $session_req
$request_vars
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 935
- 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 and objects and sets up the basic member variables.
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 274
- Signature: public function __construct($args,$request_remainder,$get,$post)
- Parameters:
_display()
Display the template as HTML/XML. Sets the header and displays any buffered warnings/echoed text.
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 593
- Signature: protected function _display($supress_output)
- Parameters:
- $supress_output
_flattenRequestVars()
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 435
- Signature: static public function _flattenRequestVars($vars,$req,$prefix)
- Parameters:
- $vars
- &$req
- $prefix
action()
Perform any actions
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 144
- Signature: protected function action()
- Returns: boolean.
true on sucess
actionCommandLine()
The business method if this page is called from the commmand line
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 662
- Signature: protected function actionCommandLine($args,$request_remainder)
- Parameters:
- array $args
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') - array $request_remainder
the remainder of the request after the page specfication.
- array $args
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 ::display() template display method will be called to output the combined template files to the browser.
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 509
- Signature: public function display($supress_output)
- Parameters:
- boolean $supress_output
defaults to false. set to true to supress the output of a webpage- Default Value: false
- boolean $supress_output
displayCommandLine()
Main display method for command line interface
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 520
- Signature: protected function displayCommandLine()
displayWeb()
Main display method for web interface
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 532
- Signature: protected function displayWeb($supress_output)
- Parameters:
- boolean $supress_output
defaults to false. set to true to supress the output of a webpage- Default Value: false
- boolean $supress_output
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 i2ce/modules/Pages/lib/I2CE_Page.php on line 406
- Signature: static public function fixupRequestVariables($vars)
- Parameters:
- array $vars
- Returns: $vars;
flattenRequestVars()
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 428
- Signature: static public function flattenRequestVars($vars)
- Parameters:
- $vars
get()
Gets/sets the $get value for the given key.
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 822
- Signature: public function get($key,$val)
- Parameters:
- Returns: mixed
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 variable.
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 686
- Signature: protected function getAccess()
- Returns: array
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 i2ce/modules/Pages/lib/I2CE_Page.php on line 93
- Signature: static public function getAccessedBaseURL()
- Returns: string
getTemplate()
Get the template associated to this page
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 161
- Signature: public function getTemplate()
getTitle()
Return the title for this page.
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 154
- Signature: public function getTitle()
- Returns: string
getURLRoot()
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 207
- Signature: public function getURLRoot($page_remainder)
- Parameters:
- $page_remainder
- Default Value: null
- $page_remainder
getUser()
Get the user of this page
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 702
- Signature: public function getUser()
- Returns: I2CE_User
get_exists()
Check to see if a key exists in the $get array.
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 801
- Signature: public function get_exists($key)
- Parameters:
- $key
- Returns: boolean
hasPermission()
Parse a permission string to see if we have permission.
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 260
- Signature: public function hasPermission($permission,$node)
- Parameters:
- Returns: boolean.
Null on failure.
initPage()
Initializes any data for the page
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 495
- Signature: protected function initPage()
- Returns: boolean.
True on sucess. False on failture
initializeTemplate()
Handles creating hte I2CE_TemplateMeister templates and loading any default templates
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 313
- Signature: protected function initializeTemplate()
- Returns: boolean
true on success
isGet()
Check to see if the current page is a GET request or not
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 731
- Signature: public function isGet()
- Returns: boolean
isPost()
Check to see if the current page is a POST form submission or not.
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 722
- Signature: public function isPost()
- Returns: boolean
loadHTMLTemplates()
Load the template (HTML or XML) files to the template object.
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 123
- Signature: protected function loadHTMLTemplates()
module()
Sets/Gets the module.
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 453
- Signature: public function module($module)
- Parameters:
- string $module
If non-null sets the module's name to $module.- Default Value: null
- string $module
- Returns: string
if $module was non-null
page()
Sets/Gets the page.
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 465
- Signature: public function page($page)
- Parameters:
- string $page
If non-null sets the page's name to $page.- Default Value: null
- string $page
- Returns: string
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 i2ce/modules/Pages/lib/I2CE_Page.php on line 197
- Signature: public function pageRemainder($page_remainder)
- Parameters:
- $page_remainder
- Default Value: null
- $page_remainder
- Returns: string
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 i2ce/modules/Pages/lib/I2CE_Page.php on line 177
- Signature: public function pageRoot($page_root)
- Parameters:
- $page_root
- Default Value: null
- $page_root
- Returns: string
if $page_root was null(default)
post()
Get/set the $post value for the given key.
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 760
- Signature: public function post($key,$val)
- Parameters:
- Returns: mixed
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 array.
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 739
- Signature: public function post_exists($key)
- Parameters:
- $key
- Returns: boolean
redirect()
Send the redirect header with the given URL.
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 102
- Signature: public function redirect($url)
- Parameters:
- string $url
request()
Return the given value for the key in one of the request arrays.
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 941
- Signature: public function request($key)
- Parameters:
- mixed $key
- Default Value: null
- mixed $key
- Returns: mixed
request_exists()
Checks all the request arrays for the given key and returns true if it exists.
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 929
- Signature: public function request_exists($key)
- Parameters:
- mixed $key
- Returns: boolean
rewrittenURLs()
returns true if the url's have been written. false if not
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 83
- Signature: static public function rewrittenURLs()
session_req()
Gets/sets the $session_req value for the given key.
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 891
- Signature: public function session_req($key,$val)
- Parameters:
- Returns: mixed
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 array.
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 870
- Signature: public function session_req_exists($key)
- Parameters:
- $key
- Returns: 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 variable. @param array of string
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 673
- Signature: public function setAccess($access)
- Parameters:
- $access
setActiveMenu()
Set the active menu
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 486
- Signature: protected function setActiveMenu()
setIsPost()
Sets if this pages is a post or not
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 709
- Signature: public function setIsPost($post)
- Parameters:
- $post
setRedirect()
Set the URL to be redirected to instead of displaying this page.
- Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 973
- Signature: public function setRedirect($url)
- Parameters:
- 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 i2ce/modules/Pages/lib/I2CE_Page.php on line 354
- Signature: protected function setupGetPost($get,$post,$strip)
- Parameters:
Inherited Methods
_hasMethod()
This public method is inherited from I2CE_Fuzzy->_hasMethod()
Inherited Fuzzy Methods
userMessage()
This method is inherited from I2CE_Fuzzy->userMessage()
Fuzzy Methods
launchBackgroundProcess()
This method is implemented by I2CE_BackgroundProcess->launchBackgroundProcess()
launchBackgroundPHPScript()
This method is implemented by I2CE_BackgroundProcess->launchBackgroundPHPScript()
launchBackgroundPage()
This method is implemented by I2CE_BackgroundProcess->launchBackgroundPage()
addColorPickerTriple()
This method is implemented by I2CE_Module_ColorPicker->addColorPickerTriple()
addReportSelector()
This method is implemented by I2CE_Module_ReportSelector->addReportSelector()
addDatePicker()
This method is implemented by I2CE_Module_DatePicker->addDatePicker()
selectOptionsImmediate()
This method is implemented by I2CE_DisplayData->selectOptionsImmediate()
setDisplayData()
This method is implemented by I2CE_DisplayData->setDisplayData()
setDisplayDataImmediate()
This method is implemented by I2CE_DisplayData->setDisplayDataImmediate()
addFormWorm()
This method is implemented by I2CE_Module_FormWorm->addFormWorm()
getClassValue()
This method is implemented by I2CE_MootoolsCore->getClassValue()
loadClassValues()
This method is implemented by I2CE_MootoolsCore->loadClassValues()
setClassValue()
This method is implemented by I2CE_MootoolsCore->setClassValue()
setClassValues()
This method is implemented by I2CE_MootoolsCore->setClassValues()
useDropDown()
This method is implemented by I2CE_MootoolsCore->useDropDown()
addOption()
This method is implemented by I2CE_Template_Options->addOption()
addOptions()
This method is implemented by I2CE_Template_Options->addOptions()
addAutoCompleteInputTreeById()
This method is implemented by I2CE_Module_TreeSelect->addAutoCompleteInputTreeById()
addAutoCompleteInputTree()
This method is implemented by I2CE_Module_TreeSelect->addAutoCompleteInputTree()
setForm()
This method is implemented by I2CE_Module_Forms->setForm()
getForm()
This method is implemented by I2CE_Module_Forms->getForm()
getField()
This method is implemented by I2CE_Module_Forms->getField()
setReview()
This method is implemented by I2CE_Module_Forms->setReview()
isReview()
This method is implemented by I2CE_Module_Forms->isReview()
makeJumper()
This method is implemented by I2CE_Module_Jumper->makeJumper()
makeScalingJumper()
This method is implemented by I2CE_Module_Jumper->makeScalingJumper()
This method is implemented by I2CE_Module_MenuSelect->menuSelect()
addUpdateSelect()
This method is implemented by I2CE_Module_MenuSelect->addUpdateSelect()
addAjaxUpdate()
This method is implemented by I2CE_Stub->addAjaxUpdate()
addAjaxLoad()
This method is implemented by I2CE_Stub->addAjaxLoad()
addAjaxToggle()
This method is implemented by I2CE_Stub->addAjaxToggle()
addAjaxRequestFunction()
This method is implemented by I2CE_Stub->addAjaxRequestFunction()
addAjaxCompleteFunction()
This method is implemented by I2CE_Stub->addAjaxCompleteFunction()
addAjaxToggleOnFunction()
This method is implemented by I2CE_Stub->addAjaxToggleOnFunction()
addAjaxToggleOffFunction()
This method is implemented by I2CE_Stub->addAjaxToggleOffFunction()
hasAjax()
This method is implemented by I2CE_Stub->hasAjaxFuzzy()
setDataTypePriority()
This method is implemented by I2CE_Module_TemplateData->setDataTypePriority()
setData()
This method is implemented by I2CE_Module_TemplateData->setData()
getData()
This method is implemented by I2CE_Module_TemplateData->getData()
getDefaultData()
This method is implemented by I2CE_Module_TemplateData->getDefaultData()
removeData()
This method is implemented by I2CE_Module_TemplateData->removeData()
getDataNames()
This method is implemented by I2CE_Module_TemplateData->getDataNames()
ensureNode()
This method is implemented by I2CE_Module_TemplateData->ensureNode()