adulau/cakephp2-php8
1
0
Fork 0
mirror of https://github.com/kamilwylegala/cakephp2-php8.git synced 2024-11-15 03:18:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Change serialize to _serialize

Browse source 
Its possible that a developer would use 'serialize' as a legitimate
view variable.  Prefix with an _ to minimize that.
This commit is contained in:
mark_story 2011-11-22 20:56:25 -05:00
parent 04463c4ee5
commit 6e1b1df2b2
4 changed files with 24 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
lib/Cake/Test/Case/View/JsonViewTest.php
View file

@ -39,7 +39,7 @@ class JsonViewTest extends CakeTestCase {
$Response = new CakeResponse();
$Controller = new Controller($Request, $Response);
$data = array('user' => 'fake', 'list' => array('item1', 'item2'));
$Controller->set(array('data' => $data, 'serialize' => 'data'));
$Controller->set(array('data' => $data, '_serialize' => 'data'));
$View = new JsonView($Controller);
$output = $View->render(false);
@ -48,7 +48,7 @@ class JsonViewTest extends CakeTestCase {
}
/**
* Test render with an array in serialize
* Test render with an array in _serialize
*
* @return void
*/
@ -58,7 +58,7 @@ class JsonViewTest extends CakeTestCase {
$Controller = new Controller($Request, $Response);
$data = array('no' => 'nope', 'user' => 'fake', 'list' => array('item1', 'item2'));
$Controller->set($data);
$Controller->set('serialize', array('no', 'user'));
$Controller->set('_serialize', array('no', 'user'));
$View = new JsonView($Controller);
$output = $View->render(false);

6
lib/Cake/Test/Case/View/XmlViewTest.php
View file

@ -39,7 +39,7 @@ class XmlViewTest extends CakeTestCase {
$Response = new CakeResponse();
$Controller = new Controller($Request, $Response);
$data = array('users' => array('user' => array('user1', 'user2')));
$Controller->set(array('users' => $data, 'serialize' => 'users'));
$Controller->set(array('users' => $data, '_serialize' => 'users'));
$View = new XmlView($Controller);
$output = $View->render(false);
@ -49,7 +49,7 @@ class XmlViewTest extends CakeTestCase {
}
/**
* Test render with an array in serialize
* Test render with an array in _serialize
*
* @return void
*/
@ -59,7 +59,7 @@ class XmlViewTest extends CakeTestCase {
$Controller = new Controller($Request, $Response);
$data = array('no' => 'nope', 'user' => 'fake', 'list' => array('item1', 'item2'));
$Controller->set($data);
$Controller->set('serialize', array('no', 'user'));
$Controller->set('_serialize', array('no', 'user'));
$View = new XmlView($Controller);
$output = $View->render(false);

18
lib/Cake/View/JsonView.php
View file

@ -16,31 +16,31 @@ App::uses('View', 'View');
/**
* A view class that is used for JSON responses.
*
* By setting the 'serialize' key in your controller, you can specify a view variable
* By setting the '_serialize' key in your controller, you can specify a view variable
* that should be serialized to JSON and used as the response for the request.
* This allows you to omit views + layouts, if your just need to emit a single view
* variable as the JSON response.
*
* In your controller, you could do the following:
*
* `$this->set(array('posts' => $posts, 'serialize' => 'posts'));`
* `$this->set(array('posts' => $posts, '_serialize' => 'posts'));`
*
* When the view is rendered, the `$posts` view variable will be serialized
* into JSON.
*
* You can also define `'serialize'` as an array. This will create a top level object containing
* You can also define `'_serialize'` as an array. This will create a top level object containing
* all the named view variables:
*
* {{{
* $this->set(compact('posts', 'users', 'stuff'));
* $this->set('serialize', array('posts', 'users'));
* $this->set('_serialize', array('posts', 'users'));
* }}}
*
* The above would generate a JSON object that looks like:
*
* `{"posts": [...], "users": [...]}`
*
* If you don't use the `serialize` key, you will need a view. You can use extended
* If you don't use the `_serialize` key, you will need a view. You can use extended
* views to provide layout like functionality.
*
* @package Cake.View
@ -73,9 +73,9 @@ class JsonView extends View {
/**
* Render a JSON view.
*
* Uses the special 'serialize' parameter to convert a set of
* Uses the special '_serialize' parameter to convert a set of
* view variables into a JSON response. Makes generating simple
* JSON responses very easy. You can omit the 'serialize' parameter,
* JSON responses very easy. You can omit the '_serialize' parameter,
* and use a normal view + layout as well.
*
* @param string $view The view being rendered.
@ -83,8 +83,8 @@ class JsonView extends View {
* @return string The rendered view.
*/
public function render($view = null, $layout = null) {
if (isset($this->viewVars['serialize'])) {
$serialize = $this->viewVars['serialize'];
if (isset($this->viewVars['_serialize'])) {
$serialize = $this->viewVars['_serialize'];
if (is_array($serialize)) {
$data = array();
foreach ($serialize as $key) {

18
lib/Cake/View/XmlView.php
View file

@ -17,33 +17,33 @@ App::uses('Xml', 'Utility');
/**
* A view class that is used for creating XML responses.
*
* By setting the 'serialize' key in your controller, you can specify a view variable
* By setting the '_serialize' key in your controller, you can specify a view variable
* that should be serialized to XML and used as the response for the request.
* This allows you to omit views + layouts, if your just need to emit a single view
* variable as the XML response.
*
* In your controller, you could do the following:
*
* `$this->set(array('posts' => $posts, 'serialize' => 'posts'));`
* `$this->set(array('posts' => $posts, '_serialize' => 'posts'));`
*
* When the view is rendered, the `$posts` view variable will be serialized
* into XML.
*
* **Note** The view variable you specify must be compatible with Xml::fromArray().
*
* You can also define `'serialize'` as an array. This will create an additional
* You can also define `'_serialize'` as an array. This will create an additional
* top level element named `<response>` containing all the named view variables:
*
* {{{
* $this->set(compact('posts', 'users', 'stuff'));
* $this->set('serialize', array('posts', 'users'));
* $this->set('_serialize', array('posts', 'users'));
* }}}
*
* The above would generate a XML object that looks like:
*
* `<response><posts>...</posts><users>...</users></response>`
*
* If you don't use the `serialize` key, you will need a view. You can use extended
* If you don't use the `_serialize` key, you will need a view. You can use extended
* views to provide layout like functionality.
*
* @package Cake.View
@ -74,9 +74,9 @@ class XmlView extends View {
/**
* Render a XML view.
*
* Uses the special 'serialize' parameter to convert a set of
* Uses the special '_serialize' parameter to convert a set of
* view variables into a XML response. Makes generating simple
* XML responses very easy. You can omit the 'serialize' parameter,
* XML responses very easy. You can omit the '_serialize' parameter,
* and use a normal view + layout as well.
*
* @param string $view The view being rendered.
@ -84,8 +84,8 @@ class XmlView extends View {
* @return string The rendered view.
*/
public function render($view = null, $layout = null) {
if (isset($this->viewVars['serialize'])) {
$serialize = $this->viewVars['serialize'];
if (isset($this->viewVars['_serialize'])) {
$serialize = $this->viewVars['_serialize'];
if (is_array($serialize)) {
$data = array('response' => array());
foreach ($serialize as $key) {