Class Preferences

Description
Description | Methods (details)
  • abstract: Manages user preferences

Located in /preferences/Preferences.php (line 15) 


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

																																				
												

											Preferences
										__construct
										()
									

																

											void
										addSort
											([string $location = false], [string $field = false], [string $dir = 'ASC'])
									

																

											array
										getSort
											(string $location, [string $field = false], [string $default = 'id'], [string $dir = 'ASC'])
									

																

											void
										loadUserPreferences
										()
									

								

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			




	
	

		Constructor __construct (line 28)
	
 
	
	
	
    
				
  • abstract: Constructor
    • 
				
  • access: public
    • 
			

	
	

		Preferences
		
			__construct
		
				()
			

	
		
			
	




	
	

		addSort (line 68)
	
 
	
	
	
    
				
  • abstract: Adds a new sort preference
    • 
				
  • access: public
    • 
			

	
	

		void
		
			addSort
		
					([string $location = false], [string $field = false], [string $dir = 'ASC'])
			

	
			
    
					
  • 
				string
				$location			
    • 
					
  • 
				string
				$field			
    • 
					
  • 
				string
				$dir			
    • 
				

		
			
	




	
	

		getSort (line 99)
	
 
	
	
	
    
				
  • abstract: Returns a sort preference
    • 
				
  • access: public
    • 
			

	
	

		array
		
			getSort
		
					(string $location, [string $field = false], [string $default = 'id'], [string $dir = 'ASC'])
			

	
			
    
					
  • 
				string
				$location			
    • 
					
  • 
				string
				$field			
    • 
					
  • 
				string
				$default			
    • 
					
  • 
				string
				$dir			
    • 
				

		
			
	




	
	

		loadUserPreferences (line 35)
	
 
	
	
	
    
				
  • abstract: Loads user preferences into their session
    • 
				
  • access: public
    • 
			

	
	

		void
		
			loadUserPreferences
		
				()
			

	
		
			
	

						
		

	



	

		Documentation generated on Wed, 15 Apr 2009 17:03:40 -0700 by phpDocumentor 1.4.1