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_Bot

Source Location: /Phergie/Bot.php

Class Overview




Composite class for other components to represent the bot.




Author(s):






            

        




Variables






Constants






Methods
























Class Details



[line 31]

Composite class for other components to represent the bot.





Tags:





  

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

  

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

  

    license:  New BSD License
  










[ Top ]







Class Variables



	
	

	
$config = 

	
[line 50]

  Current configuration instance





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      Phergie_Config
    

      

	



	
[ Top ]


	
	

	
$connections = 

	
[line 57]

  Current connection handler instance





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      Phergie_Connection_Handler
    

      

	



	
[ Top ]


	
	

	
$driver = 

	
[line 43]

  Current driver instance





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      Phergie_Driver_Abstract
    

      

	



	
[ Top ]


	
	

	
$events = 

	
[line 71]

  Current event handler instance





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      Phergie_Event_Handler
    

      

	



	
[ Top ]


	
	

	
$plugins = 

	
[line 64]

  Current plugin handler instance





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      Phergie_Plugin_Handler
    

      

	



	
[ Top ]


	
	

	
$processor = 

	
[line 85]

  Current processor instance





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      Phergie_Process_Abstract
    

      

	



	
[ Top ]


	
	

	
$ui = 

	
[line 78]

  Current end-user interface instance





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      Phergie_Ui_Abstract
    

      

	



	
[ Top ]










Class Methods




  

	
	
method getConfig [line 148]

	

    

    

		mixed getConfig(
[string
$index = null], [mixed
$default = null])
    

    


	
		Returns the entire configuration in use or the value of a specific  configuration setting.





Tags:





  

    return:  Value corresponding to $index or the entire          configuration if $index is not specified
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $index  
        Optional index of a specific configuration         setting for which the corresponding value should be returned
      

          

        mixed  
        $default  
        Value to return if no match is found for $index
      

        

    


        
[ Top ]

  

  

	
	
method getConnectionHandler [line 227]

	

    

    

		Phergie_Connection_Handler getConnectionHandler(
)
    

    


	
		Returns a connection handler instance, creating it if it does not  already exist and using a default class if none has been set.





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getDriver [line 93]

	

    

    

		Phergie_Driver_Abstract getDriver(
)
    

    


	
		Returns a driver instance, creating one of the default class if  none has been set.





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getEventHandler [line 200]

	

    

    

		Phergie_Event_Handler getEventHandler(
)
    

    


	
		Returns an event handler instance, creating it if it does not already  exist and using a default class if none has been set.





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getPluginHandler [line 170]

	

    

    

		Phergie_Plugin_Handler getPluginHandler(
)
    

    


	
		Returns a plugin handler instance, creating it if it does not already  exist and using a default class if none has been set.





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getProcessor [line 281]

	

    

    

		Phergie_Process_Abstract getProcessor(
)
    

    


	
		Returns a processer instance, creating one if none exists.





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getUi [line 254]

	

    

    

		Phergie_Ui_Abstract getUi(
)
    

    


	
		Returns an end-user interface instance, creating it if it does not  already exist and using a default class if none has been set.





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method loadConnections [line 351]

	

    

    

		void loadConnections(
)
    

    


	
		Configures and establishes connections to IRC servers.





Tags:





  

    access:  protected
  









	
        
[ Top ]

  

  

	
	
method loadPlugins [line 317]

	

    

    

		void loadPlugins(
)
    

    


	
		Loads plugins into the plugin handler.





Tags:





  

    access:  protected
  









	
        
[ Top ]

  

  

	
	
method run [line 382]

	

    

    

		Phergie_Bot run(
)
    

    


	
		Establishes server connections and initiates an execution loop to  continuously receive and process events.





Tags:





  

    return:  Provides a fluent interface
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method setConfig [line 131]

	

    

    

		Phergie_Runner_Abstract setConfig(
Phergie_Config
$config)
    

    


	
		Sets the configuration to use.





Tags:





  

    return:  Provides a fluent interface
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        Phergie_Config  
        $config  
        Configuration instance
      

        

    


        
[ Top ]

  

  

	
	
method setConnectionHandler [line 242]

	

    

    

		Phergie_Bot setConnectionHandler(
Phergie_Connection_Handler
$handler)
    

    


	
		Sets the connection handler instance to use.





Tags:





  

    return:  Provides a fluent interface
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        Phergie_Connection_Handler  
        $handler  
        Connection handler instance
      

        

    


        
[ Top ]

  

  

	
	
method setDriver [line 118]

	

    

    

		Phergie_Bot setDriver(
Phergie_Driver_Abstract
$driver)
    

    


	
		Sets the driver instance to use.





Tags:





  

    return:  Provides a fluent interface
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        Phergie_Driver_Abstract  
        $driver  
        Driver instance
      

        

    


        
[ Top ]

  

  

	
	
method setEventHandler [line 215]

	

    

    

		Phergie_Bot setEventHandler(
Phergie_Event_Handler
$handler)
    

    


	
		Sets the event handler instance to use.





Tags:





  

    return:  Provides a fluent interface
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        Phergie_Event_Handler  
        $handler  
        Event handler instance
      

        

    


        
[ Top ]

  

  

	
	
method setPluginHandler [line 188]

	

    

    

		Phergie_Bot setPluginHandler(
Phergie_Plugin_Handler
$handler)
    

    


	
		Sets the plugin handler instance to use.





Tags:





  

    return:  Provides a fluent interface
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        Phergie_Plugin_Handler  
        $handler  
        Plugin handler instance
      

        

    


        
[ Top ]

  

  

	
	
method setProcessor [line 306]

	

    

    

		Phergie_Bot setProcessor(
Phergie_Process_Abstract
$processor)
    

    


	
		Sets the processer instance to use.





Tags:





  

    return:  Provides a fluent interface
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        Phergie_Process_Abstract  
        $processor  
        Processer instance
      

        

    


        
[ Top ]

  

  

	
	
method setUi [line 270]

	

    

    

		Phergie_Bot setUi(
Phergie_Ui_Abstract
$ui)
    

    


	
		Sets the end-user interface instance to use.





Tags:





  

    return:  Provides a fluent interface
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        Phergie_Ui_Abstract  
        $ui  
        End-user interface instance
      

        

    


        
[ Top ]

  









Class Constants



	
	

	
VERSION =  '2.0.1'

	
[line 36]

  Current version of Phergie


  

	
[ Top ]






        

		    

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