Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Enhanced RESTful controller interface for Kohana

branch: 3.1/master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 classes
Octocat-spinner-32 tests
Octocat-spinner-32 README.md
README.md

krestful

An enhanced RESTful interface for Kohana. This module extends existing Kohana Core classes to provide a more rigid RESTful interface that validates the following HTTP headers;

  • accept
  • accept-charset
  • accept-language

krestful validates the Request header and attempts to match the request accept declarations with the Restful_Controller accept options. Results are returned in order of match, sorted by quality.

In strict mode, if no matching type is found the appropriate HTTP_Exception will be thrown. Otherwise the Kohana defaults values will be used.

Usage

To use krestful, ensure the KRestful module is enabled within the Kohana application. Within the bootstrap.php module add the following:

 Kohana::$modules(array(
      'krestful'    => MODPATH.'krestful'
 ));

Note: This module modifies the inheritance tree for a number of Kohana Core classes. Ensure any inheritance conflicts are resolved within your application.

Once the krestful module is loaded, controllers can extend Controller_REST safely and receive the enhancements of this module.

The following properties can be set to the Restful_Controller class.

  1. Restful_Controller::$_accept Defines the acceptable types (mime) the controller supports. e.g. text/html, application/json, application/xml, ...
  2. Restful_Controller::$_accept_charset Defines the acceptable character sets the controller supports. e.g. utf-8, 'utf-16', 'ISO-8859-1', ...
  3. Restful_Controller::$_accept_lang Defines the acceptable languages the controller supports. e.g. en_US, en_GB, fr_FR
  4. Restful_Controller::$_accept_strict Defines if the controller will be strict and enforce on the defined acceptable arguments upon request.

The acceptable request parameters should be set in the controller definition. For example:

class Controller_Foo extends Controller_REST {

     protected $_accept = array(
          'text/html',
          'application/json',
          'application/xml'
     );

     protected $_accept_lang = array(
          'en_US',
          'en_GB'
     );

     protected $_accept_charset = array(
          'utf-8',
          'ISO-8859-1'
     );

     protected $_accept_strict = TRUE;
}

The following controller will only return either;

  • HTML, JSON or XML in
  • US or British English using
  • UTF-8 or ISO-8859-1 encoding

System Requirements

License

This software is protected by the ISC License.

Copyright (c) 2011, Sam de Freyssinet

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Something went wrong with that request. Please try again.