jeroendesloovere/showpad-php-api

This Showpad PHP class connects to the Showpad API.

Showpad PHP wrapper class

, _(*1)

This Showpad PHP wrapper class connects to the Showpad API., _(*2)

Usage

Installation

``` json { "require": { "jeroendesloovere/showpad-php-api": "1.0.*" } }, <sub>(*3)</sub>

> Adding this code in your `composer.json` file will get the [latest GitHub package](https://packagist.org/packages/jeroendesloovere/showpad-php-api) using [Composer](https://getcomposer.org).

### Example

$showpadUsername = ''; $showpadApiKey = '';, <sub>(*4)</sub>

// define api $api = new JeroenDesloovere\Showpad\Showpad( $showpadUsername, $showpadApiKey );, <sub>(*5)</sub>

// get all users $items = $api->users->getAll();, <sub>(*6)</sub>

// get all user groups $items = $api->userGroups->getAll(); ... ```, <sub>(*7)</sub>

View all examples or check the Showpad class., <sub>(*8)</sub>

Work in progress

Jeroen Desloovere started this class to test if it is possible to make connection to the API of Showpad. It was possible and the base is set for this class. All functions in this class work, excepts the assets->create is untested (didn't worked offline). Every subClass has its getAll() function, other functions aren't defined yet., <sub>(*9)</sub>

Documentation

The class is well documented inline. If you use a decent IDE you'll see that each method is documented with PHPDoc., <sub>(*10)</sub>

Contributing

It would be great if you could help us improve this class. GitHub does a great job in managing collaboration by providing different tools, the only thing you need is a GitHub login., <sub>(*11)</sub>

• Use Pull requests to add or update code
• Issues for bug reporting or code discussions
• Or regarding documentation and how-to's, check out Wiki More info on how to work with GitHub on help.github.com.

License

The module is licensed under MIT. In short, this license allows you to do everything as long as the copyright statement stays present., <sub>(*12)</sub>