Koowa_Mixin
[ class tree: Koowa_Mixin ] [ index: Koowa_Mixin ] [ all elements ]

Class: KMixinAbstract

Source Location: /libraries/koowa/mixin/abstract.php

Class Overview


Abstract mixing class


Author(s):

Implements interfaces:

Variables

Methods


Child classes:

KMixinCallback
Callback Command Mixin
KMixinCommand
Command Mixin
KMixinBehavior
Behavior Mixin Class
KMixinEvent
Event Mixin
KMixinToolbar
Toolbar Mixin Class
KBehaviorAbstract
Abstract Behavior Class

Class Details

[line 21]
Abstract mixing class

This class does not extend from KObject and acts as a special core class that is intended to offer semi-multiple inheritance features to KObject derived classes.




Tags:

author:  Johan Janssens <johan@nooku.org>
abstract:  
uses:  KObject


[ Top ]


Class Variables

$_mixer =

[line 28]

The object doing the mixin



Tags:

access:  protected

Type:   object


[ Top ]

$__methods = array()

[line 35]

Class methods



Tags:

access:  private

Type:   array


[ Top ]

$__mixable_methods =

[line 42]

List of mixable methods



Tags:

access:  private

Type:   array


[ Top ]



Class Methods


constructor __construct [line 49]

KMixinAbstract __construct( $config)

Object constructor



Tags:

access:  public


Overridden in child classes as:

KMixinCallback::__construct()
Object constructor
KMixinCommand::__construct()
Object constructor
KMixinBehavior::__construct()
Constructor
KMixinEvent::__construct()
Object constructor
KMixinToolbar::__construct()
Constructor
KBehaviorAbstract::__construct()
Constructor.
KControllerBehaviorExecutable::__construct()
Constructor.
KControllerBehaviorEditable::__construct()
Constructor
KDatabaseBehaviorIdentifiable::__construct()
Constructor.
KDatabaseBehaviorSluggable::__construct()
Constructor.

Parameters:

object An   $config   optional KConfig object with configuration options

[ Top ]

method getHandle [line 104]

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:

KBehaviorAbstract::getHandle()
Get an object handle
KControllerBehaviorExecutable::getHandle()
Get an object handle


Implementation of:
KObjectHandlable::getHandle()
Get the object handle
[ Top ]

method getMethods [line 116]

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


[ Top ]

method getMixableMethods [line 141]

array getMixableMethods( [ $mixer = null])

Get the methods that are available for mixin.

Only public methods can be mixed




Tags:

return:  An array of public methods
access:  public


Overridden in child classes as:

KMixinCallback::getMixableMethods()
Get the methods that are available for mixin.
KBehaviorAbstract::getMixableMethods()
Get the methods that are available for mixin based
KDatabaseBehaviorAbstract::getMixableMethods()
Get the methods that are available for mixin based
KDatabaseBehaviorModifiable::getMixableMethods()
Get the methods that are available for mixin based
KDatabaseBehaviorLockable::getMixableMethods()
Get the methods that are available for mixin based
KDatabaseBehaviorIdentifiable::getMixableMethods()
Get the methods that are available for mixin based
KDatabaseBehaviorOrderable::getMixableMethods()
Get the methods that are available for mixin based
KDatabaseBehaviorCreatable::getMixableMethods()
Get the methods that are available for mixin based
KDatabaseBehaviorSluggable::getMixableMethods()
Get the methods that are available for mixin based


Implementation of:
KMixinInterface::getMixableMethods()
Get the methods that are available for mixin.

Parameters:

object The   $mixer   mixer requesting the mixable methods.

[ Top ]

method getMixer [line 79]

object The getMixer( )

Get the mixer object



Tags:

return:  mixer object
access:  public



Implementation of:
KMixinInterface::getMixer()
Get the mixer object
[ Top ]

method setMixer [line 90]

KMixinInterface setMixer( object The $mixer)

Set the mixer object



Tags:

access:  public



Implementation of:
KMixinInterface::setMixer()
Set the mixer object

Parameters:

object The   $mixer   mixer object

[ Top ]

method _initialize [line 67]

void _initialize( $config)

Initializes the options for the object

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




Tags:

access:  protected


Overridden in child classes as:

KMixinCallback::_initialize()
Initializes the options for the object
KMixinCommand::_initialize()
Initializes the options for the object
KMixinBehavior::_initialize()
Initializes the default configuration for the object
KMixinEvent::_initialize()
Initializes the options for the object
KMixinToolbar::_initialize()
Initializes the default configuration for the object
KBehaviorAbstract::_initialize()
Initializes the options for the object
KControllerBehaviorExecutable::_initialize()
Initializes the default configuration for the object
KDatabaseBehaviorModifiable::_initialize()
Initializes the options for the object
KDatabaseBehaviorLockable::_initialize()
Initializes the options for the object
ComDefaultDatabaseBehaviorLockable::_initialize()
Initializes the options for the object
KDatabaseBehaviorIdentifiable::_initialize()
Initializes the options for the object
KDatabaseBehaviorSluggable::_initialize()
Initializes the options for the object

Parameters:

object An   $config   optional KConfig object with configuration options

[ Top ]

method __call [line 227]

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


Parameters:

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

[ Top ]

method __get [line 186]

mixed __get( string $key)

Overloaded get function



Tags:

access:  public


Parameters:

string   $key   The variable name.

[ Top ]

method __isset [line 199]

boolean __isset( string $key)

Overloaded isset function

Allows testing with empty() and isset() functions




Tags:

access:  public


Parameters:

string   $key   The variable name

[ Top ]

method __set [line 175]

mixed __set( string $key, mixed $value)

Overloaded set function



Tags:

access:  public


Parameters:

string   $key   The variable name
mixed   $value   The variable value.

[ Top ]

method __unset [line 212]

void __unset( string $key)

Overloaded isset function

Allows unset() on object properties to work




Tags:

access:  public


Parameters:

string   $key   The variable name.

[ Top ]


Documentation generated on Fri, 24 May 2013 03:00:52 +0200 by phpDocumentor 1.4.3