InclusionFilter Class Reference

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

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

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

Detailed Description

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

With an InclusionFilter, only the specified fields (and the primary key) will be included in any subsequent queries or operations.

Definition at line 103 of file abstract_data_item.inc.

Member Function Documentation

add()

InclusionFilter::add

(

)

Definition at line 122 of file abstract_data_item.inc.

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

excludeField()

InclusionFilter::excludeField

(

$field

)

Definition at line 145 of file abstract_data_item.inc.

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

includeField()

InclusionFilter::includeField

(

$field

)

Definition at line 140 of file abstract_data_item.inc.

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

InclusionFilter()

InclusionFilter::InclusionFilter

(

)

Definition at line 108 of file abstract_data_item.inc.

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

isExcluded()

InclusionFilter::isExcluded

(

$field

)

Definition at line 117 of file abstract_data_item.inc.

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

remove()

InclusionFilter::remove

(

)

Definition at line 131 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

InclusionFilter::$fields = array()

Definition at line 105 of file abstract_data_item.inc.

$type

InclusionFilter::$type = "InclusionFilter"

Definition at line 106 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