https://github.com/jerodev/php-irc-client
php irc client based on ReactPHP
https://github.com/jerodev/php-irc-client
irc php reactphp
Last synced: 11 days ago
JSON representation
php irc client based on ReactPHP
- Host: GitHub
- URL: https://github.com/jerodev/php-irc-client
- Owner: jerodev
- License: mit
- Created: 2019-02-28T17:08:30.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-30T12:57:20.000Z (about 2 years ago)
- Last Synced: 2024-11-14T20:54:40.807Z (about 1 year ago)
- Topics: irc, php, reactphp
- Language: PHP
- Homepage:
- Size: 117 KB
- Stars: 16
- Watchers: 7
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# PHP IRC Client
[](https://travis-ci.com/jerodev/php-irc-client) [](https://github.styleci.io/repos/173153410) [](https://scrutinizer-ci.com/g/jerodev/php-irc-client/?branch=master)
A pure PHP IRC client based on [ReactPHP](https://reactphp.org/).
> :wrench: This project is under development and will probably not work in its current state.
## Documentation
- [Client](#client)
- [Connecting to the server](#client-connect)
- [Sending commands to the server](#client-send-command)
- [Joining a channel](#client-join-channel)
- [Leaving a channel](#client-leave-channel)
- [Sending messages](#client-sending-messages)
- [Events](#events)
- [Registered on server](#client-event-registered)
- [Message of the day](#client-event-motd)
- [Topic changed](#client-event-topic)
- [Channel users received](#client-event-names)
- [Message received](#client-event-message)
- [Ping received](#client-event-ping)
---
## Client
The client is the heart of the library, this object is used to perform all communication between your application and the IRC server. It will manage the connection to the IRC server and has all functions needed to interact with the server.
use Jerodev\PhpIrcClient\IrcClient;
$client = new IrcClient('irc.server:6667', 'Jerodev');
$client->connect();
$client->connect()
This function opens the connection to the IRC server. Username has to be set before the connection can be opened.
### Sending commands to the server
$client->send(string $command)
Sends a raw IRC command directly to the server. This method should only be used if you really know what you are doing, it is recommended to use the built-in functions below.
| Name | Type | Description
| --- | --- | --- |
| `$command` | *string* | The raw irc command
$client->join(string $channel)
Joins a specified channel
| Name | Type | Description
| --- | --- | --- |
| `$channel` | *string* | The name of the channel to join.
$client->part(string $channel)
Leave a channel. If the specified channel has not yet been joined, nothing will happen.
| Name | Type | Description
| --- | --- | --- |
| `$channel` | *string* | The name of the channel to part.
$client->say(string $target, string $message)
Sends a message to a channel or user.
| Name | Type | Description
| --- | --- | --- |
| `$target` | *string* | A name of a channel staring with `#` or the nickname of the user to send a message to.
| `$message` | *string* | The message to send to the target.
---
## Events
The `on()` function on the client can be used to register to several different events. This can be done both before and after connecting to the IRC server. Events have variable callback arguments, all are described below.
$client->on('registered', function () { });
Emitted when the server sends the initial welcome message (`001`). This indicates that you are connected to the server.
$client->on('motd', function (string $motd) { });
Emitted when the server sends the message of the day to the client. If the message of the day is multiple lines, this event might be emitted multiple times.
| Name | Type | Description
| --- | --- | --- |
| `$motd` | *string* | The server's *Message Of The Day*.
$client->on('topic', function (string $channel, string $topic) { });
Emitted when joining a channel or when the topic of a joined channel changes.
| Name | Type | Description
| --- | --- | --- |
| `$channel` | *string* | The channel where the topic has changed.
| `$topic` | *string* | The new topic for this channel.
$client->on('names', function (string $channel, string[] $nicks) { });
Emitted when the server sends a list of nicks for a channel. This happens immediately after joining a channel and on request.
| Name | Type | Description
| --- | --- | --- |
| `$channel` | *string* | The channel name.
| `$names` | *string[]* | A list of nicknames who are currently in this channel.
> You can also specify the channel you want to listen on by adding `#channel` to the event.
> For example: `$client->on('names#channel', function ($names) {})`
$client->on('message', function (string $from, IrcChannel $channel, string $message) { });
Emitted when a message is sent to a connected channel.
| Name | Type | Description
| --- | --- | --- |
| `$from` | *string* | The nickname of the user who sent the message.
| `$channel` | *IrcChannel* | The channel where the message was sent.
| `$message` | *string* | The received message.
> You can also specify the channel you want to listen on by adding `#channel` to the event.
> For example: `$client->on('message#channel', function ($from, $channel, $message) {})`
$client->on('ping', function () { });
Emitted when the server sends a `ping` request to the client. The pong request has already been sent back to the server before this event is emitted.