Class FileMaker_Layout

Description
Description | Methods (details)

Layout description class. Contains all the information about a specific layout. Can be requested directly, or returned as part of a result set.

Located in /FileMaker/Layout.php (line 29) 


	
			






	
	

		
Method Summary

		

			Description |
									Methods (details)
		

		
			
			

								
				

											FileMaker_Layout
										FileMaker_Layout
											(FileMaker_Implementation &$fm)
									

								
				

											string
										getDatabase
										()
									

								
				

											FileMaker_Field|FileMaker_Error
										&getField
											(mixed $fieldName)
									

								
				

											array
										&getFields
										()
									

								
				

											string
										getName
										()
									

								
				

											FileMaker_RelatedSet|FileMaker_Error
										&getRelatedSet
											(mixed $relatedSet)
									

								
				

											array
										&getRelatedSets
										()
									

								
				

											array
										getValueList
											(mixed $valueList)
									

								
				

											array
										getValueLists
										()
									

								
				

											array
										listFields
										()
									

								
				

											array
										listRelatedSets
										()
									

								
				

											array
										listValueLists
										()
									

							

		

	
		

	
	
	

		
Methods

		

			Description |
													Methods (details)
						
		

		

			



	
	

		Constructor FileMaker_Layout (line 45)
	
 
	
	

Layout constructor.

	
	

		FileMaker_Layout
		
			FileMaker_Layout
		
					(FileMaker_Implementation &$fm)
			

	
			
    
					
  • 
				FileMaker_Implementation
				&$fm: The FileMaker_Implementation object this layout was created through.			
    • 
				

		
		
	




	
	

		getDatabase (line 65)
	
 
	
	

Return the name of the database this layout is in.

	
    
				
  • return: Database name.
    • 
			

	
	

		string
		
			getDatabase
		
				()
			

	
		
		
	




	
	

		getField (line 85)
	
 
	
	

Returns the FileMaker_Field object describing $fieldName.

	
    
				
  • return: Either a Field object or an error.
    • 
			

	
	

		FileMaker_Field|FileMaker_Error
		
			&getField
		
					(mixed $fieldName)
			

	
		
		
	




	
	

		getFields (line 97)
	
 
	
	

Return an associative array with the names of all fields as  keys, and the array values will be the associated  FileMaker_Field objects.

	
    
				
  • return: Array of FileMaker_Field objects.
    • 
			

	
	

		array
		
			&getFields
		
				()
			

	
		
		
	




	
	

		getName (line 55)
	
 
	
	

Returns the name of the layout this object describes.

	
    
				
  • return: Layout name.
    • 
			

	
	

		string
		
			getName
		
				()
			

	
		
		
	




	
	

		getRelatedSet (line 118)
	
 
	
	

Returns the FileMaker_RelatedSet object describing $relatedSet.

	
    
				
  • return: Either a RelatedSet object or an error.
    • 
			

	
	

		FileMaker_RelatedSet|FileMaker_Error
		
			&getRelatedSet
		
					(mixed $relatedSet)
			

	
		
		
	




	
	

		getRelatedSets (line 130)
	
 
	
	

Return an associative array with the names of all related sets  as keys, and the array values will be the associated  FileMaker_RelatedSet objects.

	
    
				
  • return: Array of FileMaker_RelatedSet objects.
    • 
			

	
	

		array
		
			&getRelatedSets
		
				()
			

	
		
		
	




	
	

		getValueList (line 151)
	
 
	
	

Return the list of options in the named value list.

	
    
				
  • return: List of options in $valueList.
    • 
			

	
	

		array
		
			getValueList
		
					(mixed $valueList)
			

	
		
		
	




	
	

		getValueLists (line 163)
	
 
	
	

Return a multi-level associative array. The top-level array has  names of value lists as keys and arrays as values. The second  level arrays are the lists of choices from each value list.

	
    
				
  • return: Array of value-list arrays.
    • 
			

	
	

		array
		
			getValueLists
		
				()
			

	
		
		
	




	
	

		listFields (line 75)
	
 
	
	

Return an array with the string names of all fields in this layout.

	
    
				
  • return: Simple list of string field names.
    • 
			

	
	

		array
		
			listFields
		
				()
			

	
		
		
	




	
	

		listRelatedSets (line 108)
	
 
	
	

Return an array with the string names of all related sets in  this layout.

	
    
				
  • return: Simple list of string related set names.
    • 
			

	
	

		array
		
			listRelatedSets
		
				()
			

	
		
		
	




	
	

		listValueLists (line 141)
	
 
	
	

Return the names of any value lists associated with this  layout.

	
    
				
  • return: Simple list of string value list names.
    • 
			

	
	

		array
		
			listValueLists
		
				()
			

	
		
		
	

						
		

	

	
	

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