1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
/**
* Model relationships mixin
*
* @since 3.16.0
* @version 3.16.11
*/
define( [], function() {
return {
/**
* Default relationship settings object
*
* @type {Object}
*/
relationship_defaults: {
parent: {},
children: {},
},
/**
* Relationship settings object
* Should be overridden in the model
*
* @type {Object}
*/
relationships: {},
/**
* Initialize all parent and child relationships
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
init_relationships: function( options ) {
var rels = this.get_relationships();
// initialize parent relationships
// useful when adding a model to ensure parent is initialized
if ( rels.parent && options && options.parent ) {
this.set_parent( options.parent );
}
// initialize all children relationships
_.each( rels.children, function( child_data, child_key ) {
if ( ! child_data.conditional || true === child_data.conditional( this ) ) {
var child_val = this.get( child_key ),
child;
if ( child_data.lookup ) {
child = child_data.lookup( child_val );
} else if ( 'model' === child_data.type ) {
child = window.llms_builder.construct.get_model( child_data.class, child_val );
} else if ( 'collection' === child_data.type ) {
child = window.llms_builder.construct.get_collection( child_data.class, child_val );
}
this.set( child_key, child );
// if the child defines a parent, save a reference to the parent on the child
if ( 'model' === child_data.type ) {
this._maybe_set_parent_reference( child );
// save directly to each model in the collection
} else if ( 'collection' === child_data.type ) {
child.parent = this;
child.each( function( child_model ) {
this._maybe_set_parent_reference( child_model );
}, this );
}
}
}, this );
},
/**
* Retrieve the property names for all children of the model
*
* @return array
* @since 3.16.11
* @version 3.16.11
*/
get_child_props: function() {
var props = [];
_.each( this.get_relationships().children, function( data, key ) {
if ( ! data.conditional || true === data.conditional( this ) ) {
props.push( key );
}
}, this );
return props;
},
/**
* Retrieve the model's parent (if set)
*
* @return obj|false
* @since 3.16.0
* @version 3.16.0
*/
get_parent: function() {
var rels = this.get_relationships();
if ( rels.parent ) {
return rels.parent.reference;
}
return false;
},
/**
* Retrieve relationships for the model
* Extends with defaults
*
* @return obj
* @since 3.16.0
* @version 3.16.0
*/
get_relationships: function() {
return $.extend( true, this.relationships, this.relationship_defaults );
},
/**
* Set the parent reference for the given model
*
* @param obj obj parent model obj
* @return void
* @since 3.16.0
* @version 3.16.0
*/
set_parent: function( obj ) {
this.relationships.parent.reference = obj;
},
/**
* Set up the parent relationships for qualifying children during relationship initialization
*
* @param obj model child model
* @return void
* @since 3.16.0
* @version 3.16.0
*/
_maybe_set_parent_reference: function( model ) {
if ( ! model || ! model.get_relationships ) {
return;
}
var rels = model.get_relationships();
if ( rels.parent && rels.parent.model === this.get( 'type' ) ) {
model.set_parent( this );
}
},
};
} );