Docs For Class KObject

\KObjectDecorator __construct(
[
$config = null])

Constructor

Tags:

access:

public

Overridden in child classes as:

KHttpUrl::__construct(): Constructor

KEventSubscriberAbstract::__construct(): Constructor.

PlgKoowaDefault::__construct(): Constructor

KControllerToolbarAbstract::__construct(): Constructor

KEventDispatcher::__construct(): Constructor.

KControllerAbstract::__construct(): Constructor.

KControllerResource::__construct(): Constructor

ComDefaultControllerDefault::__construct(): Constructor

KDispatcherAbstract::__construct(): Constructor.

KFilterAbstract::__construct(): Constructor

ComDefaultFilterIni::__construct(): Constructor

KFilterHtml::__construct(): Constructor

KFilterJson::__construct(): Constructor

KFilterTrim::__construct(): Constructor

KFilterTidy::__construct(): Constructor

KFilterSlug::__construct(): Constructor

KModelAbstract::__construct(): Constructor

KModelTable::__construct(): Constructor

KDatabaseAdapterAbstract::__construct(): Constructor.

ComDefaultDatabaseAdapterMysqli::__construct(): Constructor

KDatabaseTableAbstract::__construct(): Object constructor

KObjectSet::__construct(): Constructor

KDatabaseRowsetAbstract::__construct(): Constructor

KDatabaseRowsetTable::__construct(): Constructor

KObjectArray::__construct(): Constructor

KDatabaseRowAbstract::__construct(): Constructor

KDatabaseRowTable::__construct(): Object constructor

KObjectQueue::__construct(): Constructor

KCommandChain::__construct(): Constructor

KObjectDecorator::__construct(): Constructor

KObjectStack::__construct(): Constructor

KViewAbstract::__construct(): Constructor

KViewJson::__construct(): Constructor

KViewTemplate::__construct(): Constructor

ComDefaultViewHtml::__construct(): Constructor

KViewFile::__construct(): Constructor

KTemplateHelperAbstract::__construct(): Constructor

KTemplateFilterAbstract::__construct(): Constructor.

ComDefaultTemplateFilterChrome::__construct(): Constructor.

ModDefaultTemplateFilterChrome::__construct(): Constructor.

KTemplateFilterForm::__construct(): Constructor.

KTemplateAbstract::__construct(): Constructor

ComDefaultTemplateAbstract::__construct(): Constructor

KDate::__construct(): Constructor

KCommand::__construct(): Constructor.

KCommandEvent::__construct(): Constructor.

Parameters:

KConfig|null

$config

An optional KConfig object with configuration options

[ Top ]

mixed get(
[string
$property = null], [mixed
$default = null])

Get the object properties

If no property name is given then the function will return an associative array of all properties.

If the property does not exist and a default value is specified this is returned, otherwise the function return NULL.

Tags:

return:	The value of the property, an associative array or NULL
access:	public

Overridden in child classes as:

KModelAbstract::get(): Get the model state properties

Parameters:

string	$property	The name of the property
mixed	$default	The default value

[ Top ]

string getHandle(
)

Get a handle for this object

This function returns an unique identifier for the object. This id can be used as a hash key for storing objects or for identifying an object

Tags:

return:	A string that is unique
access:	public

Overridden in child classes as:

KFilterAbstract::getHandle(): Get a handle for this object

Implementation of:

KObjectHandlable::getHandle(): Get the object handle

[ Top ]

KServiceIdentifier getIdentifier(
[string|object
$identifier = null])

Gets the service identifier.

Tags:

see:	KObjectServiceable
throws:	KObjectException if the service container has not been defined.
access:	public

Implementation of:

KObjectServiceable::getIdentifier(): Get a service identifier.

Parameters:

string|object

$identifier

The class identifier or identifier object

[ Top ]

array getMethods(
)

Get a list of all the available methods

This function returns an array of all the methods, both native and mixed in

Tags:

return:	An array
access:	public

Overridden in child classes as:

KObjectDecorator::getMethods(): Get a list of all the available methods

[ Top ]

object Return getService(
string|object
$identifier, [
$config = array()])

Get an instance of a class based on a class identifier only creating it if it does not exist yet.

Tags:

return:	object on success, throws exception on failure
see:	KObjectServiceable
throws:	KObjectException if the service container has not been defined.
access:	public

Implementation of:

KObjectServiceable::getService(): Get an instance of a class based on a class identifier only creating it if it doesn't exist yet.

Parameters:

string\|object	$identifier	The class identifier or identifier object
array	$config	An optional associative array of configuration settings.

[ Top ]

bool inherits(
string|object
$class)

Checks if the object or one of it's mixin's inherits from a class.

Tags:

return:	Returns TRUE if the object inherits from the class
access:	public

Overridden in child classes as:

KObjectDecorator::inherits(): Checks if the decorated object or one of it's mixins inherits from a class.

Parameters:

string|object

$class

The class to check

[ Top ]

KObject mixin(

$object)

Mixin an object

When using mixin(), the calling object inherits the methods of the mixed in objects, in a LIFO order.

Tags:

access:

public

Overridden in child classes as:

KControllerAbstract::mixin(): Mixin an object

Parameters:

KMixinInterface

$object

An object that implements KMinxInterface

[ Top ]

KObject set(
string|array|object 
$property, [mixed
$value = null])

Set the object properties

Tags:

throws:	KObjectException If trying to access protected or private properties
access:	public

Overridden in child classes as:

KModelAbstract::set(): Set the model state properties

KModelTable::set(): Set the model state properties

Parameters:

string\|array\|object	$property	The name of the property, an associative array or an object
mixed	$value	The value of the property

[ Top ]

void _initialize(

$config, KConfig
$object)

Initializes the options for the object

Called from __construct() as a first step of object instantiation.

Tags:

access:

protected

Overridden in child classes as:

KHttpUrl::_initialize(): Initializes the options for the object

KEventSubscriberAbstract::_initialize(): Initializes the options for the object

PlgKoowaDefault::_initialize(): Initializes the options for the object

KControllerToolbarAbstract::_initialize(): Initializes the config for the object

KControllerAbstract::_initialize(): Initializes the default configuration for the object

KControllerResource::_initialize(): Initializes the default configuration for the object

KControllerService::_initialize(): Initializes the default configuration for the object

ComDefaultControllerDefault::_initialize(): Initializes the default configuration for the object

KDispatcherAbstract::_initialize(): Initializes the options for the object

ComDefaultDispatcher::_initialize(): Initializes the options for the object

KFilterTidy::_initialize(): Initializes the config for the object

KFilterSlug::_initialize(): Initializes the options for the object

KModelAbstract::_initialize(): Initializes the options for the object

KModelTable::_initialize(): Initializes the config for the object

KDatabaseAdapterAbstract::_initialize(): Initializes the options for the object

KDatabaseAdapterMysqli::_initialize(): Initializes the options for the object

ComDefaultDatabaseAdapterMysqli::_initialize(): Initializes the options for the object

KDatabaseTableAbstract::_initialize(): Initializes the options for the object

KDatabaseRowsetAbstract::_initialize(): Initializes the options for the object

KDatabaseRowsetTable::_initialize(): Initializes the options for the object

KObjectArray::_initialize(): Initializes the options for the object

KDatabaseRowAbstract::_initialize(): Initializes the options for the object

KDatabaseRowTable::_initialize(): Initializes the options for the object

KCommandChain::_initialize(): Initializes the options for the object

KViewAbstract::_initialize(): Initializes the config for the object

KViewJson::_initialize(): Initializes the config for the object

KViewTemplate::_initialize(): Initializes the config for the object

KViewHtml::_initialize(): Initializes the config for the object

ModDefaultHtml::_initialize(): Initializes the default configuration for the object

KViewFile::_initialize(): Initializes the options for the object

KViewCsv::_initialize(): Initializes the options for the object

KViewVcard::_initialize(): Initializes the options for the object

ComDefaultTemplateHelperMenubar::_initialize(): Initializes the options for the object

KTemplateFilterAbstract::_initialize(): Initializes the options for the object

ComDefaultTemplateFilterChrome::_initialize(): Initializes the options for the object

ComDefaultTemplateFilterModule::_initialize(): Initializes the options for the object

ModDefaultTemplateFilterChrome::_initialize(): Initializes the options for the object

KTemplateFilterStyle::_initialize(): Initializes the options for the object

KTemplateFilterForm::_initialize(): Initializes the options for the object

KTemplateFilterScript::_initialize(): Initializes the options for the object

KTemplateFilterTemplate::_initialize(): Initializes the options for the object

KTemplateAbstract::_initialize(): Initializes the options for the object

KDate::_initialize(): Initializes the options for the object

KCommand::_initialize(): Initializes the options for the object

KCommandEvent::_initialize(): Initializes the options for the object

Parameters:

KConfig	$object	An optional KConfig object with configuration options
KConfig	$config

[ Top ]

mixed __call(
string
$method, array
$arguments)

Search the mixin method map and call the method or trigger an error

Tags:

return:	The result of the function
throws:	BadMethodCallException If method could not be found
access:	public

Overridden in child classes as:

KControllerToolbarAbstract::__call(): Add a command by it's name

KControllerAbstract::__call(): Execute a controller action by it's name.

KControllerResource::__call(): Supports a simple form Fluent Interfaces. Allows you to set the request properties by using the request property name as the method name.

KModelAbstract::__call(): Supports a simple form Fluent Interfaces. Allows you to set states by using the state name as the method name.

KDatabaseTableAbstract::__call(): Search the behaviors to see if this table behaves as.

KDatabaseRowsetAbstract::__call(): Search the mixin method map and call the method or forward the call to each row for processing.

KDatabaseRowsetTable::__call(): Forward the call to each row

KDatabaseRowAbstract::__call(): Search the mixin method map and call the method or trigger an error

KDatabaseRowTable::__call(): Search the mixin method map and call the method or trigger an error

KObjectDecorator::__call(): Overloaded call function

KViewTemplate::__call(): Supports a simple form of Fluent Interfaces. Allows you to assign variables to the view by using the variable name as the method name. If the method name is a setter method the setter will be called instead.

KTemplateHelperListbox::__call(): Search the mixin method map and call the method or trigger an error

Parameters:

string	$method	The function name
array	$arguments	The function arguments

[ Top ]

void __clone(
)

Preform a deep clone of the object.

Tags:

access:

public

Overridden in child classes as:

KModelAbstract::__clone(): Preform a deep clone of the object.

KObjectSet::__clone(): Preform a deep clone of the object

KObjectQueue::__clone(): Preform a deep clone of the object

[ Top ]

Class: KObject

Class Overview

Author(s):

Variables

Methods

Child classes:

Class Details

Tags:

Class Variables

$_mixed_methods = array()

Tags:

$__methods = array()

Tags:

$__service_container =

Tags:

$__service_identifier =

Tags:

Class Methods

constructor __construct [line 55]

Tags:

Parameters:

method get [line 131]

Tags:

Parameters:

method getHandle [line 211]

Tags:

method getIdentifier [line 267]

Tags:

Parameters:

method getMethods [line 223]

Tags:

method getService [line 250]

Tags:

Parameters:

method inherits [line 185]

Tags:

Parameters:

method mixin [line 165]

Tags:

Parameters:

method set [line 94]

Tags:

Parameters:

method _initialize [line 81]

Tags:

Parameters:

method __call [line 302]

Tags:

Parameters:

method __clone [line 287]

Tags: