MethodOverride.php 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  1. <?php
  2. /**
  3. * Slim - a micro PHP 5 framework
  4. *
  5. * @author Josh Lockhart <[email protected]>
  6. * @copyright 2011 Josh Lockhart
  7. * @link http://www.slimframework.com
  8. * @license http://www.slimframework.com/license
  9. * @version 2.2.0
  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. * HTTP Method Override
  36. *
  37. * This is middleware for a Slim application that allows traditional
  38. * desktop browsers to submit psuedo PUT and DELETE requests by relying
  39. * on a pre-determined request parameter. Without this middleware,
  40. * desktop browsers are only able to submit GET and POST requests.
  41. *
  42. * This middleware is included automatically!
  43. *
  44. * @package Slim
  45. * @author Josh Lockhart
  46. * @since 1.6.0
  47. */
  48. class MethodOverride extends \Slim\Middleware
  49. {
  50. /**
  51. * @var array
  52. */
  53. protected $settings;
  54. /**
  55. * Constructor
  56. * @param \Slim $app
  57. * @param array $settings
  58. */
  59. public function __construct($settings = array())
  60. {
  61. $this->settings = array_merge(array('key' => '_METHOD'), $settings);
  62. }
  63. /**
  64. * Call
  65. *
  66. * Implements Slim middleware interface. This method is invoked and passed
  67. * an array of environment variables. This middleware inspects the environment
  68. * variables for the HTTP method override parameter; if found, this middleware
  69. * modifies the environment settings so downstream middleware and/or the Slim
  70. * application will treat the request with the desired HTTP method.
  71. *
  72. * @param array $env
  73. * @return array[status, header, body]
  74. */
  75. public function call()
  76. {
  77. $env = $this->app->environment();
  78. if (isset($env['X_HTTP_METHOD_OVERRIDE'])) {
  79. // Header commonly used by Backbone.js and others
  80. $env['slim.method_override.original_method'] = $env['REQUEST_METHOD'];
  81. $env['REQUEST_METHOD'] = strtoupper($env['X_HTTP_METHOD_OVERRIDE']);
  82. } elseif (isset($env['REQUEST_METHOD']) && $env['REQUEST_METHOD'] === 'POST') {
  83. // HTML Form Override
  84. $req = new \Slim\Http\Request($env);
  85. $method = $req->post($this->settings['key']);
  86. if ($method) {
  87. $env['slim.method_override.original_method'] = $env['REQUEST_METHOD'];
  88. $env['REQUEST_METHOD'] = strtoupper($method);
  89. }
  90. }
  91. $this->next->call();
  92. }
  93. }