Antidot PHP API  version 0.16.0
##PHP API to simplify integration of Antidot components
 All Classes Files Functions Variables Groups Pages
Public Member Functions | List of all members
AfsFilterWrapper Class Reference

Wrapper to access right underlying object when building filter expression. More...

Public Member Functions

 __construct ($parent, $obj)
 Constructs new wrapped object.
 __get ($name)
 Wraps all getter methods and properties calls.
 __set ($name, $params)
 Wraps all setter methods and properties calls.
 __call ($name, $params)
 Wraps all methods calls.
 to_string ($serialize_wrapped_object=false)
 Retrieves string representation.

Detailed Description

Wrapper to access right underlying object when building filter expression.

Constructor & Destructor Documentation

__construct (   $parent,
  $obj 
)

Constructs new wrapped object.

Parameters
$parent[in] Parent of the wrapper.
$obj[in] The wrapped object.

Member Function Documentation

__call (   $name,
  $params 
)

Wraps all methods calls.

Only first method parameter is forwarded to corresponding method of the wrapped object.

Parameters
$name[in] Name of the method.
$params[in] Array of parameters (only the first one is used!).
Returns
This wrapper with updated wrapped object.
Exceptions
AfsFilterExceptionwhen invalid method has been requested.
__get (   $name)

Wraps all getter methods and properties calls.

Parameters
$name[in] Name of the getter/property.
Returns
This wrapper with updated wrapped object.
Exceptions
AfsFilterExceptionwhen invalid getter/property has been requested
__set (   $name,
  $params 
)

Wraps all setter methods and properties calls.

Parameters
$name[in] Name of the setter/property.
$params[in] Parameter forwarded to the setter/property/
Returns
This wrapper with updated wrapped object.
Exceptions
AfsFilterExceptionwhen invalid setter/property has been requested
to_string (   $serialize_wrapped_object = false)

Retrieves string representation.

Parameters
$serialize_wrapped_object[in] When set to true, output corresponds to the string representation of the wrapped object. Otherwise, false (default), output corresponds to the string representation of the parent element.
Returns
string representation of the parent or the wrapped object.