Class FileMaker_Field

Description
Description | Methods (details)

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

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


	
			






	
	

		
Method Summary

		

			Description |
									Methods (details)
		

		
			
			

								
				

											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
										()
									

								
				

											boolean
										hasValidationRule
											(integer $validationRule)
									

								
				

											boolean
										isAutoEntered
										()
									

								
				

											boolean
										isGlobal
										()
									

								
				

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

							

		

	
		

	
	
	

		
Methods

		

			Description |
													Methods (details)
						
		

		

			



	
	

		Constructor FileMaker_Field (line 43)
	
 
	
	

Field Constructor.

	
	

		FileMaker_Field
		
			FileMaker_Field
		
					(FileMaker_Layout &$layout)
			

	
			
		
		
	




	
	

		describeLocalValidationRules (line 192)
	
 
	
	

Return an array of arrays containing the extra information for


all validation rules on this field that can be evaluated by  PHP. Rules such as "unique" and "exists" can only be validated  on the server and are not included in this list. Indexes of the  outer array are validation constants, and values are the same  array returned by describeValidationRule().

	
    
				
  • return: An associative array of all extra validation info,                with rule constants as keys and extra info as the                values.
    • 
			

	
	

		array
		
			describeLocalValidationRules
		
				()
			

	
		
		
	




	
	

		describeValidationRule (line 175)
	
 
	
	

Returns any additional information for a given rule. Used for  range rules and other rules that have additional validation  parameters.

	
    
				
  • return: Any extra information for $validationRule.
    • 
			

	
	

		array
		
			describeValidationRule
		
					(integer $validationRule)
			

	
			
    
					
  • 
				integer
				$validationRule: The validation rule constant to get info for.			
    • 
				

		
		
	




	
	

		describeValidationRules (line 204)
	
 
	
	

Returns all additional information for all validation rules.

	
    
				
  • return: An associative array of all extra validation info,                with rule constants as keys and extra info as the                values.
    • 
			

	
	

		array
		
			describeValidationRules
		
				()
			

	
		
		
	




	
	

		getLayout (line 63)
	
 
	
	

Return the FileMaker_Layout object that contains this field.

	
    
				
  • return: Layout object.
    • 
			

	
	

		FileMaker_Layout
		
			&getLayout
		
				()
			

	
		
		
	




	
	

		getLocalValidationRules (line 126)
	
 
	
	

Returns an array of FILEMAKER_RULE_* constants for each rule  set on this field that can be evaluated by PHP. Rules such as  "unique" and "exists" can only be validated on the server and  are not included in this list.

	
    
				
  • return: Local rule array.
    • 
			

	
	

		array
		
			getLocalValidationRules
		
				()
			

	
		
		
	




	
	

		getName (line 53)
	
 
	
	

Return the name of this field.

	
    
				
  • return: Field name.
    • 
			

	
	

		string
		
			getName
		
				()
			

	
		
		
	




	
	

		getRepetitionCount (line 94)
	
 
	
	

Return the maximum number of repetitions for this field.

	
    
				
  • return: Maximum repetitions of this field.
    • 
			

	
	

		integer
		
			getRepetitionCount
		
				()
			

	
		
		
	




	
	

		getResult (line 215)
	
 
	
	

Get the result type of this field - for example, 'text' or  'number'.

	
    
				
  • return: Result type.
    • 
			

	
	

		string
		
			getResult
		
				()
			

	
		
		
	




	
	

		getStyleType (line 249)
	
 
	
	

Loads FMPXMLLAYOUT data. Returns the type of this field - for  example, 'EDITTEXT'.

	
    
				
  • return: Style type.
    • 
			

	
	

		string
		
			getStyleType
		
				()
			

	
		
		
	




	
	

		getType (line 226)
	
 
	
	

Returns the type of this field. Examples: 'normal',  'calculation'.

	
    
				
  • return: Type.
    • 
			

	
	

		string
		
			getType
		
				()
			

	
		
		
	




	
	

		getValidationMask (line 148)
	
 
	
	

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

	
    
				
  • return: Rule bitmask.
    • 
			

	
	

		integer
		
			getValidationMask
		
				()
			

	
		
		
	




	
	

		getValidationRules (line 137)
	
 
	
	

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

	
    
				
  • return: Rule array.
    • 
			

	
	

		array
		
			getValidationRules
		
				()
			

	
		
		
	




	
	

		getValueList (line 238)
	
 
	
	

Loads FMPXMLLAYOUT data. If this field is associated with a  value list, return the list of choices in that value  list. Otherwise returns NULL.

	
    
				
  • return: The value list array.
    • 
			

	
	

		array
		
			getValueList
		
				()
			

	
		
		
	




	
	

		hasValidationRule (line 161)
	
 
	
	

Returns TRUE if the given FILEMAKER_RULE_* constant matches the  field's validation bitmask, FALSE otherwise.

	
	

		boolean
		
			hasValidationRule
		
					(integer $validationRule)
			

	
			
    
					
  • 
				integer
				$validationRule: The validation rule constant to test presence of.			
    • 
				

		
		
	




	
	

		isAutoEntered (line 74)
	
 
	
	

Return TRUE if this field is auto-entered and FALSE if it is  set manually.

	
    
				
  • return: Auto-entered status of this field.
    • 
			

	
	

		boolean
		
			isAutoEntered
		
				()
			

	
		
		
	




	
	

		isGlobal (line 84)
	
 
	
	

Return TRUE if this field is global and FALSE if it is not.

	
    
				
  • return: Global status of this field.
    • 
			

	
	

		boolean
		
			isGlobal
		
				()
			

	
		
		
	




	
	

		validate (line 113)
	
 
	
	

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

	
    
				
  • return: Result of field validation on $value.
    • 
			

	
	

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

	
			
    
					
  • 
				mixed
				$value: Value to validate.			
    • 
					
  • 
				FileMaker_Error_Validation
				$error: If validation is being done on more than  one field, you may pass an existing error object to validate() to be added 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. An existing $error object will  never be overwritten with boolean true.			
    • 
				

		
		
	

						
		

	

	
	

		Documentation generated on Thu, 06 Jul 2006 15:52:28 -0700 by phpDocumentor 1.2.3