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

Files:
bot.php
calc.module.php
commands.class.php
config.inc.php
config.inc.template.php
example.module.php
install.class.php
kernel.class.php
logs.class.php
main.module.php
modules.class.php
shell.module.php
store.class.php
store.flatfile.class.php
time.module.php
users.class.php

Classes:
IcqBot
IcqBot_Commands
IcqBot_Conf
IcqBot_Install
IcqBot_Logs
IcqBot_Module
IcqBot_ModuleAdmin
IcqBot_Module_Calc
IcqBot_Module_Example
IcqBot_Module_Main
IcqBot_Module_Shell
IcqBot_Module_Time
IcqBot_Store
IcqBot_Store_Flatfile
IcqBot_Users

Class: IcqBot_Commands

Source Location: /kernel/commands.class.php

Class IcqBot_Commands

Class Overview
Class Overview | Property Summary | Properties Detail | Method Summary | Methods Detail

Located in /kernel/commands.class.php [line 3] 



		
		
		
				

				
		
Properties

		
				
		
				
		
Methods

		
				
		
		

		
[ Top ]

	







	
	

		
Property Summary

		

			Class Overview
									| Property Summary | Properties Detail
												| Method Summary | Methods Detail
							    				

		

			

			

					

																			
IcqBot_Store  
					$store  
					Storing class

				
										

			

			
[ Top ]

		

	


	
	

		
Method Summary

		

			Class Overview
																		| Property Summary | Properties Detail
							    					| Method Summary | Methods Detail
		

		

			

				

											

											

											

											

											

											

											

											

											

											

											

											

											

											

																																																																																																																																
IcqBot_Commands  
										__construct()  
					

				
																
void  
										activateOfflineMessages()  
					

				
																
array  
										addCommand()  
					Add command handler to module

				
																
void  
										addEvent()  
					

				
																
void  
										addTimer()  
					

				
																
void  
										removeAll()  
					

				
																
void  
										removeAllCommands()  
					

				
																
void  
										removeAllEvents()  
					

				
																
void  
										removeAllTimers()  
					

				
																
void  
										removeCommand()  
					

				
																
void  
										removeEvent()  
					

				
																
void  
										removeTimer()  
					

				
																
void  
										sendMsg()  
					

				
																
void  
										setStatus()  
					

				
												

			

			
[ Top ]

		

	


	
	

		
Properties

		

			Class Overview
													| Property Summary | Properties Detail
															| Method Summary | Methods Detail
												

		

			



	

		
			IcqBot_Store  
			$store
						[line 39]
		
	


	
Storing class


	API Tags:



  

    Access:  public
  







	
		

	
[ Top ]



		

	


	
	

		
Methods

		

			Class Overview
																		| Property Summary | Properties Detail
																	| Method Summary | Methods Detail
					

		

			







	Constructor __construct  [line 41]





	

    

    
 
		IcqBot_Commands __construct(
IcqBot
&$icqbot, IcqBot_Conf
&$conf, 
&$proto, IcqBot_Logs
&$logs 
)
    

    



	
			Parameters:

			

					

				IcqBot  
				
				&$icqbot: 
				
							

					

				IcqBot_Conf  
				
				&$conf: 
				
							

					

				WebIcqPro  
				
				&$proto: 
				
							

					

				IcqBot_Logs  
				
				&$logs: 
				
							

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	activateOfflineMessages  [line 217]





	

    

    
 
		void activateOfflineMessages(
)
    

    



	
	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	addCommand  [line 58]





	

    

    
 
		array addCommand(
IcqBot_Module
&$module, string
$command, [array
$aliases = array()], IcqBot_Module
$module 
)
    

    



	
Add command handler to module



			Parameters:

			

					

				IcqBot_Module  
				
				$module: 
				
							

					

				string  
				
				$command: 
				
				 Command to handle			

					

				array  
				
				$aliases: 
				
				 Aliases for this command			

					

				IcqBot_Module  
				
				&$module: 
				
							

				


	

	API Tags:



  

    Return:  Commands and Aliases, whick handled
  

  

    Access:  public
  







		
		

	
[ Top ]









	addEvent  [line 113]





	

    

    
 
		void addEvent(
IcqBot_Module
$module, 
$event 
)
    

    



	
			Parameters:

			

					

				IcqBot_Module  
				
				$module: 
				
							

					

				  
				
				$event: 
				
							

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	addTimer  [line 150]





	

    

    
 
		void addTimer(
IcqBot_Module
$module, 
$key, 
$interval, 
$callback 
)
    

    



	
			Parameters:

			

					

				IcqBot_Module  
				
				$module: 
				
							

					

				  
				
				$key: 
				
							

					

				  
				
				$interval: 
				
							

					

				  
				
				$callback: 
				
							

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	removeAll  [line 195]





	

    

    
 
		void removeAll(
IcqBot_Module
$module 
)
    

    



	
			Parameters:

			

					

				IcqBot_Module  
				
				$module: 
				
							

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	removeAllCommands  [line 101]





	

    

    
 
		void removeAllCommands(
IcqBot_Module
&$module 
)
    

    



	
			Parameters:

			

					

				IcqBot_Module  
				
				&$module: 
				
							

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	removeAllEvents  [line 137]





	

    

    
 
		void removeAllEvents(
IcqBot_Module
$module 
)
    

    



	
			Parameters:

			

					

				IcqBot_Module  
				
				$module: 
				
							

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	removeAllTimers  [line 178]





	

    

    
 
		void removeAllTimers(
IcqBot_Module
$module 
)
    

    



	
			Parameters:

			

					

				IcqBot_Module  
				
				$module: 
				
							

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	removeCommand  [line 88]





	

    

    
 
		void removeCommand(
IcqBot_Module
&$module, 
$command 
)
    

    



	
			Parameters:

			

					

				IcqBot_Module  
				
				&$module: 
				
							

					

				  
				
				$command: 
				
							

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	removeEvent  [line 127]





	

    

    
 
		void removeEvent(
IcqBot_Module
$module, 
$event 
)
    

    



	
			Parameters:

			

					

				IcqBot_Module  
				
				$module: 
				
							

					

				  
				
				$event: 
				
							

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	removeTimer  [line 167]





	

    

    
 
		void removeTimer(
IcqBot_Module
$module, 
$key 
)
    

    



	
			Parameters:

			

					

				IcqBot_Module  
				
				$module: 
				
							

					

				  
				
				$key: 
				
							

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	sendMsg  [line 210]





	

    

    
 
		void sendMsg(

$uin, 
$msg 
)
    

    



	
			Parameters:

			

					

				  
				
				$uin: 
				
							

					

				  
				
				$msg: 
				
							

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	setStatus  [line 203]





	

    

    
 
		void setStatus(

$status 
)
    

    



	
			Parameters:

			

					

				  
				
				$status: 
				
							

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]



		

	



        

		    

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