119 lines
3.5 KiB
Markdown
119 lines
3.5 KiB
Markdown
# fabiang/xmpp
|
|
|
|
Library for XMPP protocol connections (Jabber) for PHP.
|
|
|
|
[](https://packagist.org/packages/fabiang/xmpp)
|
|
[](https://packagist.org/packages/fabiang/xmpp)
|
|
[](https://packagist.org/packages/fabiang/xmpp)
|
|
[](https://gemnasium.com/fabiang/xmpp)
|
|
[](https://travis-ci.org/fabiang/xmpp)
|
|
[](https://coveralls.io/r/fabiang/xmpp?branch=master)
|
|
[](https://scrutinizer-ci.com/g/fabiang/xmpp/)
|
|
[](https://insight.sensiolabs.com/projects/a535cd82-788d-4506-803e-02ede44a9e74)
|
|
|
|
## SYSTEM REQUIREMENTS
|
|
|
|
- PHP minimum 5.6 or minimum 7.0
|
|
- psr/log
|
|
- (optional) psr/log-implementation - like monolog/monolog for logging
|
|
|
|
## INSTALLATION
|
|
|
|
New to Composer? Read the [introduction](https://getcomposer.org/doc/00-intro.md#introduction). Add the following to your composer file:
|
|
|
|
```bash
|
|
composer require fabiang/xmpp
|
|
```
|
|
|
|
## DOCUMENTATION
|
|
|
|
This library uses an object to hold options:
|
|
|
|
```php
|
|
use Fabiang\Xmpp\Options;
|
|
$options = new Options($address);
|
|
$options->setUsername($username)
|
|
->setPassword($password);
|
|
```
|
|
|
|
The server address must be in the format `tcp://myjabber.com:5222`.
|
|
If the server supports TLS the connection will automatically be encrypted.
|
|
|
|
You can also pass a PSR-2-compatible object to the options object:
|
|
|
|
```php
|
|
$options->setLogger($logger)
|
|
```
|
|
|
|
The client manages the connection to the Jabber server and requires the options object:
|
|
|
|
```php
|
|
use Fabiang\Xmpp\Client;
|
|
$client = new Client($options);
|
|
// optional connect manually
|
|
$client->connect();
|
|
```
|
|
|
|
For sending data you just need to pass a object that implements `Fabiang\Xmpp\Protocol\ProtocolImplementationInterface`:
|
|
|
|
```php
|
|
use Fabiang\Xmpp\Protocol\Roster;
|
|
use Fabiang\Xmpp\Protocol\Presence;
|
|
use Fabiang\Xmpp\Protocol\Message;
|
|
|
|
// fetch roster list; users and their groups
|
|
$client->send(new Roster);
|
|
// set status to online
|
|
$client->send(new Presence);
|
|
|
|
// send a message to another user
|
|
$message = new Message;
|
|
$message->setMessage('test')
|
|
->setTo('nickname@myjabber.com')
|
|
$client->send($message);
|
|
|
|
// join a channel
|
|
$channel = new Presence;
|
|
$channel->setTo('channelname@conference.myjabber.com')
|
|
->setPassword('channelpassword')
|
|
->setNickName('mynick');
|
|
$client->send($channel);
|
|
|
|
// send a message to the above channel
|
|
$message = new Message;
|
|
$message->setMessage('test')
|
|
->setTo('channelname@conference.myjabber.com')
|
|
->setType(Message::TYPE_GROUPCHAT);
|
|
$client->send($message);
|
|
```
|
|
|
|
After all you should disconnect:
|
|
|
|
```php
|
|
$client->disconnect();
|
|
```
|
|
|
|
## DEVELOPING
|
|
|
|
If you like this library and you want to contribute, make sure the unit-tests and integration tests are running.
|
|
Composer will help you to install the right version of PHPUnit and [Behat](http://behat.org/).
|
|
|
|
composer install
|
|
|
|
After that:
|
|
|
|
./vendor/bin/phpunit
|
|
./vendor/bin/behat
|
|
|
|
New features should always tested with Behat.
|
|
|
|
## LICENSE
|
|
|
|
BSD-2-Clause. See the [LICENSE](LICENSE.md).
|
|
|
|
## TODO
|
|
|
|
- Better integration of channels
|
|
- Factory method for server addresses
|
|
- improve documentation
|