From d8beaa648e5ec8e1aa7fe14513b47ba1ea2fb897 Mon Sep 17 00:00:00 2001 From: Alexander Makarov Date: Sat, 4 May 2013 23:23:29 +0400 Subject: [PATCH 1/8] added doc files --- docs/guide/active-record.md | 0 docs/guide/authentication.md | 0 docs/guide/authorization.md | 0 docs/guide/caching.md | 3 +++ docs/guide/console.md | 0 docs/guide/dao.md | 0 docs/guide/error.md | 3 +++ docs/guide/extension.md | 0 docs/guide/form.md | 0 docs/guide/gii.md | 0 docs/guide/i18n.md | 0 docs/guide/installation.md | 11 ++++++----- docs/guide/logging.md | 0 docs/guide/migration.md | 3 +++ docs/guide/mvc.md | 3 ++- docs/guide/performance.md | 0 docs/guide/query-builder.md | 0 docs/guide/security.md | 0 docs/guide/template.md | 0 docs/guide/testing.md | 0 docs/guide/theming.md | 0 docs/guide/upgrade.md | 0 docs/guide/url.md | 3 +++ docs/guide/validation.md | 0 24 files changed, 20 insertions(+), 6 deletions(-) create mode 100644 docs/guide/active-record.md create mode 100644 docs/guide/authentication.md create mode 100644 docs/guide/authorization.md create mode 100644 docs/guide/caching.md create mode 100644 docs/guide/console.md create mode 100644 docs/guide/dao.md create mode 100644 docs/guide/error.md create mode 100644 docs/guide/extension.md create mode 100644 docs/guide/form.md create mode 100644 docs/guide/gii.md create mode 100644 docs/guide/i18n.md create mode 100644 docs/guide/logging.md create mode 100644 docs/guide/migration.md create mode 100644 docs/guide/performance.md create mode 100644 docs/guide/query-builder.md create mode 100644 docs/guide/security.md create mode 100644 docs/guide/template.md create mode 100644 docs/guide/testing.md create mode 100644 docs/guide/theming.md create mode 100644 docs/guide/upgrade.md create mode 100644 docs/guide/url.md create mode 100644 docs/guide/validation.md diff --git a/docs/guide/active-record.md b/docs/guide/active-record.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/guide/authentication.md b/docs/guide/authentication.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/guide/authorization.md b/docs/guide/authorization.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/guide/caching.md b/docs/guide/caching.md new file mode 100644 index 0000000..cd945e7 --- /dev/null +++ b/docs/guide/caching.md @@ -0,0 +1,3 @@ +Caching +======= + diff --git a/docs/guide/console.md b/docs/guide/console.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/guide/dao.md b/docs/guide/dao.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/guide/error.md b/docs/guide/error.md new file mode 100644 index 0000000..c97fada --- /dev/null +++ b/docs/guide/error.md @@ -0,0 +1,3 @@ +Error Handling +============== + diff --git a/docs/guide/extension.md b/docs/guide/extension.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/guide/form.md b/docs/guide/form.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/guide/gii.md b/docs/guide/gii.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/guide/i18n.md b/docs/guide/i18n.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/guide/installation.md b/docs/guide/installation.md index 6cc5ef8..3f9a803 100644 --- a/docs/guide/installation.md +++ b/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. diff --git a/docs/guide/logging.md b/docs/guide/logging.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/guide/migration.md b/docs/guide/migration.md new file mode 100644 index 0000000..0fe2fb3 --- /dev/null +++ b/docs/guide/migration.md @@ -0,0 +1,3 @@ +Database Migration +================== + diff --git a/docs/guide/mvc.md b/docs/guide/mvc.md index 79140ce..a99d043 100644 --- a/docs/guide/mvc.md +++ b/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: diff --git a/docs/guide/performance.md b/docs/guide/performance.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/guide/query-builder.md b/docs/guide/query-builder.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/guide/security.md b/docs/guide/security.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/guide/template.md b/docs/guide/template.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/guide/testing.md b/docs/guide/testing.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/guide/theming.md b/docs/guide/theming.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/guide/upgrade.md b/docs/guide/upgrade.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/guide/url.md b/docs/guide/url.md new file mode 100644 index 0000000..46bb177 --- /dev/null +++ b/docs/guide/url.md @@ -0,0 +1,3 @@ +URL Management +============== + diff --git a/docs/guide/validation.md b/docs/guide/validation.md new file mode 100644 index 0000000..e69de29 From 1a317ebe313252c08fcbf3f89388b06414975d0f Mon Sep 17 00:00:00 2001 From: Rinat Silnov Date: Sat, 4 May 2013 23:54:59 +0400 Subject: [PATCH 2/8] Fixed VarDumper::dump for objects Otherwise it throws an exception that "Object of class ClassName could not be converted to string" --- framework/helpers/base/VarDumper.php | 2 +- tests/unit/framework/helpers/VarDumperTest.php | 12 ++++++++++++ 2 files changed, 13 insertions(+), 1 deletion(-) create mode 100644 tests/unit/framework/helpers/VarDumperTest.php diff --git a/framework/helpers/base/VarDumper.php b/framework/helpers/base/VarDumper.php index fe15d98..43b0cd8 100644 --- a/framework/helpers/base/VarDumper.php +++ b/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); diff --git a/tests/unit/framework/helpers/VarDumperTest.php b/tests/unit/framework/helpers/VarDumperTest.php new file mode 100644 index 0000000..8757588 --- /dev/null +++ b/tests/unit/framework/helpers/VarDumperTest.php @@ -0,0 +1,12 @@ + Date: Sun, 5 May 2013 00:02:14 +0400 Subject: [PATCH 3/8] started performance section of the guide --- docs/guide/performance.md | 100 ++++++++++++++++++++++++++++++++++++++++++++++ docs/guide/template.md | 3 ++ 2 files changed, 103 insertions(+) diff --git a/docs/guide/performance.md b/docs/guide/performance.md index e69de29..a480a0b 100644 --- a/docs/guide/performance.md +++ b/docs/guide/performance.md @@ -0,0 +1,100 @@ +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`. Debug mode is 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. Yii is no exception. It was tested with APC extension 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 + +``` + +### Combining and Minimizing Assets + + +### Using better storage for sessions + +By default PHP uses plain 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 +``` + + +Improving application +--------------------- + +### Using 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. + + +### 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 + +### 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. \ No newline at end of file diff --git a/docs/guide/template.md b/docs/guide/template.md index e69de29..dc83d15 100644 --- a/docs/guide/template.md +++ b/docs/guide/template.md @@ -0,0 +1,3 @@ +Template +======== + From 958aeb76b6c866615a2f428b3c60e1e8d768845f Mon Sep 17 00:00:00 2001 From: Alexander Makarov Date: Sun, 5 May 2013 00:26:18 +0400 Subject: [PATCH 4/8] more on performance tuning --- docs/guide/performance.md | 82 +++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 72 insertions(+), 10 deletions(-) diff --git a/docs/guide/performance.md b/docs/guide/performance.md index a480a0b..58e8258 100644 --- a/docs/guide/performance.md +++ b/docs/guide/performance.md @@ -14,15 +14,22 @@ Preparing framework for production 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`. Debug mode is 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. +`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. Yii is no exception. It was tested with APC extension that caches +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. @@ -34,28 +41,69 @@ to save the time of parsing database schema. This can be done by setting the `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 plain files to handle sessions. It is OK for development and +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 Caching Techniques +### 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 @@ -66,6 +114,10 @@ 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 @@ -91,10 +143,20 @@ 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 +``` + +TBD + ### 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. \ No newline at end of file +- queues + handlers. + +TBD \ No newline at end of file From 03cd47aed94512ddc117815bcca631c1a5763807 Mon Sep 17 00:00:00 2001 From: Alexander Makarov Date: Sun, 5 May 2013 01:26:40 +0400 Subject: [PATCH 5/8] phpdoc typos --- framework/db/Query.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/framework/db/Query.php b/framework/db/Query.php index 2239f5d..6f76265 100644 --- a/framework/db/Query.php +++ b/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 From a948e7387231ee49d0664c114c40a9cce7b41eb8 Mon Sep 17 00:00:00 2001 From: Alexander Makarov Date: Sun, 5 May 2013 01:27:13 +0400 Subject: [PATCH 6/8] example for using asArray --- docs/guide/performance.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/docs/guide/performance.md b/docs/guide/performance.md index 58e8258..9a871dc 100644 --- a/docs/guide/performance.md +++ b/docs/guide/performance.md @@ -147,9 +147,28 @@ 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, + )); + } +} ``` -TBD +In the view you should access fields of each invidual record from `$posts` as array: + +```php +foreach($posts as $post) { + echo $post['title']."
"; +} +``` + +Note that you can use array notation even if `asArray` wasn't specified and you're +working with AR objects. ### Processing data in background From f3286df32880b46ec117d2eab8c5d783eec64952 Mon Sep 17 00:00:00 2001 From: Alexander Makarov Date: Sun, 5 May 2013 01:44:34 +0400 Subject: [PATCH 7/8] Fixes #76 --- docs/view_renderers.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/view_renderers.md b/docs/view_renderers.md index 1d88d21..e26fe83 100644 --- a/docs/view_renderers.md +++ b/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 ---- From ddf67f0833d96d16a4f01667c1237d51558fa481 Mon Sep 17 00:00:00 2001 From: Alexander Kochetov Date: Sun, 5 May 2013 03:18:37 +0400 Subject: [PATCH 8/8] Code style fix --- framework/db/ActiveRelation.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/framework/db/ActiveRelation.php b/framework/db/ActiveRelation.php index f1b198b..97e2a8c 100644 --- a/framework/db/ActiveRelation.php +++ b/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) {