class Bot

www/php-ircbot/Classes/Library/IRC/Bot.php

---

Bot

Package

IRCBot\Library

author

• Super3 [email protected]
• Daniel Siepmann [email protected]

Overview

Public Properties

No public properties found

Constants

No constants found

Public Methods

__construct() | __destruct() | addCommand() | addListener() | connectToServer() | getCommandPrefix() | getCommands() | getUserNickName() | log() | sendDataToServer() | setChannel() | setLogFile() | setMaxReconnects() | setName() | setNick() | setPort() | setServer() |

Properties

channel

A list of all channels the bot should connect to.

private $channel : array

Array

commandPrefix

Defines the prefix for all commands interacting with the bot.

protected $commandPrefix : string

Array

commands

All available commands.

Commands are type of IRCCommand private $commands : array

Array

connection

Holds the server connection.

private $connection : \Library\IRC\Connection

Array

ex

All of the messages both server and client

private $ex : array

Array

listeners

All available listeners.

Listeners are type of IRCListener private $listeners : array

Array

logFile

Complete file path to the log file.

Configure the path, the filename is generated and added. private $logFile : string

Array

logFileHandler

Holds the reference to the file.

private $logFileHandler : \Library\IRC\type

Array

maxReconnects

The number of reconnects before the bot stops running.

private $maxReconnects : int

Array

name

The name of the bot.

private $name : string

Array

nick

The nick of the bot.

private $nick : string

Array

nickCounter

The nick counter, used to generate a available nick.

private $nickCounter : int

Array

nickToUse

The nick of the bot.

private $nickToUse : string

Array

numberOfReconnects

Contains the number of reconnects.

private $numberOfReconnects : int

Array

Methods

__construct()

Creates a new IRCBot.

• Inherited from \Library\IRC\Bot

public __construct(array $configuration = array()) : void

Tags

• author: Daniel Siepmann [email protected]

__destruct()

Cleanup handlers.

• Inherited from \Library\IRC\Bot

public __destruct() : mixed

addCommand()

Adds a single command to the bot.

• Inherited from \Library\IRC\Bot

public addCommand(\Library\IRC\IRCCommand $command) : mixed

Tags

• author: Daniel Siepmann [email protected]

addListener()

• Inherited from \Library\IRC\Bot

public addListener(\Library\IRC\Listener\Base $listener) : mixed

connectToServer()

Connects the bot to the server.

The "USER" input is formed like: "USER misc misc misc :misc\r\n" http://stackoverflow.com/questions/2356040/my-ruby-irc-bot-doesnt-connect-to-the-irc-server-what-am-i-doing-wrong

• Inherited from \Library\IRC\Bot

public connectToServer() : mixed

Tags

• author: Super3 [email protected]
• author: Daniel Siepmann [email protected]
• version: 1.1

executeCommand()

• Inherited from \Library\IRC\Bot

protected executeCommand(mixed $source, mixed $commandName, array $arguments, mixed $data) : mixed

getClassName()

Returns class name of $object without namespace

• Inherited from \Library\IRC\Bot

private getClassName(mixed $object) : string

Tags

• author: Matej Velikonja [email protected]

getCommandPrefix()

• Inherited from \Library\IRC\Bot

public getCommandPrefix() : mixed

getCommands()

• Inherited from \Library\IRC\Bot

public getCommands() : mixed

getUserNickName()

Get the nickname from the data string.

• Inherited from \Library\IRC\Bot

public getUserNickName(string $data) : mixed

join_channel()

Joins one or multiple channel/-s.

• Inherited from \Library\IRC\Bot

private join_channel(mixed $channel) : mixed

Tags

• author: Super3 [email protected]

log()

Adds a log entry to the log file.

• Inherited from \Library\IRC\Bot

public log(string $log, string $status = '') : mixed

Tags

• author: Daniel Siepmann [email protected]

main()

This is the workhorse function, grabs the data from the server and displays on the browser

• Inherited from \Library\IRC\Bot

private main() : mixed

Tags

• author: Super3 [email protected]
• author: Daniel Siepmann [email protected]

sendDataToServer()

Displays stuff to the broswer and sends data to the server.

• Inherited from \Library\IRC\Bot

public sendDataToServer(string $cmd) : mixed

Tags

• author: Daniel Siepmann [email protected]

setChannel()

Sets the channel.

E.g. '#testchannel' or array('#testchannel','#helloWorldChannel')

• Inherited from \Library\IRC\Bot

public setChannel(string|array $channel) : mixed

setLogFile()

Sets the filepath to the log. Specify the folder and a prefix.

E.g. /Users/yourname/logs/ircbot- That will result in a logfile like the following: /Users/yourname/logs/ircbot-11-12-2012.log

• Inherited from \Library\IRC\Bot

public setLogFile(string $logFile) : mixed

setMaxReconnects()

Sets the limit of reconnects, before the bot exits.

• Inherited from \Library\IRC\Bot

public setMaxReconnects(int $maxReconnects) : mixed

setName()

Sets the name of the bot.

"Yes give me a name!"

• Inherited from \Library\IRC\Bot

public setName(string $name) : mixed

setNick()

Sets the nick of the bot.

"Yes give me a nick too. I love nicks."

• Inherited from \Library\IRC\Bot

public setNick(string $nick) : mixed

setPort()

Sets the port.

E.g. 6667

• Inherited from \Library\IRC\Bot

public setPort(int $port) : mixed

setServer()

Sets the server.

E.g. irc.quakenet.org or irc.freenode.org

• Inherited from \Library\IRC\Bot

public setServer(string $server) : mixed

setWholeConfiguration()

Sets the whole configuration.

• Inherited from \Library\IRC\Bot

private setWholeConfiguration(array $configuration) : mixed

Tags

• author: Daniel Siepmann [email protected]

---

\ » Classes » Bot