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


Classes:
Net_SmartIRC
   MyBot
   Net_SmartIRC_channel
   Net_SmartIRC_channeluser
   Net_SmartIRC_data
   Net_SmartIRC_Error
   Net_SmartIRC_irccommands
   Net_SmartIRC_ircuser
   Net_SmartIRC_listenfor
   Net_SmartIRC_messagehandler
   Net_SmartIRC_module_MyBot
   Net_SmartIRC_user

Class: Net_SmartIRC_irccommands

Source Location: /Net_SmartIRC-1.1.14/Net/SmartIRC/irccommands.php

Class Overview




$Id$




Author(s):


    
        





    







Methods















Child classes:






Net_SmartIRC_messagehandler

	
$Id$









Inherited Variables





Inherited Methods














Class Details



[line 27]

$Id$
$Revision$  $Author$  $Date$
Copyright (c) 2002-2004 Mirco Bauer <meebey@meebey.net> <http://www.meebey.net>
Full LGPL License: <http://www.gnu.org/licenses/lgpl.txt>
This library is free software; you can redistribute it and/or  modify it under the terms of the GNU Lesser General Public  License as published by the Free Software Foundation; either  version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,  but WITHOUT ANY WARRANTY; without even the implied warranty of  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU  Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public  License along with this library; if not, write to the Free Software  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA


    

  • Abstract: 
    • 









[ Top ]








Method Detail



	
	
admin   [line 317]

	

    

    

		Net_SmartIRC admin(
string
$channel, string
$nickname, [integer
$priority = SMARTIRC_MEDIUM])
    

    


	
		admins an user in the given channel


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $channel  
        — 
        
      

          

        string  
        $nickname  
        — 
        
      

          

        integer  
        $priority  
        — 
        message priority, default is SMARTIRC_MEDIUM
      

        

    


        
[ Top ]

  

  
  
	
	
ban   [line 431]

	

    

    

		Net_SmartIRC ban(
string
$channel, [string
$hostmask = null], [integer
$priority = SMARTIRC_MEDIUM])
    

    


	
		bans a hostmask for the given channel or requests the current banlist
The banlist will be requested if no hostmask is specified


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $channel  
        — 
        
      

          

        string  
        $hostmask  
        — 
        
      

          

        integer  
        $priority  
        — 
        message priority, default is SMARTIRC_MEDIUM
      

        

    


        
[ Top ]

  

  
  
	
	
changeNick   [line 479]

	

    

    

		Net_SmartIRC changeNick(
string
$newnick, [integer
$priority = SMARTIRC_MEDIUM])
    

    


	
		changes the own nickname
Trys to set a new nickname, nickcollisions are handled.


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $newnick  
        — 
        
      

          

        integer  
        $priority  
        — 
        message priority, default is SMARTIRC_MEDIUM
      

        

    


        
[ Top ]

  

  
  
	
	
deadmin   [line 331]

	

    

    

		Net_SmartIRC deadmin(
string
$channel, string
$nickname, [integer
$priority = SMARTIRC_MEDIUM])
    

    


	
		deadmins an user in the given channel


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $channel  
        — 
        
      

          

        string  
        $nickname  
        — 
        
      

          

        integer  
        $priority  
        — 
        message priority, default is SMARTIRC_MEDIUM
      

        

    


        
[ Top ]

  

  
  
	
	
defounder   [line 303]

	

    

    

		Net_SmartIRC defounder(
string
$channel, string
$nickname, [integer
$priority = SMARTIRC_MEDIUM])
    

    


	
		defounders an user in the given channel


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $channel  
        — 
        
      

          

        string  
        $nickname  
        — 
        
      

          

        integer  
        $priority  
        — 
        message priority, default is SMARTIRC_MEDIUM
      

        

    


        
[ Top ]

  

  
  
	
	
dehop   [line 387]

	

    

    

		Net_SmartIRC dehop(
string
$channel, string
$nickname, [integer
$priority = SMARTIRC_MEDIUM])
    

    


	
		dehops an user in the given channel


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $channel  
        — 
        
      

          

        string  
        $nickname  
        — 
        
      

          

        integer  
        $priority  
        — 
        message priority, default is SMARTIRC_MEDIUM
      

        

    


        
[ Top ]

  

  
  
	
	
deop   [line 359]

	

    

    

		Net_SmartIRC deop(
string
$channel, string
$nickname, [integer
$priority = SMARTIRC_MEDIUM])
    

    


	
		deops an user in the given channel


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $channel  
        — 
        
      

          

        string  
        $nickname  
        — 
        
      

          

        integer  
        $priority  
        — 
        message priority, default is SMARTIRC_MEDIUM
      

        

    


        
[ Top ]

  

  
  
	
	
devoice   [line 415]

	

    

    

		Net_SmartIRC devoice(
string
$channel, string
$nickname, [integer
$priority = SMARTIRC_MEDIUM])
    

    


	
		devoice a user in the given channel


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $channel  
        — 
        
      

          

        string  
        $nickname  
        — 
        
      

          

        integer  
        $priority  
        — 
        message priority, default is SMARTIRC_MEDIUM
      

        

    


        
[ Top ]

  

  
  
	
	
founder   [line 289]

	

    

    

		Net_SmartIRC founder(
string
$channel, string
$nickname, [integer
$priority = SMARTIRC_MEDIUM])
    

    


	
		founders an user in the given channel


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $channel  
        — 
        
      

          

        string  
        $nickname  
        — 
        
      

          

        integer  
        $priority  
        — 
        message priority, default is SMARTIRC_MEDIUM
      

        

    


        
[ Top ]

  

  
  
	
	
getList   [line 190]

	

    

    

		Net_SmartIRC getList(
[mixed
$channelarray = null], [integer
$priority = SMARTIRC_MEDIUM])
    

    


	
		gets a list of one ore more channels
Requests a full channellist if $channelarray is not given.  (use it with care, usually its a looooong list)


    

  • Access: public
    • 








        
Parameters:

    

    

          

        mixed  
        $channelarray  
        — 
        
      

          

        integer  
        $priority  
        — 
        message priority, default is SMARTIRC_MEDIUM
      

        

    


        
[ Top ]

  

  
  
	
	
getTopic   [line 253]

	

    

    

		Net_SmartIRC getTopic(
string
$channel, [integer
$priority = SMARTIRC_MEDIUM])
    

    


	
		gets the topic of a channel


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $channel  
        — 
        
      

          

        integer  
        $priority  
        — 
        message priority, default is SMARTIRC_MEDIUM
      

        

    


        
[ Top ]

  

  
  
	
	
hop   [line 373]

	

    

    

		Net_SmartIRC hop(
string
$channel, string
$nickname, [integer
$priority = SMARTIRC_MEDIUM])
    

    


	
		hops an user in the given channel


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $channel  
        — 
        
      

          

        string  
        $nickname  
        — 
        
      

          

        integer  
        $priority  
        — 
        message priority, default is SMARTIRC_MEDIUM
      

        

    


        
[ Top ]

  

  
  
	
	
invite   [line 464]

	

    

    

		Net_SmartIRC invite(
string
$nickname, string
$channel, [integer
$priority = SMARTIRC_MEDIUM])
    

    


	
		invites a user to the specified channel


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $nickname  
        — 
        
      

          

        string  
        $channel  
        — 
        
      

          

        integer  
        $priority  
        — 
        message priority, default is SMARTIRC_MEDIUM
      

        

    


        
[ Top ]

  

  
  
	
	
join   [line 105]

	

    

    

		Net_SmartIRC join(
mixed
$channelarray, [string
$key = null], [integer
$priority = SMARTIRC_MEDIUM])
    

    


	
		Joins one or more IRC channels with an optional key.


    

  • Access: public
    • 








        
Parameters:

    

    

          

        mixed  
        $channelarray  
        — 
        
      

          

        string  
        $key  
        — 
        
      

          

        integer  
        $priority  
        — 
        message priority, default is SMARTIRC_MEDIUM
      

        

    


        
[ Top ]

  

  
  
	
	
kick   [line 162]

	

    

    

		Net_SmartIRC kick(
string
$channel, mixed
$nicknamearray, [string
$reason = null], [integer
$priority = SMARTIRC_MEDIUM])
    

    


	
		Kicks one or more user from an IRC channel with an optional reason.


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $channel  
        — 
        
      

          

        mixed  
        $nicknamearray  
        — 
        
      

          

        string  
        $reason  
        — 
        
      

          

        integer  
        $priority  
        — 
        message priority, default is SMARTIRC_MEDIUM
      

        

    


        
[ Top ]

  

  
  
	
	
message   [line 42]

	

    

    

		boolean|Net_SmartIRC message(
integer
$type, string
$destination, mixed
$messagearray, [integer
$priority = SMARTIRC_MEDIUM])
    

    


	
		sends a new message
Sends a message to a channel or user.


    

  • See: DOCUMENTATION
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        integer  
        $type  
        — 
        specifies the type, like QUERY/ACTION or CTCP see 'Message Types'
      

          

        string  
        $destination  
        — 
        can be a user or channel
      

          

        mixed  
        $messagearray  
        — 
        the message
      

          

        integer  
        $priority  
        — 
        the priority level of the message
      

        

    


        
[ Top ]

  

  
  
	
	
mode   [line 270]

	

    

    

		Net_SmartIRC mode(
string
$target, [string
$newmode = null], [integer
$priority = SMARTIRC_MEDIUM])
    

    


	
		sets or gets the mode of an user or channel
Changes/requests the mode of the given target.


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $target  
        — 
        the target, can be an user (only yourself) or a channel
      

          

        string  
        $newmode  
        — 
        the new mode like +mt
      

          

        integer  
        $priority  
        — 
        message priority, default is SMARTIRC_MEDIUM
      

        

    


        
[ Top ]

  

  
  
	
	
names   [line 215]

	

    

    

		Net_SmartIRC names(
[mixed
$channelarray = null], [integer
$priority = SMARTIRC_MEDIUM])
    

    


	
		requests all nicknames of one or more channels
The requested nickname list also includes op and voice state


    

  • Access: public
    • 








        
Parameters:

    

    

          

        mixed  
        $channelarray  
        — 
        
      

          

        integer  
        $priority  
        — 
        message priority, default is SMARTIRC_MEDIUM
      

        

    


        
[ Top ]

  

  
  
	
	
op   [line 345]

	

    

    

		Net_SmartIRC op(
string
$channel, string
$nickname, [integer
$priority = SMARTIRC_MEDIUM])
    

    


	
		ops an user in the given channel


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $channel  
        — 
        
      

          

        string  
        $nickname  
        — 
        
      

          

        integer  
        $priority  
        — 
        message priority, default is SMARTIRC_MEDIUM
      

        

    


        
[ Top ]

  

  
  
	
	
part   [line 135]

	

    

    

		Net_SmartIRC part(
mixed
$channelarray, [string
$reason = null], [integer
$priority = SMARTIRC_MEDIUM])
    

    


	
		parts from one or more IRC channels with an optional reason


    

  • Access: public
    • 








        
Parameters:

    

    

          

        mixed  
        $channelarray  
        — 
        
      

          

        string  
        $reason  
        — 
        
      

          

        integer  
        $priority  
        — 
        message priority, default is SMARTIRC_MEDIUM
      

        

    


        
[ Top ]

  

  
  
	
	
quit   [line 533]

	

    

    

		Net_SmartIRC quit(
[string
$quitmessage = null], [integer
$priority = SMARTIRC_CRITICAL])
    

    


	
		sends QUIT to IRC server and disconnects


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $quitmessage  
        — 
        optional quitmessage
      

          

        integer  
        $priority  
        — 
        message priority, default is SMARTIRC_CRITICAL
      

        

    


        
[ Top ]

  

  
  
	
	
setTopic   [line 239]

	

    

    

		Net_SmartIRC setTopic(
string
$channel, string
$newtopic, [integer
$priority = SMARTIRC_MEDIUM])
    

    


	
		sets a new topic of a channel


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $channel  
        — 
        
      

          

        string  
        $newtopic  
        — 
        
      

          

        integer  
        $priority  
        — 
        message priority, default is SMARTIRC_MEDIUM
      

        

    


        
[ Top ]

  

  
  
	
	
unban   [line 450]

	

    

    

		Net_SmartIRC unban(
string
$channel, string
$hostmask, [integer
$priority = SMARTIRC_MEDIUM])
    

    


	
		unbans a hostmask on the given channel


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $channel  
        — 
        
      

          

        string  
        $hostmask  
        — 
        
      

          

        integer  
        $priority  
        — 
        message priority, default is SMARTIRC_MEDIUM
      

        

    


        
[ Top ]

  

  
  
	
	
voice   [line 401]

	

    

    

		Net_SmartIRC voice(
string
$channel, string
$nickname, [integer
$priority = SMARTIRC_MEDIUM])
    

    


	
		voice a user in the given channel


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $channel  
        — 
        
      

          

        string  
        $nickname  
        — 
        
      

          

        integer  
        $priority  
        — 
        message priority, default is SMARTIRC_MEDIUM
      

        

    


        
[ Top ]

  

  
  
	
	
who   [line 493]

	

    

    

		Net_SmartIRC who(
string
$target, [integer
$priority = SMARTIRC_MEDIUM])
    

    


	
		requests a 'WHO' from the specified target


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $target  
        — 
        
      

          

        integer  
        $priority  
        — 
        message priority, default is SMARTIRC_MEDIUM
      

        

    


        
[ Top ]

  

  
  
	
	
whois   [line 506]

	

    

    

		Net_SmartIRC whois(
string
$target, [integer
$priority = SMARTIRC_MEDIUM])
    

    


	
		requests a 'WHOIS' from the specified target


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $target  
        — 
        
      

          

        integer  
        $priority  
        — 
        message priority, default is SMARTIRC_MEDIUM
      

        

    


        
[ Top ]

  

  
  
	
	
whowas   [line 520]

	

    

    

		Net_SmartIRC whowas(
string
$target, [integer
$priority = SMARTIRC_MEDIUM])
    

    


	
		requests a 'WHOWAS' from the specified target  (if he left the IRC network)


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $target  
        — 
        
      

          

        integer  
        $priority  
        — 
        message priority, default is SMARTIRC_MEDIUM
      

        

    


        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Thu, 25 Jul 2019 12:49:08 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright ©  PHP Group 2004.