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

Source Location: /Phergie/Connection.php

Class Overview




Data structure for connection metadata.




Author(s):






            

        




Variables







Methods
























Class Details



[line 31]

Data structure for connection metadata.





Tags:





  

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

  

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

  

    license:  New BSD License
  










[ Top ]







Class Variables



	
	

	
$encoding = 

	
[line 62]

  Encoding method for the connection, defaults to ISO-8859-1 but can  be set to UTF8 if necessary





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      strng
    

      

	



	
[ Top ]


	
	

	
$host = 

	
[line 38]

  Host to which the client will connect





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$hostmask = 

	
[line 97]

  Hostmask for the connection





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      Phergie_Hostmask
    

      

	



	
[ Top ]


	
	

	
$nick = 

	
[line 69]

  Nick that the client will use





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$password = 

	
[line 90]

  Password that the client will use





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$port = 

	
[line 46]

  Port on which the client will connect, defaults to the standard IRC  port





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$realname = 

	
[line 83]

  Realname that the client will use





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$transport = 

	
[line 54]

  Transport for the connection, defaults to tcp but can be set to ssl  or variations thereof to connect over SSL





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$username = 

	
[line 76]

  Username that the client will use





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]










Class Methods




  

	
	
constructor __construct [line 107]

	

    

    

		void __construct(
[
$options = array()])
    

    


	
		Constructor to initialize instance properties.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        array  
        $options  
        Optional associative array of property values         to initialize
      

        

    


        
[ Top ]

  

  

	
	
method checkSetting [line 126]

	

    

    

		void checkSetting(
string
$setting)
    

    


	
		Emits an error related to a required connection setting does not have  value set for it.





Tags:





  

    access:  protected
  









	
        
Parameters:

    

    

          

        string  
        $setting  
        Name of the setting
      

        

    


        
[ Top ]

  

  

	
	
method getEncoding [line 273]

	

    

    

		string getEncoding(
)
    

    


	
		Returns the encoding in use by the connection.





Tags:





  

    return:  Encoding (ex: ASCII, ISO-8859-1, UTF8, etc.)
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHost [line 176]

	

    

    

		string getHost(
)
    

    


	
		Returns the host to which the client will connect if it is set or  emits an error if it is not set.





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHostmask [line 141]

	

    

    

		string getHostmask(
)
    

    


	
		Returns a hostmask that uniquely identifies the connection.





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getNick [line 299]

	

    

    

		string getNick(
)
    

    


	
		Returns the nick that the client will use.





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getPassword [line 383]

	

    

    

		string getPassword(
)
    

    


	
		Returns the password that the client will use.





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getPort [line 204]

	

    

    

		int getPort(
)
    

    


	
		Returns the port on which the client will connect.





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getRealname [line 355]

	

    

    

		string getRealname(
)
    

    


	
		Returns the realname that the client will use.





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getTransport [line 239]

	

    

    

		string getTransport(
)
    

    


	
		Returns the transport in use by the connection.





Tags:





  

    return:  Transport (ex: tcp, ssl, etc.)
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getUsername [line 327]

	

    

    

		string getUsername(
)
    

    


	
		Returns the username that the client will use.





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method setEncoding [line 251]

	

    

    

		Phergie_Connection setEncoding(
string
$encoding)
    

    


	
		Sets the encoding for the connection to use.





Tags:





  

    return:  Provides a fluent interface
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $encoding  
        Encoding to use (ex: ASCII, ISO-8859-1, UTF8, etc.)
      

        

    


        
[ Top ]

  

  

	
	
method setHost [line 161]

	

    

    

		Phergie_Connection setHost(
string
$host)
    

    


	
		Sets the host to which the client will connect.





Tags:





  

    return:  Provides a fluent interface
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $host  
        Hostname
      

        

    


        
[ Top ]

  

  

	
	
method setNick [line 285]

	

    

    

		Phergie_Connection setNick(
string
$nick)
    

    


	
		Sets the nick that the client will use.





Tags:





  

    return:  Provides a fluent interface
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $nick  
        Nickname
      

        

    


        
[ Top ]

  

  

	
	
method setOptions [line 396]

	

    

    

		Phergie_Connection setOptions(

$options)
    

    


	
		Sets multiple connection settings using an array.





Tags:





  

    return:  Provides a fluent interface
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        array  
        $options  
        Associative array of setting names mapped to         corresponding values
      

        

    


        
[ Top ]

  

  

	
	
method setPassword [line 369]

	

    

    

		Phergie_Connection setPassword(
string
$password)
    

    


	
		Sets the password that the client will use.





Tags:





  

    return:  Provides a fluent interface
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $password  
        Password
      

        

    


        
[ Top ]

  

  

	
	
method setPort [line 190]

	

    

    

		Phergie_Connection setPort(
int
$port)
    

    


	
		Sets the port on which the client will connect.





Tags:





  

    return:  Provides a fluent interface
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $port  
        Port
      

        

    


        
[ Top ]

  

  

	
	
method setRealname [line 341]

	

    

    

		Phergie_Connection setRealname(
string
$realname)
    

    


	
		Sets the realname that the client will use.





Tags:





  

    return:  Provides a fluent interface
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $realname  
        Real name
      

        

    


        
[ Top ]

  

  

	
	
method setTransport [line 220]

	

    

    

		Phergie_Connection setTransport(
string
$transport)
    

    


	
		Sets the transport for the connection to use.





Tags:





  

    return:  Provides a fluent interface
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $transport  
        Transport (ex: tcp, ssl, etc.)
      

        

    


        
[ Top ]

  

  

	
	
method setUsername [line 313]

	

    

    

		Phergie_Connection setUsername(
string
$username)
    

    


	
		Sets the username that the client will use.





Tags:





  

    return:  Provides a fluent interface
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $username  
        Username
      

        

    


        
[ Top ]

  






        

		    

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