Gidkom\OpenFireRestApi\OpenFireRestApi

Complexity

Total Complexity

42

Size/Duplication

Total Lines	521
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	12
Bugs	1	Features	0

41 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getUsers()	0	9	2
A	getUser()	0	5	1
A	addUser()	0	5	1
A	deleteUser()	0	5	1
A	updateUser()	0	5	1
A	userGroups()	0	5	1
A	addToGroups()	0	5	1
A	addToGroup()	0	5	1
A	deleteFromGroup()	0	5	1
A	lockoutUser()	0	5	1
A	unlockUser()	0	5	1
A	userRosters()	0	5	1
A	addToRoster()	0	5	1
A	deleteFromRoster()	0	5	1
A	updateRoster()	0	5	1
A	getChatRoom()	0	4	1
A	getAllChatRooms()	0	4	1
A	createChatRoom()	0	4	1
A	updateChatRoom()	0	4	1
A	deleteChatRoom()	0	4	1
A	getChatRoomParticipants()	0	4	1
A	getChatRoomOccupants()	0	4	1
A	addUserRoleToChatRoom()	0	4	1
A	addGroupRoleToChatRoom()	0	4	1
A	deleteChatRoomUser()	0	4	1
A	getSystemProperties()	0	4	1
A	getSystemProperty()	0	4	1
A	createSystemProperty()	0	4	1
A	updateSystemProperty()	0	4	1
A	deleteSystemProperty()	0	4	1
A	getConcurrentSessons()	0	4	1
A	getGroups()	0	5	1
A	getGroup()	0	5	1
A	createGroup()	0	5	1
A	deleteGroup()	0	5	1
A	updateGroup()	0	5	1
A	getSessions()	0	5	1
A	getUserSessions()	0	5	1
A	closeUserSessions()	0	5	1
A	broadcastMessage()	0	6	1

<?php
	
namespace Gidkom\OpenFireRestApi;

use \Gidkom\OpenFireRestApi\RestClient;

class OpenFireRestApi extends RestClient
{


    public function __construct()
    {
        parent::__construct();

    }   

    

    /**
     * Get all registered users
     *
     * @return json|false       Json with data or error, or False when something went fully wrong
     */
    public function getUsers($opts = [])
    {
        $query = '';
        
        if(isset($opts['search'])) $query .= '?search='.$opts['search'];
        
    	$endpoint = '/users'.$query;        
    	return $this->doRequest('GET', $endpoint);
    }


    /**
     * Get information for a specified user
     *
     * @return json|false       Json with data or error, or False when something went fully wrong
     */
    public function getUser($username)
    {
        $endpoint = '/users/'.$username; 
        return $this->doRequest('GET', $endpoint);
    }


    /**
     * Creates a new OpenFire user
     *
     * @param   string          $username   Username
     * @param   string          $password   Password
     * @param   string|false    $name       Name    (Optional)
     * @param   string|false    $email      Email   (Optional)
     * @param   string[]|false  $groups     Groups  (Optional)
     * @return  json|false                 Json with data or error, or False when something went fully wrong
     */
    public function addUser($username, $password, $name=false, $email=false, $groups=false)
    {
        $endpoint = '/users'; 
        return $this->doRequest('POST', $endpoint, compact('username', 'password','name','email', 'groups'));
    }


    /**
     * Deletes an OpenFire user
     *
     * @param   string          $username   Username
     * @return  json|false                 Json with data or error, or False when something went fully wrong
     */
    public function deleteUser($username)
    {
        $endpoint = '/users/'.$username; 
        return $this->doRequest('DELETE', $endpoint);
    }

    /**
     * Updates an OpenFire user
     *
     * @param   string          $username   Username
     * @param   string|false    $password   Password (Optional)
     * @param   string|false    $name       Name (Optional)
     * @param   string|false    $email      Email (Optional)
     * @param   string[]|false  $groups     Groups (Optional)
     * @return  json|false                 Json with data or error, or False when something went fully wrong
     */
    public function updateUser($username, $password, $name=false, $email=false, $groups=false)
    {
        $endpoint = '/users/'.$username; 
        return $this->doRequest('PUT', $endpoint, compact('username', 'password','name','email', 'groups'));
    }


    /**
     * Retrieve all user groups
     *
     * @param   string          $username   Username
     * @return  json|false                 Json with data or error, or False when something went fully wrong
     */
    public function userGroups($username)
    {
        $endpoint = '/users/'.$username.'/groups'; 
        return $this->doRequest('GET', $endpoint);
    }

    /**
     * Add user to groups
     *
     * @param   string          $username   Username
     * @param   Array           $groups   Groups to add user
     * @return  json|false                 Json with data or error, or False when something went fully wrong
     */
    public function addToGroups($username, $groups)
    {
        $endpoint = '/users/'.$username.'/groups'; 
        return $this->doRequest('POST', $endpoint, $groups);
    }

    /**
     * Add user to a group
     *
     * @param   string          $username   Username
     * @param   string           $groups   Groups to add user

There is no parameter named $groups. Was it maybe removed?

     * @return  json|false                 Json with data or error, or False when something went fully wrong
     */
    public function addToGroup($username, $groupName)
    {
        $endpoint = '/users/'.$username.'/groups/'.$groupName; 
        return $this->doRequest('POST', $endpoint );
    }


    /**
     * Delete user from a group
     *
     * @param   string          $username   Username
     * @param   string           $groups   Groups to add user

There is no parameter named $groups. Was it maybe removed?

     * @return  json|false                 Json with data or error, or False when something went fully wrong
     */
    public function deleteFromGroup($username, $groupName)
    {
        $endpoint = '/users/'.$username.'/groups/'.$groupName; 
        return $this->doRequest('DELETE', $endpoint );
    }


    /**
     * lockout/Disable an OpenFire user
     *
     * @param   string          $username   Username
     * @return  json|false                 Json with data or error, or False when something went fully wrong
     */
    public function lockoutUser($username)
    {
        $endpoint = '/lockouts/'.$username; 
        return $this->doRequest('POST', $endpoint);
    }


    /**
     * unlocks an OpenFire user
     *
     * @param   string          $username   Username
     * @return  json|false                 Json with data or error, or False when something went fully wrong
     */
    public function unlockUser($username)
    {
        $endpoint = '/lockouts/'.$username; 
        return $this->doRequest('DELETE', $endpoint);
    }


    /**
     * List user rosters
     *
     * @param   string          $username           Username
     * @return  json|false                          Json with data or error, or False when something went fully wrong
     */
    public function userRosters($username)
    {
        $endpoint = '/users/'.$username.'/roster';
        return $this->doRequest('GET', $endpoint, compact('jid','name','subscriptionType'));
    }


    /**
     * Adds to this OpenFire user's roster
     *
     * @param   string          $username       	Username
     * @param   string          $jid            	JID
     * @param   string|false    $name           	Name         (Optional)
     * @param   int|false       $subscriptionType   	Subscription (Optional)
     * @return  json|false                     		Json with data or error, or False when something went fully wrong
     */
    public function addToRoster($username, $jid, $name=false, $subscriptionType=false)
    {
        $endpoint = '/users/'.$username.'/roster';
        return $this->doRequest('POST', $endpoint, compact('jid','name','subscriptionType'));
    }


    /**
     * Removes from this OpenFire user's roster
     *
     * @param   string          $username   Username
     * @param   string          $jid        JID
     * @return  json|false                 Json with data or error, or False when something went fully wrong
     */
    public function deleteFromRoster($username, $jid)
    {
        $endpoint = '/users/'.$username.'/roster/'.$jid;
        return $this->doRequest('DELETE', $endpoint, $jid);
    }

    /**
     * Updates this OpenFire user's roster
     *
     * @param   string          $username           Username
     * @param   string          $jid                 JID
     * @param   string|false    $nickname           Nick Name (Optional)
     * @param   int|false       $subscriptionType   Subscription (Optional)
     * @return  json|false                          Json with data or error, or False when something went fully wrong
     */
    public function updateRoster($username, $jid, $nickname=false, $subscriptionType=false)

The parameter $nickname is not used and could be removed.

    {
        $endpoint = '/users/'.$username.'/roster/'.$jid;
        return $this->doRequest('PUT', $endpoint, $jid, compact('jid','username','subscriptionType'));     

The call to OpenFireRestApi::doRequest() has too many arguments starting with compact('jid', 'username', 'subscriptionType').

    }

   


    /**
     * Gell all active sessions
     *
     * @return json|false       Json with data or error, or False when something went fully wrong
     */
    public function getChatRoom($name)
    {
        return $this->doRequest('GET', '/chatrooms/'.$name);
    }
	
    /**
     * Gell all chat rooms
     *
     * @return json|false       Json with data or error, or False when something went fully wrong
     */
    public function getAllChatRooms()
    {
        return $this->doRequest('GET', '/chatrooms?type=all');
    }


    /**
     * Create a chat room
     *
     * @param   string          $params        Params
     * @return  json|false                     Json with data or error, or False when something went fully wrong
     */
    public function createChatRoom($params = [])
    {
        return $this->doRequest('POST', '/chatrooms', $params);

It seems like $params defined by parameter $params on line 259 can also be of type string; however, Gidkom\OpenFireRestApi\RestClient::doRequest() does only seem to accept array, maybe add an additional type check?

    }


    /**
     * Update a chat room
     *
     * @param   string          $params        Params
     * @return  json|false                     Json with data or error, or False when something went fully wrong
     */
    public function updateChatRoom($roomName, $params = [])
    {
        return $this->doRequest('PUT', '/chatrooms/'.$roomName, $params);

It seems like $params defined by parameter $params on line 271 can also be of type string; however, Gidkom\OpenFireRestApi\RestClient::doRequest() does only seem to accept array, maybe add an additional type check?

    }


    /**
     * Delete a chat room
     *
     * @param   string      $name               Name of the Group to delete

There is no parameter named $name. Was it maybe removed?

     * @return  json|false                       Json with data or error, or False when something went fully wrong
     */
    public function deleteChatRoom($roomName)
    {
        return $this->doRequest('DELETE', '/chatrooms/'.$roomName);
    }

    /**
     * Get chat room participants
     *
     * @param   string      $name               Name of the chatroom

There is no parameter named $name. Was it maybe removed?

     * @return  json|false                       Json with data or error, or False when something went fully wrong
     */
    public function getChatRoomParticipants($roomName)      
    {
        return $this->doRequest('GET', '/chatrooms/'.$roomName.'/participants');
    }

    /**
     * Get chat room occupants
     *
     * @param   string      $name               Name of the chatroom

There is no parameter named $name. Was it maybe removed?

     * @return  json|false                       Json with data or error, or False when something went fully wrong
     */
    public function getChatRoomOccupants($roomName)      
    {
        return $this->doRequest('GET', '/chatrooms/'.$roomName.'/occupants');
    }

    /**
     * Add user with role to chatroom
     *
     * @param   string      $name               Name of the user or jid
     * @return  json|false                       Json with data or error, or False when something went fully wrong
     */
    public function addUserRoleToChatRoom($roomName, $name, $roles)
    {
        return $this->doRequest('POST', '/chatrooms/'.$roomName.'/'.$roles.'/'.$name);
    }


    /**
     * Add group with role to chatroom
     *
     * @param   string      $name               Name of the group
     * @return  json|false                       Json with data or error, or False when something went fully wrong
     */
    public function addGroupRoleToChatRoom($roomName, $name, $roles)
    {
        return $this->doRequest('POST', '/chatrooms/'.$roomName.'/'.$roles.'/group/'.$name);
    }


    /**
     * Delete a user from a chat room
     *
     * @param   string      $name               Name of the group
     * @return  json|false                       Json with data or error, or False when something went fully wrong
     */
    public function deleteChatRoomUser($roomName, $name, $roles)
    {
        return $this->doRequest('DELETE', '/chatrooms/'.$roomName.'/'.$roles.'/'.$name);
    }


    /**
     * Retrieve all system properties
     *
     * @return  json|false                       Json with data or error, or False when something went fully wrong
     */
    public function getSystemProperties()
    {
        return $this->doRequest('GET', '/system/properties');
    }

    /**
     * Retrieve a system property
     *
     * @param   string      $name                Name of property

There is no parameter named $name. Was it maybe removed?

     * @return  json|false                       Json with data or error, or False when something went fully wrong
     */
    public function getSystemProperty($propertyName)
    {
        return $this->doRequest('GET', '/system/properties/'.$propertyName);
    }


    /**
     * Create a system property
     *
     * @param   array      $data                new property with value
     * @return  json|false                       Json with data or error, or False when something went fully wrong
     */
    public function createSystemProperty($data)
    {
        return $this->doRequest('POST', '/system/properties', $data);
    }


    /**
     * Update a system property
     *
     * @param   string     $propertyName        name of property to update
     * @param   array      $data                new property with value
     * @return  json|false                       Json with data or error, or False when something went fully wrong
     */
    public function updateSystemProperty($propertyName, $data)
    {
        return $this->doRequest('POST', '/system/properties/'.$propertyName, $data);
    }


    /**
     * Delete a system property
     *
     * @param   array      $data                new property with value

There is no parameter named $data. Was it maybe removed?

     * @return  json|false                       Json with data or error, or False when something went fully wrong
     */
    public function deleteSystemProperty($propertyName)
    {
        return $this->doRequest('DELETE', '/system/properties/'.$propertyName);
    }


    /**
     * Retrieve concurrent sessions
     *
     * @return  json|false                       Json with data or error, or False when something went fully wrong
     */
    public function getConcurrentSessons()
    {
        return $this->doRequest('GET', '/system/statistics/sessions');
    }


     /**
     * Get all groups
     *
     * @return  json|false      Json with data or error, or False when something went fully wrong
     */
    public function getGroups()
    {
        $endpoint = '/groups';
        return $this->doRequest('GET', $endpoint);
    }

    /**
     *  Retrieve a group
     *
     * @param  string   $name                       Name of group
     * @return  json|false                          Json with data or error, or False when something went fully wrong
     */
    public function getGroup($name)
    {
        $endpoint = '/groups/'.$name;
        return $this->doRequest('GET', $endpoint);
    }

    /**
     * Create a group 
     *
     * @param   string   $name                      Name of the group
     * @param   string   $description               Some description of the group
     *
     * @return  json|false                          Json with data or error, or False when something went fully wrong
     */
    public function createGroup($name, $description = false)
    {
        $endpoint = '/groups/';
        return $this->doRequest('POST', $endpoint, compact('name','description'));
    }

    /**
     * Delete a group
     *
     * @param   string      $name               Name of the Group to delete
     * @return  json|false                          Json with data or error, or False when something went fully wrong
     */
    public function deleteGroup($name)
    {
        $endpoint = '/groups/'.$name;
        return $this->doRequest('DELETE', $endpoint);
    }

    /**
     * Update a group (description)
     *
     * @param   string      $name               Name of group
     * @param   string      $description        Some description of the group
     *
     */
    public function updateGroup($name,  $description)
    {
        $endpoint = '/groups/'.$name;
        return $this->doRequest('PUT', $endpoint, compact('name','description'));
    }


    /**
     * Retrieve all sessions
     *
     * @return json|false       Json with data or error, or False when something went fully wrong
     */
    public function getSessions()
    {
        $endpoint = '/sessions';
        return $this->doRequest('GET', $endpoint);
    }

    /**
     * Retrieve all user sessions
     *
     * @param   string      $username               Username of user
     * @return json|false       Json with data or error, or False when something went fully wrong
     */
    public function getUserSessions($username)
    {
        $endpoint = '/sessions/'.$username;
        return $this->doRequest('GET', $endpoint);
    }


    /**
     * Close all user sessions
     * @param string      $username               Username of user 
     * @return json|false       Json with data or error, or False when something went fully wrong
     */
    public function closeUserSessions($username)
    {
        $endpoint = '/sessions/'.$username;
        return $this->doRequest('DELETE', $endpoint);
    }

    /**
     * Send a broadcast message to all online users
     *
     * @param  string      $content               message to send

There is no parameter named $content. Was it maybe removed?

     * @return json|false       Json with data or error, or False when something went fully wrong
     */
    public function broadcastMessage($message = '')
    {
        $content =['body'=> $message];
        $endpoint = '/messages/users';
        return $this->doRequest('POST', $endpoint, $content);
    }

}