Phergie
[ class tree: Phergie ] [ index: Phergie ] [ all elements ]
Packages:
Phergie


Files:
Abstract.php
Abstract.php
Abstract.php
Abstract.php
Abstract.php
Async.php
Autoload.php
Bot.php
Command.php
Config.php
Connection.php
Console.php
Exception.php
Exception.php
Exception.php
Exception.php
Exception.php
Exception.php
Exception.php
Exception.php
Handler.php
Handler.php
Handler.php
Hostmask.php
phergie.php
Request.php
Response.php
Standard.php
Streams.php

Classes:
Phergie_Autoload
Phergie_Bot
Phergie_Config
Phergie_Config_Exception
Phergie_Connection
Phergie_Connection_Exception
Phergie_Connection_Handler
Phergie_Driver_Abstract
Phergie_Driver_Exception
Phergie_Driver_Streams
Phergie_Event_Abstract
Phergie_Event_Command
Phergie_Event_Exception
Phergie_Event_Handler
Phergie_Event_Request
Phergie_Event_Response
Phergie_Exception
Phergie_Hostmask
Phergie_Hostmask_Exception
Phergie_Plugin_Abstract
Phergie_Plugin_Exception
Phergie_Plugin_Handler
Phergie_Process_Abstract
Phergie_Process_Async
Phergie_Process_Exception
Phergie_Process_Standard
Phergie_Ui_Abstract
Phergie_Ui_Console

Class: Phergie_Ui_Abstract

Source Location: /Phergie/Ui/Abstract.php

Class Overview




Base class for end-user interfaces.




Author(s):






                

        






Methods















Child classes:






Phergie_Ui_Console

	
End-user interface that produces console output when running the bot from  a shell.

















Class Details



[line 31]

Base class for end-user interfaces.





Tags:





  

    author:  Phergie Development Team <team@phergie.org>
  

  

    link:  http://pear.phergie.org/package/Phergie
  

  

    abstract:  
  

  

    license:  New BSD License
  










[ Top ]








Class Methods




  

	
	
method onCommand [line 91]

	

    

    

		void onCommand(
Phergie_Event_Command
$event, Phergie_Connection
$connection)
    

    


	
		Handler for when the bot sends a command to a server.





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
Phergie_Ui_Console::onCommand()

		
Outputs a prompt when the bot sends a command to a server.

	

	

	
        
Parameters:

    

    

          

        Phergie_Event_Command  
        $event  
        Event representing the command         being sent
      

          

        Phergie_Connection  
        $connection  
        Connection on which the command         is being sent
      

        

    


        
[ Top ]

  

  

	
	
method onConnect [line 40]

	

    

    

		void onConnect(
string
$host)
    

    


	
		Handler for when a server connection is attempted.





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
Phergie_Ui_Console::onConnect()

		
Outputs a prompt when a server connection is attempted.

	

	

	
        
Parameters:

    

    

          

        string  
        $host  
        Server hostname
      

        

    


        
[ Top ]

  

  

	
	
method onEvent [line 76]

	

    

    

		void onEvent(
Phergie_Event_Abstract
$event, Phergie_Connection
$connection)
    

    


	
		Handler for when the bot receives an IRC event.





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
Phergie_Ui_Console::onEvent()

		
Outputs a prompt when the bot receives an IRC event.

	

	

	
        
Parameters:

    

    

          

        Phergie_Event_Abstract  
        $event  
        Received event
      

          

        Phergie_Connection  
        $connection  
        Connection on which the event         was received
      

        

    


        
[ Top ]

  

  

	
	
method onPluginFailure [line 63]

	

    

    

		void onPluginFailure(
string
$plugin, string
$message)
    

    


	
		Handler for when a plugin fails to load.





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
Phergie_Ui_Console::onPluginFailure()

		
Outputs a prompt when a plugin fails to load.

	

	

	
        
Parameters:

    

    

          

        string  
        $plugin  
        Short name of the plugin
      

          

        string  
        $message  
        Message describing the reason for the failure
      

        

    


        
[ Top ]

  

  

	
	
method onPluginLoad [line 51]

	

    

    

		void onPluginLoad(
string
$plugin)
    

    


	
		Handler for when an attempt is made to load a plugin.





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
Phergie_Ui_Console::onPluginLoad()

		
Outputs a prompt when a plugin is loaded successfully.

	

	

	
        
Parameters:

    

    

          

        string  
        $plugin  
        Short name of the plugin
      

        

    


        
[ Top ]

  

  

	
	
method onQuit [line 103]

	

    

    

		void onQuit(
Phergie_Connection
$connection)
    

    


	
		Handler for when the bot terminates a connection to a server.





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
Phergie_Ui_Console::onQuit()

		
Outputs a prompt when the bot terminates a connection to a server.

	

	

	
        
Parameters:

    

    

          

        Phergie_Connection  
        $connection  
        Terminated connection
      

        

    


        
[ Top ]

  

  

	
	
method onShutdown [line 113]

	

    

    

		void onShutdown(
)
    

    


	
		Handler for when the bot shuts down after terminating all server  connections.





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
Phergie_Ui_Console::onShutdown()

		
Outputs a prompt when the bot shuts down after terminating all server  connections.

	

	

	
        
[ Top ]

  






        

		    

		    Documentation generated on Mon, 27 Sep 2010 23:03:46 -0500 by phpDocumentor 1.4.3