Class Bitmask

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

Class to wrap around bitmap field functionality

Located in /system/classes/bitmask.php (line 5) 


	
			






	
	

		
Variable Summary

		

			Description |
						Vars (details)
							| 
									Methods (details)
							
								

		

			

																								

					mixed
					$flags
				

											

		

	


	
	

		
Method Summary

		

			Description |
																		Vars (details)
				 
				|
						Methods (details)
		

		
			
			

																												
												

											Bitmask
										__construct
											((optional) 0)
									

																

											boolean
										__get
											(bit $bit)
									

																

											void
										__set
											(bit $bit, on $on)
									

								

		

	
		

	
	

		
Variables

		

			Description |
										Vars (details)
						
			
										| 
									Methods (details)
							
					

		

			



	

		
			mixed
			$flags
			 = array()			(line 6)
		
	


	
	
    
				
  • access: public
    • 
			

	
	
		
		




						
		

	

	
	
	

		
Methods

		

			Description |
															Vars (details)
																	Methods (details)
						
		

		

			




	
	

		Constructor __construct (line 15)
	
 
	
	

Constructor.  Takes an optional array parameter  of bit flags to mask on.

	
    
				
  • access: public
    • 
			

	
	

		Bitmask
		
			__construct
		
					((optional) 0)
			

	
			
    
					
  • 
				(optional)
				0: an array of integer flags			
    • 
				

		
			
	




	
	

		__get (line 50)
	
 
	
	

Magic getter method for flag status

	
    
				
  • access: public
    • 
			

	
	

		boolean
		
			__get
		
					(bit $bit)
			

	
			
    
					
  • 
				bit
				$bit: integer representing th emask bit to test			
    • 
				

		
			
	




	
	

		__set (line 29)
	
 
	
	

Magic setter method for flag values.

	
    
				
  • access: public
    • 
			

	
	

		void
		
			__set
		
					(bit $bit, on $on)
			

	
			
    
					
  • 
				bit
				$bit: integer representing the mask bit			
    • 
					
  • 
				on
				$on: on or off?			
    • 
				

		
			
	

						
		

	



	

		Documentation generated on Thu, 30 Oct 2008 20:31:02 +0100 by phpDocumentor 1.3.2