Skip to content
Permalink
Browse files

Fix how $uses is handled.

$uses now defaults to true.  All falsey values turn some features
off, and most truthy values enable them.

Fixes #2590
  • Loading branch information...
markstory committed Feb 29, 2012
1 parent 6599422 commit 1ddcde7c864801625d5254c920a83c0ee0d4c3c8
Showing with 63 additions and 40 deletions.
  1. +61 −34 lib/Cake/Controller/Controller.php
  2. +2 −6 lib/Cake/Test/Case/Controller/ControllerTest.php
@@ -75,13 +75,20 @@ class Controller extends Object implements CakeEventListener {
*
* Example: `public $uses = array('Product', 'Post', 'Comment');`
*
* Can be set to array() to use no models. Can be set to false to
* use no models and prevent the merging of $uses with AppController
* Can be set to several values to express different options:
*
* - `true` Use the default inflected model name.
* - `array()` Use only models defined in the parent class.
* - `false` Use no models at all, do not merge with parent class either.
* - `array('Post', 'Comment')` Use only the Post and Comment models. Models
* Will also be merged with the parent class.
*
* The default value is `true`.
*
* @var mixed A single name as a string or a list of names as an array.
* @link http://book.cakephp.org/2.0/en/controllers.html#components-helpers-and-uses
*/
public $uses = false;
public $uses = true;
/**
* An array containing the names of helpers this controller uses. The array elements should
@@ -530,12 +537,16 @@ protected function _getScaffold(CakeRequest $request) {
}
/**
* Merge components, helpers, and uses vars from Controller::$_mergeParent and PluginAppController.
* Merge components, helpers, and uses vars from
* Controller::$_mergeParent and PluginAppController.
*
* @return void
*/
protected function _mergeControllerVars() {
$pluginController = $pluginDot = null;
$mergeParent = is_subclass_of($this, $this->_mergeParent);
$pluginVars = array();
$appVars = array();
if (!empty($this->plugin)) {
$pluginController = $this->plugin . 'AppController';
@@ -545,40 +556,59 @@ protected function _mergeControllerVars() {
$pluginDot = $this->plugin . '.';
}
if ($pluginController && $this->plugin != null) {
if ($pluginController) {
$merge = array('components', 'helpers');
$appVars = get_class_vars($pluginController);
if (
($this->uses !== null || $this->uses !== false) &&
is_array($this->uses) && !empty($appVars['uses'])
) {
$this->uses = array_merge($this->uses, array_diff($appVars['uses'], $this->uses));
}
$this->_mergeVars($merge, $pluginController);
}
if (is_subclass_of($this, $this->_mergeParent) || !empty($pluginController)) {
if ($mergeParent || !empty($pluginController)) {
$appVars = get_class_vars($this->_mergeParent);
$uses = $appVars['uses'];
$merge = array('components', 'helpers');
if ($uses == $this->uses && !empty($this->uses)) {
if (!in_array($pluginDot . $this->modelClass, $this->uses)) {
array_unshift($this->uses, $pluginDot . $this->modelClass);
} elseif ($this->uses[0] !== $pluginDot . $this->modelClass) {
$this->uses = array_flip($this->uses);
unset($this->uses[$pluginDot . $this->modelClass]);
$this->uses = array_flip($this->uses);
array_unshift($this->uses, $pluginDot . $this->modelClass);
}
} elseif (
($this->uses !== null || $this->uses !== false) &&
is_array($this->uses) && !empty($appVars['uses'])
) {
$this->uses = array_merge($this->uses, array_diff($appVars['uses'], $this->uses));
}
$this->_mergeVars($merge, $this->_mergeParent, true);
}
if ($this->uses === null) {
$this->uses = false;
}
if ($this->uses === true) {
$this->uses = array($pluginDot . $this->modelClass);
}
if (isset($appVars['uses']) && $appVars['uses'] === $this->uses) {
array_unshift($this->uses, $pluginDot . $this->modelClass);
}
if ($pluginController) {
$pluginVars = get_class_vars($pluginController);
}
if ($this->uses !== false) {
$this->_mergeUses($pluginVars);
$this->_mergeUses($appVars);
} else {
$this->uses = array();
$this->modelClass = '';
}
}
/**
* Helper method for merging the $uses property together.
*
* Merges the elements not already in $this->uses into
* $this->uses.
*
* @param mixed $merge The data to merge in.
* @return void
*/
protected function _mergeUses($merge) {
if (!isset($merge['uses'])) {
return;
}
if ($merge['uses'] === true) {
return;
}
$this->uses = array_merge(
$this->uses,
array_diff($merge['uses'], $this->uses)
);
}
/**
@@ -698,7 +728,7 @@ public function loadModel($modelClass = null, $id = null) {
$modelClass = $this->modelClass;
}
$this->uses = ($this->uses) ? $this->uses : array();
$this->uses = ($this->uses) ? (array)$this->uses : array();
if (!in_array($modelClass, $this->uses)) {
$this->uses[] = $modelClass;
}
@@ -903,15 +933,12 @@ public function render($view = null, $layout = null) {
return $this->response;
}
if (!empty($this->uses)) {
if (!empty($this->uses) && is_array($this->uses)) {
foreach ($this->uses as $model) {
list($plugin, $className) = pluginSplit($model);
$this->request->params['models'][$className] = compact('plugin', 'className');
}
}
if (!empty($this->modelClass) && ($this->uses === false || $this->uses === array())) {
$this->request->params['models'][$this->modelClass] = array('plugin' => $this->plugin, 'className' => $this->modelClass);
}
$viewClass = $this->viewClass;
if ($this->viewClass != 'View') {
@@ -1,9 +1,5 @@
<?php
/**
* ControllerTest file
*
* PHP 5
*
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
*
@@ -385,7 +381,7 @@ class AnotherTestController extends ControllerTestAppController {
*
* @var array
*/
public $uses = null;
public $uses = false;
/**
* merge parent
@@ -917,7 +913,7 @@ public function testMergeVars() {
$this->assertTrue(in_array('ControllerPost', $appVars['uses']));
$this->assertNull($testVars['uses']);
$this->assertFalse($testVars['uses']);
$this->assertFalse(property_exists($TestController, 'ControllerPost'));

0 comments on commit 1ddcde7

Please sign in to comment.
You can’t perform that action at this time.