2017 © Pedro Peláez
 

library php-openfire-restapi

Manage Open fire server using Rest Api

image

hrn4n/php-openfire-restapi

Manage Open fire server using Rest Api

  • Sunday, June 5, 2016
  • by hrn4n
  • Repository
  • 1 Watchers
  • 0 Stars
  • 7 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 37 Forks
  • 0 Open issues
  • 2 Versions
  • 0 % Grown

The README.md

php-openfire-restapi

A simple PHP class designed to work with Openfire Rest Api plugin. It is used to remote manage the Openfire server., (*1)

LICENSE

php-openfire-restapi is licensed under MIT style license, see LICENCE for further information., (*2)

REQUIREMENTS

  • PHP 5.4+

INSTALLATION

### With Composer

The easiest way to install is via composer. Create the following composer.json file and run the composer.phar install command to install it., (*3)

{
    "require": {
        "hrn4n/php-openfire-restapi": "dev-master"
    }
}

USAGE

include "vendor/autoload.php";

// Create the Openfire Rest api object
$api = new Gidkom\OpenFireRestApi\OpenFireRestApi;

// Set the required config parameters
$api->secret = "MySecret";
$api->host = "jabber.myserver.com";
$api->port = "9090";  // default 9090

// Optional parameters (showing default values)

$api->useSSL = false;
$api->plugin = "/plugins/restapi/v1";  // plugin 

// Add a new user to OpenFire and add to a group
$result = $api->addUser('Username', 'Password', 'Real Name', 'johndoe@domain.com', array('Group 1'));

// Check result if command is succesful
if($result['status']) {
    // Display result, and check if it's an error or correct response
    echo 'Success: ';
    echo $result['message'];
} else {
    // Something went wrong, probably connection issues
    echo 'Error: ';
    echo $result['message'];
}

//Delete a user from OpenFire
$result = $api->deleteUser($username);


//Disable a user
$result = $api->lockoutUser($username);


//Enable a user
$result = $api->unlockUser($username);

/**
 * Update a user
 *
 * The $password, $name, $email, $groups arguments are optional
 * 
 */
$result = $api->updateUser($username, $password, $name, $email, $groups)

//Add to roster
$api->addToRoster($username, $jid);

//Delete from roster
$api->addToRoster($username, $jid);

//Update user roster
$api->updateRoster($username, $jid, $nickname, $subscription]);

// Get all groups
$api->getGroup();

// Retrieve group 
$api->getGroup($name);

// Create a group
$api->createGroup($group_name, $description);

// Update a group description
$api->updateGroup($group_name, $description);

// Delete a group
$api->deleteGroup($group_name);

The Versions

05/06 2016

dev-master

9999999-dev https://github.com/gidkom/php-openfire-restapi

Manage Open fire server using Rest Api

  Sources   Download

MIT

The Requires

 

by Gideon Kombian
by Hernán Ruíz

xmpp chat openfire

24/10 2015

dev-devs

dev-devs https://github.com/gidkom/php-openfire-restapi

Manage Open fire server using Rest Api

  Sources   Download

MIT

The Requires

 

by Gideon Kombian

xmpp chat openfire