https://github.com/gamenet/php-jabber-rpc

PHP wrapper for ejabberd xml-rpc module
https://github.com/gamenet/php-jabber-rpc

Last synced: 3 months ago
JSON representation

PHP wrapper for ejabberd xml-rpc module

• Host: GitHub
• URL: https://github.com/gamenet/php-jabber-rpc
• Owner: gamenet
• License: mit
• Created: 2014-05-05T10:24:46.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2016-10-22T18:47:46.000Z (about 8 years ago)
• Last Synced: 2024-09-26T20:55:59.814Z (3 months ago)
• Language: PHP
• Homepage:
• Size: 50.8 KB
• Stars: 18
• Watchers: 7
• Forks: 13
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# php-jabber-rpc #

[![Build Status](https://travis-ci.org/gamenet/php-jabber-rpc.svg?branch=master)](https://travis-ci.org/gamenet/php-jabber-rpc)

[![Latest Stable Version](https://poser.pugx.org/gamenet/php-jabber-rpc/v/stable.png)](https://packagist.org/packages/gamenet/php-jabber-rpc)

[![Code Coverage](https://scrutinizer-ci.com/g/gamenet/php-jabber-rpc/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/gamenet/php-jabber-rpc/?branch=master)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/gamenet/php-jabber-rpc/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/gamenet/php-jabber-rpc/?branch=master)

[![Latest Unstable Version](https://poser.pugx.org/gamenet/php-jabber-rpc/v/unstable.png)](https://packagist.org/packages/gamenet/php-jabber-rpc)

[![License](https://poser.pugx.org/gamenet/php-jabber-rpc/license.png)](https://packagist.org/packages/gamenet/php-jabber-rpc)

# About #

[mod_xmlrpc](http://www.ejabberd.im/ejabberd+integration+with+XMLRPC+API) is a module for [ejabberd](http://www.ejabberd.im/),

a XMPP/Jabber server written in Erlang. It starts a XML-RPC server and waits for external requests. Implemented calls include

statistics and user administration. This allows external programs written in any language like websites or administrative tools

to communicate with ejabberd to get information or to make changes without the need to know ejabberd internals.

One example usage is a corporate site in PHP that creates a Jabber user every time a new user is created on the website. Some

 benefits of interfacing with the Jabber server by XML-RPC instead of modifying directly the database are:

 * external programs are more simple and easy to develop and debug

 * can communicate with a server in a different machine, and even on Internet

This library is an simple wrapper above php xmlrpc module to simplify ejabberd mod_xmlrpc usage from php. PHP code based

on [mod_admin_extra.erl](https://github.com/processone/ejabberd-contrib/blob/master/mod_admin_extra/src/mod_admin_extra.erl)

and [mod_muc_admin.erl](https://github.com/processone/ejabberd-contrib/blob/master/mod_muc_admin/src/mod_muc_admin.erl)

 source files.

## Requirements ##

    PHP >= 5.4

## Installation ##

### Composer ###

The recommended way to install library is [composer](http://getcomposer.org).

You can see [package information on Packagist](https://packagist.org/packages/gamenet/php-jabber-rpc).

```JSON

{

	"require": {

		"gamenet/php-jabber-rpc": "*"

	}

}

```

### Do not use composer? ###

Just clone the repository and take care about autoload for namespace `GameNet`.

# Usage #

Basic usage looks like this:

```php

    $rpc = new \GameNet\Jabber\RpcClient([

        'server' => 'http://127.0.0.1:4560',

        'host' => 'j.gamenet.ru',

        'debug' => false,

    ]);

    //Create 2 new users with name `Ivan` and `Petr` with password `someStrongPassword`

    $rpc->createUser('Ivan', 'someStrongPassword');

    $rpc->createUser('Petr', 'someStrongPassword');

    // Add each other in the contact list with group 'Friend'

    $rpc->addRosterItem('Ivan', 'Petr', 'Petr Ivanov', 'Friend');

    $rpc->addRosterItem('Petr', 'Ivan', 'Ivan Petrov', 'Friend');

    // Get contact list Ivan

    $contacts = $rpc->getRoster($username);

```