MethodOverride.php (3484B)
1 <?php 2 /** 3 * Slim - a micro PHP 5 framework 4 * 5 * @author Josh Lockhart <info@slimframework.com> 6 * @copyright 2011 Josh Lockhart 7 * @link http://www.slimframework.com 8 * @license http://www.slimframework.com/license 9 * @version 2.4.2 10 * @package Slim 11 * 12 * MIT LICENSE 13 * 14 * Permission is hereby granted, free of charge, to any person obtaining 15 * a copy of this software and associated documentation files (the 16 * "Software"), to deal in the Software without restriction, including 17 * without limitation the rights to use, copy, modify, merge, publish, 18 * distribute, sublicense, and/or sell copies of the Software, and to 19 * permit persons to whom the Software is furnished to do so, subject to 20 * the following conditions: 21 * 22 * The above copyright notice and this permission notice shall be 23 * included in all copies or substantial portions of the Software. 24 * 25 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 26 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 27 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 28 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 29 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 30 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 31 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 32 */ 33 namespace Slim\Middleware; 34 35 /** 36 * HTTP Method Override 37 * 38 * This is middleware for a Slim application that allows traditional 39 * desktop browsers to submit pseudo PUT and DELETE requests by relying 40 * on a pre-determined request parameter. Without this middleware, 41 * desktop browsers are only able to submit GET and POST requests. 42 * 43 * This middleware is included automatically! 44 * 45 * @package Slim 46 * @author Josh Lockhart 47 * @since 1.6.0 48 */ 49 class MethodOverride extends \Slim\Middleware 50 { 51 /** 52 * @var array 53 */ 54 protected $settings; 55 56 /** 57 * Constructor 58 * @param array $settings 59 */ 60 public function __construct($settings = array()) 61 { 62 $this->settings = array_merge(array('key' => '_METHOD'), $settings); 63 } 64 65 /** 66 * Call 67 * 68 * Implements Slim middleware interface. This method is invoked and passed 69 * an array of environment variables. This middleware inspects the environment 70 * variables for the HTTP method override parameter; if found, this middleware 71 * modifies the environment settings so downstream middleware and/or the Slim 72 * application will treat the request with the desired HTTP method. 73 * 74 * @return array[status, header, body] 75 */ 76 public function call() 77 { 78 $env = $this->app->environment(); 79 if (isset($env['HTTP_X_HTTP_METHOD_OVERRIDE'])) { 80 // Header commonly used by Backbone.js and others 81 $env['slim.method_override.original_method'] = $env['REQUEST_METHOD']; 82 $env['REQUEST_METHOD'] = strtoupper($env['HTTP_X_HTTP_METHOD_OVERRIDE']); 83 } elseif (isset($env['REQUEST_METHOD']) && $env['REQUEST_METHOD'] === 'POST') { 84 // HTML Form Override 85 $req = new \Slim\Http\Request($env); 86 $method = $req->post($this->settings['key']); 87 if ($method) { 88 $env['slim.method_override.original_method'] = $env['REQUEST_METHOD']; 89 $env['REQUEST_METHOD'] = strtoupper($method); 90 } 91 } 92 $this->next->call(); 93 } 94 }