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

Public Member Functions

 CYap_clsSearchRangeTxt ($cfg, $FieldName)
 
 _Initialize ()
 
 LoadCfg ($cfg)
 
 GetWhereCondition ($Db_Class)
 
 var_padding ($size, $padding, $paddingchar, $text)
 
 ReadFormData ()
 
 GetValueTo ()
 
 SetDefaultValueTo ($value)
 
 StoreInformation ($prefix)
 
 LoadInformation ($prefix)
 
 CleanSessionInfo ($prefix)
 
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

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

Detailed Description

Definition at line 1265 of file CYap_clsSearch.php.

Member Function Documentation

_Initialize ( )

Set the properties to the default value private

Definition at line 1293 of file CYap_clsSearch.php.

CleanSessionInfo (   $prefix)

Definition at line 1461 of file CYap_clsSearch.php.

CYap_clsSearchRangeTxt (   $cfg,
  $FieldName 
)

Definition at line 1281 of file CYap_clsSearch.php.

& GetDrawObject ( )

Draw the field. public

Returns
CYap_Control object

Definition at line 1472 of file CYap_clsSearch.php.

GetValueTo ( )

Return the field value. It may be the data read from the form, if any, or the default value

Returns
string public

Definition at line 1409 of file CYap_clsSearch.php.

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

Definition at line 1320 of file CYap_clsSearch.php.

LoadCfg (   $cfg)

Parse and load the configuration parameters

Parameters
string[]$cfg public
Returns
void

Definition at line 1306 of file CYap_clsSearch.php.

LoadInformation (   $prefix)

Load the field value from session.

See Also
StoreInformation
Parameters
string$prefixpublic
Returns
void

Definition at line 1448 of file CYap_clsSearch.php.

ReadFormData ( )

Read data from search form. Each field retrieves its own value. If the value is not found, the default value is assumed.

Definition at line 1379 of file CYap_clsSearch.php.

SetDefaultValueTo (   $value)

Set the default value. Used the value from $_REQUEST is null It set the variable CYap_clsSearchField::DefaultValue

Parameters
string$valuepublic
Returns
void

Definition at line 1424 of file CYap_clsSearch.php.

StoreInformation (   $prefix)

All other info are retrievd from cfg file. Only the value posted from the form needs to be saved.

Parameters
string$prefixpublic
Returns
void

Definition at line 1436 of file CYap_clsSearch.php.

var_padding (   $size,
  $padding,
  $paddingchar,
  $text 
)

Pad the given field to match the requested size

Parameters
integerthe output size
stringtype of pad (none,left,right,center)
stringchar to use to pad
stringinput text
Returns
string the 'padded' string private

Definition at line 1354 of file CYap_clsSearch.php.

Field Documentation

$DefaultValueTo

Definition at line 1279 of file CYap_clsSearch.php.

$RequestValueTo

Definition at line 1278 of file CYap_clsSearch.php.


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