This project is abandoned
This repo is being kept for posterity and will be archived in a readonly state.
If you're interested it can be forked under a new Composer namespace/GitHub organization., (*1)
phergie/phergie-irc-connection
A PHP data structure for containing client connection information per the IRC protocol as described in RFC 1459., (*2)
Primarily used by IRC client implementations of the Phergie project., (*3)
, (*4)
Install
The recommended method of installation is through composer., (*5)
{
"require": {
"phergie/phergie-irc-connection": "~2"
}
}
Design goals
- Minimal dependencies: PHP 5.4.2+
- Simple easy-to-understand API
Usage
$connection = new \Phergie\Irc\Connection();
$connection
->setServerHostname('hostname')
->setServerPort(6668)
->setPassword('password')
->setNickname('nickname')
->setUsername('username')
->setHostname('hostname')
->setServername('servername')
->setRealname('realname')
->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:, (*6)
curl -s https://getcomposer.org/installer | php
php composer.phar install
./vendor/bin/phpunit
License
Released under the BSD License. See LICENSE., (*7)
Check out #phergie on irc.freenode.net., (*8)