Download the PHP package vincentdewit/kazoo-php-sdk without Composer
On this page you can find all versions of the php package vincentdewit/kazoo-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download vincentdewit/kazoo-php-sdk
More information about vincentdewit/kazoo-php-sdk
Files in vincentdewit/kazoo-php-sdk
Package kazoo-php-sdk
Short Description Kazoo PHP SDK (updated)
License MIT
Homepage http://github.com/VincentdeWit/kazoo-php-sdk
Informations about the package kazoo-php-sdk
PHP Kazoo API
A simple Object Oriented wrapper for Kazoo API, written with PHP5.
NOTICE: Master is no longer backward compatibile with version 1.x
The master brach of this repo represents a new approach to the SDK, which will become version 2.x.
If you are currently using the SDK the 1.x branches will be maintained until otherwise notified.
Features
- Follows PSR-0 conventions and coding standard: autoload friendly
- Light and fast thanks to lazy loading of API classes
- Extensively tested and documented
Requirements
Dependencies for the SDK are managed using Composer. For your convience we have included the composer binary in the root directory of the project.
However, if you would like to install Composer to your local system you can run (optional):
Installing the SDK
NOTICE: These instructions are a work-in-progress. Do you have a better way? Let us know!
- Browse to the GitHub repo for the Kazoo SDK and select the branch which represents the version you wish to use.
- Click "Download ZIP"
- Unzip the SDK into your project
- The SDK follows the PSR-0 convention names for its classes, which means you should be able to easily integrate
kazoo-php-sdk
class loading in your own autoloader.
Installing the SDK (with Composer)
This assumes basic familiarization with composer. If you have not used Composer before you might read the getting started guide.
Add the following require line:
Using Composer update or install your project dependencies.
If your project is already including the auto-generated autloader, then you are done!
Example Usage
In this example we will find all admins of the account belonging to the authenticated user. It will then set "require_password_update" to true
for each admin and save it back to the db.
This is a basic example, from $sdk
object you can access the full power of Kazoo!
Check out the examples for more!
#
To see the lastest Unit testing and great examples of functions that were tested, see:
/kazoo-php-sdk/lib/hz2600/Kazoo/Tests/Functional
We need your help with version 2.x
- Version 2.x of the SDK needs to have the Entity and Collection classes for each Kazoo API built, with unit tests
- We need to create documentation
- We need testers!
Interested? Heres how to get started!
- Install your favorite webserver with PHP 5.3.2+
-
Clone the SDK from your fork to your webserver directory, in this example we will use:
-
Create a new branch for your changes
- Make changes!
-
Commit the changes
- Login to GitHub, and your should have a "Compare & pull request" button on fork. Follow the instructions provided by that tool!
Documentation
See the doc
directory for more detailed documentation.
Credits
Contributors
- Ben Wann
- Karl Anderson
- James Aimonetti
- Darren Schreiber
- Peter Defebvre
- Francis Genet
- Sean Wysor
- Thanks to KnpLabs/php-github-api for their work on the Php github api, which inspired this library
Thanks to GitHub for the high quality API and documentation.
All versions of kazoo-php-sdk with dependencies
guzzlehttp/guzzle Version >=6.2.1
monolog/monolog Version 2.1.1
php Version >=5.5