EtherpadLite\Client

Complexity

Total Complexity

6

Size/Duplication

Total Lines	117
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Test Coverage

Coverage

88.89%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	__call()	0	10	2
A	generatePadID()	0	12	2
A	getMethods()	0	53	1

<?php

namespace EtherpadLite;

use EtherpadLite\Exception\UnsupportedMethodException;

/**
 * Class Client
 *
 * @package EtherpadLite
 *
 * @method Response createGroup() creates a new group
 * @method Response createGroupIfNotExistsFor($groupMapper) this functions helps you to map your application group ids to etherpad lite group ids
 * @method Response deleteGroup($groupID) deletes a group
 * @method Response listPads($groupID) returns all pads of this group
 * @method Response createGroupPad($groupID, $padName, $text = null) creates a new pad in this group
 * @method Response listAllGroups() lists all existing groups
 *
 * @method Response createAuthor($name = null) creates a new author
 * @method Response createAuthorIfNotExistsFor($authorMapper, $name = null) this functions helps you to map your application author ids to etherpad lite author ids
 * @method Response listPadsOfAuthor($authorID) returns an array of all pads this author contributed to
 * @method Response getAuthorName($authorID) Returns the Author Name of the author
 *
 * @method Response createSession($groupID, $authorID, $validUntil) creates a new session. validUntil is an unix timestamp in seconds
 * @method Response deleteSession($sessionID) deletes a session by id
 * @method Response getSessionInfo($sessionID) returns informations about a session
 * @method Response listSessionsOfGroup($groupID) returns all sessions of a group
 * @method Response listSessionsOfAuthor($authorID) returns all sessions of an author
 *
 * @method Response getText($padID, $rev = null) returns the text of a pad
 * @method Response setText($padID, $text) sets the text of a pad
 * @method Response appendText($padID, $text) appends text to a pad
 * @method Response getHTML($padID, $rev = null) returns the text of a pad formatted as HTML
 * @method Response setHTML($padID, $html) sets the html of a pad
 * @method Response getAttributePool($padID) returns the attribute pool of a pad
 * @method Response getRevisionChangeset($padID, $revision = null) get the changeset at a given revision, or last revision if 'rev' is not defined.
 * @method Response createDiffHTML($padID, $startRev, $endRev) returns an object of diffs from 2 points in a pad
 * @method Response restoreRevision($padID, $revision) restores revision from past as new changeset
 *
 * @method Response getChatHistory($padID, $start = null, $end = null) a part of the chat history, when start and end are given, the whole chat histroy, when no extra parameters are given
 * @method Response getChatHead($padID) returns the chatHead (last number of the last chat-message) of the pad
 * @method Response appendChatMessage($padID, $text, $authorID, $time = null) creates a chat message, saves it to the database and sends it to all connected clients of this pad
 *
 * @method Response createPad($padID, $text = null) creates a new (non-group) pad. Note that if you need to create a group Pad, you should call createGroupPad.
 * @method Response getRevisionsCount($padID) returns the number of revisions of this pad
 * @method Response getSavedRevisionsCount($padID) returns the number of saved revisions of this pad
 * @method Response listSavedRevisions($padID) returns a list of saved revisions of this pad
 * @method Response saveRevision($padID, $revision = null) save a revision of a pad
 * @method Response padUsersCount($padID) returns the number of user that are currently editing this pad
 * @method Response padUsers($padID) returns the list of users that are currently editing this pad
 * @method Response deletePad($padID) deletes a pad
 * @method Response movePad($sourceID, $destinationID, $force = false) moves a pad. If force is true and the destination pad exists, it will be overwritten.
 * @method Response copyPad($sourceID, $destinationID, $force = false) copies a pad with full history and chat. If force is true and the destination pad exists, it will be overwritten.
 * @method Response getReadOnlyID($padID) returns the read only link of a pad
 * @method Response getPadID($readOnlyID) returns the id of a pad which is assigned to the readOnlyID
 * @method Response setPublicStatus($padID, $publicStatus) sets a boolean for the public status of a pad
 * @method Response getPublicStatus($padID) return true of false
 * @method Response setPassword($padID, $password) returns ok or a error message
 * @method Response isPasswordProtected($padID) returns true or false
 * @method Response listAuthorsOfPad($padID) returns an array of authors who contributed to this pad
 * @method Response getLastEdited($padID) returns the timestamp of the last revision of the pad
 * @method Response sendClientsMessage($padID, $msg) sends a custom message of type $msg to the pad
 * @method Response checkToken() returns ok when the current api token is valid
 *
 * @method Response listAllPads() lists all pads on this epl instance
 *
 */
class Client
{
    const API_VERSION = '1.2.13';

    /**
     * @var string|null
     */
    private $apikey = null;
    /**
     * @var string|null
     */
    private $url = null;

    /**
     * @param string $apikey
     * @param string $url
     */
    public function __construct(string $apikey, string $url = 'http://localhost:9001')
    {
        $this->apikey = $apikey;
        $this->url = $url;
    }

    /**
     * @param string $method
     * @param array $args
     * @return Response
     * @throws Exception\UnsupportedMethodException
     */
    public function __call(string $method, $args = []): Response
    {
        if (!in_array($method, array_keys(self::getMethods()))) {
            throw new UnsupportedMethodException();
        }

        $request = new Request($this->url, $this->apikey, $method, $args);

        return new Response($request->send());
    }

    /**
     * Generates a random padID
     *
     * @return string
     */
    public function generatePadID(): string
    {
        $chars = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
        $length = 16;
        $padID = "";

        for ($i = 0; $i < $length; $i++) {
            $padID .= $chars[rand() % strlen($chars)];
        }

        return $padID;
    }

    /**
     * Array that holds the available methods and their required parameter names
     *
     * @return array
     */
    public static function getMethods(): array
    {
        return [
            'createGroup' => [],
            'createGroupIfNotExistsFor' => ['groupMapper'],
            'deleteGroup' => ['groupID'],
            'listPads' => ['groupID'],
            'createGroupPad' => ['groupID', 'padName', 'text'],
            'listAllGroups' => [],
            'createAuthor' => ['name'],
            'createAuthorIfNotExistsFor' => ['authorMapper', 'name'],
            'listPadsOfAuthor' => ['authorID'],
            'getAuthorName' => ['authorID'],
            'createSession' => ['groupID', 'authorID', 'validUntil'],
            'deleteSession' => ['sessionID'],
            'getSessionInfo' => ['sessionID'],
            'listSessionsOfGroup' => ['groupID'],
            'listSessionsOfAuthor' => ['authorID'],
            'getText' => ['padID', 'rev'],
            'setText' => ['padID', 'text'],
            'appendText' => ['padID', 'text'],
            'getHTML' => ['padID', 'rev'],
            'setHTML' => ['padID', 'html'],
            'getAttributePool' => ['padID'],
            'createDiffHTML' => ['padID', 'startRev', 'endRev'],
            'restoreRevision' => ['padID', 'rev'],
            'getRevisionChangeset' => ['padID'],
            'getChatHistory' => ['padID', 'start', 'end'],
            'getChatHead' => ['padID'],
            'appendChatMessage' => ['padID', 'text', 'authorID'],
            'createPad' => ['padID', 'text'],
            'getRevisionsCount' => ['padID'],
            'getSavedRevisionsCount' => ['padID'],
            'listSavedRevisions' => ['padID'],
            'saveRevision' => ['padID'],
            'padUsersCount' => ['padID'],
            'padUsers' => ['padID'],
            'deletePad' => ['padID'],
            'movePad' => ['sourceID', 'destinationID'],
            'copyPad' => ['sourceID', 'destinationID'],
            'getReadOnlyID' => ['padID'],
            'getPadID' => ['readOnlyID'],
            'setPublicStatus' => ['padID', 'publicStatus'],
            'getPublicStatus' => ['padID'],
            'setPassword' => ['padID', 'password'],
            'isPasswordProtected' => ['padID'],
            'listAuthorsOfPad' => ['padID'],
            'getLastEdited' => ['padID'],
            'sendClientsMessage' => ['padID', 'msg'],
            'checkToken' => [],
            'listAllPads' => [],
        ];
    }
}