class Timeout

www/php-ircbot/Classes/Command/Timeout.php

---

Timeout

Package

IRCBot\Command

author

• Super3 [email protected]

Overview

Public Properties

No public properties found

Constants

No constants found

Public Methods

command() | executeCommand() | getNick() | setIRCBot() | setIRCConnection() |

Properties

arguments

Contains all given arguments.

protected $arguments : array

• Inherited from \Library\IRC\Command\Base

Array

bot

Reference to the IRC Bot

protected $bot : \Lirary\IRC\Bot

• Inherited from \Library\IRC\Command\Base

Array

connection

Reference to the IRC Connection.

protected $connection : \Library\IRC\Connection

• Inherited from \Library\IRC\Command\Base

Array

data

Original request from server

private $data : string

• Inherited from \Library\IRC\Command\Base

Array

help

The command's help text.

You have to define this in the command. protected $help : string

Array

numberOfArguments

The number of arguments the command needs.

You have to define this in the command. protected $numberOfArguments : int

Array

source

Contains channel or user name

protected $source : string

• Inherited from \Library\IRC\Command\Base

Array

Methods

command()

The bot disconnects for the specified number of seconds.

This method is called if the command get's executed.

• Inherited from \Command\Timeout

public command() : mixed

executeCommand()

Executes the command.

• Inherited from \Library\IRC\Command\Base

public executeCommand(array $arguments, string $source, string $data) : mixed

fetch()

Fetches data from $uri

• Inherited from \Library\IRC\Command\Base

protected fetch(string $uri) : string

getHelp()

• Inherited from \Library\IRC\Command\Base

private getHelp() : mixed

getNick()

Returns a user's nickname

• Inherited from \Library\IRC\Command\Base

public getNick() : string

getUserIp()

Returns requesting user IP

• Inherited from \Library\IRC\Command\Base

protected getUserIp() : string

say()

Sends PRIVMSG to source with $msg

• Inherited from \Library\IRC\Command\Base

protected say(string $msg) : mixed

Tags

• version: 2.0

setIRCBot()

Set's the IRC Bot, so we can use it to send data to the server.

• Inherited from \Library\IRC\Command\Base

public setIRCBot(\Library\IRCBot $ircBot) : mixed

setIRCConnection()

Set's the IRC Connection, so we can use it to send data to the server.

• Inherited from \Library\IRC\Command\Base

public setIRCConnection(\Library\IRC\Connection $ircConnection) : mixed

---

\ » Classes » Timeout