Class FOFConfigDomainViews

Description
Description | Methods (details)

Implements interfaces:

Configuration parser for the view-specific settings

  • since: 2.1

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


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

																																																															
				

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

															
				

					 
											string
										getAcl
											(string $view, array &$configuration, array $params, [string $default = ''])
									

															
				

					 
											string
										getConfig
											(string $view, array &$configuration, array $params, [mixed $default = null])
									

															
				

					 
											array
										getTaskmap
											(string $view, array &$configuration, array $params, [array $default = array()])
									

															
				

					 
											string
										getToolbar
											(string $view, array &$configuration, array $params, [string $default = ''])
									

															
				

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

											

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			



	
	

		
		get (line 126)
	
 
	
	

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

					

			
	




	
	

		
		getAcl (line 189)
	
 
	
	

Internal method to return the ACL mapping (privilege required to access  a specific task) for the given view's tasks

	
    
				
  • return: The privilege required to access this view
    • 
				
  • access: protected
    • 
			

	
	

		string
		
			getAcl
		
					(string $view, array &$configuration, array $params, [string $default = ''])
			

	
			
    
					
  • 
				string
				$view: The view for which we will be fetching a task map			
    • 
					
  • 
				array
				&$configuration: The configuration parameters hash array			
    • 
					
  • 
				array
				$params: Extra options; key 0 defines the task we want to fetch			
    • 
					
  • 
				string
				$default: Default ACL option; empty (no ACL check) if not defined			
    • 
				

		
			
	




	
	

		
		getConfig (line 229)
	
 
	
	

Internal method to return the a configuration option for the view. These  are equivalent to $config array options passed to the Controller

	
    
				
  • return: The setting for the requested option
    • 
				
  • access: protected
    • 
			

	
	

		string
		
			getConfig
		
					(string $view, array &$configuration, array $params, [mixed $default = null])
			

	
			
    
					
  • 
				string
				$view: The view for which we will be fetching a task map			
    • 
					
  • 
				array
				&$configuration: The configuration parameters hash array			
    • 
					
  • 
				array
				$params: Extra options; key 0 defines the option variable we want to fetch			
    • 
					
  • 
				mixed
				$default: Default option; null if not defined			
    • 
				

		
			
	




	
	

		
		getTaskmap (line 156)
	
 
	
	

Internal function to return the task map for a view

	
    
				
  • return: The task map as a hash array in the format task => method
    • 
				
  • access: protected
    • 
			

	
	

		array
		
			getTaskmap
		
					(string $view, array &$configuration, array $params, [array $default = array()])
			

	
			
    
					
  • 
				string
				$view: The view for which we will be fetching a task map			
    • 
					
  • 
				array
				&$configuration: The configuration parameters hash array			
    • 
					
  • 
				array
				$params: Extra options (not used)			
    • 
					
  • 
				array
				$default: ßDefault task map; empty array if not provided			
    • 
				

		
			
	




	
	

		
		getToolbar (line 260)
	
 
	
	

Internal method to return the toolbar infos.

	
    
				
  • return: The toolbar data for this view
    • 
				
  • access: protected
    • 
			

	
	

		string
		
			getToolbar
		
					(string $view, array &$configuration, array $params, [string $default = ''])
			

	
			
    
					
  • 
				string
				$view: The view for which we will be fetching buttons			
    • 
					
  • 
				array
				&$configuration: The configuration parameters hash array			
    • 
					
  • 
				array
				$params: Extra options			
    • 
					
  • 
				string
				$default: Default option			
    • 
				

		
			
	




	
	

		
		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:18:18 +0100 by phpDocumentor 1.4.3