# Docs For Class FileMaker_Field

## Class FileMaker_Field

Description

Field description class. Contains all the information about a specific field on a layout.

Located in /FileMaker/Field.php (line 28)

Method Summary
FileMaker_Field FileMaker_Field (FileMaker_Layout &$layout)
array describeLocalValidationRules ()
array describeValidationRule (integer $validationRule)
array describeValidationRules ()
FileMaker_Layout &getLayout ()
array getLocalValidationRules ()
string getName ()
integer getRepetitionCount ()
string getResult ()
string getStyleType ()
string getType ()
integer getValidationMask ()
array getValidationRules ()
array getValueList ([string $recid = null])
boolean hasValidationRule (integer $validationRule)
boolean isAutoEntered ()
boolean isGlobal ()
boolean|FileMaker_Error_Validation validate (mixed $value, [FileMaker_Error_Validation $error = null])
Methods
Constructor FileMaker_Field (line 44)

Field object constructor.

FileMaker_Field FileMaker_Field (FileMaker_Layout &$layout)

- FileMaker_Layout &$layout: Parent Layout object.

describeLocalValidationRules (line 201)

Return an array of arrays containing the extra information for all pre-validation rules on this field that can be evaluated by the PHP engine.

Rules such as "unique" and "exists" can be validated only on the Database Server and are not included in this list. Indexes of the outer array are FILEMAKER_RULE_* constants, and values are the same array returned by describeValidationRule().

- return: An associative array of all extra pre-validation information, with rule constants as indexes and extra information as the values.

array describeLocalValidationRules ()
describeValidationRule (line 182)

Returns any additional information for the specified pre-validation rule.

Used for range rules and other rules that have additional pre-validation parameters.

- return: Any extra information for $validationRule.

array describeValidationRule (integer $validationRule)

- integer $validationRule: FILEMAKER_RULE_* constant to get information for.

describeValidationRules (line 213)

Returns any additional information for all pre-validation rules.

- return: An associative array of all extra pre-validation information, with FILEMAKER_RULE_* constants as keys and extra information as the values.

array describeValidationRules ()
getLayout (line 64)

Returns the FileMaker_Layout object that contains this field.

- return: Layout object.

FileMaker_Layout &getLayout ()
getLocalValidationRules (line 130)

Returns an array of FILEMAKER_RULE_* constants for each rule set on this field that can be evaluated by the PHP engine.

Rules such as "unique" and "exists" can only be pre-validated on the Database Server and are not included in this list.

- return: Local rule array.

array getLocalValidationRules ()
getName (line 54)

Returns the name of this field.

- return: Field name.

string getName ()
getRepetitionCount (line 95)

Returns the maximum number of repetitions for this field.

- return: Maximum repetitions of this field.

integer getRepetitionCount ()
getResult (line 224)

Returns the result type of this field -- for example, 'text', 'number', 'date', 'time', 'timestamp', or 'container'.

- return: Result type.

string getResult ()
getStyleType (line 263)

Returns the control style type of this field -- for example, 'EDITTEXT', 'POPUPLIST', 'POPUPMENU', 'CHECKBOX', 'RADIOBUTTONS' or 'CALENDAR'.

- return: Style type.

string getStyleType ()
getType (line 235)

Returns the type of this field -- for example, 'normal', 'calculation', or 'summary'.

- return: Type.

string getType ()
getValidationMask (line 152)

Returns the full additive bitmask of pre-validation rules for this field.

- return: Rule bitmask.

integer getValidationMask ()
getValidationRules (line 141)

Returns an array of FILEMAKER_RULE_* constants for each rule set on this field.

- return: Rule array.

array getValidationRules ()
getValueList (line 251)

Returns the list of choices from the value list associated with this field.

If this field is not associated with a value list, this method returns NULL.

- return: Value list array.

array getValueList ([string $recid = null])

- string $recid: Record from which to display the value list.

hasValidationRule (line 165)

Returns TRUE if the specified FILEMAKER_RULE_* constant matches the field's pre-validation bitmask. Otherwise, returns FALSE.

boolean hasValidationRule (integer $validationRule)

- integer $validationRule: Pre-validation rule constant to test.

isAutoEntered (line 75)

Returns TRUE if data in this field is auto-entered or FALSE if it is entered manually.

- return: Auto-entered status of this field.

boolean isAutoEntered ()
isGlobal (line 85)

Returns TRUE if this field is global or FALSE if it is not.

- return: Global status of this field.

boolean isGlobal ()
validate (line 116)

Returns TRUE if $value is valid for this field, or a FileMaker_Error_Validation object describing how pre-validation failed.

- return: Result of field pre-validation on $value.

boolean|FileMaker_Error_Validation validate (mixed $value, [FileMaker_Error_Validation $error = null])

- mixed $value: Value to pre-validate.
- FileMaker_Error_Validation $error: If pre-validation is being done on more than one field, you may pass validate() an existing error object to add pre-validation failures to.$error is not passed by reference, though, so you must catch the return value of validate() and use it as the new $error object. This method never overwrites an existing $error object with boolean TRUE.

Documentation generated on Mon, 28 Jul 2008 14:47:44 -0700 by phpDocumentor 1.4.0