Skip to content

Latest commit

 

History

History
69 lines (50 loc) · 1.63 KB

README.md

File metadata and controls

69 lines (50 loc) · 1.63 KB
Raw

phergie/phergie-irc-connection

A PHP data structure for containing client connection information per the IRC protocol as described in RFC 1459.

Primarily used by IRC client implementations of the Phergie project.

Build Status

Install

The recommended method of installation is through composer.

{
    "minimum-stability": "dev",
    "require": {
        "phergie/phergie-irc-connection": "1.1.0"
    }
}

Design goals

  • Minimal dependencies: PHP 5.3.3+
  • Simple easy-to-understand API

Usage

$connection = new \Phergie\Irc\Connection();

$connection->setServerHostname('hostname');
$connection->setServerPort(6668);
$connection->setPassword('password');
$connection->setNickname('nickname');
$connection->setUsername('username');
$connection->setHostname('hostname');
$connection->setServername('servername');
$connection->setRealname('realname');
$connection->setOption('option', 'value');

echo $connection->getServerHostname();
echo $connection->getServerPort();
echo $connection->getPassword();
echo $connection->getNickname();
echo $connection->getUsername();
echo $connection->getHostname();
echo $connection->getServername();
echo $connection->getRealname();
echo $connection->getOption('option');

Tests

To run the unit test suite:

curl -s https://getcomposer.org/installer | php
php composer.phar install
./vendor/bin/phpunit

License

Released under the BSD License. See LICENSE.

Community

Check out #phergie on irc.freenode.net.