Class XCube_FieldProperty
Methods summary
public
|
#
XCube_FieldProperty( $form & $form )
Parameters
- $form
$form XCube_ActionForm - Parent form.
Brief
Constructor.
Public
Remarks
Only sub-classes of XCube_ActionForm calles this constructor.
|
public
|
#
setDependsByArray( $dependsArr $dependsArr )
Parameters
- $dependsArr
$dependsArr string[]
Brief
Initializes the validator list of this field property with the depend rule name
list.
Public
|
public
|
#
addMessage( $name $name, $message $message )
Parameters
- $name
$name string - Depend rule name.
- $message
$message string - Error message.
Returns
It's possible to add 3 or greater parameters. These additional parameters are
used by XCube_Utils::formatString(). \code $field->addMessage('required',
"{0:ucFirst} is requred.", "name"); \endcode This feature is helpful for
automatic ActionForm generators.
Brief
Adds an error message which will be used in the case which '$name rule'
validation is failed.
Public
|
public
string
|
#
renderMessage( $name $name )
Parameters
- $name
$name string - Depend rule name
Returns
string Gets the error message registered at addMessage(). If the message setting has
some arguments, messages are rendered by XCube_Utils::formatString(). \code
$field->addMessage('required', "{0:ucFirst} is requred.", "name"); // Gets
"Name is required." $field->renderMessage('required'); \endcode This feature
is helpful for automatic ActionForm generators.
Brief
Gets the error message rendered by XCube_Utils::formaString().
Public
|
public
|
#
addVar( $name $name, $value $value )
Parameters
- $name
$name string - A name of the variable.
- $value
$value mixed - A value of the variable. Virtual varialbes are used for validating by
validators. For example, XCube_MinlengthValidator needs a value indicationg a
minimum length. \code $field->addVar('minlength', 2); \endcode
Brief
Adds a virtual variable used by validators.
Public
|
public
|
#
validate( & $form )
Attention
Only XCube_ActionForm and its sub-classes should call this method.
Brief
Validates form-property with validators which this field property holds.
Public
|
Properties summary
public
|
$mForm
|
|
#
Brief
XCube_ActionForm - Parent form contains this field property.
Protected
|
public
|
$mDepends
|
|
#
Brief
XCube_Validator[] - std::map<string, XCube_Validator*>
Protected
|
public
|
$mMessages
|
|
#
Brief
Complex Array
Protected
Section
section1 Complex Array $mMessages[$name]['message'] - string \n
$mMessages[$name]['args'][] - string \code // Reference Define typedef
std::map<int, string> ArgumentMap; struct MessageStrage { string Message;
ArgumentMap args; }; typedef std::map<string, MessageStrage> MessageList;
MessageList mMessages; \endcode
|
public
|
$mVariables
|
|
#
Brief
Hash-Map Array - std::map<string, mixed>
Protected
|