\Phergie\IrcConnectionInterface

Data structure for information related to a client connection per the IRC protocol as described in RFC 1459.

Summary

Methods
Constants
setServerHostname()
getServerHostname()
setServerPort()
getServerPort()
setPassword()
getPassword()
setNickname()
getNickname()
setUsername()
getUsername()
setHostname()
getHostname()
setServername()
getServername()
setRealname()
getRealname()
setOption()
getOption()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

setServerHostname()

setServerHostname(string $hostname)

Sets the hostname of the server.

Parameters

string $hostname

getServerHostname()

getServerHostname() : string

Returns the hostname of the server.

Returns

string

setServerPort()

setServerPort(int $port)

Sets the port on which the server is running.

Parameters

int $port

getServerPort()

getServerPort() : int

Returns the port on which the server is running.

The recommended return value for this method if no port is explicitly set is 6667.

Returns

int

setPassword()

setPassword(string $password)

Sets the connection password.

Parameters

string $password

getPassword()

getPassword() : string

Returns the connection password.

Returns

string

setNickname()

setNickname(string $nickname)

Sets the user's nickname.

Parameters

string $nickname

getNickname()

getNickname() : string

Returns the user's nickname.

Returns

string

setUsername()

setUsername(string $username)

Sets the user's username.

Parameters

string $username

getUsername()

getUsername() : string

Returns the user's username.

Returns

string

setHostname()

setHostname(string $hostname)

Sets the user's hostname.

Parameters

string $hostname

getHostname()

getHostname() : string

Returns the user's hostname.

Returns

string

setServername()

setServername(string $servername)

Sets the user's server name.

Parameters

string $servername

getServername()

getServername() : string

Returns the user's server name.

Returns

string

setRealname()

setRealname(string $realname)

Sets the user's real name.

Parameters

string $realname

getRealname()

getRealname() : string

Returns the user's real name.

Returns

string

setOption()

setOption(string $name, mixed $value)

Sets an implementation-specific connection option.

Parameters

string $name

Option name

mixed $value

Option value

getOption()

getOption(string $name) : mixed

Returns an implementation-specific connection option.

Parameters

string $name

Option name

Returns

mixed