YAP  2.5
 All Data Structures Namespaces Files Functions Variables
CYap_clsSearchSelectBox Class Reference
Inheritance diagram for CYap_clsSearchSelectBox:
CYap_clsSearchField

Public Member Functions

 CYap_clsSearchSelectBox ($cfg, $FieldName)
 
 _Initialize ()
 
 LoadCfg ($cfg)
 
 AddOption ($Text, $Value)
 
 GetWhereCondition ($Db_Class)
 
GetDrawObject ()
 
- Public Member Functions inherited from CYap_clsSearchField
 CYap_clsSearchField ($cfg, $FieldName)
 
 GetParameter ($paramName, $cfg, $default)
 
 _Initialize ()
 
 LoadCFg ($cfg)
 
 SetDefaultValue ($value)
 
 SetLabel ($value)
 
 SetProperty ($Property, $value)
 
 GetProperty ($Property)
 
 GetWhereCondition ($db_class)
 
 GetValue ()
 
 StoreInformation ($prefix)
 
 LoadInformation ($prefix)
 
 CleanSessionInfo ($prefix)
 
 ReadFormData ()
 
 JsSearchFieldValidate ()
 
GetDrawObject ()
 
 _MakeViewObj ()
 

Data Fields

 $OptionList
 
- Data Fields inherited from CYap_clsSearchField
 $Type
 
 $PaddingChar
 
 $Padding
 
 $UseRegex
 
 $Label
 
 $MyName
 
 $DbField
 
 $Size
 
 $RequestValue
 
 $ViewClass
 
 $ViewObj
 
 $DefaultValue
 
 $FieldOrder
 

Detailed Description

Definition at line 1172 of file CYap_clsSearch.php.

Member Function Documentation

_Initialize ( )

Set the properties to the default value private

Definition at line 1190 of file CYap_clsSearch.php.

AddOption (   $Text,
  $Value 
)

Add the options to choose from.

Parameters
string$TextOption label
string$ValueValue returned by the option public
Returns
void

Definition at line 1221 of file CYap_clsSearch.php.

CYap_clsSearchSelectBox (   $cfg,
  $FieldName 
)

Definition at line 1181 of file CYap_clsSearch.php.

& GetDrawObject ( )

Draw the field. public

Returns
CYap_Control object

Definition at line 1254 of file CYap_clsSearch.php.

GetWhereCondition (   $Db_Class)
Parameters
CYap_Db$db_class
Returns
String public
Since
2.1.0

Special values ALL and NOFILTER tell the class to not apply any filter

Definition at line 1231 of file CYap_clsSearch.php.

LoadCfg (   $cfg)

Parse and load the configuration parameters

Parameters
string[]$cfg public
Returns
void

Definition at line 1204 of file CYap_clsSearch.php.

Field Documentation

$OptionList

Definition at line 1179 of file CYap_clsSearch.php.


The documentation for this class was generated from the following file: