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


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

																																																																																																				
												

											FileMaker_Layout
										FileMaker_Layout
											(FileMaker_Implementation &$fm)
									

																

											string
										getDatabase
										()
									

																

											FileMaker_Field|FileMaker_Error
										&getField
											(string $fieldName)
									

																

											array
										&getFields
										()
									

																

											string
										getName
										()
									

																

											FileMaker_RelatedSet|FileMaker_Error
										&getRelatedSet
											(string $relatedSet)
									

																

											array
										&getRelatedSets
										()
									

																

											array
										getValueList
											(string $valueList, [integer $recid = null])
									

																

											array
										getValueLists
											([integer $recid = null])
									

																

											array
										listFields
										()
									

																

											array
										listRelatedSets
										()
									

																

											array
										listValueLists
										()
									

								

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			




	
	

		Constructor FileMaker_Layout (line 47)
	
 
	
	

Layout object constructor.

	
	

		FileMaker_Layout
		
			FileMaker_Layout
		
					(FileMaker_Implementation &$fm)
			

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

		
			
	




	
	

		getDatabase (line 67)
	
 
	
	

Returns the name of the database that this layout is in.

	
    
				
  • return: Database name.
    • 
			

	
	

		string
		
			getDatabase
		
				()
			

	
		
			
	




	
	

		getField (line 90)
	
 
	
	

Returns a FileMaker_Field object that describes the specified field.

	
    
				
  • return: Field object, if successful.          Otherwise, an Error object.
    • 
			

	
	

		FileMaker_Field|FileMaker_Error
		
			&getField
		
					(string $fieldName)
			

	
			
    
					
  • 
				string
				$fieldName: Name of field.			
    • 
				

		
			
	




	
	

		getFields (line 101)
	
 
	
	

Returns an associative array with the names of all fields as  keys and FileMaker_Field objects as the array values.

	
	
	

		array
		
			&getFields
		
				()
			

	
		
			
	




	
	

		getName (line 57)
	
 
	
	

Returns the name of this layout.

	
    
				
  • return: Layout name.
    • 
			

	
	

		string
		
			getName
		
				()
			

	
		
			
	




	
	

		getRelatedSet (line 126)
	
 
	
	

Returns a FileMaker_RelatedSet object that describes the specified  portal.

	
    
				
  • return: RelatedSet object, if          successful. Otherwise, an Error object.
    • 
			

	
	

		FileMaker_RelatedSet|FileMaker_Error
		
			&getRelatedSet
		
					(string $relatedSet)
			

	
			
    
					
  • 
				string
				$relatedSet: Name of the related table for a portal.			
    • 
				

		
			
	




	
	

		getRelatedSets (line 137)
	
 
	
	

Returns an associative array with the related table names of all  portals as keys and FileMaker_RelatedSet objects as the array values.

	
	
	

		array
		
			&getRelatedSets
		
				()
			

	
		
			
	




	
	

		getValueList (line 162)
	
 
	
	

Returns the list of defined values in the specified value list.

	
    
				
  • return: List of defined values.
    • 
			

	
	

		array
		
			getValueList
		
					(string $valueList, [integer $recid = null])
			

	
			
    
					
  • 
				string
				$valueList: Name of value list.			
    • 
					
  • 
				integer
				$recid: Record from which the value list should be         displayed.			
    • 
				

		
			
	




	
	

		getValueLists (line 179)
	
 
	
	

Returns a multi-level associative array of value lists.


The top-level array has names of value lists as keys and arrays as  values. The second level arrays are the lists of defined values from  each value list.

	
    
				
  • return: Array of value-list arrays.
    • 
			

	
	

		array
		
			getValueLists
		
					([integer $recid = null])
			

	
			
    
					
  • 
				integer
				$recid: Record from which the value list should be         displayed.			
    • 
				

		
			
	




	
	

		listFields (line 77)
	
 
	
	

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

	
    
				
  • return: List of field names as strings.
    • 
			

	
	

		array
		
			listFields
		
				()
			

	
		
			
	




	
	

		listRelatedSets (line 112)
	
 
	
	

Returns an array of related table names for all portals on  this layout.

	
    
				
  • return: List of related table names as strings.
    • 
			

	
	

		array
		
			listRelatedSets
		
				()
			

	
		
			
	




	
	

		listValueLists (line 148)
	
 
	
	

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

	
    
				
  • return: List of value list names as strings.
    • 
			

	
	

		array
		
			listValueLists
		
				()
			

	
		
			
	

						
		

	



	

		Documentation generated on Tue, 22 May 2007 13:39:07 -0700 by phpDocumentor 1.3.1