## Class Line

Description

Class Line holds lines written by chatters

- version: $Id: class.Line.inc,v 1.42 2003/04/29 16:22:44 letreo Exp $
- access: public
- author: Michael Oertel <michael@ortelius.de>
- author: Frerk Meyer <frerk@meychern.de>
- todo: rewrite of method filter_input_buffer() based on preg_replace()

Located in Program_Root/include/class.Line.inc (line 44)

Variable Summary
boolean $approved
object $chatter
boolean $info
boolean $invitationMsg
boolean $in_private_window
array $irc_command
string $join
string $leave
array $mime_types
object $recipient
string $said
boolean $sender_busy
integer $smiley_count
boolean $whispered
Method Summary
void Line (object $chatter, string $said, object 2)
null filter_buffer_input ()
null filter_buffer_output (object 0)
null filter_irc ()
boolean get_approved ()
object get_chatter ()
boolean get_invitationMsg ()
string get_irc_command ()
string get_leave ()
string get_login ()
object get_recipient ()
string get_said ()
void get_sender ()
boolean get_sender_busy ()
object get_whispered ()
boolean in_private_window ()
boolean is_info ()
void is_invitationMsg ()
void is_leavingMsg ()
void is_loginMsg ()
void is_sender_busy ()
void is_whispered ()
string out ()
void set_accepted_mime_types (array $types)
void set_approved ([boolean $bool = true])
void set_chatter (mixed $sender)
void set_info ([boolean $bool = true])
void set_invitationMsg ([boolean $bool = true])
void set_in_private_window ([boolean $bool = true])
string set_leave (mixed $leave)
string set_login (mixed $login)
void set_recipient (object $recipient)
void set_said (string $said)
void set_sender (object $sender)
void set_sender_busy ([boolean $bool = true])
boolean set_whispered ([boolean $bool = true])
void test ()
void _mk_smiley_img_tag (mixed $smiley)
Variables
boolean $approved = false (line 79)

true if line is approved by a moderator

object $chatter = null (line 51)

chatter object represents a person taking part in a chat session

boolean $info = false (line 136)
boolean $invitationMsg = false (line 107)

marks a line as invitation message

boolean $in_private_window = false (line 114)

private window flag

array $irc_command = array() (line 86)

contains an irc-command found in the line

string $join (line 126)
string $leave (line 131)
array $mime_types = array() (line 93)

contains accepted mime types for private images

object $recipient = null (line 58)

recipient object represents a person receiving a chat message

string $said (line 65)

string said by chatter

boolean $sender_busy = false (line 121)

sender busy flag

integer $smiley_count (line 100)

counts smileys within a line

boolean $whispered = false (line 72)

true if line is whispered

Methods
Constructor Line (line 145)

Constructor for class Line

void Line (object $chatter, string $said, object 2)

- object $chatter: chatter object represents a person taking part in a chat session
- string $said: string said by chatter
- object 2: recipient of the text line

filter_buffer_input (line 570)

Filters icons, links, etc.

in $said

null filter_buffer_input ()
filter_buffer_output (line 616)

Filters 'says to', 'leaves us', ...

messages within output frame

used in getlines.php only

null filter_buffer_output (object 0)

- object 0: Translator

filter_irc (line 552)

Filters irc-commands in $said

null filter_irc ()
get_approved (line 340)

Gets approved flag

boolean get_approved ()
get_chatter (line 163)

Getter for chatter object

object get_chatter ()
get_invitationMsg (line 212)

Provides the invitationMsg flag

boolean get_invitationMsg ()
get_irc_command (line 350)

Gets the irc-command of line

string get_irc_command ()
get_leave (line 370)

Provides the nickname of the chatter who is leaving the chat.

string get_leave ()
get_login (line 360)

Provides the nickname of the chatter who is logging in.

string get_login ()
get_recipient (line 181)

Getter for recipient object

object get_recipient ()
get_said (line 288)

Getter for said string

string get_said ()
get_sender (line 171)

- ignore:

void get_sender ()
get_sender_busy (line 267)

Getter for sender busy flag

boolean get_sender_busy ()
get_whispered (line 308)

Getter for chatter object

object get_whispered ()
in_private_window (line 670)

Provides the private window flag

boolean in_private_window ()
is_info (line 257)

Getter for info flag

boolean is_info ()
is_invitationMsg (line 216)
void is_invitationMsg ()
is_leavingMsg (line 400)
void is_leavingMsg ()
is_loginMsg (line 395)
void is_loginMsg ()
is_sender_busy (line 272)

alias for get_sender_busy()

void is_sender_busy ()
is_whispered (line 312)
void is_whispered ()
out (line 629)

Returns a formatted Line

- see: getlines.php

string out ()
set_accepted_mime_types (line 410)

Sets accepted mime types for private images

void set_accepted_mime_types (array $types)

- array $types

set_approved (line 330)

Sets approved flag

void set_approved ([boolean $bool = true])

- boolean $bool

set_chatter (line 278)

alias

- ignore:

void set_chatter (mixed $sender)
set_info (line 247)

Setter for info flag

void set_info ([boolean $bool = true])

- boolean $bool

set_invitationMsg (line 202)

Setter for invitationMsg

void set_invitationMsg ([boolean $bool = true])

- boolean $bool

set_in_private_window (line 680)

Sets the private window flag

void set_in_private_window ([boolean $bool = true])

- boolean $bool

set_leave (line 390)

Sets the nickname of the chatter who is leaving the chat.

string set_leave (mixed $leave)
set_login (line 380)

Sets the nickname of the chatter who is logging in.

string set_login (mixed $login)
set_recipient (line 191)

Setter for recipient object

void set_recipient (object $recipient)

- object $recipient

set_said (line 298)

Setter for said string

void set_said (string $said)

- string $said

set_sender (line 226)

Setter for sender object

void set_sender (object $sender)

- object $sender

set_sender_busy (line 237)

Setter for sender busy flag

void set_sender_busy ([boolean $bool = true])

- boolean $bool

set_whispered (line 320)

Setter for var $whispered

boolean set_whispered ([boolean $bool = true])

- boolean $bool

test (line 690)

Test class Line

Call like this: Line::test();

void test ()
_mk_smiley_img_tag (line 153)
void _mk_smiley_img_tag (mixed $smiley)

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