Upgrade CakePHP from 2.2.5 to 2.9.5

lib/Cake/Controller/Scaffold.php

@@ -4,21 +4,19 @@
  *
  * Automatic forms and actions generation for rapid web application development.
  *
- * PHP 5
- *
  * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
- * Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
+ * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
  *
  * Licensed under The MIT License
+ * For full copyright and license information, please see the LICENSE.txt
  * Redistributions of files must retain the above copyright notice.
  *
- * @copyright     Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
+ * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
  * @link          http://cakephp.org CakePHP(tm) Project
  * @package       Cake.Controller
  * @since         Cake v 0.10.0.1076
- * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
+ * @license       http://www.opensource.org/licenses/mit-license.php MIT License
  */
-App::uses('Scaffold', 'View');
 
 /**
  * Scaffolding is a set of automatic actions for starting web development work faster.
@@ -28,7 +26,8 @@ App::uses('Scaffold', 'View');
  * and afford the web developer an early look at the data, and the possibility to over-ride
  * scaffolded actions with custom-made ones.
  *
- * @package       Cake.Controller
+ * @package Cake.Controller
+ * @deprecated 3.0.0 Dynamic scaffolding will be removed and replaced in 3.0
  */
 class Scaffold {
 
@@ -77,7 +76,7 @@ class Scaffold {
 /**
  * Valid session.
  *
- * @var boolean
+ * @var bool
  */
 	protected $_validSession = null;
 
@@ -137,7 +136,7 @@ class Scaffold {
 		$associations = $this->_associations();
 
 		$this->controller->set(compact(
-			'title_for_layout', 'modelClass', 'primaryKey', 'displayField', 'singularVar', 'pluralVar',
+			'modelClass', 'primaryKey', 'displayField', 'singularVar', 'pluralVar',
 			'singularHumanName', 'pluralHumanName', 'scaffoldFields', 'associations'
 		));
 		$this->controller->set('title_for_layout', $title);
@@ -146,7 +145,9 @@ class Scaffold {
 			$this->controller->viewClass = 'Scaffold';
 		}
 		$this->_validSession = (
-			isset($this->controller->Session) && $this->controller->Session->valid() != false
+			isset($this->controller->Session) &&
+			$this->controller->Session->valid() &&
+			isset($this->controller->Flash)
 		);
 		$this->_scaffold($request);
 	}
@@ -199,7 +200,7 @@ class Scaffold {
  * Renders an add or edit action for scaffolded model.
  *
  * @param string $action Action (add or edit)
- * @return mixed A rendered view with a form to edit or add a record in the Models database table
+ * @return void
  */
 	protected function _scaffoldForm($action = 'edit') {
 		$this->controller->viewVars['scaffoldFields'] = array_merge(
@@ -226,7 +227,7 @@ class Scaffold {
 		}
 
 		if ($this->controller->beforeScaffold($action)) {
-			if ($action == 'edit') {
+			if ($action === 'edit') {
 				if (isset($request->params['pass'][0])) {
 					$this->ScaffoldModel->id = $request['pass'][0];
 				}
@@ -236,7 +237,7 @@ class Scaffold {
 			}
 
 			if (!empty($request->data)) {
-				if ($action == 'create') {
+				if ($action === 'create') {
 					$this->ScaffoldModel->create();
 				}
 
@@ -247,14 +248,12 @@ class Scaffold {
 							Inflector::humanize($this->modelKey),
 							$success
 						);
-						return $this->_sendMessage($message);
-					} else {
-						return $this->controller->afterScaffoldSaveError($action);
-					}
-				} else {
-					if ($this->_validSession) {
-						$this->controller->Session->setFlash(__d('cake', 'Please correct errors below.'));
+						return $this->_sendMessage($message, 'success');
 					}
+					return $this->controller->afterScaffoldSaveError($action);
+				}
+				if ($this->_validSession) {
+					$this->controller->Flash->set(__d('cake', 'Please correct errors below.'));
 				}
 			}
 
@@ -306,34 +305,33 @@ class Scaffold {
 			}
 			if ($this->ScaffoldModel->delete()) {
 				$message = __d('cake', 'The %1$s with id: %2$s has been deleted.', Inflector::humanize($this->modelClass), $id);
-				return $this->_sendMessage($message);
-			} else {
-				$message = __d('cake',
-					'There was an error deleting the %1$s with id: %2$s',
-					Inflector::humanize($this->modelClass),
-					$id
-				);
-				return $this->_sendMessage($message);
+				return $this->_sendMessage($message, 'success');
 			}
+			$message = __d('cake',
+				'There was an error deleting the %1$s with id: %2$s',
+				Inflector::humanize($this->modelClass),
+				$id
+			);
+			return $this->_sendMessage($message);
 		} elseif ($this->controller->scaffoldError('delete') === false) {
 			return $this->_scaffoldError();
 		}
 	}
 
 /**
- * Sends a message to the user.  Either uses Sessions or flash messages depending
+ * Sends a message to the user. Either uses Sessions or flash messages depending
  * on the availability of a session
  *
  * @param string $message Message to display
- * @return void
+ * @param string $element Flash template to use
+ * @return \Cake\Network\Response|null
  */
-	protected function _sendMessage($message) {
+	protected function _sendMessage($message, $element = 'default') {
 		if ($this->_validSession) {
-			$this->controller->Session->setFlash($message);
-			$this->controller->redirect($this->redirect);
-		} else {
-			$this->controller->flash($message, $this->redirect);
+			$this->controller->Flash->set($message, compact('element'));
+			return $this->controller->redirect($this->redirect);
 		}
+		$this->controller->flash($message, $this->redirect);
 	}
 
 /**
@@ -351,7 +349,7 @@ class Scaffold {
  * `public $scaffold;` is placed in the controller's class definition.
  *
  * @param CakeRequest $request Request object for scaffolding
- * @return mixed A rendered view of scaffold action, or showing the error
+ * @return void
  * @throws MissingActionException When methods are not scaffolded.
  * @throws MissingDatabaseException When the database connection is undefined.
  */
@@ -386,25 +384,25 @@ class Scaffold {
 					case 'index':
 					case 'list':
 						$this->_scaffoldIndex($request);
-					break;
+						break;
 					case 'view':
 						$this->_scaffoldView($request);
-					break;
+						break;
 					case 'add':
 					case 'create':
 						$this->_scaffoldSave($request, 'add');
-					break;
+						break;
 					case 'edit':
 					case 'update':
 						$this->_scaffoldSave($request, 'edit');
-					break;
+						break;
 					case 'delete':
 						$this->_scaffoldDelete($request);
-					break;
+						break;
 				}
 			} else {
 				throw new MissingActionException(array(
-					'controller' => $this->controller->name,
+					'controller' => get_class($this->controller),
 					'action' => $request->action
 				));
 			}
@@ -422,7 +420,7 @@ class Scaffold {
 		$keys = array('belongsTo', 'hasOne', 'hasMany', 'hasAndBelongsToMany');
 		$associations = array();
 
-		foreach ($keys as $key => $type) {
+		foreach ($keys as $type) {
 			foreach ($this->ScaffoldModel->{$type} as $assocKey => $assocData) {
 				$associations[$type][$assocKey]['primaryKey'] =
 					$this->ScaffoldModel->{$assocKey}->primaryKey;
@@ -442,7 +440,7 @@ class Scaffold {
 				$associations[$type][$assocKey]['controller'] =
 					Inflector::pluralize(Inflector::underscore($model));
 
-				if ($type == 'hasAndBelongsToMany') {
+				if ($type === 'hasAndBelongsToMany') {
 					$associations[$type][$assocKey]['with'] = $assocData['with'];
 				}
 			}