Class \Prado\Data\ActiveRecord\Scaffold\TScaffoldSearch

TScaffoldSearch provide a simple textbox and a button that is used to perform search on a TScaffoldListView with ID given by {@see setListViewID ListViewID}.

The \Prado\Data\ActiveRecord\Scaffold\getSearchText property is a TTextBox and the \Prado\Data\ActiveRecord\Scaffold\getSearchButton property is a TButton with label value "Search".

Searchable fields of the Active Record can be restricted by specifying a comma delimited string of allowable fields in the \Prado\Data\ActiveRecord\Scaffold\setSearchableFields property. The default is null, meaning that most text type fields are searched (the default searchable fields are database dependent).

Class hierarchy

\Prado\Data\ActiveRecord\Scaffold\TScaffoldSearch

\Prado\Data\ActiveRecord\Scaffold\TScaffoldBase

\Prado\Web\UI\TTemplateControl

\Prado\Web\UI\TCompositeControl implements INamingContainer

\Prado\Web\UI\TControl implements IRenderable, IBindable

\Prado\TApplicationComponent

\Prado\TComponent

Author: Wei Zhuo <weizhuo[at]gmail[dot]com>
Since: 3.1

Methods summary
`public`	`bubbleEvent(mixed $sender, mixed $param) : mixed` Sets the SearchCondition of the TScaffoldListView as the search terms given by the text of the search text box.
`public`	`getListViewID() : string`
`public`	`getSearchableFields() : string`
`public`	`getSearchButton() : TButton`
`public`	`getSearchText() : TTextBox`
`public`	`setListViewID(string $value) : mixed`
`public`	`setSearchableFields(string $value) : mixed`
`protected`	`createSearchCondition() : string`
`protected`	`getFields() : array<string\|int, mixed>`
`protected`	`getListView() : TScaffoldListView`

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addedControl, addParsedObject, applyStyleSheetSkin, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, autoBindProperty, bindProperty, broadcastEvent, bubbleEvent, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, clearNamingContainer, clearViewState, convertUniqueIdToClientId, createChildControls, createdOnTemplate, dataBind, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, ensureChildControls, evaluateExpression, evaluateStatements, findControl, findControlsByID, findControlsByType, focus, fxAttachClassBehavior, fxDetachClassBehavior, getAdapter, getAllowChildControls, getApplication, getAttribute, getAttributes, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getClientID, getControls, getCustomData, getDefaultStyle, getEnabled, getEnableDefaultStyle, getEnableTheming, getEnableViewState, getEventHandlers, getHasAdapter, getHasAttributes, getHasChildInitialized, getHasControls, getHasInitialized, getHasLoaded, getHasLoadedPostData, getHasPreRendered, getID, getIsSkinApplied, getIsSourceTemplateControl, getListeningToGlobalEvents, getMaster, getMasterClass, getNamingContainer, getPage, getParent, getPluginModule, getRecordClass, getRegisteredObject, getRequest, getResponse, getService, getSession, getSkinID, getSourceTemplateControl, getSubProperty, getTemplate, getTemplateControl, getTemplateDirectory, getUniqueID, getUser, getViewState, getVisible, hasAttribute, hasEvent, hasEventHandler, hasMethod, hasProperty, injectContent, isa, isObjectRegistered, listen, loadState, onDataBinding, onInit, onLoad, onPreRender, onUnload, publishAsset, publishFilePath, raiseEvent, registerContent, registerContentPlaceHolder, registerObject, removeAttribute, removedControl, render, renderChildren, renderControl, saveState, setAdapter, setAttribute, setCustomData, setDefaultStyle, setEnabled, setEnableDefaultStyle, setEnableTheming, setEnableViewState, setID, setMasterClass, setPage, setRecordClass, setSkinID, setSubProperty, setTemplate, setTemplateControl, setViewState, setVisible, trackViewState, tryToUpdateAR, tryToUpdateView, unbindProperty, unlisten, unregisterObject, _getZappableSleepProps, autoDataBindProperties, clearChildState, clearControlState, clearRecordObject, copyFrom, createControlCollection, dataBindChildren, dataBindProperties, getCallChain, getChildControlsCreated, getClassFxEvents, getControlStage, getControlState, getRecordFinder, getRecordObject, getRecordPkValues, getRecordPropertyValues, getTableInfo, initRecursive, instanceBehavior, isDescendentOf, loadRecursive, loadStateRecursive, loadTemplate, preRenderRecursive, raiseBubbleEvent, saveStateRecursive, setChildControlsCreated, setControlStage, setControlState, setRecordObject, traverseChildControls, unloadRecursive, broadcastEventInternal, clearCachedUniqueID, clearNameTable, fillNameTable, filter_prado_fx, generateAutomaticID

Inherited constants
\Prado\Web\UI\TControl::AUTOMATIC_ID_PREFIX, \Prado\Web\UI\TControl::CLIENT_ID_SEPARATOR, \Prado\Web\UI\TControl::CS_CHILD_INITIALIZED, \Prado\Web\UI\TControl::CS_CONSTRUCTED, \Prado\Web\UI\TControl::CS_INITIALIZED, \Prado\Web\UI\TControl::CS_LOADED, \Prado\Web\UI\TControl::CS_PRERENDERED, \Prado\Web\UI\TControl::CS_STATE_LOADED, \Prado\Web\UI\TTemplateControl::EXT_TEMPLATE, \Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER, \Prado\Web\UI\TControl::ID_FORMAT, \Prado\Web\UI\TControl::ID_SEPARATOR, \Prado\Web\UI\TControl::IS_CHILD_CREATED, \Prado\Web\UI\TControl::IS_CREATING_CHILD, \Prado\Web\UI\TControl::IS_DISABLE_THEMING, \Prado\Web\UI\TControl::IS_DISABLE_VIEWSTATE, \Prado\Web\UI\TControl::IS_ID_SET, \Prado\Web\UI\TControl::IS_SKIN_APPLIED, \Prado\Web\UI\TControl::IS_STYLESHEET_APPLIED, \Prado\Web\UI\TControl::RF_ADAPTER, \Prado\Web\UI\TControl::RF_AUTO_BINDINGS, \Prado\Web\UI\TControl::RF_CHILD_STATE, \Prado\Web\UI\TControl::RF_CONTROLS, \Prado\Web\UI\TControl::RF_CONTROLSTATE, \Prado\Web\UI\TControl::RF_DATA_BINDINGS, \Prado\Web\UI\TControl::RF_EVENTS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS_ID, \Prado\Web\UI\TControl::RF_NAMED_OBJECTS, \Prado\Web\UI\TControl::RF_SKIN_ID

Classes

Interfaces

Traits

Search results

Class \Prado\Data\ActiveRecord\Scaffold\TScaffoldSearch

Class hierarchy