Docs For Class atkAbstractSearchHandler

Home

Documentation home

Atk index

Docs For Class atkAbstractSearchHandler [ package: atk ]

Class: atkAbstractSearchHandler

Source Location: /handlers/class.atkabstractsearchhandler.inc

Class atkAbstractSearchHandler

Class Overview

Abstract class for implementing an atkSearchHandler

Located in /handlers/class.atkabstractsearchhandler.inc [line 26]

Wiki documentation

atkActionHandler
   |
   --atkAbstractSearchHandler

Author(s):

Ivo Jansch <ivo@achievo.org>

API Tags:

Abstract:

Information Tags:

Properties

Methods

[ Top ]

Descendants

Child Class	Description
atkSearchHandler	Handler class for the search action of a node. The handler draws a generic search form for the given node.
atkSmartSearchHandler	Smart search handler class.

[ Top ]

Inherited from parent

Inherited Properties	Inherited Methods
Inherited From atkActionHandler atkActionHandler::$m_action atkActionHandler::$m_node atkActionHandler::$m_partial atkActionHandler::$m_rejecting atkActionHandler::$m_renderBoxVars atkActionHandler::$m_renderMode atkActionHandler::$m_returnbehaviour	Inherited From atkActionHandler atkActionHandler::atkActionHandler() Default constructor. atkActionHandler::addRenderBoxVar() Add a variable to the renderbox atkActionHandler::allowed() Current action allowed on the given record? atkActionHandler::clearCache() Clear the recordlist cache atkActionHandler::closeDialog() Output JavaScript to close the dialog. atkActionHandler::getDefaultHandler() Static factory method to get the default action handler for a certain action. atkActionHandler::getNode() Returns the node object. atkActionHandler::getPage() Get the page instance for generating output. atkActionHandler::getRecordlistCache() Get the cached recordlist atkActionHandler::getRejectInfo() Get the reject info from the session This is used by the atkAddHandler and atkEditHandler to show the validation errors atkActionHandler::getRenderMode() Returns the render mode. atkActionHandler::getReturnBehaviour() Get the returnbehaviour of this action atkActionHandler::getUi() Get the ui instance for drawing and templating purposes. atkActionHandler::handle() The handle() method handles the action. atkActionHandler::invoke() Generic method invoker. atkActionHandler::notify() Notify the node that an action has occured atkActionHandler::partial() Handle partial. atkActionHandler::renderAccessDeniedDialog() Render access denied dialog contents. atkActionHandler::renderAccessDeniedPage() Render access denied page. atkActionHandler::renderMessageDialog() Render message dialog contents. atkActionHandler::setAction() Sets the current action. atkActionHandler::setNode() Set the calling node of the current action. atkActionHandler::setPostvars() Set postvars of the the calling node of the current action. atkActionHandler::setRejectInfo() Store the reject info in the session This is used by the atkSaveHandler and atkUpdateHandler to store the record if the record is not validated atkActionHandler::setRenderMode() Sets the render mode ("box" or "dialog"). atkActionHandler::setReturnBehaviour() Set the returnbehaviour of this action atkActionHandler::updateDialog() Outputs JavaScript for updating the existing dialog contents. atkActionHandler::_getAccessDeniedPage() Get the access denied page

Inherited Properties

Inherited Methods

Inherited From atkActionHandler

atkActionHandler::$m_action

atkActionHandler::$m_node

atkActionHandler::$m_partial

atkActionHandler::$m_rejecting

atkActionHandler::$m_renderBoxVars

atkActionHandler::$m_renderMode

atkActionHandler::$m_returnbehaviour

Inherited From atkActionHandler

atkActionHandler::atkActionHandler()

Default constructor.

atkActionHandler::addRenderBoxVar()

Add a variable to the renderbox

atkActionHandler::allowed()

Current action allowed on the given record?

atkActionHandler::clearCache()

Clear the recordlist cache

atkActionHandler::closeDialog()

Output JavaScript to close the dialog.

atkActionHandler::getDefaultHandler()

Static factory method to get the default action handler for a certain action.

atkActionHandler::getNode()

Returns the node object.

atkActionHandler::getPage()

Get the page instance for generating output.

atkActionHandler::getRecordlistCache()

Get the cached recordlist

atkActionHandler::getRejectInfo()

Get the reject info from the session This is used by the atkAddHandler and atkEditHandler to show the validation errors

atkActionHandler::getRenderMode()

Returns the render mode.

atkActionHandler::getReturnBehaviour()

Get the returnbehaviour of this action

atkActionHandler::getUi()

Get the ui instance for drawing and templating purposes.

atkActionHandler::handle()

The handle() method handles the action.

atkActionHandler::invoke()

Generic method invoker.

atkActionHandler::notify()

Notify the node that an action has occured

atkActionHandler::partial()

Handle partial.

atkActionHandler::renderAccessDeniedDialog()

Render access denied dialog contents.

atkActionHandler::renderAccessDeniedPage()

Render access denied page.

atkActionHandler::renderMessageDialog()

Render message dialog contents.

atkActionHandler::setAction()

Sets the current action.

atkActionHandler::setNode()

Set the calling node of the current action.

atkActionHandler::setPostvars()

Set postvars of the the calling node of the current action.

atkActionHandler::setRejectInfo()

Store the reject info in the session This is used by the atkSaveHandler and atkUpdateHandler to store the record if the record is not validated

atkActionHandler::setRenderMode()

Sets the render mode ("box" or "dialog").

atkActionHandler::setReturnBehaviour()

Set the returnbehaviour of this action

atkActionHandler::updateDialog()

Outputs JavaScript for updating the existing dialog contents.

atkActionHandler::_getAccessDeniedPage()

Get the access denied page

[ Top ]

Property Summary

string	$m_table	Holds the table name of the searchcriteria table. Due some BC issues of the atkSmartSearchHandler this value can be overwritten by the checkTable function
boolean	$m_table_exists	Indicates if the table atk_searchcriteria exists use the function tableExists

[ Top ]

Method Summary

array	fetchCriteria()	Return the criteria based on the postvarse used for storing
void	forgetCriteria()	Remove search criteria.
String	getForgetCriteria()	Returns a link for removing the currently selected criteria. If nothing (valid) is selected nothing is returned.
String	getLoadCriteria()	Returns a select list of loadable criteria which will on-selection refresh the smart search page with the loaded criteria.
void	getSaveCriteria()	Returns a textfield for entering a name to save the search criteria as.
array	getSavedCriteria()	Returns an array with all the saved criteria information. This information will be parsed to the different
string	getSearchHandlerType()	Return the type of the atkSmartSearchHandler
checkbox	getToggleSaveCriteria()	Returns a checkbox for enabling/disabling the saving of criteria.
string	handleSavedCriteria()	Take the necessary 'saved criteria' actions based on the posted variables.
Array	listCriteria()	List criteria.
Array	loadBaseCriteria()	Load base criteria.
Array	loadCriteria()	Load search criteria.
void	saveCriteria()	Save search criteria.
boolean	tableExist()	check if database table exists

[ Top ]

Properties

string $m_table = 'atk_searchcriteria' [line 35]

Holds the table name of the searchcriteria table. Due some BC issues of the atkSmartSearchHandler this value can be overwritten by the checkTable function

API Tags:

Access:

protected

[ Top ]

boolean $m_table_exists = null [line 44]

Indicates if the table atk_searchcriteria exists use the function tableExists

API Tags:

Access:

protected

[ Top ]

Methods

fetchCriteria [line 52]

array fetchCriteria(
)

Return the criteria based on the postvarse used for storing

API Tags:

Abstract:

Redefined in descendants as:

atkSearchHandler::fetchCriteria() : Fetch posted criteria.
atkSmartSearchHandler::fetchCriteria() : Fetch posted criteria.

[ Top ]

forgetCriteria [line 107]

void forgetCriteria(
String
$name 
)

Remove search criteria.

Parameters:

String

$name:

name of the search criteria

[ Top ]

getForgetCriteria [line 251]

String getForgetCriteria(
String
$current 
)

Returns a link for removing the currently selected criteria. If nothing (valid) is selected nothing is returned.

Parameters:

String

$current:

currently loaded criteria

API Tags:

Return:

forget url

[ Top ]

getLoadCriteria [line 177]

String getLoadCriteria(
String
$current 
)

Returns a select list of loadable criteria which will on-selection refresh the smart search page with the loaded criteria.

Parameters:

String

$current:

The current load criteria

API Tags:

Return:

criteria load HTML

[ Top ]

getSaveCriteria [line 273]

void getSaveCriteria(
String
$current, String
1 
)

Returns a textfield for entering a name to save the search criteria as.

Parameters:

String	$current:	currently loaded criteria
String	1:	textfield HTML

[ Top ]

getSavedCriteria [line 228]

array getSavedCriteria(
string
$current 
)

Returns an array with all the saved criteria information. This information will be parsed to the different

Parameters:

string

$current:

[ Top ]

getSearchHandlerType [line 59]

string getSearchHandlerType(
)

Return the type of the atkSmartSearchHandler

[ Top ]

getToggleSaveCriteria [line 262]

checkbox getToggleSaveCriteria(
)

Returns a checkbox for enabling/disabling the saving of criteria.

API Tags:

Return:

HTML

[ Top ]

handleSavedCriteria [line 201]

string handleSavedCriteria(
array
$criteria 
)

Take the necessary 'saved criteria' actions based on the posted variables.

Returns the name of the saved criteria

Parameters:

array

$criteria:

array with the current criteria

API Tags:

Return:

name of the saved criteria

[ Top ]

listCriteria [line 87]

Array listCriteria(
)

List criteria.

API Tags:

Return:

criteria list

[ Top ]

loadBaseCriteria [line 165]

Array loadBaseCriteria(
)

Load base criteria.

API Tags:

Return:

search criteria

[ Top ]

loadCriteria [line 144]

Array loadCriteria(
String
$name 
)

Load search criteria.

Parameters:

String

$name:

name of the search criteria

API Tags:

Return:

search criteria

[ Top ]

saveCriteria [line 127]

void saveCriteria(
String
$name, Array
$criteria 
)

Save search criteria.

NOTE: This method will overwrite existing criteria with the same name.

Parameters:

String	$name:	name for the search criteria
Array	$criteria:	search criteria data

[ Top ]

tableExist [line 69]

boolean tableExist(
)

check if database table exists

API Tags:

Access:

protected

[ Top ]