Hoa central
Public Member Functions | Protected Attributes | List of all members
Hoa\Irc\Node Class Reference
Inheritance diagram for Hoa\Irc\Node:

Public Member Functions

 setJoined ($joined)
 
 hasJoined ()
 
 setUsername ($username)
 
 getUsername ()
 
 setChannel ($channel)
 
 getChannel ()
 
- Public Member Functions inherited from Hoa\Socket\Node
 __construct ($id, $socket, Connection $connection)
 
 getId ()
 
 getSocket ()
 
 getConnection ()
 
 setEncryptionType ($type)
 
 getEncryptionType ()
 

Protected Attributes

 $_joined = false
 
 $_username = null
 
 $_channel = null
 
- Protected Attributes inherited from Hoa\Socket\Node
 $_id = null
 
 $_encryptionType = null
 

Detailed Description

Class .

Describe a IRC node.

Definition at line 49 of file Node.php.

Member Function Documentation

Hoa\Irc\Node::getChannel ( )

Get current channel.

Returns
string

Definition at line 141 of file Node.php.

142  {
143  return $this->_channel;
144  }
Hoa\Irc\Node::getUsername ( )

Get username.

Returns
string

Definition at line 117 of file Node.php.

118  {
119  return $this->_username;
120  }
Hoa\Irc\Node::hasJoined ( )

Whether the client has already joined a channel or not.

Returns
bool

Definition at line 93 of file Node.php.

94  {
95  return $this->_joined;
96  }
Hoa\Irc\Node::setChannel (   $channel)

Set current channel.

Parameters
string$channelChannel.
Returns
string

Definition at line 128 of file Node.php.

129  {
130  $old = $this->_channel;
131  $this->_channel = $channel;
132 
133  return $old;
134  }
Hoa\Irc\Node::setJoined (   $joined)

Whether the client has already joined a channel or not.

Parameters
bool$joinedJoined or not.
Returns
bool

Definition at line 80 of file Node.php.

81  {
82  $old = $this->_joined;
83  $this->_joined = $joined;
84 
85  return $old;
86  }
Hoa\Irc\Node::setUsername (   $username)

Set username.

Parameters
string$usernameUsername.
Returns
string

Definition at line 104 of file Node.php.

105  {
106  $old = $this->_username;
107  $this->_username = $username;
108 
109  return $old;
110  }

Member Data Documentation

Hoa\Irc\Node::$_channel = null
protected

Definition at line 70 of file Node.php.

Hoa\Irc\Node::$_joined = false
protected

Definition at line 56 of file Node.php.

Hoa\Irc\Node::$_username = null
protected

Definition at line 63 of file Node.php.


The documentation for this class was generated from the following file: