Docs For Class Chatter

Chatter

Description

Class Chatter represents a person taking part in a chat session

version: $Id: class.Chatter.inc,v 1.102 2004/05/27 09:16:51 jjaeschke Exp $
access: public
author: Frerk Meyer <frerk@meychern.de>
author: Michael Oertel <michael@ortelius.de>

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

Direct descendents

Class	Description
Recipient	Recipient

Variable Summary

string $advice

string $aimNickname

string $birthday

boolean $bodies

string $color

integer $connection_count

integer $days_registered

object $db

integer $db_instance_lifetime

int $disabled

string $email

array $friends

string $gender

string $grade

array $groups

boolean $guest

boolean $halted

boolean $hide_email

string $homePageURL

integer $icqNumber

array $ignored_sender

string $interests

string $lastActive

string $lastHost

string $lastIP

string $lastReferer

string $lastSessionId

string $lastUserAgent

float $lines_per_day

array $line_styles

float $logins_per_day

string $motto

string $name

string $nick

int $online_time

string $password

mixed $password_new

string $pictureURL

boolean $private

string $regTime

string $scrollspeed

boolean $sys_msg

string $theme

array $unlocked_channels

string $user

string $yimNickname

Method Summary

Chatter Chatter ([mixed $user = null], [string $password = null], string $nick)

null add_friend (string $chatter)

boolean add_to_group (string $group_name, mixed $channel_name)

boolean already_seen_today ()

boolean ban (mixed $channel, mixed $period)

void check_private ()

boolean check_user (string $user, string $password)

void connect ([mixed $force_reconnect = false])

void count_hit (string $page)

void db_instance_is_outdated ()

boolean delete ()

boolean delete_line_style_for (string $nick, string $style)

null del_friend (string $chatter)

boolean del_from_group (string $group_name, mixed $channel_name)

boolean disable ()

void disconnect ()

void disinvite (string $chatter)

boolean enable ()

string get_advice ()

mixed get_age ()

integer get_aimNickname ()

string get_birthday ()

void get_bodies (boolean 0)

string get_color ()

void get_days_registered ()

string get_db_advice ()

string get_db_color ()

integer get_db_disabled ()

string get_db_email ()

array get_db_friends ()

string get_db_grade ()

array get_db_groups (mixed $channel_name)

array get_db_invited ([boolean $private = null])

string get_db_lastChannel ()

void get_db_lines_per_day ()

void get_db_logins_per_day ()

string get_db_name ()

integer get_db_online_time ()

string get_db_password ()

string get_db_pictureURL ()

void get_db_scrollspeed ()

void get_db_times ()

string get_db_user ()

void get_db_user_info ()

string get_email ()

void get_friends ()

string get_friends_as_option_list ()

string get_gender ()

string get_grade ()

boolean get_hide (mixed $attribute)

void get_hit_count (mixed $page)

string get_homePageURL ()

integer get_icqNumber ()

array get_ignored_sender ()

string get_interests ()

string get_lastActive ()

string get_last_Host ()

string get_last_IP ()

string get_last_Referer ()

string get_last_SessionId ()

string get_last_UserAgent ()

void get_lines_per_day ()

array get_line_styles ()

string get_line_style_for (mixed $nick)

void get_logins_per_day ()

string get_motto ()

string get_name ()

void get_nick ([mixed $parse = false])

integer get_online_time ()

string get_password ()

string get_pictureURL ()

void get_private (boolean 0)

array get_profile_misc ()

string get_regTime ()

integer get_regulars_table_rank ()

integer get_scrollspeed ()

boolean get_sys_msg ()

string get_theme ()

string get_user ()

integer get_yimNickname ()

void go_offline (string $channel)

void go_online (string $channel)

void halt (string 0)

string has_birthday ()

void ignore (string $chatter)

void init_additional_profile_data ()

array insert_profile_misc (array $data, [mixed $overwrite = false])

void invite (string $chatter)

void invite_private (mixed $from, mixed $to)

boolean is_authorized (string $user, string $password)

void is_authorized_for (mixed $channel)

boolean is_banned (mixed $channel)

void is_disabled ()

boolean is_friend (string $chatter)

void is_grade (mixed $grade)

boolean is_group_member (mixed $group_name, mixed $channel_name)

void is_guest ()

void is_halted ()

boolean is_ignored (string $sender)

boolean is_invited (string $chatter, array &$invited_chatters)

boolean is_kicked ()

boolean is_moderator ()

boolean is_online ()

boolean is_operator ()

void is_registered ()

boolean is_vip ()

void join_channel (mixed $post_channel, [mixed $private_new_window = false])

void lock_channel (mixed $channel)

void mkinstance_clean ()

void mkinstance_persist ()

void refresh (string 0)

boolean register ()

void resume ()

void send_passwd ()

string set_advice (mixed $advice)

boolean set_aimNickname (mixed $aimNickname)

void set_away (boolean $away, [string $away_msg = ''])

boolean set_birthday (mixed $birthday)

void set_bodies ([boolean $bool = true])

void set_color (string $color)

null set_db_friends (string $friends)

void set_db_instance_lifetime ()

void set_db_invited (array $invited_chatters)

boolean set_db_status (mixed $status)

void set_email (string $email)

boolean set_gender (mixed $gender)

boolean set_grade (mixed $grades)

void set_hide (mixed $attribute, [mixed $bool = false])

boolean set_homePageURL (mixed $url)

boolean set_icqNumber (mixed $icqNumber)

string set_interests (mixed $interests)

boolean set_line_style_for (string $nick, string $style)

string set_motto (mixed $motto)

void set_name (mixed $user)

void set_nick (mixed $user)

void set_online_time (integer $time)

void set_password (mixed $password)

void set_password_new (string $passwd)

boolean set_pictureURL (mixed $url)

void set_private ([boolean $bool = true])

void set_scrollspeed (integer $speed)

void set_sys_msg ([boolean $bool = true])

void set_theme (string $theme)

void set_user (mixed $user)

boolean set_yimNickname (mixed $yimNickname)

void test ()

void unignore (string $chatter)

void unlock_channel (mixed $channel)

boolean update ([boolean $pwd_only = false])

void update_stats ()

boolean _send_confirmation_mail (mixed $to, mixed $subject, mixed $message, [mixed $from = ADMIN_MAIL_ADDRESS])

void _set_db_attributes ()

boolean _update_line_style ()

Variables

string $advice = null (line 235)

access: public

string $aimNickname = '' (line 143)

A AIM nickname of chatter

string $birthday = '' (line 80)

birthday of chatter

boolean $bodies = false (line 217)

access: private

string $color = '' (line 229)

access: public

integer $connection_count = 0 (line 304)

see: Chatter::disconnect()
see: Chatter::connect()

integer $days_registered = 0 (line 319)

object $db (line 290)

see: Chatter::connect()
access: private

integer $db_instance_lifetime = 0 (line 324)

int $disabled = 0 (line 178)

chatter disabled

string $email = '' (line 94)

email of chatter

array $friends = array() (line 199)

stores friends of chatter

string $gender = '' (line 87)

gender of chatter

string $grade = '' (line 157)

chatter grade

array $groups = array() (line 171)

chatter groups

boolean $guest = false (line 297)

see: Chatter::check_user()
access: private

boolean $halted = false (line 211)

access: private

boolean $hide_email = true (line 101)

hide email

string $homePageURL = '' (line 115)

A home page URL of chatter

integer $icqNumber = 0 (line 136)

A ICQ number of chatter

array $ignored_sender = array() (line 192)

stores chatter objects of ignored chatters

string $interests = '' (line 122)

Interests of chatter

string $lastActive = '' (line 253)

access: public

string $lastHost = '' (line 259)

access: public

string $lastIP = '' (line 265)

access: public

string $lastReferer = '' (line 271)

access: public

string $lastSessionId = '' (line 283)

access: public

string $lastUserAgent = '' (line 277)

access: public

float $lines_per_day = 0 (line 309)

array $line_styles = array() (line 334)

float $logins_per_day = 0 (line 314)

string $motto = '' (line 129)

Motto of chatter

string $name = '' (line 73)

user name

string $nick = '' (line 51)

every chatter is identified by a uniq nick name

int $online_time = 0 (line 185)

online time in seconds

string $password = '' (line 58)

password of chatter

mixed $password_new = '' (line 59)

string $pictureURL = '' (line 108)

A URL of a picture of chatter

boolean $private = false (line 205)

access: private

string $regTime = '' (line 247)

access: public

string $scrollspeed = -1 (line 241)

access: public

boolean $sys_msg = false (line 223)

access: private

string $theme = DEFAULT_THEME (line 164)

chatter grade

array $unlocked_channels = array() (line 329)

string $user = '' (line 66)

every chatter has an user name

string $yimNickname = '' (line 150)

A YIM nickname of chatter

Methods

Constructor Chatter (line 345)

Implements a chat user

Constructor Implements a chat user

Chatter Chatter ([mixed $user = null], [string $password = null], string $nick)

string $nick
string $password

add_friend (line 2156)

Adds a chatter to the friends list

access: public

null add_friend (string $chatter)

string $chatter

add_to_group (line 2500)

Adds the chatter to given group

boolean add_to_group (string $group_name, mixed $channel_name)

string $group_name: Name of the group

already_seen_today (line 3275)

checks last login time

boolean already_seen_today ()

ban (line 494)

Banishment of chatter

access: public

boolean ban (mixed $channel, mixed $period)

check_private (line 3209)

void check_private ()

check_user (line 367)

Check if user name and it's account data are valid

Check if user name and it's account data are valid Return false if $user is not valid

boolean check_user (string $user, string $password)

string $user
string $password

connect (line 668)

Connect to the database

Connect to the database Establish a database connection

access: public

void connect ([mixed $force_reconnect = false])

count_hit (line 1490)

Counts hits within the chat

access: public

void count_hit (string $page)

string $page

db_instance_is_outdated (line 2094)

void db_instance_is_outdated ()

delete (line 1441)

Deletes this user

access: public

boolean delete ()

delete_line_style_for (line 2795)

Deletes styles for a given chatter

access: public

boolean delete_line_style_for (string $nick, string $style)

string $nick
string $style

del_friend (line 2172)

Deletes a chatter from the friends list

access: public

null del_friend (string $chatter)

string $chatter

del_from_group (line 2561)

Deletes the chatter from given group

boolean del_from_group (string $group_name, mixed $channel_name)

string $group_name: Name of the group

disable (line 1539)

Disables this chatter

access: public

boolean disable ()

disconnect (line 693)

Disconnect the database

see: Chatter::connect()
access: public

void disconnect ()

disinvite (line 2125)

Disinvites a chatter

access: public

void disinvite (string $chatter)

string $chatter

enable (line 1462)

Enables this chatter

access: public

boolean enable ()

get_advice (line 2971)

Provides the advice flag

Provides the advice flag Is set, if user wants to be adviced if he gets new messages within the chat

access: public

string get_advice ()

get_age (line 1285)

Provides the age of chatter

access: public

mixed get_age ()

get_aimNickname (line 1162)

Provides the AIM nickname of chatter

access: public

integer get_aimNickname ()

get_birthday (line 1210)

Provides birthday of chatter

access: public

string get_birthday ()

get_bodies (line 2640)

Provides the bodies flag of chatter If is set, the chatter gets only messages from or spoken to friends of him.

access: public

void get_bodies (boolean 0)

boolean 0

get_color (line 2743)

Provides the text color of chatter

access: public

string get_color ()

get_days_registered (line 2267)

void get_days_registered ()

get_db_advice (line 3021)

Gets the advice flag from the database

access: private

string get_db_advice ()

get_db_color (line 2917)

Gets the text color of chatter from the database

access: private

string get_db_color ()

get_db_disabled (line 3051)

Gets the disabled flag from the database

access: public

integer get_db_disabled ()

get_db_email (line 3144)

Gets the name from database

access: private

string get_db_email ()

get_db_friends (line 2223)

Gets the friends list from database

access: private

array get_db_friends ()

get_db_grade (line 3090)

Gets the grade of user from DB

access: private

string get_db_grade ()

get_db_groups (line 2450)

Gets all the groups of chatter from DB

array get_db_groups (mixed $channel_name)

get_db_invited (line 1958)

Provides the array of invited chatters

access: public

array get_db_invited ([boolean $private = null])

boolean $private

get_db_lastChannel (line 3162)

Gets the name from database

access: private

string get_db_lastChannel ()

get_db_lines_per_day (line 2393)

void get_db_lines_per_day ()

get_db_logins_per_day (line 2405)

void get_db_logins_per_day ()

get_db_name (line 3108)

Gets the name from database

access: private

string get_db_name ()

get_db_online_time (line 818)

Provides chatter's online time from DB

access: public

integer get_db_online_time ()

get_db_password (line 3126)

Provides the password from poc-database account database

access: private

string get_db_password ()

get_db_pictureURL (line 3180)

Gets the name from database

access: private

string get_db_pictureURL ()

get_db_scrollspeed (line 3033)

void get_db_scrollspeed ()

get_db_times (line 3239)

Gets the registration time from database

access: private

void get_db_times ()

get_db_user (line 3069)

Gets the user name from database

access: private

string get_db_user ()

get_db_user_info (line 3256)

Gets some data about the current chatter from database

access: private

void get_db_user_info ()

get_email (line 1321)

Gets the E-Mail of chatter

access: public

string get_email ()

get_friends (line 2191)