DHTMLX Docs & Samples Explorer

FilterInterface Object

add

adds a new filtration rule to collection.

$coll->add("$name","$value");  // $name LIKE $value
//or
$coll->add("$name","$value","comp_oper"); //$name < $value

Parameters:

  • name - name of the field.
  • value - comporison value (filtration criteria).
  • comp_oper - comparison operator: '>' or '<'.

clear

clears collection (deletes all specified filtration rules).

$coll->clear();

Parameters:

  • none.

index

check if there are some rules in collection for the specified field and returns related hash.

$index = $coll->index("name");

Parameters:

  • name - name of the field

Returns:

  • true - if collection contains rule(s) for the specified field.
  • false - if collection doesn't contain any rules for the field.

rules

array of all specified sorting rules.

$name = $coll->rules[0]["name"]
$coll->rules[0]["value"]="cde";

Properties:

  • name - name of related field.
  • value - comporison value (filtration criteria).
  • operation - comporison operator. If empty - default LIKE instruction is used.