Browse Source

wording fixes for AR docs

tags/2.0.0-beta
Alexander Makarov 12 years ago
parent
commit
63bb6efb6e
  1. 10
      docs/api/db/ActiveRecord-find.md
  2. 102
      docs/api/db/ActiveRecord.md

10
docs/api/db/ActiveRecord-find.md

@ -1,22 +1,26 @@
The returned [[ActiveQuery]] instance can be further customized by calling The returned [[ActiveQuery]] instance can be further customized by calling
methods defined in [[ActiveQuery]] before returning the populated active records. methods defined in [[ActiveQuery]] before `one()`, `all()` or `value()` is
called to return the populated active records:
Below are some examples:
~~~ ~~~
// find all customers // find all customers
$customers = Customer::find()->all(); $customers = Customer::find()->all();
// find all active customers and order them by their age: // find all active customers and order them by their age:
$customers = Customer::find() $customers = Customer::find()
->where(array('status' => 1)) ->where(array('status' => 1))
->orderBy('age') ->orderBy('age')
->all(); ->all();
// find a single customer whose primary key value is 10 // find a single customer whose primary key value is 10
$customer = Customer::find(10); $customer = Customer::find(10);
// the above is equivalent to: // the above is equivalent to:
$customer = Customer::find()->where(array('id' => 10))->one(); $customer = Customer::find()->where(array('id' => 10))->one();
// find a single customer whose age is 30 and whose status is 1 // find a single customer whose age is 30 and whose status is 1
$customer = Customer::find(array('age' => 30, 'status' => 1)); $customer = Customer::find(array('age' => 30, 'status' => 1));
// the above is equivalent to: // the above is equivalent to:
$customer = Customer::find()->where(array('age' => 30, 'status' => 1))->one(); $customer = Customer::find()->where(array('age' => 30, 'status' => 1))->one();
~~~ ~~~

102
docs/api/db/ActiveRecord.md

@ -1,15 +1,23 @@
ActiveRecord implements the [Active Record design pattern](http://en.wikipedia.org/wiki/Active_record). ActiveRecord implements the [Active Record design pattern](http://en.wikipedia.org/wiki/Active_record).
An ActiveRecord object is associated with a row in a database table. For example, a `Customer` object The idea is that ActiveRecord object is associated with a row in a database table
is associated with a row in the `tbl_customer` table. Instead of writing raw SQL statements to access so object properties are mapped to colums of the corresponding database row.
the data in the table, one can call intuitive methods available in the corresponding ActiveRecord class For example, a `Customer` object is associated with a row in the `tbl_customer`
table. Instead of writing raw SQL statements to access the data in the table,
you can call intuitive methods available in the corresponding ActiveRecord class
to achieve the same goals. For example, calling [[save()]] would insert or update a row to achieve the same goals. For example, calling [[save()]] would insert or update a row
in the underlying table. in the underlying table:
~~~
$customer = new Customer();
$customer->name = 'Qiang';
$customer->save();
~~~
### Declaring ActiveRecord Classes ### Declaring ActiveRecord Classes
An ActiveRecord class is declared by extending [[\yii\db\ActiveRecord]]. It typically requires the following To declare an ActiveRecord class you need to extend [[\yii\db\ActiveRecord]] and
minimal code: implement `tableName` method like the following:
~~~ ~~~
class Customer extends \yii\db\ActiveRecord class Customer extends \yii\db\ActiveRecord
@ -24,12 +32,12 @@ class Customer extends \yii\db\ActiveRecord
} }
~~~ ~~~
### Connecting to Database ### Connecting to Database
ActiveRecord relies on a [[Connection|DB connection]] to perform DB-related operations. By default, ActiveRecord relies on a [[Connection|DB connection]]. By default, it assumes that
it assumes that an application component named `db` gives the needed [[Connection]] instance there is an application component named `db` that gives the needed [[Connection]]
which serves as the DB connection. The following application configuration shows an example: instance which serves as the DB connection. Usually this component is configured
via application configuration like the following:
~~~ ~~~
return array( return array(
@ -47,9 +55,9 @@ return array(
~~~ ~~~
### Retrieving Data from Database ### Getting Data from Database
ActiveRecord provides three methods for data retrieval purpose: There are three ActiveRecord methods for getting data:
- [[find()]] - [[find()]]
- [[findBySql()]] - [[findBySql()]]
@ -96,7 +104,7 @@ $customers = Customer::find()->indexBy('id')->all();
### Accessing Column Data ### Accessing Column Data
ActiveRecord maps each column in the associated row of database table to an *attribute* in the ActiveRecord ActiveRecord maps each column of the corresponding database table row to an *attribute* in the ActiveRecord
object. An attribute is like a regular object property whose name is the same as the corresponding column object. An attribute is like a regular object property whose name is the same as the corresponding column
name and is case sensitive. name and is case sensitive.
@ -109,7 +117,7 @@ $id = $customer->id;
$id = $customer->getAttribute('id'); $id = $customer->getAttribute('id');
~~~ ~~~
And through the [[attributes]] property, we can get all column values: We can get all column values through the [[attributes]] property:
~~~ ~~~
$values = $customer->attributes; $values = $customer->attributes;
@ -118,7 +126,7 @@ $values = $customer->attributes;
### Persisting Data to Database ### Persisting Data to Database
ActiveRecord provides the following methods to support data insertion, updating and deletion: ActiveRecord provides the following methods to insert, update and delete data:
- [[save()]] - [[save()]]
- [[insert()]] - [[insert()]]
@ -151,14 +159,14 @@ $customer = Customer::find($id);
$customer->delete(); $customer->delete();
// to increment the age of all customers by 1 // to increment the age of all customers by 1
Customer::updateAllCounters(array('age' => 1)); Customer::updateAllCounters(array('age' => +1));
~~~ ~~~
### Retrieving Relational Data ### Getting Relational Data
ActiveRecord supports foreign key relationships by exposing them via component properties. For example, Using ActiveRecord you can expose relationships as properties. For example,
with appropriate declaration, the expression `$customer->orders` can return an array of `Order` objects with an appropriate declaration, `$customer->orders` can return an array of `Order` objects
which represent the orders placed by the specified customer. which represent the orders placed by the specified customer.
To declare a relationship, define a getter method which returns an [[ActiveRelation]] object. For example, To declare a relationship, define a getter method which returns an [[ActiveRelation]] object. For example,
@ -181,30 +189,35 @@ class Order extends \yii\db\ActiveRecord
} }
~~~ ~~~
Within the getter methods, we call [[hasMany()]] or [[hasOne()]] to create a new [[ActiveRelation]] object. Within the getter methods above, we call [[hasMany()]] or [[hasOne()]] methods to
The [[hasMany()]] method declares a one-many relationship. For example, a customer has many orders. create a new [[ActiveRelation]] object. The [[hasMany()]] method declares
And the [[hasOne()]] method declares a many-one or one-one relationship. For example, an order has one customer. a one-many relationship. For example, a customer has many orders. And the [[hasOne()]]
method declares a many-one or one-one relationship. For example, an order has one customer.
Both methods take two parameters: Both methods take two parameters:
- `$class`: the class name of the related models. If the class name is not namespaced, it will take - `$class`: the name of the class related models should use. If specified without
the same namespace as the declaring class. a namespace, the namespace will be taken from the declaring class.
- `$link`: the association between columns from two tables. This should be given as an array. - `$link`: the association between columns from two tables. This should be given as an array.
The keys of the array are the names of the columns from the table associated with `$class`, The keys of the array are the names of the columns from the table associated with `$class`,
while the values of the array the names of the columns from the declaring class. while the values of the array are the names of the columns from the declaring class.
It is a good practice to define relationships based on table foreign keys.
Retrieving relational data is now as easy as accessing a component property. Remember that a component After declaring relationships getting relational data is as easy as accessing
property is defined by the existence of a getter method. The The following example a component property that is defined by the getter method:
shows how to get the orders of a customer, and how to get the customer of the first order.
~~~ ~~~
// the orders of a customer
$customer = Customer::find($id); $customer = Customer::find($id);
$orders = $customer->orders; // $orders is an array of Order objects $orders = $customer->orders; // $orders is an array of Order objects
// the customer of the first order
$customer2 = $orders[0]->customer; // $customer == $customer2 $customer2 = $orders[0]->customer; // $customer == $customer2
~~~ ~~~
Because [[ActiveRelation]] extends from [[ActiveQuery]], it has the same query customization methods, Because [[ActiveRelation]] extends from [[ActiveQuery]], it has the same query building methods,
which allows us to customize the query for retrieving the related objects. For example, we may declare a `bigOrder` which allows us to customize the query for retrieving the related objects.
relationship which returns orders whose subtotal exceeds certain amount: For example, we may declare a `bigOrders` relationship which returns orders whose
subtotal exceeds certain amount:
~~~ ~~~
class Customer extends \yii\db\ActiveRecord class Customer extends \yii\db\ActiveRecord
@ -238,7 +251,7 @@ class Order extends \yii\db\ActiveRecord
} }
~~~ ~~~
Method [[ActiveRelation::via()]] is similar to [[ActiveRelation::viaTable()]] except that [[ActiveRelation::via()]] method is similar to [[ActiveRelation::viaTable()]] except that
the first parameter of [[ActiveRelation::via()]] takes a relation name declared in the ActiveRecord class. the first parameter of [[ActiveRelation::via()]] takes a relation name declared in the ActiveRecord class.
For example, the above `items` relation can be equivalently declared as follows: For example, the above `items` relation can be equivalently declared as follows:
@ -259,9 +272,9 @@ class Order extends \yii\db\ActiveRecord
~~~ ~~~
When we access the related objects the first time, behind the scene ActiveRecord will perform a DB query When you access the related objects the first time, behind the scene ActiveRecord performs a DB query
to retrieve the corresponding data and populate them into the related objects. No query will be perform to retrieve the corresponding data and populate it into the related objects. No query will be performed
if we access again the same related objects. We call this *lazy loading*. For example, if you access the same related objects again. We call this *lazy loading*. For example,
~~~ ~~~
// SQL executed: SELECT * FROM tbl_customer WHERE id=1 // SQL executed: SELECT * FROM tbl_customer WHERE id=1
@ -273,7 +286,8 @@ $orders2 = $customer->orders;
~~~ ~~~
Lazy loading is convenient to use. However, it may suffer from performance issue in the following scenario: Lazy loading is very convenient to use. However, it may suffer from performance
issue in the following scenario:
~~~ ~~~
// SQL executed: SELECT * FROM tbl_customer LIMIT 100 // SQL executed: SELECT * FROM tbl_customer LIMIT 100
@ -287,10 +301,10 @@ foreach ($customers as $customer) {
~~~ ~~~
How many SQL queries will be performed in the above code, assuming there are more than 100 customers in How many SQL queries will be performed in the above code, assuming there are more than 100 customers in
the database? 101! The first SQL query brings back 100 customers. Then for each customer, a SQL query the database? 101! The first SQL query brings back 100 customers. Then for each customer, another SQL query
is performed to bring back the customer's orders. is performed to bring back the customer's orders.
To solve the above performance problem, we can use the so-called *eager loading* by calling [[ActiveQuery::with()]]: To solve the above performance problem, you can use the so-called *eager loading* by calling [[ActiveQuery::with()]]:
~~~ ~~~
// SQL executed: SELECT * FROM tbl_customer LIMIT 100 // SQL executed: SELECT * FROM tbl_customer LIMIT 100
@ -305,11 +319,11 @@ foreach ($customers as $customer) {
} }
~~~ ~~~
As we can see, only two SQL queries are needed for the same task. As you can see, only two SQL queries were needed for the same task.
Sometimes, we may want to customize the relational queries on the fly. This can be done for both Sometimes, you may want to customize the relational queries on the fly. It can be
lazy loading and eager loading. For example, done for both lazy loading and eager loading. For example,
~~~ ~~~
$customer = Customer::find(1); $customer = Customer::find(1);
@ -326,10 +340,10 @@ $customers = Customer::find()->limit(100)->with(array(
~~~ ~~~
### Maintaining Relationships ### Working with Relationships
ActiveRecord provides the following two methods for establishing and breaking relationship ActiveRecord provides the following two methods for establishing and breaking a
between two ActiveRecord objects: relationship between two ActiveRecord objects:
- [[link()]] - [[link()]]
- [[unlink()]] - [[unlink()]]

Loading…
Cancel
Save