From 5deb76120aa503e97fe0ae1dbb5087b7a8f214a2 Mon Sep 17 00:00:00 2001 From: Tobias Munk Date: Thu, 12 Dec 2013 21:58:14 +0100 Subject: [PATCH 01/36] changed install to create-project, added hint --- docs/internals/getting-started.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/internals/getting-started.md b/docs/internals/getting-started.md index bcaac07..8a5e506 100644 --- a/docs/internals/getting-started.md +++ b/docs/internals/getting-started.md @@ -7,7 +7,7 @@ Composer package. Here's how to do it: 1. `git clone git@github.com:yiisoft/yii2-app-basic.git`. 2. Remove `.git` directory from cloned directory. 3. Change `composer.json`. Instead of all stable requirements add just one `"yiisoft/yii2-dev": "*"`. -4. Execute `composer install`. +4. Execute `composer create-project`. 5. Now you have working playground that uses latest code. If you're core developer there's no extra step needed. You can change framework code under @@ -23,3 +23,5 @@ If you're not core developer or want to use your own fork for pull requests: [remote "origin"] url = git://github.com/username/yii2.git ``` + +> Hint: The workflow of forking a package and pushing changes back into your fork and then sending a pull-request to the maintainer is the same for all extensions you require via composer. \ No newline at end of file From a126419e9e0b1046190fa3fffdaf18cb81fb09ca Mon Sep 17 00:00:00 2001 From: Qiang Xue Date: Sat, 21 Dec 2013 15:37:49 -0500 Subject: [PATCH 02/36] Fixes #1591: StringValidator is accessing undefined property --- framework/CHANGELOG.md | 1 + framework/yii/validators/StringValidator.php | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/framework/CHANGELOG.md b/framework/CHANGELOG.md index 073a3ce..a1d7bdf 100644 --- a/framework/CHANGELOG.md +++ b/framework/CHANGELOG.md @@ -9,6 +9,7 @@ Yii Framework 2 Change Log - Bug #1500: Log messages exported to files are not separated by newlines (omnilight, qiangxue) - Bug #1509: The SQL for creating Postgres RBAC tables is incorrect (qiangxue) - Bug #1545: It was not possible to execute db Query twice, params where missing (cebe) +- Bug #1591: StringValidator is accessing undefined property (qiangxue) - Bug: Fixed `Call to a member function registerAssetFiles() on a non-object` in case of wrong `sourcePath` for an asset bundle (samdark) - Bug: Fixed incorrect event name for `yii\jui\Spinner` (samdark) - Bug: Json::encode() did not handle objects that implement JsonSerializable interface correctly (cebe) diff --git a/framework/yii/validators/StringValidator.php b/framework/yii/validators/StringValidator.php index a93fb72..dbc4001 100644 --- a/framework/yii/validators/StringValidator.php +++ b/framework/yii/validators/StringValidator.php @@ -174,7 +174,7 @@ class StringValidator extends Validator $options['is'] = $this->length; $options['notEqual'] = Html::encode(strtr($this->notEqual, [ '{attribute}' => $label, - '{length}' => $this->is, + '{length}' => $this->length, ])); } if ($this->skipOnEmpty) { From 0ff8518c2103a83587a53e44dd3d82e5d58c5a65 Mon Sep 17 00:00:00 2001 From: Qiang Xue Date: Sat, 21 Dec 2013 17:07:31 -0500 Subject: [PATCH 03/36] Fixes #1550: fixed the issue that JUI input widgets did not property input IDs. --- extensions/yii/jui/CHANGELOG.md | 2 +- extensions/yii/jui/DatePicker.php | 23 +++++++++++++++++++---- extensions/yii/jui/InputWidget.php | 6 +++++- extensions/yii/jui/SliderInput.php | 30 +++++++++++++++++++++--------- extensions/yii/jui/Widget.php | 18 +++++++++++------- framework/CHANGELOG.md | 4 +++- framework/yii/captcha/Captcha.php | 7 ------- framework/yii/widgets/InputWidget.php | 10 +++++++++- framework/yii/widgets/MaskedInput.php | 8 -------- 9 files changed, 69 insertions(+), 39 deletions(-) diff --git a/extensions/yii/jui/CHANGELOG.md b/extensions/yii/jui/CHANGELOG.md index eb30e09..b31c34e 100644 --- a/extensions/yii/jui/CHANGELOG.md +++ b/extensions/yii/jui/CHANGELOG.md @@ -4,7 +4,7 @@ Yii Framework 2 jui extension Change Log 2.0.0 beta under development ---------------------------- -- no changes in this release. +- Bug #1550: fixed the issue that JUI input widgets did not property input IDs. 2.0.0 alpha, December 1, 2013 ----------------------------- diff --git a/extensions/yii/jui/DatePicker.php b/extensions/yii/jui/DatePicker.php index 06ca356..bab2abe 100644 --- a/extensions/yii/jui/DatePicker.php +++ b/extensions/yii/jui/DatePicker.php @@ -54,14 +54,30 @@ class DatePicker extends InputWidget * @var boolean If true, shows the widget as an inline calendar and the input as a hidden field. */ public $inline = false; + /** + * @var array the HTML attributes for the container tag. This is only used when [[inline]] is true. + */ + public $containerOptions = []; /** + * @inheritdoc + */ + public function init() + { + parent::init(); + if ($this->inline && !isset($this->containerOptions['id'])) { + $this->containerOptions['id'] = $this->options['id'] . '-container'; + } + } + + /** * Renders the widget. */ public function run() { echo $this->renderWidget() . "\n"; + $containerID = $this->inline ? $this->containerOptions['id'] : $this->options['id']; if ($this->language !== false) { $view = $this->getView(); DatePickerRegionalAsset::register($view); @@ -71,10 +87,10 @@ class DatePicker extends InputWidget $options = $this->clientOptions; $this->clientOptions = false; // the datepicker js widget is already registered - $this->registerWidget('datepicker', DatePickerAsset::className()); + $this->registerWidget('datepicker', DatePickerAsset::className(), $containerID); $this->clientOptions = $options; } else { - $this->registerWidget('datepicker', DatePickerAsset::className()); + $this->registerWidget('datepicker', DatePickerAsset::className(), $containerID); } } @@ -101,8 +117,7 @@ class DatePicker extends InputWidget $this->clientOptions['defaultDate'] = $this->value; } $this->clientOptions['altField'] = '#' . $this->options['id']; - $this->options['id'] .= '-container'; - $contents[] = Html::tag('div', null, $this->options); + $contents[] = Html::tag('div', null, $this->containerOptions); } return implode("\n", $contents); diff --git a/extensions/yii/jui/InputWidget.php b/extensions/yii/jui/InputWidget.php index e100d6c..0facfb9 100644 --- a/extensions/yii/jui/InputWidget.php +++ b/extensions/yii/jui/InputWidget.php @@ -10,6 +10,7 @@ namespace yii\jui; use Yii; use yii\base\Model; use yii\base\InvalidConfigException; +use yii\helpers\Html; /** * InputWidget is the base class for all jQuery UI input widgets. @@ -44,7 +45,10 @@ class InputWidget extends Widget public function init() { if (!$this->hasModel() && $this->name === null) { - throw new InvalidConfigException("Either 'name' or 'model' and 'attribute' properties must be specified."); + throw new InvalidConfigException("Either 'name', or 'model' and 'attribute' properties must be specified."); + } + if ($this->hasModel() && !isset($this->options['id'])) { + $this->options['id'] = Html::getInputId($this->model, $this->attribute); } parent::init(); } diff --git a/extensions/yii/jui/SliderInput.php b/extensions/yii/jui/SliderInput.php index 8ded4e8..8a43eb1 100644 --- a/extensions/yii/jui/SliderInput.php +++ b/extensions/yii/jui/SliderInput.php @@ -50,30 +50,42 @@ class SliderInput extends InputWidget 'start' => 'slidestart', 'stop' => 'slidestop', ]; + /** + * @var array the HTML attributes for the container tag. + */ + public $containerOptions = []; + + /** + * @inheritdoc + */ + public function init() + { + parent::init(); + if (!isset($this->containerOptions['id'])) { + $this->containerOptions['id'] = $this->options['id'] . '-container'; + } + } /** * Executes the widget. */ public function run() { - echo Html::tag('div', '', $this->options); + echo Html::tag('div', '', $this->containerOptions); - $inputId = $this->id.'-input'; - $inputOptions = $this->options; - $inputOptions['id'] = $inputId; if ($this->hasModel()) { - echo Html::activeHiddenInput($this->model, $this->attribute, $inputOptions); + echo Html::activeHiddenInput($this->model, $this->attribute, $this->options); } else { - echo Html::hiddenInput($this->name, $this->value, $inputOptions); + echo Html::hiddenInput($this->name, $this->value, $this->options); } if (!isset($this->clientEvents['slide'])) { $this->clientEvents['slide'] = 'function(event, ui) { - $("#'.$inputId.'").val(ui.value); + $("#' . $this->options['id'] . '").val(ui.value); }'; } - $this->registerWidget('slider', SliderAsset::className()); - $this->getView()->registerJs('$("#'.$inputId.'").val($("#'.$this->id.'").slider("value"));'); + $this->registerWidget('slider', SliderAsset::className(), $this->containerOptions['id']); + $this->getView()->registerJs('$("#' . $this->options['id'] . '").val($("#' . $this->id . '").slider("value"));'); } } diff --git a/extensions/yii/jui/Widget.php b/extensions/yii/jui/Widget.php index 90bad68..8881a77 100644 --- a/extensions/yii/jui/Widget.php +++ b/extensions/yii/jui/Widget.php @@ -76,11 +76,11 @@ class Widget extends \yii\base\Widget /** * Registers a specific jQuery UI widget options * @param string $name the name of the jQuery UI widget + * @param string $id the ID of the widget */ - protected function registerClientOptions($name) + protected function registerClientOptions($name, $id) { if ($this->clientOptions !== false) { - $id = $this->options['id']; $options = empty($this->clientOptions) ? '' : Json::encode($this->clientOptions); $js = "jQuery('#$id').$name($options);"; $this->getView()->registerJs($js); @@ -90,11 +90,11 @@ class Widget extends \yii\base\Widget /** * Registers a specific jQuery UI widget events * @param string $name the name of the jQuery UI widget + * @param string $id the ID of the widget */ - protected function registerClientEvents($name) + protected function registerClientEvents($name, $id) { if (!empty($this->clientEvents)) { - $id = $this->options['id']; $js = []; foreach ($this->clientEvents as $event => $handler) { if (isset($this->clientEventMap[$event])) { @@ -112,11 +112,15 @@ class Widget extends \yii\base\Widget * Registers a specific jQuery UI widget asset bundle, initializes it with client options and registers related events * @param string $name the name of the jQuery UI widget * @param string $assetBundle the asset bundle for the widget + * @param string $id the ID of the widget. If null, it will use the `id` value of [[options]]. */ - protected function registerWidget($name, $assetBundle) + protected function registerWidget($name, $assetBundle, $id = null) { + if ($id === null) { + $id = $this->options['id']; + } $this->registerAssets($assetBundle); - $this->registerClientOptions($name); - $this->registerClientEvents($name); + $this->registerClientOptions($name, $id); + $this->registerClientEvents($name, $id); } } diff --git a/framework/CHANGELOG.md b/framework/CHANGELOG.md index a1d7bdf..9694cb7 100644 --- a/framework/CHANGELOG.md +++ b/framework/CHANGELOG.md @@ -9,6 +9,7 @@ Yii Framework 2 Change Log - Bug #1500: Log messages exported to files are not separated by newlines (omnilight, qiangxue) - Bug #1509: The SQL for creating Postgres RBAC tables is incorrect (qiangxue) - Bug #1545: It was not possible to execute db Query twice, params where missing (cebe) +- Bug #1550: fixed the issue that JUI input widgets did not property input IDs. - Bug #1591: StringValidator is accessing undefined property (qiangxue) - Bug: Fixed `Call to a member function registerAssetFiles() on a non-object` in case of wrong `sourcePath` for an asset bundle (samdark) - Bug: Fixed incorrect event name for `yii\jui\Spinner` (samdark) @@ -24,7 +25,8 @@ Yii Framework 2 Change Log - Enh: Added `Widget::autoIdPrefix` to support prefixing automatically generated widget IDs (qiangxue) - Enh: Support for file aliases in console command 'message' (omnilight) - Enh: Sort and Paginiation can now create absolute URLs (cebe) -- Chg: Renamed yii\jui\Widget::clientEventsMap to clientEventMap (qiangxue) +- Chg: Renamed `yii\jui\Widget::clientEventsMap` to `clientEventMap` (qiangxue) +- Chg: Added `yii\widgets\InputWidget::options` (qiangxue) - New #1438: [MongoDB integration](https://github.com/yiisoft/yii2-mongodb) ActiveRecord and Query (klimov-paul) - New #1393: [Codeception testing framework integration](https://github.com/yiisoft/yii2-codeception) (Ragazzo) diff --git a/framework/yii/captcha/Captcha.php b/framework/yii/captcha/Captcha.php index 76090a2..18b8765 100644 --- a/framework/yii/captcha/Captcha.php +++ b/framework/yii/captcha/Captcha.php @@ -39,10 +39,6 @@ class Captcha extends InputWidget */ public $captchaAction = 'site/captcha'; /** - * @var array HTML attributes to be applied to the text input field. - */ - public $options = []; - /** * @var array HTML attributes to be applied to the CAPTCHA image tag. */ public $imageOptions = []; @@ -62,9 +58,6 @@ class Captcha extends InputWidget $this->checkRequirements(); - if (!isset($this->options['id'])) { - $this->options['id'] = $this->hasModel() ? Html::getInputId($this->model, $this->attribute) : $this->getId(); - } if (!isset($this->imageOptions['id'])) { $this->imageOptions['id'] = $this->options['id'] . '-image'; } diff --git a/framework/yii/widgets/InputWidget.php b/framework/yii/widgets/InputWidget.php index e1981c9..0a4b5b7 100644 --- a/framework/yii/widgets/InputWidget.php +++ b/framework/yii/widgets/InputWidget.php @@ -11,6 +11,7 @@ use Yii; use yii\base\Widget; use yii\base\Model; use yii\base\InvalidConfigException; +use yii\helpers\Html; /** * InputWidget is the base class for widgets that collect user inputs. @@ -40,6 +41,10 @@ class InputWidget extends Widget * @var string the input value. */ public $value; + /** + * @var array the HTML attributes for the input tag. + */ + public $options = []; /** @@ -49,7 +54,10 @@ class InputWidget extends Widget public function init() { if (!$this->hasModel() && $this->name === null) { - throw new InvalidConfigException("Either 'name' or 'model' and 'attribute' properties must be specified."); + throw new InvalidConfigException("Either 'name', or 'model' and 'attribute' properties must be specified."); + } + if (!isset($this->options['id'])) { + $this->options['id'] = $this->hasModel() ? Html::getInputId($this->model, $this->attribute) : $this->getId(); } parent::init(); } diff --git a/framework/yii/widgets/MaskedInput.php b/framework/yii/widgets/MaskedInput.php index fc21cef..7eb42a7 100644 --- a/framework/yii/widgets/MaskedInput.php +++ b/framework/yii/widgets/MaskedInput.php @@ -61,10 +61,6 @@ class MaskedInput extends InputWidget * @var string a JavaScript function callback that will be invoked when user finishes the input. */ public $completed; - /** - * @var array the HTML attributes for the input tag. - */ - public $options = []; /** @@ -77,10 +73,6 @@ class MaskedInput extends InputWidget if (empty($this->mask)) { throw new InvalidConfigException('The "mask" property must be set.'); } - - if (!isset($this->options['id'])) { - $this->options['id'] = $this->hasModel() ? Html::getInputId($this->model, $this->attribute) : $this->getId(); - } } /** From c1aef527e43e7a2ef1e7c613bba258e7ba235a6a Mon Sep 17 00:00:00 2001 From: Larry Ullman Date: Sat, 21 Dec 2013 20:54:54 -0500 Subject: [PATCH 04/36] Edited up to "operator can be..." --- docs/guide/query-builder.md | 91 ++++++++++++++++++++++++++++----------------- 1 file changed, 56 insertions(+), 35 deletions(-) diff --git a/docs/guide/query-builder.md b/docs/guide/query-builder.md index ac79f1d..f775c76 100644 --- a/docs/guide/query-builder.md +++ b/docs/guide/query-builder.md @@ -1,86 +1,98 @@ Query Builder and Query ======================= -Yii provides a basic database access layer as was described in [Database basics](database-basics.md) section. Still it's -a bit too much to use SQL directly all the time. To solve the issue Yii provides a query builder that allows you to -work with the database in object-oriented style. +Yii provides a basic database access layer as described in the [Database basics](database-basics.md) section. The database access layer provides a low-level way to interact with the database. While useful in some situations, it can be tedious to rely too much upon direct SQL. An alternative approach that Yii provides is the Query Builder. The Query Builder provides an object-oriented vehicle for generating queries to be executed. -Basic query builder usage is the following: +Here's a basic example: ```php $query = new Query; -// Define query +// Define the query: $query->select('id, name') - ->from('tbl_user') - ->limit(10); + ->from('tbl_user') + ->limit(10); -// Create a command. You can get the actual SQL using $command->sql +// Create a command. $command = $query->createCommand(); -// Execute command +// You can get the actual SQL using $command->sql + +// Execute the command: $rows = $command->queryAll(); ``` -Basic selects and joins ------------------------ +Basic selects +------------- -In order to form a `SELECT` query you need to specify what to select and where to select it from. +In order to form a basic `SELECT` query, you need to specify what columns to select and from what table: ```php $query->select('id, name') ->from('tbl_user'); ``` -If you want to get IDs of all users with posts you can use `DISTINCT`. With query builder it will look like the following: +Select options can be specified as a comma-separated string, as in the above, or as an array. The array syntax is especially useful when forming the selection dynamically: ```php -$query->select('user_id')->distinct()->from('tbl_post'); +$columns = []; +$columns[] = 'id'; +$columns[] = 'name'; +$query->select($columns) + ->from('tbl_user'); ``` -Select options can be specified as array. It's especially useful when these are formed dynamically. - -```php -$query->select(['tbl_user.name AS author', 'tbl_post.title as title']) // <-- specified as array - ->from('tbl_user') - ->leftJoin('tbl_post', 'tbl_post.user_id = tbl_user.id'); // <-- join with another table -``` +Joins +----- -In the code above we've used `leftJoin` method to select from two related tables at the same time. First parameter -specifies table name and the second is the join condition. Query builder has the following methods to join tables: +Joins are generated in the Query Builder by using the applicable join method: - `innerJoin` - `leftJoin` - `rightJoin` -If your data storage supports more types you can use generic `join` method: +This left join selects data from two related tables in one query: + +```php +$query->select(['tbl_user.name AS author', 'tbl_post.title as title']) ->from('tbl_user') + ->leftJoin('tbl_post', 'tbl_post.user_id = tbl_user.id'); +``` + +In the code, the `leftJion` method's first parameter +specifies the table to join to. The second paramter defines the join condition. + +If your database application supports other join types, you can use those via the generic `join` method: ```php $query->join('FULL OUTER JOIN', 'tbl_post', 'tbl_post.user_id = tbl_user.id'); ``` -Specifying conditions +The first argument is the join type to perform. The second is the table to join to, and the third is the condition. + +Specifying SELECT conditions --------------------- -Usually you need data that matches some conditions. There are some useful methods to specify these and the most powerful -is `where`. There are multiple ways to use it. +Usually data is selected based upon certain criteria. Query Builder has some useful methods to specify these, the most powerful of which being `where`. It can be used in multiple ways. -The simplest is to specify condition in a string: +The simplest way to apply a condition is to use a string: ```php $query->where('status=:status', [':status' => $status]); ``` -When using this format make sure you're binding parameters and not creating a query by string concatenation. +When using strings, make sure you're binding the query parameters, not creating a query by string concatenation. The above approach is safe to use, the following is not: -Instead of binding status value immediately you can do it using `params` or `addParams`: +```php +$query->where("status=$status"); // Dangerous! +``` + +Instead of binding the status value immediately, you can do so using `params` or `addParams`: ```php $query->where('status=:status'); - $query->addParams([':status' => $status]); ``` -There is another convenient way to use the method called hash format: +Multiple conditions can simultaneously be set in `where` using the *hash format*: ```php $query->where([ @@ -90,19 +102,19 @@ $query->where([ ]); ``` -It will generate the following SQL: +That code will generate the following SQL: ```sql WHERE (`status` = 10) AND (`type` = 2) AND (`id` IN (4, 8, 15, 16, 23, 42)) ``` -If you'll specify value as `null` such as the following: +NULL is a special value in databases, and is handled smartly by the Query Builder. This code: ```php $query->where(['status' => null]); ``` -SQL generated will be: +results in this WHERE clause: ```sql WHERE (`status` IS NULL) @@ -174,6 +186,15 @@ $query->orderBy([ Here we are ordering by `id` ascending and then by `name` descending. +Distinct +-------- + +If you want to get IDs of all users with posts you can use `DISTINCT`. With query builder it will look like the following: + +```php +$query->select('user_id')->distinct()->from('tbl_post'); +``` + Group and Having ---------------- From 42d8748e6e9b3bab6a855dbbffab5b6afe014e88 Mon Sep 17 00:00:00 2001 From: Qiang Xue Date: Sat, 21 Dec 2013 23:26:35 -0500 Subject: [PATCH 05/36] Fixes #1579: throw exception when the given AR relation name does not match in a case sensitive manner. Renamed `ActiveRecord::getPopulatedRelations()` to `getRelatedRecords()` --- extensions/yii/sphinx/ActiveRecord.php | 4 +-- framework/CHANGELOG.md | 2 ++ framework/yii/db/BaseActiveRecord.php | 35 ++++++++++++++++------ .../unit/extensions/mongodb/ActiveRelationTest.php | 4 +-- .../unit/extensions/sphinx/ActiveRelationTest.php | 4 +-- .../sphinx/ExternalActiveRelationTest.php | 4 +-- tests/unit/framework/ar/ActiveRecordTestTrait.php | 6 ++-- 7 files changed, 39 insertions(+), 20 deletions(-) diff --git a/extensions/yii/sphinx/ActiveRecord.php b/extensions/yii/sphinx/ActiveRecord.php index e7bda34..0f9a48e 100644 --- a/extensions/yii/sphinx/ActiveRecord.php +++ b/extensions/yii/sphinx/ActiveRecord.php @@ -29,7 +29,7 @@ use yii\helpers\StringHelper; * @property mixed $oldPrimaryKey The old primary key value. An array (column name => column value) is * returned if the primary key is composite. A string is returned otherwise (null will be returned if the key * value is null). This property is read-only. - * @property array $populatedRelations An array of relation data indexed by relation names. This property is + * @property array $relatedRecords An array of the populated related records indexed by relation names. This property is * read-only. * @property mixed $primaryKey The primary key value. An array (column name => column value) is returned if * the primary key is composite. A string is returned otherwise (null will be returned if the key value is null). @@ -668,4 +668,4 @@ abstract class ActiveRecord extends BaseActiveRecord $transactions = $this->transactions(); return isset($transactions[$scenario]) && ($transactions[$scenario] & $operation); } -} \ No newline at end of file +} diff --git a/framework/CHANGELOG.md b/framework/CHANGELOG.md index 9694cb7..0d2bd31 100644 --- a/framework/CHANGELOG.md +++ b/framework/CHANGELOG.md @@ -21,11 +21,13 @@ Yii Framework 2 Change Log - Enh #1469: ActiveRecord::find() now works with default conditions (default scope) applied by createQuery (cebe) - Enh #1523: Query conditions now allow to use the NOT operator (cebe) - Enh #1552: It is now possible to use multiple bootstrap NavBar in a single page (Alex-Code) +- Enh #1579: throw exception when the given AR relation name does not match in a case sensitive manner (qiangxue) - Enh: Added `favicon.ico` and `robots.txt` to defauly application templates (samdark) - Enh: Added `Widget::autoIdPrefix` to support prefixing automatically generated widget IDs (qiangxue) - Enh: Support for file aliases in console command 'message' (omnilight) - Enh: Sort and Paginiation can now create absolute URLs (cebe) - Chg: Renamed `yii\jui\Widget::clientEventsMap` to `clientEventMap` (qiangxue) +- Chg: Renamed `ActiveRecord::getPopulatedRelations()` to `getRelatedRecords()` (qiangxue) - Chg: Added `yii\widgets\InputWidget::options` (qiangxue) - New #1438: [MongoDB integration](https://github.com/yiisoft/yii2-mongodb) ActiveRecord and Query (klimov-paul) - New #1393: [Codeception testing framework integration](https://github.com/yiisoft/yii2-codeception) (Ragazzo) diff --git a/framework/yii/db/BaseActiveRecord.php b/framework/yii/db/BaseActiveRecord.php index dae7134..6c947b8 100644 --- a/framework/yii/db/BaseActiveRecord.php +++ b/framework/yii/db/BaseActiveRecord.php @@ -30,7 +30,7 @@ use yii\helpers\Inflector; * @property mixed $oldPrimaryKey The old primary key value. An array (column name => column value) is * returned if the primary key is composite. A string is returned otherwise (null will be returned if the key * value is null). This property is read-only. - * @property array $populatedRelations An array of relation data indexed by relation names. This property is + * @property array $relatedRecords An array of the populated related records indexed by relation names. This property is * read-only. * @property mixed $primaryKey The primary key value. An array (column name => column value) is returned if * the primary key is composite. A string is returned otherwise (null will be returned if the key value is null). @@ -232,6 +232,13 @@ abstract class BaseActiveRecord extends Model implements ActiveRecordInterface } $value = parent::__get($name); if ($value instanceof ActiveRelationInterface) { + if (method_exists($this, 'get' . $name)) { + $method = new \ReflectionMethod($this, 'get' . $name); + $realName = lcfirst(substr($method->getName(), 3)); + if ($realName !== $name) { + throw new InvalidParamException('Relation names are case sensitive. ' . get_class($this) . " has a relation named \"$realName\" instead of \"$name\"."); + } + } return $this->_related[$name] = $value->multiple ? $value->all() : $value->one(); } else { return $value; @@ -390,10 +397,10 @@ abstract class BaseActiveRecord extends Model implements ActiveRecordInterface } /** - * Returns all populated relations. - * @return array an array of relation data indexed by relation names. + * Returns all populated related records. + * @return array an array of related records indexed by relation names. */ - public function getPopulatedRelations() + public function getRelatedRecords() { return $this->_related; } @@ -999,15 +1006,25 @@ abstract class BaseActiveRecord extends Model implements ActiveRecordInterface { $getter = 'get' . $name; try { + // the relation could be defined in a behavior $relation = $this->$getter(); - if ($relation instanceof ActiveRelationInterface) { - return $relation; - } else { - throw new InvalidParamException(get_class($this) . ' has no relation named "' . $name . '".'); - } } catch (UnknownMethodException $e) { throw new InvalidParamException(get_class($this) . ' has no relation named "' . $name . '".', 0, $e); } + if (!$relation instanceof ActiveRelationInterface) { + throw new InvalidParamException(get_class($this) . ' has no relation named "' . $name . '".'); + } + + if (method_exists($this, $getter)) { + // relation name is case sensitive, trying to validate it when the relation is defined within this class + $method = new \ReflectionMethod($this, $getter); + $realName = lcfirst(substr($method->getName(), 3)); + if ($realName !== $name) { + throw new InvalidParamException('Relation names are case sensitive. ' . get_class($this) . " has a relation named \"$realName\" instead of \"$name\"."); + } + } + + return $relation; } /** diff --git a/tests/unit/extensions/mongodb/ActiveRelationTest.php b/tests/unit/extensions/mongodb/ActiveRelationTest.php index 8736d52..2baeab4 100644 --- a/tests/unit/extensions/mongodb/ActiveRelationTest.php +++ b/tests/unit/extensions/mongodb/ActiveRelationTest.php @@ -69,7 +69,7 @@ class ActiveRelationTest extends MongoDbTestCase $this->assertTrue($order->isRelationPopulated('customer')); $this->assertTrue($customer instanceof Customer); $this->assertEquals((string)$customer->_id, (string)$order->customer_id); - $this->assertEquals(1, count($order->populatedRelations)); + $this->assertEquals(1, count($order->relatedRecords)); } public function testFindEager() @@ -83,4 +83,4 @@ class ActiveRelationTest extends MongoDbTestCase $this->assertTrue($orders[1]->customer instanceof Customer); $this->assertEquals((string)$orders[1]->customer->_id, (string)$orders[1]->customer_id); } -} \ No newline at end of file +} diff --git a/tests/unit/extensions/sphinx/ActiveRelationTest.php b/tests/unit/extensions/sphinx/ActiveRelationTest.php index cd58035..d85c6b9 100644 --- a/tests/unit/extensions/sphinx/ActiveRelationTest.php +++ b/tests/unit/extensions/sphinx/ActiveRelationTest.php @@ -29,7 +29,7 @@ class ActiveRelationTest extends SphinxTestCase $index = $article->index; $this->assertTrue($article->isRelationPopulated('index')); $this->assertTrue($index instanceof ArticleIndex); - $this->assertEquals(1, count($article->populatedRelations)); + $this->assertEquals(1, count($article->relatedRecords)); $this->assertEquals($article->id, $index->id); } @@ -42,4 +42,4 @@ class ActiveRelationTest extends SphinxTestCase $this->assertTrue($articles[0]->index instanceof ArticleIndex); $this->assertTrue($articles[1]->index instanceof ArticleIndex); } -} \ No newline at end of file +} diff --git a/tests/unit/extensions/sphinx/ExternalActiveRelationTest.php b/tests/unit/extensions/sphinx/ExternalActiveRelationTest.php index e30a0cf..1740c42 100644 --- a/tests/unit/extensions/sphinx/ExternalActiveRelationTest.php +++ b/tests/unit/extensions/sphinx/ExternalActiveRelationTest.php @@ -32,7 +32,7 @@ class ExternalActiveRelationTest extends SphinxTestCase $source = $article->source; $this->assertTrue($article->isRelationPopulated('source')); $this->assertTrue($source instanceof ArticleDb); - $this->assertEquals(1, count($article->populatedRelations)); + $this->assertEquals(1, count($article->relatedRecords)); // has many : /*$this->assertFalse($article->isRelationPopulated('tags')); @@ -71,4 +71,4 @@ class ExternalActiveRelationTest extends SphinxTestCase ->all(); $this->assertEquals(2, count($articles)); } -} \ No newline at end of file +} diff --git a/tests/unit/framework/ar/ActiveRecordTestTrait.php b/tests/unit/framework/ar/ActiveRecordTestTrait.php index 50a5f81..95def9d 100644 --- a/tests/unit/framework/ar/ActiveRecordTestTrait.php +++ b/tests/unit/framework/ar/ActiveRecordTestTrait.php @@ -392,14 +392,14 @@ trait ActiveRecordTestTrait $orders = $customer->orders; $this->assertTrue($customer->isRelationPopulated('orders')); $this->assertEquals(2, count($orders)); - $this->assertEquals(1, count($customer->populatedRelations)); + $this->assertEquals(1, count($customer->relatedRecords)); /** @var Customer $customer */ $customer = $this->callCustomerFind(2); $this->assertFalse($customer->isRelationPopulated('orders')); $orders = $customer->getOrders()->where(['id' => 3])->all(); $this->assertFalse($customer->isRelationPopulated('orders')); - $this->assertEquals(0, count($customer->populatedRelations)); + $this->assertEquals(0, count($customer->relatedRecords)); $this->assertEquals(1, count($orders)); $this->assertEquals(3, $orders[0]->id); @@ -421,7 +421,7 @@ trait ActiveRecordTestTrait $customer = $this->callCustomerFind()->where(['id' => 1])->with('orders')->one(); $this->assertTrue($customer->isRelationPopulated('orders')); $this->assertEquals(1, count($customer->orders)); - $this->assertEquals(1, count($customer->populatedRelations)); + $this->assertEquals(1, count($customer->relatedRecords)); } public function testFindLazyVia() From a08de951772603ec4333c5a3ec339af193e2f612 Mon Sep 17 00:00:00 2001 From: Qiang Xue Date: Sun, 22 Dec 2013 01:27:03 -0500 Subject: [PATCH 06/36] Fixes #1582: Error messages shown via client-side validation should not be double encoded --- framework/CHANGELOG.md | 1 + framework/yii/assets/yii.activeForm.js | 8 ++++---- framework/yii/captcha/CaptchaValidator.php | 4 ++-- framework/yii/validators/BooleanValidator.php | 4 ++-- framework/yii/validators/CompareValidator.php | 4 ++-- framework/yii/validators/EmailValidator.php | 4 ++-- framework/yii/validators/NumberValidator.php | 12 ++++++------ framework/yii/validators/RangeValidator.php | 4 ++-- framework/yii/validators/RegularExpressionValidator.php | 4 ++-- framework/yii/validators/RequiredValidator.php | 4 ++-- framework/yii/validators/StringValidator.php | 16 ++++++++-------- framework/yii/validators/UrlValidator.php | 4 ++-- 12 files changed, 35 insertions(+), 34 deletions(-) diff --git a/framework/CHANGELOG.md b/framework/CHANGELOG.md index 0d2bd31..cf6eb5a 100644 --- a/framework/CHANGELOG.md +++ b/framework/CHANGELOG.md @@ -10,6 +10,7 @@ Yii Framework 2 Change Log - Bug #1509: The SQL for creating Postgres RBAC tables is incorrect (qiangxue) - Bug #1545: It was not possible to execute db Query twice, params where missing (cebe) - Bug #1550: fixed the issue that JUI input widgets did not property input IDs. +- Bug #1582: Error messages shown via client-side validation should not be double encoded (qiangxue) - Bug #1591: StringValidator is accessing undefined property (qiangxue) - Bug: Fixed `Call to a member function registerAssetFiles() on a non-object` in case of wrong `sourcePath` for an asset bundle (samdark) - Bug: Fixed incorrect event name for `yii\jui\Spinner` (samdark) diff --git a/framework/yii/assets/yii.activeForm.js b/framework/yii/assets/yii.activeForm.js index c1d5bf5..e898efc 100644 --- a/framework/yii/assets/yii.activeForm.js +++ b/framework/yii/assets/yii.activeForm.js @@ -348,7 +348,7 @@ $container.removeClass(data.settings.validatingCssClass + ' ' + data.settings.successCssClass) .addClass(data.settings.errorCssClass); } else { - $error.html(''); + $error.text(''); $container.removeClass(data.settings.validatingCssClass + ' ' + data.settings.errorCssClass + ' ') .addClass(data.settings.successCssClass); } @@ -365,15 +365,15 @@ var updateSummary = function ($form, messages) { var data = $form.data('yiiActiveForm'), $summary = $form.find(data.settings.errorSummary), - content = ''; + $ul = $summary.find('ul'); if ($summary.length && messages) { $.each(data.attributes, function () { if ($.isArray(messages[this.name]) && messages[this.name].length) { - content += '
  • ' + messages[this.name][0] + '
    • '; + $ul.append($('
  • ').text(messages[this.name][0])); } }); - $summary.toggle(content !== '').find('ul').html(content); + $summary.toggle($ul.find('li').length > 0); } }; diff --git a/framework/yii/captcha/CaptchaValidator.php b/framework/yii/captcha/CaptchaValidator.php index 83996d5..57665ec 100644 --- a/framework/yii/captcha/CaptchaValidator.php +++ b/framework/yii/captcha/CaptchaValidator.php @@ -93,9 +93,9 @@ class CaptchaValidator extends Validator 'hash' => $hash, 'hashKey' => 'yiiCaptcha/' . $this->captchaAction, 'caseSensitive' => $this->caseSensitive, - 'message' => Html::encode(strtr($this->message, [ + 'message' => strtr($this->message, [ '{attribute}' => $object->getAttributeLabel($attribute), - ])), + ]), ]; if ($this->skipOnEmpty) { $options['skipOnEmpty'] = 1; diff --git a/framework/yii/validators/BooleanValidator.php b/framework/yii/validators/BooleanValidator.php index 961ed14..8bca827 100644 --- a/framework/yii/validators/BooleanValidator.php +++ b/framework/yii/validators/BooleanValidator.php @@ -72,11 +72,11 @@ class BooleanValidator extends Validator $options = [ 'trueValue' => $this->trueValue, 'falseValue' => $this->falseValue, - 'message' => Html::encode(strtr($this->message, [ + 'message' => strtr($this->message, [ '{attribute}' => $object->getAttributeLabel($attribute), '{true}' => $this->trueValue, '{false}' => $this->falseValue, - ])), + ]), ]; if ($this->skipOnEmpty) { $options['skipOnEmpty'] = 1; diff --git a/framework/yii/validators/CompareValidator.php b/framework/yii/validators/CompareValidator.php index 69bd6d5..cbd12d2 100644 --- a/framework/yii/validators/CompareValidator.php +++ b/framework/yii/validators/CompareValidator.php @@ -195,11 +195,11 @@ class CompareValidator extends Validator $options['skipOnEmpty'] = 1; } - $options['message'] = Html::encode(strtr($this->message, [ + $options['message'] = strtr($this->message, [ '{attribute}' => $object->getAttributeLabel($attribute), '{compareAttribute}' => $compareValue, '{compareValue}' => $compareValue, - ])); + ]); ValidationAsset::register($view); return 'yii.validation.compare(value, messages, ' . json_encode($options) . ');'; diff --git a/framework/yii/validators/EmailValidator.php b/framework/yii/validators/EmailValidator.php index 24eeaec..e5d9b75 100644 --- a/framework/yii/validators/EmailValidator.php +++ b/framework/yii/validators/EmailValidator.php @@ -98,9 +98,9 @@ class EmailValidator extends Validator 'pattern' => new JsExpression($this->pattern), 'fullPattern' => new JsExpression($this->fullPattern), 'allowName' => $this->allowName, - 'message' => Html::encode(strtr($this->message, [ + 'message' => strtr($this->message, [ '{attribute}' => $object->getAttributeLabel($attribute), - ])), + ]), 'enableIDN' => (boolean)$this->enableIDN, ]; if ($this->skipOnEmpty) { diff --git a/framework/yii/validators/NumberValidator.php b/framework/yii/validators/NumberValidator.php index 60e920a..1bb2360 100644 --- a/framework/yii/validators/NumberValidator.php +++ b/framework/yii/validators/NumberValidator.php @@ -124,24 +124,24 @@ class NumberValidator extends Validator $options = [ 'pattern' => new JsExpression($this->integerOnly ? $this->integerPattern : $this->numberPattern), - 'message' => Html::encode(strtr($this->message, [ + 'message' => strtr($this->message, [ '{attribute}' => $label, - ])), + ]), ]; if ($this->min !== null) { $options['min'] = $this->min; - $options['tooSmall'] = Html::encode(strtr($this->tooSmall, [ + $options['tooSmall'] = strtr($this->tooSmall, [ '{attribute}' => $label, '{min}' => $this->min, - ])); + ]); } if ($this->max !== null) { $options['max'] = $this->max; - $options['tooBig'] = Html::encode(strtr($this->tooBig, [ + $options['tooBig'] = strtr($this->tooBig, [ '{attribute}' => $label, '{max}' => $this->max, - ])); + ]); } if ($this->skipOnEmpty) { $options['skipOnEmpty'] = 1; diff --git a/framework/yii/validators/RangeValidator.php b/framework/yii/validators/RangeValidator.php index cfd1f51..a4da139 100644 --- a/framework/yii/validators/RangeValidator.php +++ b/framework/yii/validators/RangeValidator.php @@ -73,9 +73,9 @@ class RangeValidator extends Validator $options = [ 'range' => $range, 'not' => $this->not, - 'message' => Html::encode(strtr($this->message, [ + 'message' => strtr($this->message, [ '{attribute}' => $object->getAttributeLabel($attribute), - ])), + ]), ]; if ($this->skipOnEmpty) { $options['skipOnEmpty'] = 1; diff --git a/framework/yii/validators/RegularExpressionValidator.php b/framework/yii/validators/RegularExpressionValidator.php index 7b02381..28e9bdc 100644 --- a/framework/yii/validators/RegularExpressionValidator.php +++ b/framework/yii/validators/RegularExpressionValidator.php @@ -80,9 +80,9 @@ class RegularExpressionValidator extends Validator $options = [ 'pattern' => new JsExpression($pattern), 'not' => $this->not, - 'message' => Html::encode(strtr($this->message, [ + 'message' => strtr($this->message, [ '{attribute}' => $object->getAttributeLabel($attribute), - ])), + ]), ]; if ($this->skipOnEmpty) { $options['skipOnEmpty'] = 1; diff --git a/framework/yii/validators/RequiredValidator.php b/framework/yii/validators/RequiredValidator.php index 43b40cf..f291f39 100644 --- a/framework/yii/validators/RequiredValidator.php +++ b/framework/yii/validators/RequiredValidator.php @@ -101,9 +101,9 @@ class RequiredValidator extends Validator $options['strict'] = 1; } - $options['message'] = Html::encode(strtr($options['message'], [ + $options['message'] = strtr($options['message'], [ '{attribute}' => $object->getAttributeLabel($attribute), - ])); + ]); ValidationAsset::register($view); return 'yii.validation.required(value, messages, ' . json_encode($options) . ');'; diff --git a/framework/yii/validators/StringValidator.php b/framework/yii/validators/StringValidator.php index dbc4001..279a189 100644 --- a/framework/yii/validators/StringValidator.php +++ b/framework/yii/validators/StringValidator.php @@ -151,31 +151,31 @@ class StringValidator extends Validator $label = $object->getAttributeLabel($attribute); $options = [ - 'message' => Html::encode(strtr($this->message, [ + 'message' => strtr($this->message, [ '{attribute}' => $label, - ])), + ]), ]; if ($this->min !== null) { $options['min'] = $this->min; - $options['tooShort'] = Html::encode(strtr($this->tooShort, [ + $options['tooShort'] = strtr($this->tooShort, [ '{attribute}' => $label, '{min}' => $this->min, - ])); + ]); } if ($this->max !== null) { $options['max'] = $this->max; - $options['tooLong'] = Html::encode(strtr($this->tooLong, [ + $options['tooLong'] = strtr($this->tooLong, [ '{attribute}' => $label, '{max}' => $this->max, - ])); + ]); } if ($this->length !== null) { $options['is'] = $this->length; - $options['notEqual'] = Html::encode(strtr($this->notEqual, [ + $options['notEqual'] = strtr($this->notEqual, [ '{attribute}' => $label, '{length}' => $this->length, - ])); + ]); } if ($this->skipOnEmpty) { $options['skipOnEmpty'] = 1; diff --git a/framework/yii/validators/UrlValidator.php b/framework/yii/validators/UrlValidator.php index 4023e2a..4cb20f6 100644 --- a/framework/yii/validators/UrlValidator.php +++ b/framework/yii/validators/UrlValidator.php @@ -121,9 +121,9 @@ class UrlValidator extends Validator $options = [ 'pattern' => new JsExpression($pattern), - 'message' => Html::encode(strtr($this->message, [ + 'message' => strtr($this->message, [ '{attribute}' => $object->getAttributeLabel($attribute), - ])), + ]), 'enableIDN' => (boolean)$this->enableIDN, ]; if ($this->skipOnEmpty) { From 46768286b17005cebd396e1156965d8d6e57a3c8 Mon Sep 17 00:00:00 2001 From: Alexander Makarov Date: Sun, 22 Dec 2013 13:01:37 +0100 Subject: [PATCH 07/36] fixes #1593: fixed typo in Nav --- extensions/yii/bootstrap/Nav.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/extensions/yii/bootstrap/Nav.php b/extensions/yii/bootstrap/Nav.php index ef45f09..42e6346 100644 --- a/extensions/yii/bootstrap/Nav.php +++ b/extensions/yii/bootstrap/Nav.php @@ -164,7 +164,7 @@ class Nav extends Widget if ($items !== null) { $linkOptions['data-toggle'] = 'dropdown'; Html::addCssClass($options, 'dropdown'); - Html::addCssClass($urlOptions, 'dropdown-toggle'); + Html::addCssClass($linkOptions, 'dropdown-toggle'); $label .= ' ' . Html::tag('b', '', ['class' => 'caret']); if (is_array($items)) { $items = Dropdown::widget([ From 0035a982d86e4f12d84a805e6601eabac20ba92b Mon Sep 17 00:00:00 2001 From: Alexander Makarov Date: Sun, 22 Dec 2013 13:39:40 +0100 Subject: [PATCH 08/36] fixed typo --- docs/guide/assets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guide/assets.md b/docs/guide/assets.md index 47c4063..467d7f8 100644 --- a/docs/guide/assets.md +++ b/docs/guide/assets.md @@ -40,7 +40,7 @@ application's `web` directory. is an alias that corresponds to your website base URL such as `http://example.com/`. In case you have asset files under non web accessible directory, that is the case for any extension, you need -to additionally specify `$sourcePath`. Files will be copied or symlinked from source bath to base path prior to being +to additionally specify `$sourcePath`. Files will be copied or symlinked from source path to base path prior to being registered. In case source path is used `baseUrl` is generated automatically at the time of publishing asset bundle. Dependencies on other asset bundles are specified via `$depends` property. It is an array that contains fully qualified From d5f40b42cfd8467bdcfbf127fee66c6f451aea99 Mon Sep 17 00:00:00 2001 From: Qiang Xue Date: Sun, 22 Dec 2013 10:02:00 -0500 Subject: [PATCH 09/36] Added ActiveRecordInterface::getOldPrimaryKey(). --- framework/yii/db/ActiveRecordInterface.php | 19 ++++++++++++++++++- framework/yii/validators/ExistValidator.php | 4 ++-- framework/yii/validators/UniqueValidator.php | 8 ++------ 3 files changed, 22 insertions(+), 9 deletions(-) diff --git a/framework/yii/db/ActiveRecordInterface.php b/framework/yii/db/ActiveRecordInterface.php index 556384b..73db852 100644 --- a/framework/yii/db/ActiveRecordInterface.php +++ b/framework/yii/db/ActiveRecordInterface.php @@ -70,6 +70,23 @@ interface ActiveRecordInterface public function getPrimaryKey($asArray = false); /** + * Returns the old primary key value(s). + * This refers to the primary key value that is populated into the record + * after executing a find method (e.g. find(), findAll()). + * The value remains unchanged even if the primary key attribute is manually assigned with a different value. + * @param boolean $asArray whether to return the primary key value as an array. If true, + * the return value will be an array with column name as key and column value as value. + * If this is false (default), a scalar value will be returned for non-composite primary key. + * @property mixed The old primary key value. An array (column name => column value) is + * returned if the primary key is composite. A string is returned otherwise (null will be + * returned if the key value is null). + * @return mixed the old primary key value. An array (column name => column value) is returned if the primary key + * is composite or `$asArray` is true. A string is returned otherwise (null will be returned if + * the key value is null). + */ + public function getOldPrimaryKey($asArray = false); + + /** * Creates an [[ActiveQueryInterface|ActiveQuery]] instance for query purpose. * * This method is usually ment to be used like this: @@ -290,4 +307,4 @@ interface ActiveRecordInterface * If true, the model containing the foreign key will be deleted. */ public function unlink($name, $model, $delete = false); -} \ No newline at end of file +} diff --git a/framework/yii/validators/ExistValidator.php b/framework/yii/validators/ExistValidator.php index 585b82f..04d8af8 100644 --- a/framework/yii/validators/ExistValidator.php +++ b/framework/yii/validators/ExistValidator.php @@ -61,7 +61,7 @@ class ExistValidator extends Validator return; } - /** @var \yii\db\ActiveRecord $className */ + /** @var \yii\db\ActiveRecordInterface $className */ $className = $this->className === null ? get_class($object) : $this->className; $attributeName = $this->attributeName === null ? $attribute : $this->attributeName; $query = $className::find(); @@ -85,7 +85,7 @@ class ExistValidator extends Validator if ($this->attributeName === null) { throw new InvalidConfigException('The "attributeName" property must be set.'); } - /** @var \yii\db\ActiveRecord $className */ + /** @var \yii\db\ActiveRecordInterface $className */ $className = $this->className; $query = $className::find(); $query->where([$this->attributeName => $value]); diff --git a/framework/yii/validators/UniqueValidator.php b/framework/yii/validators/UniqueValidator.php index d9cd587..b04f4a9 100644 --- a/framework/yii/validators/UniqueValidator.php +++ b/framework/yii/validators/UniqueValidator.php @@ -8,8 +8,6 @@ namespace yii\validators; use Yii; -use yii\base\InvalidConfigException; -use yii\db\ActiveRecord; use yii\db\ActiveRecordInterface; /** @@ -57,7 +55,7 @@ class UniqueValidator extends Validator return; } - /** @var \yii\db\ActiveRecord $className */ + /** @var \yii\db\ActiveRecordInterface $className */ $className = $this->className === null ? get_class($object) : $this->className; $attributeName = $this->attributeName === null ? $attribute : $this->attributeName; @@ -69,9 +67,7 @@ class UniqueValidator extends Validator $exists = $query->exists(); } else { // if current $object is in the database already we can't use exists() - $query->limit(2); - $objects = $query->all(); - + $objects = $query->limit(2)->all(); $n = count($objects); if ($n === 1) { if (in_array($attributeName, $className::primaryKey())) { From d620f3152ef0d3663c8096c25274386c2d53f9e4 Mon Sep 17 00:00:00 2001 From: Qiang Xue Date: Sun, 22 Dec 2013 10:19:49 -0500 Subject: [PATCH 10/36] refactored BaseActiveRecord::isPrimaryKey() --- framework/yii/db/BaseActiveRecord.php | 9 ++++----- framework/yii/validators/UniqueValidator.php | 5 +++-- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/framework/yii/db/BaseActiveRecord.php b/framework/yii/db/BaseActiveRecord.php index 6c947b8..e20501b 100644 --- a/framework/yii/db/BaseActiveRecord.php +++ b/framework/yii/db/BaseActiveRecord.php @@ -1234,11 +1234,10 @@ abstract class BaseActiveRecord extends Model implements ActiveRecordInterface public static function isPrimaryKey($keys) { $pks = static::primaryKey(); - foreach ($keys as $key) { - if (!in_array($key, $pks, true)) { - return false; - } + if (count($keys) === count($pks)) { + return count(array_intersect($keys, $pks)) === count($pks); + } else { + return false; } - return count($keys) === count($pks); } } diff --git a/framework/yii/validators/UniqueValidator.php b/framework/yii/validators/UniqueValidator.php index b04f4a9..53b6739 100644 --- a/framework/yii/validators/UniqueValidator.php +++ b/framework/yii/validators/UniqueValidator.php @@ -55,7 +55,7 @@ class UniqueValidator extends Validator return; } - /** @var \yii\db\ActiveRecordInterface $className */ + /** @var ActiveRecordInterface $className */ $className = $this->className === null ? get_class($object) : $this->className; $attributeName = $this->attributeName === null ? $attribute : $this->attributeName; @@ -67,6 +67,7 @@ class UniqueValidator extends Validator $exists = $query->exists(); } else { // if current $object is in the database already we can't use exists() + /** @var ActiveRecordInterface[] $objects */ $objects = $query->limit(2)->all(); $n = count($objects); if ($n === 1) { @@ -75,7 +76,7 @@ class UniqueValidator extends Validator $exists = $object->getOldPrimaryKey() != $object->getPrimaryKey(); } else { // non-primary key, need to exclude the current record based on PK - $exists = array_shift($objects)->getPrimaryKey() != $object->getOldPrimaryKey(); + $exists = $objects[0]->getPrimaryKey() != $object->getOldPrimaryKey(); } } else { $exists = $n > 1; From 2eee7b3f1bc1cbc61bac1cbae258b2f69aa5cf01 Mon Sep 17 00:00:00 2001 From: futbolim Date: Sun, 22 Dec 2013 17:36:40 +0200 Subject: [PATCH 11/36] Update ActiveField.php doc fixes --- framework/yii/widgets/ActiveField.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/framework/yii/widgets/ActiveField.php b/framework/yii/widgets/ActiveField.php index 4228ea9..bd26237 100644 --- a/framework/yii/widgets/ActiveField.php +++ b/framework/yii/widgets/ActiveField.php @@ -112,8 +112,8 @@ class ActiveField extends Component /** * @var array different parts of the field (e.g. input, label). This will be used together with * [[template]] to generate the final field HTML code. The keys are the token names in [[template]], - * while the values are the corresponding HTML code. Valid tokens include `{input}`, `{label}`, - * `{error}`, and `{error}`. Note that you normally don't need to access this property directly as + * while the values are the corresponding HTML code. Valid tokens include `{input}`, `{label}` and `{error}`. + * Note that you normally don't need to access this property directly as * it is maintained by various methods of this class. */ public $parts = []; From 252b6c9ef17d4401e09a60380ddd72c145dbbd72 Mon Sep 17 00:00:00 2001 From: Qiang Xue Date: Sun, 22 Dec 2013 11:30:59 -0500 Subject: [PATCH 12/36] Fixes #797: Added support for validating multiple columns by `UniqueValidator` and `ExistValidator` --- framework/CHANGELOG.md | 1 + framework/yii/validators/ExistValidator.php | 54 ++++++++++++++++++---- framework/yii/validators/UniqueValidator.php | 41 ++++++++++++++-- .../framework/validators/ExistValidatorTest.php | 42 +++++++++++++++++ .../framework/validators/UniqueValidatorTest.php | 47 +++++++++++++++++++ 5 files changed, 172 insertions(+), 13 deletions(-) diff --git a/framework/CHANGELOG.md b/framework/CHANGELOG.md index cf6eb5a..fb51798 100644 --- a/framework/CHANGELOG.md +++ b/framework/CHANGELOG.md @@ -16,6 +16,7 @@ Yii Framework 2 Change Log - Bug: Fixed incorrect event name for `yii\jui\Spinner` (samdark) - Bug: Json::encode() did not handle objects that implement JsonSerializable interface correctly (cebe) - Bug: Fixed issue with tabular input on ActiveField::radio() and ActiveField::checkbox() (jom) +- Enh #797: Added support for validating multiple columns by `UniqueValidator` and `ExistValidator` (qiangxue) - Enh #1293: Replaced Console::showProgress() with a better approach. See Console::startProgress() for details (cebe) - Enh #1406: DB Schema support for Oracle Database (p0larbeer, qiangxue) - Enh #1437: Added ListView::viewParams (qiangxue) diff --git a/framework/yii/validators/ExistValidator.php b/framework/yii/validators/ExistValidator.php index 04d8af8..c205655 100644 --- a/framework/yii/validators/ExistValidator.php +++ b/framework/yii/validators/ExistValidator.php @@ -30,10 +30,25 @@ class ExistValidator extends Validator */ public $className; /** - * @var string the yii\db\ActiveRecord class attribute name that should be + * @var string|array the ActiveRecord class attribute name that should be * used to look for the attribute value being validated. Defaults to null, - * meaning using the name of the attribute being validated. - * @see className + * meaning using the name of the attribute being validated. Use a string + * to specify the attribute that is different from the attribute being validated + * (often used together with [[className]]). Use an array to validate the existence about + * multiple columns. For example, + * + * ```php + * // a1 needs to exist + * array('a1', 'exist') + * // a1 needs to exist, but its value will use a2 to check for the existence + * array('a1', 'exist', 'attributeName' => 'a2') + * // a1 and a2 need to exist together, and they both will receive error message + * array('a1, a2', 'exist', 'attributeName' => array('a1', 'a2')) + * // a1 and a2 need to exist together, only a1 will receive error message + * array('a1', 'exist', 'attributeName' => array('a1', 'a2')) + * // a1 and a2 need to exist together, a2 will take value 10, only a1 will receive error message + * array('a1', 'exist', 'attributeName' => array('a1', 'a2' => 10)) + * ``` */ public $attributeName; @@ -64,9 +79,7 @@ class ExistValidator extends Validator /** @var \yii\db\ActiveRecordInterface $className */ $className = $this->className === null ? get_class($object) : $this->className; $attributeName = $this->attributeName === null ? $attribute : $this->attributeName; - $query = $className::find(); - $query->where([$attributeName => $value]); - if (!$query->exists()) { + if (!$this->exists($className, $attributeName, $object, $value)) { $this->addError($object, $attribute, $this->message); } } @@ -85,10 +98,33 @@ class ExistValidator extends Validator if ($this->attributeName === null) { throw new InvalidConfigException('The "attributeName" property must be set.'); } + return $this->exists($this->className, $this->attributeName, null, $value) ? null : [$this->message, []]; + } + + /** + * Performs existence check. + * @param string $className the AR class name to be checked against + * @param string|array $attributeName the attribute(s) to be checked + * @param \yii\db\ActiveRecordInterface $object the object whose value is being validated + * @param mixed $value the attribute value currently being validated + * @return boolean whether the data being validated exists in the database already + */ + protected function exists($className, $attributeName, $object, $value) + { /** @var \yii\db\ActiveRecordInterface $className */ - $className = $this->className; $query = $className::find(); - $query->where([$this->attributeName => $value]); - return $query->exists() ? null : [$this->message, []]; + if (is_array($attributeName)) { + $params = []; + foreach ($attributeName as $k => $v) { + if (is_integer($k)) { + $params[$v] = $this->className === null && $object !== null ? $object->$v : $value; + } else { + $params[$k] = $v; + } + } + } else { + $params = [$attributeName => $value]; + } + return $query->where($params)->exists(); } } diff --git a/framework/yii/validators/UniqueValidator.php b/framework/yii/validators/UniqueValidator.php index 53b6739..a497ead 100644 --- a/framework/yii/validators/UniqueValidator.php +++ b/framework/yii/validators/UniqueValidator.php @@ -26,9 +26,25 @@ class UniqueValidator extends Validator */ public $className; /** - * @var string the ActiveRecord class attribute name that should be + * @var string|array the ActiveRecord class attribute name that should be * used to look for the attribute value being validated. Defaults to null, - * meaning using the name of the attribute being validated. + * meaning using the name of the attribute being validated. Use a string + * to specify the attribute that is different from the attribute being validated + * (often used together with [[className]]). Use an array to validate uniqueness about + * multiple columns. For example, + * + * ```php + * // a1 needs to be unique + * array('a1', 'unique') + * // a1 needs to be unique, but its value will use a2 to check for the uniqueness + * array('a1', 'unique', 'attributeName' => 'a2') + * // a1 and a2 need to unique together, and they both will receive error message + * array('a1, a2', 'unique', 'attributeName' => array('a1', 'a2')) + * // a1 and a2 need to unique together, only a1 will receive error message + * array('a1', 'unique', 'attributeName' => array('a1', 'a2')) + * // a1 and a2 need to unique together, a2 will take value 10, only a1 will receive error message + * array('a1', 'unique', 'attributeName' => array('a1', 'a2' => 10)) + * ``` */ public $attributeName; @@ -60,7 +76,20 @@ class UniqueValidator extends Validator $attributeName = $this->attributeName === null ? $attribute : $this->attributeName; $query = $className::find(); - $query->where([$attributeName => $value]); + + if (is_array($attributeName)) { + $params = []; + foreach ($attributeName as $k => $v) { + if (is_integer($k)) { + $params[$v] = $this->className === null ? $object->$v : $value; + } else { + $params[$k] = $v; + } + } + } else { + $params = [$attributeName => $value]; + } + $query->where($params); if (!$object instanceof ActiveRecordInterface || $object->getIsNewRecord()) { // if current $object isn't in the database yet then it's OK just to call exists() @@ -71,7 +100,11 @@ class UniqueValidator extends Validator $objects = $query->limit(2)->all(); $n = count($objects); if ($n === 1) { - if (in_array($attributeName, $className::primaryKey())) { + $keys = array_keys($params); + $pks = $className::primaryKey(); + sort($keys); + sort($pks); + if ($keys === $pks) { // primary key is modified and not unique $exists = $object->getOldPrimaryKey() != $object->getPrimaryKey(); } else { diff --git a/tests/unit/framework/validators/ExistValidatorTest.php b/tests/unit/framework/validators/ExistValidatorTest.php index 45ff5d5..03332ad 100644 --- a/tests/unit/framework/validators/ExistValidatorTest.php +++ b/tests/unit/framework/validators/ExistValidatorTest.php @@ -7,6 +7,8 @@ use Yii; use yii\base\Exception; use yii\validators\ExistValidator; use yiiunit\data\ar\ActiveRecord; +use yiiunit\data\ar\Order; +use yiiunit\data\ar\OrderItem; use yiiunit\data\validators\models\ValidatorTestMainModel; use yiiunit\data\validators\models\ValidatorTestRefModel; use yiiunit\framework\db\DatabaseTestCase; @@ -92,4 +94,44 @@ class ExistValidatorTest extends DatabaseTestCase $val->validateAttribute($m, 'test_val'); $this->assertTrue($m->hasErrors('test_val')); } + + public function testValidateCompositeKeys() + { + $val = new ExistValidator([ + 'className' => OrderItem::className(), + 'attributeName' => ['order_id', 'item_id'], + ]); + // validate old record + $m = OrderItem::find(['order_id' => 1, 'item_id' => 2]); + $val->validateAttribute($m, 'order_id'); + $this->assertFalse($m->hasErrors('order_id')); + + // validate new record + $m = new OrderItem(['order_id' => 1, 'item_id' => 2]); + $val->validateAttribute($m, 'order_id'); + $this->assertFalse($m->hasErrors('order_id')); + $m = new OrderItem(['order_id' => 10, 'item_id' => 2]); + $val->validateAttribute($m, 'order_id'); + $this->assertTrue($m->hasErrors('order_id')); + + $val = new ExistValidator([ + 'className' => OrderItem::className(), + 'attributeName' => ['order_id', 'item_id' => 2], + ]); + // validate old record + $m = Order::find(1); + $val->validateAttribute($m, 'id'); + $this->assertFalse($m->hasErrors('id')); + $m = Order::find(1); + $m->id = 10; + $val->validateAttribute($m, 'id'); + $this->assertTrue($m->hasErrors('id')); + + $m = new Order(['id' => 1]); + $val->validateAttribute($m, 'id'); + $this->assertFalse($m->hasErrors('id')); + $m = new Order(['id' => 10]); + $val->validateAttribute($m, 'id'); + $this->assertTrue($m->hasErrors('id')); + } } diff --git a/tests/unit/framework/validators/UniqueValidatorTest.php b/tests/unit/framework/validators/UniqueValidatorTest.php index 707239c..1631243 100644 --- a/tests/unit/framework/validators/UniqueValidatorTest.php +++ b/tests/unit/framework/validators/UniqueValidatorTest.php @@ -6,6 +6,8 @@ namespace yiiunit\framework\validators; use yii\validators\UniqueValidator; use Yii; use yiiunit\data\ar\ActiveRecord; +use yiiunit\data\ar\Order; +use yiiunit\data\ar\OrderItem; use yiiunit\data\validators\models\FakedValidationModel; use yiiunit\data\validators\models\ValidatorTestMainModel; use yiiunit\data\validators\models\ValidatorTestRefModel; @@ -85,4 +87,49 @@ class UniqueValidatorTest extends DatabaseTestCase $m = new ValidatorTestMainModel(); $val->validateAttribute($m, 'testMainVal'); } + + public function testValidateCompositeKeys() + { + $val = new UniqueValidator([ + 'className' => OrderItem::className(), + 'attributeName' => ['order_id', 'item_id'], + ]); + // validate old record + $m = OrderItem::find(['order_id' => 1, 'item_id' => 2]); + $val->validateAttribute($m, 'order_id'); + $this->assertFalse($m->hasErrors('order_id')); + $m->item_id = 1; + $val->validateAttribute($m, 'order_id'); + $this->assertTrue($m->hasErrors('order_id')); + + // validate new record + $m = new OrderItem(['order_id' => 1, 'item_id' => 2]); + $val->validateAttribute($m, 'order_id'); + $this->assertTrue($m->hasErrors('order_id')); + $m = new OrderItem(['order_id' => 10, 'item_id' => 2]); + $val->validateAttribute($m, 'order_id'); + $this->assertFalse($m->hasErrors('order_id')); + + $val = new UniqueValidator([ + 'className' => OrderItem::className(), + 'attributeName' => ['order_id', 'item_id' => 2], + ]); + // validate old record + $m = Order::find(1); + $val->validateAttribute($m, 'id'); + $this->assertFalse($m->hasErrors('id')); + $m->id = 2; + $val->validateAttribute($m, 'id'); + $this->assertFalse($m->hasErrors('id')); + $m->id = 3; + $val->validateAttribute($m, 'id'); + $this->assertTrue($m->hasErrors('id')); + + $m = new Order(['id' => 1]); + $val->validateAttribute($m, 'id'); + $this->assertTrue($m->hasErrors('id')); + $m = new Order(['id' => 10]); + $val->validateAttribute($m, 'id'); + $this->assertFalse($m->hasErrors('id')); + } } From a7cf6a984c609117b2ba2090ce9c62feccdb1326 Mon Sep 17 00:00:00 2001 From: Alexander Makarov Date: Sun, 22 Dec 2013 20:15:57 +0100 Subject: [PATCH 13/36] Fixes #1597: Added `enableAutoLogin` to basic and advanced application templates so "remember me" now works properly --- apps/advanced/backend/config/main.php | 1 + apps/advanced/frontend/config/main.php | 1 + apps/basic/config/web.php | 1 + framework/CHANGELOG.md | 1 + 4 files changed, 4 insertions(+) diff --git a/apps/advanced/backend/config/main.php b/apps/advanced/backend/config/main.php index c745a1f..d1a45a7 100644 --- a/apps/advanced/backend/config/main.php +++ b/apps/advanced/backend/config/main.php @@ -22,6 +22,7 @@ return [ 'mail' => $params['components.mail'], 'user' => [ 'identityClass' => 'common\models\User', + 'enableAutoLogin' => true, ], 'log' => [ 'traceLevel' => YII_DEBUG ? 3 : 0, diff --git a/apps/advanced/frontend/config/main.php b/apps/advanced/frontend/config/main.php index 6ee8ae5..2a0f330 100644 --- a/apps/advanced/frontend/config/main.php +++ b/apps/advanced/frontend/config/main.php @@ -23,6 +23,7 @@ return [ 'mail' => $params['components.mail'], 'user' => [ 'identityClass' => 'common\models\User', + 'enableAutoLogin' => true, ], 'log' => [ 'traceLevel' => YII_DEBUG ? 3 : 0, diff --git a/apps/basic/config/web.php b/apps/basic/config/web.php index 472f842..e142855 100644 --- a/apps/basic/config/web.php +++ b/apps/basic/config/web.php @@ -12,6 +12,7 @@ $config = [ ], 'user' => [ 'identityClass' => 'app\models\User', + 'enableAutoLogin' => true, ], 'errorHandler' => [ 'errorAction' => 'site/error', diff --git a/framework/CHANGELOG.md b/framework/CHANGELOG.md index fb51798..7ef506d 100644 --- a/framework/CHANGELOG.md +++ b/framework/CHANGELOG.md @@ -12,6 +12,7 @@ Yii Framework 2 Change Log - Bug #1550: fixed the issue that JUI input widgets did not property input IDs. - Bug #1582: Error messages shown via client-side validation should not be double encoded (qiangxue) - Bug #1591: StringValidator is accessing undefined property (qiangxue) +- Bug #1597: Added `enableAutoLogin` to basic and advanced application templates so "remember me" now works properly (samdark) - Bug: Fixed `Call to a member function registerAssetFiles() on a non-object` in case of wrong `sourcePath` for an asset bundle (samdark) - Bug: Fixed incorrect event name for `yii\jui\Spinner` (samdark) - Bug: Json::encode() did not handle objects that implement JsonSerializable interface correctly (cebe) From be5afe7da886785eeda4d0417c5324a6635bc6d8 Mon Sep 17 00:00:00 2001 From: Alexander Makarov Date: Sun, 22 Dec 2013 22:06:11 +0100 Subject: [PATCH 14/36] Fixes #1572: Added `yii\web\Controller::createAbsoluteUrl()` --- framework/CHANGELOG.md | 1 + framework/yii/web/Controller.php | 59 +++++++++++++++++++++++++++++++++++----- 2 files changed, 53 insertions(+), 7 deletions(-) diff --git a/framework/CHANGELOG.md b/framework/CHANGELOG.md index 7ef506d..6c81dd9 100644 --- a/framework/CHANGELOG.md +++ b/framework/CHANGELOG.md @@ -24,6 +24,7 @@ Yii Framework 2 Change Log - Enh #1469: ActiveRecord::find() now works with default conditions (default scope) applied by createQuery (cebe) - Enh #1523: Query conditions now allow to use the NOT operator (cebe) - Enh #1552: It is now possible to use multiple bootstrap NavBar in a single page (Alex-Code) +- Enh #1572: Added `yii\web\Controller::createAbsoluteUrl()` (samdark) - Enh #1579: throw exception when the given AR relation name does not match in a case sensitive manner (qiangxue) - Enh: Added `favicon.ico` and `robots.txt` to defauly application templates (samdark) - Enh: Added `Widget::autoIdPrefix` to support prefixing automatically generated widget IDs (qiangxue) diff --git a/framework/yii/web/Controller.php b/framework/yii/web/Controller.php index 0df48bd..540140f 100644 --- a/framework/yii/web/Controller.php +++ b/framework/yii/web/Controller.php @@ -101,9 +101,9 @@ class Controller extends \yii\base\Controller } /** - * Creates a URL using the given route and parameters. + * Normalizes route making it suitable for UrlManager. Absolute routes are staying as is + * while relative routes are converted to absolute routes. * - * This method enhances [[UrlManager::createUrl()]] by supporting relative routes. * A relative route is a route without a leading slash, such as "view", "post/view". * * - If the route is an empty string, the current [[route]] will be used; @@ -112,13 +112,10 @@ class Controller extends \yii\base\Controller * - If the route has no leading slash, it is considered to be a route relative * to the current module and will be prepended with the module's uniqueId. * - * After this route conversion, the method calls [[UrlManager::createUrl()]] to create a URL. - * * @param string $route the route. This can be either an absolute route or a relative route. - * @param array $params the parameters (name-value pairs) to be included in the generated URL - * @return string the created URL + * @return string normalized route suitable for UrlManager */ - public function createUrl($route, $params = []) + protected function getNormalizedRoute($route) { if (strpos($route, '/') === false) { // empty or an action ID @@ -127,10 +124,58 @@ class Controller extends \yii\base\Controller // relative to module $route = ltrim($this->module->getUniqueId() . '/' . $route, '/'); } + return $route; + } + + /** + * Creates a relative URL using the given route and parameters. + * + * This method enhances [[UrlManager::createUrl()]] by supporting relative routes. + * A relative route is a route without a leading slash, such as "view", "post/view". + * + * - If the route is an empty string, the current [[route]] will be used; + * - If the route contains no slashes at all, it is considered to be an action ID + * of the current controller and will be prepended with [[uniqueId]]; + * - If the route has no leading slash, it is considered to be a route relative + * to the current module and will be prepended with the module's uniqueId. + * + * After this route conversion, the method calls [[UrlManager::createUrl()]] to create a URL. + * + * @param string $route the route. This can be either an absolute route or a relative route. + * @param array $params the parameters (name-value pairs) to be included in the generated URL + * @return string the created relative URL + */ + public function createUrl($route, $params = []) + { + $route = $this->getNormalizedRoute($route); return Yii::$app->getUrlManager()->createUrl($route, $params); } /** + * Creates an absolute URL using the given route and parameters. + * + * This method enhances [[UrlManager::createAbsoluteUrl()]] by supporting relative routes. + * A relative route is a route without a leading slash, such as "view", "post/view". + * + * - If the route is an empty string, the current [[route]] will be used; + * - If the route contains no slashes at all, it is considered to be an action ID + * of the current controller and will be prepended with [[uniqueId]]; + * - If the route has no leading slash, it is considered to be a route relative + * to the current module and will be prepended with the module's uniqueId. + * + * After this route conversion, the method calls [[UrlManager::createUrl()]] to create a URL. + * + * @param string $route the route. This can be either an absolute route or a relative route. + * @param array $params the parameters (name-value pairs) to be included in the generated URL + * @return string the created absolute URL + */ + public function createAbsoluteUrl($route, $params = []) + { + $route = $this->getNormalizedRoute($route); + return Yii::$app->getUrlManager()->createAbsoluteUrl($route, $params); + } + + /** * Returns the canonical URL of the currently requested page. * The canonical URL is constructed using [[route]] and [[actionParams]]. You may use the following code * in the layout view to add a link tag about canonical URL: From 9649a6727ade3f065f3fa0b5f1fbd65e269b51c1 Mon Sep 17 00:00:00 2001 From: Qiang Xue Date: Sun, 22 Dec 2013 16:40:51 -0500 Subject: [PATCH 15/36] Renamed `attributeName` and `className` to `targetAttribute` and `targetClass` for `UniqueValidator` and `ExistValidator`. Refactored UniqueValidator and ExistValidator. --- docs/guide/validation.md | 12 ++- framework/CHANGELOG.md | 1 + framework/yii/db/ActiveQuery.php | 5 + framework/yii/validators/ExistValidator.php | 118 ++++++++++----------- framework/yii/validators/UniqueValidator.php | 94 ++++++++-------- .../framework/validators/ExistValidatorTest.php | 24 ++--- .../framework/validators/UniqueValidatorTest.php | 22 ++-- 7 files changed, 139 insertions(+), 137 deletions(-) diff --git a/docs/guide/validation.md b/docs/guide/validation.md index 1b1e92e..5067cb6 100644 --- a/docs/guide/validation.md +++ b/docs/guide/validation.md @@ -67,9 +67,9 @@ Validates that the attribute value is a valid email address. Validates that the attribute value exists in a table. -- `className` the ActiveRecord class name or alias of the class that should be used to look for the attribute value being +- `targetClass` the ActiveRecord class name or alias of the class that should be used to look for the attribute value being validated. _(ActiveRecord class of the attribute being validated)_ -- `attributeName` the ActiveRecord attribute name that should be used to look for the attribute value being validated. +- `targetAttribute` the ActiveRecord attribute name that should be used to look for the attribute value being validated. _(name of the attribute being validated)_ ### `file`: [[FileValidator]] @@ -112,7 +112,9 @@ Validates that the attribute value is among a list of values. ### `inline`: [[InlineValidator]] -Uses a custom function to validate the attribute. You need to define a public method in your model class which will evaluate the validity of the attribute. For example, if an attribute needs to be divisible by 10. In the rules you would define: `['attributeName', 'myValidationMethod'],`. +Uses a custom function to validate the attribute. You need to define a public method in your +model class which will evaluate the validity of the attribute. For example, if an attribute +needs to be divisible by 10. In the rules you would define: `['attributeName', 'myValidationMethod'],`. Then, your own method could look like this: ```php @@ -161,9 +163,9 @@ Validates that the attribute value is of certain length. Validates that the attribute value is unique in the corresponding database table. -- `className` the ActiveRecord class name or alias of the class that should be used to look for the attribute value being +- `targetClass` the ActiveRecord class name or alias of the class that should be used to look for the attribute value being validated. _(ActiveRecord class of the attribute being validated)_ -- `attributeName` the ActiveRecord attribute name that should be used to look for the attribute value being validated. +- `targetAttribute` the ActiveRecord attribute name that should be used to look for the attribute value being validated. _(name of the attribute being validated)_ ### `url`: [[UrlValidator]] diff --git a/framework/CHANGELOG.md b/framework/CHANGELOG.md index 6c81dd9..41d8f75 100644 --- a/framework/CHANGELOG.md +++ b/framework/CHANGELOG.md @@ -32,6 +32,7 @@ Yii Framework 2 Change Log - Enh: Sort and Paginiation can now create absolute URLs (cebe) - Chg: Renamed `yii\jui\Widget::clientEventsMap` to `clientEventMap` (qiangxue) - Chg: Renamed `ActiveRecord::getPopulatedRelations()` to `getRelatedRecords()` (qiangxue) +- Chg: Renamed `attributeName` and `className` to `targetAttribute` and `targetClass` for `UniqueValidator` and `ExistValidator` (qiangxue) - Chg: Added `yii\widgets\InputWidget::options` (qiangxue) - New #1438: [MongoDB integration](https://github.com/yiisoft/yii2-mongodb) ActiveRecord and Query (klimov-paul) - New #1393: [Codeception testing framework integration](https://github.com/yiisoft/yii2-codeception) (Ragazzo) diff --git a/framework/yii/db/ActiveQuery.php b/framework/yii/db/ActiveQuery.php index e93e9be..e0e14cf 100644 --- a/framework/yii/db/ActiveQuery.php +++ b/framework/yii/db/ActiveQuery.php @@ -143,4 +143,9 @@ class ActiveQuery extends Query implements ActiveQueryInterface } return $db->createCommand($sql, $params); } + + public function joinWith($name) + { + + } } diff --git a/framework/yii/validators/ExistValidator.php b/framework/yii/validators/ExistValidator.php index c205655..323172a 100644 --- a/framework/yii/validators/ExistValidator.php +++ b/framework/yii/validators/ExistValidator.php @@ -13,44 +13,47 @@ use yii\base\InvalidConfigException; /** * ExistValidator validates that the attribute value exists in a table. * + * ExistValidator checks if the value being validated can be found in the table column specified by + * the ActiveRecord class [[targetClass]] and the attribute [[targetAttribute]]. + * * This validator is often used to verify that a foreign key contains a value * that can be found in the foreign table. * + * The followings are examples of validation rules using this validator: + * + * ```php + * // a1 needs to exist + * ['a1', 'exist'] + * // a1 needs to exist, but its value will use a2 to check for the existence + * ['a1', 'exist', 'targetAttribute' => 'a2'] + * // a1 and a2 need to exist together, and they both will receive error message + * ['a1, a2', 'exist', 'targetAttribute' => ['a1', 'a2']] + * // a1 and a2 need to exist together, only a1 will receive error message + * ['a1', 'exist', 'targetAttribute' => ['a1', 'a2']] + * // a1 needs to be unique by checking the existence of both a2 and a3 (using a1 value) + * ['a1', 'unique', 'targetAttribute' => ['a2', 'a1' => 'a3']] + * ``` + * * @author Qiang Xue * @since 2.0 */ class ExistValidator extends Validator { /** - * @var string the ActiveRecord class name or alias of the class - * that should be used to look for the attribute value being validated. - * Defaults to null, meaning using the ActiveRecord class of - * the attribute being validated. - * @see attributeName + * @var string the name of the ActiveRecord class that should be used to validate the existence + * of the current attribute value. It not set, it will use the ActiveRecord class of the attribute being validated. + * @see targetAttribute */ - public $className; + public $targetClass; /** - * @var string|array the ActiveRecord class attribute name that should be - * used to look for the attribute value being validated. Defaults to null, - * meaning using the name of the attribute being validated. Use a string - * to specify the attribute that is different from the attribute being validated - * (often used together with [[className]]). Use an array to validate the existence about - * multiple columns. For example, - * - * ```php - * // a1 needs to exist - * array('a1', 'exist') - * // a1 needs to exist, but its value will use a2 to check for the existence - * array('a1', 'exist', 'attributeName' => 'a2') - * // a1 and a2 need to exist together, and they both will receive error message - * array('a1, a2', 'exist', 'attributeName' => array('a1', 'a2')) - * // a1 and a2 need to exist together, only a1 will receive error message - * array('a1', 'exist', 'attributeName' => array('a1', 'a2')) - * // a1 and a2 need to exist together, a2 will take value 10, only a1 will receive error message - * array('a1', 'exist', 'attributeName' => array('a1', 'a2' => 10)) - * ``` + * @var string|array the name of the ActiveRecord attribute that should be used to + * validate the existence of the current attribute value. If not set, it will use the name + * of the attribute currently being validated. You may use an array to validate the existence + * of multiple columns at the same time. The array values are the attributes that will be + * used to validate the existence, while the array keys are the attributes whose values are to be validated. + * If the key and the value are the same, you can just specify the value. */ - public $attributeName; + public $targetAttribute; /** @@ -69,17 +72,28 @@ class ExistValidator extends Validator */ public function validateAttribute($object, $attribute) { - $value = $object->$attribute; + /** @var \yii\db\ActiveRecordInterface $targetClass */ + $targetClass = $this->targetClass === null ? get_class($object) : $this->targetClass; + $targetAttribute = $this->targetAttribute === null ? $attribute : $this->targetAttribute; - if (is_array($value)) { - $this->addError($object, $attribute, $this->message); - return; + if (is_array($targetAttribute)) { + $params = []; + foreach ($targetAttribute as $k => $v) { + $params[$v] = is_integer($k) ? $object->$v : $object->$k; + } + } else { + $params = [$targetAttribute => $object->$attribute]; + } + + foreach ($params as $value) { + if (is_array($value)) { + $this->addError($object, $attribute, Yii::t('yii', '{attribute} is invalid.')); + return; + } } /** @var \yii\db\ActiveRecordInterface $className */ - $className = $this->className === null ? get_class($object) : $this->className; - $attributeName = $this->attributeName === null ? $attribute : $this->attributeName; - if (!$this->exists($className, $attributeName, $object, $value)) { + if (!$targetClass::find()->where($params)->exists()) { $this->addError($object, $attribute, $this->message); } } @@ -92,39 +106,17 @@ class ExistValidator extends Validator if (is_array($value)) { return [$this->message, []]; } - if ($this->className === null) { + if ($this->targetClass === null) { throw new InvalidConfigException('The "className" property must be set.'); } - if ($this->attributeName === null) { - throw new InvalidConfigException('The "attributeName" property must be set.'); + if (!is_string($this->targetAttribute)) { + throw new InvalidConfigException('The "attributeName" property must be configured as a string.'); } - return $this->exists($this->className, $this->attributeName, null, $value) ? null : [$this->message, []]; - } - /** - * Performs existence check. - * @param string $className the AR class name to be checked against - * @param string|array $attributeName the attribute(s) to be checked - * @param \yii\db\ActiveRecordInterface $object the object whose value is being validated - * @param mixed $value the attribute value currently being validated - * @return boolean whether the data being validated exists in the database already - */ - protected function exists($className, $attributeName, $object, $value) - { - /** @var \yii\db\ActiveRecordInterface $className */ - $query = $className::find(); - if (is_array($attributeName)) { - $params = []; - foreach ($attributeName as $k => $v) { - if (is_integer($k)) { - $params[$v] = $this->className === null && $object !== null ? $object->$v : $value; - } else { - $params[$k] = $v; - } - } - } else { - $params = [$attributeName => $value]; - } - return $query->where($params)->exists(); + /** @var \yii\db\ActiveRecordInterface $targetClass */ + $targetClass = $this->targetClass; + $query = $targetClass::find(); + $query->where([$this->targetAttribute => $value]); + return $query->exists() ? null : [$this->message, []]; } } diff --git a/framework/yii/validators/UniqueValidator.php b/framework/yii/validators/UniqueValidator.php index a497ead..1136f02 100644 --- a/framework/yii/validators/UniqueValidator.php +++ b/framework/yii/validators/UniqueValidator.php @@ -11,7 +11,25 @@ use Yii; use yii\db\ActiveRecordInterface; /** - * UniqueValidator validates that the attribute value is unique in the corresponding database table. + * UniqueValidator validates that the attribute value is unique in the specified database table. + * + * UniqueValidator checks if the value being validated is unique in the table column specified by + * the ActiveRecord class [[targetClass]] and the attribute [[targetAttribute]]. + * + * The followings are examples of validation rules using this validator: + * + * ```php + * // a1 needs to be unique + * ['a1', 'unique'] + * // a1 needs to be unique, but column a2 will be used to check the uniqueness of the a1 value + * ['a1', 'unique', 'targetAttribute' => 'a2'] + * // a1 and a2 need to unique together, and they both will receive error message + * ['a1, a2', 'unique', 'targetAttribute' => ['a1', 'a2']] + * // a1 and a2 need to unique together, only a1 will receive error message + * ['a1', 'unique', 'targetAttribute' => ['a1', 'a2']] + * // a1 needs to be unique by checking the uniqueness of both a2 and a3 (using a1 value) + * ['a1', 'unique', 'targetAttribute' => ['a2', 'a1' => 'a3']] + * ``` * * @author Qiang Xue * @since 2.0 @@ -19,34 +37,20 @@ use yii\db\ActiveRecordInterface; class UniqueValidator extends Validator { /** - * @var string the ActiveRecord class name or alias of the class - * that should be used to look for the attribute value being validated. - * Defaults to null, meaning using the ActiveRecord class of the attribute being validated. - * @see attributeName + * @var string the name of the ActiveRecord class that should be used to validate the uniqueness + * of the current attribute value. It not set, it will use the ActiveRecord class of the attribute being validated. + * @see targetAttribute */ - public $className; + public $targetClass; /** - * @var string|array the ActiveRecord class attribute name that should be - * used to look for the attribute value being validated. Defaults to null, - * meaning using the name of the attribute being validated. Use a string - * to specify the attribute that is different from the attribute being validated - * (often used together with [[className]]). Use an array to validate uniqueness about - * multiple columns. For example, - * - * ```php - * // a1 needs to be unique - * array('a1', 'unique') - * // a1 needs to be unique, but its value will use a2 to check for the uniqueness - * array('a1', 'unique', 'attributeName' => 'a2') - * // a1 and a2 need to unique together, and they both will receive error message - * array('a1, a2', 'unique', 'attributeName' => array('a1', 'a2')) - * // a1 and a2 need to unique together, only a1 will receive error message - * array('a1', 'unique', 'attributeName' => array('a1', 'a2')) - * // a1 and a2 need to unique together, a2 will take value 10, only a1 will receive error message - * array('a1', 'unique', 'attributeName' => array('a1', 'a2' => 10)) - * ``` + * @var string|array the name of the ActiveRecord attribute that should be used to + * validate the uniqueness of the current attribute value. If not set, it will use the name + * of the attribute currently being validated. You may use an array to validate the uniqueness + * of multiple columns at the same time. The array values are the attributes that will be + * used to validate the uniqueness, while the array keys are the attributes whose values are to be validated. + * If the key and the value are the same, you can just specify the value. */ - public $attributeName; + public $targetAttribute; /** * @inheritdoc @@ -64,31 +68,27 @@ class UniqueValidator extends Validator */ public function validateAttribute($object, $attribute) { - $value = $object->$attribute; - - if (is_array($value)) { - $this->addError($object, $attribute, Yii::t('yii', '{attribute} is invalid.')); - return; - } - - /** @var ActiveRecordInterface $className */ - $className = $this->className === null ? get_class($object) : $this->className; - $attributeName = $this->attributeName === null ? $attribute : $this->attributeName; - - $query = $className::find(); + /** @var ActiveRecordInterface $targetClass */ + $targetClass = $this->targetClass === null ? get_class($object) : $this->targetClass; + $targetAttribute = $this->targetAttribute === null ? $attribute : $this->targetAttribute; - if (is_array($attributeName)) { + if (is_array($targetAttribute)) { $params = []; - foreach ($attributeName as $k => $v) { - if (is_integer($k)) { - $params[$v] = $this->className === null ? $object->$v : $value; - } else { - $params[$k] = $v; - } + foreach ($targetAttribute as $k => $v) { + $params[$v] = is_integer($k) ? $object->$v : $object->$k; } } else { - $params = [$attributeName => $value]; + $params = [$targetAttribute => $object->$attribute]; + } + + foreach ($params as $value) { + if (is_array($value)) { + $this->addError($object, $attribute, Yii::t('yii', '{attribute} is invalid.')); + return; + } } + + $query = $targetClass::find(); $query->where($params); if (!$object instanceof ActiveRecordInterface || $object->getIsNewRecord()) { @@ -101,7 +101,7 @@ class UniqueValidator extends Validator $n = count($objects); if ($n === 1) { $keys = array_keys($params); - $pks = $className::primaryKey(); + $pks = $targetClass::primaryKey(); sort($keys); sort($pks); if ($keys === $pks) { diff --git a/tests/unit/framework/validators/ExistValidatorTest.php b/tests/unit/framework/validators/ExistValidatorTest.php index 03332ad..8f1a054 100644 --- a/tests/unit/framework/validators/ExistValidatorTest.php +++ b/tests/unit/framework/validators/ExistValidatorTest.php @@ -36,18 +36,18 @@ class ExistValidatorTest extends DatabaseTestCase } // combine to save the time creating a new db-fixture set (likely ~5 sec) try { - $val = new ExistValidator(['className' => ValidatorTestMainModel::className()]); + $val = new ExistValidator(['targetClass' => ValidatorTestMainModel::className()]); $val->validate('ref'); $this->fail('Exception should have been thrown at this time'); } catch (Exception $e) { $this->assertInstanceOf('yii\base\InvalidConfigException', $e); - $this->assertEquals('The "attributeName" property must be set.', $e->getMessage()); + $this->assertEquals('The "attributeName" property must be configured as a string.', $e->getMessage()); } } public function testValidateValue() { - $val = new ExistValidator(['className' => ValidatorTestRefModel::className(), 'attributeName' => 'id']); + $val = new ExistValidator(['targetClass' => ValidatorTestRefModel::className(), 'targetAttribute' => 'id']); $this->assertTrue($val->validate(2)); $this->assertTrue($val->validate(5)); $this->assertFalse($val->validate(99)); @@ -57,22 +57,22 @@ class ExistValidatorTest extends DatabaseTestCase public function testValidateAttribute() { // existing value on different table - $val = new ExistValidator(['className' => ValidatorTestMainModel::className(), 'attributeName' => 'id']); + $val = new ExistValidator(['targetClass' => ValidatorTestMainModel::className(), 'targetAttribute' => 'id']); $m = ValidatorTestRefModel::find(['id' => 1]); $val->validateAttribute($m, 'ref'); $this->assertFalse($m->hasErrors()); // non-existing value on different table - $val = new ExistValidator(['className' => ValidatorTestMainModel::className(), 'attributeName' => 'id']); + $val = new ExistValidator(['targetClass' => ValidatorTestMainModel::className(), 'targetAttribute' => 'id']); $m = ValidatorTestRefModel::find(['id' => 6]); $val->validateAttribute($m, 'ref'); $this->assertTrue($m->hasErrors('ref')); // existing value on same table - $val = new ExistValidator(['attributeName' => 'ref']); + $val = new ExistValidator(['targetAttribute' => 'ref']); $m = ValidatorTestRefModel::find(['id' => 2]); $val->validateAttribute($m, 'test_val'); $this->assertFalse($m->hasErrors()); // non-existing value on same table - $val = new ExistValidator(['attributeName' => 'ref']); + $val = new ExistValidator(['targetAttribute' => 'ref']); $m = ValidatorTestRefModel::find(['id' => 5]); $val->validateAttribute($m, 'test_val_fail'); $this->assertTrue($m->hasErrors('test_val_fail')); @@ -88,7 +88,7 @@ class ExistValidatorTest extends DatabaseTestCase $val->validateAttribute($m, 'a_field'); $this->assertTrue($m->hasErrors('a_field')); // check array - $val = new ExistValidator(['attributeName' => 'ref']); + $val = new ExistValidator(['targetAttribute' => 'ref']); $m = ValidatorTestRefModel::find(['id' => 2]); $m->test_val = [1,2,3]; $val->validateAttribute($m, 'test_val'); @@ -98,8 +98,8 @@ class ExistValidatorTest extends DatabaseTestCase public function testValidateCompositeKeys() { $val = new ExistValidator([ - 'className' => OrderItem::className(), - 'attributeName' => ['order_id', 'item_id'], + 'targetClass' => OrderItem::className(), + 'targetAttribute' => ['order_id', 'item_id'], ]); // validate old record $m = OrderItem::find(['order_id' => 1, 'item_id' => 2]); @@ -115,8 +115,8 @@ class ExistValidatorTest extends DatabaseTestCase $this->assertTrue($m->hasErrors('order_id')); $val = new ExistValidator([ - 'className' => OrderItem::className(), - 'attributeName' => ['order_id', 'item_id' => 2], + 'targetClass' => OrderItem::className(), + 'targetAttribute' => ['id' => 'order_id'], ]); // validate old record $m = Order::find(1); diff --git a/tests/unit/framework/validators/UniqueValidatorTest.php b/tests/unit/framework/validators/UniqueValidatorTest.php index 1631243..4af3d29 100644 --- a/tests/unit/framework/validators/UniqueValidatorTest.php +++ b/tests/unit/framework/validators/UniqueValidatorTest.php @@ -60,7 +60,7 @@ class UniqueValidatorTest extends DatabaseTestCase public function testValidateAttributeOfNonARModel() { - $val = new UniqueValidator(['className' => ValidatorTestRefModel::className(), 'attributeName' => 'ref']); + $val = new UniqueValidator(['targetClass' => ValidatorTestRefModel::className(), 'targetAttribute' => 'ref']); $m = FakedValidationModel::createWithAttributes(['attr_1' => 5, 'attr_2' => 1313]); $val->validateAttribute($m, 'attr_1'); $this->assertTrue($m->hasErrors('attr_1')); @@ -70,7 +70,7 @@ class UniqueValidatorTest extends DatabaseTestCase public function testValidateNonDatabaseAttribute() { - $val = new UniqueValidator(['className' => ValidatorTestRefModel::className(), 'attributeName' => 'ref']); + $val = new UniqueValidator(['targetClass' => ValidatorTestRefModel::className(), 'targetAttribute' => 'ref']); $m = ValidatorTestMainModel::find(1); $val->validateAttribute($m, 'testMainVal'); $this->assertFalse($m->hasErrors('testMainVal')); @@ -91,8 +91,8 @@ class UniqueValidatorTest extends DatabaseTestCase public function testValidateCompositeKeys() { $val = new UniqueValidator([ - 'className' => OrderItem::className(), - 'attributeName' => ['order_id', 'item_id'], + 'targetClass' => OrderItem::className(), + 'targetAttribute' => ['order_id', 'item_id'], ]); // validate old record $m = OrderItem::find(['order_id' => 1, 'item_id' => 2]); @@ -111,19 +111,21 @@ class UniqueValidatorTest extends DatabaseTestCase $this->assertFalse($m->hasErrors('order_id')); $val = new UniqueValidator([ - 'className' => OrderItem::className(), - 'attributeName' => ['order_id', 'item_id' => 2], + 'targetClass' => OrderItem::className(), + 'targetAttribute' => ['id' => 'order_id'], ]); // validate old record $m = Order::find(1); $val->validateAttribute($m, 'id'); - $this->assertFalse($m->hasErrors('id')); + $this->assertTrue($m->hasErrors('id')); + $m = Order::find(1); $m->id = 2; $val->validateAttribute($m, 'id'); - $this->assertFalse($m->hasErrors('id')); - $m->id = 3; - $val->validateAttribute($m, 'id'); $this->assertTrue($m->hasErrors('id')); + $m = Order::find(1); + $m->id = 10; + $val->validateAttribute($m, 'id'); + $this->assertFalse($m->hasErrors('id')); $m = new Order(['id' => 1]); $val->validateAttribute($m, 'id'); From ed337347e008c332272cd863e481fba6114d7e30 Mon Sep 17 00:00:00 2001 From: Alexander Makarov Date: Sun, 22 Dec 2013 23:32:34 +0100 Subject: [PATCH 16/36] Updated doc on version numbering to match current tag --- docs/internals/versions.md | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/docs/internals/versions.md b/docs/internals/versions.md index ba349f6..fe21fd7 100644 --- a/docs/internals/versions.md +++ b/docs/internals/versions.md @@ -1,12 +1,35 @@ Yii version numbering ===================== +Releases +-------- + A.B.C A = For Yii2 it's always 2. B = Major version. Non-BC changes with upgrade instructions. C = BC changes and additions. -A.B.CrcD +Release candidates +------------------ + +A.B.C-rc +A.B.C-rc2 + +This is when we want to do a release candidate. RC number increments till we're getting a stable release with no +critical bugs and backwards incompatibility reports. + +Alphas and betas +---------------- + +A.B.C-alpha +A.B.C-alpha2 + +Alphas are unstable versions where significant bugs may and probably do exist. API isn't fixed yet and may be changed +significantly. `alpha2` etc. may or may not be released based on overall stability of code and API. + +A.B.C-beta +A.B.C-beta2 -This is when we want to release release candidate. D is the RC number. Starts with 1 and increments till we're getting a stable release with no critical bugs and BC incompatibility reports. \ No newline at end of file +Beta is more or less stable with less bugs and API instability than alphas. There still could be changes in API but +there should be a significant reason for it. From 1f2972aa1e203ae70e9c7313e84e13ba0b6b8dcd Mon Sep 17 00:00:00 2001 From: Alexander Makarov Date: Sun, 22 Dec 2013 23:36:01 +0100 Subject: [PATCH 17/36] Fixed mistyped TDB -> TBD --- docs/guide/apps-own.md | 2 +- docs/guide/controller.md | 2 +- docs/guide/testing.md | 2 +- docs/guide/theming.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/guide/apps-own.md b/docs/guide/apps-own.md index ebf7597..3ebf83f 100644 --- a/docs/guide/apps-own.md +++ b/docs/guide/apps-own.md @@ -1,4 +1,4 @@ Creating your own Application structure ======================================= -TDB \ No newline at end of file +TBD \ No newline at end of file diff --git a/docs/guide/controller.md b/docs/guide/controller.md index c07968b..801df69 100644 --- a/docs/guide/controller.md +++ b/docs/guide/controller.md @@ -206,7 +206,7 @@ Two other filters, [[PageCache]] and [[HttpCache]] are described in [caching](ca Catching all incoming requests ------------------------------ -TDB +TBD See also -------- diff --git a/docs/guide/testing.md b/docs/guide/testing.md index 4b88a9a..1395d17 100644 --- a/docs/guide/testing.md +++ b/docs/guide/testing.md @@ -1,4 +1,4 @@ Testing ======= -TDB \ No newline at end of file +TBD \ No newline at end of file diff --git a/docs/guide/theming.md b/docs/guide/theming.md index 308316a..7be1292 100644 --- a/docs/guide/theming.md +++ b/docs/guide/theming.md @@ -1,4 +1,4 @@ Theming ======= -TDB \ No newline at end of file +TBD \ No newline at end of file From bbf4eb325e259aee02a3fe90e6decd6dad1530eb Mon Sep 17 00:00:00 2001 From: Alexander Makarov Date: Sun, 22 Dec 2013 23:49:02 +0100 Subject: [PATCH 18/36] Added cache dependency docs to the guide --- docs/guide/caching.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/docs/guide/caching.md b/docs/guide/caching.md index e36ae00..23bb872 100644 --- a/docs/guide/caching.md +++ b/docs/guide/caching.md @@ -152,7 +152,33 @@ $value2 = $cache['var2']; // equivalent to: $value2 = $cache->get('var2'); ### Cache Dependency -TBD: http://www.yiiframework.com/doc/guide/1.1/en/caching.data#cache-dependency +Besides expiration setting, cached data may also be invalidated according to some dependency changes. For example, if we +are caching the content of some file and the file is changed, we should invalidate the cached copy and read the latest +content from the file instead of the cache. + +We represent a dependency as an instance of [[\yii\caching\Dependency]] or its child class. We pass the dependency +instance along with the data to be cached when calling `set()`. + +```php +use yii\cache\FileDependency; + +// the value will expire in 30 seconds +// it may also be invalidated earlier if the dependent file is changed +Yii::$app->cache->set($id, $value, 30, new FileDependency(['fileName' => 'example.txt'])); +``` + +Now if we retrieve $value from cache by calling `get()`, the dependency will be evaluated and if it is changed, we will +get a false value, indicating the data needs to be regenerated. + +Below is a summary of the available cache dependencies: + +- [[\yii\cache\FileDependency]]: the dependency is changed if the file's last modification time is changed. +- [[\yii\cache\GroupDependency]]: marks a cached data item with a group name. You may invalidate the cached data items + with the same group name all at once by calling [[\yii\cache\GroupDependency::invalidate()]]. +- [[\yii\cache\DbDependency]]: the dependency is changed if the query result of the specified SQL statement is changed. +- [[\yii\cache\ChainedDependency]]: the dependency is changed if any of the dependencies on the chain is changed. +- [[\yii\cache\ExpressionDependency]]: the dependency is changed if the result of the specified PHP expression is + changed. ### Query Caching From 69cb09dbf34642e4069f8e69054d3667f84586ee Mon Sep 17 00:00:00 2001 From: Qiang Xue Date: Sun, 22 Dec 2013 22:49:44 -0500 Subject: [PATCH 19/36] doc fix. --- framework/yii/validators/ExistValidator.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/framework/yii/validators/ExistValidator.php b/framework/yii/validators/ExistValidator.php index 323172a..7e783a8 100644 --- a/framework/yii/validators/ExistValidator.php +++ b/framework/yii/validators/ExistValidator.php @@ -30,8 +30,8 @@ use yii\base\InvalidConfigException; * ['a1, a2', 'exist', 'targetAttribute' => ['a1', 'a2']] * // a1 and a2 need to exist together, only a1 will receive error message * ['a1', 'exist', 'targetAttribute' => ['a1', 'a2']] - * // a1 needs to be unique by checking the existence of both a2 and a3 (using a1 value) - * ['a1', 'unique', 'targetAttribute' => ['a2', 'a1' => 'a3']] + * // a1 needs to exist by checking the existence of both a2 and a3 (using a1 value) + * ['a1', 'exist', 'targetAttribute' => ['a2', 'a1' => 'a3']] * ``` * * @author Qiang Xue From 488918d03c1e584be6003969700263358a790499 Mon Sep 17 00:00:00 2001 From: Vincent Date: Mon, 23 Dec 2013 12:00:12 +0100 Subject: [PATCH 20/36] Refinement in comments I checked this using XDebug, and the function actually returns null (which is something different than false). I assume it is the comment that should be changed, and not the code itself... --- framework/yii/db/Query.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/framework/yii/db/Query.php b/framework/yii/db/Query.php index ee24c2f..2baa78c 100644 --- a/framework/yii/db/Query.php +++ b/framework/yii/db/Query.php @@ -148,7 +148,7 @@ class Query extends Component implements QueryInterface * Executes the query and returns a single row of result. * @param Connection $db the database connection used to generate the SQL statement. * If this parameter is not given, the `db` application component will be used. - * @return array|boolean the first row (in terms of an array) of the query result. False is returned if the query + * @return array|boolean the first row (in terms of an array) of the query result. Null is returned if the query * results in nothing. */ public function one($db = null) From 55deceb0619be9eb739aa761fe219e1b990f2a50 Mon Sep 17 00:00:00 2001 From: Qiang Xue Date: Mon, 23 Dec 2013 08:47:30 -0500 Subject: [PATCH 21/36] Fixes #1076 --- framework/yii/db/mssql/QueryBuilder.php | 41 +++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/framework/yii/db/mssql/QueryBuilder.php b/framework/yii/db/mssql/QueryBuilder.php index 338a74b..77b9532 100644 --- a/framework/yii/db/mssql/QueryBuilder.php +++ b/framework/yii/db/mssql/QueryBuilder.php @@ -60,6 +60,47 @@ class QueryBuilder extends \yii\db\QueryBuilder // } /** + * Builds a SQL statement for renaming a DB table. + * @param string $table the table to be renamed. The name will be properly quoted by the method. + * @param string $newName the new table name. The name will be properly quoted by the method. + * @return string the SQL statement for renaming a DB table. + */ + public function renameTable($table, $newName) + { + return "sp_rename '$table', '$newName'"; + } + + /** + * Builds a SQL statement for renaming a column. + * @param string $table the table whose column is to be renamed. The name will be properly quoted by the method. + * @param string $name the old name of the column. The name will be properly quoted by the method. + * @param string $newName the new name of the column. The name will be properly quoted by the method. + * @return string the SQL statement for renaming a DB column. + */ + public function renameColumn($table, $name, $newName) + { + return "sp_rename '$table.$name', '$newName', 'COLUMN'"; + } + + /** + * Builds a SQL statement for changing the definition of a column. + * @param string $table the table whose column is to be changed. The table name will be properly quoted by the method. + * @param string $column the name of the column to be changed. The name will be properly quoted by the method. + * @param string $type the new column type. The {@link getColumnType} method will be invoked to convert abstract column type (if any) + * into the physical one. Anything that is not recognized as abstract type will be kept in the generated SQL. + * For example, 'string' will be turned into 'varchar(255)', while 'string not null' will become 'varchar(255) not null'. + * @return string the SQL statement for changing the definition of a column. + */ + public function alterColumn($table, $column, $type) + { + $type=$this->getColumnType($type); + $sql='ALTER TABLE ' . $this->db->quoteTableName($table) . ' ALTER COLUMN ' + . $this->db->quoteColumnName($column) . ' ' + . $this->getColumnType($type); + return $sql; + } + + /** * Builds a SQL statement for enabling or disabling integrity check. * @param boolean $check whether to turn on or off the integrity check. * @param string $schema the schema of the tables. Defaults to empty string, meaning the current or default schema. From c04e650799b6f6ff8b3a0a1d94dcce73d2cfd53e Mon Sep 17 00:00:00 2001 From: Qiang Xue Date: Mon, 23 Dec 2013 09:04:26 -0500 Subject: [PATCH 22/36] Fixed composer about yii2-dev installation --- extensions/yii/composer/Installer.php | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/extensions/yii/composer/Installer.php b/extensions/yii/composer/Installer.php index 6f69afc..04d9d08 100644 --- a/extensions/yii/composer/Installer.php +++ b/extensions/yii/composer/Installer.php @@ -44,7 +44,7 @@ class Installer extends LibraryInstaller $this->addPackage($package); // ensure the yii2-dev package also provides Yii.php in the same place as yii2 does if ($package->getName() == 'yiisoft/yii2-dev') { - $this->linkYiiBaseFiles(); + $this->linkBaseYiiFiles(); } } @@ -58,7 +58,7 @@ class Installer extends LibraryInstaller $this->addPackage($target); // ensure the yii2-dev package also provides Yii.php in the same place as yii2 does if ($initial->getName() == 'yiisoft/yii2-dev') { - $this->linkYiiBaseFiles(); + $this->linkBaseYiiFiles(); } } @@ -73,7 +73,7 @@ class Installer extends LibraryInstaller $this->removePackage($package); // remove links for Yii.php if ($package->getName() == 'yiisoft/yii2-dev') { - $this->removeYiiBaseFiles(); + $this->removeBaseYiiFiles(); } } @@ -169,13 +169,13 @@ class Installer extends LibraryInstaller } } - protected function linkYiiBaseFiles() + protected function linkBaseYiiFiles() { $yiiDir = $this->vendorDir . '/yiisoft/yii2/yii'; if (!file_exists($yiiDir)) { mkdir($yiiDir, 0777, true); } - foreach(['Yii.php', 'YiiBase.php', 'classes.php'] as $file) { + foreach(['Yii.php', 'BaseYii.php', 'classes.php'] as $file) { file_put_contents($yiiDir . '/' . $file, <<vendorDir . '/yiisoft/yii2/yii'; - foreach(['Yii.php', 'YiiBase.php', 'classes.php'] as $file) { + foreach(['Yii.php', 'BaseYii.php', 'classes.php'] as $file) { if (file_exists($yiiDir . '/' . $file)) { unlink($yiiDir . '/' . $file); } From 6b95b2ad54d8203192be2279ae602c1223cf8205 Mon Sep 17 00:00:00 2001 From: Pavel Agalecky Date: Mon, 23 Dec 2013 22:11:28 +0400 Subject: [PATCH 23/36] Added support for tagName and encodeLabel parameters in ButtonDropdown --- extensions/yii/bootstrap/ButtonDropdown.php | 14 ++++++++++---- extensions/yii/bootstrap/CHANGELOG.md | 1 + 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/extensions/yii/bootstrap/ButtonDropdown.php b/extensions/yii/bootstrap/ButtonDropdown.php index 1ffde7d..095a93f 100644 --- a/extensions/yii/bootstrap/ButtonDropdown.php +++ b/extensions/yii/bootstrap/ButtonDropdown.php @@ -49,6 +49,14 @@ class ButtonDropdown extends Widget * @var boolean whether to display a group of split-styled button group. */ public $split = false; + /** + * @var string the tag to use to render the button + */ + public $tagName = 'button'; + /** + * @var boolean whether the label should be HTML-encoded. + */ + public $encodeLabel = true; /** @@ -68,7 +76,6 @@ class ButtonDropdown extends Widget { Html::addCssClass($this->options, 'btn'); if ($this->split) { - $tag = 'button'; $options = $this->options; $this->options['data-toggle'] = 'dropdown'; Html::addCssClass($this->options, 'dropdown-toggle'); @@ -78,7 +85,6 @@ class ButtonDropdown extends Widget 'options' => $this->options, ]); } else { - $tag = 'a'; $this->label .= ' '; $options = $this->options; if (!isset($options['href'])) { @@ -89,10 +95,10 @@ class ButtonDropdown extends Widget $splitButton = ''; } return Button::widget([ - 'tagName' => $tag, + 'tagName' => $this->tagName, 'label' => $this->label, 'options' => $options, - 'encodeLabel' => false, + 'encodeLabel' => $this->encodeLabel, ]) . "\n" . $splitButton; } diff --git a/extensions/yii/bootstrap/CHANGELOG.md b/extensions/yii/bootstrap/CHANGELOG.md index 0eaa722..3cd4aff 100644 --- a/extensions/yii/bootstrap/CHANGELOG.md +++ b/extensions/yii/bootstrap/CHANGELOG.md @@ -7,6 +7,7 @@ Yii Framework 2 bootstrap extension Change Log - Enh #1474: Added option to make NavBar 100% width (cebe) - Enh #1553: Only add navbar-default class to NavBar when no other class is specified (cebe) - Bug #1459: Update Collapse to use bootstrap 3 classes (tonydspaniard) +- Enh: Added support for tagName and encodeLabel parameters in ButtonDropdown (omnilight) 2.0.0 alpha, December 1, 2013 ----------------------------- From 56c361bb9e75b27d5cf1053e3742d6e780ba5820 Mon Sep 17 00:00:00 2001 From: Qiang Xue Date: Mon, 23 Dec 2013 14:55:41 -0500 Subject: [PATCH 24/36] Fixed changelog. --- extensions/yii/bootstrap/CHANGELOG.md | 2 +- framework/CHANGELOG.md | 1 + framework/yii/db/ActiveQuery.php | 5 ----- 3 files changed, 2 insertions(+), 6 deletions(-) diff --git a/extensions/yii/bootstrap/CHANGELOG.md b/extensions/yii/bootstrap/CHANGELOG.md index 3cd4aff..d6fbee3 100644 --- a/extensions/yii/bootstrap/CHANGELOG.md +++ b/extensions/yii/bootstrap/CHANGELOG.md @@ -6,8 +6,8 @@ Yii Framework 2 bootstrap extension Change Log - Enh #1474: Added option to make NavBar 100% width (cebe) - Enh #1553: Only add navbar-default class to NavBar when no other class is specified (cebe) +- Enh #1601: Added support for tagName and encodeLabel parameters in ButtonDropdown (omnilight) - Bug #1459: Update Collapse to use bootstrap 3 classes (tonydspaniard) -- Enh: Added support for tagName and encodeLabel parameters in ButtonDropdown (omnilight) 2.0.0 alpha, December 1, 2013 ----------------------------- diff --git a/framework/CHANGELOG.md b/framework/CHANGELOG.md index 41d8f75..dd9d168 100644 --- a/framework/CHANGELOG.md +++ b/framework/CHANGELOG.md @@ -26,6 +26,7 @@ Yii Framework 2 Change Log - Enh #1552: It is now possible to use multiple bootstrap NavBar in a single page (Alex-Code) - Enh #1572: Added `yii\web\Controller::createAbsoluteUrl()` (samdark) - Enh #1579: throw exception when the given AR relation name does not match in a case sensitive manner (qiangxue) +- Enh #1601: Added support for tagName and encodeLabel parameters in ButtonDropdown (omnilight) - Enh: Added `favicon.ico` and `robots.txt` to defauly application templates (samdark) - Enh: Added `Widget::autoIdPrefix` to support prefixing automatically generated widget IDs (qiangxue) - Enh: Support for file aliases in console command 'message' (omnilight) diff --git a/framework/yii/db/ActiveQuery.php b/framework/yii/db/ActiveQuery.php index e0e14cf..e93e9be 100644 --- a/framework/yii/db/ActiveQuery.php +++ b/framework/yii/db/ActiveQuery.php @@ -143,9 +143,4 @@ class ActiveQuery extends Query implements ActiveQueryInterface } return $db->createCommand($sql, $params); } - - public function joinWith($name) - { - - } } From 5fc275e935c7acf4b4b1a05d825d050ffa31877c Mon Sep 17 00:00:00 2001 From: Qiang Xue Date: Mon, 23 Dec 2013 16:36:21 -0500 Subject: [PATCH 25/36] Fixes #1499: Added `ActionColumn::controller` property to support customizing the controller for handling GridView actions --- framework/CHANGELOG.md | 1 + framework/yii/grid/ActionColumn.php | 10 +++++++++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/framework/CHANGELOG.md b/framework/CHANGELOG.md index dd9d168..ba1cff7 100644 --- a/framework/CHANGELOG.md +++ b/framework/CHANGELOG.md @@ -22,6 +22,7 @@ Yii Framework 2 Change Log - Enh #1406: DB Schema support for Oracle Database (p0larbeer, qiangxue) - Enh #1437: Added ListView::viewParams (qiangxue) - Enh #1469: ActiveRecord::find() now works with default conditions (default scope) applied by createQuery (cebe) +- Enh #1499: Added `ActionColumn::controller` property to support customizing the controller for handling GridView actions (qiangxue) - Enh #1523: Query conditions now allow to use the NOT operator (cebe) - Enh #1552: It is now possible to use multiple bootstrap NavBar in a single page (Alex-Code) - Enh #1572: Added `yii\web\Controller::createAbsoluteUrl()` (samdark) diff --git a/framework/yii/grid/ActionColumn.php b/framework/yii/grid/ActionColumn.php index 707d411..b53b606 100644 --- a/framework/yii/grid/ActionColumn.php +++ b/framework/yii/grid/ActionColumn.php @@ -19,6 +19,13 @@ use yii\helpers\Html; */ class ActionColumn extends Column { + /** + * @var string the ID of the controller that should handle the actions specified here. + * If not set, it will use the currently active controller. This property is mainly used by + * [[urlCreator]] to create URLs for different actions. The value of this property will be prefixed + * to each action name to form the route of the action. + */ + public $controller; public $template = '{view} {update} {delete}'; public $buttons = []; public $urlCreator; @@ -75,7 +82,8 @@ class ActionColumn extends Column return call_user_func($this->urlCreator, $model, $key, $index, $action); } else { $params = is_array($key) ? $key : ['id' => $key]; - return Yii::$app->controller->createUrl($action, $params); + $route = $this->controller ? $this->controller . '/' . $action : $action; + return Yii::$app->controller->createUrl($route, $params); } } From 5e092ac6195aabb4e5f511df433ed29b607dd33a Mon Sep 17 00:00:00 2001 From: Edin Date: Tue, 24 Dec 2013 02:01:54 +0100 Subject: [PATCH 26/36] Fixed sequence id match for postgresql PgAdmin generates sequence as '"Schema"."Table_seq"'::regclass when non public schema is used. --- framework/yii/db/pgsql/Schema.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/framework/yii/db/pgsql/Schema.php b/framework/yii/db/pgsql/Schema.php index f6c7298..eb7de37 100644 --- a/framework/yii/db/pgsql/Schema.php +++ b/framework/yii/db/pgsql/Schema.php @@ -299,7 +299,7 @@ SQL; $table->columns[$column->name] = $column; if ($column->isPrimaryKey === true) { $table->primaryKey[] = $column->name; - if ($table->sequenceName === null && preg_match("/nextval\\('\"?\\w+\"?'(::regclass)?\\)/", $column->defaultValue) === 1) { + if ($table->sequenceName === null && preg_match("/nextval\\('\"?\\w+\"?\.?\"?\\w+\"?'(::regclass)?\\)/", $column->defaultValue) === 1) { $table->sequenceName = preg_replace(['/nextval/', '/::/', '/regclass/', '/\'\)/', '/\(\'/'], '', $column->defaultValue); } } From 2402d2d031724efb5e06c7f61484723c2bc7ee1a Mon Sep 17 00:00:00 2001 From: Qiang Xue Date: Mon, 23 Dec 2013 22:26:44 -0500 Subject: [PATCH 27/36] Draft implementation of ActiveQuery::joinWith(). --- framework/yii/db/ActiveQuery.php | 137 +++++++++++++++++++++++++++ tests/unit/framework/db/ActiveRecordTest.php | 27 ++++++ 2 files changed, 164 insertions(+) diff --git a/framework/yii/db/ActiveQuery.php b/framework/yii/db/ActiveQuery.php index e93e9be..098724d 100644 --- a/framework/yii/db/ActiveQuery.php +++ b/framework/yii/db/ActiveQuery.php @@ -143,4 +143,141 @@ class ActiveQuery extends Query implements ActiveQueryInterface } return $db->createCommand($sql, $params); } + + public function joinWith($with, $eagerLoading = true, $joinType = 'INNER JOIN') + { + $with = (array)$with; + $this->joinWithRelations(new $this->modelClass, $with, $joinType); + + if (is_array($eagerLoading)) { + foreach ($with as $name => $callback) { + if (is_integer($name)) { + if (!in_array($callback, $eagerLoading, true)) { + unset($with[$name]); + } + } elseif (!in_array($name, $eagerLoading, true)) { + unset($with[$name]); + } + } + $this->with($with); + } elseif ($eagerLoading) { + $this->with($with); + } + return $this; + } + + /** + * @param ActiveRecord $model + * @param array $with + * @param string|array $joinType + */ + private function joinWithRelations($model, $with, $joinType) + { + $relations = []; + + foreach ($with as $name => $callback) { + if (is_integer($name)) { + $name = $callback; + $callback = null; + } + + $primaryModel = $model; + $parent = $this; + $prefix = ''; + while (($pos = strpos($name, '.')) !== false) { + $childName = substr($name, $pos + 1); + $name = substr($name, 0, $pos); + $fullName = $prefix === '' ? $name : "$prefix.$name"; + if (!isset($relations[$fullName])) { + $relations[$fullName] = $relation = $primaryModel->getRelation($name); + $this->joinWithRelation($parent, $relation, $this->getJoinType($joinType, $fullName)); + } else { + $relation = $relations[$fullName]; + } + $primaryModel = new $relation->modelClass; + $parent = $relation; + $prefix = $fullName; + $name = $childName; + } + + $fullName = $prefix === '' ? $name : "$prefix.$name"; + if (!isset($relations[$fullName])) { + $relations[$fullName] = $relation = $primaryModel->getRelation($name); + if ($callback !== null) { + call_user_func($callback, $relation); + } + $this->joinWithRelation($parent, $relation, $this->getJoinType($joinType, $fullName)); + } + } + } + + private function getJoinType($joinType, $name) + { + if (is_array($joinType) && isset($joinType[$name])) { + return $joinType[$name]; + } else { + return is_string($joinType) ? $joinType : 'INNER JOIN'; + } + } + + /** + * @param ActiveQuery $query + * @return string + */ + private function getQueryTableName($query) + { + if (empty($query->from)) { + /** @var ActiveRecord $modelClass */ + $modelClass = $query->modelClass; + return $modelClass::tableName(); + } else { + return reset($query->from); + } + } + + /** + * @param ActiveQuery $parent + * @param ActiveRelation $child + * @param string $joinType + */ + private function joinWithRelation($parent, $child, $joinType) + { + $parentTable = $this->getQueryTableName($parent); + $childTable = $this->getQueryTableName($child); + if (!empty($child->link)) { + $on = []; + foreach ($child->link as $childColumn => $parentColumn) { + $on[] = '{{' . $parentTable . "}}.[[$parentColumn]] = {{" . $childTable . "}}.[[$childColumn]]"; + } + $on = implode(' AND ', $on); + } else { + $on = ''; + } + $this->join($joinType, $childTable, $on); + if (!empty($child->where)) { + $this->andWhere($child->where); + } + if (!empty($child->having)) { + $this->andHaving($child->having); + } + if (!empty($child->orderBy)) { + $this->addOrderBy($child->orderBy); + } + if (!empty($child->groupBy)) { + $this->addGroupBy($child->groupBy); + } + if (!empty($child->params)) { + $this->addParams($child->params); + } + if (!empty($child->join)) { + foreach ($child->join as $join) { + $this->join[] = $join; + } + } + if (!empty($child->union)) { + foreach ($child->union as $union) { + $this->union[] = $union; + } + } + } } diff --git a/tests/unit/framework/db/ActiveRecordTest.php b/tests/unit/framework/db/ActiveRecordTest.php index 15462b5..d112ff4 100644 --- a/tests/unit/framework/db/ActiveRecordTest.php +++ b/tests/unit/framework/db/ActiveRecordTest.php @@ -217,4 +217,31 @@ class ActiveRecordTest extends DatabaseTestCase $this->assertTrue(OrderItem::isPrimaryKey(['order_id', 'item_id'])); $this->assertFalse(OrderItem::isPrimaryKey(['order_id', 'item_id', 'quantity'])); } + + public function testJoinWith() + { + // inner join filtering and eager loading + $orders = Order::find()->joinWith([ + 'customer' => function ($query) { + $query->where('tbl_customer.id=2'); + }, + ])->orderBy('tbl_order.id')->all(); + $this->assertEquals(2, count($orders)); + $this->assertEquals(2, $orders[0]->id); + $this->assertEquals(3, $orders[1]->id); + $this->assertTrue($orders[0]->isRelationPopulated('customer')); + $this->assertTrue($orders[1]->isRelationPopulated('customer')); + + // inner join filtering without eager loading + $orders = Order::find()->joinWith([ + 'customer' => function ($query) { + $query->where('tbl_customer.id=2'); + }, + ], false)->orderBy('tbl_order.id')->all(); + $this->assertEquals(2, count($orders)); + $this->assertEquals(2, $orders[0]->id); + $this->assertEquals(3, $orders[1]->id); + $this->assertFalse($orders[0]->isRelationPopulated('customer')); + $this->assertFalse($orders[1]->isRelationPopulated('customer')); + } } From 4f44bb241697d26816c43baa993a64a2c200f125 Mon Sep 17 00:00:00 2001 From: Qiang Xue Date: Tue, 24 Dec 2013 00:08:49 -0500 Subject: [PATCH 28/36] Fixes #1581: Added `ActiveQuery::joinWith()` to support joining with relations --- docs/guide/active-record.md | 24 ++++++ framework/CHANGELOG.md | 1 + framework/yii/db/ActiveQuery.php | 116 ++++++++++++++++++++++++++- framework/yii/db/ActiveRelationTrait.php | 40 ++++----- tests/unit/data/ar/Category.php | 27 +++++++ tests/unit/data/ar/Item.php | 5 ++ tests/unit/framework/db/ActiveRecordTest.php | 23 ++++++ 7 files changed, 212 insertions(+), 24 deletions(-) create mode 100644 tests/unit/data/ar/Category.php diff --git a/docs/guide/active-record.md b/docs/guide/active-record.md index 70d41e0..6498dfc 100644 --- a/docs/guide/active-record.md +++ b/docs/guide/active-record.md @@ -386,6 +386,30 @@ $customers = Customer::find()->limit(100)->with([ ``` +Joining with Relations +---------------------- + +When working with relational databases, a common task is to join multiple tables and apply various +query conditions and parameters to the JOIN SQL statement. Instead of calling [[ActiveQuery::join()]] +explicitly to build up the JOIN query, you may reuse the existing relation definitions and call [[ActiveQuery::joinWith()]] +to achieve the same goal. For example, + +```php +// find all orders that contain books, and eager loading "books" +$orders = Order::find()->joinWith('books')->all(); +// find all orders that contain books, and sort the orders by the book names. +$orders = Order::find()->joinWith([ + 'books' => function ($query) { + $query->orderBy('tbl_item.name'); + } +])->all(); +``` + +Note that [[ActiveQuery::joinWith()]] differs from [[ActiveQuery::with()]] in that the former will build up +and execute a JOIN SQL statement. For example, `Order::find()->joinWith('books')->all()` returns all orders that +contain books, while `Order::find()->with('books')->all()` returns all orders regardless they contain books or not. + + Working with Relationships -------------------------- diff --git a/framework/CHANGELOG.md b/framework/CHANGELOG.md index ba1cff7..562277e 100644 --- a/framework/CHANGELOG.md +++ b/framework/CHANGELOG.md @@ -27,6 +27,7 @@ Yii Framework 2 Change Log - Enh #1552: It is now possible to use multiple bootstrap NavBar in a single page (Alex-Code) - Enh #1572: Added `yii\web\Controller::createAbsoluteUrl()` (samdark) - Enh #1579: throw exception when the given AR relation name does not match in a case sensitive manner (qiangxue) +- Enh #1581: Added `ActiveQuery::joinWith()` to support joining with relations (qiangxue) - Enh #1601: Added support for tagName and encodeLabel parameters in ButtonDropdown (omnilight) - Enh: Added `favicon.ico` and `robots.txt` to defauly application templates (samdark) - Enh: Added `Widget::autoIdPrefix` to support prefixing automatically generated widget IDs (qiangxue) diff --git a/framework/yii/db/ActiveQuery.php b/framework/yii/db/ActiveQuery.php index 098724d..714ff61 100644 --- a/framework/yii/db/ActiveQuery.php +++ b/framework/yii/db/ActiveQuery.php @@ -68,6 +68,9 @@ class ActiveQuery extends Query implements ActiveQueryInterface $rows = $command->queryAll(); if (!empty($rows)) { $models = $this->createModels($rows); + if (!empty($this->join) && $this->indexBy === null) { + $models = $this->removeDuplicatedModels($models); + } if (!empty($this->with)) { $this->findWith($this->with, $models); } @@ -78,6 +81,47 @@ class ActiveQuery extends Query implements ActiveQueryInterface } /** + * Removes duplicated models by checking their primary key values. + * This method is mainly called when a join query is performed, which may cause duplicated rows being returned. + * @param array $models the models to be checked + * @return array the distinctive models + */ + private function removeDuplicatedModels($models) + { + $hash = []; + /** @var ActiveRecord $class */ + $class = $this->modelClass; + $pks = $class::primaryKey(); + + if (count($pks) > 1) { + foreach ($models as $i => $model) { + $key = []; + foreach ($pks as $pk) { + $key[] = $model[$pk]; + } + $key = serialize($key); + if (isset($hash[$key])) { + unset($models[$i]); + } else { + $hash[$key] = true; + } + } + } else { + $pk = reset($pks); + foreach ($models as $i => $model) { + $key = $model[$pk]; + if (isset($hash[$key])) { + unset($models[$i]); + } else { + $hash[$key] = true; + } + } + } + + return array_values($models); + } + + /** * Executes query and returns a single row of result. * @param Connection $db the DB connection used to create the DB command. * If null, the DB connection returned by [[modelClass]] will be used. @@ -144,6 +188,42 @@ class ActiveQuery extends Query implements ActiveQueryInterface return $db->createCommand($sql, $params); } + /** + * Joins with the specified relations. + * + * This method allows you to reuse existing relation definitions to perform JOIN queries. + * Based on the definition of the specified relation(s), the method will append one or multiple + * JOIN statements to the current query. + * + * If the `$eagerLoading` parameter is true, the method will also eager loading the specified relations, + * which is equivalent to calling [[with()]] using the specified relations. + * + * Note that because a JOIN query will be performed, you are responsible to disambiguate column names. + * + * This method differs from [[with()]] in that it will build up and execute a JOIN SQL statement. + * When `$eagerLoading` is true, it will call [[with()]] in addition with the specified relations. + * + * @param array $with the relations to be joined. Each array element represents a single relation. + * The array keys are relation names, and the array values are the corresponding anonymous functions that + * can be used to modify the relation queries on-the-fly. If a relation query does not need modification, + * you may use the relation name as the array value. Sub-relations can also be specified (see [[with()]]). + * For example, + * + * ```php + * // find all orders that contain books, and eager loading "books" + * Order::find()->joinWith('books')->all(); + * // find all orders that contain books, and sort the orders by the book names. + * Order::find()->joinWith([ + * 'books' => function ($query) { + * $query->orderBy('tbl_item.name'); + * } + * ])->all(); + * ``` + * + * @param bool $eagerLoading + * @param string $joinType + * @return $this + */ public function joinWith($with, $eagerLoading = true, $joinType = 'INNER JOIN') { $with = (array)$with; @@ -167,9 +247,10 @@ class ActiveQuery extends Query implements ActiveQueryInterface } /** - * @param ActiveRecord $model - * @param array $with - * @param string|array $joinType + * Modifies the current query by adding join fragments based on the given relations. + * @param ActiveRecord $model the primary model + * @param array $with the relations to be joined + * @param string|array $joinType the join type */ private function joinWithRelations($model, $with, $joinType) { @@ -211,6 +292,12 @@ class ActiveQuery extends Query implements ActiveQueryInterface } } + /** + * Returns the join type based on the given join type parameter and the relation name. + * @param string|array $joinType the given join type(s) + * @param string $name relation name + * @return string the real join type + */ private function getJoinType($joinType, $name) { if (is_array($joinType) && isset($joinType[$name])) { @@ -221,8 +308,9 @@ class ActiveQuery extends Query implements ActiveQueryInterface } /** + * Returns the table name used by the specified active query. * @param ActiveQuery $query - * @return string + * @return string the table name */ private function getQueryTableName($query) { @@ -236,14 +324,32 @@ class ActiveQuery extends Query implements ActiveQueryInterface } /** + * Joins a parent query with a child query. + * The current query object will be modified accordingly. * @param ActiveQuery $parent * @param ActiveRelation $child * @param string $joinType */ private function joinWithRelation($parent, $child, $joinType) { + $via = $child->via; + $child->via = null; + if ($via instanceof ActiveRelation) { + // via table + $this->joinWithRelation($parent, $via, $joinType); + $this->joinWithRelation($via, $child, $joinType); + return; + } elseif (is_array($via)) { + // via relation + $this->joinWithRelation($parent, $via[1], $joinType); + $this->joinWithRelation($via[1], $child, $joinType); + return; + } + $parentTable = $this->getQueryTableName($parent); $childTable = $this->getQueryTableName($child); + + if (!empty($child->link)) { $on = []; foreach ($child->link as $childColumn => $parentColumn) { @@ -254,6 +360,8 @@ class ActiveQuery extends Query implements ActiveQueryInterface $on = ''; } $this->join($joinType, $childTable, $on); + + if (!empty($child->where)) { $this->andWhere($child->where); } diff --git a/framework/yii/db/ActiveRelationTrait.php b/framework/yii/db/ActiveRelationTrait.php index c885006..dac3028 100644 --- a/framework/yii/db/ActiveRelationTrait.php +++ b/framework/yii/db/ActiveRelationTrait.php @@ -189,26 +189,6 @@ trait ActiveRelationTrait } /** - * @param ActiveRecord|array $model - * @param array $attributes - * @return string - */ - private function getModelKey($model, $attributes) - { - if (count($attributes) > 1) { - $key = []; - foreach ($attributes as $attribute) { - $key[] = $model[$attribute]; - } - return serialize($key); - } else { - $attribute = reset($attributes); - $key = $model[$attribute]; - return is_scalar($key) ? $key : serialize($key); - } - } - - /** * @param array $models */ private function filterByModels($models) @@ -237,6 +217,26 @@ trait ActiveRelationTrait } /** + * @param ActiveRecord|array $model + * @param array $attributes + * @return string + */ + private function getModelKey($model, $attributes) + { + if (count($attributes) > 1) { + $key = []; + foreach ($attributes as $attribute) { + $key[] = $model[$attribute]; + } + return serialize($key); + } else { + $attribute = reset($attributes); + $key = $model[$attribute]; + return is_scalar($key) ? $key : serialize($key); + } + } + + /** * @param array $primaryModels either array of AR instances or arrays * @return array */ diff --git a/tests/unit/data/ar/Category.php b/tests/unit/data/ar/Category.php new file mode 100644 index 0000000..cebacb0 --- /dev/null +++ b/tests/unit/data/ar/Category.php @@ -0,0 +1,27 @@ +hasMany(Item::className(), ['category_id' => 'id']); + } +} diff --git a/tests/unit/data/ar/Item.php b/tests/unit/data/ar/Item.php index e725be9..2d04f9e 100644 --- a/tests/unit/data/ar/Item.php +++ b/tests/unit/data/ar/Item.php @@ -15,4 +15,9 @@ class Item extends ActiveRecord { return 'tbl_item'; } + + public function getCategory() + { + return $this->hasOne(Category::className(), ['id' => 'category_id']); + } } diff --git a/tests/unit/framework/db/ActiveRecordTest.php b/tests/unit/framework/db/ActiveRecordTest.php index d112ff4..276547e 100644 --- a/tests/unit/framework/db/ActiveRecordTest.php +++ b/tests/unit/framework/db/ActiveRecordTest.php @@ -243,5 +243,28 @@ class ActiveRecordTest extends DatabaseTestCase $this->assertEquals(3, $orders[1]->id); $this->assertFalse($orders[0]->isRelationPopulated('customer')); $this->assertFalse($orders[1]->isRelationPopulated('customer')); + + // join with via-relation + $orders = Order::find()->joinWith('books')->orderBy('tbl_order.id')->all(); + $this->assertEquals(2, count($orders)); + $this->assertEquals(1, $orders[0]->id); + $this->assertEquals(3, $orders[1]->id); + $this->assertTrue($orders[0]->isRelationPopulated('books')); + $this->assertTrue($orders[1]->isRelationPopulated('books')); + $this->assertEquals(2, count($orders[0]->books)); + $this->assertEquals(1, count($orders[1]->books)); + + // join with sub-relation + $orders = Order::find()->joinWith([ + 'items.category' => function ($q) { + $q->where('tbl_category.id = 2'); + }, + ])->orderBy('tbl_order.id')->all(); + $this->assertEquals(1, count($orders)); + $this->assertTrue($orders[0]->isRelationPopulated('items')); + $this->assertEquals(2, $orders[0]->id); + $this->assertEquals(3, count($orders[0]->items)); + $this->assertTrue($orders[0]->items[0]->isRelationPopulated('category')); + $this->assertEquals(2, $orders[0]->items[0]->category->id); } } From b59469b54c8a1cce0c6f2144f10da0969c27dd0a Mon Sep 17 00:00:00 2001 From: zvon Date: Tue, 24 Dec 2013 10:31:16 +0200 Subject: [PATCH 29/36] doc fix --- docs/guide/controller.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/guide/controller.md b/docs/guide/controller.md index 801df69..de6cec5 100644 --- a/docs/guide/controller.md +++ b/docs/guide/controller.md @@ -194,9 +194,9 @@ public function behaviors() 'class' => 'yii\web\AccessControl', 'rules' => [ ['allow' => true, 'actions' => ['admin'], 'roles' => ['@']], - ), - ), - ); + ], + ], + ]; } ``` From dc720d9bf4fb8a07f2c7d08012952644ad85e794 Mon Sep 17 00:00:00 2001 From: Qiang Xue Date: Tue, 24 Dec 2013 09:29:05 -0500 Subject: [PATCH 30/36] more docs about joinwith() --- docs/guide/active-record.md | 45 +++++++++++++++++++++++++++++++++++++--- framework/yii/db/ActiveQuery.php | 10 ++++++--- 2 files changed, 49 insertions(+), 6 deletions(-) diff --git a/docs/guide/active-record.md b/docs/guide/active-record.md index 6498dfc..0996331 100644 --- a/docs/guide/active-record.md +++ b/docs/guide/active-record.md @@ -400,14 +400,53 @@ $orders = Order::find()->joinWith('books')->all(); // find all orders that contain books, and sort the orders by the book names. $orders = Order::find()->joinWith([ 'books' => function ($query) { - $query->orderBy('tbl_item.name'); + $query->orderBy('tbl_item.id'); } ])->all(); ``` Note that [[ActiveQuery::joinWith()]] differs from [[ActiveQuery::with()]] in that the former will build up -and execute a JOIN SQL statement. For example, `Order::find()->joinWith('books')->all()` returns all orders that -contain books, while `Order::find()->with('books')->all()` returns all orders regardless they contain books or not. +and execute a JOIN SQL statement for the primary model class. For example, `Order::find()->joinWith('books')->all()` +returns all orders that contain books, while `Order::find()->with('books')->all()` returns all orders +regardless they contain books or not. + +Because `joinWith()` will cause generating a JOIN SQL statement, you are responsible to disambiguate column +names. For example, we use `tbl_item.id` to disambiguate the `id` column reference because both of the order table +and the item table contain a column named `id`. + +You may join with one or multiple relations. You may also join with sub-relations. For example, + +```php +// join with multiple relations +// find out the orders that contain books and are placed by customers who registered within the past 24 hours +$orders = Order::find()->joinWith([ + 'books', + 'customer' => function ($query) { + $query->where('tbl_customer.create_time > ' . (time() - 24 * 3600)); + } +])->all(); +// join with sub-relations: join with books and books' authors +$orders = Order::find()->joinWith('books.author')->all(); +``` + +By default, when you join with a relation, the relation will also be eagerly loaded. You may change this behavior +by passing the `$eagerLoading` parameter which specifies whether to eager load the specified relations. + +Also, when the relations are joined with the primary table, the default join type is `INNER JOIN`. You may change +to use other type of joins, such as `LEFT JOIN`. + +Below are some more examples, + +```php +// find all orders that contain books, but do not eager loading "books". +$orders = Order::find()->joinWith('books', false)->all(); +// find all orders and sort them by the customer IDs. Do not eager loading "customer". +$orders = Order::find()->joinWith([ + 'customer' => function ($query) { + $query->orderBy('tbl_customer.id'); + }, +], false, 'LEFT JOIN')->all(); +``` Working with Relationships diff --git a/framework/yii/db/ActiveQuery.php b/framework/yii/db/ActiveQuery.php index 714ff61..a71b1cf 100644 --- a/framework/yii/db/ActiveQuery.php +++ b/framework/yii/db/ActiveQuery.php @@ -220,9 +220,13 @@ class ActiveQuery extends Query implements ActiveQueryInterface * ])->all(); * ``` * - * @param bool $eagerLoading - * @param string $joinType - * @return $this + * @param boolean|array $eagerLoading whether to eager load the relations specified in `$with`. + * When this is a boolean, it applies to all relations specified in `$with`. Use an array + * to explicitly list which relations in `$with` need to be eagerly loaded. + * @param string|array $joinType the join type of the relations specified in `$with`. + * When this is a string, it applies to all relations specified in `$with`. Use an array + * in the format of `relationName => joinType` to specify different join types for different relations. + * @return static the query object itself */ public function joinWith($with, $eagerLoading = true, $joinType = 'INNER JOIN') { From 03451912455dcf43229b92f8afa463448ec43fa0 Mon Sep 17 00:00:00 2001 From: Qiang Xue Date: Tue, 24 Dec 2013 21:27:13 -0500 Subject: [PATCH 31/36] Added ActiveQuery::innerJoinWith(). --- docs/guide/active-record.md | 61 +++++++++++++++------------- framework/CHANGELOG.md | 2 +- framework/yii/db/ActiveQuery.php | 24 ++++++++--- tests/unit/framework/db/ActiveRecordTest.php | 18 ++++++-- 4 files changed, 67 insertions(+), 38 deletions(-) diff --git a/docs/guide/active-record.md b/docs/guide/active-record.md index 0996331..a414bce 100644 --- a/docs/guide/active-record.md +++ b/docs/guide/active-record.md @@ -391,35 +391,26 @@ Joining with Relations When working with relational databases, a common task is to join multiple tables and apply various query conditions and parameters to the JOIN SQL statement. Instead of calling [[ActiveQuery::join()]] -explicitly to build up the JOIN query, you may reuse the existing relation definitions and call [[ActiveQuery::joinWith()]] -to achieve the same goal. For example, +explicitly to build up the JOIN query, you may reuse the existing relation definitions and call +[[ActiveQuery::joinWith()]] to achieve this goal. For example, ```php +// find all orders and sort the orders by the customer id and the order id. also eager loading "customer" +$orders = Order::find()->joinWith('customer')->orderBy('tbl_customer.id, tbl_order.id')->all(); // find all orders that contain books, and eager loading "books" -$orders = Order::find()->joinWith('books')->all(); -// find all orders that contain books, and sort the orders by the book names. -$orders = Order::find()->joinWith([ - 'books' => function ($query) { - $query->orderBy('tbl_item.id'); - } -])->all(); +$orders = Order::find()->innerJoinWith('books')->all(); ``` -Note that [[ActiveQuery::joinWith()]] differs from [[ActiveQuery::with()]] in that the former will build up -and execute a JOIN SQL statement for the primary model class. For example, `Order::find()->joinWith('books')->all()` -returns all orders that contain books, while `Order::find()->with('books')->all()` returns all orders -regardless they contain books or not. - -Because `joinWith()` will cause generating a JOIN SQL statement, you are responsible to disambiguate column -names. For example, we use `tbl_item.id` to disambiguate the `id` column reference because both of the order table -and the item table contain a column named `id`. +In the above, the method [[ActiveQuery::innerJoinWith()|innerJoinWith()]] is a shortcut to [[ActiveQuery::joinWith()|joinWith()]] +with the join type set as `INNER JOIN`. -You may join with one or multiple relations. You may also join with sub-relations. For example, +You may join with one or multiple relations; you may apply query conditions to the relations on-the-fly; +and you may also join with sub-relations. For example, ```php // join with multiple relations // find out the orders that contain books and are placed by customers who registered within the past 24 hours -$orders = Order::find()->joinWith([ +$orders = Order::find()->innerJoinWith([ 'books', 'customer' => function ($query) { $query->where('tbl_customer.create_time > ' . (time() - 24 * 3600)); @@ -429,23 +420,37 @@ $orders = Order::find()->joinWith([ $orders = Order::find()->joinWith('books.author')->all(); ``` +Behind the scene, Yii will first execute a JOIN SQL statement to bring back the primary models +satisfying the conditions applied to the JOIN SQL. It will then execute a query for each relation +and populate the corresponding related records. + +The difference between [[ActiveQuery::joinWith()|joinWith()]] and [[ActiveQuery::with()|with()]] is that +the former joins the tables for the primary model class and the related model classes to retrieve +the primary models, while the latter just queries against the table for the primary model class to +retrieve the primary models. + +Because of this difference, you may apply query conditions that are only available to a JOIN SQL statement. +For example, you may filter the primary models by the conditions on the related models, like the example +above. You may also sort the primary models using columns from the related tables. + +When using [[ActiveQuery::joinWith()|joinWith()]], you are responsible to disambiguate column names. +In the above examples, we use `tbl_item.id` and `tbl_order.id` to disambiguate the `id` column references +because both of the order table and the item table contain a column named `id`. + By default, when you join with a relation, the relation will also be eagerly loaded. You may change this behavior by passing the `$eagerLoading` parameter which specifies whether to eager load the specified relations. -Also, when the relations are joined with the primary table, the default join type is `INNER JOIN`. You may change -to use other type of joins, such as `LEFT JOIN`. +And also by default, [[ActiveQuery::joinWith()|joinWith()]] uses `LEFT JOIN` to join the related tables. +You may pass it with the `$joinType` parameter to customize the join type. As a shortcut to the `INNER JOIN` type, +you may use [[ActiveQuery::innerJoinWith()|innerJoinWith()]]. Below are some more examples, ```php // find all orders that contain books, but do not eager loading "books". -$orders = Order::find()->joinWith('books', false)->all(); -// find all orders and sort them by the customer IDs. Do not eager loading "customer". -$orders = Order::find()->joinWith([ - 'customer' => function ($query) { - $query->orderBy('tbl_customer.id'); - }, -], false, 'LEFT JOIN')->all(); +$orders = Order::find()->innerJoinWith('books', false)->all(); +// equivalent to the above +$orders = Order::find()->joinWith('books', false, 'INNER JOIN')->all(); ``` diff --git a/framework/CHANGELOG.md b/framework/CHANGELOG.md index 562277e..d94011f 100644 --- a/framework/CHANGELOG.md +++ b/framework/CHANGELOG.md @@ -27,7 +27,7 @@ Yii Framework 2 Change Log - Enh #1552: It is now possible to use multiple bootstrap NavBar in a single page (Alex-Code) - Enh #1572: Added `yii\web\Controller::createAbsoluteUrl()` (samdark) - Enh #1579: throw exception when the given AR relation name does not match in a case sensitive manner (qiangxue) -- Enh #1581: Added `ActiveQuery::joinWith()` to support joining with relations (qiangxue) +- Enh #1581: Added `ActiveQuery::joinWith()` and `ActiveQuery::innerJoinWith()` to support joining with relations (qiangxue) - Enh #1601: Added support for tagName and encodeLabel parameters in ButtonDropdown (omnilight) - Enh: Added `favicon.ico` and `robots.txt` to defauly application templates (samdark) - Enh: Added `Widget::autoIdPrefix` to support prefixing automatically generated widget IDs (qiangxue) diff --git a/framework/yii/db/ActiveQuery.php b/framework/yii/db/ActiveQuery.php index a71b1cf..26b0c6e 100644 --- a/framework/yii/db/ActiveQuery.php +++ b/framework/yii/db/ActiveQuery.php @@ -200,8 +200,8 @@ class ActiveQuery extends Query implements ActiveQueryInterface * * Note that because a JOIN query will be performed, you are responsible to disambiguate column names. * - * This method differs from [[with()]] in that it will build up and execute a JOIN SQL statement. - * When `$eagerLoading` is true, it will call [[with()]] in addition with the specified relations. + * This method differs from [[with()]] in that it will build up and execute a JOIN SQL statement + * for the primary table. And when `$eagerLoading` is true, it will call [[with()]] in addition with the specified relations. * * @param array $with the relations to be joined. Each array element represents a single relation. * The array keys are relation names, and the array values are the corresponding anonymous functions that @@ -211,8 +211,8 @@ class ActiveQuery extends Query implements ActiveQueryInterface * * ```php * // find all orders that contain books, and eager loading "books" - * Order::find()->joinWith('books')->all(); - * // find all orders that contain books, and sort the orders by the book names. + * Order::find()->joinWith('books', true, 'INNER JOIN')->all(); + * // find all orders, eager loading "books", and sort the orders and books by the book names. * Order::find()->joinWith([ * 'books' => function ($query) { * $query->orderBy('tbl_item.name'); @@ -228,7 +228,7 @@ class ActiveQuery extends Query implements ActiveQueryInterface * in the format of `relationName => joinType` to specify different join types for different relations. * @return static the query object itself */ - public function joinWith($with, $eagerLoading = true, $joinType = 'INNER JOIN') + public function joinWith($with, $eagerLoading = true, $joinType = 'LEFT JOIN') { $with = (array)$with; $this->joinWithRelations(new $this->modelClass, $with, $joinType); @@ -251,6 +251,20 @@ class ActiveQuery extends Query implements ActiveQueryInterface } /** + * Inner joins with the specified relations. + * This is a shortcut method to [[joinWith()]] with the join type set as "INNER JOIN". + * Please refer to [[joinWith()]] for detailed usage of this method. + * @param array $with the relations to be joined with + * @param boolean|array $eagerLoading whether to eager loading the relations + * @return static the query object itself + * @see joinWith() + */ + public function innerJoinWith($with, $eagerLoading = true) + { + return $this->joinWith($with, $eagerLoading, 'INNER JOIN'); + } + + /** * Modifies the current query by adding join fragments based on the given relations. * @param ActiveRecord $model the primary model * @param array $with the relations to be joined diff --git a/tests/unit/framework/db/ActiveRecordTest.php b/tests/unit/framework/db/ActiveRecordTest.php index 276547e..40050e5 100644 --- a/tests/unit/framework/db/ActiveRecordTest.php +++ b/tests/unit/framework/db/ActiveRecordTest.php @@ -220,8 +220,18 @@ class ActiveRecordTest extends DatabaseTestCase public function testJoinWith() { + // left join and eager loading + $orders = Order::find()->joinWith('customer')->orderBy('tbl_customer.id DESC, tbl_order.id')->all(); + $this->assertEquals(3, count($orders)); + $this->assertEquals(2, $orders[0]->id); + $this->assertEquals(3, $orders[1]->id); + $this->assertEquals(1, $orders[2]->id); + $this->assertTrue($orders[0]->isRelationPopulated('customer')); + $this->assertTrue($orders[1]->isRelationPopulated('customer')); + $this->assertTrue($orders[2]->isRelationPopulated('customer')); + // inner join filtering and eager loading - $orders = Order::find()->joinWith([ + $orders = Order::find()->innerJoinWith([ 'customer' => function ($query) { $query->where('tbl_customer.id=2'); }, @@ -233,7 +243,7 @@ class ActiveRecordTest extends DatabaseTestCase $this->assertTrue($orders[1]->isRelationPopulated('customer')); // inner join filtering without eager loading - $orders = Order::find()->joinWith([ + $orders = Order::find()->innerJoinWith([ 'customer' => function ($query) { $query->where('tbl_customer.id=2'); }, @@ -245,7 +255,7 @@ class ActiveRecordTest extends DatabaseTestCase $this->assertFalse($orders[1]->isRelationPopulated('customer')); // join with via-relation - $orders = Order::find()->joinWith('books')->orderBy('tbl_order.id')->all(); + $orders = Order::find()->innerJoinWith('books')->orderBy('tbl_order.id')->all(); $this->assertEquals(2, count($orders)); $this->assertEquals(1, $orders[0]->id); $this->assertEquals(3, $orders[1]->id); @@ -255,7 +265,7 @@ class ActiveRecordTest extends DatabaseTestCase $this->assertEquals(1, count($orders[1]->books)); // join with sub-relation - $orders = Order::find()->joinWith([ + $orders = Order::find()->innerJoinWith([ 'items.category' => function ($q) { $q->where('tbl_category.id = 2'); }, From 44d284071ed9a50d789afb3908660dcbb628204b Mon Sep 17 00:00:00 2001 From: Mark Date: Wed, 25 Dec 2013 17:04:12 +0400 Subject: [PATCH 32/36] extended from codeception testcase, added docs --- extensions/yii/codeception/README.md | 53 +++++++++++++++++++++++++++++++-- extensions/yii/codeception/TestCase.php | 3 +- 2 files changed, 52 insertions(+), 4 deletions(-) diff --git a/extensions/yii/codeception/README.md b/extensions/yii/codeception/README.md index 6df55e3..62af9f0 100644 --- a/extensions/yii/codeception/README.md +++ b/extensions/yii/codeception/README.md @@ -5,9 +5,8 @@ This extension provides [Codeception](http://codeception.com/) integration for t It provides classes that help with testing with codeception: -- a base class for unit-tests: `yii\codeception\TestCase +- a base class for unit-tests: `yii\codeception\TestCase`; - a base class for codeception page-objects: `yii\codeception\BasePage`. -- a solution for testing emails Installation @@ -39,7 +38,55 @@ class to reduce code duplication. Simply extend your page object from this class For unit testing there is a `TestCase` class which holds some common features like application creation before each test and application destroy after each test. You can configure a mock application using this class. -`TestCase` is extended from `PHPUnit_Framework_TestCase` so all methods and assertions are available. +`TestCase` is extended from `Codeception\TestCase\Case` so all methods and assertions are available. +You may use codeception modules and fire events in your test, just use methods: + +```php +getModule('CodeHelper'); #or some other module +``` + +You also can use all guy methods by accessing guy instance like: + +```php +codeGuy->someMethodFromModule(); +``` + +to fire event do this: + +```php +fire('myevent', new TestEvent($this)); +} +``` +this event can be catched in modules and helpers. If your test is in the group, then event name will be followed by the groupname, +for example ```myevent.somegroup```. + +Execution of special tests methods is (for example on ```UserTest``` class): + +``` +tests\unit\models\UserTest::setUpBeforeClass(); + + tests\unit\models\UserTest::_before(); + + tests\unit\models\UserTest::setUp(); + + tests\unit\models\UserTest::testSomething(); + + tests\unit\models\UserTest::tearDown(); + + tests\unit\models\UserTest::_after(); + +tests\unit\models\UserTest::tearDownAfterClass(); +``` + +If you use special methods dont forget to call its parent. ```php * @since 2.0 */ -class TestCase extends \PHPUnit_Framework_TestCase +class TestCase extends Test { /** * @var array|string the application configuration that will be used for creating an application instance for each test. From a300b9d1bb6e64c76ea005e3435760bfcca8d538 Mon Sep 17 00:00:00 2001 From: Hisateru Tanaka Date: Wed, 25 Dec 2013 22:24:54 +0900 Subject: [PATCH 33/36] Gii should keep horizontal layout --- extensions/yii/gii/views/layouts/generator.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/extensions/yii/gii/views/layouts/generator.php b/extensions/yii/gii/views/layouts/generator.php index 245cd29..46afb1d 100644 --- a/extensions/yii/gii/views/layouts/generator.php +++ b/extensions/yii/gii/views/layouts/generator.php @@ -12,7 +12,7 @@ $activeGenerator = Yii::$app->controller->generator; ?> beginContent('@yii/gii/views/layouts/main.php'); ?>
    -
    +
    $generator) { @@ -24,7 +24,7 @@ $activeGenerator = Yii::$app->controller->generator; ?>
    -
    +
    From cfa25dd8986dd147963705ba4f73e41f14e748ce Mon Sep 17 00:00:00 2001 From: Hisateru Tanaka Date: Wed, 25 Dec 2013 22:54:12 +0900 Subject: [PATCH 34/36] Bootstrap's dropdown encodes also trailing caret tag --- extensions/yii/bootstrap/ButtonDropdown.php | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/extensions/yii/bootstrap/ButtonDropdown.php b/extensions/yii/bootstrap/ButtonDropdown.php index 095a93f..34d3ae2 100644 --- a/extensions/yii/bootstrap/ButtonDropdown.php +++ b/extensions/yii/bootstrap/ButtonDropdown.php @@ -75,6 +75,10 @@ class ButtonDropdown extends Widget protected function renderButton() { Html::addCssClass($this->options, 'btn'); + $label = $this->label; + if ($this->encodeLabel) { + $label = Html::encode($label); + } if ($this->split) { $options = $this->options; $this->options['data-toggle'] = 'dropdown'; @@ -85,7 +89,7 @@ class ButtonDropdown extends Widget 'options' => $this->options, ]); } else { - $this->label .= ' '; + $label .= ' '; $options = $this->options; if (!isset($options['href'])) { $options['href'] = '#'; @@ -96,9 +100,9 @@ class ButtonDropdown extends Widget } return Button::widget([ 'tagName' => $this->tagName, - 'label' => $this->label, + 'label' => $label, 'options' => $options, - 'encodeLabel' => $this->encodeLabel, + 'encodeLabel' => false, ]) . "\n" . $splitButton; } From 11ff78e4b4537df8f0069a7033720fd7976df0bb Mon Sep 17 00:00:00 2001 From: Hisateru Tanaka Date: Thu, 26 Dec 2013 00:28:15 +0900 Subject: [PATCH 35/36] Gii should keep horizontal layout --- extensions/yii/gii/views/default/view.php | 2 +- extensions/yii/gii/views/layouts/generator.php | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/extensions/yii/gii/views/default/view.php b/extensions/yii/gii/views/default/view.php index dabcf39..d600f83 100644 --- a/extensions/yii/gii/views/default/view.php +++ b/extensions/yii/gii/views/default/view.php @@ -33,7 +33,7 @@ foreach ($generator->templates as $name => $path) { 'fieldConfig' => ['class' => ActiveField::className()], ]); ?>
    -
    +
    renderFile($generator->formView(), [ 'generator' => $generator, 'form' => $form, diff --git a/extensions/yii/gii/views/layouts/generator.php b/extensions/yii/gii/views/layouts/generator.php index 46afb1d..d4c205a 100644 --- a/extensions/yii/gii/views/layouts/generator.php +++ b/extensions/yii/gii/views/layouts/generator.php @@ -12,7 +12,7 @@ $activeGenerator = Yii::$app->controller->generator; ?> beginContent('@yii/gii/views/layouts/main.php'); ?>
    -
    +
    $generator) { @@ -24,7 +24,7 @@ $activeGenerator = Yii::$app->controller->generator; ?>
    -
    +
    From dba7c02a2cd9ee459b580c0cfd91cc3560c21e40 Mon Sep 17 00:00:00 2001 From: Qiang Xue Date: Wed, 25 Dec 2013 11:55:47 -0500 Subject: [PATCH 36/36] Fixes #1610: `Html::activeCheckboxList()` and `Html::activeRadioList()` will submit an empty string if no checkbox/radio is selected --- framework/CHANGELOG.md | 3 ++- framework/yii/helpers/BaseHtml.php | 10 ++++++---- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/framework/CHANGELOG.md b/framework/CHANGELOG.md index d94011f..b6c56c6 100644 --- a/framework/CHANGELOG.md +++ b/framework/CHANGELOG.md @@ -32,7 +32,8 @@ Yii Framework 2 Change Log - Enh: Added `favicon.ico` and `robots.txt` to defauly application templates (samdark) - Enh: Added `Widget::autoIdPrefix` to support prefixing automatically generated widget IDs (qiangxue) - Enh: Support for file aliases in console command 'message' (omnilight) -- Enh: Sort and Paginiation can now create absolute URLs (cebe) +- Enh: Sort and Pagination can now create absolute URLs (cebe) +- Chg #1610: `Html::activeCheckboxList()` and `Html::activeRadioList()` will submit an empty string if no checkbox/radio is selected (qiangxue) - Chg: Renamed `yii\jui\Widget::clientEventsMap` to `clientEventMap` (qiangxue) - Chg: Renamed `ActiveRecord::getPopulatedRelations()` to `getRelatedRecords()` (qiangxue) - Chg: Renamed `attributeName` and `className` to `targetAttribute` and `targetClass` for `UniqueValidator` and `ExistValidator` (qiangxue) diff --git a/framework/yii/helpers/BaseHtml.php b/framework/yii/helpers/BaseHtml.php index 2cfcb15..49fe832 100644 --- a/framework/yii/helpers/BaseHtml.php +++ b/framework/yii/helpers/BaseHtml.php @@ -1281,7 +1281,8 @@ class BaseHtml * @param array $options options (name => config) for the checkbox list. The following options are specially handled: * * - unselect: string, the value that should be submitted when none of the checkboxes is selected. - * By setting this option, a hidden input will be generated. + * You may set this option to be null to prevent default value submission. + * If this option is not set, an empty string will be submitted. * - separator: string, the HTML code that separates items. * - item: callable, a callback that can be used to customize the generation of the HTML code * corresponding to a single item in $items. The signature of this callback must be: @@ -1300,7 +1301,7 @@ class BaseHtml $name = isset($options['name']) ? $options['name'] : static::getInputName($model, $attribute); $selection = static::getAttributeValue($model, $attribute); if (!array_key_exists('unselect', $options)) { - $options['unselect'] = '0'; + $options['unselect'] = ''; } if (!array_key_exists('id', $options)) { $options['id'] = static::getInputId($model, $attribute); @@ -1321,7 +1322,8 @@ class BaseHtml * @param array $options options (name => config) for the radio button list. The following options are specially handled: * * - unselect: string, the value that should be submitted when none of the radio buttons is selected. - * By setting this option, a hidden input will be generated. + * You may set this option to be null to prevent default value submission. + * If this option is not set, an empty string will be submitted. * - separator: string, the HTML code that separates items. * - item: callable, a callback that can be used to customize the generation of the HTML code * corresponding to a single item in $items. The signature of this callback must be: @@ -1340,7 +1342,7 @@ class BaseHtml $name = isset($options['name']) ? $options['name'] : static::getInputName($model, $attribute); $selection = static::getAttributeValue($model, $attribute); if (!array_key_exists('unselect', $options)) { - $options['unselect'] = '0'; + $options['unselect'] = ''; } if (!array_key_exists('id', $options)) { $options['id'] = static::getInputId($model, $attribute);