3.0 request action

lib/Cake/Controller/Component.php

@@ -1,8 +1,5 @@
 <?php
 /**
- *
- * PHP 5
- *
  * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  * Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
  *
@@ -11,11 +8,11 @@
  *
  * @copyright     Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
  * @link          http://cakephp.org CakePHP(tm) Project
- * @package       Cake.Controller
  * @since         CakePHP(tm) v 1.2
  * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
  */
 namespace Cake\Controller;
+
 use Cake\Core\Object;
 
 /**

lib/Cake/Controller/Component/RequestHandlerComponent.php

@@ -262,7 +262,7 @@ public function beforeRedirect(Controller $controller, $url, $status = null, $ex
 			$code = key($statusCode);
 			$this->response->statusCode($code);
 		}
-		$this->response->body($this->requestAction($url, array('return', 'bare' => false)));
+		$this->response->body($controller->requestAction($url, array('return', 'bare' => false)));
 		$this->response->send();
 		$this->_stop();
 	}

lib/Cake/Controller/Controller.php

@@ -25,6 +25,7 @@
 use Cake\Network\Request;
 use Cake\Network\Response;
 use Cake\Routing\Router;
+use Cake\Routing\RequestActionTrait;
 use Cake\Utility\ClassRegistry;
 use Cake\Utility\Inflector;
 use Cake\Utility\MergeVariablesTrait;
@@ -65,6 +66,7 @@
 class Controller extends Object implements EventListener {
 
 	use MergeVariablesTrait;
+	use RequestActionTrait;
 
 /**
  * The name of this controller. Controller names are plural, named after the model they manipulate.

lib/Cake/Core/Object.php

@@ -15,10 +15,6 @@
 namespace Cake\Core;
 
 use Cake\Log\LogTrait;
-use Cake\Network\Request;
-use Cake\Network\Response;
-use Cake\Routing\Dispatcher;
-use Cake\Routing\Router;
 use Cake\Utility\Hash;
 
 /**
@@ -49,75 +45,6 @@ public function toString() {
 		return get_class($this);
 	}
 
-/**
- * Calls a controller's method from any location. Can be used to connect controllers together
- * or tie plugins into a main application. requestAction can be used to return rendered views
- * or fetch the return value from controller actions.
- *
- * Under the hood this method uses Router::reverse() to convert the $url parameter into a string
- * URL.  You should use URL formats that are compatible with Router::reverse()
- *
- * #### Passing POST and GET data
- *
- * POST and GET data can be simulated in requestAction.  Use `$extra['query']` for
- * GET data.  The `$extra['post']` parameter allows POST data simulation.
- *
- * @param string|array $url String or array-based url.  Unlike other url arrays in CakePHP, this
- *    url will not automatically handle passed arguments in the $url parameter.
- * @param array $extra if array includes the key "return" it sets the AutoRender to true.  Can
- *    also be used to submit GET/POST data, and passed arguments.
- * @return mixed Boolean true or false on success/failure, or contents
- *    of rendered action if 'return' is set in $extra.
- */
-	public function requestAction($url, $extra = array()) {
-		if (empty($url)) {
-			return false;
-		}
-		if (($index = array_search('return', $extra)) !== false) {
-			$extra['return'] = 0;
-			$extra['autoRender'] = 1;
-			unset($extra[$index]);
-		}
-		$extra = array_merge(
-			['autoRender' => 0, 'return' => 1, 'bare' => 1, 'requested' => 1],
-			$extra
-		);
-		$post = $query = [];
-		if (isset($extra['post'])) {
-			$post = $extra['post'];
-		}
-		if (isset($extra['query'])) {
-			$query = $extra['query'];
-		}
-		unset($extra['post'], $extra['query']);
-
-		if (is_string($url) && strpos($url, FULL_BASE_URL) === 0) {
-			$url = Router::normalize(str_replace(FULL_BASE_URL, '', $url));
-		}
-		if (is_string($url)) {
-			$params = array(
-				'url' => $url
-			);
-		} elseif (is_array($url)) {
-			$params = array_merge($url, [
-				'pass' => [],
-				'base' => false,
-				'url' => Router::reverse($url)
-			]);
-		}
-		if (!empty($post)) {
-			$params['post'] = $post;
-		}
-		if (!empty($query)) {
-			$params['query'] = $query;
-		}
-		$request = new Request($params);
-		$dispatcher = new Dispatcher();
-		$result = $dispatcher->dispatch($request, new Response(), $extra);
-		Router::popRequest();
-		return $result;
-	}
-
 /**
  * Calls a method on this object with the given parameters. Provides an OO wrapper
  * for `call_user_func_array`

lib/Cake/Network/Request.php

@@ -39,7 +39,7 @@ class Request implements \ArrayAccess {
 		'plugin' => null,
 		'controller' => null,
 		'action' => null,
-		'pass' => array(),
+		'pass' => [],
 	);
 
 /**
@@ -49,14 +49,21 @@ class Request implements \ArrayAccess {
  *
  * @var array
  */
-	public $data = array();
+	public $data = [];
 
 /**
  * Array of querystring arguments
  *
  * @var array
  */
-	public $query = array();
+	public $query = [];
+
+/**
+ * Array of cookie data.
+ *
+ * @var array
+ */
+	public $cookies = [];
 
 /**
  * The url string used for the request.

lib/Cake/Routing/RequestActionTrait.php

@@ -0,0 +1,125 @@
+<?php
+/**
+ * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
+ * Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
+ * @link          http://cakephp.org CakePHP(tm) Project
+ * @since         CakePHP(tm) v 3.0.0
+ * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
+ */
+namespace Cake\Routing;
+
+use Cake\Network\Request;
+use Cake\Network\Response;
+use Cake\Routing\Dispatcher;
+use Cake\Routing\Router;
+
+/**
+ * Provides the requestAction() method for doing sub-requests
+ *
+ * @package Cake.Routing
+ */
+trait RequestActionTrait {
+
+/**
+ * Calls a controller's method from any location. Can be used to connect controllers together
+ * or tie plugins into a main application. requestAction can be used to return rendered views
+ * or fetch the return value from controller actions.
+ *
+ * Under the hood this method uses Router::reverse() to convert the $url parameter into a string
+ * URL. You should use URL formats that are compatible with Router::reverse()
+ *
+ * ### Examples
+ *
+ * A basic example getting the return value of the controller action:
+ *
+ * {{{
+ * $variables = $this->requestAction('/articles/popular');
+ * }}}
+ *
+ * A basic example of request action to fetch a rendered page without the layout.
+ *
+ * {{{
+ * $viewHtml = $this->requestAction('/articles/popular', ['return']);
+ * }}}
+ *
+ * You can also pass the URL as an array:
+ *
+ * {{{
+ * $vars = $this->requestAction(['controller' => 'articles', 'action' => 'popular']);
+ * }}}
+ *
+ * ### Passing other request data
+ *
+ * You can pass POST, GET, COOKIE and other data into the request using the apporpriate keys.
+ * Cookies can be passed using the `cookies` key. Get parameters can be set with `query` and post
+ * data can be sent using the `post` key.
+ *
+ * {{{
+ * $vars = $this->requestAction('/articles/popular', [
+ *   'query' => ['page' = > 1],
+ *   'cookies' => ['remember_me' => 1],
+ * ]);
+ * }}}
+ *
+ * @param string|array $url String or array-based url.  Unlike other url arrays in CakePHP, this
+ *    url will not automatically handle passed arguments in the $url parameter.
+ * @param array $extra if array includes the key "return" it sets the autoRender to true.  Can
+ *    also be used to submit GET/POST data, and passed arguments.
+ * @return mixed Boolean true or false on success/failure, or contents
+ *    of rendered action if 'return' is set in $extra.
+ */
+	public function requestAction($url, $extra = array()) {
+		if (empty($url)) {
+			return false;
+		}
+		if (($index = array_search('return', $extra)) !== false) {
+			$extra['return'] = 0;
+			$extra['autoRender'] = 1;
+			unset($extra[$index]);
+		}
+		$extra = array_merge(
+			['autoRender' => 0, 'return' => 1, 'bare' => 1, 'requested' => 1],
+			$extra
+		);
+		$post = $query = [];
+		if (isset($extra['post'])) {
+			$post = $extra['post'];
+		}
+		if (isset($extra['query'])) {
+			$query = $extra['query'];
+		}
+		unset($extra['post'], $extra['query']);
+
+		if (is_string($url) && strpos($url, FULL_BASE_URL) === 0) {
+			$url = Router::normalize(str_replace(FULL_BASE_URL, '', $url));
+		}
+		if (is_string($url)) {
+			$params = [
+				'url' => $url
+			];
+		} elseif (is_array($url)) {
+			$params = array_merge($url, [
+				'pass' => [],
+				'base' => false,
+				'url' => Router::reverse($url)
+			]);
+		}
+		if (!empty($post)) {
+			$params['post'] = $post;
+		}
+		if (!empty($query)) {
+			$params['query'] = $query;
+		}
+		$request = new Request($params);
+		$dispatcher = new Dispatcher();
+		$result = $dispatcher->dispatch($request, new Response(), $extra);
+		Router::popRequest();
+		return $result;
+	}
+
+}

lib/Cake/Test/TestCase/Controller/Component/SessionComponentTest.php

@@ -94,14 +94,14 @@ public function testSessionIdConsistentAcrossRequestAction() {
 		$Session->check('Test');
 		$this->assertTrue(isset($_SESSION));
 
-		$Object = new Object();
+		$Controller = new Controller();
 		$Session = new SessionComponent($this->ComponentCollection);
 		$expected = $Session->id();
 
-		$result = $Object->requestAction('/session_test/session_id');
+		$result = $Controller->requestAction('/session_test/session_id');
 		$this->assertEquals($expected, $result);
 
-		$result = $Object->requestAction('/orange_session_test/session_id');
+		$result = $Controller->requestAction('/orange_session_test/session_id');
 		$this->assertEquals($expected, $result);
 	}