Class: Net_SmartIRC_irccommands

Source Location: /Net_SmartIRC-1.0.0/SmartIRC/irccommands.php

Class Overview

Net_SmartIRC_base
   |
   --Net_SmartIRC_irccommands

$Id: irccommands.php,v 1.1.2.1 2003/10/10 20:20:58 meebey Exp $

Author(s):

Mirco 'meebey' Bauer <mailto:mail at meebey.net>

Version:

0.5.5

Child classes:

Net_SmartIRC_messagehandler: $Id: messagehandler.php,v 1.25.2.5 2004/09/23 23:24:22 meebey Exp $

Inherited Variables

Class: Net_SmartIRC_base

Net_SmartIRC_base::$channel
Net_SmartIRC_base::$nreplycodes
Net_SmartIRC_base::$replycodes

Inherited Methods

Class: Net_SmartIRC_base

Net_SmartIRC_base::Net_SmartIRC_base(): Constructor. Initiales the messagebuffer and "links" the replycodes from global into properties. Also some PHP runtime settings are configured.
Net_SmartIRC_base::connect(): Creates the sockets and connects to the IRC server on the given port.
Net_SmartIRC_base::disconnect(): Disconnects from the IRC server nicely with a QUIT or just destroys the socket.
Net_SmartIRC_base::getMotd(): Returns the full motd.
Net_SmartIRC_base::getUsermode(): Returns the usermode.
Net_SmartIRC_base::isBanned(): Checks if the hostmask is on the specified channel banned and returns the result.
Net_SmartIRC_base::isError()
Net_SmartIRC_base::isJoined(): checks if we or the given user is joined to the specified channel and returns the result ChannelSyncing is required for this.
Net_SmartIRC_base::isOpped(): Checks if we or the given user is opped on the specified channel and returns the result.
Net_SmartIRC_base::isVoiced(): Checks if we or the given user is voiced on the specified channel and returns the result.
Net_SmartIRC_base::listen(): goes into receive mode
Net_SmartIRC_base::listenFor(): waits for a special message type and puts the answer in $result
Net_SmartIRC_base::log(): Adds an entry to the log.
Net_SmartIRC_base::login(): login and register nickname on the IRC network
Net_SmartIRC_base::objListenFor(): waits for a special message type and puts the answer in $result
Net_SmartIRC_base::reconnect(): Reconnects to the IRC server with the same login info, it also rejoins the channels
Net_SmartIRC_base::registerActionhandler(): registers a new actionhandler and returns the assigned id
Net_SmartIRC_base::registerTimehandler(): registers a timehandler and returns the assigned id
Net_SmartIRC_base::setAutoReconnect(): Enables/disables autoreconnecting.
Net_SmartIRC_base::setAutoRetry(): Enables/disables autoretry for connecting to a server.
Net_SmartIRC_base::setBenchmark(): Enables/disables the benchmark engine.
Net_SmartIRC_base::setChannelSynching(): Deprecated, use setChannelSyncing() instead!
Net_SmartIRC_base::setChannelSyncing(): Enables/disables channel syncing.
Net_SmartIRC_base::setCtcpVersion(): Sets the CTCP version reply string.
Net_SmartIRC_base::setDebug(): Sets the level of debug messages.
Net_SmartIRC_base::setDisconnecttime(): Sets the delaytime before closing the socket when disconnect.
Net_SmartIRC_base::setLogdestination(): Sets the destination of all log messages.
Net_SmartIRC_base::setLogfile(): Sets the file for the log if the destination is set to file.
Net_SmartIRC_base::setReceivedelay(): Sets the delay for receiving data from the IRC server.
Net_SmartIRC_base::setReceiveTimeout(): Sets the receive timeout.
Net_SmartIRC_base::setSenddelay(): Sets the delay for sending data to the IRC server.
Net_SmartIRC_base::setTransmitTimeout(): Sets the transmit timeout.
Net_SmartIRC_base::setUseSockets(): Enables/disables the usage of real sockets.
Net_SmartIRC_base::showBenchmark(): Shows the benchmark result.
Net_SmartIRC_base::startBenchmark(): Starts the benchmark (sets the counters).
Net_SmartIRC_base::stopBenchmark(): Stops the benchmark and displays the result.
Net_SmartIRC_base::throwError()
Net_SmartIRC_base::unregisterActionhandler(): unregisters an existing actionhandler
Net_SmartIRC_base::unregisterActionid(): unregisters an existing actionhandler via the id
Net_SmartIRC_base::unregisterTimeid(): unregisters an existing timehandler via the id

Class Details

[line 27]
$Id: irccommands.php,v 1.1.2.1 2003/10/10 20:20:58 meebey Exp $

$Revision: 1.1.2.1 $ $Author: meebey $ $Date: 2003/10/10 20:20:58 $

Full LGPL License: <http://www.meebey.net/lgpl.txt>

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Version: 0.5.5
Author: Mirco 'meebey' Bauer <mailto:mail@meebey.net>

[ Top ]

Method Detail

ban [line 323]

void ban(
string
$channel, [string
$hostmask = null], [integer
$priority = SMARTIRC_MEDIUM])

bans a hostmask for the given channel or requests the current banlist

The banlist will be requested if no hostmask is specified

Access: public

Parameters:

string	`$channel`	—
string	`$hostmask`	—
integer	`$priority`	—	message priority, default is SMARTIRC_MEDIUM

[ Top ]

changeNick [line 370]

void changeNick(
string
$newnick, [integer
$priority = SMARTIRC_MEDIUM])

changes the own nickname

Trys to set a new nickname, nickcollisions are handled.

Access: public

Parameters:

string	`$newnick`	—
integer	`$priority`	—	message priority, default is SMARTIRC_MEDIUM

[ Top ]

channel [line 77]

object reference &channel(
string
$channelname)

returns an object reference to the specified channel

If the channel does not exist (because not joint) false will be returned.

Return: to the channel object
Access: public

Parameters:

string $channelname —

[ Top ]

deop [line 279]

void deop(
string
$channel, string
$nickname, [integer
$priority = SMARTIRC_MEDIUM])

deops an user in the given channel

Access: public

Parameters:

string	`$channel`	—
string	`$nickname`	—
integer	`$priority`	—	message priority, default is SMARTIRC_MEDIUM

[ Top ]

devoice [line 307]

void devoice(
string
$channel, string
$nickname, [integer
$priority = SMARTIRC_MEDIUM])

devoice a user in the given channel

Access: public

Parameters:

string	`$channel`	—
string	`$nickname`	—
integer	`$priority`	—	message priority, default is SMARTIRC_MEDIUM

[ Top ]

getList [line 171]

void getList(
[mixed
$channelarray = null], [integer
$priority = SMARTIRC_MEDIUM])

gets a list of one ore more channels

Requests a full channellist if $channelarray is not given. (use it with care, usualy its a looooong list)

Access: public

Parameters:

mixed	`$channelarray`	—
integer	`$priority`	—	message priority, default is SMARTIRC_MEDIUM

[ Top ]

getTopic [line 231]

void getTopic(
string
$channel, [integer
$priority = SMARTIRC_MEDIUM])

gets the topic of a channel

Access: public

Parameters:

string	`$channel`	—
integer	`$priority`	—	message priority, default is SMARTIRC_MEDIUM

[ Top ]

invite [line 355]

void invite(
string
$nickname, string
$channel, [integer
$priority = SMARTIRC_MEDIUM])

invites a user to the specified channel

Access: public

Parameters:

string	`$nickname`	—
string	`$channel`	—
integer	`$priority`	—	message priority, default is SMARTIRC_MEDIUM

[ Top ]

join [line 96]

void join(
mixed
$channelarray, [string
$key = null], [integer
$priority = SMARTIRC_MEDIUM])

Joins one or more IRC channels with an optional key.

Access: public

Parameters:

mixed	`$channelarray`	—
string	`$key`	—
integer	`$priority`	—	message priority, default is SMARTIRC_MEDIUM

[ Top ]

kick [line 145]

void kick(
string
$channel, mixed
$nicknamearray, [string
$reason = null], [integer
$priority = SMARTIRC_MEDIUM])

Kicks one or more user from an IRC channel with an optional reason.

Access: public

Parameters:

string	`$channel`	—
mixed	`$nicknamearray`	—
string	`$reason`	—
integer	`$priority`	—	message priority, default is SMARTIRC_MEDIUM

[ Top ]

message [line 41]

boolean message(
integer
$type, string
$destination, string
$message, [mixed
$priority = SMARTIRC_MEDIUM])

sends a new message

Sends a message to a channel or user.

Access: public
See: DOCUMENTATION

Parameters:

integer	`$type`	—	specifies the type, like QUERY/ACTION or CTCP see 'Message Types'
string	`$destination`	—	can be a user or channel
string	`$message`	—	the message

[ Top ]

mode [line 247]

void mode(
string
$target, [string
$newmode = null], [integer
$priority = SMARTIRC_MEDIUM])

sets or gets the mode of an user or channel

Changes/requests the mode of the given target.

Access: public

Parameters:

string	`$target`	—	the target, can be an user (only yourself) or a channel
string	`$newmode`	—	the new mode like +mt
integer	`$priority`	—	message priority, default is SMARTIRC_MEDIUM

[ Top ]

names [line 195]

void names(
[mixed
$channelarray = null], [integer
$priority = SMARTIRC_MEDIUM])

requests all nicknames of one or more channels

The requested nickname list also includes op and voice state

Access: public

Parameters:

mixed	`$channelarray`	—
integer	`$priority`	—	message priority, default is SMARTIRC_MEDIUM

[ Top ]

op [line 265]

void op(
string
$channel, string
$nickname, [integer
$priority = SMARTIRC_MEDIUM])

ops an user in the given channel

Access: public

Parameters:

string	`$channel`	—
string	`$nickname`	—
integer	`$priority`	—	message priority, default is SMARTIRC_MEDIUM

[ Top ]

part [line 120]

void part(
mixed
$channelarray, [string
$reason = null], [integer
$priority = SMARTIRC_MEDIUM])

parts from one or more IRC channels with an optional reason

Access: public

Parameters:

mixed	`$channelarray`	—
string	`$reason`	—
integer	`$priority`	—	message priority, default is SMARTIRC_MEDIUM

[ Top ]

quit [line 424]

void quit(
[string
$quitmessage = null], [integer
$priority = SMARTIRC_MEDIUM])

sends QUIT to IRC server and disconnects

Access: public

Parameters:

string	`$quitmessage`	—	optional quitmessage
integer	`$priority`	—	message priority, default is SMARTIRC_MEDIUM

[ Top ]

setTopic [line 218]

void setTopic(
string
$channel, string
$newtopic, [integer
$priority = SMARTIRC_MEDIUM])

sets a new topic of a channel

Access: public

Parameters:

string	`$channel`	—
string	`$newtopic`	—
integer	`$priority`	—	message priority, default is SMARTIRC_MEDIUM

[ Top ]

unban [line 341]

void unban(
string
$channel, string
$hostmask, [integer
$priority = SMARTIRC_MEDIUM])

unbans a hostmask on the given channel

Access: public

Parameters:

string	`$channel`	—
string	`$hostmask`	—
integer	`$priority`	—	message priority, default is SMARTIRC_MEDIUM

[ Top ]

voice [line 293]

void voice(
string
$channel, string
$nickname, [integer
$priority = SMARTIRC_MEDIUM])

voice a user in the given channel

Access: public

Parameters:

string	`$channel`	—
string	`$nickname`	—
integer	`$priority`	—	message priority, default is SMARTIRC_MEDIUM

[ Top ]

who [line 384]

void who(
string
$target, [integer
$priority = SMARTIRC_MEDIUM])

requests a 'WHO' from the specified target

Access: public

Parameters:

string	`$target`	—
integer	`$priority`	—	message priority, default is SMARTIRC_MEDIUM

[ Top ]

whois [line 397]

void whois(
string
$target, [integer
$priority = SMARTIRC_MEDIUM])

requests a 'WHOIS' from the specified target

Access: public

Parameters:

string	`$target`	—
integer	`$priority`	—	message priority, default is SMARTIRC_MEDIUM

[ Top ]

whowas [line 411]

void whowas(
string
$target, [integer
$priority = SMARTIRC_MEDIUM])

requests a 'WHOWAS' from the specified target (if he left the IRC network)

Access: public

Parameters:

string	`$target`	—
integer	`$priority`	—	message priority, default is SMARTIRC_MEDIUM

[ Top ]