## Class Chatter

Description

Class Chatter represents a person taking part in a chat session

- version: $Id: class.Chatter.inc,v 1.82 2003/04/29 16:22:43 letreo Exp $
- access: public
- author: Michael Oertel <michael@ortelius.de>
- author: Frerk Meyer <frerk@meychern.de>

Located in Program_Root/include/class.Chatter.inc (line 41)

Direct descendents

Class | Description
--- | ---
Recipient | Recipient

Variable Summary
string $advice
string $aimNickname
string $birthday
string $color
integer $connection_count
integer $days_registered
integer $db_instance_lifetime
int $disabled
string $email
array $friends
string $gender
string $grade
array $groups
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
float $logins_per_day
string $motto
string $name
string $nick
int $online_time
string $password
string $pictureURL
string $regTime
string $scrollspeed
string $theme
array $unlocked_channels
string $user
string $yimNickname
Method Summary
void Chatter ([mixed $user = null], [string $password = null], string $nick)
null add_friend (string $chatter)
boolean add_to_group (string $group_name)
boolean already_seen_today ()
boolean ban (mixed $channel, mixed $period)
void check_private ()
boolean check_user (string $user, string $password)
void connect ()
void count_hit (string $page)
void db_instance_is_outdated ()
boolean delete ()
null del_friend (string $chatter)
boolean del_from_group (string $group_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 ()
integer get_db_disabled ()
array get_db_groups ()
array get_db_invited ([boolean $private = null])
void get_db_lines_per_day ()
void get_db_logins_per_day ()
integer get_db_online_time ()
void get_db_scrollspeed ()
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 ()
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)
string has_birthday ()
void ignore (string $chatter)
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)
void is_guest ()
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 mkinstance_clean ()
void mkinstance_persist ()
void refresh (string 0)
boolean register ()
void send_passwd ()
string set_advice (mixed $advice)
boolean set_aimNickname (mixed $aimNickname)
boolean set_birthday (mixed $birthday)
void set_bodies ([boolean $bool = true])
void set_color (string $color)
void set_db_instance_lifetime ()
boolean set_db_status (mixed $status)
void set_email (mixed $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)
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)
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 ()
void update_stats ()
Variables
string $advice = null (line 225)

- access: public

string $aimNickname (line 139)

A AIM nickname of chatter

string $birthday (line 76)

birthday of chatter

string $color (line 219)

- access: public

integer $connection_count (line 294)

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

integer $days_registered (line 309)
integer $db_instance_lifetime (line 314)
int $disabled (line 174)

chatter disabled

string $email (line 90)

email of chatter

array $friends = array() (line 195)

stores friends of chatter

string $gender (line 83)

gender of chatter

string $grade (line 153)

chatter grade

array $groups = array() (line 167)

chatter groups

boolean $hide_email = true (line 97)

hide email

string $homePageURL (line 111)

A home page URL of chatter

integer $icqNumber (line 132)

A ICQ number of chatter

array $ignored_sender = array() (line 188)

stores chatter objects of ignored chatters

string $interests (line 118)

Interests of chatter

string $lastActive (line 243)

- access: public

string $lastHost (line 249)

- access: public

string $lastIP (line 255)

- access: public

string $lastReferer (line 261)

- access: public

string $lastSessionId (line 273)

- access: public

string $lastUserAgent (line 267)

- access: public

float $lines_per_day (line 299)
float $logins_per_day (line 304)
string $motto (line 125)

Motto of chatter

string $name (line 69)

user name

string $nick (line 48)

every chatter is identified by a uniq nick name

int $online_time (line 181)

online time in seconds

string $password (line 55)

password of chatter

string $pictureURL (line 104)

A URL of a picture of chatter

string $regTime (line 237)

- access: public

string $scrollspeed = -1 (line 231)

- access: public

string $theme = DEFAULT_THEME (line 160)

chatter grade

array $unlocked_channels = array() (line 319)
string $user (line 62)

every chatter has an user name

string $yimNickname (line 146)

A YIM nickname of chatter

Methods
Constructor Chatter (line 330)

Implements a chat user

Implements a chat user

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

- string $nick
- string $password

add_friend (line 1987)

Adds a chatter to the friends list

- access: public

null add_friend (string $chatter)

- string $chatter

add_to_group (line 2319)

Adds the chatter to given group

boolean add_to_group (string $group_name)

- string $group_name: Name of the group

already_seen_today (line 2989)

checks last login time

boolean already_seen_today ()
ban (line 480)

Banishment of chatter

- access: public

boolean ban (mixed $channel, mixed $period)
check_private (line 2923)
void check_private ()
check_user (line 353)

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 596)

Connect to the database

Establish a database connection

- access: public

void connect ()
count_hit (line 1398)

Counts hits within the chat

- access: public

void count_hit (string $page)

- string $page

db_instance_is_outdated (line 1925)
void db_instance_is_outdated ()
delete (line 1349)

Deletes this user

- access: public

boolean delete ()
del_friend (line 2003)

Deletes a chatter from the friends list

- access: public

null del_friend (string $chatter)

- string $chatter

del_from_group (line 2364)

Deletes the chatter from given group

boolean del_from_group (string $group_name)

- string $group_name: Name of the group

disable (line 1447)

Disables this chatter

- access: public

boolean disable ()
disconnect (line 617)

Disconnect the database

- see: Chatter::connect()
- access: public

void disconnect ()
disinvite (line 1956)

Disinvites a chatter

- access: public

void disinvite (string $chatter)

- string $chatter

enable (line 1370)

Enables this chatter

- access: public

boolean enable ()
get_advice (line 2685)

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 1193)

Provides the age of chatter

- access: public

mixed get_age ()
get_aimNickname (line 1070)

Provides the AIM nickname of chatter

- access: public

integer get_aimNickname ()
get_birthday (line 1118)

Provides birthday of chatter

- access: public

string get_birthday ()
get_bodies (line 2440)

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 2543)

Provides the text color of chatter

- access: public

string get_color ()
get_days_registered (line 2098)
void get_days_registered ()
get_db_disabled (line 2765)

Gets the disabled flag from the database

- access: public

integer get_db_disabled ()
get_db_groups (line 2274)

Gets all the groups of chatter from DB

array get_db_groups ()
get_db_invited (line 1818)

Provides the array of invited chatters

- access: public

array get_db_invited ([boolean $private = null])

- boolean $private

get_db_lines_per_day (line 2217)
void get_db_lines_per_day ()
get_db_logins_per_day (line 2229)
void get_db_logins_per_day ()
get_db_online_time (line 739)

Provides chatter's online time from DB

- access: public

integer get_db_online_time ()
get_db_scrollspeed (line 2747)
void get_db_scrollspeed ()
get_email (line 1229)

Gets the E-Mail of chatter

- access: public

string get_email ()
get_friends (line 2022)
void get_friends ()
get_friends_as_option_list (line 2033)

Returns all friends as an html-option list

- access: public

string get_friends_as_option_list ()
get_gender (line 1153)

Provides gender of chatter

- return: possible values are 'f' or 'm'
- access: public

string get_gender ()
get_grade (line 971)

Gets grade of chatter

- access: public

string get_grade ()
get_hide (line 1164)

checks if chatter has something to hide

- access: public

boolean get_hide (mixed $attribute)
get_hit_count (line 1432)

Provides the hit count of a given page

void get_hit_count (mixed $page)
get_homePageURL (line 1288)

Gets the homePageURL of chatter

- access: public

string get_homePageURL ()
get_icqNumber (line 1046)

Provides the icq number of chatter

- access: public

integer get_icqNumber ()
get_ignored_sender (line 1806)

Provides the ignore list of chatter

- access: public

array get_ignored_sender ()
get_interests (line 1299)

Gets interests of chatter

- access: public

string get_interests ()
get_lastActive (line 2565)

Provides the last active time of chatter

- access: public

string get_lastActive ()
get_last_Host (line 2576)

Provides the last host of chatter

- access: public

string get_last_Host ()
get_last_IP (line 2587)

Provides the last IP of chatter

- access: public

string get_last_IP ()
get_last_Referer (line 2609)

Provides the last referer of chatter

- access: public

string get_last_Referer ()
get_last_SessionId (line 2620)

Provides the last referer of chatter

- access: public

string get_last_SessionId ()
get_last_UserAgent (line 2598)

Provides the last user agent of chatter

- access: public

string get_last_UserAgent ()
get_lines_per_day (line 2207)
void get_lines_per_day ()
get_logins_per_day (line 2212)
void get_logins_per_day ()
get_motto (line 1324)

Gets interests of chatter

- access: public

string get_motto ()
get_name (line 998)

Gets the name of chatter

- access: public

string get_name ()
get_nick (line 1695)

Returns the nickname of chatter

class Recipients extents class chatter. In case of recipient is 'EVERY_BODY' we have to translate 'EVERY_BODY' to the respective language of chatter

- access: public

void get_nick ([mixed $parse = false])
get_online_time (line 728)

Provides chatter's online time

- access: public

integer get_online_time ()
get_password (line 938)

Gets the password of chatter

- access: public

string get_password ()
get_pictureURL (line 1277)

Gets the pictureURL of chatter

- access: public

string get_pictureURL ()
get_private (line 2415)

Provides the private flag of chatter

- access: public

void get_private (boolean 0)

- boolean 0

get_profile_misc (line 3069)

Provides miscellaneous profile data

array get_profile_misc ()
get_regTime (line 2554)

Provides the registration time of chatter

- access: public

string get_regTime ()
get_regulars_table_rank (line 3003)

Searches the regular's table

integer get_regulars_table_rank ()
get_scrollspeed (line 2724)

Provides the scrollspeed of the output frame

- access: public

integer get_scrollspeed ()
get_sys_msg (line 2466)

Gets the system messages flag of chatter

Chatters can hide the messages sent by the system

- access: public

boolean get_sys_msg ()
get_theme (line 960)

Provides the choosen theme of chatter

- access: public

string get_theme ()
get_user (line 949)

Gets user name of chatter

- access: public

string get_user ()
get_yimNickname (line 1094)

Provides the YIM nickname of chatter

- access: public

integer get_yimNickname ()
go_offline (line 758)

Sets chatter status to offline

- see: Chatter::go_online()
- access: public

void go_offline (string $channel)

- string $channel

go_online (line 643)

Sets chatter status to online

- see: Chatter::go_offline()
- access: public

void go_online (string $channel)

- string $channel

has_birthday (line 1129)

Provides birthday of chatter

- access: public

string has_birthday ()
ignore (line 1771)

Adds the given chatter to ignore list

- access: public

void ignore (string $chatter)

- string $chatter

insert_profile_misc (line 3044)

Adds misc.

data to the profile

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

- array $data

invite (line 1937)

Invites a chatter

- access: public

void invite (string $chatter)

- string $chatter

invite_private (line 2906)
void invite_private (mixed $from, mixed $to)
is_authorized (line 1715)

Authentication of given nickname

- access: public

boolean is_authorized (string $user, string $password)

- string $user
- string $password

is_authorized_for (line 566)
void is_authorized_for (mixed $channel)
is_banned (line 463)

Provides the status of chatter

- access: public

boolean is_banned (mixed $channel)
is_disabled (line 434)
void is_disabled ()
is_friend (line 2016)

Checks if given chatter it's a friend

- access: public

boolean is_friend (string $chatter)

- string $chatter

is_grade (line 975)
void is_grade (mixed $grade)
is_group_member (line 2298)

Gets all groups where current chatter is a member

- access: public

boolean is_group_member (mixed $group_name)
is_guest (line 1218)

Provides the guest flag

- access: public

void is_guest ()
is_ignored (line 1795)

Finds given chatter in ignore list

- access: public

boolean is_ignored (string $sender)

- string $sender

is_invited (line 1975)

Searches invited chatters for chatter and returns true if it is found in the array, false otherwise.

- access: public

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

- string $chatter
- array &$invited_chatters

is_kicked (line 423)

Provides the status of chatter

- access: public

boolean is_kicked ()
is_moderator (line 401)

Provides the status of chatter

- access: public

boolean is_moderator ()
is_online (line 446)

Provides the online status of chatter

- access: public

boolean is_online ()
is_operator (line 584)

Provides the status of chatter

- access: public

boolean is_operator ()
is_registered (line 1470)
void is_registered ()
is_vip (line 412)

Provides the status of chatter

- access: public

boolean is_vip ()
join_channel (line 509)

Changes the channel

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

Cleans the chatter instance in database

- access: public

void mkinstance_clean ()
mkinstance_persist (line 1874)

Writes the chatter object into the database

- access: public

void mkinstance_persist ()
refresh (line 686)

Refreshs chatter's online time

- see: Chatter::go_online()
- access: public

void refresh (string 0)

- string 0

register (line 1488)

Register a new user

- access: public

boolean register ()
send_passwd (line 1549)
void send_passwd ()
set_advice (line 2653)

Sets the advice flag

null = no advice alert = javascript alert sound = play a soundfile

- access: public

string set_advice (mixed $advice)
set_aimNickname (line 1057)

Sets AIM nickname of chatter

- access: public

boolean set_aimNickname (mixed $aimNickname)
set_birthday (line 1105)

Sets the birthday of chatter

- access: public

boolean set_birthday (mixed $birthday)
set_bodies (line 2427)

Sets or unsets the bodies flag of chatter

- see: Chatter::get_bodies()
- access: public

void set_bodies ([boolean $bool = true])

- boolean $bool

set_color (line 2477)

Sets the text color of chatter

- access: public

void set_color (string $color)

- string $color

set_db_instance_lifetime (line 1921)
void set_db_instance_lifetime ()
set_db_status (line 2247)

Sets status of chatter in database

boolean set_db_status (mixed $status)
set_email (line 1008)

Sets the email address of chatter

- access: public

void set_email (mixed $email)
set_gender (line 1141)

Sets the gender of chatter

- access: public

boolean set_gender (mixed $gender)
set_grade (line 2119)

Sets the grade of chatter if nesessary

- access: public

boolean set_grade (mixed $grades)
set_hide (line 1178)

hides attributes

- access: public

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

Sets a home page URL of chatter

- access: public

boolean set_homePageURL (mixed $url)
set_icqNumber (line 1034)

Sets icq number of chatter

- access: public

boolean set_icqNumber (mixed $icqNumber)
set_interests (line 1310)

Sets interests of chatter

- access: public

string set_interests (mixed $interests)
set_motto (line 1335)

Sets motto of chatter

- access: public

string set_motto (mixed $motto)
set_name (line 982)

Sets the user name of chatter

- access: public

void set_name (mixed $user)
set_nick (line 817)

Sets the nickname of chatter Used while registration

- access: public

void set_nick (mixed $user)
set_online_time (line 717)

Sets chatter's online time

- see: Chatter::refresh()
- access: public

void set_online_time (integer $time)

- integer $time

set_password (line 923)

Sets the user name of chatter

- access: public

void set_password (mixed $password)
set_pictureURL (line 1240)

Sets a pictureURL of chatter

- access: public

boolean set_pictureURL (mixed $url)
set_private (line 2404)

Sets or unsets the private flag of chatter

- access: public

void set_private ([boolean $bool = true])

- boolean $bool

set_scrollspeed (line 2697)

Sets the scrollspeed of the output frame

- see: configure.php
- access: public

void set_scrollspeed (integer $speed)

- integer $speed

set_sys_msg (line 2453)

Sets or unsets the system messages flag of chatter

Chatters can hide the messages sent by the system

- access: public

void set_sys_msg ([boolean $bool = true])

- boolean $bool

set_theme (line 2510)

Sets the choosen theme of chatter

- access: public

void set_theme (string $theme)

- string $theme

set_user (line 1023)

Sets user name of chatter

- access: public

void set_user (mixed $user)
set_yimNickname (line 1081)

Sets YIM nickname of chatter

- access: public

boolean set_yimNickname (mixed $yimNickname)
test (line 3095)

Test class Chatter

call like this: Chatter::test();

void test ()
unignore (line 1783)

Removes the given chatter from ignore list

- access: public

void unignore (string $chatter)

- string $chatter

unlock_channel (line 572)
void unlock_channel (mixed $channel)
update (line 1643)

Updates chatter's profile data

- access: public

boolean update ()
update_stats (line 2186)
void update_stats ()

Documention generated on Fri, 2 May 2003 10:50:43 +0200 by phpDocumentor 1.2.0rc2