Modules

  1. +Kohana
    2. Debug
    3. I18n
    4. Kohana
    5. Kohana_Core
    6. Request
    7. Request_Client
    8. Request_Client_External
    9. Request_Client_Internal
    10. Response
    11. Route
    12. UTF8
    13. View
    14. +Cache
      1. Cache_Xcache
    15. +Configuration
      1. Config
      2. Config_File
      3. Config_Reader
    16. +Controller
      1. Controller
      2. Controller_REST
      3. Controller_Template
      4. Controller_Welcome
    17. +Exceptions
      1. HTTP_Exception
      2. HTTP_Exception_400
      3. HTTP_Exception_401
      4. HTTP_Exception_402
      5. HTTP_Exception_403
      6. HTTP_Exception_404
      7. HTTP_Exception_405
      8. HTTP_Exception_406
      9. HTTP_Exception_407
      10. HTTP_Exception_408
      11. HTTP_Exception_409
      12. HTTP_Exception_410
      13. HTTP_Exception_411
      14. HTTP_Exception_412
      15. HTTP_Exception_413
      16. HTTP_Exception_414
      17. HTTP_Exception_415
      18. HTTP_Exception_416
      19. HTTP_Exception_417
      20. HTTP_Exception_500
      21. HTTP_Exception_501
      22. HTTP_Exception_502
      23. HTTP_Exception_503
      24. HTTP_Exception_504
      25. HTTP_Exception_505
      26. Kohana_Exception
      27. Kohana_Request_Exception
      28. Kohana_View_Exception
      29. Validation_Exception
    18. +HTTP
      1. HTTP
      2. HTTP_Header
      3. HTTP_Header_Value
    19. +Helpers
      1. Arr
      2. CLI
      3. Cookie
      4. Date
      5. Feed
      6. File
      7. Form
      8. Fragment
      9. HTML
      10. Inflector
      11. Num
      12. Profiler
      13. Text
      14. URL
      15. Upload
    20. +Logging
      1. Log
      2. Log_File
      3. Log_StdErr
      4. Log_StdOut
      5. Log_Syslog
      6. Log_Writer
    21. +Models
      1. Model
    22. +Security
      1. Encrypt
      2. Security
      3. Valid
      4. Validation
    23. +Session
      1. Session
      2. Session_Cookie
      3. Session_Native
  2. +Kohana/Auth
    2. Auth
    3. Auth_File
    4. Auth_ORM
    5. Model_Auth_Role
    6. Model_Auth_User
    7. Model_Auth_User_Token
    8. Model_Role
    9. Model_User
    10. Model_User_Token
  3. +Kohana/Cache
    2. Cache
    3. Cache_Apc
    4. Cache_Eaccelerator
    5. Cache_File
    6. Cache_Memcache
    7. Cache_MemcacheTag
    8. Cache_Sqlite
    9. Cache_Wincache
    10. Kohana_Cache_Exception
    11. Kohana_Cache_GarbageCollect
    12. Kohana_Cache_Tagging
  4. +Kohana/Codebench
    2. Codebench
    3. +Controllers
      1. Controller_Codebench
    4. +Tests
      1. Bench_ArrCallback
      2. Bench_AutoLinkEmails
      3. Bench_DateSpan
      4. Bench_ExplodeLimit
      5. Bench_GruberURL
      6. Bench_LtrimDigits
      7. Bench_MDDoBaseURL
      8. Bench_MDDoImageURL
      9. Bench_MDDoIncludeViews
      10. Bench_StripNullBytes
      11. Bench_Transliterate
      12. Bench_URLSite
      13. Bench_UserFuncArray
      14. Bench_ValidColor
      15. Bench_ValidURL
  5. +Kohana/Database
    2. DB
    3. Database
    4. Database_Expression
    5. +Configuration
      1. Config_Database
    6. +Drivers
      1. Database_MySQL
      2. Database_PDO
    7. +Exceptions
      1. Database_Exception
    8. +Models
      1. Model_Database
    9. +Query
      1. Database_Query
      2. Database_Query_Builder
      3. Database_Query_Builder_Delete
      4. Database_Query_Builder_Insert
      5. Database_Query_Builder_Join
      6. Database_Query_Builder_Select
      7. Database_Query_Builder_Update
      8. Database_Query_Builder_Where
    10. +Query/Result
      1. Database_MySQL_Result
      2. Database_Result
      3. Database_Result_Cached
    11. +Session
      1. Session_Database
  6. +Kohana/Image
    2. Image
    3. +Drivers
      1. Image_GD
  7. +Kohana/ORM
    2. ORM
    3. ORM_Validation_Exception
  8. +Kohana/Userguide
    2. Kodoc
    3. Kodoc_Class
    4. Kodoc_Markdown
    5. Kodoc_Method
    6. Kodoc_Method_Param
    7. Kodoc_Property
    8. +Controllers
      1. Controller_Userguide
    9. +Undocumented
      1. Kodoc_Missing
  9. +[Unknown]
    2. HTTP_Interaction
    3. HTTP_Request
    4. HTTP_Response

abstract Kohana_Controller_REST
extends Controller
extends Kohana_Controller

Abstract Controller class for RESTful controller mapping. Supports GET, PUT, POST, and DELETE. By default, these methods will be mapped to these actions:

GET
Mapped to the "index" action, lists all objects
POST
Mapped to the "create" action, creates a new object
PUT
Mapped to the "update" action, update an existing object
DELETE
Mapped to the "delete" action, delete an existing object

Additional methods can be supported by adding the method and action to the $_action_map property.

Using this class within a website will require heavy modification, due to most web browsers only supporting the GET and POST methods. Generally, this class should only be used for web services and APIs.

package
Kohana
category
Controller
author
Kohana Team
copyright
© 2009-2012 Kohana Team
license
http://kohanaframework.org/license

Class declared in SYSPATH/classes/kohana/controller/rest.php on line 31.

Constants

  • None

Properties

Methods

Properties

public Request $request

Request that created the controller

public Response $response

The response that will be returned from controller

protected array $_action_map

REST types

protected string $_action_requested

requested action

Methods

public action_invalid( ) (defined in Kohana_Controller_REST)

Sends a 405 "Method Not Allowed" response and a list of allowed actions.

Source Code

?
public function action_invalid()
{
    // Send the "Method Not Allowed" response
    $this->response->status(405)
        ->headers('Allow', implode(', ', array_keys($this->_action_map)));
}

public after( ) (defined in Kohana_Controller_REST)

undocumented function

Source Code

?
public function after()
{
    if (in_array(Arr::get($_SERVER, 'HTTP_X_HTTP_METHOD_OVERRIDE', $this->request->method()), array(
        HTTP_Request::PUT,
        HTTP_Request::POST,
        HTTP_Request::DELETE)))
    {
        $this->response->headers('cache-control', 'no-cache, no-store, max-age=0, must-revalidate');
    }
}

public before( ) (defined in Kohana_Controller_REST)

Checks the requested method against the available methods. If the method is supported, sets the request action from the map. If not supported, the "invalid" action will be called.

Source Code

?
public function before()
{
    $this->_action_requested = $this->request->action();
 
    $method = Arr::get($_SERVER, 'HTTP_X_HTTP_METHOD_OVERRIDE', $this->request->method());
 
    if ( ! isset($this->_action_map[$method]))
    {
        $this->request->action('invalid');
    }
    else
    {
        $this->request->action($this->_action_map[$method]);
    }
 
    return parent::before();
}

public __construct( Request $request , Response $response ) (defined in Kohana_Controller)

Creates a new controller instance. Each controller must be constructed with the request object that created it.

Parameters

  • Request $request required - Request that created the controller
  • Response $response required - The request's response

Return Values

  • void

Source Code

?
public function __construct(Request $request, Response $response)
{
    // Assign the request to the controller
    $this->request = $request;
 
    // Assign a response to the controller
    $this->response = $response;
}