php/yii2
1
0
Fork 0
mirror of https://github.com/yiisoft/yii2.git synced 2025-08-26 14:26:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

guide wip [skip ci]

Browse Source
This commit is contained in:
Qiang Xue
2014-04-28 16:31:51 -04:00
parent fdefbc71c0
commit a25ed095da
2 changed files with 54 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

120
docs/guide/intro-upgrade-from-v1.md
View File

@ -1,9 +1,10 @@
Upgrading from Yii 1.1 Upgrading from Version 1.1
====================== ==========================
In this chapter, we list the major changes introduced in Yii 2.0 since version 1.1. Because Yii 2.0 is a complete rewrite of the framework, upgrading from version 1.1 is not trivial.
We hope this list will make it easier for you to upgrade from Yii 1.1 and quickly We recommend you read through this guide before performing the upgrade. In this chapter, we will
master Yii 2.0 based on your existing Yii knowledge. summarize the major differences between 1.1 and 2.0. We hope this will make it easier for you
to upgrade from Yii 1.1 and quickly master Yii 2.0 based on your existing Yii knowledge.
Namespace Namespace
@ -21,16 +22,14 @@ Component and Object
-------------------- --------------------
Yii 2.0 breaks the `CComponent` class in 1.1 into two classes: [[yii\base\Object]] and [[yii\base\Component]]. Yii 2.0 breaks the `CComponent` class in 1.1 into two classes: [[yii\base\Object]] and [[yii\base\Component]].
The [[yii\base\Object|Object]] class is a lightweight base class that allows defining class properties The [[yii\base\Object|Object]] class is a lightweight base class that allows defining [object properties](basic-properties.md)
via getters and setters. The [[yii\base\Component|Component]] class extends from [[yii\base\Object|Object]] and supports via getters and setters. The [[yii\base\Component|Component]] class extends from [[yii\base\Object|Object]] and supports
the event feature and the behavior feature. [events](basic-events.md) and [behaviors](basic-behaviors.md).
If your class does not need the event or behavior feature, you should consider using If your class does not need the event or behavior feature, you should consider using
`Object` as the base class. This is usually the case for classes that represent basic [[yii\base\Object|Object]] as the base class. This is usually the case for classes that represent basic
data structures. data structures.
More details about Object and component can be found in the [Basic concepts section](basics.md).
Object Configuration Object Configuration
-------------------- --------------------
@ -74,15 +73,22 @@ $object = Yii::createObject([
], [$param1, $param2]); ], [$param1, $param2]);
``` ```
More on configuration can be found in the [Basic concepts section](basics.md). More details about configurations can be found in the [Object Configurations](basic-configs.md) chapter.
Events Events
------ ------
There is no longer the need to define an `on`-method in order to define an event in Yii 2.0. There is no longer the need to define an `on`-method in order to define an event in Yii 2.0.
Instead, you can use whatever event names. To attach a handler to an event, you should now Instead, you can use whatever event names. You can trigger an event by calling
use the `on` method: the [[yii\base\Component::trigger()|trigger()]] method:
```php
$event = new \yii\base\Event;
$component->trigger($eventName, $event);
```
And to attach a handler to an event, you can use the [[yii\base\Component::on()|on()]] method:
```php ```php
$component->on($eventName, $handler); $component->on($eventName, $handler);
@ -90,45 +96,16 @@ $component->on($eventName, $handler);
// $component->off($eventName, $handler); // $component->off($eventName, $handler);
``` ```
There are many enhancements to the event features. For more details, please refer to the [Events](basic-events.md) chapter.
When you attach a handler, you can now associate it with some parameters which can be later
accessed via the event parameter by the handler:
```php
$component->on($eventName, $handler, $params);
```
Because of this change, you can now use "global" events. Simply trigger and attach handlers to Path Aliases
an event of the application instance: ------------
```php Yii 2.0 expands the usage of path aliases to both file/directory paths and URLs. It also requires
Yii::$app->on($eventName, $handler); an alias name to start with a `@` character so that it can be differentiated from normal file/directory paths and URLs.
....
// this will trigger the event and cause $handler to be invoked.
Yii::$app->trigger($eventName);
```
If you need to handle all instances of a class instead of the object you can attach a handler like the following:
```php
Event::on(ActiveRecord::className(), ActiveRecord::EVENT_AFTER_INSERT, function ($event) {
Yii::trace(get_class($event->sender) . ' is inserted.');
});
```
The code above defines a handler that will be triggered for every Active Record object's `EVENT_AFTER_INSERT` event.
See [Event handling section](events.md) for more details.
Path Alias
----------
Yii 2.0 expands the usage of path aliases to both file/directory paths and URLs. An alias
must start with a `@` character so that it can be differentiated from file/directory paths and URLs.
For example, the alias `@yii` refers to the Yii installation directory. Path aliases are For example, the alias `@yii` refers to the Yii installation directory. Path aliases are
supported in most places in the Yii core code. For example, `FileCache::cachePath` can take supported in most places in the Yii core code. For example, [[yii\caching\FileCache::cachePath]] can take
both a path alias and a normal directory path. both a path alias and a normal directory path.
Path alias is also closely related with class namespaces. It is recommended that a path Path alias is also closely related with class namespaces. It is recommended that a path
@ -138,11 +115,11 @@ a class like `yii\web\Request` can be autoloaded by Yii. If you use a third part
such as Zend Framework, you may define a path alias `@Zend` which refers to its installation such as Zend Framework, you may define a path alias `@Zend` which refers to its installation
directory and Yii will be able to autoload any class in this library. directory and Yii will be able to autoload any class in this library.
More on path aliases can be found in the [Basic concepts section](basics.md). More on path aliases can be found in the [Path Aliases](basic-aliases.md) chapter.
View Views
---- -----
Yii 2.0 introduces a [[yii\web\View|View]] class to represent the view part of the MVC pattern. Yii 2.0 introduces a [[yii\web\View|View]] class to represent the view part of the MVC pattern.
It can be configured globally through the "view" application component. It is also It can be configured globally through the "view" application component. It is also
@ -190,24 +167,30 @@ mainly used when using HTML forms to collect user inputs for a model. Previously
this is usually hardcoded as the class name of the model. this is usually hardcoded as the class name of the model.
New methods called [[yii\base\Model::load()|load()] and [[yii\base\Model::loadMultiple()|Model::loadMultiple()]] are New methods called [[yii\base\Model::load()|load()] and [[yii\base\Model::loadMultiple()|Model::loadMultiple()]] are
introduced to simplify the data population from user inputs to a model. For example, introduced to simplify the data population from user inputs to a model. For example, to populate a single model,
```php ```php
$model = new Post(); $model = new Post();
if ($model->load($_POST)) {...} if ($model->load($_POST)) {
// ...
}
// which is equivalent to: // which is equivalent to:
if (isset($_POST['Post'])) { if (isset($_POST['Post'])) {
$model->attributes = $_POST['Post']; $model->attributes = $_POST['Post'];
} }
```
$model->save(); and to populate multiple models (tabular inputs):
```php
$postTags = []; $postTags = [];
$tagsCount = count($_POST['PostTag']); $tagsCount = count($_POST['PostTag']);
while ($tagsCount-- > 0) { while ($tagsCount-- > 0) {
$postTags[] = new PostTag(['post_id' => $model->id]); $postTags[] = new PostTag(['post_id' => $model->id]);
} }
Model::loadMultiple($postTags, $_POST); \yii\base\Model::loadMultiple($postTags, $_POST);
``` ```
Yii 2.0 introduces a new method called [[yii\base\Model::scenarios()|scenarios()]] to declare which attributes require Yii 2.0 introduces a new method called [[yii\base\Model::scenarios()|scenarios()]] to declare which attributes require
@ -225,17 +208,16 @@ public function scenarios()
} }
``` ```
This method also determines which attributes are safe and which are not. In particular, This method also determines which attributes are safe and which are not. In particular,
given a scenario, if an attribute appears in the corresponding attribute list in [[yii\base\Model::scenarios()|scenarios()]] given a scenario, if an attribute appears in the corresponding attribute list in [[yii\base\Model::scenarios()|scenarios()]]
and the name is not prefixed with `!`, it is considered *safe*. and the name is not prefixed with `!`, it is considered *safe*.
Because of the above change, Yii 2.0 no longer has "unsafe" validator. Because of the above change, Yii 2.0 no longer has the "unsafe" validator.
If your model only has one scenario (very common), you do not have to overwrite [[yii\base\Model::scenarios()|scenarios()]], If your model only has one scenario (very common), you do not have to overwrite [[yii\base\Model::scenarios()|scenarios()]],
and everything will still work like the 1.1 way. and everything will still work like the 1.1 way.
To learn more about Yii 2.0 models refer to [Models](model.md) section of the guide. To learn more about Yii 2.0 models refer to the [Models](basic-models.md) chapter.
Controllers Controllers
@ -245,35 +227,33 @@ The [[yii\base\Controller::render()|render()]] and [[yii\base\Controller::render
now return the rendering results instead of directly sending them out. now return the rendering results instead of directly sending them out.
You have to `echo` them explicitly, e.g., `echo $this->render(...);`. You have to `echo` them explicitly, e.g., `echo $this->render(...);`.
To learn more about Yii 2.0 controllers refer to [Controller](controller.md) section of the guide. Please refer to the [Controllers](structure-controllers.md) chapter for more details.
Widgets Widgets
------- -------
Using a widget is more straightforward in 2.0. You mainly use the Using a widget is more straightforward in 2.0. You mainly use the
[[yii\base\Widget::begin()|begin()]], [[yii\base\Widget::begin()|begin()]], [[yii\base\Widget::end()|end()]] and [[yii\base\Widget::widget()|widget()]]
[[yii\base\Widget::end()|end()]] and
[[yii\base\Widget::widget()|widget()]]
methods of the [[yii\base\Widget|Widget]] class. For example, methods of the [[yii\base\Widget|Widget]] class. For example,
```php ```php
use yii\widgets\Menu;
use yii\widgets\ActiveForm;
// Note that you have to "echo" the result to display it // Note that you have to "echo" the result to display it
echo \yii\widgets\Menu::widget(['items' => $items]); echo Menu::widget(['items' => $items]);
// Passing an array to initialize the object properties // Passing an array to initialize the object properties
$form = \yii\widgets\ActiveForm::begin([ $form = ActiveForm::begin([
'options' => ['class' => 'form-horizontal'], 'options' => ['class' => 'form-horizontal'],
'fieldConfig' => ['inputOptions' => ['class' => 'input-xlarge']], 'fieldConfig' => ['inputOptions' => ['class' => 'input-xlarge']],
]); ]);
... form inputs here ... ... form input fields here ...
\yii\widgets\ActiveForm::end(); ActiveForm::end();
``` ```
Previously in 1.1, you would have to enter the widget class names as strings via the `beginWidget()`, Please refer to the [Widgets](structure-widgets.md) chapter for more details.
`endWidget()` and `widget()` methods of `CBaseController`. The approach above gets better IDE support.
For more on widgets see the [View section](view.md#widgets).
Themes Themes

8
docs/guide/intro-yii.md
View File

@ -3,7 +3,7 @@ What is Yii
Yii is a high performance, component-based PHP framework for rapidly developing modern Web applications. Yii is a high performance, component-based PHP framework for rapidly developing modern Web applications.
The name Yii (pronounced `Yee` or `[ji:]`) means simple and evolutionary in Chinese. It can also The name Yii (pronounced `Yee` or `[ji:]`) means simple and evolutionary in Chinese. It can also
be considered as the acronym for **Yes It Is!** be considered as the acronym for **Yes It Is**!
What is Yii Best for? What is Yii Best for?
@ -31,9 +31,9 @@ How does Yii Compare with Other Frameworks?
Yii is not a one-man show, it is backed up by a [strong core developer team][] as well as a large community Yii is not a one-man show, it is backed up by a [strong core developer team][] as well as a large community
with many professionals who are constantly contributing to the development of Yii. The Yii developer team with many professionals who are constantly contributing to the development of Yii. The Yii developer team
is keeping a close eye on the latest trends of Web development as well as the best practices and features is keeping a close eye on the latest trends of Web development and the best practices and features
found in other frameworks and projects. They are being wisely incorporated into the framework and exposed found in other frameworks and projects. They are being carefully incorporated into the core framework and exposed
under a simple and elegant interface. via simple and elegant interfaces.
[strong core developer team]: http://www.yiiframework.com/about/ [strong core developer team]: http://www.yiiframework.com/about/