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

Class: KObjectDecorator

Source Location: /libraries/koowa/object/decorator.php

Class Overview

KObject
   |
   --KObjectDecorator

An Object Decorator Class


Author(s):

Variables

Methods


Inherited Variables

Inherited Methods

Class: KObject

KObject::__construct()
Constructor
KObject::get()
Get the object properties
KObject::getHandle()
Get a handle for this object
KObject::getIdentifier()
Gets the service identifier.
KObject::getMethods()
Get a list of all the available methods
KObject::getService()
Get an instance of a class based on a class identifier only creating it if it does not exist yet.
KObject::inherits()
Checks if the object or one of it's mixin's inherits from a class.
KObject::mixin()
Mixin an object
KObject::set()
Set the object properties
KObject::_initialize()
Initializes the options for the object
KObject::__call()
Search the mixin method map and call the method or trigger an error
KObject::__clone()
Preform a deep clone of the object.

Class Details

[line 17]
An Object Decorator Class



Tags:

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


[ Top ]


Class Variables

$_object =

[line 31]

The decorated object



Tags:

access:  protected

Type:   object


[ Top ]

$__methods = array()

[line 24]

Class methods



Tags:

access:  private

Type:   array
Overrides:   Array


[ Top ]



Class Methods


constructor __construct [line 39]

\KObjectDecorator __construct( [ $config = null])

Constructor



Tags:

access:  public


Overrides KObject::__construct() (Constructor)

Parameters:

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

[ Top ]

method getMethods [line 76]

array getMethods( )

Get a list of all the available methods

This function returns an array of all the methods, both native and mixed. It will also return the methods exposed by the decorated object.




Tags:

return:  An array
access:  public


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

[ Top ]

method getObject [line 51]

object The getObject( )

Get the decorated object



Tags:

return:  decorated object
access:  public


[ Top ]

method inherits [line 104]

boolean inherits( string|object $class)

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



Tags:

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


Overrides KObject::inherits() (Checks if the object or one of it's mixin's inherits from a class.)

Parameters:

string|object   $class   The class to check

[ Top ]

method setObject [line 62]

\KObjectDecorator setObject( object $object)

Set the decorated object



Tags:

access:  public


Parameters:

object   $object  

[ Top ]

method __call [line 177]

mixed __call( string $method, array $arguments)

Overloaded call function



Tags:

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


Overrides KObject::__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 ]

method __get [line 136]

mixed __get( string $key)

Overloaded get function



Tags:

access:  public


Parameters:

string   $key   The variable name.

[ Top ]

method __isset [line 149]

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 125]

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 162]

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 Wed, 22 May 2013 03:01:10 +0200 by phpDocumentor 1.4.3