Class AuthorizationACL

Description
Description | Vars (details) | Methods (details)

A ACL

A list of ACL entries for a specific user. Can be cached.

Located in /phpsatk-lib/global/org.eenterphace.sat.authorization/authorization.acl.php (line 35) 


	
			






	
	

		
Variable Summary

		

			Description |
						Vars (details)
							| 
									Methods (details)
							
								

		

			

								

					int
					$version
				

							

		

	


	
	

		
Method Summary

		

			Description |
																		Vars (details)
				 
				|
						Methods (details)
		

		
			
			

								
				

											void
										fetchByRoles
											(array $roles, int $uid)
									

								
				

											void
										fetchByUser
											(AuthorizationUser $user)
									

								
				

											array[string=>array[ACLEntry]]
										getEntries
										()
									

								
				

											ACLEntry
										getEntriesByType
											(string $type)
									

								
				

											array[int=>int]
										resolveInheritedRoles
											(array[int] $roles)
									

							

		

	
		

	
	

		
Variables

		

			Description |
										Vars (details)
						
			
										| 
									Methods (details)
							
					

		

			



	

		
			int
			$version
						(line 44)
		
	


	

ACL version


Used to force rebuilding when something has changed.

	
    
				
  • access: public
    • 
			

	
	
		
		




						
		

	

	
	
	

		
Methods

		

			Description |
															Vars (details)
																	Methods (details)
						
		

		

			



	
	

		fetchByRoles (line 72)
	
 
	
	

Fetches ACLs for a given list of roles and a uid


All roles will be resolved using the given primary roles  (roles which the user is assigned to).  Data is fetched from the acl table of auth.rdbms.db.

	
    
				
  • access: public
    • 
			

	
	

		void
		
			fetchByRoles
		
					(array $roles, int $uid)
			

	
			
    
					
  • 
				array
				$roles: List of primary roles			
    • 
					
  • 
				int
				$uid: UID			
    • 
				

		
		
	




	
	

		fetchByUser (line 58)
	
 
	
	

Fetches the ACL for the given user

	
    
				
  • access: public
    • 
			

	
	

		void
		
			fetchByUser
		
					(AuthorizationUser $user)
			

	
			
		
		
	




	
	

		getEntries (line 157)
	
 
	
	

Gets all entries of this acl


Will return a two-dimensional array where in the first level the  keys are the acl entry types.

	
    
				
  • access: public
    • 
			

	
	

		array[string=>array[ACLEntry]]
		
			getEntries
		
				()
			

	
		
		
	




	
	

		getEntriesByType (line 167)
	
 
	
	

Gets all entries of a given type from this acl

	
    
				
  • access: public
    • 
			

	
	

		ACLEntry
		
			getEntriesByType
		
					(string $type)
			

	
			
    
					
  • 
				string
				$type: ACLEntry type			
    • 
				

		
		
	




	
	

		resolveInheritedRoles (line 121)
	
 
	
	

Resolves all inherited roles for a given list of primary roles


An array of "roleid => distance to the primary role", including  the given primary roles will be returned.

	
    
				
  • access: public
    • 
			

	
	

		array[int=>int]
		
			resolveInheritedRoles
		
					(array[int] $roles)
			

	
			
    
					
  • 
				array[int]
				$roles: Primary Roles			
    • 
				

		
		
	

						
		

	



	

		Documentation generated on Mon, 21 May 2007 10:34:44 +0200 by phpDocumentor 1.3.0RC5