CYap_clsSearchField Class Reference

Inheritance diagram for CYap_clsSearchField:

Public Member Functions
	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
	$Type
	$PaddingChar
	$Padding
	$UseRegex
	$Label
	$MyName
	$DbField
	$Size
	$RequestValue
	$ViewClass
	$ViewObj
	$DefaultValue
	$FieldOrder

Detailed Description

Definition at line 611 of file CYap_clsSearch.php.

Member Function Documentation

_Initialize

(

)

Set the properties to the default value private

Definition at line 695 of file CYap_clsSearch.php.

_MakeViewObj

(

)

Istance of ViewClass public

Returns

CYAP_Control object

Definition at line 875 of file CYap_clsSearch.php.

CleanSessionInfo

(

$prefix

)

Definition at line 829 of file CYap_clsSearch.php.

CYap_clsSearchField	(		$cfg,
			$FieldName
	)

Enter description here...

Parameters

array	$cfg	Configuration parameters
string	$FieldName

Returns

CYap_clsSearchField public

Definition at line 666 of file CYap_clsSearch.php.

& GetDrawObject

(

)

Draw the field. public

Returns

CYap_Control object

Definition at line 866 of file CYap_clsSearch.php.

GetParameter	(		$paramName,
			$cfg,
			$default
	)

utility used to extract the request parameter from the configuration array.

Parameters

string	$paramName
	string[]	$cfg
string	$default

Returns

string private

Definition at line 684 of file CYap_clsSearch.php.

GetProperty

(

$Property

)

Get the value of the requested property

Parameters

string

$Property

Returns

mixed public

Definition at line 767 of file CYap_clsSearch.php.

GetValue

(

)

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 790 of file CYap_clsSearch.php.

GetWhereCondition

(

$db_class

)

Parameters

CYap_Db

$db_class

Returns

String public

Since

2.1.0

Definition at line 779 of file CYap_clsSearch.php.

JsSearchFieldValidate

(

)

Js code to validate the field value called by CYAP_clsSearch Abstract public

Returns

void

See Also

show_form()

Definition at line 857 of file CYap_clsSearch.php.

LoadCFg

(

$cfg

)

Parse and load the configuration parameters

Parameters

string[]

$cfg public

Returns

void

Definition at line 713 of file CYap_clsSearch.php.

LoadInformation

(

$prefix

)

Load the field value from session.

See Also

StoreInformation

Parameters

string

$prefix

public

Returns

void

Definition at line 817 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 838 of file CYap_clsSearch.php.

SetDefaultValue

(

$value

)

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

Parameters

string

$value

public

Returns

void

Definition at line 740 of file CYap_clsSearch.php.

SetLabel

(

$value

)

Definition at line 744 of file CYap_clsSearch.php.

SetProperty	(		$Property,
			$value
	)

Generic function to set the paramters without create many set function as the property declared by each control

Parameters

Property	string
Value	mixed public

Definition at line 755 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

$prefix

public

Returns

void

Definition at line 806 of file CYap_clsSearch.php.

Field Documentation

$DbField

Definition at line 628 of file CYap_clsSearch.php.

mixed $DefaultValue

Default value form the field, if any is supplied

Definition at line 653 of file CYap_clsSearch.php.

$FieldOrder

Definition at line 657 of file CYap_clsSearch.php.

$Label

Definition at line 618 of file CYap_clsSearch.php.

$MyName

Definition at line 623 of file CYap_clsSearch.php.

$Padding

Definition at line 616 of file CYap_clsSearch.php.

$PaddingChar

Definition at line 615 of file CYap_clsSearch.php.

$RequestValue

Definition at line 638 of file CYap_clsSearch.php.

$Size

Definition at line 633 of file CYap_clsSearch.php.

$Type

Definition at line 614 of file CYap_clsSearch.php.

$UseRegex

Definition at line 617 of file CYap_clsSearch.php.

$ViewClass

Definition at line 643 of file CYap_clsSearch.php.

$ViewObj

Definition at line 648 of file CYap_clsSearch.php.

---

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

• D:/programmi/WebDarvin/classistd/yap/CYap_clsSearch.php