Docs For Class Line

Line

Description

Class Line holds lines written by chatters

version: $Id: class.Line.inc,v 1.54 2004/05/27 09:16:51 jjaeschke Exp $
access: public
author: Frerk Meyer <frerk@meychern.de>
author: Michael Oertel <michael@ortelius.de>
todo: rewrite of method filter_input_buffer() based on preg_replace()

Located in /include/class.Line.inc (line 46)

Variable Summary

boolean $approved

string $channel

object $chatter

boolean $hidden

boolean $hidden_javascript_update

boolean $info

boolean $invitationMsg

boolean $in_private_window

array $irc_command

string $join

string $leave

array $mime_types

object $recipient

string $said

string $said_raw

boolean $sender_busy

integer $smiley_count

boolean $whispered

Method Summary

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

null filter_buffer_input ()

null filter_buffer_output (object Translator 0)

null filter_irc ()

boolean get_approved ()

void get_channel ()

object get_chatter ()

boolean get_hidden ()

boolean get_invitationMsg ()

string get_irc_command ()

string get_leave ()

string get_login ()

object get_recipient ()

string get_said ()

string get_said_raw ()

void get_sender ()

boolean get_sender_busy ()

boolean get_whispered ()

boolean in_private_window ()

void is_hidden ()

void is_hidden_javascript_update ()

boolean is_info ()

void is_invitationMsg ()

void is_leavingMsg ()

void is_loginMsg ()

void is_sender_busy ()

void is_whispered ()

void log ()

string out ()

void set_accepted_mime_types (array $types)

void set_approved ([boolean $bool = true])

void set_channel (string $channel)

boolean set_hidden ([boolean $bool = true])

boolean set_hidden_javascript_update ([boolean $bool = true])

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_said_raw (string $said_raw)

void set_sender (object $sender)

void set_sender_busy ([boolean $bool = true])

boolean set_whispered ([boolean $bool = true])

void test ()

string _mk_smiley_img_tag (mixed $smiley)

string _smiley_mapping (string $code)

Variables

boolean $approved = false (line 105)

true if line is approved by a moderator

string $channel = '' (line 167)

object $chatter = null (line 53)

chatter object represents a person taking part in a chat session

boolean $hidden = false (line 91)

true if line is hidden

true if line is hidden hidden means the line contains something like javascript code or something else

boolean $hidden_javascript_update = false (line 98)

true if contains javascript to update all clients

boolean $info = false (line 162)

boolean $invitationMsg = false (line 133)

marks a line as invitation message

boolean $in_private_window = false (line 140)

private window flag

array $irc_command = array() (line 112)

contains an irc-command found in the line

string $join = '' (line 152)

string $leave = '' (line 157)

array $mime_types = array() (line 119)

contains accepted mime types for private images

object $recipient = null (line 60)

recipient object represents a person receiving a chat message

string $said = '' (line 67)

string said by chatter

string $said_raw = '' (line 74)

raw string said by chatter (i.

raw string said by chatter (i.e. without html-replacements)

boolean $sender_busy = false (line 147)

sender busy flag

integer $smiley_count = 0 (line 126)

counts smileys within a line

boolean $whispered = false (line 81)

true if line is whispered

Methods

Constructor Line (line 176)

Constructor for class Line

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

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

filter_buffer_input (line 712)

Filters icons, links, etc.

Filters icons, links, etc. in $said

todo: replace eregi_replace with preg_replace.

null filter_buffer_input ()

filter_buffer_output (line 761)

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

Filters 'says to', 'leaves us', ... messages within output frame used in getlines.php only

null filter_buffer_output (object Translator 0)

object Translator 0

filter_irc (line 692)

Filters irc-commands in $said

null filter_irc ()

get_approved (line 447)

Gets approved flag

boolean get_approved ()

get_channel (line 862)

Gets the where line was spoken

void get_channel ()

get_chatter (line 199)

Getter for chatter object

object get_chatter ()

get_hidden (line 399)

Getter for var $hidden

boolean get_hidden ()

get_invitationMsg (line 249)

Provides the invitationMsg flag

boolean get_invitationMsg ()

get_irc_command (line 457)

Gets the irc-command of line

string get_irc_command ()

get_leave (line 477)

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

string get_leave ()

get_login (line 467)

Provides the nickname of the chatter who is logging in.

string get_login ()

get_recipient (line 218)

Getter for recipient object

object get_recipient ()

get_said (line 337)

Getter for said string

string get_said ()

get_said_raw (line 357)

Getter for said_raw string

string get_said_raw ()

get_sender (line 208)

alias for get chatter

see: Line::get_chatter()

void get_sender ()

get_sender_busy (line 312)

Getter for sender busy flag

Getter for sender busy flag if is set, the chatter is using the private chat window and so hi is bussy to chat private with another one

boolean get_sender_busy ()

get_whispered (line 377)

Getter for var $whispered

boolean get_whispered ()

in_private_window (line 819)

Provides the private window flag

Provides the private window flag if is set, the line will be displayed in the private chat window only

boolean in_private_window ()

is_hidden (line 403)

void is_hidden ()

is_hidden_javascript_update (line 405)

void is_hidden_javascript_update ()

is_info (line 299)

Getter for info flag

boolean is_info ()

is_invitationMsg (line 258)

alias for get_invitationMsg

see: Line::get_invitationMsg()

void is_invitationMsg ()

is_leavingMsg (line 507)

void is_leavingMsg ()

is_loginMsg (line 502)

void is_loginMsg ()

is_sender_busy (line 321)

alias for get_sender_busy()

see: get_sender_busy(

void is_sender_busy ()

is_whispered (line 381)

void is_whispered ()

log (line 837)

log line

void log ()

out (line 776)

Returns a formatted line,

Returns a formatted line, but at this time only used to format the locally displayed lines!

see: getlines.php
todo: use this function in getlines also

string out ()

set_accepted_mime_types (line 517)

Sets accepted mime types for private images

void set_accepted_mime_types (array $types)

array $types

set_approved (line 437)

Sets approved flag

void set_approved ([boolean $bool = true])

boolean $bool

set_channel (line 871)

Sets the where line was spoken

void set_channel (string $channel)

string $channel

set_hidden (line 416)

Setter for var $hidden

boolean set_hidden ([boolean $bool = true])

boolean $bool

set_hidden_javascript_update (line 427)

Setter for var $hidden_javascript_update

boolean set_hidden_javascript_update ([boolean $bool = true])

boolean $bool

set_info (line 289)

Setter for info flag

void set_info ([boolean $bool = true])

boolean $bool

set_invitationMsg (line 239)

Setter for invitationMsg

void set_invitationMsg ([boolean $bool = true])

boolean $bool

set_in_private_window (line 829)

Sets the private window flag

void set_in_private_window ([boolean $bool = true])

boolean $bool

set_leave (line 497)

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

string set_leave (mixed $leave)

set_login (line 487)

Sets the nickname of the chatter who is logging in.

string set_login (mixed $login)

set_recipient (line 228)

Setter for recipient object

void set_recipient (object $recipient)

object $recipient

set_said (line 347)

Setter for said string

void set_said (string $said)

string $said

set_said_raw (line 367)

Setter for said_raw string

void set_said_raw (string $said_raw)

string $said_raw

set_sender (line 268)

Setter for sender object

void set_sender (object $sender)

object $sender

set_sender_busy (line 279)

Setter for sender busy flag

void set_sender_busy ([boolean $bool = true])

boolean $bool

set_whispered (line 389)

Setter for var $whispered

boolean set_whispered ([boolean $bool = true])

boolean $bool

test (line 880)

Test class Line

Test class Line Call like this: Line::test();

void test ()

_mk_smiley_img_tag (line 189)

provides the HTML code for a chosen smiley

return: HTML image tag
access: private

string _mk_smiley_img_tag (mixed $smiley)

_smiley_mapping (line 529)

Returns a file name for the given smiley

access: private

string _smiley_mapping (string $code)

string $code

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