Docs For Class atkSmartSearchHandler
Atk API home Class tree Element index

Todo list

Packages: » atk Classes: general » AllTests » atkConfig » atkController » atkDataNode » atkErrorHandlerBase » atkFileEditor » atkLanguage » atkMailErrorHandler » atkMetaNode » atkMockNode » atkNode » atkNodeValidator » atkOneToManyRelationSessionGridHandler » atkPHPView » atkSessionStore » atkStatementIterator » atkTreeNode » atkWizardBase » atkZendPlatformErrorHandler » clsTbsDataSource » clsTbsLocator » clsTinyButStrong » clsTinyButStrongOOo » FCKeditor » getSupportedLanguagesCollector » layout » node » sql_whereclause_blacklist_checker » test » tree utils » atkAbstractFrame » atkActionListener » atkClassFinder » atkClassLoader » atkCompatSelector » atkDataHolder » atkDebugger » atkDirectoryTraverser » atkEventLog » atkFileUtils » atkFrame » atkFrameSet » atkIpUtils » atkJSON » atkMail » atkMailer » atkMessageQueue » atkMLSelector » atkmlsplitter » atkRootFrameset » atkSelector » atkSelectorIterator » atkString » atkStringParser » atkTableRenderer » atkTableRendererGrouped » atkTextMarker » atkTmpFile » atkTriggerListener » atkYAML » atkZip » browserInfo fixture » atkAbstractFixtureLoader » atkFixtureManager » atkPHPFixtureLoader » atkYAMLFixtureLoader testcases » atkAbstractSearchHandler ui » atkActionBoxBuilder » atkDialog » atkIndexPage » atkOutput » atkPage » atkPageBuilder » atkTheme » atkThemeCompiler » atkUI handlers » atkActionHandler » atkAddHandler » atkAddOrCopyHandler » atkAdminHandler » atkAttributeEditHandler » atkCopyHandler » atkDeleteHandler » atkDocumentHandler » atkEditCopyHandler » atkEditHandler » atkExportHandler » atkFeedbackHandler » atkFileExport » atkImportHandler » atkMultiSelectHandler » atkMultiUpdatehandler » atkSaveHandler » atkSearchHandler » atkSelectHandler » atkSmartSearchHandler » atkUpdatehandler » atkViewEditBase » atkViewHandler » atkXmlHandler attributes » atkAggregatedColumn » atkAttribute » atkBoolAttribute » atkCalculatorAttribute » atkCaptchaAttribute » atkColorPickerAttribute » atkCountryAttribute » atkCreatedByAttribute » atkCreateStampAttribute » atkCurrencyAttribute » atkDateAttribute » atkDateTimeAttribute » atkDocumentAttribute » atkDummyAttribute » atkDurationAttribute » atkEmailAttribute » atkExpressionAttribute » atkFckAttribute » atkFieldSet » atkFileAttribute » atkFileWriterAttribute » atkFlagAttribute » atkFormatAttribute » atkFuzzySearchAttribute » atkHiddenAttribute » atkHtmlAttribute » atkIpAttribute » atkListAttribute » atkLiveTextPreview » atkMlAttribute » atkMlFckAttribute » atkMlHtmlAttribute » atkMlNumberAttribute » atkMlSelectorAttribute » atkMlTextAttribute » atkMlWrapper » atkMultipleFileAttribute » atkMultiSelectAttribute » atkNumberAttribute » atkParserAttribute » atkPasswordAttribute » atkProfileAttribute » atkRadioAttribute » atkRadioDetailsAttribute » atkRowCounter » atkStateAttribute » atkTabbedPane » atkTagAttribute » atkTextAttribute » atkTimeAttribute » atkTimeZoneAttribute » atkToolbar » atkUpdatedByAttribute » atkUpdateStampAttribute » atkUrlAttribute » atkWeekdayAttribute » atkWysiwygAttribute datatypes » atkArrayDt » atkDataType » atkStringDt » atkTime subpackage » atkAttributeTestCase security » atkBajusEncryption » atkBase64Encryption » atkEncryption » atkMockSecurityManager » atkOpenSSLEncryption » atkSecurityListener » atkSecurityManager » atkUrlVault » auth_config » auth_db » auth_imap » auth_interface » auth_ldap » auth_none » auth_pop3 » auth_saml » auth_server » auth_sspi cache » atkCache » atkCache_apc » atkCache_eaccelerator » atkCache_file » atkCache_memcache » atkCache_var » atkCache_xcache » atkCache_zp_disk » atkCache_zp_output » atkCache_zp_shm test » atkCacheTestCase » atkPluginTestCase » atkTestCase » test_sql_whereclause_blacklist_checker db » atkClusterDb » atkClusterDDL » atkClusterQuery » atkDb » atkdb2db » atkDb2DDL » atkDb2Query » atkDDL » atki5db » atki5DDL » atki5query » atkMockDb » atkMockDDL » atkMockQuery » atkMsSqlDb » atkMsSqlDDL » atkMssqlQuery » atkMysqlDb » atkMysqlDDL » atkMysqliDb » atkMysqliDDL » atkMysqliQuery » atkMysqlQuery » atkOci8Db » atkOci8DDL » atkOci8Query » atkOci9Db » atkOci9DDL » atkOci9Query » atkOci805Db » atkOci805Query » atkPgsqlDb » atkPgsqlDDL » atkPgsqlQuery » atkQuery recordlist » atkColumnConfig » atkCSVRecordList » atkCustomRecordList » atkExcelCSVRecordList » atkHTMLRecordList » atkPrintableRecordList » atkRecordList » atkRecordlistCache » atkTotalizer db-statement » atkCompatStatement » atkMySQLiStatement » atkStatement » atkStatementException » atkStatementParser console » atkConsoleController menu » atkcookmenu » atkDhtmlMenu » atkDropdownMenu » atkFramesMenu » atkMenu » atkmenuinterface » atkModernMenu » atkOutlookMenu » atkPlainMenu datagrid » atkDataGrid » atkDGComponent » atkDGEditControl » atkDGEvent » atkDGIndex » atkDGLimit » atkDGList » atkDGNoRecordsFound » atkDGPaginator » atkDGRenderer » atkDGSummary lock » atkDbLock » atkLock filters » atkDistinctFilter » atkFilter » atkGroupByFilter document » atkDocumentWriter » atkDocxWriter » atkOpenDocumentWriter meta » atkDutchMetaGrammar » atkMetaAttributeModifier » atkMetaCompiler » atkMetaGrammar » atkMetaPolicy » mod_meta relations » atkExtendableShuttleRelation » atkManyBoolRelation » atkManyToManyListRelation » atkManyToManyRelation » atkManyToManySelectRelation » atkManyToOneRelation » atkManyToOneTreeRelation » atkMatrixRelation » atkOneToManyRelation » atkOneToOneRelation » atkPolymorphicOneToOneRelation » atkRelation » atkSecureRelation » atkShuttleControl » atkShuttleFilter » atkShuttleRelation front » atkFrontController » atkFrontControllerBridge keyboard » atkKeyboard meta-relations » atkMetaExtendableShuttleRelation » atkMetaManyBoolRelation » atkMetaManyToManyListRelation » atkMetaManyToManySelectRelation » atkMetaManyToOneRelation » atkMetaOneToManyRelation » atkMetaOneToOneRelation » atkMetaShuttleRelation session » atkMockSessionManager » atkSessionManager » atkState modules » atkModule » mod_test listeners » atkRecycleBin interface » atkServer » atkSoapServer wizard » atkWizard » AtkWizardActionLoader » atkWizardPanel
Interfaces: datagrid » atkDGListener interface » atkServerInterface
Files: general » adodb-time.inc.php » AllTests.php » atknodetools.inc » atktools.inc » atktreetools.inc » basexml.php » bootstrap.inc » bootstrap.php » class.atkconfig.inc » class.atkcontroller.inc » class.atkdatanode.inc » class.atkerrorhandlerbase.inc » class.atkfileeditor.inc » class.atki5db.inc » class.atki5ddl.inc » class.atki5query.inc » class.atklanguage.inc » class.atkmailerrorhandler.inc » class.atkmetanode.inc » class.atkmocknode.inc » class.atkmocksessionmanager.inc » class.atknode.inc » class.atknodevalidator.inc » class.atkonetomanyrelationsessiongridhandler.inc » class.atkphpview.inc » class.atkpolymorphiconetoonerelation.inc » class.atksessionstore.inc » class.atkstatementiterator.inc » class.atktreenode.inc » class.atkwizardbase.inc » class.atkzendplatformerrorhandler.inc » class.layout.inc » class.nodename.inc » class.sql_whereclause_blacklist_checker.inc » class.test.inc » class.test_sql_whereclause_blacklist_checker.inc » commands.php » config.modules.inc » config.php » connector.php » console.php » db2yaml.php » defaultconfig.inc.php » fckeditor.php » fckeditor_php4.php » fckeditor_php5.php » io.php » module.inc » phpcompat.php » server.php » spellchecker.php » table2yaml.php » tbsooo_class.php » tbs_class.php » tooltip.tpl.php » upload.php » util.php » version.inc attributes » class.atkaggregatedcolumn.inc » class.atkattribute.inc » class.atkboolattribute.inc » class.atkcalculatorattribute.inc » class.atkcaptchaattribute.inc » class.atkcolorpickerattribute.inc » class.atkcountryattribute.inc » class.atkcreatedbyattribute.inc » class.atkcreatestampattribute.inc » class.atkcurrencyattribute.inc » class.atkdateattribute.inc » class.atkdatetimeattribute.inc » class.atkdocumentattribute.inc » class.atkdummyattribute.inc » class.atkdurationattribute.inc » class.atkemailattribute.inc » class.atkexpressionattribute.inc » class.atkfckattribute.inc » class.atkfieldset.inc » class.atkfileattribute.inc » class.atkfilewriterattribute.inc » class.atkflagattribute.inc » class.atkformatattribute.inc » class.atkfuzzysearchattribute.inc » class.atkhiddenattribute.inc » class.atkhtmlattribute.inc » class.atkipattribute.inc » class.atklistattribute.inc » class.atklivetextpreview.inc » class.atkmlattribute.inc » class.atkmlfckattribute.inc » class.atkmlhtmlattribute.inc » class.atkmlnumberattribute.inc » class.atkmlselectorattribute.inc » class.atkmltextattribute.inc » class.atkmlwrapper.inc » class.atkmultiplefileattribute.inc » class.atkmultiselectattribute.inc » class.atknumberattribute.inc » class.atkparserattribute.inc » class.atkpasswordattribute.inc » class.atkprofileattribute.inc » class.atkradioattribute.inc » class.atkradiodetailsattribute.inc » class.atkrowcounter.inc » class.atkstateattribute.inc » class.atktabbedpane.inc » class.atktagattribute.inc » class.atktextattribute.inc » class.atktimeattribute.inc » class.atktimezoneattribute.inc » class.atktoolbar.inc » class.atkupdatedbyattribute.inc » class.atkupdatestampattribute.inc » class.atkurlattribute.inc » class.atkweekdayattribute.inc » class.atkwysiwygattribute.inc attributes-- » property_accessor.php cache » class.atkcache.inc » class.atkcache_apc.inc » class.atkcache_eaccelerator.inc » class.atkcache_file.inc » class.atkcache_memcache.inc » class.atkcache_var.inc » class.atkcache_xcache.inc » class.atkcache_zp_disk.inc » class.atkcache_zp_output.inc » class.atkcache_zp_shm.inc console » class.atkconsolecontroller.inc datagrid » class.atkdatagrid.inc » class.atkdgcomponent.inc » class.atkdgeditcontrol.inc » class.atkdgevent.inc » class.atkdgindex.inc » class.atkdglimit.inc » class.atkdglist.inc » class.atkdglistener.inc » class.atkdgnorecordsfound.inc » class.atkdgpaginator.inc » class.atkdgrenderer.inc » class.atkdgsummary.inc datatypes » class.atkarraydt.inc » class.atkdatatype.inc » class.atkstringdt.inc » class.atktimedt.inc db » class.atkclusterdb.inc » class.atkclusterddl.inc » class.atkclusterquery.inc » class.atkdb.inc » class.atkdb2db.inc » class.atkdb2ddl.inc » class.atkdb2query.inc » class.atkddl.inc » class.atkmockdb.inc » class.atkmockddl.inc » class.atkmockquery.inc » class.atkmssqldb.inc » class.atkmssqlddl.inc » class.atkmssqlquery.inc » class.atkmysqldb.inc » class.atkmysqlddl.inc » class.atkmysqlidb.inc » class.atkmysqliddl.inc » class.atkmysqliquery.inc » class.atkmysqlquery.inc » class.atkoci8db.inc » class.atkoci8ddl.inc » class.atkoci8query.inc » class.atkoci9db.inc » class.atkoci9ddl.inc » class.atkoci9query.inc » class.atkoci805db.inc » class.atkoci805query.inc » class.atkpgsqldb.inc » class.atkpgsqlddl.inc » class.atkpgsqlquery.inc » class.atkquery.inc db-statement » class.atkcompatstatement.inc » class.atkmysqlistatement.inc » class.atkstatement.inc » class.atkstatementexception.inc » class.atkstatementparser.inc document » class.atkdocumentwriter.inc » class.atkdocxwriter.inc » class.atkopendocumentwriter.inc filters » class.atkdistinctfilter.inc » class.atkfilter.inc » class.atkgroupbyfilter.inc fixture » class.atkabstractfixtureloader.inc » class.atkfixturemanager.inc » class.atkphpfixtureloader.inc » class.atkyamlfixtureloader.inc front » class.atkfrontcontroller.inc » class.atkfrontcontrollerbridge.inc handlers » class.atkactionhandler.inc » class.atkaddhandler.inc » class.atkaddorcopyhandler.inc » class.atkadminhandler.inc » class.atkattributeedithandler.inc » class.atkcopyhandler.inc » class.atkdeletehandler.inc » class.atkdocumenthandler.inc » class.atkeditcopyhandler.inc » class.atkedithandler.inc » class.atkexporthandler.inc » class.atkfeedbackhandler.inc » class.atkfileexport.inc » class.atkimporthandler.inc » class.atkmultiselecthandler.inc » class.atkmultiupdatehandler.inc » class.atksavehandler.inc » class.atksearchhandler.inc » class.atkselecthandler.inc » class.atksmartsearchhandler.inc » class.atkupdatehandler.inc » class.atkvieweditbase.inc » class.atkviewhandler.inc » class.atkxmlhandler.inc include » autoload.inc » basics.inc » compatibility.inc » configs.inc » debugging.inc » errorhandler.inc » globals.inc » initial.inc » security.inc interface » class.atkserver.inc » class.atksoapserver.inc » interface.atkserverinterface.inc javascript » class.atkmultilanguage.js.php » class.atkprofileattribute.js.php » dhtml_tabs.js.php keyboard » class.atkkeyboard.inc listeners » class.atkrecyclebin.inc lock » class.atkdblock.inc » class.atklock.inc » lock.php lock-- » lock.js.php menu » atkmenutools.inc » class.atkcookmenu.inc » class.atkdhtmlmenu.inc » class.atkdropdownmenu.inc » class.atkframesmenu.inc » class.atkmenu.inc » class.atkmenuinterface.inc » class.atkmodernmenu.inc » class.atkoutlookmenu.inc » class.atkplainmenu.inc meta » class.atkdutchmetagrammar.inc » class.atkmetaattributemodifier.inc » class.atkmetacompiler.inc » class.atkmetagrammar.inc » class.atkmetapolicy.inc » module.inc meta-relations » class.atkmetaextendableshuttlerelation.inc » class.atkmetamanyboolrelation.inc » class.atkmetamanytomanylistrelation.inc » class.atkmetamanytomanyselectrelation.inc » class.atkmetamanytoonerelation.inc » class.atkmetaonetomanyrelation.inc » class.atkmetaonetoonerelation.inc » class.atkmetashuttlerelation.inc modules » class.atkmodule.inc modules-- » atkmoduletools.inc popups » colorpicker.inc recordlist » class.atkcolumnconfig.inc » class.atkcsvrecordlist.inc » class.atkcustomrecordlist.inc » class.atkexcelcsvrecordlist.inc » class.atkhtmlrecordlist.inc » class.atkprintablerecordlist.inc » class.atkrecordlist.inc » class.atkrecordlistcache.inc » class.atktotalizer.inc relations » class.atkextendableshuttlerelation.inc » class.atkmanyboolrelation.inc » class.atkmanytomanylistrelation.inc » class.atkmanytomanyrelation.inc » class.atkmanytomanyselectrelation.inc » class.atkmanytoonerelation.inc » class.atkmanytoonetreerelation.inc » class.atkmatrixrelation.inc » class.atkonetomanyrelation.inc » class.atkonetoonerelation.inc » class.atkrelation.inc » class.atksecurerelation.inc » class.atkshuttlecontrol.inc » class.atkshuttlefilter.inc » class.atkshuttlerelation.inc security » class.atkbajusencryption.inc » class.atkbase64encryption.inc » class.atkencryption.inc » class.atkmocksecuritymanager.inc » class.atkmocksecuritymanager.inc » class.atkopensslencryption.inc » class.atksecuritylistener.inc » class.atksecuritymanager.inc » class.atkurlvault.inc » class.auth_config.inc » class.auth_db.inc » class.auth_imap.inc » class.auth_interface.inc » class.auth_ldap.inc » class.auth_none.inc » class.auth_pop3.inc » class.auth_saml.inc » class.auth_server.inc » class.auth_sspi.inc session » class.atksessionmanager.inc » class.atkstate.inc skel » app.php » atk.inc » config.inc.php » debugger.php » dispatch.php » include.php » index.php » menu.php » top.php » welcome.php subpackage » class.atkattributetestcase.inc test » class.atkcachetestcase.inc » class.atkplugintestcase.inc » class.atktestcase.inc testcases » class.atkabstractsearchhandler.inc themes » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc ui » block.atknavigator.php » block.atknavigatorinfo.php » class.atkactionboxbuilder.inc » class.atkdialog.inc » class.atkindexpage.inc » class.atkoutput.inc » class.atkpage.inc » class.atkpagebuilder.inc » class.atktheme.inc » class.atkthemecompiler.inc » class.atkui.inc » function.atkconf.php » function.atkconfig.php » function.atkdatefield.php » function.atkdispatchfile.php » function.atkfrontcontroller.php » function.atkloadscript.php » function.atkmessages.php » function.atkmoduledir.php » function.atkscript.php » function.atkstyle.php » function.atktext.php » function.atkthemeicon.php » function.atkthemeimg.php » function.stacktrace.php » modifier.atkjson.php » modifier.atkvardump.php » resource.string.php » resource.theme.php » resource.ui.php utils » atkbrowsertools.inc » class.atkactionlistener.inc » class.atkclassloader.inc » class.atkcompatselector.inc » class.atkdataholder.inc » class.atkdebugger.inc » class.atkdirectorytraverser.inc » class.atkeventlog.inc » class.atkfileutils.inc » class.atkframeset.inc » class.atkiputils.inc » class.atkjson.inc » class.atkmail.inc » class.atkmailer.inc » class.atkmessagequeue.inc » class.atkmlselector.inc » class.atkmlsplitter.inc » class.atkselector.inc » class.atkselectoriterator.inc » class.atkstring.inc » class.atkstringparser.inc » class.atktablerenderer.inc » class.atktablerenderergrouped.inc » class.atktextmarker.inc » class.atktmpfile.inc » class.atktriggerlistener.inc » class.atkyaml.inc » class.atkzip.inc » help.inc wizard » class.atkwizard.inc » class.atkwizardactionloader.inc » class.atkwizardpanel.inc
Home  ->  Documentation home  ->  Atk index  ->  Docs For Class atkSmartSearchHandler [ package: atk ]

Class: atkSmartSearchHandler

Source Location: /handlers/class.atksmartsearchhandler.inc

Class atkSmartSearchHandler

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_boxTemplate
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::getCSRFToken()
Get/generate CSRF token for the current session stack.
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::isValidCSRFToken()
Checks whatever the given CSRF token matches the one stored in the session stack.
atkActionHandler::modifyDataGrid()
Modify grid.
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::setBoxTemplate()
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 ]

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 ]
Home | About | Contact