Gatcha Container Notify Receiver Library for PHP

copyright

Copyright 2010 Netlog NV

link

http://www.gatcha.com/downloads/gatcha_container_notifyreceiver_php

license

http://www.apache.org/licenses/LICENSE-2.0.html

About this Library

This php library helps in handling Gatcha! notifications sent to Gatcha! containers. More information on http://www.gatcha.com/downloads/gatcha_container_notifyreceiver_php.

What's New?

See the "CHANGELOG" file for an overview of the history of this library

Prerequisites

• Gatcha API Container Account (http://www.gatcha.com)
• PHP 5.2.1 or newer (http://www.php.net)
• This library uses, a.o., these php functionality:
  • json_decode() / json_encode()

Quick Start

This library comes with a test-run that showcases handling all possible events. To get started with the library, follow these steps:

1. Make sure you're registered at Gatcha! as a Container. http://www.gatcha.com/about/contact
2. Extract the source zip file into a working directory or get the sources form the subversion server.
3. Edit the "configuration.inc.php" file. (See comments in that file for further instructions. Use "configuration.inc.example.php" as a reference.)
4. Create a class that implements the interface Gatcha_Container_NotifyReceiver_EventHandlers_Interface and register it as your event handler class in the "configuration.inc.php" file.
5. Edit the configuration file to run in test mode and run

   $ php ./class.gatcha_container.notifyreceiver.php

6. All functions of your Event Handler class should now have been called with dummy test data.
7. Include the library somewhere in your project and set-up the url to it as the notification-url for your container account. (Make sure that your configuration file contains the right secret for this url.)

Documentation

• Head over to http://www.gatcha.com for more documentation.
• In the "/docs" folder of this library you get class and function documentation for the files in this library. This documentation is based on the inline phpDoc and generated by phpDoctor.

Comments, Questions or Feedback

If you have any comments, questions or feedback on this library, please get in touch: http://www.gatcha.com/about

Happy coding!