Class: I2CE (4.0.6)

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.6-release
• Source: Defined in the file lib/I2CE.php on line 45

Variables

$email

string $email

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

$userAccess

I2CE_UserAccess_Mechanism $userAccess the user access mechanism

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

$fileSearch

I2CE_FileSearch $fileSearch

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

$userAccessProtocol

string $userAccessProtocol the user access class

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

$userAccessInit

array $userAccessInit os string the user access initialization strings

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

$site_initialized

True if the site has been initalized. @param static protected boolean $site_initalized

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

$ob_level

The ooutput buffer level after initializion

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

$updateStart

• Defined in i2ce/lib/I2CE.php on line 684
• Type: protected $updateStart

$storage

I2CE_MagicData

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

Methods

allSystemsAreGoGo()

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

• Defined in i2ce/lib/I2CE.php on line 703
• 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 625
• 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 195
• Signature: static protected function dbConnect($dsn)
• Parameters:
  • string $dsn
• 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 438
• 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'

• Defined in i2ce/lib/I2CE.php on line 803
• Signature: static public function getConfig()
• Returns: I2CE_MagicData

getFileSearch()

• Defined in i2ce/lib/I2CE.php on line 820
• Signature: static public function getFileSearch()

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 370
• 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:

getUserAccess()

Get the user access mechanism

• Defined in i2ce/lib/I2CE.php on line 141
• Signature: static public function getUserAccess()
• Returns: I2CE_UserAccess_Mechansim

getUserAccessInit()

Set the user access mechanism initialization string

• Defined in i2ce/lib/I2CE.php on line 112
• Signature: static public function getUserAccessInit($protocol)
• Parameters:
  • string $protocol
    If null, the default, then we get the init string for the currently registered protocol.
    • Default Value: null
• Returns: string

getUserAccessProtocol()

Gets the registered user access protocol

• Defined in i2ce/lib/I2CE.php on line 75
• Signature: static public function getUserAccessProtocol()

handleError()

• Defined in i2ce/lib/I2CE.php on line 857
• 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 i2ce/lib/I2CE.php on line 883
• Signature: static public function hasWarnings()
• Returns: boolean

initialize()

Gets the core system going. @deprecated since version 4.0.3

• Defined in i2ce/lib/I2CE.php on line 466
• Signature: static public function initialize($db_user,$db_pass,$db_name,$user_access_init,$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_access_init
    the init string for the user access mechanism
  • string $site_module_file
    the configttion file for the site module
  • $bring_up_system
    • Default Value: true
• Returns: boolean.
  True on sucess

initializeDSN()

Gets the core system going.

• Defined in i2ce/lib/I2CE.php on line 522
• Signature: static public function initializeDSN($dsn,$user_access_init,$site_module_file,$bring_up_system)
• Parameters:
  • string $dsn
    dsn string to connect to the database
  • string $user_access_init
    the init string for the user access mechanism
  • 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 770
• Signature: static public function longExecution($limits,$notice)
• Parameters:
  • $limits
    • Default Value: null
  • $notice
    • Default Value: false

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 870
• 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: ""

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 852
• 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: ""

raiseMessage()

Raise an error message, but don't display any extra trace messages to keep the log file short when the trace isn't necessary. @param string/mixed $message The error message.

• Defined in i2ce/lib/I2CE.php on line 838
• Signature: static public function raiseMessage($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.
    • Default Value: ""

resetFileSearch()

• Defined in i2ce/lib/I2CE.php on line 355
• 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 418
• Signature: static public function rewrittenURLs()

setConfig()

Sets an instance magic data object @param I2CE_MagicData $magicdata

• Defined in i2ce/lib/I2CE.php on line 812
• Signature: static public function setConfig($magicData)
• Parameters:
  • $magicData

setUserAccess()

Set the user access mechanism

• Defined in i2ce/lib/I2CE.php on line 129
• Signature: static public function setUserAccess($userAccess)
• Parameters:
  • I2CE_UserAccess_Mechanism $userAccess

setUserAccessInit()

Set the user access mechanism initialization string

• Defined in i2ce/lib/I2CE.php on line 85
• Signature: static public function setUserAccessInit($userAccessInit,$protocol,$set_protocol)
• Parameters:
  • string $userAccessInit
  • string $protocol
    Defaults to null in which case we parse it from the init string
    • Default Value: null
  • boolean $set_protocol
    Defatuls to false. If true we set the current protocol to be the one we are registering
    • Default Value: false

setupDatabaseReferences()

Setup the references to database names in magic data

• Defined in i2ce/lib/I2CE.php on line 400
• 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 328
• 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 283
• Signature: static public function setupMagicData($set_config,$replace)
• Parameters:
  • boolean $set_config
    Defaults to false meaning we dont replace the magic data instance
    • Default Value: true
  • $replace
    • Default Value: false
• Returns: I2CE_MagicData
  on success, null on failure

setupSession()

Setup the session variables

• Defined in i2ce/lib/I2CE.php on line 228
• 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 180
• Signature: static public function siteInitialized($init)
• Parameters:
  • $init
    • Default Value: null
• Returns: mixed.