Skip to content

millfreedom/CakePHP-API-Manager

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

47 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CakePHP Notification Manager

MySQL and CRON based notification manager for CakePHP.

Background

Supports notification setup for email, push notification.

Requirements

  • PHP >= 5.3
  • CakePHP 2.x
  • Basic knowledge of Exceptions in CakePHP

Installation

[Manual]

[GIT Submodule]

In your app directory type:

git submodule add git://github.com/asugai/CakePHP-Exception-Manager.git Plugin/ExceptionManager
git submodule update --init

[GIT Clone]

In your app directory type

git clone git://github.com/asugai/CakePHP-Exception-Manager.git Plugin/ExceptionManager

Enable plugin

Enable the plugin your app/Config/bootstrap.php file:

CakePlugin::load('ExceptionManager');

If you are already using CakePlugin::loadAll();, then this is not necessary.

Usage

Setup ExceptionManager

Setup the autoloader if you are using composer in /app/Config/bootstrap.php:

// Load composer autoload.
require APP . '/Vendor/autoload.php';

// Remove and re-prepend CakePHP's autoloader as composer thinks it is the most important.
// See https://github.com/composer/composer/commit/c80cb76b9b5082ecc3e5b53b1050f76bb27b127b
spl_autoload_unregister(array('App', 'load'));
spl_autoload_register(array('App', 'load'), true, true);

Optional: Edit /app/Config/bootstrap.php file and add ExceptionManager keys:

if (!Configure::read('ApiManager.softErrors')) {
    Configure::write('ApiManager.softErrors', false);
}

Throw errors!

App::uses('ApiException', 'Error/Exception');

throw new ApiException('This is not a valid API call!');

Todo

  • Comments!

Aknowledgements

The basic layout of this of this README was taken from https://github.com/dkullmann/CakePHP-Elastic-Search-DataSource

License

Copyright (c) 2013 Andre Sugai

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

A simple lib to handle common API errors

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published