\Net_SmartIRC_irccommands

$Id$ $Revision$ $Author$ $Date$

Copyright (c) 2002-2004 Mirco Bauer meebey@meebey.net http://www.meebey.net

Full LGPL License: http://www.gnu.org/licenses/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

Summary

Methods
Properties
Constants
message()
join()
part()
kick()
getList()
names()
setTopic()
getTopic()
mode()
founder()
defounder()
admin()
deadmin()
op()
deop()
hop()
dehop()
voice()
devoice()
ban()
unban()
invite()
changeNick()
who()
whois()
whowas()
quit()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

message()

message(integer  $type, string  $destination, mixed  $messagearray, integer  $priority = SMARTIRC_MEDIUM) : boolean|\Net_SmartIRC

sends a new message

Sends a message to a channel or user.

Parameters

integer $type

specifies the type, like QUERY/ACTION or CTCP see 'Message Types'

string $destination

can be a user or channel

mixed $messagearray

the message

integer $priority

the priority level of the message

Returns

boolean|\Net_SmartIRC

join()

join(mixed  $channelarray, string  $key = null, integer  $priority = SMARTIRC_MEDIUM) : \Net_SmartIRC

Joins one or more IRC channels with an optional key.

Parameters

mixed $channelarray
string $key
integer $priority

message priority, default is SMARTIRC_MEDIUM

Returns

\Net_SmartIRC

part()

part(mixed  $channelarray, string  $reason = null, integer  $priority = SMARTIRC_MEDIUM) : \Net_SmartIRC

parts from one or more IRC channels with an optional reason

Parameters

mixed $channelarray
string $reason
integer $priority

message priority, default is SMARTIRC_MEDIUM

Returns

\Net_SmartIRC

kick()

kick(string  $channel, mixed  $nicknamearray, string  $reason = null, integer  $priority = SMARTIRC_MEDIUM) : \Net_SmartIRC

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

Parameters

string $channel
mixed $nicknamearray
string $reason
integer $priority

message priority, default is SMARTIRC_MEDIUM

Returns

\Net_SmartIRC

getList()

getList(mixed  $channelarray = null, integer  $priority = SMARTIRC_MEDIUM) : \Net_SmartIRC

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)

Parameters

mixed $channelarray
integer $priority

message priority, default is SMARTIRC_MEDIUM

Returns

\Net_SmartIRC

names()

names(mixed  $channelarray = null, integer  $priority = SMARTIRC_MEDIUM) : \Net_SmartIRC

requests all nicknames of one or more channels

The requested nickname list also includes op and voice state

Parameters

mixed $channelarray
integer $priority

message priority, default is SMARTIRC_MEDIUM

Returns

\Net_SmartIRC

setTopic()

setTopic(string  $channel, string  $newtopic, integer  $priority = SMARTIRC_MEDIUM) : \Net_SmartIRC

sets a new topic of a channel

Parameters

string $channel
string $newtopic
integer $priority

message priority, default is SMARTIRC_MEDIUM

Returns

\Net_SmartIRC

getTopic()

getTopic(string  $channel, integer  $priority = SMARTIRC_MEDIUM) : \Net_SmartIRC

gets the topic of a channel

Parameters

string $channel
integer $priority

message priority, default is SMARTIRC_MEDIUM

Returns

\Net_SmartIRC

mode()

mode(string  $target, string  $newmode = null, integer  $priority = SMARTIRC_MEDIUM) : \Net_SmartIRC

sets or gets the mode of an user or channel

Changes/requests the mode of the given target.

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

Returns

\Net_SmartIRC

founder()

founder(string  $channel, string  $nickname, integer  $priority = SMARTIRC_MEDIUM) : \Net_SmartIRC

founders an user in the given channel

Parameters

string $channel
string $nickname
integer $priority

message priority, default is SMARTIRC_MEDIUM

Returns

\Net_SmartIRC

defounder()

defounder(string  $channel, string  $nickname, integer  $priority = SMARTIRC_MEDIUM) : \Net_SmartIRC

defounders an user in the given channel

Parameters

string $channel
string $nickname
integer $priority

message priority, default is SMARTIRC_MEDIUM

Returns

\Net_SmartIRC

admin()

admin(string  $channel, string  $nickname, integer  $priority = SMARTIRC_MEDIUM) : \Net_SmartIRC

admins an user in the given channel

Parameters

string $channel
string $nickname
integer $priority

message priority, default is SMARTIRC_MEDIUM

Returns

\Net_SmartIRC

deadmin()

deadmin(string  $channel, string  $nickname, integer  $priority = SMARTIRC_MEDIUM) : \Net_SmartIRC

deadmins an user in the given channel

Parameters

string $channel
string $nickname
integer $priority

message priority, default is SMARTIRC_MEDIUM

Returns

\Net_SmartIRC

op()

op(string  $channel, string  $nickname, integer  $priority = SMARTIRC_MEDIUM) : \Net_SmartIRC

ops an user in the given channel

Parameters

string $channel
string $nickname
integer $priority

message priority, default is SMARTIRC_MEDIUM

Returns

\Net_SmartIRC

deop()

deop(string  $channel, string  $nickname, integer  $priority = SMARTIRC_MEDIUM) : \Net_SmartIRC

deops an user in the given channel

Parameters

string $channel
string $nickname
integer $priority

message priority, default is SMARTIRC_MEDIUM

Returns

\Net_SmartIRC

hop()

hop(string  $channel, string  $nickname, integer  $priority = SMARTIRC_MEDIUM) : \Net_SmartIRC

hops an user in the given channel

Parameters

string $channel
string $nickname
integer $priority

message priority, default is SMARTIRC_MEDIUM

Returns

\Net_SmartIRC

dehop()

dehop(string  $channel, string  $nickname, integer  $priority = SMARTIRC_MEDIUM) : \Net_SmartIRC

dehops an user in the given channel

Parameters

string $channel
string $nickname
integer $priority

message priority, default is SMARTIRC_MEDIUM

Returns

\Net_SmartIRC

voice()

voice(string  $channel, string  $nickname, integer  $priority = SMARTIRC_MEDIUM) : \Net_SmartIRC

voice a user in the given channel

Parameters

string $channel
string $nickname
integer $priority

message priority, default is SMARTIRC_MEDIUM

Returns

\Net_SmartIRC

devoice()

devoice(string  $channel, string  $nickname, integer  $priority = SMARTIRC_MEDIUM) : \Net_SmartIRC

devoice a user in the given channel

Parameters

string $channel
string $nickname
integer $priority

message priority, default is SMARTIRC_MEDIUM

Returns

\Net_SmartIRC

ban()

ban(string  $channel, string  $hostmask = null, integer  $priority = SMARTIRC_MEDIUM) : \Net_SmartIRC

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

The banlist will be requested if no hostmask is specified

Parameters

string $channel
string $hostmask
integer $priority

message priority, default is SMARTIRC_MEDIUM

Returns

\Net_SmartIRC

unban()

unban(string  $channel, string  $hostmask, integer  $priority = SMARTIRC_MEDIUM) : \Net_SmartIRC

unbans a hostmask on the given channel

Parameters

string $channel
string $hostmask
integer $priority

message priority, default is SMARTIRC_MEDIUM

Returns

\Net_SmartIRC

invite()

invite(string  $nickname, string  $channel, integer  $priority = SMARTIRC_MEDIUM) : \Net_SmartIRC

invites a user to the specified channel

Parameters

string $nickname
string $channel
integer $priority

message priority, default is SMARTIRC_MEDIUM

Returns

\Net_SmartIRC

changeNick()

changeNick(string  $newnick, integer  $priority = SMARTIRC_MEDIUM) : \Net_SmartIRC

changes the own nickname

Trys to set a new nickname, nickcollisions are handled.

Parameters

string $newnick
integer $priority

message priority, default is SMARTIRC_MEDIUM

Returns

\Net_SmartIRC

who()

who(string  $target, integer  $priority = SMARTIRC_MEDIUM) : \Net_SmartIRC

requests a 'WHO' from the specified target

Parameters

string $target
integer $priority

message priority, default is SMARTIRC_MEDIUM

Returns

\Net_SmartIRC

whois()

whois(string  $target, integer  $priority = SMARTIRC_MEDIUM) : \Net_SmartIRC

requests a 'WHOIS' from the specified target

Parameters

string $target
integer $priority

message priority, default is SMARTIRC_MEDIUM

Returns

\Net_SmartIRC

whowas()

whowas(string  $target, integer  $priority = SMARTIRC_MEDIUM) : \Net_SmartIRC

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

Parameters

string $target
integer $priority

message priority, default is SMARTIRC_MEDIUM

Returns

\Net_SmartIRC

quit()

quit(string  $quitmessage = null, integer  $priority = SMARTIRC_CRITICAL) : \Net_SmartIRC

sends QUIT to IRC server and disconnects

Parameters

string $quitmessage

optional quitmessage

integer $priority

message priority, default is SMARTIRC_CRITICAL

Returns

\Net_SmartIRC