icms

Notice: Wiki was automatic generated from project sources as project API documentation. Do not edit manually!

icms

ICMS Kernel / Services manager

The icms services manager handles the core bootstrap process, and paths/urls generation. Global services are made available as static properties of this class.

• Class name: icms
• Namespace:
• Parent class: League\Container\Container

Properties

$response

public \icms_response_Text $response

Current response

• Visibility: public
• This property is static.

$paths

public array $paths = array(www => array(), modules => array(), themes => array())

ImpressCMS paths locations

• Visibility: public
• This property is static.

$urls

public array $urls = \false

• Visibility: public
• This property is static.

$db

public mixed $db

Some vars for compatibility

• Visibility: public
• This property is static.

$xoopsDB

public mixed $xoopsDB

Some vars for compatibility

• Visibility: public
• This property is static.

$logger

public mixed $logger

Some vars for compatibility

• Visibility: public
• This property is static.

$preload

public mixed $preload

Some vars for compatibility

• Visibility: public
• This property is static.

$config

public mixed $config

Some vars for compatibility

• Visibility: public
• This property is static.

$security

public mixed $security

Some vars for compatibility

• Visibility: public
• This property is static.

$session

public mixed $session

Some vars for compatibility

• Visibility: public
• This property is static.

$module

public mixed $module

Some vars for compatibility

• Visibility: public
• This property is static.

$user

public \icms_member_user_Object $user

Current logged in user

• Visibility: public
• This property is static.

Methods

shutdown

mixed icms::shutdown()

Finalizes all processes as the script exits

• Visibility: public
• This method is static.

create

object icms::create(mixed factory, array args)

Creates an object instance from an object definition.

The factory parameter can be:

• A fully qualified class name starting with '': \MyClass or on PHP 5.3+ \ns\sub\MyClass
• A valid PHP callback

• Visibility: public
• This method is static.

Arguments

• factory mixed
• args array - <p>Factory/Constructor arguments</p>

url

string icms::url(string url)

Convert a ImpressCMS path to an URL

• Visibility: public
• This method is static.

Arguments

• url string

path

string icms::path(string url, bool virtual)

Convert a ImpressCMS path to a physical one

• Visibility: public

Arguments

• url string - <p>URL string to convert to a physical path</p>
• virtual bool

getInstance

\icms|null icms::getInstance()

Get instance

• Visibility: public
• This method is static.

buildUrl

string icms::buildUrl(string url, array params)

Build an URL with the specified request params

• Visibility: public
• This method is static.

Arguments

• url string
• params array

handler

object icms::handler(string name, bool optional)

Gets the handler for a class

• Visibility: public
• This method is static.

Arguments

• name string - <p>The name of the handler to get</p>
• optional bool - <p>Is the handler optional?</p>

setup

\icms icms::setup()

Initialize ImpressCMS before bootstrap

• Visibility: public

buildRelevantUrls

array icms::buildRelevantUrls()

Build URLs for global use throughout the application

• Visibility: protected

boot

\icms icms::boot()

Launch bootstrap and instanciate global services

• Visibility: public