Docs For Class Channel

Description

Describes a channel

version: $Id: class.Channel.inc,v 1.12 2004/05/27 09:16:51 jjaeschke Exp $
access: public
author: Michael Oertel <michael@ortelius.de>

Located in /include/class.Channel.inc (line 44)

Variable Summary

integer $connection_count

object $db

string $message

boolean $moderated

string $name

string $password

Method Summary

Channel Channel (string $name)

void connect ()

void disconnect ()

void get_message ()

void get_name ()

void get_password ()

mixed is_attendant (string $nick, [boolean $complete = false])

boolean is_moderated ()

boolean is_password_protected ()

void test ()

Variables

integer $connection_count = 0 (line 82)

see: Channel::disconnect()
see: Channel::connect()

object $db (line 75)

see: Channel::connect()
access: private

string $message = '' (line 68)

access: public

boolean $moderated = false (line 56)

access: public

string $name (line 50)

access: public

string $password = '' (line 62)

access: public

Methods

Constructor Channel (line 95)

Constructor.

Constructor. create and setup a new channel object channel types: null = normal channel

= moderated channel

access: public

Channel Channel (string $name)

string $name: channel name

connect (line 206)

Connect to the database

Connect to the database Establish a database connection

access: public

void connect ()

disconnect (line 227)

Disconnect the database

see: Channel::connect()
access: public

void disconnect ()

get_message (line 172)

Provides the message of current channel.

access: public

void get_message ()

get_name (line 152)

Get channel name.

access: public

void get_name ()

get_password (line 162)

Provides the password of current channel.

access: public

void get_password ()

is_attendant (line 120)

Checks if the given nickname in channel

access: public

mixed is_attendant (string $nick, [boolean $complete = false])

string $nick
boolean $complete

is_moderated (line 183)

Provides the moderated flag

access: public

boolean is_moderated ()

is_password_protected (line 194)

Provides inforamtion about password protection of current channel

access: public

boolean is_password_protected ()

test (line 243)

Test class Channel

Test class Channel call like: Channel::test();

void test ()