Docs For Class atkSmartSearchHandler

Home

Documentation home

Atk index

Docs For Class atkSmartSearchHandler [ package: atk ]

Class: atkSmartSearchHandler

Source Location: /handlers/class.atksmartsearchhandler.inc

Class atkSmartSearchHandler

Class Overview

Smart search handler class.

Located in /handlers/class.atksmartsearchhandler.inc [line 29]

Wiki documentation

atkActionHandler
   |
   --atkAbstractSearchHandler
      |
      --atkSmartSearchHandler

Author(s):

Peter C. Verhage <peter@achievo.org>

Information Tags:

Methods

[ Top ]

Inherited from parent

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

atkAbstractSearchHandler::$m_table

atkAbstractSearchHandler::$m_table_exists

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 atkAbstractSearchHandler

atkAbstractSearchHandler::fetchCriteria()

Return the criteria based on the postvarse used for storing

atkAbstractSearchHandler::forgetCriteria()

Remove search criteria.

atkAbstractSearchHandler::getForgetCriteria()

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

atkAbstractSearchHandler::getLoadCriteria()

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

atkAbstractSearchHandler::getSaveCriteria()

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

atkAbstractSearchHandler::getSavedCriteria()

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

atkAbstractSearchHandler::getSearchHandlerType()

Return the type of the atkSmartSearchHandler

atkAbstractSearchHandler::getToggleSaveCriteria()

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

atkAbstractSearchHandler::handleSavedCriteria()

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

atkAbstractSearchHandler::listCriteria()

List criteria.

atkAbstractSearchHandler::loadBaseCriteria()

Load base criteria.

atkAbstractSearchHandler::loadCriteria()

Load search criteria.

atkAbstractSearchHandler::saveCriteria()

Save search criteria.

atkAbstractSearchHandler::tableExist()

check if database table exists

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 ]

Method Summary

void	action_smartsearch()	The action handler method.
atkNode	&addNodeAndAttrEntry()	Adds a node/attribute entry to the node/attribute path.
Array	fetchCriteria()	Fetch posted criteria.
void	getAttributeList()	Returns a select element with searchable attributes for a certain node.
void	getCriterium()	Returns the criterium parameters needed to render a criterium. The data structure contains the already known information about the currently selected field and values (if any).
String	getCriteriumField()	Returns the criterium field for the given path.
void	getCriteriumMode()	Returns the criterium mode field for the given path.
void	getCriteriumValue()	Returns the criterium value field for the given path.
String	getLabels()	Returns the base labels for use in the templates.
Array	getNodeAndAttrPath()	Returns the node/attribute path for the given attribute name path.
String	getResetCriteria()	Returns a link for resetting the currently selected criteria.
Array	getSearchableAttributes()	Get searchable attributes for the given node.
full	getTemplate()	Returns the template path with the given name.
void	partialCriterium()	Partial criterium.
void	partialCriteriumField()	Partial criterium field.
void	partialCriteriumMode()	Partial criterium value.
void	partialCriteriumValue()	Partial criterium value.
void	redirectToResults()	Redirect to search results based on the given criteria.
String	renderCriterium()	Renders a single criterium (field and value).
String	smartSearchForm()	This method returns a form that the user can use to search records.
String	smartSearchPage()	This method returns an html page that can be used as a search form.
void	_getCriteriumValueOrMode()	Returns the criterium value or mode field for the given path.
void	_partialCriteriumValueOrMode()	Partial criterium value / mode.

[ Top ]

Properties

Methods

action_smartsearch [line 67]

void action_smartsearch(
)

The action handler method.

[ Top ]

addNodeAndAttrEntry [line 340]

atkNode &addNodeAndAttrEntry(

&$path, 
&$node, String
$attrName, 
&$includeSelf, 
&$excludes, Array
$path, atkNode
$node, Boolean
$includeSelf, Array
$excludes 
)

Adds a node/attribute entry to the node/attribute path.

The entry consists of the the following fields:

nr, number in the node/attribute path (>= 0)
node, reference to the node for this path entry
attr, reference to the currently selected attribute for this path entry
attrs, all searchable attributes for this node
includeSelf, whatever the attribute list should contain a reference to ourselves or not
selectSelf, should the self option be selected? (only valid if includeSelf is true)

This method will modify the $path, $includeSelf and $excludes parameters to prepare them for the next call to this method.

Parameters:

Array	$path:	reference to the current path
atkNode	$node:	reference to the current node
String	$attrName:	currently selected attribute
Boolean	$includeSelf:	should we include ourselves?
Array	$excludes:	attributes to exclude
	&$path:
	&$node:
	&$includeSelf:
	&$excludes:

API Tags:

Return:

next node

[ Top ]

fetchCriteria [line 36]

Array fetchCriteria(
)

Fetch posted criteria.

API Tags:

Return:

fetched criteria

Redefinition of:

atkAbstractSearchHandler::fetchCriteria(): Return the criteria based on the postvarse used for storing

[ Top ]

getAttributeList [line 283]

void getAttributeList(
Array
$entry 
)

Returns a select element with searchable attributes for a certain node.

Parameters:

Array

$entry:

[ Top ]

getCriterium [line 542]

void getCriterium(
String
$id, [Array
$data = array()] 
)

Returns the criterium parameters needed to render a criterium. The data structure contains the already known information about the currently selected field and values (if any).

Parameters:

String	$id:	criterium identifier
Array	$data:	criterium data

[ Top ]

getCriteriumField [line 409]

String getCriteriumField(
Integer
$id, Array
$path, 
&$scriptCode, Array
$scriptCode 
)

Returns the criterium field for the given path.

Parameters:

Integer	$id:	criterium id
Array	$path:	criterium path
Array	$scriptCode:	lines of JavaScript
	&$scriptCode:

API Tags:

Return:

criterium field HTML

[ Top ]

getCriteriumMode [line 529]

void getCriteriumMode(
Integer
$id, Array
$path, [Array
$value = array()], [Array
$mode = array()], String
4 
)

Returns the criterium mode field for the given path.

Parameters:

Integer	$id:	criterium id
Array	$path:	criterium path
Array	$value:	current search value
Array	$mode:	current search mode
String	4:	criterium mode field HTML

[ Top ]

getCriteriumValue [line 514]

void getCriteriumValue(
Integer
$id, Array
$path, [Array
$value = array()], [Array
$mode = array()], String
4 
)

Returns the criterium value field for the given path.

Parameters:

Integer	$id:	criterium id
Array	$path:	criterium path
Array	$value:	current search value
Array	$mode:	current search mode
String	4:	criterium value field HTML

[ Top ]

getLabels [line 227]

String getLabels(
)

Returns the base labels for use in the templates.

Contains labels for the following fields: 'field', 'value', 'add', 'remove'

API Tags:

Return:

label

[ Top ]

getNodeAndAttrPath [line 376]

Array getNodeAndAttrPath(
Array
$attrPath 
)

Returns the node/attribute path for the given attribute name path.

Parameters:

Array

$attrPath:

attribute name path

API Tags:

Return:

node/attribute path

[ Top ]

getResetCriteria [line 583]

String getResetCriteria(
)

Returns a link for resetting the currently selected criteria.

API Tags:

Return:

reset url

[ Top ]

getSearchableAttributes [line 260]

Array getSearchableAttributes(

&$node, Array
$excludes, atkNode
$node 
)

Get searchable attributes for the given node.

Parameters:

atkNode	$node:	reference to the node
Array	$excludes:	attribute exclude list
	&$node:

API Tags:

Return:

list of reference to searchable attributes

[ Top ]

getTemplate [line 243]

full getTemplate(
String
$name 
)

Returns the template path with the given name.

Name can be either 'form' or 'criterium'.

Parameters:

String

$name:

template name

API Tags:

Return:

template path

[ Top ]

partialCriterium [line 120]

void partialCriterium(
)

Partial criterium.

[ Top ]

partialCriteriumField [line 129]

void partialCriteriumField(
)

Partial criterium field.

[ Top ]

partialCriteriumMode [line 196]

void partialCriteriumMode(
)

Partial criterium value.

[ Top ]

partialCriteriumValue [line 188]

void partialCriteriumValue(
)

Partial criterium value.

[ Top ]

redirectToResults [line 206]

void redirectToResults(
Array
$criteria 
)

Redirect to search results based on the given criteria.

Parameters:

Array

$criteria:

[ Top ]

renderCriterium [line 569]

String renderCriterium(
Array
$criterium 
)

Renders a single criterium (field and value).

Parameters:

Array

$criterium:

criterium structure (from getCriterium)

API Tags:

Return:

rendered criterium

[ Top ]

smartSearchForm [line 595]

String smartSearchForm(
[String
$name = ""], [Array
$criteria = array()] 
)

This method returns a form that the user can use to search records.

Parameters:

String	$name:
Array	$criteria:

API Tags:

Return:

The searchform in html form.

[ Top ]

smartSearchPage [line 629]

String smartSearchPage(
[String
$name = ""], [Array
$criteria = array()] 
)

This method returns an html page that can be used as a search form.

Parameters:

String	$name:
Array	$criteria:

API Tags:

Return:

The html search page.

[ Top ]

_getCriteriumValueOrMode [line 457]

void _getCriteriumValueOrMode(
Integer
$id, Array
$path, Array
$value, Array
$mode, String
$type, String
5 
)

Returns the criterium value or mode field for the given path.

Parameters:

Integer	$id:	criterium id
Array	$path:	criterium path
Array	$value:	current search value
Array	$mode:	current search mode
String	$type:	return either 'value' or 'mode' field
String	5:	criterium value or mode field HTML

[ Top ]

_partialCriteriumValueOrMode [line 157]

void _partialCriteriumValueOrMode(
string
$type 
)

Partial criterium value / mode.

Parameters:

string

$type:

'value' or 'mode' partial?

[ Top ]