Class: I2CE (4.0.2)

From IHRIS Wiki
Revision as of 14:56, 10 March 2010 by Litlfred (talk | contribs) (Created page with '{{otherversions|Class: I2CE}} This article describes the class ''I2CE'' . *Location: Part of the module I2CE in the package [https://launchpad.n…')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
For other versions, see Class: I2CE (versions) .


This article describes the class I2CE .

  • Location: Part of the module I2CE in the package I2CE 4.0.2-release
  • Source: Defined in the file 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

$updateStart

$storage

I2CE_MagicData

$stored_messages

An array of the notice/warning messages received for this session array $stored_messages

  • Defined in i2ce/lib/I2CE.php on line 666
  • Type: static protected static $stored_messages

$errorType

$noticeErrors

$warningErrors

$ignoreErrorsFromFilesMatching

  • Defined in i2ce/lib/I2CE.php on line 689
  • Type: static public $ignoreErrorsFromFilesMatching

$ignoreErrors

$supress

$site_warnings

Count of the number of erros and warings received when the site is not initialized @param static protected boolean $site_warnings

$error_num

$errorHandler

Optional error handler callback.

$started_errors

$errorImage

$errorStart

$badness

$email

$fileSearch

I2CE_FileSearch $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.

Methods

allSystemsAreGoGo()

Get the system status. http://www.ursula1000.com/

  • Defined in 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: string
    'gogo' means we are good. 'needs_installation' means we need to initialize. 'needs_upgrade'

bringUpSystem()

  • Defined in 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 i2ce/lib/I2CE.php on line 78
  • Signature: static protected function dbConnect($dsn)
  • Parameters:
  • Returns: true
    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 i2ce/lib/I2CE.php on line 305
  • Signature: static public function getAccessedBaseURL($include_http)
  • Parameters:
    • $include_http
      • Default Value: true
  • Returns: string

getConfig()

Get the configuration storage @param string $instance. Defaults to 'default'

getFileSearch()

  • Defined in 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 i2ce/lib/I2CE.php on line 1422
  • Signature: static protected function getPrevMethod($debug,$start_depth,$trace_depth)
  • Parameters:
    • array $debug
    • $start_depth
      • Default Value: 1
    • $trace_depth
      • Default Value: 1
  • Returns: 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 i2ce/lib/I2CE.php on line 236
  • Signature: static public function getRuntimeVariable($var,$val)
  • Parameters:
    • string $var
      the variable name
    • string $val
      the defualt value; Defaults to the zero length string
      • Default Value:

handleError()

  • Defined in 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

initialize()

Gets the core system going.

  • Defined in 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:
    • string $db_user
      the database user
    • string $db_pass
      the database user's password
    • string $db_name
      the name of the database all data is stored in
    • string $user_db
      the name of the database which contains the user table. If null then we use $db
    • string $site_module_file
      the configttion file for the site module
    • $bring_up_system
      • Default Value: true
  • Returns: boolean.
    True on sucess

longExecution()

  • Defined in 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 i2ce/lib/I2CE.php on line 1468
  • Signature: static public function pearError($obj,$message,$type,$redirect)
  • Parameters:
    • mixed $obj
    • string $message
      The error message to display if it is an error.
    • integer $type
      The error type to raise.
      • Default Value: E_USER_NOTICE
    • string $redirect
      The page to redirect to if this is a critical error.
      • Default Value: ""

popErrorHandler()

Pop an error handler off of the stack.

  • Defined in i2ce/lib/I2CE.php on line 758
  • Signature: static public function popErrorHandler()
  • Returns: $callback
    the callback popped off the stack

pushErrorHandler()

Push an error handler onto the stack. @param $callback

  • Defined in 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 i2ce/lib/I2CE.php on line 1269
  • Signature: static public function raiseError($message,$type,$redirect)
  • Parameters:
    • $message
      • Default Value: null
    • integer $type
      The error type.
      • Default Value: E_USER_NOTICE
    • string $redirect
      The page to redirect to for critical errors. @global array
      • Default Value: ""

resetFileSearch()

  • Defined in 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 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 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 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.
    The previous value of trace depth.

setupDatabaseReferences()

Setup the references to database names in magic data

  • Defined in i2ce/lib/I2CE.php on line 266
  • Signature: static protected function setupDatabaseReferences($user_db)
  • Parameters:
    • string $user_db
      defaults
      • Default Value: null

setupFileSearch()

Create and populate the file search

  • Defined in i2ce/lib/I2CE.php on line 194
  • Signature: static public function setupFileSearch($paths,$clear_cache)
  • Parameters:
    • array $paths
      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()
    • boolean $clear_cache
      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 i2ce/lib/I2CE.php on line 158
  • Signature: static protected function setupMagicData()

setupSession()

Setup the session variables

  • Defined in 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 i2ce/lib/I2CE.php on line 63
  • Signature: static public function siteInitialized($init)
  • Parameters:
    • $init
      • Default Value: null
  • Returns: mixed.
Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_(4.0.2)&oldid=12175"