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_Connection_Handler

Source Location: /Phergie/Connection/Handler.php

Class Overview




Handles connections initiated by the bot.




Author(s):






            

                

            Implements interfaces:
            
    
                
  • Countable (internal interface)
  • IteratorAggregate (internal interface)
    •             

        

        




Variables







Methods
























Class Details



[line 31]

Handles connections initiated by the bot.





Tags:





  

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

  

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

  

    license:  New BSD License
  










[ Top ]







Class Variables



	
	

	
$connections = 

	
[line 38]

  Map of connections indexed by hostmask





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]










Class Methods




  

	
	
constructor __construct [line 45]

	

    

    

		void __construct(
)
    

    


	
		Constructor to initialize storage for connections.





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method addConnection [line 57]

	

    

    

		Phergie_Connection_Handler addConnection(
Phergie_Connection
$connection)
    

    


	
		Adds a connection to the connection list.





Tags:





  

    return:  Provides a fluent interface
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        Phergie_Connection  
        $connection  
        Connection to add
      

        

    


        
[ Top ]

  

  

	
	
method count [line 90]

	

    

    

		int count(
)
    

    


	
		Returns the number of connections in the list.





Tags:





  

    return:  Number of connections
  

  

    access:  public
  









			

		
Implementation of:

			

			
Countable::count

					

		
        
[ Top ]

  

  

	
	
method getConnections [line 114]

	

    

    

		array getConnections(
[array|string
$keys = null])
    

    


	
		Returns a list of specified connection objects.





Tags:





  

    return:  List of Phergie_Connection objects corresponding to the          specified hostmask(s)
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        array|string  
        $keys  
        One or more hostmasks identifying the         connections to return (optional)
      

        

    


        
[ Top ]

  

  

	
	
method getIterator [line 100]

	

    

    

		ArrayIterator getIterator(
)
    

    


	
		Returns an iterator for the connection list.





Tags:





  

    access:  public
  









			

		
Implementation of:

			

			
IteratorAggregate::getIterator

					

		
        
[ Top ]

  

  

	
	
method removeConnection [line 71]

	

    

    

		Phergie_Connection_Handler removeConnection(
Phergie_Connection|string
$connection)
    

    


	
		Removes a connection from the connection list.





Tags:





  

    return:  Provides a fluent interface
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        Phergie_Connection|string  
        $connection  
        Instance or hostmask for         the connection to remove
      

        

    


        
[ Top ]

  






        

		    

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