Net_SmartIRC
[ class tree: Net_SmartIRC ] [ index: Net_SmartIRC ] [ all elements ]
Packages:
Net_SmartIRC


Classes:
Net_SmartIRC
   Net_SmartIRC
   Net_SmartIRC_irccommands
   Net_SmartIRC_messagehandler
Net_SmartIRC_base
Files:
defines.php
example.php
example2.php
example3.php
example4.php
example5.php
example6.php
example7.php
irccommands.php
messagehandler.php
SmartIRC.php

Element index for package Net_SmartIRC

[ ' ] [ b ] [ c ] [ d ] [ e ] [ g ] [ i ] [ j ] [ k ] [ l ] [ m ] [ n ] [ o ] [ p ] [ q ] [ r ] [ s ] [ t ] [ u ] [ v ] [ w ]

'

'SMARTIRC_'.$key
in file defines.php, constant 'SMARTIRC_'.$key
top

b

ban
in file irccommands.php, method Net_SmartIRC_irccommands::ban()
    bans a hostmask for the given channel or requests the current banlist
top

c

$channel
in file SmartIRC.php, variable Net_SmartIRC_base::$channel
    Stores all channels in this array where we are joined, works only if channelsyncing is activated.
connect
in file SmartIRC.php, method Net_SmartIRC_base::connect()
    Creates the sockets and connects to the IRC server on the given port.
changeNick
in file irccommands.php, method Net_SmartIRC_irccommands::changeNick()
    changes the own nickname
channel
in file irccommands.php, method Net_SmartIRC_irccommands::channel()
    returns an object reference to the specified channel
top

d

disconnect
in file SmartIRC.php, method Net_SmartIRC_base::disconnect()
    Disconnects from the IRC server nicely with a QUIT or just destroys the socket.
defines.php
procedural page defines.php
deop
in file irccommands.php, method Net_SmartIRC_irccommands::deop()
    deops an user in the given channel
devoice
in file irccommands.php, method Net_SmartIRC_irccommands::devoice()
    devoice a user in the given channel
top

e

example.php
procedural page example.php
example2.php
procedural page example2.php
example3.php
procedural page example3.php
example4.php
procedural page example4.php
example5.php
procedural page example5.php
example6.php
procedural page example6.php
example7.php
procedural page example7.php
top

g

getChannel
in file SmartIRC.php, method Net_SmartIRC_base::getChannel()
    Returns a reference to the channel object of the specified channelname.
getMotd
in file SmartIRC.php, method Net_SmartIRC_base::getMotd()
    Returns the full motd.
getUser
in file SmartIRC.php, method Net_SmartIRC_base::getUser()
    Returns a reference to the user object for the specified username and channelname.
getUsermode
in file SmartIRC.php, method Net_SmartIRC_base::getUsermode()
    Returns the usermode.
getList
in file irccommands.php, method Net_SmartIRC_irccommands::getList()
    gets a list of one ore more channels
getTopic
in file irccommands.php, method Net_SmartIRC_irccommands::getTopic()
    gets the topic of a channel
top

i

isBanned
in file SmartIRC.php, method Net_SmartIRC_base::isBanned()
    Checks if the hostmask is on the specified channel banned and returns the result.
isError
in file SmartIRC.php, method Net_SmartIRC_base::isError()
isJoined
in file SmartIRC.php, method 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.
isMe
in file SmartIRC.php, method Net_SmartIRC_base::isMe()
    checks if the passed nickname is our own nickname
isOpped
in file SmartIRC.php, method Net_SmartIRC_base::isOpped()
    Checks if we or the given user is opped on the specified channel and returns the result.
isVoiced
in file SmartIRC.php, method Net_SmartIRC_base::isVoiced()
    Checks if we or the given user is voiced on the specified channel and returns the result.
irccommands.php
procedural page irccommands.php
invite
in file irccommands.php, method Net_SmartIRC_irccommands::invite()
    invites a user to the specified channel
top

j

join
in file irccommands.php, method Net_SmartIRC_irccommands::join()
    Joins one or more IRC channels with an optional key.
top

k

kick
in file irccommands.php, method Net_SmartIRC_irccommands::kick()
    Kicks one or more user from an IRC channel with an optional reason.
top

l

listen
in file SmartIRC.php, method Net_SmartIRC_base::listen()
    goes into receive mode
listenFor
in file SmartIRC.php, method Net_SmartIRC_base::listenFor()
    waits for a special message type and puts the answer in $result
listenOnce
in file SmartIRC.php, method Net_SmartIRC_base::listenOnce()
    goes into receive mode _only_ for one pass
loadModule
in file SmartIRC.php, method Net_SmartIRC_base::loadModule()
log
in file SmartIRC.php, method Net_SmartIRC_base::log()
    Adds an entry to the log.
login
in file SmartIRC.php, method Net_SmartIRC_base::login()
    login and register nickname on the IRC network
top

m

messagehandler.php
procedural page messagehandler.php
message
in file irccommands.php, method Net_SmartIRC_irccommands::message()
    sends a new message
mode
in file irccommands.php, method Net_SmartIRC_irccommands::mode()
    sets or gets the mode of an user or channel
top

n

$nreplycodes
in file SmartIRC.php, variable Net_SmartIRC_base::$nreplycodes
    All numeric IRC replycodes, the index is the numeric replycode.
Net_SmartIRC_base
in file SmartIRC.php, method 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
in file SmartIRC.php, class Net_SmartIRC_base
    main SmartIRC class
names
in file irccommands.php, method Net_SmartIRC_irccommands::names()
    requests all nicknames of one or more channels
Net_SmartIRC
in file SmartIRC.php, class Net_SmartIRC
    $Id: messagehandler.php 241017 2007-08-10 09:22:02Z amir $
Net_SmartIRC_irccommands
in file irccommands.php, class Net_SmartIRC_irccommands
    $Id: irccommands.php 241047 2007-08-10 15:10:30Z amir $
Net_SmartIRC_messagehandler
in file messagehandler.php, class Net_SmartIRC_messagehandler
    $Id: messagehandler.php 241017 2007-08-10 09:22:02Z amir $
top

o

op
in file irccommands.php, method Net_SmartIRC_irccommands::op()
    ops an user in the given channel
top

p

part
in file irccommands.php, method Net_SmartIRC_irccommands::part()
    parts from one or more IRC channels with an optional reason
top

q

quit
in file irccommands.php, method Net_SmartIRC_irccommands::quit()
    sends QUIT to IRC server and disconnects
top

r

$replycodes
in file SmartIRC.php, variable Net_SmartIRC_base::$replycodes
    All IRC replycodes, the index is the replycode name.
reconnect
in file SmartIRC.php, method Net_SmartIRC_base::reconnect()
    Reconnects to the IRC server with the same login info, it also rejoins the channels
registerActionhandler
in file SmartIRC.php, method Net_SmartIRC_base::registerActionhandler()
    registers a new actionhandler and returns the assigned id
registerTimehandler
in file SmartIRC.php, method Net_SmartIRC_base::registerTimehandler()
    registers a timehandler and returns the assigned id
top

s

SmartIRC.php
procedural page SmartIRC.php
send
in file SmartIRC.php, method Net_SmartIRC_base::send()
    sends an IRC message
setAutoReconnect
in file SmartIRC.php, method Net_SmartIRC_base::setAutoReconnect()
    Enables/disables autoreconnecting.
setAutoRetry
in file SmartIRC.php, method Net_SmartIRC_base::setAutoRetry()
    Enables/disables autoretry for connecting to a server.
setAutoRetryMax
in file SmartIRC.php, method Net_SmartIRC_base::setAutoRetryMax()
    Sets the maximum number of attempts to connect to a server before giving up.
setBenchmark
in file SmartIRC.php, method Net_SmartIRC_base::setBenchmark()
    Enables/disables the benchmark engine.
setChannelSynching
in file SmartIRC.php, method Net_SmartIRC_base::setChannelSynching()
    Deprecated, use setChannelSyncing() instead!
setChannelSyncing
in file SmartIRC.php, method Net_SmartIRC_base::setChannelSyncing()
    Enables/disables channel syncing.
setCtcpVersion
in file SmartIRC.php, method Net_SmartIRC_base::setCtcpVersion()
    Sets the CTCP version reply string.
setDebug
in file SmartIRC.php, method Net_SmartIRC_base::setDebug()
    Sets the level of debug messages.
setDisconnecttime
in file SmartIRC.php, method Net_SmartIRC_base::setDisconnecttime()
    Sets the delaytime before closing the socket when disconnect.
setLogdestination
in file SmartIRC.php, method Net_SmartIRC_base::setLogdestination()
    Sets the destination of all log messages.
setLogfile
in file SmartIRC.php, method Net_SmartIRC_base::setLogfile()
    Sets the file for the log if the destination is set to file.
setModulepath
in file SmartIRC.php, method Net_SmartIRC_base::setModulepath()
    Sets the paths for the modules.
setReceivedelay
in file SmartIRC.php, method Net_SmartIRC_base::setReceivedelay()
    Sets the delay for receiving data from the IRC server.
setReceiveTimeout
in file SmartIRC.php, method Net_SmartIRC_base::setReceiveTimeout()
    Sets the receive timeout.
setReconnectdelay
in file SmartIRC.php, method Net_SmartIRC_base::setReconnectdelay()
    Sets the delaytime before attempting reconnect.
setRunAsDaemon
in file SmartIRC.php, method Net_SmartIRC_base::setRunAsDaemon()
    Sets wheter the script should be run as a daemon or not ( actually disables/enables ignore_user_abort() )
setSenddelay
in file SmartIRC.php, method Net_SmartIRC_base::setSenddelay()
    Sets the delay for sending data to the IRC server.
setTransmitTimeout
in file SmartIRC.php, method Net_SmartIRC_base::setTransmitTimeout()
    Sets the transmit timeout.
setUserSyncing
in file SmartIRC.php, method Net_SmartIRC_base::setUserSyncing()
    Enables/disables user syncing.
setUseSockets
in file SmartIRC.php, method Net_SmartIRC_base::setUseSockets()
    Enables/disables the usage of real sockets.
showBenchmark
in file SmartIRC.php, method Net_SmartIRC_base::showBenchmark()
    Shows the benchmark result.
SMARTIRC_BROWSEROUT
in file defines.php, constant SMARTIRC_BROWSEROUT
SMARTIRC_CRITICAL
in file defines.php, constant SMARTIRC_CRITICAL
SMARTIRC_CRLF
in file defines.php, constant SMARTIRC_CRLF
    $Id: defines.php 162248 2004-06-28 17:35:55Z meebey $
SMARTIRC_DEBUG_ACTIONHANDLER
in file defines.php, constant SMARTIRC_DEBUG_ACTIONHANDLER
SMARTIRC_DEBUG_ALL
in file defines.php, constant SMARTIRC_DEBUG_ALL
SMARTIRC_DEBUG_CHANNELSYNCING
in file defines.php, constant SMARTIRC_DEBUG_CHANNELSYNCING
SMARTIRC_DEBUG_CONNECTION
in file defines.php, constant SMARTIRC_DEBUG_CONNECTION
SMARTIRC_DEBUG_DCC
in file defines.php, constant SMARTIRC_DEBUG_DCC
SMARTIRC_DEBUG_IRCMESSAGES
in file defines.php, constant SMARTIRC_DEBUG_IRCMESSAGES
SMARTIRC_DEBUG_MESSAGEHANDLER
in file defines.php, constant SMARTIRC_DEBUG_MESSAGEHANDLER
SMARTIRC_DEBUG_MESSAGEPARSER
in file defines.php, constant SMARTIRC_DEBUG_MESSAGEPARSER
SMARTIRC_DEBUG_MESSAGETYPES
in file defines.php, constant SMARTIRC_DEBUG_MESSAGETYPES
SMARTIRC_DEBUG_MODULES
in file defines.php, constant SMARTIRC_DEBUG_MODULES
SMARTIRC_DEBUG_NONE
in file defines.php, constant SMARTIRC_DEBUG_NONE
SMARTIRC_DEBUG_NOTICE
in file defines.php, constant SMARTIRC_DEBUG_NOTICE
SMARTIRC_DEBUG_SOCKET
in file defines.php, constant SMARTIRC_DEBUG_SOCKET
SMARTIRC_DEBUG_TIMEHANDLER
in file defines.php, constant SMARTIRC_DEBUG_TIMEHANDLER
SMARTIRC_DEBUG_USERSYNCING
in file defines.php, constant SMARTIRC_DEBUG_USERSYNCING
SMARTIRC_FILE
in file defines.php, constant SMARTIRC_FILE
SMARTIRC_HIGH
in file defines.php, constant SMARTIRC_HIGH
SMARTIRC_LOW
in file defines.php, constant SMARTIRC_LOW
SMARTIRC_MEDIUM
in file defines.php, constant SMARTIRC_MEDIUM
SMARTIRC_NONE
in file defines.php, constant SMARTIRC_NONE
SMARTIRC_STATE_CONNECTED
in file defines.php, constant SMARTIRC_STATE_CONNECTED
SMARTIRC_STATE_CONNECTING
in file defines.php, constant SMARTIRC_STATE_CONNECTING
SMARTIRC_STATE_DISCONNECTED
in file defines.php, constant SMARTIRC_STATE_DISCONNECTED
SMARTIRC_STDOUT
in file defines.php, constant SMARTIRC_STDOUT
SMARTIRC_SYSLOG
in file defines.php, constant SMARTIRC_SYSLOG
SMARTIRC_TYPE_ACTION
in file defines.php, constant SMARTIRC_TYPE_ACTION
SMARTIRC_TYPE_ALL
in file defines.php, constant SMARTIRC_TYPE_ALL
SMARTIRC_TYPE_BANLIST
in file defines.php, constant SMARTIRC_TYPE_BANLIST
SMARTIRC_TYPE_CHANNEL
in file defines.php, constant SMARTIRC_TYPE_CHANNEL
SMARTIRC_TYPE_CHANNELMODE
in file defines.php, constant SMARTIRC_TYPE_CHANNELMODE
SMARTIRC_TYPE_CTCP
in file defines.php, constant SMARTIRC_TYPE_CTCP
SMARTIRC_TYPE_CTCP_REPLY
in file defines.php, constant SMARTIRC_TYPE_CTCP_REPLY
SMARTIRC_TYPE_CTCP_REQUEST
in file defines.php, constant SMARTIRC_TYPE_CTCP_REQUEST
SMARTIRC_TYPE_ERROR
in file defines.php, constant SMARTIRC_TYPE_ERROR
SMARTIRC_TYPE_INFO
in file defines.php, constant SMARTIRC_TYPE_INFO
SMARTIRC_TYPE_INVITE
in file defines.php, constant SMARTIRC_TYPE_INVITE
SMARTIRC_TYPE_JOIN
in file defines.php, constant SMARTIRC_TYPE_JOIN
SMARTIRC_TYPE_KICK
in file defines.php, constant SMARTIRC_TYPE_KICK
SMARTIRC_TYPE_LIST
in file defines.php, constant SMARTIRC_TYPE_LIST
SMARTIRC_TYPE_LOGIN
in file defines.php, constant SMARTIRC_TYPE_LOGIN
SMARTIRC_TYPE_MODECHANGE
in file defines.php, constant SMARTIRC_TYPE_MODECHANGE
SMARTIRC_TYPE_MOTD
in file defines.php, constant SMARTIRC_TYPE_MOTD
SMARTIRC_TYPE_NAME
in file defines.php, constant SMARTIRC_TYPE_NAME
SMARTIRC_TYPE_NICKCHANGE
in file defines.php, constant SMARTIRC_TYPE_NICKCHANGE
SMARTIRC_TYPE_NONRELEVANT
in file defines.php, constant SMARTIRC_TYPE_NONRELEVANT
SMARTIRC_TYPE_NOTICE
in file defines.php, constant SMARTIRC_TYPE_NOTICE
SMARTIRC_TYPE_PART
in file defines.php, constant SMARTIRC_TYPE_PART
SMARTIRC_TYPE_QUERY
in file defines.php, constant SMARTIRC_TYPE_QUERY
SMARTIRC_TYPE_QUIT
in file defines.php, constant SMARTIRC_TYPE_QUIT
SMARTIRC_TYPE_TOPIC
in file defines.php, constant SMARTIRC_TYPE_TOPIC
SMARTIRC_TYPE_TOPICCHANGE
in file defines.php, constant SMARTIRC_TYPE_TOPICCHANGE
SMARTIRC_TYPE_UNKNOWN
in file defines.php, constant SMARTIRC_TYPE_UNKNOWN
SMARTIRC_TYPE_USERMODE
in file defines.php, constant SMARTIRC_TYPE_USERMODE
SMARTIRC_TYPE_WHO
in file defines.php, constant SMARTIRC_TYPE_WHO
SMARTIRC_TYPE_WHOIS
in file defines.php, constant SMARTIRC_TYPE_WHOIS
SMARTIRC_TYPE_WHOWAS
in file defines.php, constant SMARTIRC_TYPE_WHOWAS
SMARTIRC_UNUSED
in file defines.php, constant SMARTIRC_UNUSED
SMARTIRC_VERSION
in file SmartIRC.php, constant SMARTIRC_VERSION
SMARTIRC_VERSIONSTRING
in file SmartIRC.php, constant SMARTIRC_VERSIONSTRING
startBenchmark
in file SmartIRC.php, method Net_SmartIRC_base::startBenchmark()
    Starts the benchmark (sets the counters).
stopBenchmark
in file SmartIRC.php, method Net_SmartIRC_base::stopBenchmark()
    Stops the benchmark and displays the result.
setTopic
in file irccommands.php, method Net_SmartIRC_irccommands::setTopic()
    sets a new topic of a channel
top

t

throwError
in file SmartIRC.php, method Net_SmartIRC_base::throwError()
top

u

$user
in file SmartIRC.php, variable Net_SmartIRC_base::$user
    Stores all users that had/have contact with us (channel/query/notice etc.), works only if usersyncing is activated.
unloadModule
in file SmartIRC.php, method Net_SmartIRC_base::unloadModule()
unregisterActionhandler
in file SmartIRC.php, method Net_SmartIRC_base::unregisterActionhandler()
    unregisters an existing actionhandler
unregisterActionid
in file SmartIRC.php, method Net_SmartIRC_base::unregisterActionid()
    unregisters an existing actionhandler via the id
unregisterTimeid
in file SmartIRC.php, method Net_SmartIRC_base::unregisterTimeid()
    unregisters an existing timehandler via the id
unban
in file irccommands.php, method Net_SmartIRC_irccommands::unban()
    unbans a hostmask on the given channel
top

v

voice
in file irccommands.php, method Net_SmartIRC_irccommands::voice()
    voice a user in the given channel
top

w

who
in file irccommands.php, method Net_SmartIRC_irccommands::who()
    requests a 'WHO' from the specified target
whois
in file irccommands.php, method Net_SmartIRC_irccommands::whois()
    requests a 'WHOIS' from the specified target
whowas
in file irccommands.php, method Net_SmartIRC_irccommands::whowas()
    requests a 'WHOWAS' from the specified target (if he left the IRC network)
top
Documentation generated on Mon, 25 Oct 2010 14:30:06 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.