Merge branch 'master' of https://github.com/yiisoft/yii2

docs/guide/caching.md

@@ -0,0 +1,3 @@
+Caching
+=======
+

docs/guide/error.md

@@ -0,0 +1,3 @@
+Error Handling
+==============
+

docs/guide/installation.md

@@ -25,8 +25,8 @@ http://hostname/path/to/yii/requirements/index.php
 ~~~
 
 Yii requires PHP 5.3, so the server must have PHP 5.3 or above installed and
-available to the web server.  Yii has been tested with [Apache HTTP server](http://httpd.apache.org/)
-on Windows and Linux.  It may also run on other Web servers and platforms,
+available to the web server. Yii has been tested with [Apache HTTP server](http://httpd.apache.org/)
+on Windows and Linux. It may also run on other Web servers and platforms,
 provided PHP 5.3 is supported.
 
 
@@ -34,7 +34,7 @@ Recommended Apache Configuration
 --------------------------------
 
 Yii is ready to work with a default Apache web server configuration.
-The `.htaccess` files in Yii framework and application folders restrict
+The `.htaccess` files in Yii framework and application folders deny
 access to the restricted resources. To hide the bootstrap file (usually `index.php`)
 in your URLs you can add `mod_rewrite` instructions to the `.htaccess` file
 in your document root or to the virtual host configuration:
@@ -63,7 +63,7 @@ server {
     access_log  /www/mysite/log/access.log  main;
 
     server_name  mysite;
-    root   $host_path/htdocs;
+    root  $host_path/htdocs;
     set $yii_bootstrap "index.php";
 
     charset utf-8;
@@ -108,4 +108,5 @@ server {
 }
 ~~~
 
-Using this configuration you can set `cgi.fix_pathinfo=0` in php.ini to avoid many unnecessary system stat() calls.
+Using this configuration you can set `cgi.fix_pathinfo=0` in php.ini to avoid
+many unnecessary system `stat()` calls.

docs/guide/migration.md

@@ -0,0 +1,3 @@
+Database Migration
+==================
+

docs/guide/mvc.md

@@ -11,7 +11,7 @@ the communication between the model and the view.
 
 Besides implementing MVC, Yii also introduces a front-controller, called
 `Application`, which encapsulates the execution context for the processing
-of a request.  Application collects some information about a user request and
+of a request. Application collects information about a user request and
 then dispatches it to an appropriate controller for further handling.
 
 The following diagram shows the static structure of a Yii application:
@@ -21,6 +21,7 @@ The following diagram shows the static structure of a Yii application:
 
 A Typical Workflow
 ------------------
+
 The following diagram shows a typical workflow of a Yii application when
 it is handling a user request:
 

docs/guide/performance.md

@@ -0,0 +1,181 @@
+Performance Tuning
+==================
+
+Application performance consists of two parts. First is the framework performance
+and the second is the application itself. Yii has a pretty low performance impact
+on your application out of the box and can be fine-tuned further for production
+environment. As for the application, we'll provide some of the best practices
+along with examples on how to apply them to Yii.
+
+Preparing framework for production
+----------------------------------
+
+### Disabling Debug Mode
+
+First thing you should do before deploying your application to production environment
+is to disable debug mode. A Yii application runs in debug mode if the constant
+`YII_DEBUG` is defined as `true` in `index.php` so to disable debug the following
+should be in your `index.php`:
+
+```php
+defined('YII_DEBUG') or define('YII_DEBUG', false);
+```
+
+Debug mode is very useful during development stage, but it would impact performance
+because some components cause extra burden in debug mode. For example, the message
+logger may record additional debug information for every message being logged.
+
+### Enabling PHP opcode cache
+
+Enabling the PHP opcode cache improves any PHP application performance and lowers
+memory usage significantly. Yii is no exception. It was tested with
+[APC PHP extension](http://php.net/manual/en/book.apc.php) that caches
+and optimizes PHP intermediate code and avoids the time spent in parsing PHP
+scripts for every incoming request.
+
+### Turning on ActiveRecord database schema caching
+
+If the application is using Active Record, we should turn on the schema caching
+to save the time of parsing database schema. This can be done by setting the
+`Connection::enableSchemaCache` property to be `true` via application configuration
+`protected/config/main.php`:
+
+```php
+return array(
+	// ...
+	'components' => array(
+		// ...
+		'db' => array(
+			'class' => 'yii\db\Connection',
+			'dsn' => 'mysql:host=localhost;dbname=mydatabase',
+			'username' => 'root',
+			'password' => '',
+			'enableSchemaCache' => true,
+
+			// Duration of schema cache.
+			// 'schemaCacheDuration' => 3600,
+
+			// Name of the cache component used. Default is 'cache'.
+			//'schemaCache' => 'cache',
+		),
+		'cache' => array(
+			'class' => 'yii\caching\FileCache',
+		),
+	),
+);
+```
+
+Note that `cache` application component should be configured.
+
+### Combining and Minimizing Assets
+
+TBD
+
+### Using better storage for sessions
+
+By default PHP uses files to handle sessions. It is OK for development and
+small projects but when it comes to handling concurrent requests it's better to
+switch to another storage such as database. You can do so by configuring your
+application via `protected/config/main.php`:
+
+```php
+return array(
+	// ...
+	'components' => array(
+		'session' => array(
+			'class' => 'yii\web\DbSession',
+
+			// Set the following if want to use DB component other than
+			// default 'db'.
+			// 'db' => 'mydb',
+
+			// To override default session table set the following
+			// 'sessionTable' => 'my_session',
+		),
+	),
+);
+```
+
+You can use `CacheSession` to store sessions using cache. Note that some
+cache storages such as memcached has no guaranteee that session data will not
+be lost leading to unexpected logouts.
+
+Improving application
+---------------------
+
+### Using Serverside Caching Techniques
+
+As described in the Caching section, Yii provides several caching solutions that
+may improve the performance of a Web application significantly. If the generation
+of some data takes long time, we can use the data caching approach to reduce the
+data generation frequency; If a portion of page remains relatively static, we
+can use the fragment caching approach to reduce its rendering frequency;
+If a whole page remains relative static, we can use the page caching approach to
+save the rendering cost for the whole page.
+
+
+### Leveraging HTTP to save procesing time and bandwidth
+
+TBD
+
+### Database Optimization
+
+Fetching data from database is often the main performance bottleneck in
+a Web application. Although using caching may alleviate the performance hit,
+it does not fully solve the problem. When the database contains enormous data
+and the cached data is invalid, fetching the latest data could be prohibitively
+expensive without proper database and query design.
+
+Design index wisely in a database. Indexing can make SELECT queries much faster,
+but it may slow down INSERT, UPDATE or DELETE queries.
+
+For complex queries, it is recommended to create a database view for it instead
+of issuing the queries inside the PHP code and asking DBMS to parse them repetitively.
+
+Do not overuse Active Record. Although Active Record is good at modelling data
+in an OOP fashion, it actually degrades performance due to the fact that it needs
+to create one or several objects to represent each row of query result. For data
+intensive applications, using DAO or database APIs at lower level could be
+a better choice.
+
+Last but not least, use LIMIT in your SELECT queries. This avoids fetching
+overwhelming data from database and exhausting the memory allocated to PHP.
+
+### Using asArray
+
+A good way to save memory and processing time on read-only pages is to use
+ActiveRecord's `asArray` method.
+
+```php
+class PostController extends Controller
+{
+	public function actionIndex()
+	{
+		$posts = Post::find()->orderBy('id DESC')->limit(100)->asArray()->all();
+		echo $this->render('index', array(
+			'posts' => $posts,
+		));
+	}
+}
+```
+
+In the view you should access fields of each invidual record from `$posts` as array:
+
+```php
+foreach($posts as $post) {
+	echo $post['title']."<br>";
+}
+```
+
+Note that you can use array notation even if `asArray` wasn't specified and you're
+working with AR objects.
+
+### Processing data in background
+
+In order to respond to user requests faster you can process heavy parts of the
+request later if there's no need for immediate response.
+
+- Cron jobs + console.
+- queues + handlers.
+
+TBD

docs/guide/template.md

@@ -0,0 +1,3 @@
+Template
+========
+

docs/guide/url.md

@@ -0,0 +1,3 @@
+URL Management
+==============
+

docs/view_renderers.md

@@ -27,6 +27,9 @@ array(
 )
 ```
 
+Note that Smarty and Twig are not bundled with Yii and you have to download and
+unpack these yourself and then specify `twigPath` and `smartyPath` respectively.
+
 Twig
 ----
 

framework/db/ActiveRelation.php

@@ -266,7 +266,7 @@ class ActiveRelation extends ActiveQuery
 	{
 		$attributes = array_keys($this->link);
 		$values = array();
-		if (count($attributes) ===1) {
+		if (count($attributes) === 1) {
 			// single key
 			$attribute = reset($this->link);
 			foreach ($models as $model) {

framework/db/Query.php

@@ -483,7 +483,7 @@ class Query extends \yii\base\Component
 	 * Sets the ORDER BY part of the query.
 	 * @param string|array $columns the columns (and the directions) to be ordered by.
 	 * Columns can be specified in either a string (e.g. "id ASC, name DESC") or an array
-	 * (e.g. `array('id' => Query::SORT_ASC ASC, 'name' => Query::SORT_DESC)`).
+	 * (e.g. `array('id' => Query::SORT_ASC, 'name' => Query::SORT_DESC)`).
 	 * The method will automatically quote the column names unless a column contains some parenthesis
 	 * (which means the column contains a DB expression).
 	 * @return Query the query object itself
@@ -499,7 +499,7 @@ class Query extends \yii\base\Component
 	 * Adds additional ORDER BY columns to the query.
 	 * @param string|array $columns the columns (and the directions) to be ordered by.
 	 * Columns can be specified in either a string (e.g. "id ASC, name DESC") or an array
-	 * (e.g. `array('id' => Query::SORT_ASC ASC, 'name' => Query::SORT_DESC)`).
+	 * (e.g. `array('id' => Query::SORT_ASC, 'name' => Query::SORT_DESC)`).
 	 * The method will automatically quote the column names unless a column contains some parenthesis
 	 * (which means the column contains a DB expression).
 	 * @return Query the query object itself

framework/helpers/base/VarDumper.php

@@ -116,7 +116,7 @@ class VarDumper
 				} elseif (self::$_depth <= $level) {
 					self::$_output .= get_class($var) . '(...)';
 				} else {
-					$id = self::$_objects[] = $var;
+					$id = array_push(self::$_objects, $var);
 					$className = get_class($var);
 					$members = (array)$var;
 					$spaces = str_repeat(' ', $level * 4);

tests/unit/framework/helpers/VarDumperTest.php

@@ -0,0 +1,12 @@
+<?php
+namespace yiiunit\framework\helpers;
+use \yii\helpers\VarDumper;
+
+class VarDumperTest extends \yii\test\TestCase
+{
+	public function testDumpObject()
+	{
+		$obj = new \StdClass();
+		VarDumper::dump($obj);
+	}
+}