Gumbo_Interface_Router





	
Router Interface
	
A Router is simply a class that changes the current location of the browser  to the specified URL.  In order to jump, the object must be active.  The Delay  is meant to hold from the jump for a given amount of time (in seconds).  The  Flush option will flush the buffer before routing.







	
	
	

	
	
	
	
	
															
																
																
																
				
			
Author(s):
												Michael Luster <mluster79@yahoo.com>

																																					

		
			
License:New BSD License

		
			
Copyright:Copyright (c) 2007, iBayou, Michael Luster

		
			
Link:http://sourceforge.net/projects/phpgumbo

		
			
Version:0.0.1

		











	


	




	
	
Interface Methods

	


	
	
	

		

			public void activate (  )
			[line 51]
		

		
		
Activates the Router
		
				
					
    
											
  • postcondition:  isActive()
    • 
										

				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void deactivate (  )
			[line 57]
		

		
		
Deactivates the Router
		
				
					
    
											
  • postcondition:  !isActive()
    • 
										

				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public int getDelay (  )
			[line 95]
		

		
		
Returns the delay time, in seconds
		
				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public bool getFlush (  )
			[line 101]
		

		
		
Returns if the buffer should be flushed
		
				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public string getUrl (  )
			[line 89]
		

		
		
Returns the Url
		
				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void go (  )
			[line 45]
		

		
		
Jumps to the supplied URL
		
				
					
    
											
  • precondition:  isActive ()
    • 
										

				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public bool isActive (  )
			[line 107]
		

		
		
Returns if the Router is active
		
				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void setDelay ( int $delay )
			[line 74]
		

		
		
Sets the delay time, in seconds, before routing
		
					
Parameter(s):

			
    
							
  • 
				(int) $delay
								
    • 
						

			

				
					
    
											
  • precondition:  0 <= delay <= 30
    • 
										

				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void setFlush ( bool $val )
			[line 80]
		

		
		
Sets the program to flush the buffer before routing
		
					
Parameter(s):

			
    
							
  • 
				(bool) $val
								
    • 
						

			

				
				
				
		
				
		

		[ Top ]
	

	
	
	
	

		

			public void setUrl ( string $url )
			[line 67]
		

		
		
Sets the URL to jump to
		
					
Parameter(s):

			
    
							
  • 
				(string) $url
								
    • 
						

			

				
					
    
											
  • precondition:  Valid_Web::isUrl ()
    • 
										

				
				
		
				
		

		[ Top ]