Browse Source

Return null instead of true.

Doesn't make sense returning a boolean when it's always true.
ADmad 12 years ago
parent
commit
fee9b11d0f

+ 7 - 7
src/Controller/Component/AuthComponent.php

@@ -236,7 +236,7 @@ class AuthComponent extends Component {
  * of login form data.
  *
  * @param Event $event The startup event.
- * @return bool|\Cake\Network\Response
+ * @return void|\Cake\Network\Response
  */
 	public function startup(Event $event) {
 		$controller = $event->subject();
@@ -244,13 +244,13 @@ class AuthComponent extends Component {
 		$action = strtolower($controller->request->params['action']);
 
 		if (!isset($methods[$action])) {
-			return true;
+			return;
 		}
 
 		$this->_setDefaults();
 
 		if ($this->_isAllowed($controller)) {
-			return true;
+			return;
 		}
 
 		if (!$this->_getUser()) {
@@ -265,7 +265,7 @@ class AuthComponent extends Component {
 			empty($this->_config['authorize']) ||
 			$this->isAuthorized($this->user())
 		) {
-			return true;
+			return;
 		}
 
 		$result = $this->_unauthorized($controller);
@@ -299,8 +299,8 @@ class AuthComponent extends Component {
  * is returned.
  *
  * @param Controller $controller A reference to the controller object.
- * @return bool|\Cake\Network\Response True if current action is login action
- *   else false or response object if Controller::redirect() is called.
+ * @return void|\Cake\Network\Response Null if current action is login action
+ *   else response object returned by authenticate object or Controller::redirect().
  */
 	protected function _unauthenticated(Controller $controller) {
 		if (empty($this->_authenticateObjects)) {
@@ -319,7 +319,7 @@ class AuthComponent extends Component {
 			) {
 				$this->Session->write('Auth.redirect', $controller->referer(null, true));
 			}
-			return true;
+			return;
 		}
 
 		if (!$controller->request->is('ajax')) {

+ 12 - 12
tests/TestCase/Controller/Component/AuthComponentTest.php

@@ -123,11 +123,11 @@ class AuthComponentTest extends TestCase {
 		$this->Controller->Auth->initialize($event);
 
 		$this->Controller->name = 'Error';
-		$this->assertTrue($this->Controller->Auth->startup($event));
+		$this->assertNull($this->Controller->Auth->startup($event));
 
 		$this->Controller->name = 'Post';
 		$this->Controller->request['action'] = 'thisdoesnotexist';
-		$this->assertTrue($this->Controller->Auth->startup($event));
+		$this->assertNull($this->Controller->Auth->startup($event));
 	}
 
 /**
@@ -215,7 +215,7 @@ class AuthComponentTest extends TestCase {
 		$this->Controller->request->addParams(Router::parse('auth_test/add'));
 		$this->Controller->Auth->initialize($event);
 		$result = $this->Controller->Auth->startup($event);
-		$this->assertTrue($result);
+		$this->assertNull($result);
 
 		$this->Auth->Session->delete('Auth');
 		$result = $this->Controller->Auth->startup($event);
@@ -382,7 +382,7 @@ class AuthComponentTest extends TestCase {
 		$this->Controller->Auth->deny('add', 'camelCase');
 
 		$this->Controller->request['action'] = 'delete';
-		$this->assertTrue($this->Controller->Auth->startup($event));
+		$this->assertNull($this->Controller->Auth->startup($event));
 
 		$this->Controller->request['action'] = 'add';
 		$this->assertInstanceOf('Cake\Network\Response', $this->Controller->Auth->startup($event));
@@ -394,7 +394,7 @@ class AuthComponentTest extends TestCase {
 		$this->Controller->Auth->deny(array('add', 'camelCase'));
 
 		$this->Controller->request['action'] = 'delete';
-		$this->assertTrue($this->Controller->Auth->startup($event));
+		$this->assertNull($this->Controller->Auth->startup($event));
 
 		$this->Controller->request['action'] = 'camelCase';
 		$this->assertInstanceOf('Cake\Network\Response', $this->Controller->Auth->startup($event));
@@ -421,7 +421,7 @@ class AuthComponentTest extends TestCase {
 		$this->Controller->Auth->allow(null);
 
 		$this->Controller->request['action'] = 'camelCase';
-		$this->assertTrue($this->Controller->Auth->startup($event));
+		$this->assertNull($this->Controller->Auth->startup($event));
 
 		$this->Controller->Auth->allow();
 		$this->Controller->Auth->deny(null);
@@ -468,7 +468,7 @@ class AuthComponentTest extends TestCase {
 		$this->Controller->Auth->userModel = 'AuthUsers';
 		$this->Controller->Auth->allow();
 		$result = $this->Controller->Auth->startup($event);
-		$this->assertTrue($result, 'startup() should return true, as action is allowed. %s');
+		$this->assertNull($result, 'startup() should return null, as action is allowed. %s');
 
 		$url = '/auth_test/camelCase';
 		$this->Controller->request->addParams(Router::parse($url));
@@ -478,7 +478,7 @@ class AuthComponentTest extends TestCase {
 		$this->Controller->Auth->userModel = 'AuthUsers';
 		$this->Controller->Auth->allowedActions = array('delete', 'camelCase', 'add');
 		$result = $this->Controller->Auth->startup($event);
-		$this->assertTrue($result, 'startup() should return true, as action is allowed. %s');
+		$this->assertNull($result, 'startup() should return null, as action is allowed. %s');
 
 		$this->Controller->Auth->allowedActions = array('delete', 'add');
 		$this->assertInstanceOf('Cake\Network\Response', $this->Controller->Auth->startup($event));
@@ -492,7 +492,7 @@ class AuthComponentTest extends TestCase {
 
 		$this->Controller->Auth->allow(array('delete', 'add'));
 		$result = $this->Controller->Auth->startup($event);
-		$this->assertTrue($result, 'startup() should return true, as action is allowed. %s');
+		$this->assertNull($result, 'startup() should return null, as action is allowed. %s');
 	}
 
 	public function testAllowedActionsSetWithAllowMethod() {
@@ -687,7 +687,7 @@ class AuthComponentTest extends TestCase {
 
 		$event = new Event('Controller.startup', $this->Controller);
 		$return = $this->Auth->startup($event);
-		$this->assertTrue($return);
+		$this->assertNull($return);
 		$this->assertNull($this->Controller->testUrl);
 	}
 
@@ -860,7 +860,7 @@ class AuthComponentTest extends TestCase {
 		$this->Auth->initialize($event);
 		$this->Auth->request->addParams(Router::parse('auth_test/something_totally_wrong'));
 		$result = $this->Auth->startup($event);
-		$this->assertTrue($result, 'Auth redirected a missing action %s');
+		$this->assertNull($result, 'Auth redirected a missing action %s');
 	}
 
 /**
@@ -1314,7 +1314,7 @@ class AuthComponentTest extends TestCase {
 		$this->Controller->request->env('PHP_AUTH_PW', 'cake');
 
 		$result = $this->Auth->startup($event);
-		$this->assertTrue($result);
+		$this->assertNull($result);
 
 		$this->assertNull(Session::id());
 	}