|
|
| Line 1: |
Line 1: |
| This article describes the class ''I2CE''.
| | #REDIRECT [[Class: I2CE (4.0.3)]] |
| *Location: Part of the module [[I2CE Module List#I2CE|I2CE]] 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:/lib/I2CE.php#L44 lib/I2CE.php] on line 44
| |
| This class mainly handles throwing errors from withing I2CE
| |
| ==Variables==
| |
| ===$site_initialized===
| |
| True if the site has been initalized. @param static protected boolean $site_initalized
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L51 i2ce/lib/I2CE.php] on line 51
| |
| *Type: static protected $site_initialized
| |
| | |
| ===$updateStart===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L513 i2ce/lib/I2CE.php] on line 513
| |
| *Type: protected $updateStart
| |
| | |
| ===$storage===
| |
| I2CE_MagicData
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L656 i2ce/lib/I2CE.php] on line 656
| |
| *Type: static protected static $storage
| |
| | |
| ===$stored_messages===
| |
| An array of the notice/warning messages received for this session array $stored_messages
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L666 i2ce/lib/I2CE.php] on line 666
| |
| *Type: static protected static $stored_messages
| |
| | |
| ===$errorType===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L669 i2ce/lib/I2CE.php] on line 669
| |
| *Type: static public $errorType
| |
| | |
| ===$noticeErrors===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L685 i2ce/lib/I2CE.php] on line 685
| |
| *Type: static public $noticeErrors
| |
| | |
| ===$warningErrors===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L686 i2ce/lib/I2CE.php] on line 686
| |
| *Type: static public $warningErrors
| |
| | |
| ===$ignoreErrorsFromFilesMatching===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L689 i2ce/lib/I2CE.php] on line 689
| |
| *Type: static public $ignoreErrorsFromFilesMatching
| |
| | |
| ===$ignoreErrors===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L690 i2ce/lib/I2CE.php] on line 690
| |
| *Type: static public $ignoreErrors
| |
| | |
| ===$supress===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L699 i2ce/lib/I2CE.php] on line 699
| |
| *Type: protected $supress
| |
| | |
| ===$site_warnings===
| |
| Count of the number of erros and warings received when the site is not initialized @param static protected boolean $site_warnings
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L729 i2ce/lib/I2CE.php] on line 729
| |
| *Type: static protected $site_warnings
| |
| | |
| ===$error_num===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L739 i2ce/lib/I2CE.php] on line 739
| |
| *Type: protected $error_num
| |
| | |
| ===$errorHandler===
| |
| Optional error handler callback.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L744 i2ce/lib/I2CE.php] on line 744
| |
| *Type: static private $errorHandler
| |
| | |
| ===$started_errors===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L762 i2ce/lib/I2CE.php] on line 762
| |
| *Type: protected $started_errors
| |
| | |
| ===$errorImage===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L763 i2ce/lib/I2CE.php] on line 763
| |
| *Type: protected $errorImage
| |
| | |
| ===$errorStart===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L1080 i2ce/lib/I2CE.php] on line 1080
| |
| *Type: protected $errorStart
| |
| | |
| ===$badness===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L1222 i2ce/lib/I2CE.php] on line 1222
| |
| *Type: protected $badness
| |
| | |
| ===$email===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L1258 i2ce/lib/I2CE.php] on line 1258
| |
| *Type: static protected $email
| |
| | |
| ===$fileSearch===
| |
| I2CE_FileSearch $fileSearch
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L1393 i2ce/lib/I2CE.php] on line 1393
| |
| *Type: static protected static $fileSearch
| |
| | |
| ===$trace_depth===
| |
| integer $trace_depth. Defaults to 1. The number of previous methods to report when an error message is developed. Set to a negative number to report all, or 0 to report none.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L1400 i2ce/lib/I2CE.php] on line 1400
| |
| *Type: static protected static $trace_depth
| |
| | |
| ==Methods==
| |
| ===allSystemsAreGoGo()===
| |
| Get the system status. http://www.ursula1000.com/
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L532 i2ce/lib/I2CE.php] on line 532
| |
| *Signature: static public function allSystemsAreGoGo($site_module_file,$check_time)
| |
| *Parameters:
| |
| **$site_module_file
| |
| **$check_time
| |
| ***Default Value: false
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>'gogo' means we are good. 'needs_installation' means we need to initialize. 'needs_upgrade'
| |
| ===bringUpSystem()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L456 i2ce/lib/I2CE.php] on line 456
| |
| *Signature: static protected function bringUpSystem($site_module_file)
| |
| *Parameters:
| |
| **$site_module_file
| |
| ===dbConnect()===
| |
| connect to the database
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L78 i2ce/lib/I2CE.php] on line 78
| |
| *Signature: static protected function dbConnect($dsn)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $dsn
| |
| *Returns: true<br/>on sucess
| |
| ===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:/lib/I2CE.php#L305 i2ce/lib/I2CE.php] on line 305
| |
| *Signature: static public function getAccessedBaseURL($include_http)
| |
| *Parameters:
| |
| **$include_http
| |
| ***Default Value: true
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===getConfig()===
| |
| Get the configuration storage @param string $instance. Defaults to 'default'
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L630 i2ce/lib/I2CE.php] on line 630
| |
| *Signature: static public function getConfig()
| |
| *Returns: [[Class: I2CE_MagicData | I2CE_MagicData]]
| |
| ===getFileSearch()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L647 i2ce/lib/I2CE.php] on line 647
| |
| *Signature: static public function getFileSearch()
| |
| ===getPrevMethod()===
| |
| Parse the debug backtrace to get the method that raised the error.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L1422 i2ce/lib/I2CE.php] on line 1422
| |
| *Signature: static protected function getPrevMethod($debug,$start_depth,$trace_depth)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $debug
| |
| **$start_depth
| |
| ***Default Value: 1
| |
| **$trace_depth
| |
| ***Default Value: 1
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===getRuntimeVariable()===
| |
| Gets a runtime variable. For the CLI is the is from the environment which may be overwridden by a ---long-option from the command line. Otherwise it is set by SetEnv in a .htaccess file (which is stored in $_SERVER)
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L236 i2ce/lib/I2CE.php] on line 236
| |
| *Signature: static public function getRuntimeVariable($var,$val)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $var <br/>the variable name
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $val <br/>the defualt value; Defaults to the zero length string
| |
| ***Default Value: ''
| |
| ===handleError()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L702 i2ce/lib/I2CE.php] on line 702
| |
| *Signature: public function handleError($err_no,$err_string,$err_file,$err_line,$err_context)
| |
| *Parameters:
| |
| **$err_no
| |
| **$err_string
| |
| **$err_file
| |
| ***Default Value: false
| |
| **$err_line
| |
| ***Default Value: false
| |
| **$err_context
| |
| ***Default Value: false
| |
| ===hasWarnings()===
| |
| See if there were any warning messages set before the site was initialized
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L735 i2ce/lib/I2CE.php] on line 735
| |
| *Signature: static public function hasWarnings()
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===initialize()===
| |
| Gets the core system going.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L330 i2ce/lib/I2CE.php] on line 330
| |
| *Signature: static public function initialize($db_user,$db_pass,$db_name,$user_db,$site_module_file,$bring_up_system)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $db_user <br/>the database user
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $db_pass <br/>the database user's password
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $db_name <br/>the name of the database all data is stored in
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $user_db <br/>the name of the database which contains the user table. If null then we use $db
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $site_module_file <br/>the configttion file for the site module
| |
| **$bring_up_system
| |
| ***Default Value: true
| |
| *Returns: boolean.<br/>True on sucess
| |
| ===longExecution()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L599 i2ce/lib/I2CE.php] on line 599
| |
| *Signature: static public function longExecution($limits)
| |
| *Parameters:
| |
| **$limits
| |
| ***Default Value: null
| |
| ===pearError()===
| |
| Check to see if a object is a pear error and raise an error if it is.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L1468 i2ce/lib/I2CE.php] on line 1468
| |
| *Signature: static public function pearError($obj,$message,$type,$redirect)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $obj
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $message <br/>The error message to display if it is an error.
| |
| ** integer $type <br/>The error type to raise.
| |
| ***Default Value: E_USER_NOTICE
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $redirect <br/>The page to redirect to if this is a critical error.
| |
| ***Default Value: ""
| |
| ===popErrorHandler()===
| |
| Pop an error handler off of the stack.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L758 i2ce/lib/I2CE.php] on line 758
| |
| *Signature: static public function popErrorHandler()
| |
| *Returns: $callback<br/>the callback popped off the stack
| |
| ===pushErrorHandler()===
| |
| Push an error handler onto the stack. @param $callback
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L750 i2ce/lib/I2CE.php] on line 750
| |
| *Signature: static public function pushErrorHandler($callback)
| |
| *Parameters:
| |
| **$callback
| |
| ===raiseError()===
| |
| Raise an error and redirect the user for any critical errors. The default redirect will go to the home page for the site. @param string/mixed $message The error message.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L1269 i2ce/lib/I2CE.php] on line 1269
| |
| *Signature: static public function raiseError($message,$type,$redirect)
| |
| *Parameters:
| |
| **$message
| |
| ***Default Value: null
| |
| ** integer $type <br/>The error type.
| |
| ***Default Value: E_USER_NOTICE
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $redirect <br/>The page to redirect to for critical errors. @global array
| |
| ***Default Value: ""
| |
| ===resetFileSearch()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L221 i2ce/lib/I2CE.php] on line 221
| |
| *Signature: public function resetFileSearch()
| |
| ===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:/lib/I2CE.php#L285 i2ce/lib/I2CE.php] on line 285
| |
| *Signature: static public function rewrittenURLs()
| |
| ===setConfig()===
| |
| Sets an instance magic data object @param I2CE_MagicData $magicdata
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L639 i2ce/lib/I2CE.php] on line 639
| |
| *Signature: static public function setConfig($magicData)
| |
| *Parameters:
| |
| **$magicData
| |
| ===setTraceDepth()===
| |
| Set the trace depth used in reporting error messages
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L1411 i2ce/lib/I2CE.php] on line 1411
| |
| *Signature: static public function setTraceDepth($depth)
| |
| *Parameters:
| |
| ** integer $depth Set to a negative number to report all, 0 to report none.
| |
| *Returns: integer.<br/>The previous value of trace depth.
| |
| ===setupDatabaseReferences()===
| |
| Setup the references to database names in magic data
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L266 i2ce/lib/I2CE.php] on line 266
| |
| *Signature: static protected function setupDatabaseReferences($user_db)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $user_db <br/>defaults
| |
| ***Default Value: null
| |
| ===setupFileSearch()===
| |
| Create and populate the file search
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L194 i2ce/lib/I2CE.php] on line 194
| |
| *Signature: static public function setupFileSearch($paths,$clear_cache)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $paths <br/>An array with keys file search categories and values a path or an array of paths to add to the file search
| |
| ***Default Value: array()
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $clear_cache <br/>Default to false. If true, we clear out the APC Cache.
| |
| ***Default Value: false
| |
| ===setupMagicData()===
| |
| Creates the magic data instance. Sets the mafic data storage mechanisms to be used.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L158 i2ce/lib/I2CE.php] on line 158
| |
| *Signature: static protected function setupMagicData()
| |
| ===setupSession()===
| |
| Setup the session variables
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L111 i2ce/lib/I2CE.php] on line 111
| |
| *Signature: static protected function setupSession()
| |
| ===siteInitialized()===
| |
| Get/Set the site's initialization state. @param init. Defaults to null in which case we return the site installation state. if non-null, it is the new site initialization state.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE.php#L63 i2ce/lib/I2CE.php] on line 63
| |
| *Signature: static public function siteInitialized($init)
| |
| *Parameters:
| |
| **$init
| |
| ***Default Value: null
| |
| *Returns: mixed.
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
