ControllerAuthorize.php 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. <?php
  2. /**
  3. * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  4. * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
  5. *
  6. * Licensed under The MIT License
  7. * For full copyright and license information, please see the LICENSE.txt
  8. * Redistributions of files must retain the above copyright notice.
  9. *
  10. * @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
  11. * @link http://cakephp.org CakePHP(tm) Project
  12. * @license http://www.opensource.org/licenses/mit-license.php MIT License
  13. */
  14. App::uses('BaseAuthorize', 'Controller/Component/Auth');
  15. /**
  16. * An authorization adapter for AuthComponent. Provides the ability to authorize using a controller callback.
  17. * Your controller's isAuthorized() method should return a boolean to indicate whether or not the user is authorized.
  18. *
  19. * {{{
  20. * public function isAuthorized($user) {
  21. * if (!empty($this->request->params['admin'])) {
  22. * return $user['role'] === 'admin';
  23. * }
  24. * return !empty($user);
  25. * }
  26. * }}}
  27. *
  28. * the above is simple implementation that would only authorize users of the 'admin' role to access
  29. * admin routing.
  30. *
  31. * @package Cake.Controller.Component.Auth
  32. * @since 2.0
  33. * @see AuthComponent::$authenticate
  34. */
  35. class ControllerAuthorize extends BaseAuthorize {
  36. /**
  37. * Get/set the controller this authorize object will be working with. Also checks that isAuthorized is implemented.
  38. *
  39. * @param Controller $controller null to get, a controller to set.
  40. * @return mixed
  41. * @throws CakeException
  42. */
  43. public function controller(Controller $controller = null) {
  44. if ($controller) {
  45. if (!method_exists($controller, 'isAuthorized')) {
  46. throw new CakeException(__d('cake_dev', '$controller does not implement an %s method.', 'isAuthorized()'));
  47. }
  48. }
  49. return parent::controller($controller);
  50. }
  51. /**
  52. * Checks user authorization using a controller callback.
  53. *
  54. * @param array $user Active user data
  55. * @param CakeRequest $request Request instance.
  56. * @return bool
  57. */
  58. public function authorize($user, CakeRequest $request) {
  59. return (bool)$this->_Controller->isAuthorized($user);
  60. }
  61. }