belongsTo()
Description
Sets up a belongsTo association between this model and the specified one. Use this association when this model contains a foreign key referencing another model.
Function Syntax
belongsTo(name [, modelName, foreignKey, joinType ])
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name |
string |
Yes | |
Gives the association a name that you refer to when working with the association (in the include argument to findAll(), to name one example). |
modelName |
string |
No | |
Name of associated model (usually not needed if you follow Wheels conventions because the model name will be deduced from the name argument). |
foreignKey |
string |
No | |
Foreign key property name (usually not needed if you follow Wheels conventions since the foreign key name will be deduced from the name argument). |
joinType |
string |
No | inner |
Use to set the join type when joining associated tables. Possible values are inner (for INNER JOIN) and outer (for LEFT OUTER JOIN). |
Examples
<!--- Specify that instances of this model belong to an author. (The table for this model should have a foreign key set on it, typically named `authorid`.) --->
<cfset belongsTo("author")>
<!--- Same as above, but because we have broken away from the foreign key naming convention, we need to set `modelName` and `foreignKey` --->
<cfset belongsTo(name="bookWriter", modelName="author", foreignKey="authorId")>
