Extracting a base class, as it will be needed.

Moving AuthComponent::action() into the authorize object base as that's where its used.
This commit is contained in:
mark_story 2011-01-02 14:23:43 -05:00
parent 67c9acbc94
commit 4058e7f48c
2 changed files with 102 additions and 31 deletions

View file

@ -0,0 +1,90 @@
<?php
/**
* PHP 5
*
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
/**
* Abstract base authorization adapter for AuthComponent.
*
* @package cake.libs.controller.components.auth
* @since 2.0
* @see AuthComponent::$authenticate
*/
abstract class BaseAuthorize {
/**
* Controller for the request.
*
* @var Controller
*/
protected $_controller = null;
/**
* The path to ACO nodes that contains the nodes for controllers. Used as a prefix
* when calling $this->action();
*
* @var string
*/
public $actionPath = null;
/**
* Constructor
*
* @param Controller $controller The controller for this request.
* @param string $settings An array of settings. This class does not use any settings.
*/
public function __construct(Controller $controller, $settings = array()) {
$this->controller($controller);
}
/**
* Checks user authorization.
*
* @param array $user Active user data
* @param CakeRequest $request
* @return boolean
*/
abstract public function authorize($user, CakeRequest $request);
/**
* Accessor to the controller object.
*
* @param mixed $controller null to get, a controller to set.
* @return mixed.
*/
public function controller($controller = null) {
if ($controller) {
if (!$controller instanceof Controller) {
throw new CakeException(__('$controller needs to be an instance of Controller'));
}
$this->_controller = $controller;
return true;
}
return $this->_controller;
}
/**
* Get the action path for a given request. Primarily used by authorize objects
* that need to get information about the plugin, controller, and action being invoked.
*
* @param CakeRequest $request The request a path is needed for.
* @return string the action path for the given request.
*/
public function action($request, $path = '/:plugin/:controller/:action') {
$plugin = empty($request['plugin']) ? null : Inflector::camelize($request['plugin']) . '/';
return str_replace(
array(':controller', ':action', ':plugin/'),
array(Inflector::camelize($request['controller']), $request['action'], $plugin),
$this->actionPath . $path
);
}
}

View file

@ -12,6 +12,7 @@
* @link http://cakephp.org CakePHP(tm) Project
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
App::import('Component', 'auth/base_authorize');
/**
* An authorization adapter for AuthComponent. Provides the ability to authorize using a controller callback.
@ -33,22 +34,21 @@
* @since 2.0
* @see AuthComponent::$authenticate
*/
class ControllerAuthorize {
/**
* Controller for the request.
*
* @var Controller
*/
protected $_controller = null;
class ControllerAuthorize extends BaseAuthorize {
/**
* Constructor
* Get/set the controller this authorize object will be working with. Also checks that isAuthorized is implemented.
*
* @param Controller $controller The controller for this request.
* @param string $settings An array of settings. This class does not use any settings.
* @param mixed $controller null to get, a controller to set.
* @return mixed.
*/
public function __construct(Controller $controller, $settings = array()) {
$this->controller($controller);
public function controller($controller = null) {
if ($controller) {
if (!method_exists($controller, 'isAuthorized')) {
throw new CakeException(__('$controller does not implement an isAuthorized() method.'));
}
}
return parent::controller($controller);
}
/**
@ -62,23 +62,4 @@ class ControllerAuthorize {
return (bool) $this->_controller->isAuthorized($user);
}
/**
* Accessor to the controller object.
*
* @param mixed $controller null to get, a controller to set.
* @return mixed.
*/
public function controller($controller = null) {
if ($controller) {
if (!$controller instanceof Controller) {
throw new CakeException(__('$controller needs to be an instance of Controller'));
}
if (!method_exists($controller, 'isAuthorized')) {
throw new CakeException(__('$controller does not implement an isAuthorized() method.'));
}
$this->_controller = $controller;
return true;
}
return $this->_controller;
}
}