Public Member Functions | Data Fields | Protected Member Functions

BizField Class Reference

Inheritance diagram for BizField:
Inheritance graph
[legend]
Collaboration diagram for BizField:
Collaboration graph
[legend]

Public Member Functions

 __construct (&$xmlArr, $bizObj)
 getProperty ($propertyName)
 adjustBizObjName ($bizObjName)
 getSqlValue ($input=null)
 isLobField ()
 getInsertLobValue ($dbType)
 lookupValue ()
 getValue ($formatted=true)
 setValue ($value)
 saveOldValue ($oldValue=null)
 getDefaultValue ()
 getValueOnCreate ()
 getValueOnUpdate ()
 checkRequired ()
 checkValueType ($value=null)
 validate ()

Data Fields

 $m_BizObjName
 $m_Join = null
 $m_Column = null
 $m_Alias = null
 $m_Index
 $m_Type = null
 $m_Format = null
 $m_Length = null
 $m_ValueExpression = null
 $m_Required = null
 $m_Validator = null
 $m_SqlExpression = null
 $m_Encrypted = "N"
 $m_ClearText = null
 $m_DefaultValue = null
 $m_ValueOnCreate = null
 $m_ValueOnUpdate = null
 $m_OnAudit = false
 $m_Value = null
 $m_OldValue = null

Protected Member Functions

 useDefaultFormat ()
 getDataObj ()

Detailed Description

Definition at line 25 of file BizField.php.


Constructor & Destructor Documentation

__construct ( &$  xmlArr,
bizObj 
)

Initialize BizField with xml array

Parameters:
array$xmlArrxml array
BizDataObj$bizObjBizDataObj instance
Returns:
void

Definition at line 100 of file BizField.php.

Here is the call graph for this function:


Member Function Documentation

adjustBizObjName ( bizObjName )

Change the BizDataObj name. This function is used in case of the current BizDataObj inheriting from another BizDataObj, BizField's BizDataObj name should be changed to current BizDataObj name, not the parent object name.

Parameters:
string$bizObjNamethe name of BizDataObj object
Returns:
void

Definition at line 168 of file BizField.php.

checkRequired (  )

Check if the field is a required field

Returns:
boolean true if the field is a required field

Definition at line 340 of file BizField.php.

Here is the call graph for this function:

checkValueType ( value = null )

Check value type

Parameters:
mixed$value
Returns:
mixed|boolean

Definition at line 360 of file BizField.php.

Here is the call graph for this function:

getDataObj (  ) [protected]

Get the BizDataObj instance

Returns:
BizDataObj BizDataObj instance

Definition at line 330 of file BizField.php.

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultValue (  )

Get default value of the field

Returns:
string the default value of the field

Definition at line 294 of file BizField.php.

Here is the call graph for this function:

getInsertLobValue ( dbType )

Get insert lob value when execute insert SQL. For a lob column, insert SQL first inserts an empty entry in the lob column. Then use update to actually add the lob data.

Parameters:
string$dbTypedatabase type
Returns:
string the insert string for the lob column

Definition at line 217 of file BizField.php.

getProperty ( propertyName )

Get property value

Parameters:
string$propertyNameproperty name
Returns:
mixed property value

Reimplemented from MetaObject.

Definition at line 151 of file BizField.php.

Here is the call graph for this function:

getSqlValue ( input = null )

Get string used in sql - with single quote, or without single quote in case of number

Parameters:
mixed$inputthe value to add quote. If null, use the current field value
Returns:
string string used in sql

Definition at line 180 of file BizField.php.

Here is the caller graph for this function:

getValue ( formatted = true )

Get the value of the field.

Parameters:
boolean$formattedtrue if want to get the formatted value
Returns:
mixed string or number depending on the field type

Definition at line 245 of file BizField.php.

Here is the call graph for this function:

Here is the caller graph for this function:

getValueOnCreate (  )

Get the value when a new record is created

Returns:
mixed the value of the field

Definition at line 306 of file BizField.php.

Here is the call graph for this function:

getValueOnUpdate (  )

Get the value when a record is updated

Returns:
mixed the value of the field

Definition at line 318 of file BizField.php.

Here is the call graph for this function:

isLobField (  )

Check if the field is a LOB type column

Returns:
boolean true if the field points a LOB type column

Definition at line 205 of file BizField.php.

lookupValue (  )

Lookup the value of the field. Typically used in expression @:Field[name].Value

Parameters:
boolean$formattedtrue if want to get the formatted value
Returns:
mixed string or number depending on the field type

Definition at line 233 of file BizField.php.

Here is the call graph for this function:

Here is the caller graph for this function:

saveOldValue ( oldValue = null )

Save the old value to an internal variable

Parameters:
mixed$oldValue
Returns:
void

Definition at line 281 of file BizField.php.

setValue ( value )

Set the value of the field.

Parameters:
mixed$value
Returns:
void

Definition at line 270 of file BizField.php.

useDefaultFormat (  ) [protected]

Use default format if no format is given

Returns:
void

Definition at line 137 of file BizField.php.

Here is the caller graph for this function:

validate (  )

Check if the field has valid value

Returns:
boolean true if validation is good

Definition at line 406 of file BizField.php.

Here is the call graph for this function:


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