Download the PHP package hoa/irc without Composer
On this page you can find all versions of the php package hoa/irc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package irc
Short Description The Hoa\Irc library.
License BSD-3-Clause
Homepage https://hoa-project.net/
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package irc
Hoa is a modular, extensible and
structured set of PHP libraries.
Moreover, Hoa aims at being a bridge between industrial and research worlds.
Hoa\Irc
This library allows to write an IRC client, and interact through listeners and simple methods.
Installation
With Composer, to include this library into
your dependencies, you need to
require hoa/irc:
For more installation procedures, please read the Source page.
Testing
Before running the test suites, the development dependencies must be installed:
Then, to run all the test suites:
For more information, please read the contributor guide.
Quick usage
We propose a quick overview of a simple client that joins a channel and interacts to mentions. Next, we will enhance this client with a WebSocket server to receive external messages.
Interact to mentions
The Hoa\Irc\Client proposes the following listeners: open, join,
message, private-message, mention, other-message, ping, kick,
invite and error.
In order to connect to an IRC server, we have to use a socket client, such as:
Then, we attach our listeners. When the connexion will be opened, we will join a
channel, for example #hoaproject with the Gordon username:
Next, when someone will mention Gordon, we will answer What?:
Finally, to run the client:
Include a WebSocket server
We can add a WebSocket server to receive external messages we will forward to the IRC client. Thus, the beginning of our program will look like:
Then, we will forward all messages received by the WebSocket server to the IRC client:
Finally, to run both the IRC client and WebSocket server:
To send a message to the WebSocket server, we can use a WebSocket client in CLI:
Documentation
The
hack book of Hoa\Irc
contains detailed information about how to use this library and how it works.
To generate the documentation locally, execute the following commands:
More documentation can be found on the project's website: hoa-project.net.
Getting help
There are mainly two ways to get help:
- On the
#hoaprojectIRC channel, - On the forum at users.hoa-project.net.
Contribution
Do you want to contribute? Thanks! A detailed contributor guide explains everything you need to know.
License
Hoa is under the New BSD License (BSD-3-Clause). Please, see
LICENSE for details.
All versions of irc with dependencies
hoa/event Version ~1.0
hoa/exception Version ~1.0
hoa/socket Version ~1.0