Class Shift8_Event

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

Generic Shift8 Event. Class is being instanciated and fed all the informations retrieved from a Asterisk Manager event

  • author: Paris Stamatopoulos
  • version: 0.1.1
  • usedby: Shift8

Located in /Event/Event.php (line 28) 


	
			






	
	

		
Variable Summary

		

			Description |
						Vars (details)
							| 
									Methods (details)
							
								

		

			

																								

					array
					$variables
				

											

		

	


	
	

		
Method Summary

		

			Description |
																		Vars (details)
				 
				|
						Methods (details)
		

		
			
			

																																																				
												

											string
										get
											(string $variable)
									

																

											array
										getVariables
										()
									

																

											boolean
										set
											(string $variable, string $value)
									

																

											void
										setVariables
											(array $variables)
									

																

											string
										__get
											(string $variable)
									

																

											boolean
										__set
											(string $variable, string $value)
									

								

		

	
		

	
	

		
Variables

		

			Description |
										Vars (details)
						
			
										| 
									Methods (details)
							
					

		

			



	

		
			array
			$variables
						(line 35)
		
	


	

Normally this should have been specified as private/protected, however it has been declared public to be  viewed via Soap requests

	
    
				
  • access: public
    • 
			

	
	
		
		



						
		

	

	
	
	

		
Methods

		

			Description |
															Vars (details)
																	Methods (details)
						
		

		

			




	
	

		get (line 62)
	
 
	
	

Generic getter function to retrieve a specific variable. If the variable  is not set, boolean false will be returned

	
    
				
  • return: or null if nothing was found
    • 
				
  • access: public
    • 
			

	
	

		string
		
			get
		
					(string $variable)
			

	
			
    
					
  • 
				string
				$variable: The variable name retrieved for the event			
    • 
				

		
			
	




	
	

		getVariables (line 97)
	
 
	
	

Returns all the variables stored in the Event as an associative array

	
    
				
  • access: public
    • 
			

	
	

		array
		
			getVariables
		
				()
			

	
		
			
	




	
	

		set (line 46)
	
 
	
	

Generic setter function to retrieve all the variables from the  asterisk event. In case of duplicate the later will be ignored

	
    
				
  • access: public
    • 
			

	
	

		boolean
		
			set
		
					(string $variable, string $value)
			

	
			
    
					
  • 
				string
				$variable: The variable name retrieved for the event			
    • 
					
  • 
				string
				$value: The value that this variable has			
    • 
				

		
			
	




	
	

		setVariables (line 108)
	
 
	
	

Sets the internal variables array.

	
    
				
  • access: public
    • 
			

	
	

		void
		
			setVariables
		
					(array $variables)
			

	
			
    
					
  • 
				array
				$variables: The variables to set to this object			
    • 
				

		
			
	




	
	

		__get (line 76)
	
 
	
	

Class overloading to retrieve the event parameters directly

	
    
				
  • access: public
    • 
			

	
	

		string
		
			__get
		
					(string $variable)
			

	
			
    
					
  • 
				string
				$variable			
    • 
				

		
			
	




	
	

		__set (line 88)
	
 
	
	

Class overloading to set a variable directly into the object

	
    
				
  • access: public
    • 
			

	
	

		boolean
		
			__set
		
					(string $variable, string $value)
			

	
			
    
					
  • 
				string
				$variable			
    • 
					
  • 
				string
				$value			
    • 
				

		
			
	

						
		

	



	

		Documentation generated on Mon, 28 Dec 2009 17:42:49 +0200 by phpDocumentor 1.4.3