.
Gyro-PHP > Documentation

FilterTextDefaultAdapter Class Reference
[Controller]

Default Implementation of Filter Text adapter. More...

Inheritance diagram for FilterTextDefaultAdapter:
IFilterTextAdapter

List of all members.

Public Member Functions
  __construct ($page_data, $param, $prefix= 'filter_')
  get_param ()
  Name of param holding value.
  get_reset_param ()
  Name of param indicating reset.
  get_value ()
  Return current value to be filtered after.

Static Public Member Functions
static  apply_to_url ($url, $value, $parameter)
  Prepare URL so filter gets applied.

Protected Attributes
  $page_data
  $param

Detailed Description

Default Implementation of Filter Text adapter.

Uses GET-Parameters as filter parameters

Author:
Gerd Riesselmann

Definition at line 101 of file filtertext.cls.php.

Constructor & Destructor Documentation

FilterTextDefaultAdapter::__construct ( $  page_data,
$  param,
$  prefix = 'filter_'  
)

Definition at line 105 of file filtertext.cls.php.

00105                                                                              {
00106                 $this->page_data = $page_data;
00107                 $this->param = $prefix . $param;
00108         }

Member Function Documentation

static FilterTextDefaultAdapter::apply_to_url ( $  url,
$  value,
$  parameter  
) [static]

Prepare URL so filter gets applied.

Parameters:
Url  Instance of URL class. This instance is changed.
string  Filter to append
Returns:
void
Deprecated:
Used function on FilterAdapter instead

Definition at line 138 of file filtertext.cls.php.

00138                                                                       {
00139                 $url->replace_query_parameter($parameter, $value);
00140         }
FilterTextDefaultAdapter::get_param (  ) 

Name of param holding value.

Returns:
string

Implements IFilterTextAdapter.

Definition at line 120 of file filtertext.cls.php.

00120                                     {
00121                 return $this->param;
00122         }
FilterTextDefaultAdapter::get_reset_param (  ) 

Name of param indicating reset.

Returns:
string

Implements IFilterTextAdapter.

Definition at line 124 of file filtertext.cls.php.

00124                                           {
00125                 return $this->param . '_reset_filter';
00126         }
FilterTextDefaultAdapter::get_value (  ) 

Return current value to be filtered after.

Returns:
string

Implements IFilterTextAdapter.

Definition at line 115 of file filtertext.cls.php.

00115                                     {
00116                 $reset = $this->page_data->get_get()->get_item($this->get_reset_param(), false);
00117                 return ($reset) ? '' : $this->page_data->get_get()->get_item($this->get_param(), '');
00118         }

Member Data Documentation

FilterTextDefaultAdapter::$page_data [protected]

Definition at line 103 of file filtertext.cls.php.

FilterTextDefaultAdapter::$param [protected]

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

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