phergie / phergie-irc-connection
Data structure for containing information about an IRC client connection
Installs: 21 832
Dependents: 6
Suggesters: 0
Security: 0
Stars: 9
Watchers: 6
Forks: 5
Open Issues: 0
Requires
- php: >=5.4.2
Requires (Dev)
- phpunit/phpunit: ~4.6
This package is not auto-updated.
Last update: 2020-03-15 13:59:07 UTC
README
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.
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.
Install
The recommended method of installation is through composer.
{ "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:
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.