Quick ORM
Search…
polymorphicHasMany

Usage

A polymorphicHasMany relationship is a one-to-many relationship. This relationship is used when an entity can belong to multiple types of entities. The classic example for this type of relationship is Posts, Videos, and Comments.
1
// Post.cfc
2
component extends="quick.models.BaseEntity" accessors="true" {
3
4
function comments() {
5
return polymorphicHasMany( "Comment", "commentable" );
6
}
7
8
}
Copied!
1
// Video.cfc
2
component extends="quick.models.BaseEntity" accessors="true" {
3
4
function comments() {
5
return polymorphicHasMany( "Comment", "commentable" );
6
}
7
8
}
Copied!
The first value passed to polymophicHasMany is a WireBox mapping to the related entity.
The second value is a prefix for the polymorphic type. A common convention where is to add able to the end of the entity name, though this is not automatically done. In our example, this prefix is commentable. This tells quick to look for a commentable_type and a commentable_id column in our Comment entity. It stores our entity's mapping as the _type and our entity's primary key value as the _id.
The inverse of polymophicHasMany is polymorphicBelongsTo.
1
// Comment.cfc
2
component extends="quick.models.BaseEntity" accessors="true" {
3
4
function post() {
5
return polymorphicBelongsTo( "commentable" );
6
}
7
8
}
Copied!

Signature

Name
Type
Required
Default
Description
relationName
String
true
The WireBox mapping for the related entity.
name
String
true
The name given to the polymorphic relationship.
type
String
false
name & "_type"
The column name that defines the type of the polymorphic relationship.
id
String
false
name & "_id"
The column name that defines the id of the polymorphic relationship.
localKey
String | [String]
false
keyNames()
The local primary key on the parent entity.
relationMethodName
String
false
The method name called on the entity to produce this relationship.
The method name called to retrieve this relationship. Uses a stack backtrace to determine by default.
DO NOT PASS A VALUE HERE UNLESS YOU KNOW WHAT YOU ARE DOING.
Returns a polymorphicHasMany relationship between this entity and the entity defined by relationName.

Visualizer

Last modified 1yr ago
Copy link
Edit on GitHub