Class channel

Description

BuddyServ IRC Services

Channel class object

Located in /includes/class/Class.channel.php (line 24)


	
			
Method Summary
channel __construct (string $channel)
void addaccess (string $user, bit $binmode)
void addBan (string $mask)
void addMode (bit $modes)
void adduser (string $user, bit $binmode)
void addUserStatus (string $user, bit $bin)
unknown_type add_auto_status1 ($mask $mask, $modes $modes)
int deluser (stirng $user)
bool exists (string $channel)
string findMatchingBan (string $mask)
channel get (string $channel)
void hasUserStatus (string $user, bit $bin)
bool has_access (string $nick, bit $which)
bool isBanned (string $mask)
void isMember ( $who)
mixed is_juped ()
bool is_registered ()
void remaccess (string $user, bit $binmode)
bool remove (channel $object)
void removeBan (string $mask)
void removeBansMatching (string $mask)
void removeMode (bit $bin)
void removeUserStatus (string $user, bit $bin)
void rename_user (string $user, string $newnick)
mixed sql_single (string $channel)
int usercount ()
void __get ( $what)
void __set ( $key,  $value)
Methods
Constructor __construct (line 132)

Creates a new instance of a channel.

Used to store all relevant information for the duration its needed.

channel __construct (string $channel)
  • string $channel
addaccess (line 397)

Add user to the channel access list with the given level

void addaccess (string $user, bit $binmode)
  • string $user
  • bit $binmode
addBan (line 255)

Adds a ban record to the channel

void addBan (string $mask)
  • string $mask
addMode (line 334)

Sets the channels active modes in BIN

void addMode (bit $modes)
  • bit $modes
adduser (line 472)

Add a user to this channel with the given channel modes.

void adduser (string $user, bit $binmode)
  • string $user
  • bit $binmode
addUserStatus (line 499)

Add a channel status to the given user.

void addUserStatus (string $user, bit $bin)
  • string $user
  • bit $bin
add_auto_status1 (line 543)

Convert IRCD mode prefixes to their letter equivalence -- not sure if this is used...

unknown_type add_auto_status1 ($mask $mask, $modes $modes)
  • $mask $mask
  • $modes $modes
deluser (line 427)

Remove a user entry from the current channel.

Returns the amount of users left.

int deluser (stirng $user)
  • stirng $user
exists (line 91)

Check if a given channel currently exists.

bool exists (string $channel)
  • string $channel
findMatchingBan (line 278)

Find an return a ban matching a mask.

Returns false on no matches.

string findMatchingBan (string $mask)
  • string $mask
get (line 61)

Check for an instance of the given channel or creates one if not found.

channel get (string $channel)
  • string $channel
hasUserStatus (line 525)

Check if the user has a given status.

void hasUserStatus (string $user, bit $bin)
  • string $user
  • bit $bin
has_access (line 370)

Check if a user has the given access level to the channel.

bool has_access (string $nick, bit $which)
  • string $nick
  • bit $which
isBanned (line 233)

Checks if the given mask is banned from this channel.

bool isBanned (string $mask)
  • string $mask
isMember (line 318)
void isMember ( $who)
  • $who
is_juped (line 182)

Check if the channel is juped or not.

Returns false or the jupe reason

mixed is_juped ()
is_registered (line 354)

Is a registered channel?

bool is_registered ()
remaccess (line 414)

Remove access for a user

void remaccess (string $user, bit $binmode)
  • string $user
  • bit $binmode
remove (line 108)

Remove a channel from our current list of active channels.

bool remove (channel $object)
removeBan (line 266)

Remove a ban from the channel records.

void removeBan (string $mask)
  • string $mask
removeBansMatching (line 296)

Remove all bans matching a mask.

void removeBansMatching (string $mask)
  • string $mask
removeMode (line 312)

Removes a mode from the channel bits

void removeMode (bit $bin)
  • bit $bin
removeUserStatus (line 512)

Remove a channel user status from a user

void removeUserStatus (string $user, bit $bin)
  • string $user
  • bit $bin
rename_user (line 452)

Called when a user who is on this channel changes their nickname.

void rename_user (string $user, string $newnick)
  • string $user
  • string $newnick
sql_single (line 204)

Check the database for an entry for the given channel.

Returns an array on success or false on failure.

mixed sql_single (string $channel)
  • string $channel
usercount (line 221)

Return the amount of users on this channel.

int usercount ()
__get (line 339)
void __get ( $what)
  • $what
__set (line 344)
void __set ( $key,  $value)
  • $key
  • $value

Documentation generated on Thu, 19 Nov 2009 20:25:10 -0700 by phpDocumentor 1.4.1