Class FOFConfigDomainTables

Description
Description | Methods (details)

Implements interfaces:

Configuration parser for the tables-specific settings

  • since: 2.1

Located in /libraries/fof/config/domain/tables.php (line 17) 


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

																																																							
				

					 
											mixed
										get
											(string &$configuration, string $var, mixed $default)
									

															
				

					 
											string
										getBehaviors
											(string $table, array &$configuration, array $params, [string $default = ''])
									

															
				

					 
											array
										getField
											(string $table, array &$configuration, array $params, [string $default = ''])
									

															
				

					 
											string
										getTablealias
											(string $table, array &$configuration, array $params, [string $default = ''])
									

															
				

					 
											void
										parseDomain
											(SimpleXMLElement $xml, array &$ret)
									

											

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			



	
	

		
		get (line 70)
	
 
	
	

Return a configuration variable

	
    
				
  • return: The variable's value
    • 
				
  • access: public
    • 
			

	
	

		mixed
		
			get
		
					(string &$configuration, string $var, mixed $default)
			

	
			
    
					
  • 
				string
				&$configuration: Configuration variables (hashed array)			
    • 
					
  • 
				string
				$var: The variable we want to fetch			
    • 
					
  • 
				mixed
				$default: Default value			
    • 
				

		
				

		
Implementation of:

			

			
FOFConfigDomainInterface::get()

						
Return a configuration variable

					

			
	




	
	

		
		getBehaviors (line 169)
	
 
	
	

Internal method to get table alias

	
    
				
  • return: Table alias
    • 
				
  • access: protected
    • 
			

	
	

		string
		
			getBehaviors
		
					(string $table, array &$configuration, array $params, [string $default = ''])
			

	
			
    
					
  • 
				string
				$table: The table for which we will be fetching table alias			
    • 
					
  • 
				array
				&$configuration: The configuration parameters hash array			
    • 
					
  • 
				array
				$params: Extra options; key 0 defines the table we want to fetch			
    • 
					
  • 
				string
				$default: Default table alias			
    • 
				

		
			
	




	
	

		
		getField (line 100)
	
 
	
	

Internal method to return the magic field mapping

	
    
				
  • return: Field map
    • 
				
  • access: protected
    • 
			

	
	

		array
		
			getField
		
					(string $table, array &$configuration, array $params, [string $default = ''])
			

	
			
    
					
  • 
				string
				$table: The table for which we will be fetching a field map			
    • 
					
  • 
				array
				&$configuration: The configuration parameters hash array			
    • 
					
  • 
				array
				$params: Extra options; key 0 defines the table we want to fetch			
    • 
					
  • 
				string
				$default: Default magic field mapping; empty if not defined			
    • 
				

		
			
	




	
	

		
		getTablealias (line 138)
	
 
	
	

Internal method to get table alias

	
    
				
  • return: Table alias
    • 
				
  • access: protected
    • 
			

	
	

		string
		
			getTablealias
		
					(string $table, array &$configuration, array $params, [string $default = ''])
			

	
			
    
					
  • 
				string
				$table: The table for which we will be fetching table alias			
    • 
					
  • 
				array
				&$configuration: The configuration parameters hash array			
    • 
					
  • 
				array
				$params: Extra options; key 0 defines the table we want to fetch			
    • 
					
  • 
				string
				$default: Default table alias			
    • 
				

		
			
	




	
	

		
		parseDomain (line 27)
	
 
	
	

Parse the XML data, adding them to the $ret array

	
    
				
  • access: public
    • 
			

	
	

		void
		
			parseDomain
		
					(SimpleXMLElement $xml, array &$ret)
			

	
			
    
					
  • 
				SimpleXMLElement
				$xml: The XML data of the component's configuration area			
    • 
					
  • 
				array
				&$ret: The parsed data, in the form of a hash array			
    • 
				

		
				

		
Implementation of:

			

			
FOFConfigDomainInterface::parseDomain()

						
Parse the XML data, adding them to the $ret array

					

			
	

						
		

	


	
	

		Documentation generated on Tue, 19 Nov 2013 15:15:03 +0100 by phpDocumentor 1.4.3