Docs For Class midcom_core_helpers

Class midcom_core_helpers_context

Description

Context data management helper for MidCOM 3

Located in /midcom_core/helpers/context.php (line 15)

Method Summary

midcom_core_helpers_context __construct ()

void create ()

void delete ()

array &get ([int $context_id = null])

void get_current_context ()

array get_item (string $key, [int $context_id = null])

void set_item (string $key, mixed $value, [int $context_id = null])

mixed __get (string $key)

bool __isset (string $key)

void __set (string $key, mixed $value)

Methods

Constructor __construct (line 20)

access: public

midcom_core_helpers_context __construct ()

create (line 27)

Create and prepare a new component context.

access: public

void create ()

delete (line 45)

Remove a context and return to previous.

access: public

void delete ()

get (line 70)

Get a reference of the context data array

return: Context data
access: public

array &get ([int $context_id = null])

int $context_id: ID of the current context

get_current_context (line 59)

access: public

void get_current_context ()

get_item (line 92)

Get value of a particular context data array item

return: Context data
access: public

array get_item (string $key, [int $context_id = null])

string $key: Key to get data of
int $context_id: ID of the current context

set_item (line 119)

Set value of a particular context data array item

access: public

void set_item (string $key, mixed $value, [int $context_id = null])

string $key: Key to set data of
mixed $value: Value to set to the context data array
int $context_id: ID of the current context

__get (line 140)

Get value of current context data array item

return: Value
access: public

mixed __get (string $key)

string $key: Key to get data of

__isset (line 162)

Check if data array item exists in current context

access: public

bool __isset (string $key)

string $key: Key to check for

__set (line 151)

Set value of a particular context data array item

access: public

void __set (string $key, mixed $value)

string $key: Key to set data to
mixed $value: Value to set

Documentation generated on Tue, 14 Oct 2008 01:59:11 +0200 by phpDocumentor 1.4.1