DBFilterGroup Class Reference
[Model]

Contains a set of DBFilter instances that form a group. More...

Inheritance diagram for DBFilterGroup:

List of all members.

Public Member Functions
	__construct ($key= '', $name= '', $filters=array(), $default= '')
	Constructor.
	add_filter ($key, $filter)
	Add a new filter.
	apply ($query)
	Apply filter.
	count ()
	Returns number of filters.
	get_current_filter ()
	Returns current filter.
	get_current_key ()
	Return current filter's key.
	get_default_key ()
	Return default filter's key.
	get_filter ($key)
	Get filter for give key.
	get_filters ()
	Returns an array of all filters.
	get_group_id ()
	Return key of this group.
	get_keys ()
	Returns an array of all filter keys.
	get_name ()
	Return name of this filter.
	set_current_key ($key)
	Set current filter's key.
	set_default_key ($key)
	Set default filter's key.
Protected Attributes
	$filters = array()
	An associative array of DBFilter instances.
	$group_key = ''
	$key_current_filter = ''
	$key_default_filter = ''
	$name = ''

---

Detailed Description

Contains a set of DBFilter instances that form a group.

For example, all possible filters on a column can form a group

Author:

Gerd Riesselmann

Definition at line 11 of file dbfiltergroup.cls.php.

---

Constructor & Destructor Documentation

DBFilterGroup::__construct	(	$	key = '',
		$	name = '',
		$	filters = array(),
		$	default = ''
	)

Constructor.

Parameters:

array

Associative array of DBFilter instances

Definition at line 26 of file dbfiltergroup.cls.php.

                                                                                              {
                $this->name = $name;
                $this->group_key = $key;
                foreach($filters as $key => $value) {
                        $this->add_filter(strval($key), $value);
                }
                $this->set_default_key($default);
                $this->set_current_key($default);
        }

---

Member Function Documentation

DBFilterGroup::add_filter	(	$	key,
		$	filter
	)

Add a new filter.

Parameters:

	string	The key for this filter
	DBFilter	DBFilter instance

Definition at line 56 of file dbfiltergroup.cls.php.

                                                  {
                $filter->set_key($key);
                $this->filters[$key] = $filter;
        }

DBFilterGroup::apply

(

$

query

)

Apply filter.

Implements IDBQueryModifier.

Definition at line 136 of file dbfiltergroup.cls.php.

                                      {
                $query->apply_modifier($this->get_current_filter());
        }

DBFilterGroup::count

(

)

Returns number of filters.

Definition at line 85 of file dbfiltergroup.cls.php.

                                {
                return count($this->filters);
        }

DBFilterGroup::get_current_filter

(

)

Returns current filter.

Returns:

DBFilter

Definition at line 125 of file dbfiltergroup.cls.php.

                                             {
                $ret = $this->get_filter($this->get_current_key());
                if ($ret == false) {
                        $ret = $this->get_filter($this->get_default_key());
                }
                return $ret;
        }

DBFilterGroup::get_current_key

(

)

Return current filter's key.

Definition at line 116 of file dbfiltergroup.cls.php.

                                          {
                return $this->key_current_filter;
        }

DBFilterGroup::get_default_key

(

)

Return default filter's key.

Definition at line 102 of file dbfiltergroup.cls.php.

                                          {
                return $this->key_default_filter;
        }       

DBFilterGroup::get_filter

(

$

key

)

Get filter for give key.

Definition at line 64 of file dbfiltergroup.cls.php.

                                         {
                return Arr::get_item($this->filters, $key, false);
        }

DBFilterGroup::get_filters

(

)

Returns an array of all filters.

Definition at line 78 of file dbfiltergroup.cls.php.

                                      {
                return array_values($this->filters);
        }

DBFilterGroup::get_group_id

(

)

Return key of this group.

Definition at line 46 of file dbfiltergroup.cls.php.

                                       {
                return $this->group_key;
        }       

DBFilterGroup::get_keys

(

)

Returns an array of all filter keys.

Definition at line 71 of file dbfiltergroup.cls.php.

                                   {
                return array_keys($this->filters);
        }

DBFilterGroup::get_name

(

)

Return name of this filter.

Definition at line 39 of file dbfiltergroup.cls.php.

                                   {
                return $this->name;
        }

DBFilterGroup::set_current_key

(

$

key

)

Set current filter's key.

Definition at line 109 of file dbfiltergroup.cls.php.

                                              {
                $this->key_current_filter = $key;
        }

DBFilterGroup::set_default_key

(

$

key

)

Set default filter's key.

Definition at line 92 of file dbfiltergroup.cls.php.

                                              {
                $this->key_default_filter = $key;
                foreach($this->filters as $f) {
                        $f->set_is_default($f->get_key() == $key);
                }
        }

---

Member Data Documentation

DBFilterGroup::$filters = array() [protected]

An associative array of DBFilter instances.

Definition at line 15 of file dbfiltergroup.cls.php.

DBFilterGroup::$group_key = '' [protected]

Definition at line 17 of file dbfiltergroup.cls.php.

DBFilterGroup::$key_current_filter = '' [protected]

Definition at line 19 of file dbfiltergroup.cls.php.

DBFilterGroup::$key_default_filter = '' [protected]

Definition at line 18 of file dbfiltergroup.cls.php.

DBFilterGroup::$name = '' [protected]

Definition at line 16 of file dbfiltergroup.cls.php.

---

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

• gyro/core/model/base/dbfiltergroup.cls.php