YAP  2.5
 All Data Structures Namespaces Files Functions Variables
CYap_Control Class Reference
Inheritance diagram for CYap_Control:
CYap_Preset CYap_SelectBox CYap_TextBox CYap_ViewDate CYap_ViewOptRegex

Public Member Functions

 CYap_control ($TableFieldDef=array())
 
 BindField ($FieldDef)
 
 SetValue ($value)
 
 SetControlName ($name)
 
 SetControlLabel ($name)
 
 SetCalBackFunc ($name)
 
 SetProperty ($Property, $value)
 
 ParseResponse ()
 
 _InternalCheck ()
 
 IsValid ()
 
 GetSqlData ()
 
 GetSqlFieldName ()
 
 GetInfo ($InfoName)
 
 GetHeaderCode ()
 
 HasValue ()
 
 GetValue ()
 
 GetJsCode ()
 
 GetJsSubmitFunction ()
 
 Draw ($Show=true)
 
 DrawLabel ($Show=true)
 
 IsHidden ()
 

Data Fields

 $Name
 
 $DbField
 
 $DbFieldInfo
 
 $ValidIndex =array('autoincrement','values','table','type','apice','size','decimal','name')
 
 $FieldValue
 
 $IHaveValue
 
 $CallBackCheck
 
 $IsValidInput
 
 $Label
 

Detailed Description

Definition at line 40 of file CYap_Control.php.

Member Function Documentation

_InternalCheck ( )

Internal function to check the input value. Each control may develop som intrisic cchecks i.e an integer inpu accepts only integer value In the base class this function is empty private

Definition at line 196 of file CYap_Control.php.

BindField (   $FieldDef)

Definition at line 118 of file CYap_Control.php.

CYap_control (   $TableFieldDef = array())

Class constructor

Parameters
arraythis table contains the definition for the field binded to this control

Definition at line 105 of file CYap_Control.php.

Draw (   $Show = true)

Draw the control

Parameters
boolShould the function echo the code, or return it as string public
Returns
string

Definition at line 293 of file CYap_Control.php.

DrawLabel (   $Show = true)

Draw the control label. The base class provides standard way to draw the label.

Parameters
boolean$Show
Returns
string public
Since
2.1.0

Definition at line 303 of file CYap_Control.php.

GetHeaderCode ( )

Definition at line 250 of file CYap_Control.php.

GetInfo (   $InfoName)

return the value of the index $InfoName of $this->DbFieldInfo

Parameters
string$InfoName
Returns
string public

Definition at line 239 of file CYap_Control.php.

GetJsCode ( )

Return the Js code reuired by the control public

Definition at line 272 of file CYap_Control.php.

GetJsSubmitFunction ( )

Return the JS code required to write the function to check the form before submit it public

Definition at line 281 of file CYap_Control.php.

GetSqlData ( )

Retrieve the value in the format suitable to build an update SQL query

Returns
string public

Definition at line 216 of file CYap_Control.php.

GetSqlFieldName ( )

Retrieve the value in the format suitable to build an update SQL query

Returns
string public

Definition at line 228 of file CYap_Control.php.

GetValue ( )

Definition at line 264 of file CYap_Control.php.

HasValue ( )

Has been set the control's value?

Returns
boolean

Definition at line 259 of file CYap_Control.php.

IsHidden ( )

The hidden fields are fields expected not to be requested (never show) in modify form. The default are false, (show the field)

Returns
boolean public

Definition at line 313 of file CYap_Control.php.

IsValid ( )

The current value is valid?

Returns
bool public

Definition at line 207 of file CYap_Control.php.

ParseResponse ( )

Load the input value from form answer

public

Definition at line 181 of file CYap_Control.php.

SetCalBackFunc (   $name)

Set tha callback function to check the input value

Parameters
stringpublic

Definition at line 159 of file CYap_Control.php.

SetControlLabel (   $name)

set the Label for the control

Parameters
stringpublic

Definition at line 150 of file CYap_Control.php.

SetControlName (   $name)

set the name for the control

Parameters
stringpublic

Definition at line 141 of file CYap_Control.php.

SetProperty (   $Property,
  $value 
)

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

Parameters
Propertystring
Valuemixed public

Definition at line 170 of file CYap_Control.php.

SetValue (   $value)

Set the current value for the field

Parameters
stringmixed public

Definition at line 130 of file CYap_Control.php.

Field Documentation

$CallBackCheck

Definition at line 88 of file CYap_Control.php.

$DbField

Definition at line 51 of file CYap_Control.php.

$DbFieldInfo

Definition at line 65 of file CYap_Control.php.

$FieldValue

Definition at line 76 of file CYap_Control.php.

$IHaveValue

Definition at line 83 of file CYap_Control.php.

$IsValidInput

Definition at line 93 of file CYap_Control.php.

$Label

Definition at line 97 of file CYap_Control.php.

$Name

Definition at line 46 of file CYap_Control.php.

$ValidIndex =array('autoincrement','values','table','type','apice','size','decimal','name')

Definition at line 70 of file CYap_Control.php.


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