Class: IcqBot_Module_Main

Source Location: /modules/main.module.php

Class IcqBot_Module_Main

Class Overview

phpIcqBot Main Module

Main (Admin) Module is used for controlling bot. Now available commands:

!mod - for controlling modules
!roles - for controlling users
!stop - the exit command for bot
!restart - restart command (tries to load new modules)

Located in /modules/main.module.php [line 19]

IcqBot_Module
   |
   --IcqBot_ModuleAdmin
      |
      --IcqBot_Module_Main

Author(s):

Jector <no.one.on@gmail.com>

Information Tags:

Version:	0.2
Todo:	a lot of things

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From IcqBot_ModuleAdmin

IcqBot_ModuleAdmin::$conf

IcqBot_ModuleAdmin::$icqbot

IcqBot_ModuleAdmin::$proto

Inherited From IcqBot_Module

IcqBot_Module::$commands

IcqBot_Module::$logs

Inherited From IcqBot_ModuleAdmin

IcqBot_ModuleAdmin::setIcqBot()

Inherited From IcqBot_Module

IcqBot_Module::__construct()

IcqBot_Module::deinit()

IcqBot_Module::init()

IcqBot_Module::__destruct()

[ Top ]

Method Summary

void	Command_About()	About Command
void	Command_Exit()	Exit command.
mixed	Command_Help()	Help command.
void	Command_Mod()	Mod command.
void	Command_Restart()	Restart command.
mixed	Command_Roles()	Roles command
void	deinit()	Standart deinitialization function
string	Help_Mod()	Help for Mod command
void	init()	Standart initialization function

[ Top ]

Properties

Methods

Command_About [line 51]

void Command_About(
integer
$uin 
)

About Command

Returns information about phpIcqBot like version, author, etc

Parameters:

integer

$uin:

API Tags:

Access:

public

[ Top ]

Command_Exit [line 65]

void Command_Exit(
integer
$uin 
)

Exit command.

Terminate working of phpIcqBot. It's not really stop it here, but just set WORKING flag to false.

Parameters:

integer

$uin:

API Tags:

See:	IcqBot::work()
Access:	public

[ Top ]

Command_Help [line 107]

mixed Command_Help(
integer
$uin, string
$params 
)

Help command.

Supports help system of phpIcqBot.

Parameters:

integer	$uin:
string	$params:

API Tags:

Access:

public

Information Tags:

Todo:

A lot of changes will be here

[ Top ]

Command_Mod [line 160]

void Command_Mod(
integer
$uin, string
$params 
)

Mod command.

Command, which controls phpIcqBot modules Available params:

!mod list
!mod cmdlist <modulename|modulenum>
!mod info <modulename|modulenum>

Parameters:

integer	$uin:
string	$params:

API Tags:

Access:

public

Information Tags:

Todo:

params for load/unload modules

[ Top ]

Command_Restart [line 84]

void Command_Restart(
integer
$uin 
)

Restart command.

Do restart of phpIcqBot. It's not really restart it here, but just set RESTART flag to true.

Parameters:

integer

$uin:

API Tags:

See:	IcqBot::work()
Access:	public

[ Top ]

Command_Roles [line 509]

mixed Command_Roles(
integer
$uin, string
$params 
)

Roles command

Command, which rules users ACL. Available params:

!roles list <icqnumber>
!roles add <icqnumber> <role1> [role2 [role3 ... ] ]
!roles remove <icqnumber> <role1> [role2 [role3 ... ] ]

Parameters:

integer	$uin:
string	$params:

API Tags:

Access:

public

Information Tags:

Todo:

Roles and ACL system should be more powerfull

[ Top ]

deinit [line 40]

void deinit(
)

Standart deinitialization function

API Tags:

Access:

public

Redefinition of:

IcqBot_Module::deinit()

[ Top ]

Help_Mod [line 607]

string Help_Mod(
string
$params 
)

Help for Mod command

Parameters:

string

$params:

API Tags:

Deprecated:	will be deprecated
Access:	public

[ Top ]

init [line 25]

void init(
)

Standart initialization function

API Tags:

Access:

public

Redefinition of:

IcqBot_Module::init()

[ Top ]

Documentation generated on Mon, 24 Dec 2007 09:34:33 +0500 by phpDocumentor 1.4.0

	phpIcqBot

[ class tree: phpIcqBot ] [ index: phpIcqBot ] [ all elements ]