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)

void get_friends ()

get_friends_as_option_list (line 2202)

Returns all friends as an html-option list

access: public

string get_friends_as_option_list ()

get_gender (line 1245)

Provides gender of chatter

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

string get_gender ()

get_grade (line 1060)

Gets grade of chatter

access: public

string get_grade ()

get_hide (line 1256)

checks if chatter has something to hide

access: public

boolean get_hide (mixed $attribute)

get_hit_count (line 1524)

Provides the hit count of a given page

void get_hit_count (mixed $page)

get_homePageURL (line 1380)

Gets the homePageURL of chatter

access: public

string get_homePageURL ()

get_icqNumber (line 1138)

Provides the icq number of chatter

access: public

integer get_icqNumber ()

get_ignored_sender (line 1927)

Provides the ignore list of chatter

access: public

array get_ignored_sender ()

get_interests (line 1391)

Gets interests of chatter

access: public

string get_interests ()

get_lastActive (line 2851)

Provides the last active time of chatter

access: public

string get_lastActive ()

get_last_Host (line 2862)

Provides the last host of chatter

access: public

string get_last_Host ()

get_last_IP (line 2873)

Provides the last IP of chatter

access: public

string get_last_IP ()

get_last_Referer (line 2895)

Provides the last referer of chatter

access: public

string get_last_Referer ()

get_last_SessionId (line 2906)

Provides the last referer of chatter

access: public

string get_last_SessionId ()

get_last_UserAgent (line 2884)

Provides the last user agent of chatter

access: public

string get_last_UserAgent ()

get_lines_per_day (line 2383)

void get_lines_per_day ()

get_line_styles (line 2754)

Provides all defined line styles for other chatters

access: public

array get_line_styles ()

get_line_style_for (line 2765)

Provides the styles for a given chatter

access: public

string get_line_style_for (mixed $nick)

get_logins_per_day (line 2388)

void get_logins_per_day ()

get_motto (line 1416)

Gets interests of chatter

access: public

string get_motto ()

get_name (line 1087)

Gets the name of chatter

access: public

string get_name ()

get_nick (line 1803)

Returns the nickname of chatter

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

Provides chatter's online time

access: public

integer get_online_time ()

get_password (line 1027)

Gets the password of chatter

access: public

string get_password ()

get_pictureURL (line 1369)

Gets the pictureURL of chatter

access: public

string get_pictureURL ()

get_private (line 2615)

Provides the private flag of chatter

access: public

void get_private (boolean 0)

boolean 0

get_profile_misc (line 3346)

Provides miscellaneous profile data

array get_profile_misc ()

get_regTime (line 2840)

Provides the registration time of chatter

access: public

string get_regTime ()

get_regulars_table_rank (line 3289)

Searches the regular's table

integer get_regulars_table_rank ()

get_scrollspeed (line 3010)

Provides the scrollspeed of the output frame

access: public

integer get_scrollspeed ()

get_sys_msg (line 2666)

Gets the system messages flag of chatter

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

Provides the choosen theme of chatter

access: public

string get_theme ()

get_user (line 1038)

Gets user name of chatter

access: public

string get_user ()

get_yimNickname (line 1186)

Provides the YIM nickname of chatter

access: public

integer get_yimNickname ()

go_offline (line 837)

Sets chatter status to offline

see: Chatter::go_online()
access: public

void go_offline (string $channel)

string $channel

go_online (line 719)

Sets chatter status to online

see: Chatter::go_offline()
access: public

void go_online (string $channel)

string $channel

halt (line 1938)

Halt Chatter (accept no lines, print no lines)

access: public

void halt (string 0)

string 0

has_birthday (line 1221)

Provides birthday of chatter

access: public

string has_birthday ()

ignore (line 1885)

Adds the given chatter to ignore list

access: public

void ignore (string $chatter)

string $chatter

init_additional_profile_data (line 973)

Initializes additional data of chatter stored in DB

access: private

void init_additional_profile_data ()

insert_profile_misc (line 3321)

Adds misc.

Adds misc. data to the profile

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

array $data

invite (line 2106)

Invites a chatter

access: public

void invite (string $chatter)

string $chatter

invite_private (line 3192)

void invite_private (mixed $from, mixed $to)

is_authorized (line 1823)

Authentication of given nickname

access: public

boolean is_authorized (string $user, string $password)

string $user
string $password

is_authorized_for (line 625)

void is_authorized_for (mixed $channel)

is_banned (line 477)

Provides the status of chatter

access: public

boolean is_banned (mixed $channel)

is_disabled (line 448)

void is_disabled ()

is_friend (line 2185)

Checks if given chatter it's a friend

access: public

boolean is_friend (string $chatter)

string $chatter

is_grade (line 1064)

void is_grade (mixed $grade)

is_group_member (line 2480)

Gets all groups where current chatter is a member

access: public

boolean is_group_member (mixed $group_name, mixed $channel_name)

is_guest (line 1310)

Provides the guest flag

access: public

void is_guest ()

is_halted (line 1945)

void is_halted ()

is_ignored (line 1916)

Finds given chatter in ignore list

access: public

boolean is_ignored (string $sender)

string $sender

is_invited (line 2144)

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

Provides the status of chatter

access: public

boolean is_kicked ()

is_moderator (line 415)

Provides the status of chatter

access: public

boolean is_moderator ()

is_online (line 460)

Provides the online status of chatter

access: public

boolean is_online ()

is_operator (line 656)

Provides the status of chatter

access: public

boolean is_operator ()

is_registered (line 1562)

void is_registered ()

is_vip (line 426)

Provides the status of chatter

access: public

boolean is_vip ()

join_channel (line 523)

Changes the channel

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

lock_channel (line 642)

void lock_channel (mixed $channel)

mkinstance_clean (line 2070)

Cleans the chatter instance in database

access: public

void mkinstance_clean ()

mkinstance_persist (line 2043)

Writes the chatter object into the database

access: public

void mkinstance_persist ()

refresh (line 765)

Refreshs chatter's online time

see: Chatter::go_online()
access: public

void refresh (string 0)

string 0

access: public

boolean register ()

resume (line 1942)

void resume ()

send_passwd (line 1643)

void send_passwd ()

set_advice (line 2939)

Sets the advice flag

Sets the advice flag null = no advice alert = javascript alert sound = play a soundfile

access: public

string set_advice (mixed $advice)

set_aimNickname (line 1149)

Sets AIM nickname of chatter

access: public

boolean set_aimNickname (mixed $aimNickname)

set_away (line 2016)

Sets the AWAY-status in DB

access: private

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

boolean $away
string $away_msg

set_birthday (line 1197)

Sets the birthday of chatter

access: public

boolean set_birthday (mixed $birthday)

set_bodies (line 2627)

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

Sets the text color of chatter

access: public

void set_color (string $color)

string $color

set_db_friends (line 2247)

Sets friends list in database

access: private

null set_db_friends (string $friends)

string $friends

set_db_instance_lifetime (line 2090)

void set_db_instance_lifetime ()

set_db_invited (line 1987)

Writes the array of invited chatters into the database

access: private

void set_db_invited (array $invited_chatters)

array $invited_chatters

set_db_status (line 2423)

Sets status of chatter in database

boolean set_db_status (mixed $status)

set_email (line 1098)

Sets the email address of chatter

access: public

void set_email (string $email)

string $email: Mail address of a new chatter

set_gender (line 1233)

Sets the gender of chatter

access: public

boolean set_gender (mixed $gender)

set_grade (line 2288)

Sets the grade of chatter if nesessary

access: public

boolean set_grade (mixed $grades)

set_hide (line 1270)

hides attributes

access: public

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

set_homePageURL (line 1354)

Sets a home page URL of chatter

access: public

boolean set_homePageURL (mixed $url)

set_icqNumber (line 1126)

Sets icq number of chatter

access: public

boolean set_icqNumber (mixed $icqNumber)

set_interests (line 1402)

Sets interests of chatter

access: public

string set_interests (mixed $interests)

set_line_style_for (line 2779)

Sets the styles for a given chatter

access: public

boolean set_line_style_for (string $nick, string $style)

string $nick
string $style

set_motto (line 1427)

Sets motto of chatter

access: public

string set_motto (mixed $motto)

set_name (line 1071)

Sets the user name of chatter

access: public

void set_name (mixed $user)

set_nick (line 898)

Sets the nickname of chatter

Sets the nickname of chatter Used while registration

access: public

void set_nick (mixed $user)

set_online_time (line 796)

Sets chatter's online time

see: Chatter::refresh()
access: public

void set_online_time (integer $time)

integer $time

set_password (line 996)

Sets the user name of chatter

access: public

void set_password (mixed $password)

set_password_new (line 1016)

Sets user a new password

access: public

void set_password_new (string $passwd)

string $passwd

set_pictureURL (line 1332)

Sets a pictureURL of chatter

access: public

boolean set_pictureURL (mixed $url)

set_private (line 2604)

Sets or unsets the private flag of chatter

access: public

void set_private ([boolean $bool = true])

boolean $bool

set_scrollspeed (line 2983)

Sets the scrollspeed of the output frame

see: configure.php
access: public

void set_scrollspeed (integer $speed)

integer $speed

set_sys_msg (line 2653)

Sets or unsets the system messages flag of chatter

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

Sets the choosen theme of chatter

access: public

void set_theme (string $theme)

string $theme

set_user (line 1115)

Sets user name of chatter

access: public

void set_user (mixed $user)

set_yimNickname (line 1173)

Sets YIM nickname of chatter

access: public

boolean set_yimNickname (mixed $yimNickname)

test (line 3372)

Test class Chatter

Test class Chatter call like this: Chatter::test();

void test ()

unignore (line 1904)

Removes the given chatter from ignore list

access: public

void unignore (string $chatter)

string $chatter

unlock_channel (line 636)

void unlock_channel (mixed $channel)

update (line 1747)

Updates chatter's profile data

access: public

boolean update ([boolean $pwd_only = false])

boolean $pwd_only

update_stats (line 2355)

void update_stats ()

_send_confirmation_mail (line 1668)

Sends a mail to the new chatter

see: Chatter::register()
access: private

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

_set_db_attributes (line 931)

Sets all attributes of chatter stored in DB

access: private

void _set_db_attributes ()

_update_line_style (line 2809)

Updates styles for a given chatter

access: private

boolean _update_line_style ()

Documentation generated on Tue, 29 Jun 2004 14:42:00 +0200 by phpDocumentor 1.3.0RC3