ExclusionFilter Class Reference

Used to place a filter on the contents of a DataItem-derived object. More...

Public Member Functions
	ExclusionFilter ()
	isExcluded ($field)
	add ()
	remove ()
	includeField ($field)
	excludeField ($field)

Public Attributes
	$fields = array()
	$type = "ExclusionFilter"

Detailed Description

Used to place a filter on the contents of a DataItem-derived object.

With an ExclusionFilter, the specified fields will be excluded from any subsequent queries or operations.

Definition at line 50 of file abstract_data_item.inc.

Member Function Documentation

add()

ExclusionFilter::add

(

)

Definition at line 69 of file abstract_data_item.inc.

     {
          $args = func_get_args();
          for($i = 0; $i < count($args); ++$i)
          {
               $this->fields[$args[$i]] = true;
          }
     }

excludeField()

ExclusionFilter::excludeField

(

$field

)

Definition at line 92 of file abstract_data_item.inc.

     {
          $this->add($field);
     }

ExclusionFilter()

ExclusionFilter::ExclusionFilter

(

)

Definition at line 55 of file abstract_data_item.inc.

     {
          $args = func_get_args();
          for($i = 0; $i < count($args); ++$i)
          {
               $this->fields[$args[$i]] = true;
          }
     }

includeField()

ExclusionFilter::includeField

(

$field

)

Definition at line 87 of file abstract_data_item.inc.

     {
          $this->remove($field);
     }

isExcluded()

ExclusionFilter::isExcluded

(

$field

)

Definition at line 64 of file abstract_data_item.inc.

     {
          return (array_key_exists($field, $this->fields));
     }    

remove()

ExclusionFilter::remove

(

)

Definition at line 78 of file abstract_data_item.inc.

     {
          $args = func_get_args();
          for($i = 0; $i < count($args); ++$i)
          {
               unset($this->fields[$args[$i]]);
          }
     }

Member Data Documentation

$fields

ExclusionFilter::$fields = array()

Definition at line 52 of file abstract_data_item.inc.

$type

ExclusionFilter::$type = "ExclusionFilter"

Definition at line 53 of file abstract_data_item.inc.

---

The documentation for this class was generated from the following file:

• C:/code/cms.sonjara.com/framework/abstract_data_item.inc