root/trunk/Phergie/Client/Driver.php @ 12

<?php

/**
* @see Phergie_Connection
*/
require_once 'Phergie/Connection.php';

/**
* @see Phergie_Exception
*/
require_once 'Phergie/Exception.php';

/**
* @see Phergie_Event_Handler
*/
require_once 'Phergie/Event/Handler.php';

/**
* Handles reception, transmission, and processing of data sent to and
* from IRC server.
*/
interface Phergie_Client_Driver
{
    /**
    * Adds a set of callbacks for events received from the server.
    *
    * @param Phergie_Event_Handler $handler
    */
    public function addEventHandler(Phergie_Event_Handler $handler);

    /**
    * Establishes a connection to the server.
    *
    * @param Phergie_Connection $connection Connection information
    * @throws Phergie_Exception A connectivity issue occurred
    */
    public function connect(Phergie_Connection $connection);

    /**
    * Terminates any existing connection to the server. Note that this 
    * should never be used by an event handler; doQuit should be called 
    * instead.
    */
    public function disconnect();

    /**
    * Returns whether or not the client is currently connected to the server.
    *
    * @return TRUE if the client is connected, FALSE otherwise
    */
    public function isConnected();

    /**
    * Executes a continuous loop in which the client listens for events from
    * the server and processes them until the connection is terminated.
    *
    * @throws Phergie_Exception A runtime issue occurred
    */
    public function run();

    /**
    * Controls debugging output.
    *
    * @param string $message Debugging message
    */
    public function debug($message);

    /**
    * Terminates the connection with the server.
    *
    * @param string $reason Reason for connection termination (optional)
    */
    public function doQuit($reason = null);

    /**
    * Joins a channel.
    *
    * @param string $channel Name of the channel to join
    * @param string $keys Channel key if needed (optional)
    */
    public function doJoin($channel, $key = null);

    /**
    * Leaves a channel.
    *
    * @param string $channel Name of the channel to leave
    */
    public function doPart($channel);

    /**
    * Invites a user to an invite-only channel.
    *
    * @param string $nick Nick of the user to invite
    * @param string $channel Name of the channel
    */
    public function doInvite($nick, $channel);

    /**
    * Obtains a list of nicks of usrs in currently joined channels.
    *
    * @param string $channels Comma-delimited list of one or more channels
    */
    public function doNames($channels);

    /**
    * Obtains a list of channel names and topics.
    *
    * @param string $channels Comma-delimited list of one or more channels
    *                         to which the response should be restricted
    *                         (optional)
    */
    public function doList($channels = null);

    /**
    * Retrieves or changes a channel topic.
    *
    * @param string $channel Name of the channel
    * @param string $topic New topic to assign (optional)
    */
    public function doTopic($channel, $topic = null);

    /**
    * Retrieves or changes a channel or user mode.
    *
    * @param string $target Channel name or user nick
    * @param string $mode New mode to assign (optional)
    */
    public function doMode($target, $mode = null);

    /**
    * Changes the client nick.
    *
    * @param string $nick New nick to assign
    */
    public function doNick($nick);

    /**
    * Retrieves information about a nick.
    *
    * @param string $nick
    */
    public function doWhois($nick);

    /**
    * Sends a message to a nick or channel.
    *
    * @param string $target Channel name or user nick
    * @param string $text Text of the message to send
    */
    public function doPrivmsg($target, $text);

    /**
    * Sends a notice to a nick or channel.
    *
    * @param string $target Channel name or user nick
    * @param string $text Text of the notice to send
    */
    public function doNotice($target, $text);

    /**
    * Kicks a user from a channel.
    *
    * @param string $nick Nick of the user
    * @param string $channel Channel name
    * @param string $reason Reason for the kick (optional)
    */
    public function doKick($nick, $channel, $reason = null);

    /**
    * Responds to a server test of client responsiveness.
    *
    * @param string $daemon Daemon from which the original request originates
    */
    public function doPong($daemon);
}