https://github.com/0x46616c6b/etherpad-lite-client

PHP Client for Etherpad Lite
https://github.com/0x46616c6b/etherpad-lite-client

etherpad etherpad-lite php php-client

Last synced: about 1 month ago
JSON representation

PHP Client for Etherpad Lite

• Host: GitHub
• URL: https://github.com/0x46616c6b/etherpad-lite-client
• Owner: 0x46616c6b
• License: gpl-3.0
• Created: 2013-09-12T20:59:46.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2023-03-06T09:56:32.000Z (about 2 years ago)
• Last Synced: 2024-04-25T20:04:28.411Z (about 1 year ago)
• Topics: etherpad, etherpad-lite, php, php-client
• Language: PHP
• Size: 167 KB
• Stars: 14
• Watchers: 4
• Forks: 9
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PHP Client for Etherpad Lite

![Continuous Integration](https://github.com/0x46616c6b/etherpad-lite-client/workflows/Continuous%20Integration/badge.svg) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/0x46616c6b/etherpad-lite-client/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/0x46616c6b/etherpad-lite-client/?branch=master) [![Code Coverage](https://scrutinizer-ci.com/g/0x46616c6b/etherpad-lite-client/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/0x46616c6b/etherpad-lite-client/?branch=master) [![Latest Stable Version](https://poser.pugx.org/0x46616c6b/etherpad-lite-client/v/stable.png)](https://packagist.org/packages/0x46616c6b/etherpad-lite-client) [![License](https://poser.pugx.org/0x46616c6b/etherpad-lite-client/license.png)](https://packagist.org/packages/0x46616c6b/etherpad-lite-client)

This package provides an easy access to [Etherpad Lite](https://github.com/ether/etherpad-lite) throw there built-in [HTTP API](http://etherpad.org/doc/v1.2.11/#index_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)

    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