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
AfsFilter Class Reference

Base class used to represent a filter. More...

Inheritance diagram for AfsFilter:
AfsNativeFunctionFilter

Public Member Functions

 __construct ($id)
 Constructs new filter instance.
 __get ($name)
 Create new filter operator object.
 to_string ()
 Transforms this instance in its string representation.

Detailed Description

Base class used to represent a filter.

This class should never be instanced directly. Use filter function instead.

Constructor & Destructor Documentation

__construct (   $id)

Constructs new filter instance.

Parameters
$id[in] Filter identifier (should be a string).

Member Function Documentation

__get (   $name)

Create new filter operator object.

Valid operators are:

  • equal: equal comparison,
  • not_equal: not equal comparison,
  • less: less than comparison,
  • less_equal: less than or equal comparison,
  • greater: greater than comparison,
  • greater_equal: greater than or equal comparison.
Parameters
$name[in] Should be one of the valid operators.
Returns
newly created instance depending on the provided parameter.
Exceptions
AfsUnknownOperatorExceptionwhen invalid operator has been provided.
to_string ( )

Transforms this instance in its string representation.

Returns
string representation of the instance.

Reimplemented in AfsNativeFunctionFilter.