Docs For Class atkShuttleFilter

Home

Documentation home

Atk index

Docs For Class atkShuttleFilter [ package: atk ]

Class: atkShuttleFilter

Source Location: /relations/controls/class.atkshuttlefilter.inc

Class atkShuttleFilter

Class Overview

Located in /relations/controls/class.atkshuttlefilter.inc [line 31]

Wiki documentation

atkShuttleControl
   |
   --atkShuttleFilter

Author(s):

Tjeerd Bijlsma <tjeerd@ibuildings.nl>

API Tags:

Abstract:

Information Tags:

Methods

[ Top ]

Inherited from parent

Inherited Properties	Inherited Methods	Inherited Constants
Inherited From atkShuttleControl atkShuttleControl::$m_name atkShuttleControl::$m_section atkShuttleControl::$m_shuttle	Inherited From atkShuttleControl atkShuttleControl::__construct() Constructor atkShuttleControl::getFormName() Get the form name atkShuttleControl::getName() Get the name of the shuttle control atkShuttleControl::getShuttle() Get the shuttle atkShuttleControl::getValue() Get the value of the shuttle control atkShuttleControl::init() Init atkShuttleControl::needsRefresh() Called if a filter or selection event has occured. And allows the control to state if it needs to be refreshed based on the filter or selection changes. atkShuttleControl::render() Renders the control. Returns a piece of HTML that is used in the shuttle atkShuttleControl::setSection() Set section atkShuttleControl::setShuttle() Set the shuttle atkShuttleControl::text() Text proxy. Forwards translations to the shuttle attribute.	Inherited From atkShuttleControl atkShuttleControl::AVAILABLE atkShuttleControl::SELECTED

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From atkShuttleControl

atkShuttleControl::$m_name

atkShuttleControl::$m_section

atkShuttleControl::$m_shuttle

Inherited From atkShuttleControl

atkShuttleControl::__construct()

Constructor

atkShuttleControl::getFormName()

Get the form name

atkShuttleControl::getName()

Get the name of the shuttle control

atkShuttleControl::getShuttle()

Get the shuttle

atkShuttleControl::getValue()

Get the value of the shuttle control

atkShuttleControl::init()

Init

atkShuttleControl::needsRefresh()

Called if a filter or selection event has occured. And allows the control to state if it needs to be refreshed based on the filter or selection changes.

atkShuttleControl::render()

Renders the control. Returns a piece of HTML that is used in the shuttle

atkShuttleControl::setSection()

Set section

atkShuttleControl::setShuttle()

Set the shuttle

atkShuttleControl::text()

Text proxy. Forwards translations to the shuttle attribute.

Inherited From atkShuttleControl

atkShuttleControl::AVAILABLE

atkShuttleControl::SELECTED

[ Top ]

Method Summary

string	getChangeHandlerName()	Returns the change handler name.
string	getFilter()	Applies a filter clause to the destination node for this filter's current value.
int	getLimit()	This method gets called to set a hard limit to the amount of records that can get returned.
void	registerChangeHandler()	Register change handler
string	render()	Renders the shuttle filter control.

[ Top ]

Properties

Methods

getChangeHandlerName [line 40]

string getChangeHandlerName(
string
$prefix 
)

Returns the change handler name.

Parameters:

string

$prefix:

API Tags:

Access:

protected

[ Top ]

getFilter [line 98]

string getFilter(

&$record, array
$record 
)

Applies a filter clause to the destination node for this filter's current value.

The current value can be retrieved from the record using $this->getValue(...).

Parameters:

array	$record:	full record
	&$record:

API Tags:

Return:	filter
Access:	public

[ Top ]

getLimit [line 84]

int getLimit(
)

This method gets called to set a hard limit to the amount of records that can get returned.

API Tags:

Access:

public

[ Top ]

registerChangeHandler [line 51]

void registerChangeHandler(
string
$mode, string
$prefix 
)

Parameters:

string	$mode:
string	$prefix:

API Tags:

Access:

protected

[ Top ]

render [line 72]

string render(
array
$record, string
$mode, string
$prefix 
)

Renders the shuttle filter control.

Parameters:

array	$record:
string	$mode:
string	$prefix:

API Tags:

Return:	control
Access:	public

Redefinition of:

atkShuttleControl::render(): Renders the control. Returns a piece of HTML that is used in the shuttle

[ Top ]