Completed
Branch models-cleanup/model-relations (b772ed)
by
unknown
56:02 queued 47:06
created
core/db_models/EEM_Line_Item.model.php 3 patches
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -416,7 +416,7 @@
 block discarded – undo
416 416
      * If $expired is set to true, then only line items for expired sessions will be returned.
417 417
      * If $expired is set to false, then only line items for active sessions will be returned.
418 418
      *
419
-     * @param null $expired
419
+     * @param boolean $expired
420 420
      * @return EE_Base_Class[]|EE_Line_Item[]
421 421
      * @throws EE_Error
422 422
      * @throws InvalidArgumentException
Please login to merge, or discard this patch.
Spacing   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -324,8 +324,8 @@  discard block
 block discarded – undo
324 324
         );
325 325
         $query = $wpdb->prepare(
326 326
             'DELETE li
327
-				FROM ' . $this->table() . ' li
328
-				LEFT JOIN ' . EEM_Transaction::instance()->table() . ' t ON li.TXN_ID = t.TXN_ID
327
+				FROM ' . $this->table().' li
328
+				LEFT JOIN ' . EEM_Transaction::instance()->table().' t ON li.TXN_ID = t.TXN_ID
329 329
 				WHERE t.TXN_ID IS NULL AND li.LIN_timestamp < %s',
330 330
             // use GMT time because that's what TXN_timestamps are in
331 331
             date('Y-m-d H:i:s', time() - $time_to_leave_alone)
@@ -598,7 +598,7 @@  discard block
 block discarded – undo
598 598
      */
599 599
     public function getTicketLineItemsForExpiredCarts($timestamp = 0)
600 600
     {
601
-        if (! absint($timestamp)) {
601
+        if ( ! absint($timestamp)) {
602 602
             /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
603 603
             $session_lifespan = LoaderFactory::getLoader()->getShared(
604 604
                 'EventEspresso\core\domain\values\session\SessionLifespan'
Please login to merge, or discard this patch.
Indentation   +595 added lines, -595 removed lines patch added patch discarded remove patch
@@ -28,602 +28,602 @@
 block discarded – undo
28 28
 class EEM_Line_Item extends EEM_Base
29 29
 {
30 30
 
31
-    /**
32
-     * Tax sub-total is just the total of all the taxes, which should be children
33
-     * of this line item. There should only ever be one tax sub-total, and it should
34
-     * be a direct child of. Its quantity and LIN_unit_price = 1.
35
-     */
36
-    const type_tax_sub_total = 'tax-sub-total';
37
-
38
-    /**
39
-     * Tax line items indicate a tax applied to all the taxable line items.
40
-     * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal
41
-     * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1.
42
-     */
43
-    const type_tax = 'tax';
44
-
45
-    /**
46
-     * Indicating individual items purchased, or discounts or surcharges.
47
-     * The sum of all the regular line items  plus the tax items should equal the grand total.
48
-     * Possible children are sub-line-items and cancellations.
49
-     * For flat items, LIN_unit_price * LIN_quantity = LIN_total. Its LIN_total is the sum of all the children
50
-     * LIN_totals. Its LIN_percent = 0.
51
-     * For percent items, its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal (eg 10% = 10, not 0.1).
52
-     * Its LIN_total is LIN_percent / 100 * sum of lower-priority sibling line items. Quantity = 1.
53
-     */
54
-    const type_line_item = 'line-item';
55
-
56
-    /**
57
-     * Line item indicating all the factors that make a single line item.
58
-     * Sub-line items should have NO children line items.
59
-     * For flat sub-items, their quantity should match their parent item, their LIN_unit_price should be this sub-item's
60
-     * contribution towards the price of ONE of their parent items, and its LIN_total should be
61
-     *  = LIN_quantity * LIN_unit_price. Its LIN_percent = 0.
62
-     * For percent sub-items, the quantity should be 1, LIN_unit_price should be 0, and its LIN_total should
63
-     * = LIN_percent / 100 * sum of lower-priority sibling line items..
64
-     */
65
-    const type_sub_line_item = 'sub-item';
66
-
67
-    /**
68
-     * Line item indicating a sub-total (eg total for an event, or pre-tax subtotal).
69
-     * Direct children should be event subtotals.
70
-     * Should have quantity of 1, and a LIN_total and LIN_unit_price of the sum of all its sub-items' LIN_totals.
71
-     */
72
-    const type_sub_total = 'sub-total';
73
-
74
-    /**
75
-     * Line item for the grand total of an order.
76
-     * Its direct children should be tax subtotals and (pre-tax) subtotals,
77
-     * and possibly a regular line item indicating a transaction-wide discount/surcharge.
78
-     * Should have a quantity of 1, a LIN_total and LIN_unit_price of the entire order's amount.
79
-     */
80
-    const type_total = 'total';
81
-
82
-    /**
83
-     * When a line item is cancelled, a sub-line-item of type 'cancellation'
84
-     * should be created, indicating the quantity that were cancelled
85
-     * (because a line item could have a quantity of 1, and its cancellation item
86
-     * could be for 3, indicating that originally 4 were purchased, but 3 have been
87
-     * cancelled, and only one remains).
88
-     * When items are refunded, a cancellation line item should be made, which points
89
-     * to teh payment model object which actually refunded the payment.
90
-     * Cancellations should NOT have any children line items; the should NOT affect
91
-     * any calculations, and are only meant as a record that cancellations have occurred.
92
-     * Their LIN_percent should be 0.
93
-     */
94
-    const type_cancellation = 'cancellation';
95
-
96
-    // various line item object types
97
-    const OBJ_TYPE_EVENT = 'Event';
98
-
99
-    const OBJ_TYPE_PRICE = 'Price';
100
-
101
-    const OBJ_TYPE_PROMOTION = 'Promotion';
102
-
103
-    const OBJ_TYPE_TICKET = 'Ticket';
104
-
105
-    const OBJ_TYPE_TRANSACTION = 'Transaction';
106
-
107
-    /**
108
-     * @var EEM_Line_Item $_instance
109
-     */
110
-    protected static $_instance;
111
-
112
-
113
-    /**
114
-     * private constructor to prevent direct creation
115
-     *
116
-     * @Constructor
117
-     * @param string $timezone string representing the timezone we want to set for returned Date Time Strings
118
-     *                         (and any incoming timezone data that gets saved).
119
-     *                         Note this just sends the timezone info to the date time model field objects.
120
-     *                         Default is NULL
121
-     *                         (and will be assumed using the set timezone in the 'timezone_string' wp option)
122
-     * @throws EE_Error
123
-     * @throws InvalidArgumentException
124
-     */
125
-    protected function __construct($timezone)
126
-    {
127
-        $this->singular_item = esc_html__('Line Item', 'event_espresso');
128
-        $this->plural_item = esc_html__('Line Items', 'event_espresso');
129
-
130
-        $this->_tables = array(
131
-            'Line_Item' => new EE_Primary_Table('esp_line_item', 'LIN_ID'),
132
-        );
133
-        $line_items_can_be_for = apply_filters(
134
-            'FHEE__EEM_Line_Item__line_items_can_be_for',
135
-            array('Ticket', 'Price', 'Event')
136
-        );
137
-        $this->_fields = array(
138
-            'Line_Item' => array(
139
-                'LIN_ID'         => new EE_Primary_Key_Int_Field(
140
-                    'LIN_ID',
141
-                    esc_html__('ID', 'event_espresso')
142
-                ),
143
-                'LIN_code'       => new EE_Slug_Field(
144
-                    'LIN_code',
145
-                    esc_html__('Code for index into Cart', 'event_espresso'),
146
-                    true
147
-                ),
148
-                'TXN_ID'         => new EE_Foreign_Key_Int_Field(
149
-                    'TXN_ID',
150
-                    esc_html__('Transaction ID', 'event_espresso'),
151
-                    true,
152
-                    null,
153
-                    'Transaction'
154
-                ),
155
-                'LIN_name'       => new EE_Full_HTML_Field(
156
-                    'LIN_name',
157
-                    esc_html__('Line Item Name', 'event_espresso'),
158
-                    false,
159
-                    ''
160
-                ),
161
-                'LIN_desc'       => new EE_Full_HTML_Field(
162
-                    'LIN_desc',
163
-                    esc_html__('Line Item Description', 'event_espresso'),
164
-                    true
165
-                ),
166
-                'LIN_unit_price' => new EE_Money_Field(
167
-                    'LIN_unit_price',
168
-                    esc_html__('Unit Price', 'event_espresso'),
169
-                    false,
170
-                    0
171
-                ),
172
-                'LIN_percent'    => new EE_Float_Field(
173
-                    'LIN_percent',
174
-                    esc_html__('Percent', 'event_espresso'),
175
-                    false,
176
-                    0
177
-                ),
178
-                'LIN_is_taxable' => new EE_Boolean_Field(
179
-                    'LIN_is_taxable',
180
-                    esc_html__('Taxable', 'event_espresso'),
181
-                    false,
182
-                    false
183
-                ),
184
-                'LIN_order'      => new EE_Integer_Field(
185
-                    'LIN_order',
186
-                    esc_html__('Order of Application towards total of parent', 'event_espresso'),
187
-                    false,
188
-                    1
189
-                ),
190
-                'LIN_total'      => new EE_Money_Field(
191
-                    'LIN_total',
192
-                    esc_html__('Total (unit price x quantity)', 'event_espresso'),
193
-                    false,
194
-                    0
195
-                ),
196
-                'LIN_quantity'   => new EE_Integer_Field(
197
-                    'LIN_quantity',
198
-                    esc_html__('Quantity', 'event_espresso'),
199
-                    true,
200
-                    1
201
-                ),
202
-                'LIN_parent'     => new EE_Integer_Field(
203
-                    'LIN_parent',
204
-                    esc_html__("Parent ID (this item goes towards that Line Item's total)", 'event_espresso'),
205
-                    true,
206
-                    null
207
-                ),
208
-                'LIN_type'       => new EE_Enum_Text_Field(
209
-                    'LIN_type',
210
-                    esc_html__('Type', 'event_espresso'),
211
-                    false,
212
-                    'line-item',
213
-                    array(
214
-                        self::type_line_item     => esc_html__('Line Item', 'event_espresso'),
215
-                        self::type_sub_line_item => esc_html__('Sub-Item', 'event_espresso'),
216
-                        self::type_sub_total     => esc_html__('Subtotal', 'event_espresso'),
217
-                        self::type_tax_sub_total => esc_html__('Tax Subtotal', 'event_espresso'),
218
-                        self::type_tax           => esc_html__('Tax', 'event_espresso'),
219
-                        self::type_total         => esc_html__('Total', 'event_espresso'),
220
-                        self::type_cancellation  => esc_html__('Cancellation', 'event_espresso'),
221
-                    )
222
-                ),
223
-                'OBJ_ID'         => new EE_Foreign_Key_Int_Field(
224
-                    'OBJ_ID',
225
-                    esc_html__('ID of Item purchased.', 'event_espresso'),
226
-                    true,
227
-                    null,
228
-                    $line_items_can_be_for
229
-                ),
230
-                'OBJ_type'       => new EE_Any_Foreign_Model_Name_Field(
231
-                    'OBJ_type',
232
-                    esc_html__('Model Name this Line Item is for', 'event_espresso'),
233
-                    true,
234
-                    null,
235
-                    $line_items_can_be_for
236
-                ),
237
-                'LIN_timestamp'  => new EE_Datetime_Field(
238
-                    'LIN_timestamp',
239
-                    esc_html__('When the line item was created', 'event_espresso'),
240
-                    false,
241
-                    EE_Datetime_Field::now,
242
-                    $timezone
243
-                ),
244
-            ),
245
-        );
246
-        $this->_model_relations = array(
247
-            'Transaction' => new EE_Belongs_To_Relation(),
248
-            'Ticket'      => new EE_Belongs_To_Any_Relation(),
249
-            'Price'       => new EE_Belongs_To_Any_Relation(),
250
-            'Event'       => new EE_Belongs_To_Any_Relation(),
251
-        );
252
-        $this->_model_chain_to_wp_user = 'Transaction.Registration.Event';
253
-        $this->_caps_slug = 'transactions';
254
-        parent::__construct($timezone);
255
-    }
256
-
257
-
258
-    /**
259
-     * Gets all the line items for this transaction of the given type
260
-     *
261
-     * @param string             $line_item_type like one of EEM_Line_Item::type_*
262
-     * @param EE_Transaction|int $transaction
263
-     * @return EE_Base_Class[]|EE_Line_Item[]
264
-     * @throws EE_Error
265
-     * @throws InvalidArgumentException
266
-     * @throws InvalidDataTypeException
267
-     * @throws InvalidInterfaceException
268
-     */
269
-    public function get_all_of_type_for_transaction($line_item_type, $transaction)
270
-    {
271
-        $transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
272
-        return $this->get_all(array(
273
-            array(
274
-                'LIN_type' => $line_item_type,
275
-                'TXN_ID'   => $transaction,
276
-            ),
277
-        ));
278
-    }
279
-
280
-
281
-    /**
282
-     * Gets all line items unrelated to tickets that are normal line items
283
-     * (eg shipping, promotions, and miscellaneous other stuff should probably fit in this category)
284
-     *
285
-     * @param EE_Transaction|int $transaction
286
-     * @return EE_Base_Class[]|EE_Line_Item[]
287
-     * @throws EE_Error
288
-     * @throws InvalidArgumentException
289
-     * @throws InvalidDataTypeException
290
-     * @throws InvalidInterfaceException
291
-     */
292
-    public function get_all_non_ticket_line_items_for_transaction($transaction)
293
-    {
294
-        $transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
295
-        return $this->get_all(array(
296
-            array(
297
-                'LIN_type' => self::type_line_item,
298
-                'TXN_ID'   => $transaction,
299
-                'OR'       => array(
300
-                    'OBJ_type*notticket' => array('!=', EEM_Line_Item::OBJ_TYPE_TICKET),
301
-                    'OBJ_type*null'      => array('IS_NULL'),
302
-                ),
303
-            ),
304
-        ));
305
-    }
306
-
307
-
308
-    /**
309
-     * Deletes line items with no transaction who have passed the transaction cutoff time.
310
-     * This needs to be very efficient
311
-     * because if there are spam bots afoot there will be LOTS of line items. Also MySQL doesn't allow a limit when
312
-     * deleting and joining tables like this.
313
-     *
314
-     * @return int count of how many deleted
315
-     * @throws EE_Error
316
-     * @throws InvalidArgumentException
317
-     * @throws InvalidDataTypeException
318
-     * @throws InvalidInterfaceException
319
-     */
320
-    public function delete_line_items_with_no_transaction()
321
-    {
322
-        /** @type WPDB $wpdb */
323
-        global $wpdb;
324
-        $time_to_leave_alone = apply_filters(
325
-            'FHEE__EEM_Line_Item__delete_line_items_with_no_transaction__time_to_leave_alone',
326
-            WEEK_IN_SECONDS
327
-        );
328
-        $query = $wpdb->prepare(
329
-            'DELETE li
31
+	/**
32
+	 * Tax sub-total is just the total of all the taxes, which should be children
33
+	 * of this line item. There should only ever be one tax sub-total, and it should
34
+	 * be a direct child of. Its quantity and LIN_unit_price = 1.
35
+	 */
36
+	const type_tax_sub_total = 'tax-sub-total';
37
+
38
+	/**
39
+	 * Tax line items indicate a tax applied to all the taxable line items.
40
+	 * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal
41
+	 * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1.
42
+	 */
43
+	const type_tax = 'tax';
44
+
45
+	/**
46
+	 * Indicating individual items purchased, or discounts or surcharges.
47
+	 * The sum of all the regular line items  plus the tax items should equal the grand total.
48
+	 * Possible children are sub-line-items and cancellations.
49
+	 * For flat items, LIN_unit_price * LIN_quantity = LIN_total. Its LIN_total is the sum of all the children
50
+	 * LIN_totals. Its LIN_percent = 0.
51
+	 * For percent items, its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal (eg 10% = 10, not 0.1).
52
+	 * Its LIN_total is LIN_percent / 100 * sum of lower-priority sibling line items. Quantity = 1.
53
+	 */
54
+	const type_line_item = 'line-item';
55
+
56
+	/**
57
+	 * Line item indicating all the factors that make a single line item.
58
+	 * Sub-line items should have NO children line items.
59
+	 * For flat sub-items, their quantity should match their parent item, their LIN_unit_price should be this sub-item's
60
+	 * contribution towards the price of ONE of their parent items, and its LIN_total should be
61
+	 *  = LIN_quantity * LIN_unit_price. Its LIN_percent = 0.
62
+	 * For percent sub-items, the quantity should be 1, LIN_unit_price should be 0, and its LIN_total should
63
+	 * = LIN_percent / 100 * sum of lower-priority sibling line items..
64
+	 */
65
+	const type_sub_line_item = 'sub-item';
66
+
67
+	/**
68
+	 * Line item indicating a sub-total (eg total for an event, or pre-tax subtotal).
69
+	 * Direct children should be event subtotals.
70
+	 * Should have quantity of 1, and a LIN_total and LIN_unit_price of the sum of all its sub-items' LIN_totals.
71
+	 */
72
+	const type_sub_total = 'sub-total';
73
+
74
+	/**
75
+	 * Line item for the grand total of an order.
76
+	 * Its direct children should be tax subtotals and (pre-tax) subtotals,
77
+	 * and possibly a regular line item indicating a transaction-wide discount/surcharge.
78
+	 * Should have a quantity of 1, a LIN_total and LIN_unit_price of the entire order's amount.
79
+	 */
80
+	const type_total = 'total';
81
+
82
+	/**
83
+	 * When a line item is cancelled, a sub-line-item of type 'cancellation'
84
+	 * should be created, indicating the quantity that were cancelled
85
+	 * (because a line item could have a quantity of 1, and its cancellation item
86
+	 * could be for 3, indicating that originally 4 were purchased, but 3 have been
87
+	 * cancelled, and only one remains).
88
+	 * When items are refunded, a cancellation line item should be made, which points
89
+	 * to teh payment model object which actually refunded the payment.
90
+	 * Cancellations should NOT have any children line items; the should NOT affect
91
+	 * any calculations, and are only meant as a record that cancellations have occurred.
92
+	 * Their LIN_percent should be 0.
93
+	 */
94
+	const type_cancellation = 'cancellation';
95
+
96
+	// various line item object types
97
+	const OBJ_TYPE_EVENT = 'Event';
98
+
99
+	const OBJ_TYPE_PRICE = 'Price';
100
+
101
+	const OBJ_TYPE_PROMOTION = 'Promotion';
102
+
103
+	const OBJ_TYPE_TICKET = 'Ticket';
104
+
105
+	const OBJ_TYPE_TRANSACTION = 'Transaction';
106
+
107
+	/**
108
+	 * @var EEM_Line_Item $_instance
109
+	 */
110
+	protected static $_instance;
111
+
112
+
113
+	/**
114
+	 * private constructor to prevent direct creation
115
+	 *
116
+	 * @Constructor
117
+	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings
118
+	 *                         (and any incoming timezone data that gets saved).
119
+	 *                         Note this just sends the timezone info to the date time model field objects.
120
+	 *                         Default is NULL
121
+	 *                         (and will be assumed using the set timezone in the 'timezone_string' wp option)
122
+	 * @throws EE_Error
123
+	 * @throws InvalidArgumentException
124
+	 */
125
+	protected function __construct($timezone)
126
+	{
127
+		$this->singular_item = esc_html__('Line Item', 'event_espresso');
128
+		$this->plural_item = esc_html__('Line Items', 'event_espresso');
129
+
130
+		$this->_tables = array(
131
+			'Line_Item' => new EE_Primary_Table('esp_line_item', 'LIN_ID'),
132
+		);
133
+		$line_items_can_be_for = apply_filters(
134
+			'FHEE__EEM_Line_Item__line_items_can_be_for',
135
+			array('Ticket', 'Price', 'Event')
136
+		);
137
+		$this->_fields = array(
138
+			'Line_Item' => array(
139
+				'LIN_ID'         => new EE_Primary_Key_Int_Field(
140
+					'LIN_ID',
141
+					esc_html__('ID', 'event_espresso')
142
+				),
143
+				'LIN_code'       => new EE_Slug_Field(
144
+					'LIN_code',
145
+					esc_html__('Code for index into Cart', 'event_espresso'),
146
+					true
147
+				),
148
+				'TXN_ID'         => new EE_Foreign_Key_Int_Field(
149
+					'TXN_ID',
150
+					esc_html__('Transaction ID', 'event_espresso'),
151
+					true,
152
+					null,
153
+					'Transaction'
154
+				),
155
+				'LIN_name'       => new EE_Full_HTML_Field(
156
+					'LIN_name',
157
+					esc_html__('Line Item Name', 'event_espresso'),
158
+					false,
159
+					''
160
+				),
161
+				'LIN_desc'       => new EE_Full_HTML_Field(
162
+					'LIN_desc',
163
+					esc_html__('Line Item Description', 'event_espresso'),
164
+					true
165
+				),
166
+				'LIN_unit_price' => new EE_Money_Field(
167
+					'LIN_unit_price',
168
+					esc_html__('Unit Price', 'event_espresso'),
169
+					false,
170
+					0
171
+				),
172
+				'LIN_percent'    => new EE_Float_Field(
173
+					'LIN_percent',
174
+					esc_html__('Percent', 'event_espresso'),
175
+					false,
176
+					0
177
+				),
178
+				'LIN_is_taxable' => new EE_Boolean_Field(
179
+					'LIN_is_taxable',
180
+					esc_html__('Taxable', 'event_espresso'),
181
+					false,
182
+					false
183
+				),
184
+				'LIN_order'      => new EE_Integer_Field(
185
+					'LIN_order',
186
+					esc_html__('Order of Application towards total of parent', 'event_espresso'),
187
+					false,
188
+					1
189
+				),
190
+				'LIN_total'      => new EE_Money_Field(
191
+					'LIN_total',
192
+					esc_html__('Total (unit price x quantity)', 'event_espresso'),
193
+					false,
194
+					0
195
+				),
196
+				'LIN_quantity'   => new EE_Integer_Field(
197
+					'LIN_quantity',
198
+					esc_html__('Quantity', 'event_espresso'),
199
+					true,
200
+					1
201
+				),
202
+				'LIN_parent'     => new EE_Integer_Field(
203
+					'LIN_parent',
204
+					esc_html__("Parent ID (this item goes towards that Line Item's total)", 'event_espresso'),
205
+					true,
206
+					null
207
+				),
208
+				'LIN_type'       => new EE_Enum_Text_Field(
209
+					'LIN_type',
210
+					esc_html__('Type', 'event_espresso'),
211
+					false,
212
+					'line-item',
213
+					array(
214
+						self::type_line_item     => esc_html__('Line Item', 'event_espresso'),
215
+						self::type_sub_line_item => esc_html__('Sub-Item', 'event_espresso'),
216
+						self::type_sub_total     => esc_html__('Subtotal', 'event_espresso'),
217
+						self::type_tax_sub_total => esc_html__('Tax Subtotal', 'event_espresso'),
218
+						self::type_tax           => esc_html__('Tax', 'event_espresso'),
219
+						self::type_total         => esc_html__('Total', 'event_espresso'),
220
+						self::type_cancellation  => esc_html__('Cancellation', 'event_espresso'),
221
+					)
222
+				),
223
+				'OBJ_ID'         => new EE_Foreign_Key_Int_Field(
224
+					'OBJ_ID',
225
+					esc_html__('ID of Item purchased.', 'event_espresso'),
226
+					true,
227
+					null,
228
+					$line_items_can_be_for
229
+				),
230
+				'OBJ_type'       => new EE_Any_Foreign_Model_Name_Field(
231
+					'OBJ_type',
232
+					esc_html__('Model Name this Line Item is for', 'event_espresso'),
233
+					true,
234
+					null,
235
+					$line_items_can_be_for
236
+				),
237
+				'LIN_timestamp'  => new EE_Datetime_Field(
238
+					'LIN_timestamp',
239
+					esc_html__('When the line item was created', 'event_espresso'),
240
+					false,
241
+					EE_Datetime_Field::now,
242
+					$timezone
243
+				),
244
+			),
245
+		);
246
+		$this->_model_relations = array(
247
+			'Transaction' => new EE_Belongs_To_Relation(),
248
+			'Ticket'      => new EE_Belongs_To_Any_Relation(),
249
+			'Price'       => new EE_Belongs_To_Any_Relation(),
250
+			'Event'       => new EE_Belongs_To_Any_Relation(),
251
+		);
252
+		$this->_model_chain_to_wp_user = 'Transaction.Registration.Event';
253
+		$this->_caps_slug = 'transactions';
254
+		parent::__construct($timezone);
255
+	}
256
+
257
+
258
+	/**
259
+	 * Gets all the line items for this transaction of the given type
260
+	 *
261
+	 * @param string             $line_item_type like one of EEM_Line_Item::type_*
262
+	 * @param EE_Transaction|int $transaction
263
+	 * @return EE_Base_Class[]|EE_Line_Item[]
264
+	 * @throws EE_Error
265
+	 * @throws InvalidArgumentException
266
+	 * @throws InvalidDataTypeException
267
+	 * @throws InvalidInterfaceException
268
+	 */
269
+	public function get_all_of_type_for_transaction($line_item_type, $transaction)
270
+	{
271
+		$transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
272
+		return $this->get_all(array(
273
+			array(
274
+				'LIN_type' => $line_item_type,
275
+				'TXN_ID'   => $transaction,
276
+			),
277
+		));
278
+	}
279
+
280
+
281
+	/**
282
+	 * Gets all line items unrelated to tickets that are normal line items
283
+	 * (eg shipping, promotions, and miscellaneous other stuff should probably fit in this category)
284
+	 *
285
+	 * @param EE_Transaction|int $transaction
286
+	 * @return EE_Base_Class[]|EE_Line_Item[]
287
+	 * @throws EE_Error
288
+	 * @throws InvalidArgumentException
289
+	 * @throws InvalidDataTypeException
290
+	 * @throws InvalidInterfaceException
291
+	 */
292
+	public function get_all_non_ticket_line_items_for_transaction($transaction)
293
+	{
294
+		$transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
295
+		return $this->get_all(array(
296
+			array(
297
+				'LIN_type' => self::type_line_item,
298
+				'TXN_ID'   => $transaction,
299
+				'OR'       => array(
300
+					'OBJ_type*notticket' => array('!=', EEM_Line_Item::OBJ_TYPE_TICKET),
301
+					'OBJ_type*null'      => array('IS_NULL'),
302
+				),
303
+			),
304
+		));
305
+	}
306
+
307
+
308
+	/**
309
+	 * Deletes line items with no transaction who have passed the transaction cutoff time.
310
+	 * This needs to be very efficient
311
+	 * because if there are spam bots afoot there will be LOTS of line items. Also MySQL doesn't allow a limit when
312
+	 * deleting and joining tables like this.
313
+	 *
314
+	 * @return int count of how many deleted
315
+	 * @throws EE_Error
316
+	 * @throws InvalidArgumentException
317
+	 * @throws InvalidDataTypeException
318
+	 * @throws InvalidInterfaceException
319
+	 */
320
+	public function delete_line_items_with_no_transaction()
321
+	{
322
+		/** @type WPDB $wpdb */
323
+		global $wpdb;
324
+		$time_to_leave_alone = apply_filters(
325
+			'FHEE__EEM_Line_Item__delete_line_items_with_no_transaction__time_to_leave_alone',
326
+			WEEK_IN_SECONDS
327
+		);
328
+		$query = $wpdb->prepare(
329
+			'DELETE li
330 330
 				FROM ' . $this->table() . ' li
331 331
 				LEFT JOIN ' . EEM_Transaction::instance()->table() . ' t ON li.TXN_ID = t.TXN_ID
332 332
 				WHERE t.TXN_ID IS NULL AND li.LIN_timestamp < %s',
333
-            // use GMT time because that's what TXN_timestamps are in
334
-            date('Y-m-d H:i:s', time() - $time_to_leave_alone)
335
-        );
336
-        return $wpdb->query($query);
337
-    }
338
-
339
-
340
-    /**
341
-     * get_line_item_for_transaction_object
342
-     * Gets a transaction's line item record for a specific object such as a EE_Event or EE_Ticket
343
-     *
344
-     * @param int           $TXN_ID
345
-     * @param EE_Base_Class $object
346
-     * @return EE_Base_Class[]|EE_Line_Item[]
347
-     * @throws EE_Error
348
-     * @throws InvalidArgumentException
349
-     * @throws InvalidDataTypeException
350
-     * @throws InvalidInterfaceException
351
-     * @throws ReflectionException
352
-     */
353
-    public function get_line_item_for_transaction_object($TXN_ID, EE_Base_Class $object)
354
-    {
355
-        return $this->get_all(array(
356
-            array(
357
-                'TXN_ID'   => $TXN_ID,
358
-                'OBJ_type' => str_replace('EE_', '', get_class($object)),
359
-                'OBJ_ID'   => $object->ID(),
360
-            ),
361
-        ));
362
-    }
363
-
364
-
365
-    /**
366
-     * get_object_line_items_for_transaction
367
-     * Gets all of the the object line items for a transaction, based on an object type plus an array of object IDs
368
-     *
369
-     * @param int    $TXN_ID
370
-     * @param string $OBJ_type
371
-     * @param array  $OBJ_IDs
372
-     * @return EE_Base_Class[]|EE_Line_Item[]
373
-     * @throws EE_Error
374
-     */
375
-    public function get_object_line_items_for_transaction(
376
-        $TXN_ID,
377
-        $OBJ_type = EEM_Line_Item::OBJ_TYPE_EVENT,
378
-        $OBJ_IDs = array()
379
-    ) {
380
-        $query_params = array(
381
-            'OBJ_type' => $OBJ_type,
382
-            // if incoming $OBJ_IDs is an array, then make sure it is formatted correctly for the query
383
-            'OBJ_ID'   => is_array($OBJ_IDs) && ! isset($OBJ_IDs['IN']) ? array('IN', $OBJ_IDs) : $OBJ_IDs,
384
-        );
385
-        if ($TXN_ID) {
386
-            $query_params['TXN_ID'] = $TXN_ID;
387
-        }
388
-        return $this->get_all(array($query_params));
389
-    }
390
-
391
-
392
-    /**
393
-     * get_all_ticket_line_items_for_transaction
394
-     *
395
-     * @param EE_Transaction $transaction
396
-     * @return EE_Base_Class[]|EE_Line_Item[]
397
-     * @throws EE_Error
398
-     * @throws InvalidArgumentException
399
-     * @throws InvalidDataTypeException
400
-     * @throws InvalidInterfaceException
401
-     * @throws ReflectionException
402
-     */
403
-    public function get_all_ticket_line_items_for_transaction(EE_Transaction $transaction)
404
-    {
405
-        return $this->get_all(array(
406
-            array(
407
-                'TXN_ID'   => $transaction->ID(),
408
-                'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
409
-            ),
410
-        ));
411
-    }
412
-
413
-
414
-    /**
415
-     * get_ticket_line_item_for_transaction
416
-     *
417
-     * @param int $TXN_ID
418
-     * @param int $TKT_ID
419
-     * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL
420
-     * @throws EE_Error
421
-     * @throws InvalidArgumentException
422
-     * @throws InvalidDataTypeException
423
-     * @throws InvalidInterfaceException
424
-     */
425
-    public function get_ticket_line_item_for_transaction($TXN_ID, $TKT_ID)
426
-    {
427
-        return $this->get_one(array(
428
-            array(
429
-                'TXN_ID'   => EEM_Transaction::instance()->ensure_is_ID($TXN_ID),
430
-                'OBJ_ID'   => $TKT_ID,
431
-                'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
432
-            ),
433
-        ));
434
-    }
435
-
436
-
437
-    /**
438
-     * get_existing_promotion_line_item
439
-     * searches the cart for existing line items for the specified promotion
440
-     *
441
-     * @since 1.0.0
442
-     * @param EE_Line_Item $parent_line_item
443
-     * @param EE_Promotion $promotion
444
-     * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL
445
-     * @throws EE_Error
446
-     * @throws InvalidArgumentException
447
-     * @throws InvalidDataTypeException
448
-     * @throws InvalidInterfaceException
449
-     * @throws ReflectionException
450
-     */
451
-    public function get_existing_promotion_line_item(EE_Line_Item $parent_line_item, EE_Promotion $promotion)
452
-    {
453
-        return $this->get_one(array(
454
-            array(
455
-                'TXN_ID'     => $parent_line_item->TXN_ID(),
456
-                'LIN_parent' => $parent_line_item->ID(),
457
-                'OBJ_type'   => EEM_Line_Item::OBJ_TYPE_PROMOTION,
458
-                'OBJ_ID'     => $promotion->ID(),
459
-            ),
460
-        ));
461
-    }
462
-
463
-
464
-    /**
465
-     * get_all_promotion_line_items
466
-     * searches the cart for any and all existing promotion line items
467
-     *
468
-     * @since   1.0.0
469
-     * @param EE_Line_Item $parent_line_item
470
-     * @return EE_Base_Class[]|EE_Line_Item[]
471
-     * @throws EE_Error
472
-     * @throws InvalidArgumentException
473
-     * @throws InvalidDataTypeException
474
-     * @throws InvalidInterfaceException
475
-     * @throws ReflectionException
476
-     */
477
-    public function get_all_promotion_line_items(EE_Line_Item $parent_line_item)
478
-    {
479
-        return $this->get_all(array(
480
-            array(
481
-                'TXN_ID'     => $parent_line_item->TXN_ID(),
482
-                'LIN_parent' => $parent_line_item->ID(),
483
-                'OBJ_type'   => EEM_Line_Item::OBJ_TYPE_PROMOTION,
484
-            ),
485
-        ));
486
-    }
487
-
488
-
489
-    /**
490
-     * Gets the registration's corresponding line item.
491
-     * Note: basically does NOT support having multiple line items for a single ticket,
492
-     * which would happen if some of the registrations had a price modifier while others didn't.
493
-     * In order to support that, we'd probably need a LIN_ID on registrations or something.
494
-     *
495
-     * @param EE_Registration $registration
496
-     * @return EE_Base_Class|EE_Line_ITem|EE_Soft_Delete_Base_Class|NULL
497
-     * @throws EE_Error
498
-     */
499
-    public function get_line_item_for_registration(EE_Registration $registration)
500
-    {
501
-        return $this->get_one($this->line_item_for_registration_query_params($registration));
502
-    }
503
-
504
-
505
-    /**
506
-     * Gets the query params used to retrieve a specific line item for the given registration
507
-     *
508
-     * @param EE_Registration $registration
509
-     * @param array           $original_query_params any extra query params you'd like to be merged with
510
-     * @return array @see
511
-     *      https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
512
-     * @throws EE_Error
513
-     */
514
-    public function line_item_for_registration_query_params(
515
-        EE_Registration $registration,
516
-        $original_query_params = array()
517
-    ) {
518
-        return array_replace_recursive($original_query_params, array(
519
-            array(
520
-                'OBJ_ID'   => $registration->ticket_ID(),
521
-                'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
522
-                'TXN_ID'   => $registration->transaction_ID(),
523
-            ),
524
-        ));
525
-    }
526
-
527
-
528
-    /**
529
-     * @return EE_Base_Class[]|EE_Line_Item[]
530
-     * @throws InvalidInterfaceException
531
-     * @throws InvalidDataTypeException
532
-     * @throws EE_Error
533
-     * @throws InvalidArgumentException
534
-     */
535
-    public function get_total_line_items_with_no_transaction()
536
-    {
537
-        return $this->get_total_line_items_for_carts();
538
-    }
539
-
540
-
541
-    /**
542
-     * @return EE_Base_Class[]|EE_Line_Item[]
543
-     * @throws InvalidInterfaceException
544
-     * @throws InvalidDataTypeException
545
-     * @throws EE_Error
546
-     * @throws InvalidArgumentException
547
-     */
548
-    public function get_total_line_items_for_active_carts()
549
-    {
550
-        return $this->get_total_line_items_for_carts(false);
551
-    }
552
-
553
-
554
-    /**
555
-     * @return EE_Base_Class[]|EE_Line_Item[]
556
-     * @throws InvalidInterfaceException
557
-     * @throws InvalidDataTypeException
558
-     * @throws EE_Error
559
-     * @throws InvalidArgumentException
560
-     */
561
-    public function get_total_line_items_for_expired_carts()
562
-    {
563
-        return $this->get_total_line_items_for_carts(true);
564
-    }
565
-
566
-
567
-    /**
568
-     * Returns an array of grand total line items where the TXN_ID is 0.
569
-     * If $expired is set to true, then only line items for expired sessions will be returned.
570
-     * If $expired is set to false, then only line items for active sessions will be returned.
571
-     *
572
-     * @param null $expired
573
-     * @return EE_Base_Class[]|EE_Line_Item[]
574
-     * @throws EE_Error
575
-     * @throws InvalidArgumentException
576
-     * @throws InvalidDataTypeException
577
-     * @throws InvalidInterfaceException
578
-     */
579
-    private function get_total_line_items_for_carts($expired = null)
580
-    {
581
-        $where_params = array(
582
-            'TXN_ID'   => 0,
583
-            'LIN_type' => 'total',
584
-        );
585
-        if ($expired !== null) {
586
-            /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
587
-            $session_lifespan = LoaderFactory::getLoader()->getShared(
588
-                'EventEspresso\core\domain\values\session\SessionLifespan'
589
-            );
590
-            $where_params['LIN_timestamp'] = array(
591
-                $expired ? '<=' : '>',
592
-                $session_lifespan->expiration(),
593
-            );
594
-        }
595
-        return $this->get_all(array($where_params));
596
-    }
597
-
598
-
599
-    /**
600
-     * Returns an array of ticket total line items where the TXN_ID is 0
601
-     * AND the timestamp is older than the session lifespan.
602
-     *
603
-     * @param int $timestamp
604
-     * @return EE_Base_Class[]|EE_Line_Item[]
605
-     * @throws EE_Error
606
-     * @throws InvalidArgumentException
607
-     * @throws InvalidDataTypeException
608
-     * @throws InvalidInterfaceException
609
-     */
610
-    public function getTicketLineItemsForExpiredCarts($timestamp = 0)
611
-    {
612
-        if (! absint($timestamp)) {
613
-            /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
614
-            $session_lifespan = LoaderFactory::getLoader()->getShared(
615
-                'EventEspresso\core\domain\values\session\SessionLifespan'
616
-            );
617
-            $timestamp = $session_lifespan->expiration();
618
-        }
619
-        return $this->get_all(
620
-            array(
621
-                array(
622
-                    'TXN_ID'        => 0,
623
-                    'OBJ_type'      => EEM_Line_Item::OBJ_TYPE_TICKET,
624
-                    'LIN_timestamp' => array('<=', $timestamp),
625
-                ),
626
-            )
627
-        );
628
-    }
333
+			// use GMT time because that's what TXN_timestamps are in
334
+			date('Y-m-d H:i:s', time() - $time_to_leave_alone)
335
+		);
336
+		return $wpdb->query($query);
337
+	}
338
+
339
+
340
+	/**
341
+	 * get_line_item_for_transaction_object
342
+	 * Gets a transaction's line item record for a specific object such as a EE_Event or EE_Ticket
343
+	 *
344
+	 * @param int           $TXN_ID
345
+	 * @param EE_Base_Class $object
346
+	 * @return EE_Base_Class[]|EE_Line_Item[]
347
+	 * @throws EE_Error
348
+	 * @throws InvalidArgumentException
349
+	 * @throws InvalidDataTypeException
350
+	 * @throws InvalidInterfaceException
351
+	 * @throws ReflectionException
352
+	 */
353
+	public function get_line_item_for_transaction_object($TXN_ID, EE_Base_Class $object)
354
+	{
355
+		return $this->get_all(array(
356
+			array(
357
+				'TXN_ID'   => $TXN_ID,
358
+				'OBJ_type' => str_replace('EE_', '', get_class($object)),
359
+				'OBJ_ID'   => $object->ID(),
360
+			),
361
+		));
362
+	}
363
+
364
+
365
+	/**
366
+	 * get_object_line_items_for_transaction
367
+	 * Gets all of the the object line items for a transaction, based on an object type plus an array of object IDs
368
+	 *
369
+	 * @param int    $TXN_ID
370
+	 * @param string $OBJ_type
371
+	 * @param array  $OBJ_IDs
372
+	 * @return EE_Base_Class[]|EE_Line_Item[]
373
+	 * @throws EE_Error
374
+	 */
375
+	public function get_object_line_items_for_transaction(
376
+		$TXN_ID,
377
+		$OBJ_type = EEM_Line_Item::OBJ_TYPE_EVENT,
378
+		$OBJ_IDs = array()
379
+	) {
380
+		$query_params = array(
381
+			'OBJ_type' => $OBJ_type,
382
+			// if incoming $OBJ_IDs is an array, then make sure it is formatted correctly for the query
383
+			'OBJ_ID'   => is_array($OBJ_IDs) && ! isset($OBJ_IDs['IN']) ? array('IN', $OBJ_IDs) : $OBJ_IDs,
384
+		);
385
+		if ($TXN_ID) {
386
+			$query_params['TXN_ID'] = $TXN_ID;
387
+		}
388
+		return $this->get_all(array($query_params));
389
+	}
390
+
391
+
392
+	/**
393
+	 * get_all_ticket_line_items_for_transaction
394
+	 *
395
+	 * @param EE_Transaction $transaction
396
+	 * @return EE_Base_Class[]|EE_Line_Item[]
397
+	 * @throws EE_Error
398
+	 * @throws InvalidArgumentException
399
+	 * @throws InvalidDataTypeException
400
+	 * @throws InvalidInterfaceException
401
+	 * @throws ReflectionException
402
+	 */
403
+	public function get_all_ticket_line_items_for_transaction(EE_Transaction $transaction)
404
+	{
405
+		return $this->get_all(array(
406
+			array(
407
+				'TXN_ID'   => $transaction->ID(),
408
+				'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
409
+			),
410
+		));
411
+	}
412
+
413
+
414
+	/**
415
+	 * get_ticket_line_item_for_transaction
416
+	 *
417
+	 * @param int $TXN_ID
418
+	 * @param int $TKT_ID
419
+	 * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL
420
+	 * @throws EE_Error
421
+	 * @throws InvalidArgumentException
422
+	 * @throws InvalidDataTypeException
423
+	 * @throws InvalidInterfaceException
424
+	 */
425
+	public function get_ticket_line_item_for_transaction($TXN_ID, $TKT_ID)
426
+	{
427
+		return $this->get_one(array(
428
+			array(
429
+				'TXN_ID'   => EEM_Transaction::instance()->ensure_is_ID($TXN_ID),
430
+				'OBJ_ID'   => $TKT_ID,
431
+				'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
432
+			),
433
+		));
434
+	}
435
+
436
+
437
+	/**
438
+	 * get_existing_promotion_line_item
439
+	 * searches the cart for existing line items for the specified promotion
440
+	 *
441
+	 * @since 1.0.0
442
+	 * @param EE_Line_Item $parent_line_item
443
+	 * @param EE_Promotion $promotion
444
+	 * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL
445
+	 * @throws EE_Error
446
+	 * @throws InvalidArgumentException
447
+	 * @throws InvalidDataTypeException
448
+	 * @throws InvalidInterfaceException
449
+	 * @throws ReflectionException
450
+	 */
451
+	public function get_existing_promotion_line_item(EE_Line_Item $parent_line_item, EE_Promotion $promotion)
452
+	{
453
+		return $this->get_one(array(
454
+			array(
455
+				'TXN_ID'     => $parent_line_item->TXN_ID(),
456
+				'LIN_parent' => $parent_line_item->ID(),
457
+				'OBJ_type'   => EEM_Line_Item::OBJ_TYPE_PROMOTION,
458
+				'OBJ_ID'     => $promotion->ID(),
459
+			),
460
+		));
461
+	}
462
+
463
+
464
+	/**
465
+	 * get_all_promotion_line_items
466
+	 * searches the cart for any and all existing promotion line items
467
+	 *
468
+	 * @since   1.0.0
469
+	 * @param EE_Line_Item $parent_line_item
470
+	 * @return EE_Base_Class[]|EE_Line_Item[]
471
+	 * @throws EE_Error
472
+	 * @throws InvalidArgumentException
473
+	 * @throws InvalidDataTypeException
474
+	 * @throws InvalidInterfaceException
475
+	 * @throws ReflectionException
476
+	 */
477
+	public function get_all_promotion_line_items(EE_Line_Item $parent_line_item)
478
+	{
479
+		return $this->get_all(array(
480
+			array(
481
+				'TXN_ID'     => $parent_line_item->TXN_ID(),
482
+				'LIN_parent' => $parent_line_item->ID(),
483
+				'OBJ_type'   => EEM_Line_Item::OBJ_TYPE_PROMOTION,
484
+			),
485
+		));
486
+	}
487
+
488
+
489
+	/**
490
+	 * Gets the registration's corresponding line item.
491
+	 * Note: basically does NOT support having multiple line items for a single ticket,
492
+	 * which would happen if some of the registrations had a price modifier while others didn't.
493
+	 * In order to support that, we'd probably need a LIN_ID on registrations or something.
494
+	 *
495
+	 * @param EE_Registration $registration
496
+	 * @return EE_Base_Class|EE_Line_ITem|EE_Soft_Delete_Base_Class|NULL
497
+	 * @throws EE_Error
498
+	 */
499
+	public function get_line_item_for_registration(EE_Registration $registration)
500
+	{
501
+		return $this->get_one($this->line_item_for_registration_query_params($registration));
502
+	}
503
+
504
+
505
+	/**
506
+	 * Gets the query params used to retrieve a specific line item for the given registration
507
+	 *
508
+	 * @param EE_Registration $registration
509
+	 * @param array           $original_query_params any extra query params you'd like to be merged with
510
+	 * @return array @see
511
+	 *      https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
512
+	 * @throws EE_Error
513
+	 */
514
+	public function line_item_for_registration_query_params(
515
+		EE_Registration $registration,
516
+		$original_query_params = array()
517
+	) {
518
+		return array_replace_recursive($original_query_params, array(
519
+			array(
520
+				'OBJ_ID'   => $registration->ticket_ID(),
521
+				'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
522
+				'TXN_ID'   => $registration->transaction_ID(),
523
+			),
524
+		));
525
+	}
526
+
527
+
528
+	/**
529
+	 * @return EE_Base_Class[]|EE_Line_Item[]
530
+	 * @throws InvalidInterfaceException
531
+	 * @throws InvalidDataTypeException
532
+	 * @throws EE_Error
533
+	 * @throws InvalidArgumentException
534
+	 */
535
+	public function get_total_line_items_with_no_transaction()
536
+	{
537
+		return $this->get_total_line_items_for_carts();
538
+	}
539
+
540
+
541
+	/**
542
+	 * @return EE_Base_Class[]|EE_Line_Item[]
543
+	 * @throws InvalidInterfaceException
544
+	 * @throws InvalidDataTypeException
545
+	 * @throws EE_Error
546
+	 * @throws InvalidArgumentException
547
+	 */
548
+	public function get_total_line_items_for_active_carts()
549
+	{
550
+		return $this->get_total_line_items_for_carts(false);
551
+	}
552
+
553
+
554
+	/**
555
+	 * @return EE_Base_Class[]|EE_Line_Item[]
556
+	 * @throws InvalidInterfaceException
557
+	 * @throws InvalidDataTypeException
558
+	 * @throws EE_Error
559
+	 * @throws InvalidArgumentException
560
+	 */
561
+	public function get_total_line_items_for_expired_carts()
562
+	{
563
+		return $this->get_total_line_items_for_carts(true);
564
+	}
565
+
566
+
567
+	/**
568
+	 * Returns an array of grand total line items where the TXN_ID is 0.
569
+	 * If $expired is set to true, then only line items for expired sessions will be returned.
570
+	 * If $expired is set to false, then only line items for active sessions will be returned.
571
+	 *
572
+	 * @param null $expired
573
+	 * @return EE_Base_Class[]|EE_Line_Item[]
574
+	 * @throws EE_Error
575
+	 * @throws InvalidArgumentException
576
+	 * @throws InvalidDataTypeException
577
+	 * @throws InvalidInterfaceException
578
+	 */
579
+	private function get_total_line_items_for_carts($expired = null)
580
+	{
581
+		$where_params = array(
582
+			'TXN_ID'   => 0,
583
+			'LIN_type' => 'total',
584
+		);
585
+		if ($expired !== null) {
586
+			/** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
587
+			$session_lifespan = LoaderFactory::getLoader()->getShared(
588
+				'EventEspresso\core\domain\values\session\SessionLifespan'
589
+			);
590
+			$where_params['LIN_timestamp'] = array(
591
+				$expired ? '<=' : '>',
592
+				$session_lifespan->expiration(),
593
+			);
594
+		}
595
+		return $this->get_all(array($where_params));
596
+	}
597
+
598
+
599
+	/**
600
+	 * Returns an array of ticket total line items where the TXN_ID is 0
601
+	 * AND the timestamp is older than the session lifespan.
602
+	 *
603
+	 * @param int $timestamp
604
+	 * @return EE_Base_Class[]|EE_Line_Item[]
605
+	 * @throws EE_Error
606
+	 * @throws InvalidArgumentException
607
+	 * @throws InvalidDataTypeException
608
+	 * @throws InvalidInterfaceException
609
+	 */
610
+	public function getTicketLineItemsForExpiredCarts($timestamp = 0)
611
+	{
612
+		if (! absint($timestamp)) {
613
+			/** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
614
+			$session_lifespan = LoaderFactory::getLoader()->getShared(
615
+				'EventEspresso\core\domain\values\session\SessionLifespan'
616
+			);
617
+			$timestamp = $session_lifespan->expiration();
618
+		}
619
+		return $this->get_all(
620
+			array(
621
+				array(
622
+					'TXN_ID'        => 0,
623
+					'OBJ_type'      => EEM_Line_Item::OBJ_TYPE_TICKET,
624
+					'LIN_timestamp' => array('<=', $timestamp),
625
+				),
626
+			)
627
+		);
628
+	}
629 629
 }
Please login to merge, or discard this patch.
modules/ticket_selector/EED_Ticket_Selector.module.php 3 patches
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -241,7 +241,7 @@
 block discarded – undo
241 241
 
242 242
 
243 243
     /**
244
-     * @return string
244
+     * @return boolean
245 245
      * @throws InvalidArgumentException
246 246
      * @throws InvalidInterfaceException
247 247
      * @throws InvalidDataTypeException
Please login to merge, or discard this patch.
Indentation   +441 added lines, -441 removed lines patch added patch discarded remove patch
@@ -17,445 +17,445 @@
 block discarded – undo
17 17
 class EED_Ticket_Selector extends EED_Module
18 18
 {
19 19
 
20
-    /**
21
-     * @var DisplayTicketSelector $ticket_selector
22
-     */
23
-    private static $ticket_selector;
24
-
25
-    /**
26
-     * @var TicketSelectorIframeEmbedButton $iframe_embed_button
27
-     */
28
-    private static $iframe_embed_button;
29
-
30
-
31
-    /**
32
-     * @return EED_Module|EED_Ticket_Selector
33
-     */
34
-    public static function instance()
35
-    {
36
-        return parent::get_instance(__CLASS__);
37
-    }
38
-
39
-
40
-    /**
41
-     * @return void
42
-     */
43
-    protected function set_config()
44
-    {
45
-        $this->set_config_section('template_settings');
46
-        $this->set_config_class('EE_Ticket_Selector_Config');
47
-        $this->set_config_name('EED_Ticket_Selector');
48
-    }
49
-
50
-
51
-    /**
52
-     *    set_hooks - for hooking into EE Core, other modules, etc
53
-     *
54
-     * @return void
55
-     */
56
-    public static function set_hooks()
57
-    {
58
-        // routing
59
-        EE_Config::register_route(
60
-            'iframe',
61
-            'EED_Ticket_Selector',
62
-            'ticket_selector_iframe',
63
-            'ticket_selector'
64
-        );
65
-        EE_Config::register_route(
66
-            'process_ticket_selections',
67
-            'EED_Ticket_Selector',
68
-            'process_ticket_selections'
69
-        );
70
-        EE_Config::register_route(
71
-            'cancel_ticket_selections',
72
-            'EED_Ticket_Selector',
73
-            'cancel_ticket_selections'
74
-        );
75
-        add_action('wp_loaded', array('EED_Ticket_Selector', 'set_definitions'), 2);
76
-        add_action('AHEE_event_details_header_bottom', array('EED_Ticket_Selector', 'display_ticket_selector'), 10, 1);
77
-        add_action('wp_enqueue_scripts', array('EED_Ticket_Selector', 'translate_js_strings'), 0);
78
-        add_action('wp_enqueue_scripts', array('EED_Ticket_Selector', 'load_tckt_slctr_assets'), 10);
79
-        EED_Ticket_Selector::loadIframeAssets();
80
-    }
81
-
82
-
83
-    /**
84
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
85
-     *
86
-     * @return void
87
-     */
88
-    public static function set_hooks_admin()
89
-    {
90
-        // hook into the end of the \EE_Admin_Page::_load_page_dependencies()
91
-        // to load assets for "espresso_events" page on the "edit" route (action)
92
-        add_action(
93
-            'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__edit',
94
-            array('EED_Ticket_Selector', 'ticket_selector_iframe_embed_button'),
95
-            10
96
-        );
97
-        /**
98
-         * Make sure assets for the ticket selector are loaded on the espresso registrations route so  admin side
99
-         * registrations work.
100
-         */
101
-        add_action(
102
-            'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_registrations__new_registration',
103
-            array('EED_Ticket_Selector', 'set_definitions'),
104
-            10
105
-        );
106
-    }
107
-
108
-
109
-    /**
110
-     *    set_definitions
111
-     *
112
-     * @return void
113
-     * @throws InvalidArgumentException
114
-     * @throws InvalidDataTypeException
115
-     * @throws InvalidInterfaceException
116
-     */
117
-    public static function set_definitions()
118
-    {
119
-        // don't do this twice
120
-        if (defined('TICKET_SELECTOR_ASSETS_URL')) {
121
-            return;
122
-        }
123
-        define('TICKET_SELECTOR_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
124
-        define(
125
-            'TICKET_SELECTOR_TEMPLATES_PATH',
126
-            str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/'
127
-        );
128
-        // if config is not set, initialize
129
-        if (
130
-            ! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config
131
-        ) {
132
-            EED_Ticket_Selector::instance()->set_config();
133
-            EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector = EED_Ticket_Selector::instance(
134
-            )->config();
135
-        }
136
-    }
137
-
138
-
139
-    /**
140
-     * @return DisplayTicketSelector
141
-     */
142
-    public static function ticketSelector()
143
-    {
144
-        if (! EED_Ticket_Selector::$ticket_selector instanceof DisplayTicketSelector) {
145
-            EED_Ticket_Selector::$ticket_selector = new DisplayTicketSelector(EED_Events_Archive::is_iframe());
146
-        }
147
-        return EED_Ticket_Selector::$ticket_selector;
148
-    }
149
-
150
-
151
-    /**
152
-     * gets the ball rolling
153
-     *
154
-     * @param WP $WP
155
-     * @return void
156
-     */
157
-    public function run($WP)
158
-    {
159
-    }
160
-
161
-
162
-    /**
163
-     * @return TicketSelectorIframeEmbedButton
164
-     */
165
-    public static function getIframeEmbedButton()
166
-    {
167
-        if (! self::$iframe_embed_button instanceof TicketSelectorIframeEmbedButton) {
168
-            self::$iframe_embed_button = new TicketSelectorIframeEmbedButton();
169
-        }
170
-        return self::$iframe_embed_button;
171
-    }
172
-
173
-
174
-    /**
175
-     * ticket_selector_iframe_embed_button
176
-     *
177
-     * @return void
178
-     * @throws EE_Error
179
-     */
180
-    public static function ticket_selector_iframe_embed_button()
181
-    {
182
-        $iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton();
183
-        $iframe_embed_button->addEventEditorIframeEmbedButton();
184
-    }
185
-
186
-
187
-    /**
188
-     * ticket_selector_iframe
189
-     *
190
-     * @return void
191
-     * @throws DomainException
192
-     * @throws EE_Error
193
-     */
194
-    public function ticket_selector_iframe()
195
-    {
196
-        $ticket_selector_iframe = new TicketSelectorIframe();
197
-        $ticket_selector_iframe->display();
198
-    }
199
-
200
-
201
-    /**
202
-     * creates buttons for selecting number of attendees for an event
203
-     *
204
-     * @param  WP_Post|int $event
205
-     * @param  bool        $view_details
206
-     * @return string
207
-     * @throws EE_Error
208
-     */
209
-    public static function display_ticket_selector($event = null, $view_details = false)
210
-    {
211
-        return EED_Ticket_Selector::ticketSelector()->display($event, $view_details);
212
-    }
213
-
214
-
215
-    /**
216
-     * @return array  or FALSE
217
-     * @throws \ReflectionException
218
-     * @throws \EE_Error
219
-     * @throws InvalidArgumentException
220
-     * @throws InvalidInterfaceException
221
-     * @throws InvalidDataTypeException
222
-     */
223
-    public function process_ticket_selections()
224
-    {
225
-        /** @var EventEspresso\modules\ticket_selector\ProcessTicketSelector $form */
226
-        $form = LoaderFactory::getLoader()->getShared('EventEspresso\modules\ticket_selector\ProcessTicketSelector');
227
-        return $form->processTicketSelections();
228
-    }
229
-
230
-
231
-    /**
232
-     * @return string
233
-     * @throws InvalidArgumentException
234
-     * @throws InvalidInterfaceException
235
-     * @throws InvalidDataTypeException
236
-     * @throws EE_Error
237
-     */
238
-    public static function cancel_ticket_selections()
239
-    {
240
-        /** @var EventEspresso\modules\ticket_selector\ProcessTicketSelector $form */
241
-        $form = LoaderFactory::getLoader()->getShared('EventEspresso\modules\ticket_selector\ProcessTicketSelector');
242
-        return $form->cancelTicketSelections();
243
-    }
244
-
245
-
246
-    /**
247
-     * @return void
248
-     */
249
-    public static function translate_js_strings()
250
-    {
251
-        EE_Registry::$i18n_js_strings['please_select_date_filter_notice'] = esc_html__(
252
-            'please select a datetime',
253
-            'event_espresso'
254
-        );
255
-    }
256
-
257
-
258
-    /**
259
-     * @return void
260
-     */
261
-    public static function load_tckt_slctr_assets()
262
-    {
263
-        if (apply_filters('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', false)) {
264
-            // add some style
265
-            wp_register_style(
266
-                'ticket_selector',
267
-                TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css',
268
-                array(),
269
-                EVENT_ESPRESSO_VERSION
270
-            );
271
-            wp_enqueue_style('ticket_selector');
272
-            // make it dance
273
-            wp_register_script(
274
-                'ticket_selector',
275
-                TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js',
276
-                array('espresso_core'),
277
-                EVENT_ESPRESSO_VERSION,
278
-                true
279
-            );
280
-            wp_enqueue_script('ticket_selector');
281
-            require_once EE_LIBRARIES
282
-                         . 'form_sections/strategies/display/EE_Checkbox_Dropdown_Selector_Display_Strategy.strategy.php';
283
-            \EE_Checkbox_Dropdown_Selector_Display_Strategy::enqueue_styles_and_scripts();
284
-        }
285
-    }
286
-
287
-
288
-    /**
289
-     * @return void
290
-     */
291
-    public static function loadIframeAssets()
292
-    {
293
-        // for event lists
294
-        add_filter(
295
-            'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
296
-            array('EED_Ticket_Selector', 'iframeCss')
297
-        );
298
-        add_filter(
299
-            'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
300
-            array('EED_Ticket_Selector', 'iframeJs')
301
-        );
302
-        // for ticket selectors
303
-        add_filter(
304
-            'FHEE__EED_Ticket_Selector__ticket_selector_iframe__css',
305
-            array('EED_Ticket_Selector', 'iframeCss')
306
-        );
307
-        add_filter(
308
-            'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
309
-            array('EED_Ticket_Selector', 'iframeJs')
310
-        );
311
-    }
312
-
313
-
314
-    /**
315
-     * Informs the rest of the forms system what CSS and JS is needed to display the input
316
-     *
317
-     * @param array $iframe_css
318
-     * @return array
319
-     */
320
-    public static function iframeCss(array $iframe_css)
321
-    {
322
-        $iframe_css['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css';
323
-        return $iframe_css;
324
-    }
325
-
326
-
327
-    /**
328
-     * Informs the rest of the forms system what CSS and JS is needed to display the input
329
-     *
330
-     * @param array $iframe_js
331
-     * @return array
332
-     */
333
-    public static function iframeJs(array $iframe_js)
334
-    {
335
-        $iframe_js['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js';
336
-        return $iframe_js;
337
-    }
338
-
339
-
340
-    /****************************** DEPRECATED ******************************/
341
-
342
-
343
-    /**
344
-     * @deprecated
345
-     * @return string
346
-     * @throws EE_Error
347
-     */
348
-    public static function display_view_details_btn()
349
-    {
350
-        // todo add doing_it_wrong() notice during next major version
351
-        return EED_Ticket_Selector::ticketSelector()->displayViewDetailsButton();
352
-    }
353
-
354
-
355
-    /**
356
-     * @deprecated
357
-     * @return string
358
-     * @throws EE_Error
359
-     */
360
-    public static function display_ticket_selector_submit()
361
-    {
362
-        // todo add doing_it_wrong() notice during next major version
363
-        return EED_Ticket_Selector::ticketSelector()->displaySubmitButton();
364
-    }
365
-
366
-
367
-    /**
368
-     * @deprecated
369
-     * @param string $permalink_string
370
-     * @param int    $id
371
-     * @param string $new_title
372
-     * @param string $new_slug
373
-     * @return string
374
-     * @throws InvalidArgumentException
375
-     * @throws InvalidDataTypeException
376
-     * @throws InvalidInterfaceException
377
-     */
378
-    public static function iframe_code_button($permalink_string, $id, $new_title = '', $new_slug = '')
379
-    {
380
-        // todo add doing_it_wrong() notice during next major version
381
-        if (
382
-            EE_Registry::instance()->REQ->get('page') === 'espresso_events'
383
-            && EE_Registry::instance()->REQ->get('action') === 'edit'
384
-        ) {
385
-            $iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton();
386
-            $iframe_embed_button->addEventEditorIframeEmbedButton();
387
-        }
388
-        return '';
389
-    }
390
-
391
-
392
-    /**
393
-     * @deprecated
394
-     * @param int    $ID
395
-     * @param string $external_url
396
-     * @return string
397
-     */
398
-    public static function ticket_selector_form_open($ID = 0, $external_url = '')
399
-    {
400
-        // todo add doing_it_wrong() notice during next major version
401
-        return EED_Ticket_Selector::ticketSelector()->formOpen($ID, $external_url);
402
-    }
403
-
404
-
405
-    /**
406
-     * @deprecated
407
-     * @return string
408
-     */
409
-    public static function ticket_selector_form_close()
410
-    {
411
-        // todo add doing_it_wrong() notice during next major version
412
-        return EED_Ticket_Selector::ticketSelector()->formClose();
413
-    }
414
-
415
-
416
-    /**
417
-     * @deprecated
418
-     * @return string
419
-     */
420
-    public static function no_tkt_slctr_end_dv()
421
-    {
422
-        // todo add doing_it_wrong() notice during next major version
423
-        return EED_Ticket_Selector::ticketSelector()->ticketSelectorEndDiv();
424
-    }
425
-
426
-
427
-    /**
428
-     * @deprecated 4.9.13
429
-     * @return string
430
-     */
431
-    public static function tkt_slctr_end_dv()
432
-    {
433
-        return EED_Ticket_Selector::ticketSelector()->clearTicketSelector();
434
-    }
435
-
436
-
437
-    /**
438
-     * @deprecated
439
-     * @return string
440
-     */
441
-    public static function clear_tkt_slctr()
442
-    {
443
-        return EED_Ticket_Selector::ticketSelector()->clearTicketSelector();
444
-    }
445
-
446
-
447
-    /**
448
-     * @deprecated
449
-     */
450
-    public static function load_tckt_slctr_assets_admin()
451
-    {
452
-        // todo add doing_it_wrong() notice during next major version
453
-        if (
454
-            EE_Registry::instance()->REQ->get('page') === 'espresso_events'
455
-            && EE_Registry::instance()->REQ->get('action') === 'edit'
456
-        ) {
457
-            $iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton();
458
-            $iframe_embed_button->embedButtonAssets();
459
-        }
460
-    }
20
+	/**
21
+	 * @var DisplayTicketSelector $ticket_selector
22
+	 */
23
+	private static $ticket_selector;
24
+
25
+	/**
26
+	 * @var TicketSelectorIframeEmbedButton $iframe_embed_button
27
+	 */
28
+	private static $iframe_embed_button;
29
+
30
+
31
+	/**
32
+	 * @return EED_Module|EED_Ticket_Selector
33
+	 */
34
+	public static function instance()
35
+	{
36
+		return parent::get_instance(__CLASS__);
37
+	}
38
+
39
+
40
+	/**
41
+	 * @return void
42
+	 */
43
+	protected function set_config()
44
+	{
45
+		$this->set_config_section('template_settings');
46
+		$this->set_config_class('EE_Ticket_Selector_Config');
47
+		$this->set_config_name('EED_Ticket_Selector');
48
+	}
49
+
50
+
51
+	/**
52
+	 *    set_hooks - for hooking into EE Core, other modules, etc
53
+	 *
54
+	 * @return void
55
+	 */
56
+	public static function set_hooks()
57
+	{
58
+		// routing
59
+		EE_Config::register_route(
60
+			'iframe',
61
+			'EED_Ticket_Selector',
62
+			'ticket_selector_iframe',
63
+			'ticket_selector'
64
+		);
65
+		EE_Config::register_route(
66
+			'process_ticket_selections',
67
+			'EED_Ticket_Selector',
68
+			'process_ticket_selections'
69
+		);
70
+		EE_Config::register_route(
71
+			'cancel_ticket_selections',
72
+			'EED_Ticket_Selector',
73
+			'cancel_ticket_selections'
74
+		);
75
+		add_action('wp_loaded', array('EED_Ticket_Selector', 'set_definitions'), 2);
76
+		add_action('AHEE_event_details_header_bottom', array('EED_Ticket_Selector', 'display_ticket_selector'), 10, 1);
77
+		add_action('wp_enqueue_scripts', array('EED_Ticket_Selector', 'translate_js_strings'), 0);
78
+		add_action('wp_enqueue_scripts', array('EED_Ticket_Selector', 'load_tckt_slctr_assets'), 10);
79
+		EED_Ticket_Selector::loadIframeAssets();
80
+	}
81
+
82
+
83
+	/**
84
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
85
+	 *
86
+	 * @return void
87
+	 */
88
+	public static function set_hooks_admin()
89
+	{
90
+		// hook into the end of the \EE_Admin_Page::_load_page_dependencies()
91
+		// to load assets for "espresso_events" page on the "edit" route (action)
92
+		add_action(
93
+			'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__edit',
94
+			array('EED_Ticket_Selector', 'ticket_selector_iframe_embed_button'),
95
+			10
96
+		);
97
+		/**
98
+		 * Make sure assets for the ticket selector are loaded on the espresso registrations route so  admin side
99
+		 * registrations work.
100
+		 */
101
+		add_action(
102
+			'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_registrations__new_registration',
103
+			array('EED_Ticket_Selector', 'set_definitions'),
104
+			10
105
+		);
106
+	}
107
+
108
+
109
+	/**
110
+	 *    set_definitions
111
+	 *
112
+	 * @return void
113
+	 * @throws InvalidArgumentException
114
+	 * @throws InvalidDataTypeException
115
+	 * @throws InvalidInterfaceException
116
+	 */
117
+	public static function set_definitions()
118
+	{
119
+		// don't do this twice
120
+		if (defined('TICKET_SELECTOR_ASSETS_URL')) {
121
+			return;
122
+		}
123
+		define('TICKET_SELECTOR_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
124
+		define(
125
+			'TICKET_SELECTOR_TEMPLATES_PATH',
126
+			str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/'
127
+		);
128
+		// if config is not set, initialize
129
+		if (
130
+			! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config
131
+		) {
132
+			EED_Ticket_Selector::instance()->set_config();
133
+			EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector = EED_Ticket_Selector::instance(
134
+			)->config();
135
+		}
136
+	}
137
+
138
+
139
+	/**
140
+	 * @return DisplayTicketSelector
141
+	 */
142
+	public static function ticketSelector()
143
+	{
144
+		if (! EED_Ticket_Selector::$ticket_selector instanceof DisplayTicketSelector) {
145
+			EED_Ticket_Selector::$ticket_selector = new DisplayTicketSelector(EED_Events_Archive::is_iframe());
146
+		}
147
+		return EED_Ticket_Selector::$ticket_selector;
148
+	}
149
+
150
+
151
+	/**
152
+	 * gets the ball rolling
153
+	 *
154
+	 * @param WP $WP
155
+	 * @return void
156
+	 */
157
+	public function run($WP)
158
+	{
159
+	}
160
+
161
+
162
+	/**
163
+	 * @return TicketSelectorIframeEmbedButton
164
+	 */
165
+	public static function getIframeEmbedButton()
166
+	{
167
+		if (! self::$iframe_embed_button instanceof TicketSelectorIframeEmbedButton) {
168
+			self::$iframe_embed_button = new TicketSelectorIframeEmbedButton();
169
+		}
170
+		return self::$iframe_embed_button;
171
+	}
172
+
173
+
174
+	/**
175
+	 * ticket_selector_iframe_embed_button
176
+	 *
177
+	 * @return void
178
+	 * @throws EE_Error
179
+	 */
180
+	public static function ticket_selector_iframe_embed_button()
181
+	{
182
+		$iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton();
183
+		$iframe_embed_button->addEventEditorIframeEmbedButton();
184
+	}
185
+
186
+
187
+	/**
188
+	 * ticket_selector_iframe
189
+	 *
190
+	 * @return void
191
+	 * @throws DomainException
192
+	 * @throws EE_Error
193
+	 */
194
+	public function ticket_selector_iframe()
195
+	{
196
+		$ticket_selector_iframe = new TicketSelectorIframe();
197
+		$ticket_selector_iframe->display();
198
+	}
199
+
200
+
201
+	/**
202
+	 * creates buttons for selecting number of attendees for an event
203
+	 *
204
+	 * @param  WP_Post|int $event
205
+	 * @param  bool        $view_details
206
+	 * @return string
207
+	 * @throws EE_Error
208
+	 */
209
+	public static function display_ticket_selector($event = null, $view_details = false)
210
+	{
211
+		return EED_Ticket_Selector::ticketSelector()->display($event, $view_details);
212
+	}
213
+
214
+
215
+	/**
216
+	 * @return array  or FALSE
217
+	 * @throws \ReflectionException
218
+	 * @throws \EE_Error
219
+	 * @throws InvalidArgumentException
220
+	 * @throws InvalidInterfaceException
221
+	 * @throws InvalidDataTypeException
222
+	 */
223
+	public function process_ticket_selections()
224
+	{
225
+		/** @var EventEspresso\modules\ticket_selector\ProcessTicketSelector $form */
226
+		$form = LoaderFactory::getLoader()->getShared('EventEspresso\modules\ticket_selector\ProcessTicketSelector');
227
+		return $form->processTicketSelections();
228
+	}
229
+
230
+
231
+	/**
232
+	 * @return string
233
+	 * @throws InvalidArgumentException
234
+	 * @throws InvalidInterfaceException
235
+	 * @throws InvalidDataTypeException
236
+	 * @throws EE_Error
237
+	 */
238
+	public static function cancel_ticket_selections()
239
+	{
240
+		/** @var EventEspresso\modules\ticket_selector\ProcessTicketSelector $form */
241
+		$form = LoaderFactory::getLoader()->getShared('EventEspresso\modules\ticket_selector\ProcessTicketSelector');
242
+		return $form->cancelTicketSelections();
243
+	}
244
+
245
+
246
+	/**
247
+	 * @return void
248
+	 */
249
+	public static function translate_js_strings()
250
+	{
251
+		EE_Registry::$i18n_js_strings['please_select_date_filter_notice'] = esc_html__(
252
+			'please select a datetime',
253
+			'event_espresso'
254
+		);
255
+	}
256
+
257
+
258
+	/**
259
+	 * @return void
260
+	 */
261
+	public static function load_tckt_slctr_assets()
262
+	{
263
+		if (apply_filters('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', false)) {
264
+			// add some style
265
+			wp_register_style(
266
+				'ticket_selector',
267
+				TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css',
268
+				array(),
269
+				EVENT_ESPRESSO_VERSION
270
+			);
271
+			wp_enqueue_style('ticket_selector');
272
+			// make it dance
273
+			wp_register_script(
274
+				'ticket_selector',
275
+				TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js',
276
+				array('espresso_core'),
277
+				EVENT_ESPRESSO_VERSION,
278
+				true
279
+			);
280
+			wp_enqueue_script('ticket_selector');
281
+			require_once EE_LIBRARIES
282
+						 . 'form_sections/strategies/display/EE_Checkbox_Dropdown_Selector_Display_Strategy.strategy.php';
283
+			\EE_Checkbox_Dropdown_Selector_Display_Strategy::enqueue_styles_and_scripts();
284
+		}
285
+	}
286
+
287
+
288
+	/**
289
+	 * @return void
290
+	 */
291
+	public static function loadIframeAssets()
292
+	{
293
+		// for event lists
294
+		add_filter(
295
+			'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
296
+			array('EED_Ticket_Selector', 'iframeCss')
297
+		);
298
+		add_filter(
299
+			'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
300
+			array('EED_Ticket_Selector', 'iframeJs')
301
+		);
302
+		// for ticket selectors
303
+		add_filter(
304
+			'FHEE__EED_Ticket_Selector__ticket_selector_iframe__css',
305
+			array('EED_Ticket_Selector', 'iframeCss')
306
+		);
307
+		add_filter(
308
+			'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
309
+			array('EED_Ticket_Selector', 'iframeJs')
310
+		);
311
+	}
312
+
313
+
314
+	/**
315
+	 * Informs the rest of the forms system what CSS and JS is needed to display the input
316
+	 *
317
+	 * @param array $iframe_css
318
+	 * @return array
319
+	 */
320
+	public static function iframeCss(array $iframe_css)
321
+	{
322
+		$iframe_css['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css';
323
+		return $iframe_css;
324
+	}
325
+
326
+
327
+	/**
328
+	 * Informs the rest of the forms system what CSS and JS is needed to display the input
329
+	 *
330
+	 * @param array $iframe_js
331
+	 * @return array
332
+	 */
333
+	public static function iframeJs(array $iframe_js)
334
+	{
335
+		$iframe_js['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js';
336
+		return $iframe_js;
337
+	}
338
+
339
+
340
+	/****************************** DEPRECATED ******************************/
341
+
342
+
343
+	/**
344
+	 * @deprecated
345
+	 * @return string
346
+	 * @throws EE_Error
347
+	 */
348
+	public static function display_view_details_btn()
349
+	{
350
+		// todo add doing_it_wrong() notice during next major version
351
+		return EED_Ticket_Selector::ticketSelector()->displayViewDetailsButton();
352
+	}
353
+
354
+
355
+	/**
356
+	 * @deprecated
357
+	 * @return string
358
+	 * @throws EE_Error
359
+	 */
360
+	public static function display_ticket_selector_submit()
361
+	{
362
+		// todo add doing_it_wrong() notice during next major version
363
+		return EED_Ticket_Selector::ticketSelector()->displaySubmitButton();
364
+	}
365
+
366
+
367
+	/**
368
+	 * @deprecated
369
+	 * @param string $permalink_string
370
+	 * @param int    $id
371
+	 * @param string $new_title
372
+	 * @param string $new_slug
373
+	 * @return string
374
+	 * @throws InvalidArgumentException
375
+	 * @throws InvalidDataTypeException
376
+	 * @throws InvalidInterfaceException
377
+	 */
378
+	public static function iframe_code_button($permalink_string, $id, $new_title = '', $new_slug = '')
379
+	{
380
+		// todo add doing_it_wrong() notice during next major version
381
+		if (
382
+			EE_Registry::instance()->REQ->get('page') === 'espresso_events'
383
+			&& EE_Registry::instance()->REQ->get('action') === 'edit'
384
+		) {
385
+			$iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton();
386
+			$iframe_embed_button->addEventEditorIframeEmbedButton();
387
+		}
388
+		return '';
389
+	}
390
+
391
+
392
+	/**
393
+	 * @deprecated
394
+	 * @param int    $ID
395
+	 * @param string $external_url
396
+	 * @return string
397
+	 */
398
+	public static function ticket_selector_form_open($ID = 0, $external_url = '')
399
+	{
400
+		// todo add doing_it_wrong() notice during next major version
401
+		return EED_Ticket_Selector::ticketSelector()->formOpen($ID, $external_url);
402
+	}
403
+
404
+
405
+	/**
406
+	 * @deprecated
407
+	 * @return string
408
+	 */
409
+	public static function ticket_selector_form_close()
410
+	{
411
+		// todo add doing_it_wrong() notice during next major version
412
+		return EED_Ticket_Selector::ticketSelector()->formClose();
413
+	}
414
+
415
+
416
+	/**
417
+	 * @deprecated
418
+	 * @return string
419
+	 */
420
+	public static function no_tkt_slctr_end_dv()
421
+	{
422
+		// todo add doing_it_wrong() notice during next major version
423
+		return EED_Ticket_Selector::ticketSelector()->ticketSelectorEndDiv();
424
+	}
425
+
426
+
427
+	/**
428
+	 * @deprecated 4.9.13
429
+	 * @return string
430
+	 */
431
+	public static function tkt_slctr_end_dv()
432
+	{
433
+		return EED_Ticket_Selector::ticketSelector()->clearTicketSelector();
434
+	}
435
+
436
+
437
+	/**
438
+	 * @deprecated
439
+	 * @return string
440
+	 */
441
+	public static function clear_tkt_slctr()
442
+	{
443
+		return EED_Ticket_Selector::ticketSelector()->clearTicketSelector();
444
+	}
445
+
446
+
447
+	/**
448
+	 * @deprecated
449
+	 */
450
+	public static function load_tckt_slctr_assets_admin()
451
+	{
452
+		// todo add doing_it_wrong() notice during next major version
453
+		if (
454
+			EE_Registry::instance()->REQ->get('page') === 'espresso_events'
455
+			&& EE_Registry::instance()->REQ->get('action') === 'edit'
456
+		) {
457
+			$iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton();
458
+			$iframe_embed_button->embedButtonAssets();
459
+		}
460
+	}
461 461
 }
Please login to merge, or discard this patch.
Spacing   +8 added lines, -8 removed lines patch added patch discarded remove patch
@@ -120,10 +120,10 @@  discard block
 block discarded – undo
120 120
         if (defined('TICKET_SELECTOR_ASSETS_URL')) {
121 121
             return;
122 122
         }
123
-        define('TICKET_SELECTOR_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
123
+        define('TICKET_SELECTOR_ASSETS_URL', plugin_dir_url(__FILE__).'assets/');
124 124
         define(
125 125
             'TICKET_SELECTOR_TEMPLATES_PATH',
126
-            str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/'
126
+            str_replace('\\', '/', plugin_dir_path(__FILE__)).'templates/'
127 127
         );
128 128
         // if config is not set, initialize
129 129
         if (
@@ -141,7 +141,7 @@  discard block
 block discarded – undo
141 141
      */
142 142
     public static function ticketSelector()
143 143
     {
144
-        if (! EED_Ticket_Selector::$ticket_selector instanceof DisplayTicketSelector) {
144
+        if ( ! EED_Ticket_Selector::$ticket_selector instanceof DisplayTicketSelector) {
145 145
             EED_Ticket_Selector::$ticket_selector = new DisplayTicketSelector(EED_Events_Archive::is_iframe());
146 146
         }
147 147
         return EED_Ticket_Selector::$ticket_selector;
@@ -164,7 +164,7 @@  discard block
 block discarded – undo
164 164
      */
165 165
     public static function getIframeEmbedButton()
166 166
     {
167
-        if (! self::$iframe_embed_button instanceof TicketSelectorIframeEmbedButton) {
167
+        if ( ! self::$iframe_embed_button instanceof TicketSelectorIframeEmbedButton) {
168 168
             self::$iframe_embed_button = new TicketSelectorIframeEmbedButton();
169 169
         }
170 170
         return self::$iframe_embed_button;
@@ -264,7 +264,7 @@  discard block
 block discarded – undo
264 264
             // add some style
265 265
             wp_register_style(
266 266
                 'ticket_selector',
267
-                TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css',
267
+                TICKET_SELECTOR_ASSETS_URL.'ticket_selector.css',
268 268
                 array(),
269 269
                 EVENT_ESPRESSO_VERSION
270 270
             );
@@ -272,7 +272,7 @@  discard block
 block discarded – undo
272 272
             // make it dance
273 273
             wp_register_script(
274 274
                 'ticket_selector',
275
-                TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js',
275
+                TICKET_SELECTOR_ASSETS_URL.'ticket_selector.js',
276 276
                 array('espresso_core'),
277 277
                 EVENT_ESPRESSO_VERSION,
278 278
                 true
@@ -319,7 +319,7 @@  discard block
 block discarded – undo
319 319
      */
320 320
     public static function iframeCss(array $iframe_css)
321 321
     {
322
-        $iframe_css['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css';
322
+        $iframe_css['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL.'ticket_selector.css';
323 323
         return $iframe_css;
324 324
     }
325 325
 
@@ -332,7 +332,7 @@  discard block
 block discarded – undo
332 332
      */
333 333
     public static function iframeJs(array $iframe_js)
334 334
     {
335
-        $iframe_js['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js';
335
+        $iframe_js['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL.'ticket_selector.js';
336 336
         return $iframe_js;
337 337
     }
338 338
 
Please login to merge, or discard this patch.
core/domain/services/custom_post_types/RegisterCustomTaxonomyTerms.php 2 patches
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -65,7 +65,7 @@
 block discarded – undo
65 65
      */
66 66
     public function registerCustomTaxonomyTerm($taxonomy, $term_slug, array $cpt_slugs = array())
67 67
     {
68
-        $this->custom_taxonomy_terms[][ $term_slug ] = new CustomTaxonomyTerm(
68
+        $this->custom_taxonomy_terms[][$term_slug] = new CustomTaxonomyTerm(
69 69
             $taxonomy,
70 70
             $term_slug,
71 71
             $cpt_slugs
Please login to merge, or discard this patch.
Indentation   +177 added lines, -177 removed lines patch added patch discarded remove patch
@@ -16,181 +16,181 @@
 block discarded – undo
16 16
 class RegisterCustomTaxonomyTerms
17 17
 {
18 18
 
19
-    /**
20
-     * @var array[] $custom_taxonomy_terms
21
-     */
22
-    public $custom_taxonomy_terms = array();
23
-
24
-
25
-    /**
26
-     * RegisterCustomTaxonomyTerms constructor.
27
-     */
28
-    public function __construct()
29
-    {
30
-        // hook into save_post so that we can make sure that the default terms get saved on publish of registered cpts
31
-        // IF they don't have a term for that taxonomy set.
32
-        add_action('save_post', array($this, 'saveDefaultTerm'), 100, 2);
33
-        do_action(
34
-            'AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end',
35
-            $this
36
-        );
37
-    }
38
-
39
-
40
-    public function registerCustomTaxonomyTerms()
41
-    {
42
-        // setup default terms in any of our taxonomies (but only if we're in admin).
43
-        // Why not added via register_activation_hook?
44
-        // Because it's possible that in future iterations of EE we may add new defaults for specialized taxonomies
45
-        // (think event_types) and register_activation_hook only reliably runs when a user manually activates the plugin.
46
-        // Keep in mind that this will READ these terms if they are deleted by the user.  Hence MUST use terms.
47
-        // if ( is_admin() ) {
48
-        // $this->set_must_use_event_types();
49
-        // }
50
-        // set default terms
51
-        $this->registerCustomTaxonomyTerm(
52
-            'espresso_event_type',
53
-            'single-event',
54
-            array('espresso_events')
55
-        );
56
-    }
57
-
58
-
59
-    /**
60
-     * Allows us to set what the default will be for terms when a cpt is PUBLISHED.
61
-     *
62
-     * @param string $taxonomy  The taxonomy we're using for the default term
63
-     * @param string $term_slug The slug of the term that will be the default.
64
-     * @param array  $cpt_slugs An array of custom post types we want the default assigned to
65
-     */
66
-    public function registerCustomTaxonomyTerm($taxonomy, $term_slug, array $cpt_slugs = array())
67
-    {
68
-        $this->custom_taxonomy_terms[][ $term_slug ] = new CustomTaxonomyTerm(
69
-            $taxonomy,
70
-            $term_slug,
71
-            $cpt_slugs
72
-        );
73
-    }
74
-
75
-
76
-    /**
77
-     * hooked into the wp 'save_post' action hook for setting our default terms found in the $_default_terms property
78
-     *
79
-     * @param  int     $post_id ID of CPT being saved
80
-     * @param  WP_Post $post    Post object
81
-     * @return void
82
-     */
83
-    public function saveDefaultTerm($post_id, WP_Post $post)
84
-    {
85
-        if (empty($this->custom_taxonomy_terms)) {
86
-            return;
87
-        }
88
-        // no default terms set so lets just exit.
89
-        foreach ($this->custom_taxonomy_terms as $custom_taxonomy_terms) {
90
-            foreach ($custom_taxonomy_terms as $custom_taxonomy_term) {
91
-                if (
92
-                    $post->post_status === 'publish'
93
-                    && $custom_taxonomy_term instanceof CustomTaxonomyTerm
94
-                    && in_array($post->post_type, $custom_taxonomy_term->customPostTypeSlugs(), true)
95
-                ) {
96
-                    // note some error proofing going on here to save unnecessary db queries
97
-                    $taxonomies = get_object_taxonomies($post->post_type);
98
-                    foreach ($taxonomies as $taxonomy) {
99
-                        $terms = wp_get_post_terms($post_id, $taxonomy);
100
-                        if (empty($terms) && $taxonomy === $custom_taxonomy_term->taxonomySlug()) {
101
-                            wp_set_object_terms(
102
-                                $post_id,
103
-                                array($custom_taxonomy_term->termSlug()),
104
-                                $taxonomy
105
-                            );
106
-                        }
107
-                    }
108
-                }
109
-            }
110
-        }
111
-    }
112
-
113
-
114
-    /**
115
-     * @return void
116
-     */
117
-    public function setMustUseEventTypes()
118
-    {
119
-        $term_details = array(
120
-            // Attendee's register for the first date-time only
121
-            'single-event'    => array(
122
-                'term' => esc_html__('Single Event', 'event_espresso'),
123
-                'desc' => esc_html__(
124
-                    'A single event that spans one or more consecutive days.',
125
-                    'event_espresso'
126
-                ),
127
-            ),
128
-            // example: a party or two-day long workshop
129
-            // Attendee's can register for any of the date-times
130
-            'multi-event'     => array(
131
-                'term' => esc_html__('Multi Event', 'event_espresso'),
132
-                'desc' => esc_html__(
133
-                    'Multiple, separate, but related events that occur on consecutive days.',
134
-                    'event_espresso'
135
-                ),
136
-            ),
137
-            // example: a three day music festival or week long conference
138
-            // Attendee's register for the first date-time only
139
-            'event-series'    => array(
140
-                'term' => esc_html__('Event Series', 'event_espresso'),
141
-                'desc' => esc_html__(
142
-                    ' Multiple events that occur over multiple non-consecutive days.',
143
-                    'event_espresso'
144
-                ),
145
-            ),
146
-            // example: an 8 week introduction to basket weaving course
147
-            // Attendee's can register for any of the date-times.
148
-            'recurring-event' => array(
149
-                'term' => esc_html__('Recurring Event', 'event_espresso'),
150
-                'desc' => esc_html__(
151
-                    'Multiple events that occur over multiple non-consecutive days.',
152
-                    'event_espresso'
153
-                ),
154
-            ),
155
-            // example: a yoga class
156
-            'ongoing'         => array(
157
-                'term' => esc_html__('Ongoing Event', 'event_espresso'),
158
-                'desc' => esc_html__(
159
-                    'An "event" that people can purchase tickets to gain access for anytime for this event regardless of date times on the event',
160
-                    'event_espresso'
161
-                ),
162
-            )
163
-            // example: access to a museum
164
-            // 'walk-in' => array( esc_html__('Walk In', 'event_espresso'), esc_html__('Single datetime and single entry recurring events. Attendees register for one or multiple datetimes individually.', 'event_espresso') ),
165
-            // 'reservation' => array( esc_html__('Reservation', 'event_espresso'), esc_html__('Reservations are created by specifying available datetimes and quantities. Attendees choose from the available datetimes and specify the quantity available (if the maximum is greater than 1)') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1
166
-            // 'multiple-session' => array( esc_html__('Multiple Session', 'event_espresso'), esc_html__('Multiple event, multiple datetime, hierarchically organized, custom entry events. Attendees may be required to register for a parent event before being allowed to register for child events. Attendees can register for any combination of child events as long as the datetimes do not conflict. Parent and child events may have additional fees or registration questions.') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1
167
-            // 'appointment' => array( esc_html__('Appointments', 'event_espresso'), esc_html__('Time slotted events where datetimes are generally in hours or minutes. For example, attendees can register for a single 15 minute or 1 hour time slot and this type of availability frequently reoccurs.', 'event_espresso') )
168
-        );
169
-        $this->setMustUseTerms('espresso_event_type', $term_details);
170
-    }
171
-
172
-
173
-    /**
174
-     * wrapper method for handling the setting up of initial terms in the db (if they don't already exist).
175
-     * Note this should ONLY be used for terms that always must be present.  Be aware that if an initial term is
176
-     * deleted then it WILL be recreated.
177
-     *
178
-     * @param string $taxonomy     The name of the taxonomy
179
-     * @param array  $term_details An array of term details indexed by slug and containing Name of term, and
180
-     *                             description as the elements in the array
181
-     * @return void
182
-     */
183
-    public function setMustUseTerms($taxonomy, $term_details)
184
-    {
185
-        $term_details = (array) $term_details;
186
-        foreach ($term_details as $slug => $details) {
187
-            if (isset($details['term'], $details['desc']) && ! term_exists($slug, $taxonomy)) {
188
-                $insert_arr = array(
189
-                    'slug'        => $slug,
190
-                    'description' => $details['desc'],
191
-                );
192
-                wp_insert_term($details['term'], $taxonomy, $insert_arr);
193
-            }
194
-        }
195
-    }
19
+	/**
20
+	 * @var array[] $custom_taxonomy_terms
21
+	 */
22
+	public $custom_taxonomy_terms = array();
23
+
24
+
25
+	/**
26
+	 * RegisterCustomTaxonomyTerms constructor.
27
+	 */
28
+	public function __construct()
29
+	{
30
+		// hook into save_post so that we can make sure that the default terms get saved on publish of registered cpts
31
+		// IF they don't have a term for that taxonomy set.
32
+		add_action('save_post', array($this, 'saveDefaultTerm'), 100, 2);
33
+		do_action(
34
+			'AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end',
35
+			$this
36
+		);
37
+	}
38
+
39
+
40
+	public function registerCustomTaxonomyTerms()
41
+	{
42
+		// setup default terms in any of our taxonomies (but only if we're in admin).
43
+		// Why not added via register_activation_hook?
44
+		// Because it's possible that in future iterations of EE we may add new defaults for specialized taxonomies
45
+		// (think event_types) and register_activation_hook only reliably runs when a user manually activates the plugin.
46
+		// Keep in mind that this will READ these terms if they are deleted by the user.  Hence MUST use terms.
47
+		// if ( is_admin() ) {
48
+		// $this->set_must_use_event_types();
49
+		// }
50
+		// set default terms
51
+		$this->registerCustomTaxonomyTerm(
52
+			'espresso_event_type',
53
+			'single-event',
54
+			array('espresso_events')
55
+		);
56
+	}
57
+
58
+
59
+	/**
60
+	 * Allows us to set what the default will be for terms when a cpt is PUBLISHED.
61
+	 *
62
+	 * @param string $taxonomy  The taxonomy we're using for the default term
63
+	 * @param string $term_slug The slug of the term that will be the default.
64
+	 * @param array  $cpt_slugs An array of custom post types we want the default assigned to
65
+	 */
66
+	public function registerCustomTaxonomyTerm($taxonomy, $term_slug, array $cpt_slugs = array())
67
+	{
68
+		$this->custom_taxonomy_terms[][ $term_slug ] = new CustomTaxonomyTerm(
69
+			$taxonomy,
70
+			$term_slug,
71
+			$cpt_slugs
72
+		);
73
+	}
74
+
75
+
76
+	/**
77
+	 * hooked into the wp 'save_post' action hook for setting our default terms found in the $_default_terms property
78
+	 *
79
+	 * @param  int     $post_id ID of CPT being saved
80
+	 * @param  WP_Post $post    Post object
81
+	 * @return void
82
+	 */
83
+	public function saveDefaultTerm($post_id, WP_Post $post)
84
+	{
85
+		if (empty($this->custom_taxonomy_terms)) {
86
+			return;
87
+		}
88
+		// no default terms set so lets just exit.
89
+		foreach ($this->custom_taxonomy_terms as $custom_taxonomy_terms) {
90
+			foreach ($custom_taxonomy_terms as $custom_taxonomy_term) {
91
+				if (
92
+					$post->post_status === 'publish'
93
+					&& $custom_taxonomy_term instanceof CustomTaxonomyTerm
94
+					&& in_array($post->post_type, $custom_taxonomy_term->customPostTypeSlugs(), true)
95
+				) {
96
+					// note some error proofing going on here to save unnecessary db queries
97
+					$taxonomies = get_object_taxonomies($post->post_type);
98
+					foreach ($taxonomies as $taxonomy) {
99
+						$terms = wp_get_post_terms($post_id, $taxonomy);
100
+						if (empty($terms) && $taxonomy === $custom_taxonomy_term->taxonomySlug()) {
101
+							wp_set_object_terms(
102
+								$post_id,
103
+								array($custom_taxonomy_term->termSlug()),
104
+								$taxonomy
105
+							);
106
+						}
107
+					}
108
+				}
109
+			}
110
+		}
111
+	}
112
+
113
+
114
+	/**
115
+	 * @return void
116
+	 */
117
+	public function setMustUseEventTypes()
118
+	{
119
+		$term_details = array(
120
+			// Attendee's register for the first date-time only
121
+			'single-event'    => array(
122
+				'term' => esc_html__('Single Event', 'event_espresso'),
123
+				'desc' => esc_html__(
124
+					'A single event that spans one or more consecutive days.',
125
+					'event_espresso'
126
+				),
127
+			),
128
+			// example: a party or two-day long workshop
129
+			// Attendee's can register for any of the date-times
130
+			'multi-event'     => array(
131
+				'term' => esc_html__('Multi Event', 'event_espresso'),
132
+				'desc' => esc_html__(
133
+					'Multiple, separate, but related events that occur on consecutive days.',
134
+					'event_espresso'
135
+				),
136
+			),
137
+			// example: a three day music festival or week long conference
138
+			// Attendee's register for the first date-time only
139
+			'event-series'    => array(
140
+				'term' => esc_html__('Event Series', 'event_espresso'),
141
+				'desc' => esc_html__(
142
+					' Multiple events that occur over multiple non-consecutive days.',
143
+					'event_espresso'
144
+				),
145
+			),
146
+			// example: an 8 week introduction to basket weaving course
147
+			// Attendee's can register for any of the date-times.
148
+			'recurring-event' => array(
149
+				'term' => esc_html__('Recurring Event', 'event_espresso'),
150
+				'desc' => esc_html__(
151
+					'Multiple events that occur over multiple non-consecutive days.',
152
+					'event_espresso'
153
+				),
154
+			),
155
+			// example: a yoga class
156
+			'ongoing'         => array(
157
+				'term' => esc_html__('Ongoing Event', 'event_espresso'),
158
+				'desc' => esc_html__(
159
+					'An "event" that people can purchase tickets to gain access for anytime for this event regardless of date times on the event',
160
+					'event_espresso'
161
+				),
162
+			)
163
+			// example: access to a museum
164
+			// 'walk-in' => array( esc_html__('Walk In', 'event_espresso'), esc_html__('Single datetime and single entry recurring events. Attendees register for one or multiple datetimes individually.', 'event_espresso') ),
165
+			// 'reservation' => array( esc_html__('Reservation', 'event_espresso'), esc_html__('Reservations are created by specifying available datetimes and quantities. Attendees choose from the available datetimes and specify the quantity available (if the maximum is greater than 1)') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1
166
+			// 'multiple-session' => array( esc_html__('Multiple Session', 'event_espresso'), esc_html__('Multiple event, multiple datetime, hierarchically organized, custom entry events. Attendees may be required to register for a parent event before being allowed to register for child events. Attendees can register for any combination of child events as long as the datetimes do not conflict. Parent and child events may have additional fees or registration questions.') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1
167
+			// 'appointment' => array( esc_html__('Appointments', 'event_espresso'), esc_html__('Time slotted events where datetimes are generally in hours or minutes. For example, attendees can register for a single 15 minute or 1 hour time slot and this type of availability frequently reoccurs.', 'event_espresso') )
168
+		);
169
+		$this->setMustUseTerms('espresso_event_type', $term_details);
170
+	}
171
+
172
+
173
+	/**
174
+	 * wrapper method for handling the setting up of initial terms in the db (if they don't already exist).
175
+	 * Note this should ONLY be used for terms that always must be present.  Be aware that if an initial term is
176
+	 * deleted then it WILL be recreated.
177
+	 *
178
+	 * @param string $taxonomy     The name of the taxonomy
179
+	 * @param array  $term_details An array of term details indexed by slug and containing Name of term, and
180
+	 *                             description as the elements in the array
181
+	 * @return void
182
+	 */
183
+	public function setMustUseTerms($taxonomy, $term_details)
184
+	{
185
+		$term_details = (array) $term_details;
186
+		foreach ($term_details as $slug => $details) {
187
+			if (isset($details['term'], $details['desc']) && ! term_exists($slug, $taxonomy)) {
188
+				$insert_arr = array(
189
+					'slug'        => $slug,
190
+					'description' => $details['desc'],
191
+				);
192
+				wp_insert_term($details['term'], $taxonomy, $insert_arr);
193
+			}
194
+		}
195
+	}
196 196
 }
Please login to merge, or discard this patch.
core/services/loaders/CoreLoader.php 2 patches
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -47,7 +47,7 @@
 block discarded – undo
47 47
      */
48 48
     public function __construct($generator)
49 49
     {
50
-        if (! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
50
+        if ( ! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
51 51
             throw new InvalidArgumentException(
52 52
                 esc_html__(
53 53
                     'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.',
Please login to merge, or discard this patch.
Indentation   +98 added lines, -98 removed lines patch added patch discarded remove patch
@@ -29,108 +29,108 @@
 block discarded – undo
29 29
 class CoreLoader implements LoaderDecoratorInterface
30 30
 {
31 31
 
32
-    /**
33
-     * @var EE_Registry|CoffeeShop $generator
34
-     */
35
-    private $generator;
32
+	/**
33
+	 * @var EE_Registry|CoffeeShop $generator
34
+	 */
35
+	private $generator;
36 36
 
37 37
 
38
-    /**
39
-     * CoreLoader constructor.
40
-     *
41
-     * @param EE_Registry|CoffeeShop $generator
42
-     * @throws InvalidArgumentException
43
-     */
44
-    public function __construct($generator)
45
-    {
46
-        if (! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
47
-            throw new InvalidArgumentException(
48
-                esc_html__(
49
-                    'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.',
50
-                    'event_espresso'
51
-                )
52
-            );
53
-        }
54
-        $this->generator = $generator;
55
-    }
38
+	/**
39
+	 * CoreLoader constructor.
40
+	 *
41
+	 * @param EE_Registry|CoffeeShop $generator
42
+	 * @throws InvalidArgumentException
43
+	 */
44
+	public function __construct($generator)
45
+	{
46
+		if (! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
47
+			throw new InvalidArgumentException(
48
+				esc_html__(
49
+					'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.',
50
+					'event_espresso'
51
+				)
52
+			);
53
+		}
54
+		$this->generator = $generator;
55
+	}
56 56
 
57 57
 
58
-    /**
59
-     * Calls the appropriate loading method from the installed generator;
60
-     * If EE_Registry is being used, then the additional parameters for the EE_Registry::create() method
61
-     * can be added to the $arguments array and they will be extracted and passed to EE_Registry::create(),
62
-     * but NOT to the class being instantiated.
63
-     * This is done by adding the parameters to the $arguments array as follows:
64
-     *  array(
65
-     *      'EE_Registry::create(from_db)'   => true, // boolean value, default = false
66
-     *      'EE_Registry::create(load_only)' => true, // boolean value, default = false
67
-     *      'EE_Registry::create(addon)'     => true, // boolean value, default = false
68
-     *  )
69
-     *
70
-     * @param string $fqcn
71
-     * @param array  $arguments
72
-     * @param bool   $shared
73
-     * @return mixed
74
-     * @throws OutOfBoundsException
75
-     * @throws ServiceExistsException
76
-     * @throws InstantiationException
77
-     * @throws InvalidIdentifierException
78
-     * @throws InvalidDataTypeException
79
-     * @throws InvalidClassException
80
-     * @throws EE_Error
81
-     * @throws ServiceNotFoundException
82
-     * @throws ReflectionException
83
-     * @throws InvalidInterfaceException
84
-     * @throws InvalidArgumentException
85
-     */
86
-    public function load($fqcn, $arguments = array(), $shared = true)
87
-    {
88
-        $shared = filter_var($shared, FILTER_VALIDATE_BOOLEAN);
89
-        if ($this->generator instanceof EE_Registry) {
90
-            // check if additional EE_Registry::create() arguments have been passed
91
-            // from_db
92
-            $from_db = isset($arguments['EE_Registry::create(from_db)'])
93
-                ? filter_var($arguments['EE_Registry::create(from_db)'], FILTER_VALIDATE_BOOLEAN)
94
-                : false;
95
-            // load_only
96
-            $load_only = isset($arguments['EE_Registry::create(load_only)'])
97
-                ? filter_var($arguments['EE_Registry::create(load_only)'], FILTER_VALIDATE_BOOLEAN)
98
-                : false;
99
-            // addon
100
-            $addon = isset($arguments['EE_Registry::create(addon)'])
101
-                ? filter_var($arguments['EE_Registry::create(addon)'], FILTER_VALIDATE_BOOLEAN)
102
-                : false;
103
-            unset(
104
-                $arguments['EE_Registry::create(from_db)'],
105
-                $arguments['EE_Registry::create(load_only)'],
106
-                $arguments['EE_Registry::create(addon)']
107
-            );
108
-            // addons need to be cached on EE_Registry
109
-            $shared = $addon ? true : $shared;
110
-            return $this->generator->create(
111
-                $fqcn,
112
-                $arguments,
113
-                $shared,
114
-                $from_db,
115
-                $load_only,
116
-                $addon
117
-            );
118
-        }
119
-        return $this->generator->brew(
120
-            $fqcn,
121
-            $arguments,
122
-            $shared ? CoffeeMaker::BREW_SHARED : CoffeeMaker::BREW_NEW
123
-        );
124
-    }
58
+	/**
59
+	 * Calls the appropriate loading method from the installed generator;
60
+	 * If EE_Registry is being used, then the additional parameters for the EE_Registry::create() method
61
+	 * can be added to the $arguments array and they will be extracted and passed to EE_Registry::create(),
62
+	 * but NOT to the class being instantiated.
63
+	 * This is done by adding the parameters to the $arguments array as follows:
64
+	 *  array(
65
+	 *      'EE_Registry::create(from_db)'   => true, // boolean value, default = false
66
+	 *      'EE_Registry::create(load_only)' => true, // boolean value, default = false
67
+	 *      'EE_Registry::create(addon)'     => true, // boolean value, default = false
68
+	 *  )
69
+	 *
70
+	 * @param string $fqcn
71
+	 * @param array  $arguments
72
+	 * @param bool   $shared
73
+	 * @return mixed
74
+	 * @throws OutOfBoundsException
75
+	 * @throws ServiceExistsException
76
+	 * @throws InstantiationException
77
+	 * @throws InvalidIdentifierException
78
+	 * @throws InvalidDataTypeException
79
+	 * @throws InvalidClassException
80
+	 * @throws EE_Error
81
+	 * @throws ServiceNotFoundException
82
+	 * @throws ReflectionException
83
+	 * @throws InvalidInterfaceException
84
+	 * @throws InvalidArgumentException
85
+	 */
86
+	public function load($fqcn, $arguments = array(), $shared = true)
87
+	{
88
+		$shared = filter_var($shared, FILTER_VALIDATE_BOOLEAN);
89
+		if ($this->generator instanceof EE_Registry) {
90
+			// check if additional EE_Registry::create() arguments have been passed
91
+			// from_db
92
+			$from_db = isset($arguments['EE_Registry::create(from_db)'])
93
+				? filter_var($arguments['EE_Registry::create(from_db)'], FILTER_VALIDATE_BOOLEAN)
94
+				: false;
95
+			// load_only
96
+			$load_only = isset($arguments['EE_Registry::create(load_only)'])
97
+				? filter_var($arguments['EE_Registry::create(load_only)'], FILTER_VALIDATE_BOOLEAN)
98
+				: false;
99
+			// addon
100
+			$addon = isset($arguments['EE_Registry::create(addon)'])
101
+				? filter_var($arguments['EE_Registry::create(addon)'], FILTER_VALIDATE_BOOLEAN)
102
+				: false;
103
+			unset(
104
+				$arguments['EE_Registry::create(from_db)'],
105
+				$arguments['EE_Registry::create(load_only)'],
106
+				$arguments['EE_Registry::create(addon)']
107
+			);
108
+			// addons need to be cached on EE_Registry
109
+			$shared = $addon ? true : $shared;
110
+			return $this->generator->create(
111
+				$fqcn,
112
+				$arguments,
113
+				$shared,
114
+				$from_db,
115
+				$load_only,
116
+				$addon
117
+			);
118
+		}
119
+		return $this->generator->brew(
120
+			$fqcn,
121
+			$arguments,
122
+			$shared ? CoffeeMaker::BREW_SHARED : CoffeeMaker::BREW_NEW
123
+		);
124
+	}
125 125
 
126 126
 
127
-    /**
128
-     * calls reset() on generator if method exists
129
-     */
130
-    public function reset()
131
-    {
132
-        if ($this->generator instanceof ResettableInterface) {
133
-            $this->generator->reset();
134
-        }
135
-    }
127
+	/**
128
+	 * calls reset() on generator if method exists
129
+	 */
130
+	public function reset()
131
+	{
132
+		if ($this->generator instanceof ResettableInterface) {
133
+			$this->generator->reset();
134
+		}
135
+	}
136 136
 }
Please login to merge, or discard this patch.
core/services/loaders/CachingLoader.php 2 patches
Spacing   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -53,7 +53,7 @@  discard block
 block discarded – undo
53 53
         $identifier = ''
54 54
     ) {
55 55
         parent::__construct($loader);
56
-        $this->cache       = $cache;
56
+        $this->cache = $cache;
57 57
         $this->object_identifier = $object_identifier;
58 58
         $this->setIdentifier($identifier);
59 59
         if ($this->identifier !== '') {
@@ -89,7 +89,7 @@  discard block
 block discarded – undo
89 89
      */
90 90
     private function setIdentifier($identifier)
91 91
     {
92
-        if (! is_string($identifier)) {
92
+        if ( ! is_string($identifier)) {
93 93
             throw new InvalidDataTypeException('$identifier', $identifier, 'string');
94 94
         }
95 95
         $this->identifier = $identifier;
Please login to merge, or discard this patch.
Indentation   +156 added lines, -156 removed lines patch added patch discarded remove patch
@@ -17,160 +17,160 @@
 block discarded – undo
17 17
 class CachingLoader extends CachingLoaderDecorator
18 18
 {
19 19
 
20
-    /**
21
-     * @var string $identifier
22
-     */
23
-    protected $identifier;
24
-
25
-    /**
26
-     * @var CollectionInterface $cache
27
-     */
28
-    protected $cache;
29
-
30
-    /**
31
-     * @var ObjectIdentifier
32
-     */
33
-    private $object_identifier;
34
-
35
-
36
-    /**
37
-     * CachingLoader constructor.
38
-     *
39
-     * @param LoaderDecoratorInterface $loader
40
-     * @param CollectionInterface      $cache
41
-     * @param ObjectIdentifier         $object_identifier
42
-     * @param string                   $identifier
43
-     * @throws InvalidDataTypeException
44
-     */
45
-    public function __construct(
46
-        LoaderDecoratorInterface $loader,
47
-        CollectionInterface $cache,
48
-        ObjectIdentifier $object_identifier,
49
-        $identifier = ''
50
-    ) {
51
-        parent::__construct($loader);
52
-        $this->cache       = $cache;
53
-        $this->object_identifier = $object_identifier;
54
-        $this->setIdentifier($identifier);
55
-        if ($this->identifier !== '') {
56
-            // to only clear this cache, and assuming an identifier has been set, simply do the following:
57
-            // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__IDENTIFIER');
58
-            // where "IDENTIFIER" = the string that was set during construction
59
-            add_action(
60
-                "AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__{$identifier}",
61
-                array($this, 'reset')
62
-            );
63
-        }
64
-        // to clear ALL caches, simply do the following:
65
-        // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache');
66
-        add_action(
67
-            'AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache',
68
-            array($this, 'reset')
69
-        );
70
-    }
71
-
72
-
73
-    /**
74
-     * @return string
75
-     */
76
-    public function identifier()
77
-    {
78
-        return $this->identifier;
79
-    }
80
-
81
-
82
-    /**
83
-     * @param string $identifier
84
-     * @throws InvalidDataTypeException
85
-     */
86
-    private function setIdentifier($identifier)
87
-    {
88
-        if (! is_string($identifier)) {
89
-            throw new InvalidDataTypeException('$identifier', $identifier, 'string');
90
-        }
91
-        $this->identifier = $identifier;
92
-    }
93
-
94
-
95
-    /**
96
-     * @param FullyQualifiedName|string $fqcn
97
-     * @param mixed                     $object
98
-     * @param array                     $arguments
99
-     * @return bool
100
-     * @throws InvalidArgumentException
101
-     */
102
-    public function share($fqcn, $object, array $arguments = array())
103
-    {
104
-        if ($object instanceof $fqcn) {
105
-            return $this->cache->add(
106
-                $object,
107
-                $this->object_identifier->getIdentifier($fqcn, $arguments)
108
-            );
109
-        }
110
-        throw new InvalidArgumentException(
111
-            sprintf(
112
-                esc_html__(
113
-                    'The supplied class name "%1$s" must match the class of the supplied object.',
114
-                    'event_espresso'
115
-                ),
116
-                $fqcn
117
-            )
118
-        );
119
-    }
120
-
121
-
122
-    /**
123
-     * @param FullyQualifiedName|string $fqcn
124
-     * @param array                     $arguments
125
-     * @param bool                      $shared
126
-     * @param array                     $interfaces
127
-     * @return mixed
128
-     */
129
-    public function load($fqcn, $arguments = array(), $shared = true, array $interfaces = array())
130
-    {
131
-        $fqcn = ltrim($fqcn, '\\');
132
-        // caching can be turned off via the following code:
133
-        // add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
134
-        if (
135
-            apply_filters(
136
-                'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache',
137
-                false,
138
-                $this
139
-            )
140
-        ) {
141
-            // even though $shared might be true, caching could be bypassed for whatever reason,
142
-            // so we don't want the core loader to cache anything, therefore caching is turned off
143
-            return $this->loader->load($fqcn, $arguments, false);
144
-        }
145
-        $object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments);
146
-        if ($this->cache->has($object_identifier)) {
147
-            return $this->cache->get($object_identifier);
148
-        }
149
-        $object = $this->loader->load($fqcn, $arguments, $shared);
150
-        if ($object instanceof $fqcn) {
151
-            $this->cache->add($object, $object_identifier);
152
-        }
153
-        return $object;
154
-    }
155
-
156
-
157
-    /**
158
-     * empties cache and calls reset() on loader if method exists
159
-     */
160
-    public function reset()
161
-    {
162
-        $this->clearCache();
163
-        $this->loader->reset();
164
-    }
165
-
166
-
167
-    /**
168
-     * unsets and detaches ALL objects from the cache
169
-     *
170
-     * @since 4.9.62.p
171
-     */
172
-    public function clearCache()
173
-    {
174
-        $this->cache->trashAndDetachAll();
175
-    }
20
+	/**
21
+	 * @var string $identifier
22
+	 */
23
+	protected $identifier;
24
+
25
+	/**
26
+	 * @var CollectionInterface $cache
27
+	 */
28
+	protected $cache;
29
+
30
+	/**
31
+	 * @var ObjectIdentifier
32
+	 */
33
+	private $object_identifier;
34
+
35
+
36
+	/**
37
+	 * CachingLoader constructor.
38
+	 *
39
+	 * @param LoaderDecoratorInterface $loader
40
+	 * @param CollectionInterface      $cache
41
+	 * @param ObjectIdentifier         $object_identifier
42
+	 * @param string                   $identifier
43
+	 * @throws InvalidDataTypeException
44
+	 */
45
+	public function __construct(
46
+		LoaderDecoratorInterface $loader,
47
+		CollectionInterface $cache,
48
+		ObjectIdentifier $object_identifier,
49
+		$identifier = ''
50
+	) {
51
+		parent::__construct($loader);
52
+		$this->cache       = $cache;
53
+		$this->object_identifier = $object_identifier;
54
+		$this->setIdentifier($identifier);
55
+		if ($this->identifier !== '') {
56
+			// to only clear this cache, and assuming an identifier has been set, simply do the following:
57
+			// do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__IDENTIFIER');
58
+			// where "IDENTIFIER" = the string that was set during construction
59
+			add_action(
60
+				"AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__{$identifier}",
61
+				array($this, 'reset')
62
+			);
63
+		}
64
+		// to clear ALL caches, simply do the following:
65
+		// do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache');
66
+		add_action(
67
+			'AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache',
68
+			array($this, 'reset')
69
+		);
70
+	}
71
+
72
+
73
+	/**
74
+	 * @return string
75
+	 */
76
+	public function identifier()
77
+	{
78
+		return $this->identifier;
79
+	}
80
+
81
+
82
+	/**
83
+	 * @param string $identifier
84
+	 * @throws InvalidDataTypeException
85
+	 */
86
+	private function setIdentifier($identifier)
87
+	{
88
+		if (! is_string($identifier)) {
89
+			throw new InvalidDataTypeException('$identifier', $identifier, 'string');
90
+		}
91
+		$this->identifier = $identifier;
92
+	}
93
+
94
+
95
+	/**
96
+	 * @param FullyQualifiedName|string $fqcn
97
+	 * @param mixed                     $object
98
+	 * @param array                     $arguments
99
+	 * @return bool
100
+	 * @throws InvalidArgumentException
101
+	 */
102
+	public function share($fqcn, $object, array $arguments = array())
103
+	{
104
+		if ($object instanceof $fqcn) {
105
+			return $this->cache->add(
106
+				$object,
107
+				$this->object_identifier->getIdentifier($fqcn, $arguments)
108
+			);
109
+		}
110
+		throw new InvalidArgumentException(
111
+			sprintf(
112
+				esc_html__(
113
+					'The supplied class name "%1$s" must match the class of the supplied object.',
114
+					'event_espresso'
115
+				),
116
+				$fqcn
117
+			)
118
+		);
119
+	}
120
+
121
+
122
+	/**
123
+	 * @param FullyQualifiedName|string $fqcn
124
+	 * @param array                     $arguments
125
+	 * @param bool                      $shared
126
+	 * @param array                     $interfaces
127
+	 * @return mixed
128
+	 */
129
+	public function load($fqcn, $arguments = array(), $shared = true, array $interfaces = array())
130
+	{
131
+		$fqcn = ltrim($fqcn, '\\');
132
+		// caching can be turned off via the following code:
133
+		// add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
134
+		if (
135
+			apply_filters(
136
+				'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache',
137
+				false,
138
+				$this
139
+			)
140
+		) {
141
+			// even though $shared might be true, caching could be bypassed for whatever reason,
142
+			// so we don't want the core loader to cache anything, therefore caching is turned off
143
+			return $this->loader->load($fqcn, $arguments, false);
144
+		}
145
+		$object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments);
146
+		if ($this->cache->has($object_identifier)) {
147
+			return $this->cache->get($object_identifier);
148
+		}
149
+		$object = $this->loader->load($fqcn, $arguments, $shared);
150
+		if ($object instanceof $fqcn) {
151
+			$this->cache->add($object, $object_identifier);
152
+		}
153
+		return $object;
154
+	}
155
+
156
+
157
+	/**
158
+	 * empties cache and calls reset() on loader if method exists
159
+	 */
160
+	public function reset()
161
+	{
162
+		$this->clearCache();
163
+		$this->loader->reset();
164
+	}
165
+
166
+
167
+	/**
168
+	 * unsets and detaches ALL objects from the cache
169
+	 *
170
+	 * @since 4.9.62.p
171
+	 */
172
+	public function clearCache()
173
+	{
174
+		$this->cache->trashAndDetachAll();
175
+	}
176 176
 }
Please login to merge, or discard this patch.
core/services/loaders/LoaderFactory.php 1 patch
Indentation   +39 added lines, -39 removed lines patch added patch discarded remove patch
@@ -80,47 +80,47 @@
 block discarded – undo
80 80
 class LoaderFactory
81 81
 {
82 82
 
83
-    /**
84
-     * @var LoaderInterface $loader ;
85
-     */
86
-    private static $loader;
83
+	/**
84
+	 * @var LoaderInterface $loader ;
85
+	 */
86
+	private static $loader;
87 87
 
88 88
 
89
-    /**
90
-     * @param EE_Registry|CoffeeShop   $generator   provided during very first instantiation in
91
-     *                                              BootstrapDependencyInjectionContainer::buildLoader()
92
-     *                                              otherwise can be left null
93
-     * @param ClassInterfaceCache|null $class_cache also provided during first instantiation
94
-     * @param ObjectIdentifier|null    $object_identifier
95
-     * @return LoaderInterface
96
-     * @throws InvalidArgumentException
97
-     * @throws InvalidDataTypeException
98
-     * @throws InvalidInterfaceException
99
-     */
100
-    public static function getLoader(
101
-        $generator = null,
102
-        ClassInterfaceCache $class_cache = null,
103
-        ObjectIdentifier $object_identifier = null
104
-    ) {
105
-        if (
106
-            ! LoaderFactory::$loader instanceof LoaderInterface
107
-            && ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)
108
-            && $class_cache instanceof ClassInterfaceCache
109
-            && $object_identifier instanceof ObjectIdentifier
110
-        ) {
111
-            $core_loader = new CoreLoader($generator);
112
-            LoaderFactory::$loader = new Loader(
113
-                $core_loader,
114
-                new CachingLoader(
115
-                    $core_loader,
116
-                    new LooseCollection(''),
117
-                    $object_identifier
118
-                ),
119
-                $class_cache
120
-            );
121
-        }
122
-        return LoaderFactory::$loader;
123
-    }
89
+	/**
90
+	 * @param EE_Registry|CoffeeShop   $generator   provided during very first instantiation in
91
+	 *                                              BootstrapDependencyInjectionContainer::buildLoader()
92
+	 *                                              otherwise can be left null
93
+	 * @param ClassInterfaceCache|null $class_cache also provided during first instantiation
94
+	 * @param ObjectIdentifier|null    $object_identifier
95
+	 * @return LoaderInterface
96
+	 * @throws InvalidArgumentException
97
+	 * @throws InvalidDataTypeException
98
+	 * @throws InvalidInterfaceException
99
+	 */
100
+	public static function getLoader(
101
+		$generator = null,
102
+		ClassInterfaceCache $class_cache = null,
103
+		ObjectIdentifier $object_identifier = null
104
+	) {
105
+		if (
106
+			! LoaderFactory::$loader instanceof LoaderInterface
107
+			&& ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)
108
+			&& $class_cache instanceof ClassInterfaceCache
109
+			&& $object_identifier instanceof ObjectIdentifier
110
+		) {
111
+			$core_loader = new CoreLoader($generator);
112
+			LoaderFactory::$loader = new Loader(
113
+				$core_loader,
114
+				new CachingLoader(
115
+					$core_loader,
116
+					new LooseCollection(''),
117
+					$object_identifier
118
+				),
119
+				$class_cache
120
+			);
121
+		}
122
+		return LoaderFactory::$loader;
123
+	}
124 124
 
125 125
 
126 126
 }
Please login to merge, or discard this patch.
core/domain/entities/editor/BlockCollection.php 1 patch
Indentation   +47 added lines, -47 removed lines patch added patch discarded remove patch
@@ -20,55 +20,55 @@
 block discarded – undo
20 20
 class BlockCollection extends Collection
21 21
 {
22 22
 
23
-    /**
24
-     * Collection constructor
25
-     *
26
-     * @throws InvalidInterfaceException
27
-     */
28
-    public function __construct()
29
-    {
30
-        parent::__construct('EventEspresso\core\domain\entities\editor\BlockInterface');
31
-    }
23
+	/**
24
+	 * Collection constructor
25
+	 *
26
+	 * @throws InvalidInterfaceException
27
+	 */
28
+	public function __construct()
29
+	{
30
+		parent::__construct('EventEspresso\core\domain\entities\editor\BlockInterface');
31
+	}
32 32
 
33 33
 
34
-    /**
35
-     * unRegisterBlock
36
-     * finds block in the Collection based on the identifier that was set using addObject()
37
-     * and calls unRegisterBlock() on it. Returns block if successful and false if block was not found.
38
-     * PLZ NOTE: the pointer is reset to the beginning of the collection afterwards
39
-     *
40
-     * @param mixed $identifier
41
-     * @return boolean
42
-     */
43
-    public function unRegisterBlock($identifier)
44
-    {
45
-        $this->rewind();
46
-        while ($this->valid()) {
47
-            if ($identifier === $this->getInfo()) {
48
-                $object = $this->current();
49
-                $this->rewind();
50
-                return $object->unRegisterBlock();
51
-            }
52
-            $this->next();
53
-        }
54
-        return false;
55
-    }
34
+	/**
35
+	 * unRegisterBlock
36
+	 * finds block in the Collection based on the identifier that was set using addObject()
37
+	 * and calls unRegisterBlock() on it. Returns block if successful and false if block was not found.
38
+	 * PLZ NOTE: the pointer is reset to the beginning of the collection afterwards
39
+	 *
40
+	 * @param mixed $identifier
41
+	 * @return boolean
42
+	 */
43
+	public function unRegisterBlock($identifier)
44
+	{
45
+		$this->rewind();
46
+		while ($this->valid()) {
47
+			if ($identifier === $this->getInfo()) {
48
+				$object = $this->current();
49
+				$this->rewind();
50
+				return $object->unRegisterBlock();
51
+			}
52
+			$this->next();
53
+		}
54
+		return false;
55
+	}
56 56
 
57 57
 
58
-    /**
59
-     * unRegisterAllBlocks
60
-     * calls unRegisterBlock() on all blocks in Collection.
61
-     * PLZ NOTE: the pointer is reset to the beginning of the collection afterwards
62
-     *
63
-     * @return void
64
-     */
65
-    public function unRegisterAllBlocks()
66
-    {
67
-        $this->rewind();
68
-        while ($this->valid()) {
69
-            $this->current()->unRegisterBlock();
70
-            $this->next();
71
-        }
72
-        $this->rewind();
73
-    }
58
+	/**
59
+	 * unRegisterAllBlocks
60
+	 * calls unRegisterBlock() on all blocks in Collection.
61
+	 * PLZ NOTE: the pointer is reset to the beginning of the collection afterwards
62
+	 *
63
+	 * @return void
64
+	 */
65
+	public function unRegisterAllBlocks()
66
+	{
67
+		$this->rewind();
68
+		while ($this->valid()) {
69
+			$this->current()->unRegisterBlock();
70
+			$this->next();
71
+		}
72
+		$this->rewind();
73
+	}
74 74
 }
Please login to merge, or discard this patch.
core/services/loaders/ClassInterfaceCache.php 2 patches
Spacing   +14 added lines, -14 removed lines patch added patch discarded remove patch
@@ -51,16 +51,16 @@  discard block
 block discarded – undo
51 51
     {
52 52
         $fqn = $this->getFqn($fqn);
53 53
         // have we already seen this FQCN ?
54
-        if (! array_key_exists($fqn, $this->interfaces)) {
55
-            $this->interfaces[ $fqn ] = array();
54
+        if ( ! array_key_exists($fqn, $this->interfaces)) {
55
+            $this->interfaces[$fqn] = array();
56 56
             if (class_exists($fqn)) {
57
-                $this->interfaces[ $fqn ] = class_implements($fqn, false);
58
-                $this->interfaces[ $fqn ] = $this->interfaces[ $fqn ] !== false
59
-                    ? $this->interfaces[ $fqn ]
57
+                $this->interfaces[$fqn] = class_implements($fqn, false);
58
+                $this->interfaces[$fqn] = $this->interfaces[$fqn] !== false
59
+                    ? $this->interfaces[$fqn]
60 60
                     : array();
61 61
             }
62 62
         }
63
-        return $this->interfaces[ $fqn ];
63
+        return $this->interfaces[$fqn];
64 64
     }
65 65
 
66 66
 
@@ -91,13 +91,13 @@  discard block
 block discarded – undo
91 91
         // are we adding an alias for a specific class?
92 92
         if ($for_class !== '') {
93 93
             // make sure it's set up as an array
94
-            if (! isset($this->aliases[ $for_class ])) {
95
-                $this->aliases[ $for_class ] = array();
94
+            if ( ! isset($this->aliases[$for_class])) {
95
+                $this->aliases[$for_class] = array();
96 96
             }
97
-            $this->aliases[ $for_class ][ $alias ] = $fqn;
97
+            $this->aliases[$for_class][$alias] = $fqn;
98 98
             return;
99 99
         }
100
-        $this->aliases[ $alias ] = $fqn;
100
+        $this->aliases[$alias] = $fqn;
101 101
     }
102 102
 
103 103
 
@@ -129,7 +129,7 @@  discard block
 block discarded – undo
129 129
      */
130 130
     protected function isDirectAlias($fqn = '')
131 131
     {
132
-        return isset($this->aliases[ (string) $fqn ]) && ! is_array($this->aliases[ (string) $fqn ]);
132
+        return isset($this->aliases[(string) $fqn]) && ! is_array($this->aliases[(string) $fqn]);
133 133
     }
134 134
 
135 135
 
@@ -144,7 +144,7 @@  discard block
 block discarded – undo
144 144
     {
145 145
         return (
146 146
             $for_class !== ''
147
-            && isset($this->aliases[ (string) $for_class ][ (string) $fqn ])
147
+            && isset($this->aliases[(string) $for_class][(string) $fqn])
148 148
         );
149 149
     }
150 150
 
@@ -169,10 +169,10 @@  discard block
 block discarded – undo
169 169
     {
170 170
         $alias = $this->getFqn($alias);
171 171
         if ($this->isAliasForClass($alias, $for_class)) {
172
-            return $this->getFqnForAlias($this->aliases[ (string) $for_class ][ (string) $alias ], $for_class);
172
+            return $this->getFqnForAlias($this->aliases[(string) $for_class][(string) $alias], $for_class);
173 173
         }
174 174
         if ($this->isDirectAlias($alias)) {
175
-            return $this->getFqnForAlias($this->aliases[ (string) $alias ], '');
175
+            return $this->getFqnForAlias($this->aliases[(string) $alias], '');
176 176
         }
177 177
         return $alias;
178 178
     }
Please login to merge, or discard this patch.
Indentation   +169 added lines, -169 removed lines patch added patch discarded remove patch
@@ -17,173 +17,173 @@
 block discarded – undo
17 17
 class ClassInterfaceCache
18 18
 {
19 19
 
20
-    /**
21
-     * array of interfaces indexed by FQCNs where values are arrays of interface FQNs
22
-     *
23
-     * @var string[][] $interfaces
24
-     */
25
-    private $interfaces = array();
26
-
27
-    /**
28
-     * @type string[][] $aliases
29
-     */
30
-    protected $aliases = array();
31
-
32
-
33
-    /**
34
-     * @return string[][]
35
-     */
36
-    public function getAliases()
37
-    {
38
-        return $this->aliases;
39
-    }
40
-
41
-    /**
42
-     * @param string $fqn
43
-     * @return string
44
-     */
45
-    public function getFqn($fqn)
46
-    {
47
-        $fqn = $fqn instanceof FullyQualifiedName ? $fqn->string() : $fqn;
48
-        return ltrim($fqn, '\\');
49
-    }
50
-
51
-
52
-    /**
53
-     * @param string $fqn
54
-     * @return array
55
-     */
56
-    public function getInterfaces($fqn)
57
-    {
58
-        $fqn = $this->getFqn($fqn);
59
-        // have we already seen this FQCN ?
60
-        if (! array_key_exists($fqn, $this->interfaces)) {
61
-            $this->interfaces[ $fqn ] = array();
62
-            if (class_exists($fqn)) {
63
-                $this->interfaces[ $fqn ] = class_implements($fqn, false);
64
-                $this->interfaces[ $fqn ] = $this->interfaces[ $fqn ] !== false
65
-                    ? $this->interfaces[ $fqn ]
66
-                    : array();
67
-            }
68
-        }
69
-        return $this->interfaces[ $fqn ];
70
-    }
71
-
72
-
73
-    /**
74
-     * @param string $fqn
75
-     * @param string $interface
76
-     * @return bool
77
-     */
78
-    public function hasInterface($fqn, $interface)
79
-    {
80
-        $fqn        = $this->getFqn($fqn);
81
-        $interfaces = $this->getInterfaces($fqn);
82
-        return in_array($interface, $interfaces, true);
83
-    }
84
-
85
-
86
-    /**
87
-     * adds an alias for a classname
88
-     *
89
-     * @param string $fqn       the class name that should be used (concrete class to replace interface)
90
-     * @param string $alias     the class name that would be type hinted for (abstract parent or interface)
91
-     * @param string $for_class the class that has the dependency (is type hinting for the interface)
92
-     * @throws InvalidAliasException
93
-     */
94
-    public function addAlias($fqn, $alias, $for_class = '')
95
-    {
96
-        $fqn   = $this->getFqn($fqn);
97
-        $alias = $this->getFqn($alias);
98
-        if (strpos($alias, '\\') !== false && ! is_subclass_of($fqn, $alias)) {
99
-            throw new InvalidAliasException($fqn, $alias);
100
-        }
101
-        // are we adding an alias for a specific class?
102
-        if ($for_class !== '') {
103
-            // make sure it's set up as an array
104
-            if (! isset($this->aliases[ $for_class ])) {
105
-                $this->aliases[ $for_class ] = array();
106
-            }
107
-            $this->aliases[ $for_class ][ $alias ] = $fqn;
108
-            return;
109
-        }
110
-        $this->aliases[ $alias ] = $fqn;
111
-    }
112
-
113
-
114
-    /**
115
-     * returns TRUE if the provided FQN is an alias
116
-     *
117
-     * @param string $fqn
118
-     * @param string $for_class
119
-     * @return bool
120
-     */
121
-    public function isAlias($fqn = '', $for_class = '')
122
-    {
123
-        $fqn = $this->getFqn($fqn);
124
-        if ($this->isAliasForClass($fqn, $for_class)) {
125
-            return true;
126
-        }
127
-        if ($this->isDirectAlias($fqn)) {
128
-            return true;
129
-        }
130
-        return false;
131
-    }
132
-
133
-
134
-    /**
135
-     * returns TRUE if the provided FQN is an alias
136
-     *
137
-     * @param string $fqn
138
-     * @return bool
139
-     */
140
-    protected function isDirectAlias($fqn = '')
141
-    {
142
-        return isset($this->aliases[ (string) $fqn ]) && ! is_array($this->aliases[ (string) $fqn ]);
143
-    }
144
-
145
-
146
-    /**
147
-     * returns TRUE if the provided FQN is an alias for the specified class
148
-     *
149
-     * @param string $fqn
150
-     * @param string $for_class
151
-     * @return bool
152
-     */
153
-    protected function isAliasForClass($fqn = '', $for_class = '')
154
-    {
155
-        return (
156
-            $for_class !== ''
157
-            && isset($this->aliases[ (string) $for_class ][ (string) $fqn ])
158
-        );
159
-    }
160
-
161
-
162
-    /**
163
-     * returns FQN for provided alias if one exists, otherwise returns the original FQN
164
-     * functions recursively, so that multiple aliases can be used to drill down to a FQN
165
-     *  for example:
166
-     *      if the following two entries were added to the aliases array:
167
-     *          array(
168
-     *              'interface_alias'           => 'some\namespace\interface'
169
-     *              'some\namespace\interface'  => 'some\namespace\classname'
170
-     *          )
171
-     *      then one could use Loader::getNew( 'interface_alias' )
172
-     *      to load an instance of 'some\namespace\classname'
173
-     *
174
-     * @param string $alias
175
-     * @param string $for_class
176
-     * @return string
177
-     */
178
-    public function getFqnForAlias($alias = '', $for_class = '')
179
-    {
180
-        $alias = $this->getFqn($alias);
181
-        if ($this->isAliasForClass($alias, $for_class)) {
182
-            return $this->getFqnForAlias($this->aliases[ (string) $for_class ][ (string) $alias ], $for_class);
183
-        }
184
-        if ($this->isDirectAlias($alias)) {
185
-            return $this->getFqnForAlias($this->aliases[ (string) $alias ], '');
186
-        }
187
-        return $alias;
188
-    }
20
+	/**
21
+	 * array of interfaces indexed by FQCNs where values are arrays of interface FQNs
22
+	 *
23
+	 * @var string[][] $interfaces
24
+	 */
25
+	private $interfaces = array();
26
+
27
+	/**
28
+	 * @type string[][] $aliases
29
+	 */
30
+	protected $aliases = array();
31
+
32
+
33
+	/**
34
+	 * @return string[][]
35
+	 */
36
+	public function getAliases()
37
+	{
38
+		return $this->aliases;
39
+	}
40
+
41
+	/**
42
+	 * @param string $fqn
43
+	 * @return string
44
+	 */
45
+	public function getFqn($fqn)
46
+	{
47
+		$fqn = $fqn instanceof FullyQualifiedName ? $fqn->string() : $fqn;
48
+		return ltrim($fqn, '\\');
49
+	}
50
+
51
+
52
+	/**
53
+	 * @param string $fqn
54
+	 * @return array
55
+	 */
56
+	public function getInterfaces($fqn)
57
+	{
58
+		$fqn = $this->getFqn($fqn);
59
+		// have we already seen this FQCN ?
60
+		if (! array_key_exists($fqn, $this->interfaces)) {
61
+			$this->interfaces[ $fqn ] = array();
62
+			if (class_exists($fqn)) {
63
+				$this->interfaces[ $fqn ] = class_implements($fqn, false);
64
+				$this->interfaces[ $fqn ] = $this->interfaces[ $fqn ] !== false
65
+					? $this->interfaces[ $fqn ]
66
+					: array();
67
+			}
68
+		}
69
+		return $this->interfaces[ $fqn ];
70
+	}
71
+
72
+
73
+	/**
74
+	 * @param string $fqn
75
+	 * @param string $interface
76
+	 * @return bool
77
+	 */
78
+	public function hasInterface($fqn, $interface)
79
+	{
80
+		$fqn        = $this->getFqn($fqn);
81
+		$interfaces = $this->getInterfaces($fqn);
82
+		return in_array($interface, $interfaces, true);
83
+	}
84
+
85
+
86
+	/**
87
+	 * adds an alias for a classname
88
+	 *
89
+	 * @param string $fqn       the class name that should be used (concrete class to replace interface)
90
+	 * @param string $alias     the class name that would be type hinted for (abstract parent or interface)
91
+	 * @param string $for_class the class that has the dependency (is type hinting for the interface)
92
+	 * @throws InvalidAliasException
93
+	 */
94
+	public function addAlias($fqn, $alias, $for_class = '')
95
+	{
96
+		$fqn   = $this->getFqn($fqn);
97
+		$alias = $this->getFqn($alias);
98
+		if (strpos($alias, '\\') !== false && ! is_subclass_of($fqn, $alias)) {
99
+			throw new InvalidAliasException($fqn, $alias);
100
+		}
101
+		// are we adding an alias for a specific class?
102
+		if ($for_class !== '') {
103
+			// make sure it's set up as an array
104
+			if (! isset($this->aliases[ $for_class ])) {
105
+				$this->aliases[ $for_class ] = array();
106
+			}
107
+			$this->aliases[ $for_class ][ $alias ] = $fqn;
108
+			return;
109
+		}
110
+		$this->aliases[ $alias ] = $fqn;
111
+	}
112
+
113
+
114
+	/**
115
+	 * returns TRUE if the provided FQN is an alias
116
+	 *
117
+	 * @param string $fqn
118
+	 * @param string $for_class
119
+	 * @return bool
120
+	 */
121
+	public function isAlias($fqn = '', $for_class = '')
122
+	{
123
+		$fqn = $this->getFqn($fqn);
124
+		if ($this->isAliasForClass($fqn, $for_class)) {
125
+			return true;
126
+		}
127
+		if ($this->isDirectAlias($fqn)) {
128
+			return true;
129
+		}
130
+		return false;
131
+	}
132
+
133
+
134
+	/**
135
+	 * returns TRUE if the provided FQN is an alias
136
+	 *
137
+	 * @param string $fqn
138
+	 * @return bool
139
+	 */
140
+	protected function isDirectAlias($fqn = '')
141
+	{
142
+		return isset($this->aliases[ (string) $fqn ]) && ! is_array($this->aliases[ (string) $fqn ]);
143
+	}
144
+
145
+
146
+	/**
147
+	 * returns TRUE if the provided FQN is an alias for the specified class
148
+	 *
149
+	 * @param string $fqn
150
+	 * @param string $for_class
151
+	 * @return bool
152
+	 */
153
+	protected function isAliasForClass($fqn = '', $for_class = '')
154
+	{
155
+		return (
156
+			$for_class !== ''
157
+			&& isset($this->aliases[ (string) $for_class ][ (string) $fqn ])
158
+		);
159
+	}
160
+
161
+
162
+	/**
163
+	 * returns FQN for provided alias if one exists, otherwise returns the original FQN
164
+	 * functions recursively, so that multiple aliases can be used to drill down to a FQN
165
+	 *  for example:
166
+	 *      if the following two entries were added to the aliases array:
167
+	 *          array(
168
+	 *              'interface_alias'           => 'some\namespace\interface'
169
+	 *              'some\namespace\interface'  => 'some\namespace\classname'
170
+	 *          )
171
+	 *      then one could use Loader::getNew( 'interface_alias' )
172
+	 *      to load an instance of 'some\namespace\classname'
173
+	 *
174
+	 * @param string $alias
175
+	 * @param string $for_class
176
+	 * @return string
177
+	 */
178
+	public function getFqnForAlias($alias = '', $for_class = '')
179
+	{
180
+		$alias = $this->getFqn($alias);
181
+		if ($this->isAliasForClass($alias, $for_class)) {
182
+			return $this->getFqnForAlias($this->aliases[ (string) $for_class ][ (string) $alias ], $for_class);
183
+		}
184
+		if ($this->isDirectAlias($alias)) {
185
+			return $this->getFqnForAlias($this->aliases[ (string) $alias ], '');
186
+		}
187
+		return $alias;
188
+	}
189 189
 }
Please login to merge, or discard this patch.
core/domain/services/custom_post_types/RegisterCustomPostTypes.php 2 patches
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -61,7 +61,7 @@
 block discarded – undo
61 61
     {
62 62
         $custom_post_types = $this->custom_post_types->getDefinitions();
63 63
         foreach ($custom_post_types as $custom_post_type => $CPT) {
64
-            $this->wp_post_types[ $custom_post_type ] = $this->registerCustomPostType(
64
+            $this->wp_post_types[$custom_post_type] = $this->registerCustomPostType(
65 65
                 $custom_post_type,
66 66
                 $CPT['singular_name'],
67 67
                 $CPT['plural_name'],
Please login to merge, or discard this patch.
Indentation   +295 added lines, -295 removed lines patch added patch discarded remove patch
@@ -18,314 +18,314 @@
 block discarded – undo
18 18
 class RegisterCustomPostTypes
19 19
 {
20 20
 
21
-    /**
22
-     * @var CustomPostTypeDefinitions $custom_post_types
23
-     */
24
-    public $custom_post_types;
21
+	/**
22
+	 * @var CustomPostTypeDefinitions $custom_post_types
23
+	 */
24
+	public $custom_post_types;
25 25
 
26
-    /**
27
-     * @var WP_Post_Type[] $wp_post_types
28
-     */
29
-    public $wp_post_types = array();
26
+	/**
27
+	 * @var WP_Post_Type[] $wp_post_types
28
+	 */
29
+	public $wp_post_types = array();
30 30
 
31 31
 
32
-    /**
33
-     * RegisterCustomPostTypes constructor.
34
-     *
35
-     * @param CustomPostTypeDefinitions $custom_post_types
36
-     */
37
-    public function __construct(CustomPostTypeDefinitions $custom_post_types)
38
-    {
39
-        $this->custom_post_types = $custom_post_types;
40
-    }
32
+	/**
33
+	 * RegisterCustomPostTypes constructor.
34
+	 *
35
+	 * @param CustomPostTypeDefinitions $custom_post_types
36
+	 */
37
+	public function __construct(CustomPostTypeDefinitions $custom_post_types)
38
+	{
39
+		$this->custom_post_types = $custom_post_types;
40
+	}
41 41
 
42 42
 
43
-    /**
44
-     * @return WP_Post_Type[]
45
-     */
46
-    public function getRegisteredCustomPostTypes()
47
-    {
48
-        return $this->wp_post_types;
49
-    }
43
+	/**
44
+	 * @return WP_Post_Type[]
45
+	 */
46
+	public function getRegisteredCustomPostTypes()
47
+	{
48
+		return $this->wp_post_types;
49
+	}
50 50
 
51 51
 
52
-    /**
53
-     * @return void
54
-     * @throws DomainException
55
-     */
56
-    public function registerCustomPostTypes()
57
-    {
58
-        $custom_post_types = $this->custom_post_types->getDefinitions();
59
-        foreach ($custom_post_types as $custom_post_type => $CPT) {
60
-            $this->wp_post_types[ $custom_post_type ] = $this->registerCustomPostType(
61
-                $custom_post_type,
62
-                $CPT['singular_name'],
63
-                $CPT['plural_name'],
64
-                $CPT['singular_slug'],
65
-                $CPT['plural_slug'],
66
-                $CPT['args']
67
-            );
68
-        }
69
-    }
52
+	/**
53
+	 * @return void
54
+	 * @throws DomainException
55
+	 */
56
+	public function registerCustomPostTypes()
57
+	{
58
+		$custom_post_types = $this->custom_post_types->getDefinitions();
59
+		foreach ($custom_post_types as $custom_post_type => $CPT) {
60
+			$this->wp_post_types[ $custom_post_type ] = $this->registerCustomPostType(
61
+				$custom_post_type,
62
+				$CPT['singular_name'],
63
+				$CPT['plural_name'],
64
+				$CPT['singular_slug'],
65
+				$CPT['plural_slug'],
66
+				$CPT['args']
67
+			);
68
+		}
69
+	}
70 70
 
71 71
 
72
-    /**
73
-     * Registers a new custom post type. Sets default settings given only the following params.
74
-     * Returns the registered post type object, or an error object.
75
-     *
76
-     * @param string $post_type          the actual post type name
77
-     *                                   IMPORTANT:
78
-     *                                   this must match what the slug is for admin pages related to this CPT
79
-     *                                   Also any models must use this slug as well
80
-     * @param string $singular_name      a pre-internationalized string for the singular name of the objects
81
-     * @param string $plural_name        a pre-internationalized string for the plural name of the objects
82
-     * @param string $singular_slug
83
-     * @param string $plural_slug
84
-     * @param array  $override_arguments exactly like $args as described in
85
-     *                                   http://codex.wordpress.org/Function_Reference/register_post_type
86
-     * @return WP_Post_Type|WP_Error
87
-     * @throws DomainException
88
-     */
89
-    public function registerCustomPostType(
90
-        $post_type,
91
-        $singular_name,
92
-        $plural_name,
93
-        $singular_slug = '',
94
-        $plural_slug = '',
95
-        array $override_arguments = array()
96
-    ) {
97
-        $wp_post_type = register_post_type(
98
-            $post_type,
99
-            $this->prepareArguments(
100
-                $post_type,
101
-                $singular_name,
102
-                $plural_name,
103
-                $singular_slug,
104
-                $plural_slug,
105
-                $override_arguments
106
-            )
107
-        );
108
-        if ($wp_post_type instanceof WP_Error) {
109
-            throw new DomainException($wp_post_type->get_error_message());
110
-        }
111
-        return $wp_post_type;
112
-    }
72
+	/**
73
+	 * Registers a new custom post type. Sets default settings given only the following params.
74
+	 * Returns the registered post type object, or an error object.
75
+	 *
76
+	 * @param string $post_type          the actual post type name
77
+	 *                                   IMPORTANT:
78
+	 *                                   this must match what the slug is for admin pages related to this CPT
79
+	 *                                   Also any models must use this slug as well
80
+	 * @param string $singular_name      a pre-internationalized string for the singular name of the objects
81
+	 * @param string $plural_name        a pre-internationalized string for the plural name of the objects
82
+	 * @param string $singular_slug
83
+	 * @param string $plural_slug
84
+	 * @param array  $override_arguments exactly like $args as described in
85
+	 *                                   http://codex.wordpress.org/Function_Reference/register_post_type
86
+	 * @return WP_Post_Type|WP_Error
87
+	 * @throws DomainException
88
+	 */
89
+	public function registerCustomPostType(
90
+		$post_type,
91
+		$singular_name,
92
+		$plural_name,
93
+		$singular_slug = '',
94
+		$plural_slug = '',
95
+		array $override_arguments = array()
96
+	) {
97
+		$wp_post_type = register_post_type(
98
+			$post_type,
99
+			$this->prepareArguments(
100
+				$post_type,
101
+				$singular_name,
102
+				$plural_name,
103
+				$singular_slug,
104
+				$plural_slug,
105
+				$override_arguments
106
+			)
107
+		);
108
+		if ($wp_post_type instanceof WP_Error) {
109
+			throw new DomainException($wp_post_type->get_error_message());
110
+		}
111
+		return $wp_post_type;
112
+	}
113 113
 
114 114
 
115
-    /**
116
-     * @param string $post_type          the actual post type name
117
-     * @param string $singular_name      a pre-internationalized string for the singular name of the objects
118
-     * @param string $plural_name        a pre-internationalized string for the plural name of the objects
119
-     * @param string $singular_slug
120
-     * @param string $plural_slug
121
-     * @param array  $override_arguments The default values set in this function will be overridden
122
-     *                                   by whatever you set in $override_arguments
123
-     * @return array
124
-     */
125
-    protected function prepareArguments(
126
-        $post_type,
127
-        $singular_name,
128
-        $plural_name,
129
-        $singular_slug,
130
-        $plural_slug,
131
-        array $override_arguments = array()
132
-    ) {
133
-        // verify plural slug and singular slug, if they aren't we'll use $singular_name and $plural_name
134
-        $singular_slug = ! empty($singular_slug) ? $singular_slug : $singular_name;
135
-        $plural_slug = ! empty($plural_slug) ? $plural_slug : $plural_name;
136
-        $labels = $this->getLabels(
137
-            $singular_name,
138
-            $plural_name,
139
-            $singular_slug,
140
-            $plural_slug
141
-        );
142
-        // note the page_templates arg in the supports index is something specific to EE.
143
-        // WordPress doesn't actually have that in their register_post_type api.
144
-        $arguments = $this->getDefaultArguments($labels, $post_type, $plural_slug);
145
-        if ($override_arguments) {
146
-            if (isset($override_arguments['labels'])) {
147
-                $labels = array_merge($arguments['labels'], $override_arguments['labels']);
148
-            }
149
-            $arguments = array_merge($arguments, $override_arguments);
150
-            $arguments['labels'] = $labels;
151
-        }
152
-        return $arguments;
153
-    }
115
+	/**
116
+	 * @param string $post_type          the actual post type name
117
+	 * @param string $singular_name      a pre-internationalized string for the singular name of the objects
118
+	 * @param string $plural_name        a pre-internationalized string for the plural name of the objects
119
+	 * @param string $singular_slug
120
+	 * @param string $plural_slug
121
+	 * @param array  $override_arguments The default values set in this function will be overridden
122
+	 *                                   by whatever you set in $override_arguments
123
+	 * @return array
124
+	 */
125
+	protected function prepareArguments(
126
+		$post_type,
127
+		$singular_name,
128
+		$plural_name,
129
+		$singular_slug,
130
+		$plural_slug,
131
+		array $override_arguments = array()
132
+	) {
133
+		// verify plural slug and singular slug, if they aren't we'll use $singular_name and $plural_name
134
+		$singular_slug = ! empty($singular_slug) ? $singular_slug : $singular_name;
135
+		$plural_slug = ! empty($plural_slug) ? $plural_slug : $plural_name;
136
+		$labels = $this->getLabels(
137
+			$singular_name,
138
+			$plural_name,
139
+			$singular_slug,
140
+			$plural_slug
141
+		);
142
+		// note the page_templates arg in the supports index is something specific to EE.
143
+		// WordPress doesn't actually have that in their register_post_type api.
144
+		$arguments = $this->getDefaultArguments($labels, $post_type, $plural_slug);
145
+		if ($override_arguments) {
146
+			if (isset($override_arguments['labels'])) {
147
+				$labels = array_merge($arguments['labels'], $override_arguments['labels']);
148
+			}
149
+			$arguments = array_merge($arguments, $override_arguments);
150
+			$arguments['labels'] = $labels;
151
+		}
152
+		return $arguments;
153
+	}
154 154
 
155 155
 
156
-    /**
157
-     * @param string $singular_name
158
-     * @param string $plural_name
159
-     * @param string $singular_slug
160
-     * @param string $plural_slug
161
-     * @return array
162
-     */
163
-    private function getLabels($singular_name, $plural_name, $singular_slug, $plural_slug)
164
-    {
165
-        return array(
166
-            'name'                     => $plural_name,
167
-            'singular_name'            => $singular_name,
168
-            'singular_slug'            => $singular_slug,
169
-            'plural_slug'              => $plural_slug,
170
-            'add_new'                  => sprintf(
171
-                /* Translators: Post Type Label */
172
-                esc_html_x('Add %s', 'Add Event', 'event_espresso'),
173
-                $singular_name
174
-            ),
175
-            'add_new_item'             => sprintf(
176
-                /* Translators: Post Type Label */
177
-                esc_html_x('Add New %s', 'Add New Event', 'event_espresso'),
178
-                $singular_name
179
-            ),
180
-            'edit_item'                => sprintf(
181
-                /* Translators: Post Type Label */
182
-                esc_html_x('Edit %s', 'Edit Event', 'event_espresso'),
183
-                $singular_name
184
-            ),
185
-            'new_item'                 => sprintf(
186
-                /* Translators: Post Type Label */
187
-                esc_html_x('New %s', 'New Event', 'event_espresso'),
188
-                $singular_name
189
-            ),
190
-            'all_items'                => sprintf(
191
-                /* Translators: Post Type Label */
192
-                esc_html_x('All %s', 'All Events', 'event_espresso'),
193
-                $plural_name
194
-            ),
195
-            'view_item'                => sprintf(
196
-                /* Translators: Post Type Label */
197
-                esc_html_x('View %s', 'View Event', 'event_espresso'),
198
-                $singular_name
199
-            ),
200
-            'view_items'               => sprintf(
201
-                /* Translators: Post Type Label */
202
-                esc_html_x('View %s', 'View Events', 'event_espresso'),
203
-                $plural_name
204
-            ),
205
-            'archives'                 => sprintf(
206
-                /* Translators: Post Type Label */
207
-                esc_html_x('%s Archives', 'Event Archives', 'event_espresso'),
208
-                $singular_name
209
-            ),
210
-            'attributes'               => sprintf(
211
-                /* Translators: Post Type Label */
212
-                esc_html_x('%s Attributes', 'Event Attributes', 'event_espresso'),
213
-                $singular_name
214
-            ),
215
-            'insert_into_item'         => sprintf(
216
-                /* Translators: Post Type Label */
217
-                esc_html_x('Insert into this %s', 'Insert into this Event', 'event_espresso'),
218
-                $singular_name
219
-            ),
220
-            'uploaded_to_this_item'    => sprintf(
221
-                /* Translators: Post Type Label */
222
-                esc_html_x('Uploaded to this %s', 'Uploaded to this Event', 'event_espresso'),
223
-                $singular_name
224
-            ),
225
-            'filter_items_list'        => sprintf(
226
-                /* Translators: Post Type Label */
227
-                esc_html_x('Filter %s list', 'Filter Events list', 'event_espresso'),
228
-                $plural_name
229
-            ),
230
-            'items_list_navigation'    => sprintf(
231
-                /* Translators: Post Type Label */
232
-                esc_html_x('%s list navigation', 'Events list navigation', 'event_espresso'),
233
-                $plural_name
234
-            ),
235
-            'items_list'               => sprintf(
236
-                /* Translators: Post Type Label */
237
-                esc_html_x('%s list', 'Events list', 'event_espresso'),
238
-                $plural_name
239
-            ),
240
-            'item_published'           => sprintf(
241
-                /* Translators: Post Type Label */
242
-                esc_html_x('%s published', 'Event published', 'event_espresso'),
243
-                $singular_name
244
-            ),
245
-            'item_published_privately' => sprintf(
246
-                /* Translators: Post Type Label */
247
-                esc_html_x('%s published privately', 'Event published privately', 'event_espresso'),
248
-                $singular_name
249
-            ),
250
-            'item_reverted_to_draft'   => sprintf(
251
-                /* Translators: Post Type Label */
252
-                esc_html_x('%s reverted to draft', 'Event reverted to draft', 'event_espresso'),
253
-                $singular_name
254
-            ),
255
-            'item_scheduled'           => sprintf(
256
-                /* Translators: Post Type Label */
257
-                esc_html_x('%s scheduled', 'Event scheduled', 'event_espresso'),
258
-                $singular_name
259
-            ),
260
-            'item_updated'             => sprintf(
261
-                /* Translators: Post Type Label */
262
-                esc_html_x('%s updated', 'Event updated', 'event_espresso'),
263
-                $singular_name
264
-            ),
265
-            'search_items'             => sprintf(
266
-                /* Translators: Post Type Label */
267
-                esc_html_x('Search %s', 'Search Events', 'event_espresso'),
268
-                $plural_name
269
-            ),
270
-            'not_found'                => sprintf(
271
-                /* Translators: Post Type Label */
272
-                esc_html_x('No %s found', 'No Events found', 'event_espresso'),
273
-                $plural_name
274
-            ),
275
-            'not_found_in_trash'       => sprintf(
276
-                /* Translators: Post Type Label */
277
-                esc_html_x('No %s found in Trash', 'No Events found in Trash', 'event_espresso'),
278
-                $plural_name
279
-            ),
280
-            'parent_item_colon'        => '',
281
-            'menu_name'                => $plural_name,
282
-        );
283
-    }
156
+	/**
157
+	 * @param string $singular_name
158
+	 * @param string $plural_name
159
+	 * @param string $singular_slug
160
+	 * @param string $plural_slug
161
+	 * @return array
162
+	 */
163
+	private function getLabels($singular_name, $plural_name, $singular_slug, $plural_slug)
164
+	{
165
+		return array(
166
+			'name'                     => $plural_name,
167
+			'singular_name'            => $singular_name,
168
+			'singular_slug'            => $singular_slug,
169
+			'plural_slug'              => $plural_slug,
170
+			'add_new'                  => sprintf(
171
+				/* Translators: Post Type Label */
172
+				esc_html_x('Add %s', 'Add Event', 'event_espresso'),
173
+				$singular_name
174
+			),
175
+			'add_new_item'             => sprintf(
176
+				/* Translators: Post Type Label */
177
+				esc_html_x('Add New %s', 'Add New Event', 'event_espresso'),
178
+				$singular_name
179
+			),
180
+			'edit_item'                => sprintf(
181
+				/* Translators: Post Type Label */
182
+				esc_html_x('Edit %s', 'Edit Event', 'event_espresso'),
183
+				$singular_name
184
+			),
185
+			'new_item'                 => sprintf(
186
+				/* Translators: Post Type Label */
187
+				esc_html_x('New %s', 'New Event', 'event_espresso'),
188
+				$singular_name
189
+			),
190
+			'all_items'                => sprintf(
191
+				/* Translators: Post Type Label */
192
+				esc_html_x('All %s', 'All Events', 'event_espresso'),
193
+				$plural_name
194
+			),
195
+			'view_item'                => sprintf(
196
+				/* Translators: Post Type Label */
197
+				esc_html_x('View %s', 'View Event', 'event_espresso'),
198
+				$singular_name
199
+			),
200
+			'view_items'               => sprintf(
201
+				/* Translators: Post Type Label */
202
+				esc_html_x('View %s', 'View Events', 'event_espresso'),
203
+				$plural_name
204
+			),
205
+			'archives'                 => sprintf(
206
+				/* Translators: Post Type Label */
207
+				esc_html_x('%s Archives', 'Event Archives', 'event_espresso'),
208
+				$singular_name
209
+			),
210
+			'attributes'               => sprintf(
211
+				/* Translators: Post Type Label */
212
+				esc_html_x('%s Attributes', 'Event Attributes', 'event_espresso'),
213
+				$singular_name
214
+			),
215
+			'insert_into_item'         => sprintf(
216
+				/* Translators: Post Type Label */
217
+				esc_html_x('Insert into this %s', 'Insert into this Event', 'event_espresso'),
218
+				$singular_name
219
+			),
220
+			'uploaded_to_this_item'    => sprintf(
221
+				/* Translators: Post Type Label */
222
+				esc_html_x('Uploaded to this %s', 'Uploaded to this Event', 'event_espresso'),
223
+				$singular_name
224
+			),
225
+			'filter_items_list'        => sprintf(
226
+				/* Translators: Post Type Label */
227
+				esc_html_x('Filter %s list', 'Filter Events list', 'event_espresso'),
228
+				$plural_name
229
+			),
230
+			'items_list_navigation'    => sprintf(
231
+				/* Translators: Post Type Label */
232
+				esc_html_x('%s list navigation', 'Events list navigation', 'event_espresso'),
233
+				$plural_name
234
+			),
235
+			'items_list'               => sprintf(
236
+				/* Translators: Post Type Label */
237
+				esc_html_x('%s list', 'Events list', 'event_espresso'),
238
+				$plural_name
239
+			),
240
+			'item_published'           => sprintf(
241
+				/* Translators: Post Type Label */
242
+				esc_html_x('%s published', 'Event published', 'event_espresso'),
243
+				$singular_name
244
+			),
245
+			'item_published_privately' => sprintf(
246
+				/* Translators: Post Type Label */
247
+				esc_html_x('%s published privately', 'Event published privately', 'event_espresso'),
248
+				$singular_name
249
+			),
250
+			'item_reverted_to_draft'   => sprintf(
251
+				/* Translators: Post Type Label */
252
+				esc_html_x('%s reverted to draft', 'Event reverted to draft', 'event_espresso'),
253
+				$singular_name
254
+			),
255
+			'item_scheduled'           => sprintf(
256
+				/* Translators: Post Type Label */
257
+				esc_html_x('%s scheduled', 'Event scheduled', 'event_espresso'),
258
+				$singular_name
259
+			),
260
+			'item_updated'             => sprintf(
261
+				/* Translators: Post Type Label */
262
+				esc_html_x('%s updated', 'Event updated', 'event_espresso'),
263
+				$singular_name
264
+			),
265
+			'search_items'             => sprintf(
266
+				/* Translators: Post Type Label */
267
+				esc_html_x('Search %s', 'Search Events', 'event_espresso'),
268
+				$plural_name
269
+			),
270
+			'not_found'                => sprintf(
271
+				/* Translators: Post Type Label */
272
+				esc_html_x('No %s found', 'No Events found', 'event_espresso'),
273
+				$plural_name
274
+			),
275
+			'not_found_in_trash'       => sprintf(
276
+				/* Translators: Post Type Label */
277
+				esc_html_x('No %s found in Trash', 'No Events found in Trash', 'event_espresso'),
278
+				$plural_name
279
+			),
280
+			'parent_item_colon'        => '',
281
+			'menu_name'                => $plural_name,
282
+		);
283
+	}
284 284
 
285 285
 
286
-    /**
287
-     * @param array  $labels
288
-     * @param string $post_type
289
-     * @param string $plural_slug
290
-     * @return array
291
-     */
292
-    private function getDefaultArguments(array $labels, $post_type, $plural_slug)
293
-    {
294
-        return array(
295
-            'labels'             => $labels,
296
-            'public'             => true,
297
-            'publicly_queryable' => true,
298
-            'show_ui'            => false,
299
-            'show_ee_ui'         => true,
300
-            'show_in_menu'       => false,
301
-            'show_in_nav_menus'  => false,
302
-            'query_var'          => true,
303
-            'rewrite'            => apply_filters(
304
-                'FHEE__EventEspresso_core_domain_entities_custom_post_types_RegisterCustomPostTypes__getDefaultArguments__rewrite',
305
-                // legacy filter applied for now,
306
-                // later on we'll run a has_filter($tag) check and throw a doing_it_wrong() notice
307
-                apply_filters(
308
-                    'FHEE__EE_Register_CPTs__register_CPT__rewrite',
309
-                    array('slug' => $plural_slug),
310
-                    $post_type
311
-                ),
312
-                $post_type,
313
-                $plural_slug
314
-            ),
315
-            'capability_type'    => 'post',
316
-            'map_meta_cap'       => true,
317
-            'has_archive'        => true,
318
-            'hierarchical'       => false,
319
-            'menu_position'      => null,
320
-            'supports'           => array(
321
-                'title',
322
-                'editor',
323
-                'author',
324
-                'thumbnail',
325
-                'excerpt',
326
-                'custom-fields',
327
-                'comments',
328
-            ),
329
-        );
330
-    }
286
+	/**
287
+	 * @param array  $labels
288
+	 * @param string $post_type
289
+	 * @param string $plural_slug
290
+	 * @return array
291
+	 */
292
+	private function getDefaultArguments(array $labels, $post_type, $plural_slug)
293
+	{
294
+		return array(
295
+			'labels'             => $labels,
296
+			'public'             => true,
297
+			'publicly_queryable' => true,
298
+			'show_ui'            => false,
299
+			'show_ee_ui'         => true,
300
+			'show_in_menu'       => false,
301
+			'show_in_nav_menus'  => false,
302
+			'query_var'          => true,
303
+			'rewrite'            => apply_filters(
304
+				'FHEE__EventEspresso_core_domain_entities_custom_post_types_RegisterCustomPostTypes__getDefaultArguments__rewrite',
305
+				// legacy filter applied for now,
306
+				// later on we'll run a has_filter($tag) check and throw a doing_it_wrong() notice
307
+				apply_filters(
308
+					'FHEE__EE_Register_CPTs__register_CPT__rewrite',
309
+					array('slug' => $plural_slug),
310
+					$post_type
311
+				),
312
+				$post_type,
313
+				$plural_slug
314
+			),
315
+			'capability_type'    => 'post',
316
+			'map_meta_cap'       => true,
317
+			'has_archive'        => true,
318
+			'hierarchical'       => false,
319
+			'menu_position'      => null,
320
+			'supports'           => array(
321
+				'title',
322
+				'editor',
323
+				'author',
324
+				'thumbnail',
325
+				'excerpt',
326
+				'custom-fields',
327
+				'comments',
328
+			),
329
+		);
330
+	}
331 331
 }
Please login to merge, or discard this patch.