Yii Framework

https://github.com/yiisoft/yii
Admin
Yii Framework is an open-source PHP framework designed for rapid development of modern web...
Tokens:602,420
Snippets:4,204
Trust Score:9.6
License:BSD-3-Clause
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Example URL in get format

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/topics.url.txt

This is an example of a URL in the default 'get' format, where parameters appear in the query string. It is not user-friendly due to non-word characters.

```text
/index.php?r=post/read&id=100
```

--------------------------------

### Example URL in path format

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/topics.url.txt

This is an example of a URL in the 'path' format, which eliminates the query string and puts GET parameters into the path info part. It is cleaner and more self-explanatory.

```text
/index.php/post/read/id/100
```

--------------------------------

### Example console command class with actions

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/topics.console.txt

Example command class defining index and init actions.

```php
class SitemapCommand extends CConsoleCommand
{
    public function actionIndex($type, $limit=5) { ... }
    public function actionInit() { ... }
}
```

--------------------------------

### Generate translation reports for Guide, Blog, and framework views

Source: https://github.com/yiisoft/yii/wiki/Documentation-translation-guidelines

Run these commands to check if your translation is up to date and get info about what should be updated. The example is for Russian translation. After running, you'll have three reports; do not push them into your repository. Ensure git is installed and added to PATH.

```shell
build translations report --sourcePath="../docs/guide" --translationPath="../docs/guide/ru" --title="Russian guide translation report" > report_guide_ru.html
```

```shell
build translations report --sourcePath="../docs/blog" --translationPath="../docs/blog/ru" --title="Russian blog translation report" > report_blog_ru.html
```

```shell
build translations report --sourcePath="../framework/views" --translationPath="../framework/views/ru" --title="Russian framework views translation report" > report_views_ru.html
```

--------------------------------

### Accessing Component Properties

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/basics.component.txt

Shows how to read and write a component property using the property access syntax. The example gets 'textWidth' and sets 'enableCaching'.

```php
$width=$component->textWidth;     // get the textWidth property
$component->enableCaching=true;   // set the enableCaching property
```

--------------------------------

### Query examples with USE INDEX in joinOptions

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.arr.txt

Shows how to use 'joinOptions' in relation definitions to add USE INDEX clauses for query optimization. Includes three findAll examples with different joinOptions configurations.

```php
$users=User::model()->findAll(array(
	'select'=>'t.id,t.name',
	'with'=>array(
		'posts'=>array(
			'alias'=>'p',
			'select'=>'p.id,p.title',
			'joinOptions'=>'USE INDEX(post__user)',
		),
	),
));

$posts=Post::model()->findAll(array(
	'select'=>'t.id,t.title',
	'with'=>array(
		'tags'=>array(
			'alias'=>'a',
			'select'=>'a.id,a.name',
			'joinOptions'=>'USE INDEX(post_tag__tag) USE INDEX(post_tag__post)',
		),
	),
));

$posts=Post::model()->findAll(array(
	'select'=>'t.id,t.title',
	'with'=>array(
		'tags'=>array(
			'alias'=>'a',
			'select'=>'a.id,a.name',
			'joinOptions'=>array(
				'USE INDEX(post_tag__tag) USE INDEX(post_tag__post)',
				'USE INDEX(tag__name)',
			),
		),
	),
));
```

--------------------------------

### createIndex() example

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.query-builder.txt

Creates an index on a single column. The example shows the generated SQL comment and the method call.

```php
// CREATE INDEX `idx_username` ON `tbl_user` (`username`)
createIndex('idx_username', 'tbl_user', 'username')
```

--------------------------------

### Usage examples for HAS_MANY through

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.arr.txt

Shows how to use the relations defined with 'through' to fetch groups with users, roles, and comments. Includes examples for finding all groups with users, all groups with users and roles, and getting users/roles/comments for a specific group.

```php
// get all groups with all users
$groups=Group::model()->with('users')->findAll();

// get all groups with all corresponding users and roles
$groups=Group::model()->with('roles','users')->findAll();

// get all users and roles where group ID is 1
$group=Group::model()->findByPk(1);
$users=$group->users;
$roles=$group->roles;

// get all comments where group ID is 1
$group=Group::model()->findByPk(1);
$comments=$group->comments;
```

--------------------------------

### URL rule set example

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/topics.url.txt

Example rule set with three rules for posts and post reading. Demonstrates how rules map routes and parameters to URLs.

```php
array(
	'posts'=>'post/list',
	'post/<id:\d+>'=>'post/read',
	'post/<year:\d{4}>/<title>'=>'post/read',
)
```

--------------------------------

### join() usage examples

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.query-builder.txt

Examples of using join() and leftJoin(). The join condition syntax is the same as where(). Each join call appends to previous ones.

```php
// JOIN `tbl_profile` ON user_id=id
join('tbl_profile', 'user_id=id')
// LEFT JOIN `pub`.`tbl_profile` `p` ON p.user_id=id AND type=1
leftJoin('pub.tbl_profile p', 'p.user_id=id AND type=:type', array(':type'=>1))
```

--------------------------------

### Access the Guide online for testing translations

Source: https://github.com/yiisoft/yii/wiki/Documentation-translation-guidelines

Use this URL to access the Guide via the included application for testing translations. Point your webserver root to the docs directory first.

```url
http://hostname/index.php?r=guide
```

--------------------------------

### Create table example with abstract types

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.query-builder.txt

Example of creating a table named tbl_user with columns id, username, and location. Uses abstract types 'pk', 'string', and 'point', and appends 'ENGINE=InnoDB' as options. The generated SQL is shown in comments.

```php
// CREATE TABLE `tbl_user` (
//     `id` int(11) NOT NULL AUTO_INCREMENT PRIMARY KEY,
//     `username` varchar(255) NOT NULL,
//     `location` point
// ) ENGINE=InnoDB
createTable('tbl_user', array(
	'id' => 'pk',
	'username' => 'string NOT NULL',
	'location' => 'point',
), 'ENGINE=InnoDB')
```

--------------------------------

### limit() and offset() usage examples

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.query-builder.txt

Examples of using limit() and offset() to set LIMIT and OFFSET clauses. The examples show limit(10), limit(10, 20), and offset(20).

```php
// LIMIT 10
limit(10)
// LIMIT 10 OFFSET 20
limit(10, 20)
// OFFSET 20
offset(20)
```

--------------------------------

### insert() example

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.query-builder.txt

Builds and executes an INSERT statement with parameter binding for the values.

```php
// build and execute the following SQL:
// INSERT INTO `tbl_user` (`name`, `email`) VALUES (:name, :email)
$command->insert('tbl_user', array(
	'name'=>'Tester',
	'email'=>'tester@example.com',
));
```

--------------------------------

### from() usage examples

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.query-builder.txt

Examples of using from() with various table specifications: string, array, schema prefixes, aliases, and sub-queries. The comments show the resulting SQL.

```php
// FROM `tbl_user`
from('tbl_user')
// FROM `tbl_user` `u`, `public`.`tbl_profile` `p`
from('tbl_user u, public.tbl_profile p')
// FROM `tbl_user`, `tbl_profile`
from(array('tbl_user', 'tbl_profile'))
// FROM `tbl_user`, (select * from tbl_profile) p
from(array('tbl_user', '(select * from tbl_profile) p'))
```

--------------------------------

### Migration example creating a news table

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.migration.txt

Example migration that creates a news table with id, title, and content columns. The down() method drops the table to revert the migration.

```php
class m101129_185401_create_news_table extends CDbMigration
{
	public function up()
	{
		$this->createTable('tbl_news', array(
			'id' => 'pk',
			'title' => 'string NOT NULL',
			'content' => 'text',
		));
	}

	public function down()
	{
		$this->dropTable('tbl_news');
	}
}
```

--------------------------------

### select() usage examples

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.query-builder.txt

Examples of using select() with various column specifications: string, array, aliases, and DB expressions. The comments show the resulting SQL.

```php
// SELECT *
select()
// SELECT `id`, `username`
select('id, username')
// SELECT `tbl_user`.`id`, `username` AS `name`
select('tbl_user.id, username as name')
// SELECT `id`, `username`
select(array('id', 'username'))
// SELECT `id`, count(*) as num
select(array('id', 'count(*) as num'))
```

--------------------------------

### where() usage examples

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.query-builder.txt

Multiple examples of using where() with different operators: string conditions, parameter binding, and/or, in, not in, like, not like, or like, or not like. Each example shows the generated SQL condition.

```php
// WHERE id=1 or id=2
where('id=1 or id=2')
// WHERE id=:id1 or id=:id2
where('id=:id1 or id=:id2', array(':id1'=>1, ':id2'=>2))
// WHERE id=1 OR id=2
where(array('or', 'id=1', 'id=2'))
// WHERE id=1 AND (type=2 OR type=3)
where(array('and', 'id=1', array('or', 'type=2', 'type=3')))
// WHERE `id` IN (1, 2)
where(array('in', 'id', array(1, 2))
// WHERE `id` NOT IN (1, 2)
where(array('not in', 'id', array(1,2)))
// WHERE `name` LIKE '%Qiang%'
where(array('like', 'name', '%Qiang%'))
// WHERE `name` LIKE '%Qiang' AND `name` LIKE '%Xue'
where(array('like', 'name', array('%Qiang', '%Xue')))
// WHERE `name` LIKE '%Qiang' OR `name` LIKE '%Xue'
where(array('or like', 'name', array('%Qiang', '%Xue')))
// WHERE `name` NOT LIKE '%Qiang%'
where(array('not like', 'name', '%Qiang%'))
// WHERE `name` NOT LIKE '%Qiang%' OR `name` NOT LIKE '%Xue%'
where(array('or not like', 'name', array('%Qiang%', '%Xue%')))
```

--------------------------------

### Filter class example

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/basics.controller.txt

Shows how to define a filter as a class extending CFilter, with preFilter and postFilter methods.

```php
class PerformanceFilter extends CFilter
{
	protected function preFilter($filterChain)
	{
		// logic being applied before the action is executed
		return true; // false if the action should not be executed
	}

	protected function postFilter($filterChain)
	{
		// logic being applied after the action is executed
	}
}
```

--------------------------------

### update() example

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.query-builder.txt

Builds and executes an UPDATE statement with parameter binding for the WHERE clause.

```php
// build and execute the following SQL:
// UPDATE `tbl_user` SET `name`=:name WHERE id=:id
$command->update('tbl_user', array(
	'name'=>'Tester',
), 'id=:id', array(':id'=>1));
```

--------------------------------

### delete() example

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.query-builder.txt

Builds and executes a DELETE statement with parameter binding for the WHERE clause.

```php
// build and execute the following SQL:
// DELETE FROM `tbl_user` WHERE id=:id
$command->delete('tbl_user', 'id=:id', array(':id'=>1));
```

--------------------------------

### addForeignKey example

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.query-builder.txt

Adds a foreign key constraint. Parameters include $name, $table, $columns, $refTable, $refColumns, $delete, and $update. The example shows the SQL comment and the method call.

```php
// ALTER TABLE `tbl_profile` ADD CONSTRAINT `fk_profile_user_id`
// FOREIGN KEY (`user_id`) REFERENCES `tbl_user` (`id`)
// ON DELETE CASCADE ON UPDATE CASCADE
addForeignKey('fk_profile_user_id', 'tbl_profile', 'user_id',
	'tbl_user', 'id', 'CASCADE', 'CASCADE')
```

--------------------------------

### Executing a query with queryAll()

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.query-builder.txt

Example of executing a query built with the query builder using queryAll(). This retrieves all rows from the tbl_user table.

```php
$users = Yii::app()->db->createCommand()
	->select('*')
	->from('tbl_user')
	->queryAll();
```

--------------------------------

### Class constants example

Source: https://github.com/yiisoft/yii/wiki/Core-framework-code-style

Shows the required all-uppercase with underscore separators for class constants, as used in Yii core classes.

```php
<?php
class Foo
{
    const VERSION='1.0';
    const DATE_APPROVED='2012-06-01';
}
```

--------------------------------

### Create a CDbCommand instance

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.query-builder.txt

Creates a new CDbCommand instance using the DB connection. This is the starting point for building queries with the Query Builder.

```php
$command = Yii::app()->db->createCommand();
```

--------------------------------

### SQL to create the tbl_post table

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.ar.txt

Defines the database table used in the examples. For MySQL, replace AUTOINCREMENT with AUTO_INCREMENT.

```sql
CREATE TABLE tbl_post (
	id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
	title VARCHAR(128) NOT NULL,
	content TEXT NOT NULL,
	create_time INTEGER NOT NULL
);
```

--------------------------------

### Configuring widget properties with initial values

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/basics.view.txt

This example shows how to configure a widget by passing an array of initial property values. The array keys are property names and values are the initial values.

```php
<?php
$this->widget('CMaskedTextField',array(
	'mask'=>'99/99/9999'
));
?>
```

--------------------------------

### Access the Blog tutorial online for testing translations

Source: https://github.com/yiisoft/yii/wiki/Documentation-translation-guidelines

Use this URL to access the Blog tutorial via the included application for testing translations. Point your webserver root to the docs directory first.

```url
http://hostname/index.php?r=blog
```

--------------------------------

### Usage example for self-referencing through relation

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.arr.txt

Shows how to retrieve all students taught by a specific teacher using the 'students' relation defined in the User model.

```php
// get all students taught by teacher whose ID is 1
$teacher=User::model()->findByPk(1);
$students=$teacher->students;
```

--------------------------------

### Usage example for HAS_ONE through

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.arr.txt

Shows how to use the 'address' relation defined with 'through' to get the address of a user with ID 1.

```php
// get address of a user whose ID is 1
$user=User::model()->findByPk(1);
$address=$user->address;
```

--------------------------------

### Enter console directory and show help

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/topics.console.txt

Navigate to the protected directory and display a list of available console commands.

```bash
cd protected
yiic help
```

--------------------------------

### Layout view with header and footer

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/basics.view.txt

This is an example of a layout view that contains common UI parts. The $content variable holds the rendering result of the view that is being decorated.

```php
......header here......
<?php echo $content; ?>
......footer here......
```

--------------------------------

### Create web application with configuration file

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/basics.application.txt

Pass the configuration file name to Yii::createWebApplication() to create the application instance. Usually done in the entry script.

```php
$app=Yii::createWebApplication($configFile);
```

--------------------------------

### HAS_ONE through example

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.arr.txt

Defines a User model with a 'profile' relation and an 'address' relation that uses 'through' to get the address via the profile. This allows accessing $user->address directly.

```php
class User extends CActiveRecord
{
	...
	public function relations()
	{
		return array(
			'profile'=>array(self::HAS_ONE,'Profile','user_id'),
			'address'=>array(
				self::HAS_ONE,'Address',array('id'=>'profile_id'),
					'through'=>'profile'
			),
		);
	}
}
```

--------------------------------

### URL rule with pattern as array element

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/topics.url.txt

Starting from version 1.1.7, a rule can be specified with the pattern as an array element, allowing multiple rules with the same pattern. This example shows the format.

```php
array('route1', 'pattern'=>'pattern1', 'urlSuffix'=>'.xml', 'caseSensitive'=>false)
```

--------------------------------

### Relational query without selecting related models

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.arr.txt

Use with() with select=>false and a join condition to filter by related models without loading them. This example gets users who have published posts.

```php
$users=User::model()->with(array(
	'posts'=>array(
		// we don't want to select posts
		'select'=>false,
		// but want to get only users with published posts
		'joinType'=>'INNER JOIN',
		'condition'=>'posts.published=1',
	),
))->findAll();
```

--------------------------------

### Create skeleton application with yiic

Source: https://github.com/yiisoft/yii/blob/master/docs/blog/start.testdrive.txt

Command to create a skeleton application under /wwwroot/blog. The output shows the prompt and confirmation.

```bash
% /wwwroot/yii/framework/yiic webapp /wwwroot/blog
Create a Web application under '/wwwroot/blog'? [Yes|No]y
......
```

--------------------------------

### Migration using safeUp() and safeDown()

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.migration.txt

Shows the recommended way to get transaction support by implementing safeUp() and safeDown() instead of up() and down(). Yii automatically starts a transaction and rolls back on error.

```php
class m101129_185401_create_news_table extends CDbMigration
{
	public function safeUp()
	{
		$this->createTable('tbl_news', array(
			'id' => 'pk',
			'title' => 'string NOT NULL',
			'content' => 'text',
		));
	}

	public function safeDown()
	{
		$this->dropTable('tbl_news');
	}
}
```

--------------------------------

### Install Gii module in main.php config

Source: https://github.com/yiisoft/yii/blob/master/docs/blog/prototype.scaffold.txt

Add this configuration to /wwwroot/blog/protected/config/main.php to enable the Gii module. It sets a password for accessing the module. Remove this code on production machines; only use it on development machines.

```php
return array(
	......
	'import'=>array(
		'application.models.*',
		'application.components.*',
	),

	'modules'=>array(
		'gii'=>array(
			'class'=>'system.gii.GiiModule',
			'password'=>'pick up a password here',
		),
	),
);
```

--------------------------------

### Example theme directory structure

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/topics.theming.txt

Shows the directory organization for an application with two themes, basic and fancy. Each theme contains views, layouts, and site views mirroring the application's view structure.

```text
WebRoot/
	assets
	protected/
		.htaccess
		components/
		controllers/
		models/
		views/
			layouts/
				main.php
			site/
				index.php
	themes/
		basic/
			views/
				.htaccess
				layouts/
					main.php
				site/
					index.php
		fancy/
			views/
				.htaccess
				layouts/
					main.php
				site/
					index.php
```

--------------------------------

### Translate blockquote tokens in Guide and Blog

Source: https://github.com/yiisoft/yii/wiki/Documentation-translation-guidelines

Do not translate the tokens like '> Note:' or '> Tip:'. Instead, append the translation of the token word and use '|' as the separator. The example shows the format for 'note' and 'tip'.

```markdown
> Note|translation for 'note': ....


> Tip|translation for 'tip': ......
```

--------------------------------

### dropIndex() example

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.query-builder.txt

Drops an index. The example shows the generated SQL comment and the method call.

```php
// DROP INDEX `idx_username` ON `tbl_user`
dropIndex('idx_username', 'tbl_user')
```

--------------------------------

### Configure db component for SQLite in main.php

Source: https://github.com/yiisoft/yii/blob/master/docs/blog/prototype.database.txt

Use this configuration in /wwwroot/blog/protected/config/main.php to set up the 'db' component with a SQLite connection string and a table prefix. The 'tablePrefix' property enables the use of {{post}} tokens in SQL statements, which are translated to tbl_post.

```php
return array(
	......
	'components'=>array(
		......
		'db'=>array(
			'connectionString'=>'sqlite:/wwwroot/blog/protected/data/blog.db',
			'tablePrefix'=>'tbl_',
		),
	),
	......
);
```

--------------------------------

### having() usage examples

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.query-builder.txt

Examples of using having() with a string condition and an array condition. The array form uses the 'or' operator.

```php
// HAVING id=1 or id=2
having('id=1 or id=2')
// HAVING id=1 OR id=2
having(array('or', 'id=1', 'id=2'))
```

--------------------------------

### selectDistinct() example

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.query-builder.txt

Example of using selectDistinct() with 'id, username' which generates the SQL: SELECT DISTINCT `id`, `username`.

```php
SELECT DISTINCT `id`, `username`
```

--------------------------------

### Using transactions with beginTransaction, commit, and rollback

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.dao.txt

Shows the recommended transaction workflow: begin a transaction, execute queries, commit on success, and rollback on exception. Updates are not visible to the outside world until commit. The catch block rolls back the transaction if any query fails.

```php
$transaction=$connection->beginTransaction();
try
{
	$connection->createCommand($sql1)->execute();
	$connection->createCommand($sql2)->execute();
	//.... other SQL executions
	$transaction->commit();
}
catch(Exception $e) // an exception is raised if a query fails
{
	$transaction->rollback();
}
```

--------------------------------

### dropForeignKey example

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.query-builder.txt

Drops a foreign key constraint. The $name and $table parameters are used. The example shows the method call.

```php
dropForeignKey('fk_profile_user_id', 'tbl_profile')
```

--------------------------------

### truncateTable example

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.query-builder.txt

Truncates a table. The $table parameter is quoted properly. The example shows the SQL comment and the method call.

```php
// TRUNCATE TABLE `tbl_user`
truncateTable('tbl_user')
```

--------------------------------

### Login and logout actions using UserIdentity

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/topics.auth.txt

Shows how to create a UserIdentity with submitted credentials, call authenticate(), and log the user in via Yii::app()->user->login() on success or display the error message on failure. Also demonstrates logging out with Yii::app()->user->logout().

```php
// Login a user with the provided username and password.
$identity=new UserIdentity($username,$password);
if($identity->authenticate())
	Yii::app()->user->login($identity);
else
	echo $identity->errorMessage;
......
// Logout the current user
Yii::app()->user->logout();
```

--------------------------------

### Run migrate with command line options

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.migration.txt

Execute the migrate command with options specified in the format --option=value. Boolean options like interactive require 1 or 0.

```bash
yiic migrate up --option1=value1 --option2=value2 ...
```

```bash
yiic migrate up --migrationPath=ext.forum.migrations
```

```bash
yiic migrate --interactive=0
```

--------------------------------

### dropTable example

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.query-builder.txt

Drops a table. The $table parameter is quoted properly. The example shows the SQL comment and the method call.

```php
// DROP TABLE `tbl_user`
dropTable('tbl_user')
```

--------------------------------

### group() usage examples

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.query-builder.txt

Examples of using group() with a string and an array. Column names are quoted unless they contain parentheses.

```php
// GROUP BY `name`, `id`
group('name, id')
// GROUP BY `tbl_profile`.`name`, `id`
group(array('tbl_profile.name', 'id'))
```

--------------------------------

### Massive Assignment in Login and Register Scenarios

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/form.model.txt

Shows how to perform massive assignment in login and register scenarios using the User model.

```php
// in login scenario
$model=new User('login');
if(isset($_POST['User']))
	$model->attributes=$_POST['User'];

// in register scenario
$model=new User('register');
if(isset($_POST['User']))
	$model->attributes=$_POST['User'];
```

--------------------------------

### Rename table example

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.query-builder.txt

Example of renaming table tbl_users to tbl_user. The comment shows the generated SQL: RENAME TABLE `tbl_users` TO `tbl_user`.

```php
// RENAME TABLE `tbl_users` TO `tbl_user`
renameTable('tbl_users', 'tbl_user')
```

--------------------------------

### union() usage example

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.query-builder.txt

Example of using union() to append a SELECT statement. Calling union() multiple times appends multiple SQLs.

```php
// UNION (select * from tbl_profile)
union('select * from tbl_profile')
```

--------------------------------

### Cache tag example: profile fragment

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/topics.prado.txt

Example of a cache tag with a duration property, and the corresponding translated PHP code using beginCache and endCache.

```php
<cache:profile duration={3600}>
	// user profile information here
</cache:profile >
```

```php
<?php if($this->beginCache('profile', array('duration'=>3600))): ?>
	// user profile information here
<?php $this->endCache(); endif; ?>
```

--------------------------------

### dropColumn example

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.query-builder.txt

Drops a column from a table. The $table and $column parameters are used; both names are quoted. The example shows the SQL comment and the method call.

```php
// ALTER TABLE `tbl_user` DROP COLUMN `location`
dropColumn('tbl_user', 'location')
```

--------------------------------

### Using Component with Getters and Setters

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/basics.component.txt

Demonstrates usage of the component defined with getters and setters: reading/writing textWidth, reading textHeight, and writing completed.

```php
$document=new Document();

// we can write and read textWidth
$document->textWidth=100;
echo $document->textWidth;

// we can only read textHeight
echo $document->textHeight;

// we can only write completed
$document->completed=true;
```

--------------------------------

### Predefined Validator Usage Examples

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/form.model.txt

Examples of using predefined validators in Yii validation rules, including required, length, compare, and authenticate validators.

```php
// username is required
array('username', 'required'),
// username must be between 3 and 12 characters
array('username', 'length', 'min'=>3, 'max'=>12),
// when in register scenario, password must match password2
array('password', 'compare', 'compareAttribute'=>'password2', 'on'=>'register'),
// when in login scenario, password must be authenticated
array('password', 'authenticate', 'on'=>'login'),
```

--------------------------------

### Enable asset symlinking in main.php config

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/topics.performance.txt

Configures the 'assetManager' component with 'linkAssets' => true to use symbolic links instead of file copies, improving performance. Place in 'protected/config/main.php'.

```php
return array(
	// ...
	'components' => array(
		// ...
		'assetManager' => array(
			'linkAssets' => true,
		),
	),
);
```

--------------------------------

### Component tag example: CCaptcha widget

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/topics.prado.txt

Example of a component tag for the CCaptcha widget. The showRefreshButton property uses {false} to denote a boolean false, not a string.

```php
<com:CCaptcha captchaAction="captcha" showRefreshButton={false} />
```

```php
<?php $this->widget('CCaptcha', array(
	'captchaAction'=>'captcha',
	'showRefreshButton'=>false)); ?>
```

--------------------------------

### Fixture data for Post table in Post.php

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/test.fixture.txt

Example fixture file for the 'Post' table, returning an array of rows with aliases 'sample1' and 'sample2'. The 'id' column is omitted because it is auto-incremental.

```php
<?php
return array(
	'sample1'=>array(
		'title'=>'test post 1',
		'content'=>'test post content 1',
		'createTime'=>1230952187,
		'authorId'=>1,
	),
	'sample2'=>array(
		'title'=>'test post 2',
		'content'=>'test post content 2',
		'createTime'=>1230952287,
		'authorId'=>1,
	),
);
```

--------------------------------

### order() usage examples

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.query-builder.txt

Examples of using order() with a string and an array. The method automatically quotes column names unless they contain parentheses (DB expression).

```php
// ORDER BY `name`, `id` DESC
order('name, id desc')
// ORDER BY `tbl_profile`.`name`, `id` DESC
order(array('tbl_profile.name', 'id desc'))
```

--------------------------------

### Console command with run and getHelp

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/extension.create.txt

Defines a console command extending CConsoleCommand, implementing run and getHelp methods. run receives command-line arguments as an array; getHelp returns usage information. Use this to create custom console commands.

```php
class MyCommand extends CConsoleCommand
{
	public function run($args)
	{
		// $args gives an array of the command-line arguments for this command
	}

	public function getHelp()
	{
		return 'Usage: how to use this command';
	}
}
```

--------------------------------

### Show help for a specific command

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/topics.console.txt

Display usage information for a particular console command.

```bash
yiic help <command-name>
```

--------------------------------

### alterColumn example

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.query-builder.txt

Alters a column definition. The $table, $column, and $type parameters are used; table and column names are quoted. The example shows the SQL comment and the method call.

```php
// ALTER TABLE `tbl_user` CHANGE `username` `username` varchar(255) NOT NULL
alterColumn('tbl_user', 'username', 'string NOT NULL')
```

--------------------------------

### renameColumn example

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.query-builder.txt

Renames a column in a table. The $table, $name, and $newName parameters are used; table and column names are quoted. The example shows the SQL comment and the method call.

```php
// ALTER TABLE `tbl_users` CHANGE `name` `username` varchar(255) NOT NULL
renameColumn('tbl_user', 'name', 'username')
```

--------------------------------

### Navigate to Yii framework directory (Windows)

Source: https://github.com/yiisoft/yii/blob/master/README.md

Change to the framework directory on Windows to run the yiic tool.

```bash
cd YiiPath\framework
```

--------------------------------

### Invoke sitemap index action with various options

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/topics.console.txt

Different ways to call the sitemap index action, showing option handling and defaults.

```bash
yiic sitemap index --type=News --limit=5

// $limit takes default value
yiic sitemap index --type=News

// $limit takes default value
// because 'index' is a default action, we can omit the action name
yiic sitemap --type=News

// the order of options does not matter
yiic sitemap index --limit=5 --type=News
```

--------------------------------

### Configure db component for MySQL in main.php

Source: https://github.com/yiisoft/yii/blob/master/docs/blog/prototype.database.txt

Alternative configuration for using MySQL instead of SQLite. Create a MySQL database named 'blog' using the provided SQL file, then replace the db component configuration with this one.

```php
return array(
    ......
    'components'=>array(
        ......
        'db'=>array(
            'connectionString' => 'mysql:host=localhost;dbname=blog',
            'emulatePrepare' => true,
            'username' => 'root',
            'password' => '',
            'charset' => 'utf8',
            'tablePrefix' => 'tbl_',
        ),
    ),
	......
);
```

--------------------------------

### addColumn example

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.query-builder.txt

Adds a new column to a table. The $table, $column, and $type parameters are used; the table and column names are quoted. The example shows the SQL comment and the method call.

```php
// ALTER TABLE `tbl_user` ADD `email` varchar(255) NOT NULL
addColumn('tbl_user', 'email', 'string NOT NULL')
```

--------------------------------

### Navigate to Yii framework directory (Linux)

Source: https://github.com/yiisoft/yii/blob/master/README.md

Change to the framework directory on Linux to run the yiic tool.

```bash
cd YiiPath/framework
```

--------------------------------

### Fragment caching with requestTypes option

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/caching.fragment.txt

Cache a fragment only for GET requests by setting the 'requestTypes' option to array('GET'). This prevents caching POST requests, which may contain user input.

```php
[php]
...other HTML content...
<?php if($this->beginCache($id, array('requestTypes'=>array('GET')))) { ?>
...content to be cached...
<?php $this->endCache(); } ?>
...other HTML content...

```

--------------------------------

### Console application configuration with components

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/topics.console.txt

Configure console application components, such as DB, in the console configuration file.

```php
return array(
	......
	'components'=>array(
		'db'=>array(
			......
		),
	),
);
```

--------------------------------

### Konfigurera db-applikationskomponent

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/sv/database.dao.txt

Konfigurerar en 'db'-komponent i applikationskonfigurationen med klass, DSN, användarnamn, lösenord och emulatePrepare. Används för att dela en enda DB-anslutning via Yii::app()->db.

```php
array(
	......
	'components'=>array(
		......
		'db'=>array(
			'class'=>'CDbConnection',
			'connectionString'=>'mysql:host=localhost;dbname=testdb',
			'username'=>'root',
			'password'=>'password',
			'emulatePrepare'=>true,  // erfordras i vissa MySQL-installationer
		),
	),
)
```

--------------------------------

### dropForeignKey() example

Source: https://github.com/yiisoft/yii/blob/master/docs/guide/database.query-builder.txt

Drops a foreign key constraint. The $name parameter is the constraint name, $table is the table name. The query builder quotes both properly. Example shows the generated SQL comment and the method call.

```php
// ALTER TABLE `tbl_profile` DROP FOREIGN KEY `fk_profile_user_id`
dropForeignKey('fk_profile_user_id', 'tbl_profile')
```
Tokens:
Raw