phergie / phergie-irc-generator
Generator for messages conforming to the IRC protocol
Installs: 22 475
Dependents: 3
Suggesters: 0
Security: 0
Stars: 6
Watchers: 5
Forks: 4
Open Issues: 2
Requires
- php: >=5.3.3
Requires (Dev)
- phpunit/phpunit: 4.1.*
This package is not auto-updated.
Last update: 2020-03-15 13:56:58 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-generator
A PHP-based generator for messages conforming to the IRC protocol as described in RFC 1459.
Install
The recommended method of installation is through composer.
{ "minimum-stability": "dev", "require": { "phergie/phergie-irc-generator": "1.1.0" } }
Design goals
- Minimal dependencies: PHP 5.3.3+
- Simple easy-to-understand API
Usage
<?php $generator = new \Phergie\Irc\Generator(); $messages = $generator->ircPass('password') . $generator->ircNick('nick') . $generator->ircUser('username', 'hostname', 'servername', 'realname') . $generator->ircJoin('#channel1,#channel2') . $generator->ircPrivmsg('#channel1', 'Hello world!'); echo $messages; /* Output: PASS :password NICK :nick USER username hostname servername :realname JOIN :#channel1,#channel2 PRIVMSG #channel1 :Hello world! */
Tests
To run the unit test suite:
curl -s https://getcomposer.org/installer | php
php composer.phar install
./vendor/bin/phpunit Phergie/Irc/GeneratorTest.php
License
Released under the BSD License. See LICENSE
.
Community
Check out #phergie on irc.freenode.net.