Skip to content

0x46616c6b/etherpad-lite-client

Repository files navigation

PHP Client for Etherpad Lite

Continuous Integration Scrutinizer Code Quality Code Coverage Latest Stable Version License

This package provides an easy access to Etherpad Lite throw there built-in HTTP API.

Supported API Version: 1.3.0 (Release: 1.7.5)

Installation

Install the package via Composer

composer require 0x46616c6b/etherpad-lite-client

Example (after install)

<?php

$client = new \EtherpadLite\Client($apikey);
// if you don't use http://localhost:9001
//$client = new \EtherpadLite\Client($apikey, 'http://example.com:9001');

/** @var $response \EtherpadLite\Response */
$response = $client->checkToken();

echo $response->getCode();
echo $response->getMessage();
echo $response->getData();

Testing

vendor/bin/phpunit

# Integration Tests
# > requires a running etherpad lite instance
#
# Environment Variables:
# ----------------------
# 		API_KEY=cqOtzCYEUyzR23s8tftePVo8HHO
# 		BASE_URL=http://localhost:9001

vendor/bin/behat -f progress

Contributing

Feel free to contribute to this repository.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request