@@ -28,7 +28,7 @@ discard block |
||
28 | 28 | { |
29 | 29 | |
30 | 30 | // validate that the first element in the array is an EE_Registration object. |
31 | - if (! reset($data) instanceof EE_Registration) { |
|
31 | + if ( ! reset($data) instanceof EE_Registration) { |
|
32 | 32 | throw new EE_Error( |
33 | 33 | esc_html__( |
34 | 34 | 'The EE_Message_Registrations_incoming_data class expects an array of EE_Registration objects.', |
@@ -77,7 +77,7 @@ discard block |
||
77 | 77 | if ($registration instanceof EE_Registration) { |
78 | 78 | $transaction = $registration->transaction(); |
79 | 79 | if ($transaction instanceof EE_Transaction) { |
80 | - $transactions[ $transaction->ID() ] = $transaction; |
|
80 | + $transactions[$transaction->ID()] = $transaction; |
|
81 | 81 | } |
82 | 82 | } |
83 | 83 | } |
@@ -97,7 +97,7 @@ discard block |
||
97 | 97 | */ |
98 | 98 | public static function convert_data_for_persistent_storage($registrations) |
99 | 99 | { |
100 | - if (! self::validateRegistrationsForConversion($registrations)) { |
|
100 | + if ( ! self::validateRegistrationsForConversion($registrations)) { |
|
101 | 101 | return array(); |
102 | 102 | } |
103 | 103 | |
@@ -110,7 +110,7 @@ discard block |
||
110 | 110 | // k nope so let's pull from the registrations |
111 | 111 | $registration_ids = array_filter( |
112 | 112 | array_map( |
113 | - function ($registration) { |
|
113 | + function($registration) { |
|
114 | 114 | if ($registration instanceof EE_Registration) { |
115 | 115 | return $registration->ID(); |
116 | 116 | } |
@@ -15,172 +15,172 @@ |
||
15 | 15 | */ |
16 | 16 | class EE_Messages_Registrations_incoming_data extends EE_Messages_incoming_data |
17 | 17 | { |
18 | - /** |
|
19 | - * Constructor. |
|
20 | - * |
|
21 | - * @param EE_Registration[] $data expecting an array of EE_Registration objects. |
|
22 | - * @throws EE_Error |
|
23 | - * @access protected |
|
24 | - */ |
|
25 | - public function __construct($data = array()) |
|
26 | - { |
|
27 | - |
|
28 | - // validate that the first element in the array is an EE_Registration object. |
|
29 | - if (! reset($data) instanceof EE_Registration) { |
|
30 | - throw new EE_Error( |
|
31 | - esc_html__( |
|
32 | - 'The EE_Message_Registrations_incoming_data class expects an array of EE_Registration objects.', |
|
33 | - 'event_espresso' |
|
34 | - ) |
|
35 | - ); |
|
36 | - } |
|
37 | - parent::__construct($data); |
|
38 | - } |
|
39 | - |
|
40 | - |
|
41 | - /** |
|
42 | - * setup the data. |
|
43 | - * Sets up the expected data object for the messages prep using incoming registration objects. |
|
44 | - * |
|
45 | - * @return void |
|
46 | - * @throws EE_Error |
|
47 | - * @throws EntityNotFoundException |
|
48 | - * @access protected |
|
49 | - */ |
|
50 | - protected function _setup_data() |
|
51 | - { |
|
52 | - // we'll loop through each contact and setup the data needed. Note that many properties will just be set as |
|
53 | - // empty because this data handler is for a very specific set of data (i.e. just what's related to the |
|
54 | - // registration). |
|
55 | - |
|
56 | - $this->reg_objs = $this->data(); |
|
57 | - $this->txn = $this->_maybe_get_transaction(); |
|
58 | - $this->_assemble_data(); |
|
59 | - } |
|
60 | - |
|
61 | - |
|
62 | - /** |
|
63 | - * If the incoming registrations all share the same transaction then this will return the transaction object shared |
|
64 | - * among the registrations. Otherwise the transaction object is set to null because its intended to only represent |
|
65 | - * one transaction. |
|
66 | - * |
|
67 | - * @return EE_Transaction|null |
|
68 | - * @throws EE_Error |
|
69 | - * @throws EntityNotFoundException |
|
70 | - */ |
|
71 | - protected function _maybe_get_transaction() |
|
72 | - { |
|
73 | - $transactions = array(); |
|
74 | - foreach ($this->reg_objs as $registration) { |
|
75 | - if ($registration instanceof EE_Registration) { |
|
76 | - $transaction = $registration->transaction(); |
|
77 | - if ($transaction instanceof EE_Transaction) { |
|
78 | - $transactions[ $transaction->ID() ] = $transaction; |
|
79 | - } |
|
80 | - } |
|
81 | - } |
|
82 | - return count($transactions) === 1 ? reset($transactions) : null; |
|
83 | - } |
|
84 | - |
|
85 | - |
|
86 | - /** |
|
87 | - * Returns database safe representation of the data later used to when instantiating this object. |
|
88 | - * |
|
89 | - * @param array $registrations The incoming data to be prepped. |
|
90 | - * @return EE_Registration[] The data being prepared for the db |
|
91 | - * @throws EE_Error |
|
92 | - * @throws InvalidArgumentException |
|
93 | - * @throws InvalidDataTypeException |
|
94 | - * @throws InvalidInterfaceException |
|
95 | - */ |
|
96 | - public static function convert_data_for_persistent_storage($registrations) |
|
97 | - { |
|
98 | - if (! self::validateRegistrationsForConversion($registrations)) { |
|
99 | - return array(); |
|
100 | - } |
|
101 | - |
|
102 | - // is this an array of ints? |
|
103 | - $first_item = reset($registrations); |
|
104 | - if (is_int($first_item)) { |
|
105 | - return $registrations; |
|
106 | - } |
|
107 | - |
|
108 | - // k nope so let's pull from the registrations |
|
109 | - $registration_ids = array_filter( |
|
110 | - array_map( |
|
111 | - function ($registration) { |
|
112 | - if ($registration instanceof EE_Registration) { |
|
113 | - return $registration->ID(); |
|
114 | - } |
|
115 | - return false; |
|
116 | - }, |
|
117 | - $registrations |
|
118 | - ) |
|
119 | - ); |
|
120 | - |
|
121 | - return $registration_ids; |
|
122 | - } |
|
123 | - |
|
124 | - |
|
125 | - /** |
|
126 | - * This validates incoming registrations (considers whether they are ids or EE_Registration objects. |
|
127 | - * |
|
128 | - * @param array $registrations Could be EE_Registration[] or int[] |
|
129 | - * @return bool |
|
130 | - * @throws EE_Error |
|
131 | - * @throws InvalidArgumentException |
|
132 | - * @throws InvalidDataTypeException |
|
133 | - * @throws InvalidInterfaceException |
|
134 | - */ |
|
135 | - protected static function validateRegistrationsForConversion($registrations) |
|
136 | - { |
|
137 | - if (is_array($registrations)) { |
|
138 | - $first_item = reset($registrations); |
|
139 | - if ($first_item instanceof EE_Registration) { |
|
140 | - return true; |
|
141 | - } |
|
142 | - if (is_int($first_item)) { |
|
143 | - // k let's some basic validation here. This isn't foolproof but better than nothing. |
|
144 | - // the purpose of this validation is to verify that the ids sent in match valid registrations existing |
|
145 | - // in the db. If the count is different, then we know they aren't valid. |
|
146 | - $count_for_ids = EEM_Registration::instance()->count( |
|
147 | - array( |
|
148 | - array( |
|
149 | - 'REG_ID' => array('IN', $registrations) |
|
150 | - ) |
|
151 | - ) |
|
152 | - ); |
|
153 | - return $count_for_ids === count($registrations); |
|
154 | - } |
|
155 | - } |
|
156 | - return false; |
|
157 | - } |
|
158 | - |
|
159 | - |
|
160 | - /** |
|
161 | - * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage |
|
162 | - * can be sent into this method and converted back into the format used for instantiating with this data handler. |
|
163 | - * |
|
164 | - * @param array $data |
|
165 | - * @return EE_Registration[] |
|
166 | - * @throws EE_Error |
|
167 | - * @throws InvalidArgumentException |
|
168 | - * @throws InvalidDataTypeException |
|
169 | - * @throws InvalidInterfaceException |
|
170 | - */ |
|
171 | - public static function convert_data_from_persistent_storage($data) |
|
172 | - { |
|
173 | - // since this was added later, we need to account of possible back compat issues where data already queued for |
|
174 | - // generation is in the old format, which is an array of EE_Registration objects. So if that's the case, then |
|
175 | - // let's just return them |
|
176 | - // @see https://events.codebasehq.com/projects/event-espresso/tickets/10127 |
|
177 | - if (is_array($data) && reset($data) instanceof EE_Registration) { |
|
178 | - return $data; |
|
179 | - } |
|
180 | - |
|
181 | - $registrations = is_array($data) |
|
182 | - ? EEM_Registration::instance()->get_all(array(array('REG_ID' => array('IN', $data)))) |
|
183 | - : array(); |
|
184 | - return $registrations; |
|
185 | - } |
|
18 | + /** |
|
19 | + * Constructor. |
|
20 | + * |
|
21 | + * @param EE_Registration[] $data expecting an array of EE_Registration objects. |
|
22 | + * @throws EE_Error |
|
23 | + * @access protected |
|
24 | + */ |
|
25 | + public function __construct($data = array()) |
|
26 | + { |
|
27 | + |
|
28 | + // validate that the first element in the array is an EE_Registration object. |
|
29 | + if (! reset($data) instanceof EE_Registration) { |
|
30 | + throw new EE_Error( |
|
31 | + esc_html__( |
|
32 | + 'The EE_Message_Registrations_incoming_data class expects an array of EE_Registration objects.', |
|
33 | + 'event_espresso' |
|
34 | + ) |
|
35 | + ); |
|
36 | + } |
|
37 | + parent::__construct($data); |
|
38 | + } |
|
39 | + |
|
40 | + |
|
41 | + /** |
|
42 | + * setup the data. |
|
43 | + * Sets up the expected data object for the messages prep using incoming registration objects. |
|
44 | + * |
|
45 | + * @return void |
|
46 | + * @throws EE_Error |
|
47 | + * @throws EntityNotFoundException |
|
48 | + * @access protected |
|
49 | + */ |
|
50 | + protected function _setup_data() |
|
51 | + { |
|
52 | + // we'll loop through each contact and setup the data needed. Note that many properties will just be set as |
|
53 | + // empty because this data handler is for a very specific set of data (i.e. just what's related to the |
|
54 | + // registration). |
|
55 | + |
|
56 | + $this->reg_objs = $this->data(); |
|
57 | + $this->txn = $this->_maybe_get_transaction(); |
|
58 | + $this->_assemble_data(); |
|
59 | + } |
|
60 | + |
|
61 | + |
|
62 | + /** |
|
63 | + * If the incoming registrations all share the same transaction then this will return the transaction object shared |
|
64 | + * among the registrations. Otherwise the transaction object is set to null because its intended to only represent |
|
65 | + * one transaction. |
|
66 | + * |
|
67 | + * @return EE_Transaction|null |
|
68 | + * @throws EE_Error |
|
69 | + * @throws EntityNotFoundException |
|
70 | + */ |
|
71 | + protected function _maybe_get_transaction() |
|
72 | + { |
|
73 | + $transactions = array(); |
|
74 | + foreach ($this->reg_objs as $registration) { |
|
75 | + if ($registration instanceof EE_Registration) { |
|
76 | + $transaction = $registration->transaction(); |
|
77 | + if ($transaction instanceof EE_Transaction) { |
|
78 | + $transactions[ $transaction->ID() ] = $transaction; |
|
79 | + } |
|
80 | + } |
|
81 | + } |
|
82 | + return count($transactions) === 1 ? reset($transactions) : null; |
|
83 | + } |
|
84 | + |
|
85 | + |
|
86 | + /** |
|
87 | + * Returns database safe representation of the data later used to when instantiating this object. |
|
88 | + * |
|
89 | + * @param array $registrations The incoming data to be prepped. |
|
90 | + * @return EE_Registration[] The data being prepared for the db |
|
91 | + * @throws EE_Error |
|
92 | + * @throws InvalidArgumentException |
|
93 | + * @throws InvalidDataTypeException |
|
94 | + * @throws InvalidInterfaceException |
|
95 | + */ |
|
96 | + public static function convert_data_for_persistent_storage($registrations) |
|
97 | + { |
|
98 | + if (! self::validateRegistrationsForConversion($registrations)) { |
|
99 | + return array(); |
|
100 | + } |
|
101 | + |
|
102 | + // is this an array of ints? |
|
103 | + $first_item = reset($registrations); |
|
104 | + if (is_int($first_item)) { |
|
105 | + return $registrations; |
|
106 | + } |
|
107 | + |
|
108 | + // k nope so let's pull from the registrations |
|
109 | + $registration_ids = array_filter( |
|
110 | + array_map( |
|
111 | + function ($registration) { |
|
112 | + if ($registration instanceof EE_Registration) { |
|
113 | + return $registration->ID(); |
|
114 | + } |
|
115 | + return false; |
|
116 | + }, |
|
117 | + $registrations |
|
118 | + ) |
|
119 | + ); |
|
120 | + |
|
121 | + return $registration_ids; |
|
122 | + } |
|
123 | + |
|
124 | + |
|
125 | + /** |
|
126 | + * This validates incoming registrations (considers whether they are ids or EE_Registration objects. |
|
127 | + * |
|
128 | + * @param array $registrations Could be EE_Registration[] or int[] |
|
129 | + * @return bool |
|
130 | + * @throws EE_Error |
|
131 | + * @throws InvalidArgumentException |
|
132 | + * @throws InvalidDataTypeException |
|
133 | + * @throws InvalidInterfaceException |
|
134 | + */ |
|
135 | + protected static function validateRegistrationsForConversion($registrations) |
|
136 | + { |
|
137 | + if (is_array($registrations)) { |
|
138 | + $first_item = reset($registrations); |
|
139 | + if ($first_item instanceof EE_Registration) { |
|
140 | + return true; |
|
141 | + } |
|
142 | + if (is_int($first_item)) { |
|
143 | + // k let's some basic validation here. This isn't foolproof but better than nothing. |
|
144 | + // the purpose of this validation is to verify that the ids sent in match valid registrations existing |
|
145 | + // in the db. If the count is different, then we know they aren't valid. |
|
146 | + $count_for_ids = EEM_Registration::instance()->count( |
|
147 | + array( |
|
148 | + array( |
|
149 | + 'REG_ID' => array('IN', $registrations) |
|
150 | + ) |
|
151 | + ) |
|
152 | + ); |
|
153 | + return $count_for_ids === count($registrations); |
|
154 | + } |
|
155 | + } |
|
156 | + return false; |
|
157 | + } |
|
158 | + |
|
159 | + |
|
160 | + /** |
|
161 | + * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage |
|
162 | + * can be sent into this method and converted back into the format used for instantiating with this data handler. |
|
163 | + * |
|
164 | + * @param array $data |
|
165 | + * @return EE_Registration[] |
|
166 | + * @throws EE_Error |
|
167 | + * @throws InvalidArgumentException |
|
168 | + * @throws InvalidDataTypeException |
|
169 | + * @throws InvalidInterfaceException |
|
170 | + */ |
|
171 | + public static function convert_data_from_persistent_storage($data) |
|
172 | + { |
|
173 | + // since this was added later, we need to account of possible back compat issues where data already queued for |
|
174 | + // generation is in the old format, which is an array of EE_Registration objects. So if that's the case, then |
|
175 | + // let's just return them |
|
176 | + // @see https://events.codebasehq.com/projects/event-espresso/tickets/10127 |
|
177 | + if (is_array($data) && reset($data) instanceof EE_Registration) { |
|
178 | + return $data; |
|
179 | + } |
|
180 | + |
|
181 | + $registrations = is_array($data) |
|
182 | + ? EEM_Registration::instance()->get_all(array(array('REG_ID' => array('IN', $data)))) |
|
183 | + : array(); |
|
184 | + return $registrations; |
|
185 | + } |
|
186 | 186 | } |
@@ -32,18 +32,18 @@ |
||
32 | 32 | |
33 | 33 | // modify just event_list |
34 | 34 | $new_config['event_list'] = array( |
35 | - 'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization','recipient_details', 'recipient_list', 'event_author', 'primary_registration_details', 'primary_registration_list') |
|
35 | + 'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'recipient_details', 'recipient_list', 'event_author', 'primary_registration_details', 'primary_registration_list') |
|
36 | 36 | ); |
37 | 37 | $new_config['ticket_list'] = array( |
38 | 38 | 'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list', 'recipient_details', 'transaction') |
39 | 39 | ); |
40 | 40 | $new_config['content'] = array( |
41 | - 'shortcodes' => array('event_list','attendee_list', 'ticket_list', 'organization', 'recipient_details', 'recipient_list', 'transaction', 'primary_registration_details', 'primary_registration_list', 'messenger') |
|
41 | + 'shortcodes' => array('event_list', 'attendee_list', 'ticket_list', 'organization', 'recipient_details', 'recipient_list', 'transaction', 'primary_registration_details', 'primary_registration_list', 'messenger') |
|
42 | 42 | ); |
43 | 43 | $this->_messenger->set_validator_config($new_config); |
44 | 44 | |
45 | 45 | if ($this->_context != 'admin') { |
46 | - $this->_valid_shortcodes_modifier[ $this->_context ]['event_list'] = array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list'); |
|
46 | + $this->_valid_shortcodes_modifier[$this->_context]['event_list'] = array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list'); |
|
47 | 47 | } |
48 | 48 | |
49 | 49 | $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]'); |
@@ -13,37 +13,37 @@ |
||
13 | 13 | */ |
14 | 14 | class EE_Messages_Email_Payment_Refund_Validator extends EE_Messages_Validator |
15 | 15 | { |
16 | - public function __construct($fields, $context) |
|
17 | - { |
|
18 | - $this->_m_name = 'email'; |
|
19 | - $this->_mt_name = 'payment_refund'; |
|
16 | + public function __construct($fields, $context) |
|
17 | + { |
|
18 | + $this->_m_name = 'email'; |
|
19 | + $this->_mt_name = 'payment_refund'; |
|
20 | 20 | |
21 | - parent::__construct($fields, $context); |
|
22 | - } |
|
21 | + parent::__construct($fields, $context); |
|
22 | + } |
|
23 | 23 | |
24 | - /** |
|
25 | - * at this point no custom validation needed for this messenger/message_type combo. |
|
26 | - */ |
|
27 | - protected function _modify_validator() |
|
28 | - { |
|
29 | - $new_config = $this->_messenger->get_validator_config(); |
|
24 | + /** |
|
25 | + * at this point no custom validation needed for this messenger/message_type combo. |
|
26 | + */ |
|
27 | + protected function _modify_validator() |
|
28 | + { |
|
29 | + $new_config = $this->_messenger->get_validator_config(); |
|
30 | 30 | |
31 | - // modify just event_list |
|
32 | - $new_config['event_list'] = array( |
|
33 | - 'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization','recipient_details', 'recipient_list', 'event_author', 'primary_registration_details', 'primary_registration_list') |
|
34 | - ); |
|
35 | - $new_config['ticket_list'] = array( |
|
36 | - 'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list', 'recipient_details', 'transaction') |
|
37 | - ); |
|
38 | - $new_config['content'] = array( |
|
39 | - 'shortcodes' => array('event_list','attendee_list', 'ticket_list', 'organization', 'recipient_details', 'recipient_list', 'transaction', 'primary_registration_details', 'primary_registration_list', 'messenger') |
|
40 | - ); |
|
41 | - $this->_messenger->set_validator_config($new_config); |
|
31 | + // modify just event_list |
|
32 | + $new_config['event_list'] = array( |
|
33 | + 'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization','recipient_details', 'recipient_list', 'event_author', 'primary_registration_details', 'primary_registration_list') |
|
34 | + ); |
|
35 | + $new_config['ticket_list'] = array( |
|
36 | + 'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list', 'recipient_details', 'transaction') |
|
37 | + ); |
|
38 | + $new_config['content'] = array( |
|
39 | + 'shortcodes' => array('event_list','attendee_list', 'ticket_list', 'organization', 'recipient_details', 'recipient_list', 'transaction', 'primary_registration_details', 'primary_registration_list', 'messenger') |
|
40 | + ); |
|
41 | + $this->_messenger->set_validator_config($new_config); |
|
42 | 42 | |
43 | - if ($this->_context != 'admin') { |
|
44 | - $this->_valid_shortcodes_modifier[ $this->_context ]['event_list'] = array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list'); |
|
45 | - } |
|
43 | + if ($this->_context != 'admin') { |
|
44 | + $this->_valid_shortcodes_modifier[ $this->_context ]['event_list'] = array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list'); |
|
45 | + } |
|
46 | 46 | |
47 | - $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]'); |
|
48 | - } |
|
47 | + $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]'); |
|
48 | + } |
|
49 | 49 | } |
@@ -38,7 +38,7 @@ |
||
38 | 38 | $this->_messenger->set_validator_config($new_config); |
39 | 39 | |
40 | 40 | if ($this->_context != 'admin') { |
41 | - $this->_valid_shortcodes_modifier[ $this->_context ]['event_list'] = array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list'); |
|
41 | + $this->_valid_shortcodes_modifier[$this->_context]['event_list'] = array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list'); |
|
42 | 42 | } |
43 | 43 | |
44 | 44 | $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]'); |
@@ -14,31 +14,31 @@ |
||
14 | 14 | */ |
15 | 15 | class EE_Messages_Email_Registration_Summary_Validator extends EE_Messages_Validator |
16 | 16 | { |
17 | - public function __construct($fields, $context) |
|
18 | - { |
|
19 | - $this->_m_name = 'email'; |
|
20 | - $this->_mt_name = 'registration_summary'; |
|
17 | + public function __construct($fields, $context) |
|
18 | + { |
|
19 | + $this->_m_name = 'email'; |
|
20 | + $this->_mt_name = 'registration_summary'; |
|
21 | 21 | |
22 | - parent::__construct($fields, $context); |
|
23 | - } |
|
22 | + parent::__construct($fields, $context); |
|
23 | + } |
|
24 | 24 | |
25 | - /** |
|
26 | - * custom validator (restricting what was originally set by the messenger) |
|
27 | - */ |
|
28 | - protected function _modify_validator() |
|
29 | - { |
|
30 | - $new_config = $this->_messenger->get_validator_config(); |
|
31 | - // modify just event_list |
|
32 | - $new_config['event_list'] = array( |
|
33 | - 'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list'), |
|
34 | - 'required' => array('[EVENT_LIST]') |
|
35 | - ); |
|
36 | - $this->_messenger->set_validator_config($new_config); |
|
25 | + /** |
|
26 | + * custom validator (restricting what was originally set by the messenger) |
|
27 | + */ |
|
28 | + protected function _modify_validator() |
|
29 | + { |
|
30 | + $new_config = $this->_messenger->get_validator_config(); |
|
31 | + // modify just event_list |
|
32 | + $new_config['event_list'] = array( |
|
33 | + 'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list'), |
|
34 | + 'required' => array('[EVENT_LIST]') |
|
35 | + ); |
|
36 | + $this->_messenger->set_validator_config($new_config); |
|
37 | 37 | |
38 | - if ($this->_context != 'admin') { |
|
39 | - $this->_valid_shortcodes_modifier[ $this->_context ]['event_list'] = array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list'); |
|
40 | - } |
|
38 | + if ($this->_context != 'admin') { |
|
39 | + $this->_valid_shortcodes_modifier[ $this->_context ]['event_list'] = array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list'); |
|
40 | + } |
|
41 | 41 | |
42 | - $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]'); |
|
43 | - } |
|
42 | + $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]'); |
|
43 | + } |
|
44 | 44 | } |
@@ -46,7 +46,7 @@ |
||
46 | 46 | */ |
47 | 47 | public function get_key($classname, $data) |
48 | 48 | { |
49 | - return md5($classname . serialize($data)); |
|
49 | + return md5($classname.serialize($data)); |
|
50 | 50 | } |
51 | 51 | |
52 | 52 |
@@ -9,69 +9,69 @@ |
||
9 | 9 | */ |
10 | 10 | class EE_Messages_Data_Handler_Collection extends EE_Object_Collection |
11 | 11 | { |
12 | - public function __construct() |
|
13 | - { |
|
14 | - $this->interface = 'EE_Messages_incoming_data'; |
|
15 | - } |
|
12 | + public function __construct() |
|
13 | + { |
|
14 | + $this->interface = 'EE_Messages_incoming_data'; |
|
15 | + } |
|
16 | 16 | |
17 | 17 | |
18 | - /** |
|
19 | - * This adds the EE_Messages_incoming_data data handler object to the collection. |
|
20 | - * |
|
21 | - * @param EE_Messages_incoming_data $data_handler |
|
22 | - * @param mixed $data Usually an array of data used in combination with the $data_handler |
|
23 | - * classname to create an alternative index for retrieving data_handlers. |
|
24 | - * @return bool |
|
25 | - */ |
|
26 | - public function add($data_handler, $data = ''): bool |
|
27 | - { |
|
28 | - $data = $data === null ? array() : (array) $data; |
|
29 | - $info['key'] = $this->get_key(get_class($data_handler), $data); |
|
30 | - return parent::add($data_handler, $info); |
|
31 | - } |
|
18 | + /** |
|
19 | + * This adds the EE_Messages_incoming_data data handler object to the collection. |
|
20 | + * |
|
21 | + * @param EE_Messages_incoming_data $data_handler |
|
22 | + * @param mixed $data Usually an array of data used in combination with the $data_handler |
|
23 | + * classname to create an alternative index for retrieving data_handlers. |
|
24 | + * @return bool |
|
25 | + */ |
|
26 | + public function add($data_handler, $data = ''): bool |
|
27 | + { |
|
28 | + $data = $data === null ? array() : (array) $data; |
|
29 | + $info['key'] = $this->get_key(get_class($data_handler), $data); |
|
30 | + return parent::add($data_handler, $info); |
|
31 | + } |
|
32 | 32 | |
33 | 33 | |
34 | 34 | |
35 | 35 | |
36 | 36 | |
37 | - /** |
|
38 | - * This returns a key for retrieving data for the given references used to generate the key. |
|
39 | - * Data handlers are cached to the repository along with a md5() generated key using known references. |
|
40 | - * @param string $classname The classname of the datahandler being checked for. |
|
41 | - * @param mixed $data The data that was used to instantiate the data_handler. |
|
42 | - * |
|
43 | - * @return string md5 hash using provided info. |
|
44 | - */ |
|
45 | - public function get_key($classname, $data) |
|
46 | - { |
|
47 | - return md5($classname . serialize($data)); |
|
48 | - } |
|
37 | + /** |
|
38 | + * This returns a key for retrieving data for the given references used to generate the key. |
|
39 | + * Data handlers are cached to the repository along with a md5() generated key using known references. |
|
40 | + * @param string $classname The classname of the datahandler being checked for. |
|
41 | + * @param mixed $data The data that was used to instantiate the data_handler. |
|
42 | + * |
|
43 | + * @return string md5 hash using provided info. |
|
44 | + */ |
|
45 | + public function get_key($classname, $data) |
|
46 | + { |
|
47 | + return md5($classname . serialize($data)); |
|
48 | + } |
|
49 | 49 | |
50 | 50 | |
51 | 51 | |
52 | 52 | |
53 | 53 | |
54 | 54 | |
55 | - /** |
|
56 | - * This returns a saved EE_Messages_incoming_data object if there is one in the repository indexed by a key matching |
|
57 | - * the given string. |
|
58 | - * |
|
59 | - * @param string $key @see EE_Messages_Data_Handler_Collection::get_key() to setup a key formatted for searching. |
|
60 | - * |
|
61 | - * @return null|EE_Messages_incoming_data |
|
62 | - */ |
|
63 | - public function get_by_key($key) |
|
64 | - { |
|
65 | - $this->rewind(); |
|
66 | - while ($this->valid()) { |
|
67 | - $data = $this->getInfo(); |
|
68 | - if (isset($data['key']) && $data['key'] === $key) { |
|
69 | - $handler = $this->current(); |
|
70 | - $this->rewind(); |
|
71 | - return $handler; |
|
72 | - } |
|
73 | - $this->next(); |
|
74 | - } |
|
75 | - return null; |
|
76 | - } |
|
55 | + /** |
|
56 | + * This returns a saved EE_Messages_incoming_data object if there is one in the repository indexed by a key matching |
|
57 | + * the given string. |
|
58 | + * |
|
59 | + * @param string $key @see EE_Messages_Data_Handler_Collection::get_key() to setup a key formatted for searching. |
|
60 | + * |
|
61 | + * @return null|EE_Messages_incoming_data |
|
62 | + */ |
|
63 | + public function get_by_key($key) |
|
64 | + { |
|
65 | + $this->rewind(); |
|
66 | + while ($this->valid()) { |
|
67 | + $data = $this->getInfo(); |
|
68 | + if (isset($data['key']) && $data['key'] === $key) { |
|
69 | + $handler = $this->current(); |
|
70 | + $this->rewind(); |
|
71 | + return $handler; |
|
72 | + } |
|
73 | + $this->next(); |
|
74 | + } |
|
75 | + return null; |
|
76 | + } |
|
77 | 77 | } |
@@ -52,7 +52,7 @@ discard block |
||
52 | 52 | |
53 | 53 | protected function _set_admin_pages() |
54 | 54 | { |
55 | - $this->admin_registered_pages = array( 'events_edit' => true ); |
|
55 | + $this->admin_registered_pages = array('events_edit' => true); |
|
56 | 56 | } |
57 | 57 | |
58 | 58 | |
@@ -67,7 +67,7 @@ discard block |
||
67 | 67 | protected function _set_with_messengers() |
68 | 68 | { |
69 | 69 | $this->_with_messengers = array( |
70 | - 'html' => array( 'pdf' ) |
|
70 | + 'html' => array('pdf') |
|
71 | 71 | ); |
72 | 72 | } |
73 | 73 | |
@@ -78,7 +78,7 @@ discard block |
||
78 | 78 | // receipt message type data handler is 'Gateways' and it expects a transaction object. |
79 | 79 | $transaction = $registration->transaction(); |
80 | 80 | if ($transaction instanceof EE_Transaction) { |
81 | - return array( $transaction ); |
|
81 | + return array($transaction); |
|
82 | 82 | } |
83 | 83 | return array(); |
84 | 84 | } |
@@ -12,123 +12,123 @@ |
||
12 | 12 | */ |
13 | 13 | class EE_Invoice_message_type extends EE_message_type |
14 | 14 | { |
15 | - public function __construct() |
|
16 | - { |
|
17 | - $this->name = 'invoice'; |
|
18 | - $this->description = esc_html__('The invoice message type is triggered via a url on the thank you page and via at url generated by the [INVOICE_URL] or [INVOICE_LINK] shortcode.', 'event_espresso'); |
|
19 | - $this->label = array( |
|
20 | - 'singular' => esc_html__('invoice', 'event_espresso'), |
|
21 | - 'plural' => esc_html__('invoices', 'event_espresso') |
|
22 | - ); |
|
23 | - $this->_master_templates = array(); |
|
24 | - parent::__construct(); |
|
25 | - } |
|
15 | + public function __construct() |
|
16 | + { |
|
17 | + $this->name = 'invoice'; |
|
18 | + $this->description = esc_html__('The invoice message type is triggered via a url on the thank you page and via at url generated by the [INVOICE_URL] or [INVOICE_LINK] shortcode.', 'event_espresso'); |
|
19 | + $this->label = array( |
|
20 | + 'singular' => esc_html__('invoice', 'event_espresso'), |
|
21 | + 'plural' => esc_html__('invoices', 'event_espresso') |
|
22 | + ); |
|
23 | + $this->_master_templates = array(); |
|
24 | + parent::__construct(); |
|
25 | + } |
|
26 | 26 | |
27 | 27 | |
28 | 28 | |
29 | - /** |
|
30 | - * @see parent::get_priority() for documentation. |
|
31 | - * @return int |
|
32 | - */ |
|
33 | - public function get_priority() |
|
34 | - { |
|
35 | - return EEM_Message::priority_high; |
|
36 | - } |
|
29 | + /** |
|
30 | + * @see parent::get_priority() for documentation. |
|
31 | + * @return int |
|
32 | + */ |
|
33 | + public function get_priority() |
|
34 | + { |
|
35 | + return EEM_Message::priority_high; |
|
36 | + } |
|
37 | 37 | |
38 | 38 | |
39 | - /** |
|
40 | - * This method returns whether this message type should always generate a new copy |
|
41 | - * when requested, or if links can be to the already generated copy. |
|
42 | - * Note: this does NOT affect viewing/resending already generated messages in the EE_Message list table. |
|
43 | - * Invoices always generate. |
|
44 | - * @return bool false means can link to generated EE_Message. true must regenerate. |
|
45 | - */ |
|
46 | - public function always_generate() |
|
47 | - { |
|
48 | - return true; |
|
49 | - } |
|
39 | + /** |
|
40 | + * This method returns whether this message type should always generate a new copy |
|
41 | + * when requested, or if links can be to the already generated copy. |
|
42 | + * Note: this does NOT affect viewing/resending already generated messages in the EE_Message list table. |
|
43 | + * Invoices always generate. |
|
44 | + * @return bool false means can link to generated EE_Message. true must regenerate. |
|
45 | + */ |
|
46 | + public function always_generate() |
|
47 | + { |
|
48 | + return true; |
|
49 | + } |
|
50 | 50 | |
51 | 51 | |
52 | - protected function _set_admin_pages() |
|
53 | - { |
|
54 | - $this->admin_registered_pages = array( 'events_edit' => true ); |
|
55 | - } |
|
52 | + protected function _set_admin_pages() |
|
53 | + { |
|
54 | + $this->admin_registered_pages = array( 'events_edit' => true ); |
|
55 | + } |
|
56 | 56 | |
57 | 57 | |
58 | 58 | |
59 | - protected function _set_data_handler() |
|
60 | - { |
|
61 | - $this->_data_handler = 'Gateways'; |
|
62 | - } |
|
59 | + protected function _set_data_handler() |
|
60 | + { |
|
61 | + $this->_data_handler = 'Gateways'; |
|
62 | + } |
|
63 | 63 | |
64 | 64 | |
65 | 65 | |
66 | - protected function _set_with_messengers() |
|
67 | - { |
|
68 | - $this->_with_messengers = array( |
|
69 | - 'html' => array( 'pdf' ) |
|
70 | - ); |
|
71 | - } |
|
66 | + protected function _set_with_messengers() |
|
67 | + { |
|
68 | + $this->_with_messengers = array( |
|
69 | + 'html' => array( 'pdf' ) |
|
70 | + ); |
|
71 | + } |
|
72 | 72 | |
73 | 73 | |
74 | 74 | |
75 | - protected function _get_data_for_context($context, EE_Registration $registration, $id) |
|
76 | - { |
|
77 | - // receipt message type data handler is 'Gateways' and it expects a transaction object. |
|
78 | - $transaction = $registration->transaction(); |
|
79 | - if ($transaction instanceof EE_Transaction) { |
|
80 | - return array( $transaction ); |
|
81 | - } |
|
82 | - return array(); |
|
83 | - } |
|
75 | + protected function _get_data_for_context($context, EE_Registration $registration, $id) |
|
76 | + { |
|
77 | + // receipt message type data handler is 'Gateways' and it expects a transaction object. |
|
78 | + $transaction = $registration->transaction(); |
|
79 | + if ($transaction instanceof EE_Transaction) { |
|
80 | + return array( $transaction ); |
|
81 | + } |
|
82 | + return array(); |
|
83 | + } |
|
84 | 84 | |
85 | 85 | |
86 | 86 | |
87 | - protected function _set_admin_settings_fields() |
|
88 | - { |
|
89 | - $this->_admin_settings_fields = array(); |
|
90 | - } |
|
87 | + protected function _set_admin_settings_fields() |
|
88 | + { |
|
89 | + $this->_admin_settings_fields = array(); |
|
90 | + } |
|
91 | 91 | |
92 | 92 | |
93 | 93 | |
94 | - protected function _set_contexts() |
|
95 | - { |
|
96 | - $this->_context_label = array( |
|
97 | - 'label' => esc_html__('recipient', 'event_espresso'), |
|
98 | - 'plural' => esc_html__('recipients', 'event_espresso'), |
|
99 | - 'description' => esc_html__('Recipient\'s are who will view the invoice.', 'event_espresso') |
|
100 | - ); |
|
94 | + protected function _set_contexts() |
|
95 | + { |
|
96 | + $this->_context_label = array( |
|
97 | + 'label' => esc_html__('recipient', 'event_espresso'), |
|
98 | + 'plural' => esc_html__('recipients', 'event_espresso'), |
|
99 | + 'description' => esc_html__('Recipient\'s are who will view the invoice.', 'event_espresso') |
|
100 | + ); |
|
101 | 101 | |
102 | - $this->_contexts = array( |
|
103 | - 'purchaser' => array( |
|
104 | - 'label' => esc_html__('Purchaser', 'event_espresso'), |
|
105 | - 'description' => esc_html__('This template goes to the person who conducted the transaction.', 'event_espresso') |
|
106 | - ) |
|
107 | - ); |
|
108 | - } |
|
102 | + $this->_contexts = array( |
|
103 | + 'purchaser' => array( |
|
104 | + 'label' => esc_html__('Purchaser', 'event_espresso'), |
|
105 | + 'description' => esc_html__('This template goes to the person who conducted the transaction.', 'event_espresso') |
|
106 | + ) |
|
107 | + ); |
|
108 | + } |
|
109 | 109 | |
110 | 110 | |
111 | 111 | |
112 | 112 | |
113 | - /** |
|
114 | - * used to set the valid shortcodes for the receipt message type |
|
115 | - * |
|
116 | - * @since 4.5.0 |
|
117 | - * |
|
118 | - * @return void |
|
119 | - */ |
|
120 | - protected function _set_valid_shortcodes() |
|
121 | - { |
|
122 | - $this->_valid_shortcodes['purchaser'] = array( |
|
123 | - 'attendee_list', 'attendee', 'datetime_list', 'datetime', 'event_list', 'event', 'event_meta', 'messenger', 'organization', 'primary_registration_list', 'primary_registration_details', 'ticket_list', 'ticket', 'transaction', 'venue', 'line_item_list', 'payment_list', 'line_item', 'payment' |
|
124 | - ); |
|
125 | - } |
|
113 | + /** |
|
114 | + * used to set the valid shortcodes for the receipt message type |
|
115 | + * |
|
116 | + * @since 4.5.0 |
|
117 | + * |
|
118 | + * @return void |
|
119 | + */ |
|
120 | + protected function _set_valid_shortcodes() |
|
121 | + { |
|
122 | + $this->_valid_shortcodes['purchaser'] = array( |
|
123 | + 'attendee_list', 'attendee', 'datetime_list', 'datetime', 'event_list', 'event', 'event_meta', 'messenger', 'organization', 'primary_registration_list', 'primary_registration_details', 'ticket_list', 'ticket', 'transaction', 'venue', 'line_item_list', 'payment_list', 'line_item', 'payment' |
|
124 | + ); |
|
125 | + } |
|
126 | 126 | |
127 | 127 | |
128 | 128 | |
129 | 129 | |
130 | - protected function _purchaser_addressees() |
|
131 | - { |
|
132 | - return parent::_primary_attendee_addressees(); |
|
133 | - } |
|
130 | + protected function _purchaser_addressees() |
|
131 | + { |
|
132 | + return parent::_primary_attendee_addressees(); |
|
133 | + } |
|
134 | 134 | } |
@@ -53,7 +53,7 @@ discard block |
||
53 | 53 | |
54 | 54 | protected function _set_admin_pages() |
55 | 55 | { |
56 | - $this->admin_registered_pages = array( 'events_edit' => true ); |
|
56 | + $this->admin_registered_pages = array('events_edit' => true); |
|
57 | 57 | } |
58 | 58 | |
59 | 59 | |
@@ -68,7 +68,7 @@ discard block |
||
68 | 68 | protected function _set_with_messengers() |
69 | 69 | { |
70 | 70 | $this->_with_messengers = array( |
71 | - 'html' => array( 'pdf' ) |
|
71 | + 'html' => array('pdf') |
|
72 | 72 | ); |
73 | 73 | } |
74 | 74 | |
@@ -79,7 +79,7 @@ discard block |
||
79 | 79 | // receipt message type data handler is 'Gateways' and it expects a transaction object. |
80 | 80 | $transaction = $registration->transaction(); |
81 | 81 | if ($transaction instanceof EE_Transaction) { |
82 | - return array( $transaction ); |
|
82 | + return array($transaction); |
|
83 | 83 | } |
84 | 84 | return array(); |
85 | 85 | } |
@@ -12,142 +12,142 @@ |
||
12 | 12 | */ |
13 | 13 | class EE_Receipt_message_type extends EE_message_type |
14 | 14 | { |
15 | - public function __construct() |
|
16 | - { |
|
17 | - $this->name = 'receipt'; |
|
18 | - $this->description = esc_html__('The receipt message type is triggered via a url on the thank you page and via at url generated by the [RECEIPT_URL] shortcode.', 'event_espresso'); |
|
19 | - $this->label = array( |
|
20 | - 'singular' => esc_html__('receipt', 'event_espresso'), |
|
21 | - 'plural' => esc_html__('receipts', 'event_espresso') |
|
22 | - ); |
|
23 | - $this->_master_templates = array(); |
|
24 | - parent::__construct(); |
|
25 | - } |
|
15 | + public function __construct() |
|
16 | + { |
|
17 | + $this->name = 'receipt'; |
|
18 | + $this->description = esc_html__('The receipt message type is triggered via a url on the thank you page and via at url generated by the [RECEIPT_URL] shortcode.', 'event_espresso'); |
|
19 | + $this->label = array( |
|
20 | + 'singular' => esc_html__('receipt', 'event_espresso'), |
|
21 | + 'plural' => esc_html__('receipts', 'event_espresso') |
|
22 | + ); |
|
23 | + $this->_master_templates = array(); |
|
24 | + parent::__construct(); |
|
25 | + } |
|
26 | 26 | |
27 | 27 | |
28 | 28 | |
29 | - /** |
|
30 | - * @see parent::get_priority() for documentation. |
|
31 | - * @return int |
|
32 | - */ |
|
33 | - public function get_priority() |
|
34 | - { |
|
35 | - return EEM_Message::priority_high; |
|
36 | - } |
|
37 | - |
|
38 | - |
|
39 | - |
|
40 | - /** |
|
41 | - * This method returns whether this message type should always generate a new copy |
|
42 | - * when requested, or if links can be to the already generated copy. |
|
43 | - * Note: this does NOT affect viewing/resending already generated messages in the EE_Message list table. |
|
44 | - * Receipts always generate |
|
45 | - * @return bool false means can link to generated EE_Message. true must regenerate. |
|
46 | - */ |
|
47 | - public function always_generate() |
|
48 | - { |
|
49 | - return true; |
|
50 | - } |
|
51 | - |
|
52 | - |
|
53 | - protected function _set_admin_pages() |
|
54 | - { |
|
55 | - $this->admin_registered_pages = array( 'events_edit' => true ); |
|
56 | - } |
|
57 | - |
|
58 | - |
|
59 | - |
|
60 | - protected function _set_data_handler() |
|
61 | - { |
|
62 | - $this->_data_handler = 'Gateways'; |
|
63 | - } |
|
64 | - |
|
65 | - |
|
66 | - |
|
67 | - protected function _set_with_messengers() |
|
68 | - { |
|
69 | - $this->_with_messengers = array( |
|
70 | - 'html' => array( 'pdf' ) |
|
71 | - ); |
|
72 | - } |
|
73 | - |
|
74 | - |
|
75 | - |
|
76 | - protected function _get_data_for_context($context, EE_Registration $registration, $id) |
|
77 | - { |
|
78 | - // receipt message type data handler is 'Gateways' and it expects a transaction object. |
|
79 | - $transaction = $registration->transaction(); |
|
80 | - if ($transaction instanceof EE_Transaction) { |
|
81 | - return array( $transaction ); |
|
82 | - } |
|
83 | - return array(); |
|
84 | - } |
|
85 | - |
|
86 | - |
|
87 | - |
|
88 | - protected function _set_admin_settings_fields() |
|
89 | - { |
|
90 | - $this->_admin_settings_fields = array(); |
|
91 | - } |
|
92 | - |
|
93 | - |
|
94 | - |
|
95 | - protected function _set_contexts() |
|
96 | - { |
|
97 | - $this->_context_label = array( |
|
98 | - 'label' => esc_html__('recipient', 'event_espresso'), |
|
99 | - 'plural' => esc_html__('recipients', 'event_espresso'), |
|
100 | - 'description' => esc_html__('Recipient\'s are who will view the receipt.', 'event_espresso') |
|
101 | - ); |
|
102 | - |
|
103 | - $this->_contexts = array( |
|
104 | - 'purchaser' => array( |
|
105 | - 'label' => esc_html__('Purchaser', 'event_espresso'), |
|
106 | - 'description' => esc_html__('This template goes to the person who conducted the transaction.', 'event_espresso') |
|
107 | - ) |
|
108 | - ); |
|
109 | - } |
|
110 | - |
|
111 | - |
|
112 | - |
|
113 | - |
|
114 | - /** |
|
115 | - * used to set the valid shortcodes for the receipt message type |
|
116 | - * |
|
117 | - * @since 4.5.0 |
|
118 | - * |
|
119 | - * @return void |
|
120 | - */ |
|
121 | - protected function _set_valid_shortcodes() |
|
122 | - { |
|
123 | - $this->_valid_shortcodes['purchaser'] = array( |
|
124 | - 'attendee_list', |
|
125 | - 'attendee', |
|
126 | - 'datetime_list', |
|
127 | - 'datetime', |
|
128 | - 'event_list', |
|
129 | - 'event', |
|
130 | - 'event_meta', |
|
131 | - 'messenger', |
|
132 | - 'organization', |
|
133 | - 'primary_registration_list', |
|
134 | - 'primary_registration_details', |
|
135 | - 'ticket_list', |
|
136 | - 'ticket', |
|
137 | - 'transaction', |
|
138 | - 'venue', |
|
139 | - 'line_item_list', |
|
140 | - 'payment_list', |
|
141 | - 'line_item', |
|
142 | - 'payment' |
|
143 | - ); |
|
144 | - } |
|
145 | - |
|
29 | + /** |
|
30 | + * @see parent::get_priority() for documentation. |
|
31 | + * @return int |
|
32 | + */ |
|
33 | + public function get_priority() |
|
34 | + { |
|
35 | + return EEM_Message::priority_high; |
|
36 | + } |
|
37 | + |
|
38 | + |
|
39 | + |
|
40 | + /** |
|
41 | + * This method returns whether this message type should always generate a new copy |
|
42 | + * when requested, or if links can be to the already generated copy. |
|
43 | + * Note: this does NOT affect viewing/resending already generated messages in the EE_Message list table. |
|
44 | + * Receipts always generate |
|
45 | + * @return bool false means can link to generated EE_Message. true must regenerate. |
|
46 | + */ |
|
47 | + public function always_generate() |
|
48 | + { |
|
49 | + return true; |
|
50 | + } |
|
51 | + |
|
52 | + |
|
53 | + protected function _set_admin_pages() |
|
54 | + { |
|
55 | + $this->admin_registered_pages = array( 'events_edit' => true ); |
|
56 | + } |
|
57 | + |
|
58 | + |
|
59 | + |
|
60 | + protected function _set_data_handler() |
|
61 | + { |
|
62 | + $this->_data_handler = 'Gateways'; |
|
63 | + } |
|
64 | + |
|
65 | + |
|
66 | + |
|
67 | + protected function _set_with_messengers() |
|
68 | + { |
|
69 | + $this->_with_messengers = array( |
|
70 | + 'html' => array( 'pdf' ) |
|
71 | + ); |
|
72 | + } |
|
73 | + |
|
74 | + |
|
75 | + |
|
76 | + protected function _get_data_for_context($context, EE_Registration $registration, $id) |
|
77 | + { |
|
78 | + // receipt message type data handler is 'Gateways' and it expects a transaction object. |
|
79 | + $transaction = $registration->transaction(); |
|
80 | + if ($transaction instanceof EE_Transaction) { |
|
81 | + return array( $transaction ); |
|
82 | + } |
|
83 | + return array(); |
|
84 | + } |
|
85 | + |
|
86 | + |
|
87 | + |
|
88 | + protected function _set_admin_settings_fields() |
|
89 | + { |
|
90 | + $this->_admin_settings_fields = array(); |
|
91 | + } |
|
92 | + |
|
93 | + |
|
94 | + |
|
95 | + protected function _set_contexts() |
|
96 | + { |
|
97 | + $this->_context_label = array( |
|
98 | + 'label' => esc_html__('recipient', 'event_espresso'), |
|
99 | + 'plural' => esc_html__('recipients', 'event_espresso'), |
|
100 | + 'description' => esc_html__('Recipient\'s are who will view the receipt.', 'event_espresso') |
|
101 | + ); |
|
102 | + |
|
103 | + $this->_contexts = array( |
|
104 | + 'purchaser' => array( |
|
105 | + 'label' => esc_html__('Purchaser', 'event_espresso'), |
|
106 | + 'description' => esc_html__('This template goes to the person who conducted the transaction.', 'event_espresso') |
|
107 | + ) |
|
108 | + ); |
|
109 | + } |
|
110 | + |
|
111 | + |
|
112 | + |
|
113 | + |
|
114 | + /** |
|
115 | + * used to set the valid shortcodes for the receipt message type |
|
116 | + * |
|
117 | + * @since 4.5.0 |
|
118 | + * |
|
119 | + * @return void |
|
120 | + */ |
|
121 | + protected function _set_valid_shortcodes() |
|
122 | + { |
|
123 | + $this->_valid_shortcodes['purchaser'] = array( |
|
124 | + 'attendee_list', |
|
125 | + 'attendee', |
|
126 | + 'datetime_list', |
|
127 | + 'datetime', |
|
128 | + 'event_list', |
|
129 | + 'event', |
|
130 | + 'event_meta', |
|
131 | + 'messenger', |
|
132 | + 'organization', |
|
133 | + 'primary_registration_list', |
|
134 | + 'primary_registration_details', |
|
135 | + 'ticket_list', |
|
136 | + 'ticket', |
|
137 | + 'transaction', |
|
138 | + 'venue', |
|
139 | + 'line_item_list', |
|
140 | + 'payment_list', |
|
141 | + 'line_item', |
|
142 | + 'payment' |
|
143 | + ); |
|
144 | + } |
|
145 | + |
|
146 | 146 | |
147 | 147 | |
148 | 148 | |
149 | - protected function _purchaser_addressees() |
|
150 | - { |
|
151 | - return parent::_primary_attendee_addressees(); |
|
152 | - } |
|
149 | + protected function _purchaser_addressees() |
|
150 | + { |
|
151 | + return parent::_primary_attendee_addressees(); |
|
152 | + } |
|
153 | 153 | } |
@@ -62,7 +62,7 @@ |
||
62 | 62 | */ |
63 | 63 | protected function _get_subject($custom_subject = '') |
64 | 64 | { |
65 | - if (! empty($custom_subject)) { |
|
65 | + if ( ! empty($custom_subject)) { |
|
66 | 66 | return $custom_subject; |
67 | 67 | } |
68 | 68 | $this->queue->get_message_repository()->rewind(); |
@@ -12,90 +12,90 @@ |
||
12 | 12 | */ |
13 | 13 | class EE_Message_To_Generate_From_Queue extends EE_Message_To_Generate |
14 | 14 | { |
15 | - /** |
|
16 | - * Will hold an EE_Messages_Queue object |
|
17 | - * @type EE_Messages_Queue |
|
18 | - */ |
|
19 | - public $queue = array(); |
|
15 | + /** |
|
16 | + * Will hold an EE_Messages_Queue object |
|
17 | + * @type EE_Messages_Queue |
|
18 | + */ |
|
19 | + public $queue = array(); |
|
20 | 20 | |
21 | - /** |
|
22 | - * @param string $messenger_name The messenger being used to send the message |
|
23 | - * @param string $message_type_name The message type being used to grab variations etc. |
|
24 | - * @param EE_Messages_Queue $queue |
|
25 | - * @param string $custom_subject Used if a custom subject is desired for the generated aggregate EE_Message object |
|
26 | - */ |
|
27 | - public function __construct($messenger_name, $message_type_name, EE_Messages_Queue $queue, $custom_subject = '') |
|
28 | - { |
|
29 | - $this->queue = $queue; |
|
30 | - parent::__construct($messenger_name, $message_type_name, array(), '', false, EEM_Message::status_idle); |
|
31 | - if ($this->valid()) { |
|
32 | - $this->_message->set_content($this->_get_content()); |
|
33 | - $this->_message->set_subject($this->_get_subject($custom_subject)); |
|
34 | - $this->_message->set_GRP_ID($this->getGroupIdFromMessageRepo()); |
|
35 | - } |
|
36 | - } |
|
21 | + /** |
|
22 | + * @param string $messenger_name The messenger being used to send the message |
|
23 | + * @param string $message_type_name The message type being used to grab variations etc. |
|
24 | + * @param EE_Messages_Queue $queue |
|
25 | + * @param string $custom_subject Used if a custom subject is desired for the generated aggregate EE_Message object |
|
26 | + */ |
|
27 | + public function __construct($messenger_name, $message_type_name, EE_Messages_Queue $queue, $custom_subject = '') |
|
28 | + { |
|
29 | + $this->queue = $queue; |
|
30 | + parent::__construct($messenger_name, $message_type_name, array(), '', false, EEM_Message::status_idle); |
|
31 | + if ($this->valid()) { |
|
32 | + $this->_message->set_content($this->_get_content()); |
|
33 | + $this->_message->set_subject($this->_get_subject($custom_subject)); |
|
34 | + $this->_message->set_GRP_ID($this->getGroupIdFromMessageRepo()); |
|
35 | + } |
|
36 | + } |
|
37 | 37 | |
38 | 38 | |
39 | 39 | |
40 | - /** |
|
41 | - * Uses the EE_Messages_Queue currently set on this object to generate the content |
|
42 | - * for the single EE_Message aggregate object returned by get_EE_Message |
|
43 | - * @return string; |
|
44 | - */ |
|
45 | - protected function _get_content() |
|
46 | - { |
|
47 | - $content = ''; |
|
48 | - $this->queue->get_message_repository()->rewind(); |
|
49 | - while ($this->queue->get_message_repository()->valid()) { |
|
50 | - $content .= $this->queue->get_message_repository()->current()->content(); |
|
51 | - $this->queue->get_message_repository()->next(); |
|
52 | - } |
|
53 | - return $content; |
|
54 | - } |
|
40 | + /** |
|
41 | + * Uses the EE_Messages_Queue currently set on this object to generate the content |
|
42 | + * for the single EE_Message aggregate object returned by get_EE_Message |
|
43 | + * @return string; |
|
44 | + */ |
|
45 | + protected function _get_content() |
|
46 | + { |
|
47 | + $content = ''; |
|
48 | + $this->queue->get_message_repository()->rewind(); |
|
49 | + while ($this->queue->get_message_repository()->valid()) { |
|
50 | + $content .= $this->queue->get_message_repository()->current()->content(); |
|
51 | + $this->queue->get_message_repository()->next(); |
|
52 | + } |
|
53 | + return $content; |
|
54 | + } |
|
55 | 55 | |
56 | 56 | |
57 | - /** |
|
58 | - * Return a subject string to use for `MSG_Subject` in the aggregate EE_Message object. |
|
59 | - * @param string $custom_subject |
|
60 | - * |
|
61 | - * @return string |
|
62 | - */ |
|
63 | - protected function _get_subject($custom_subject = '') |
|
64 | - { |
|
65 | - if (! empty($custom_subject)) { |
|
66 | - return $custom_subject; |
|
67 | - } |
|
68 | - $this->queue->get_message_repository()->rewind(); |
|
69 | - $count_of_items = $this->queue->get_message_repository()->count(); |
|
57 | + /** |
|
58 | + * Return a subject string to use for `MSG_Subject` in the aggregate EE_Message object. |
|
59 | + * @param string $custom_subject |
|
60 | + * |
|
61 | + * @return string |
|
62 | + */ |
|
63 | + protected function _get_subject($custom_subject = '') |
|
64 | + { |
|
65 | + if (! empty($custom_subject)) { |
|
66 | + return $custom_subject; |
|
67 | + } |
|
68 | + $this->queue->get_message_repository()->rewind(); |
|
69 | + $count_of_items = $this->queue->get_message_repository()->count(); |
|
70 | 70 | |
71 | - // if $count of items in queue == 1, then let's just return the subject for that item. |
|
72 | - if ($count_of_items === 1) { |
|
73 | - return $this->queue->get_message_repository()->current()->subject(); |
|
74 | - } |
|
75 | - // phpcs:disable WordPress.WP.I18n.MissingSingularPlaceholder |
|
76 | - return sprintf( |
|
77 | - _n( |
|
78 | - 'Showing Aggregate output for 1 result', |
|
79 | - 'Showing Aggregate output for %d items', |
|
80 | - $count_of_items, |
|
81 | - 'event_espresso' |
|
82 | - ), |
|
83 | - $count_of_items |
|
84 | - ); |
|
85 | - // phpcs:enable |
|
86 | - } |
|
71 | + // if $count of items in queue == 1, then let's just return the subject for that item. |
|
72 | + if ($count_of_items === 1) { |
|
73 | + return $this->queue->get_message_repository()->current()->subject(); |
|
74 | + } |
|
75 | + // phpcs:disable WordPress.WP.I18n.MissingSingularPlaceholder |
|
76 | + return sprintf( |
|
77 | + _n( |
|
78 | + 'Showing Aggregate output for 1 result', |
|
79 | + 'Showing Aggregate output for %d items', |
|
80 | + $count_of_items, |
|
81 | + 'event_espresso' |
|
82 | + ), |
|
83 | + $count_of_items |
|
84 | + ); |
|
85 | + // phpcs:enable |
|
86 | + } |
|
87 | 87 | |
88 | 88 | |
89 | - /** |
|
90 | - * Uses the EE_Messages_Queue currently set on this object to set the GRP_ID |
|
91 | - * for the single EE_Message aggregate object returned by get_EE_Message |
|
92 | - * @return int; |
|
93 | - */ |
|
94 | - protected function getGroupIdFromMessageRepo() |
|
95 | - { |
|
96 | - $this->queue->get_message_repository()->rewind(); |
|
97 | - if ($this->queue->get_message_repository()->valid()) { |
|
98 | - return $this->queue->get_message_repository()->current()->GRP_ID(); |
|
99 | - } |
|
100 | - } |
|
89 | + /** |
|
90 | + * Uses the EE_Messages_Queue currently set on this object to set the GRP_ID |
|
91 | + * for the single EE_Message aggregate object returned by get_EE_Message |
|
92 | + * @return int; |
|
93 | + */ |
|
94 | + protected function getGroupIdFromMessageRepo() |
|
95 | + { |
|
96 | + $this->queue->get_message_repository()->rewind(); |
|
97 | + if ($this->queue->get_message_repository()->valid()) { |
|
98 | + return $this->queue->get_message_repository()->current()->GRP_ID(); |
|
99 | + } |
|
100 | + } |
|
101 | 101 | } |
@@ -42,7 +42,7 @@ discard block |
||
42 | 42 | protected function _parser($shortcode) |
43 | 43 | { |
44 | 44 | // ensure that the incoming object IS a line item. If it isn't then bail early. |
45 | - if (! $this->_data instanceof EE_Line_Item) { |
|
45 | + if ( ! $this->_data instanceof EE_Line_Item) { |
|
46 | 46 | return ''; |
47 | 47 | } |
48 | 48 | |
@@ -62,7 +62,7 @@ discard block |
||
62 | 62 | break; |
63 | 63 | |
64 | 64 | case '[LINE_ITEM_AMOUNT]': |
65 | - return $line_item->is_percent() ? $line_item->percent() . '%' : $line_item->unit_price_no_code(); |
|
65 | + return $line_item->is_percent() ? $line_item->percent().'%' : $line_item->unit_price_no_code(); |
|
66 | 66 | break; |
67 | 67 | |
68 | 68 | case '[LINE_ITEM_TOTAL]': |
@@ -16,65 +16,65 @@ |
||
16 | 16 | */ |
17 | 17 | class EE_Line_Item_Shortcodes extends EE_Shortcodes |
18 | 18 | { |
19 | - protected function _init_props() |
|
20 | - { |
|
21 | - $this->label = esc_html__('Line Item Shortcodes', 'event_espresso'); |
|
22 | - $this->description = esc_html__('All shortcodes specific to line items', 'event_espresso'); |
|
23 | - $this->_shortcodes = array( |
|
24 | - '[LINE_ITEM_NAME]' => esc_html__('Outputs the line item name.', 'event_espresso'), |
|
25 | - '[LINE_ITEM_DESCRIPTION]' => esc_html__('Outputs a the description for the line item.', 'event_espresso'), |
|
26 | - '[LINE_ITEM_QUANTITY]' => esc_html__('Outputs the quantity for this line item.', 'event_espresso'), |
|
27 | - '[LINE_ITEM_AMOUNT]' => esc_html__( |
|
28 | - 'This will either output the unit price for a line item if its not a percent, or the percent of the line item (if it is percent).', |
|
29 | - 'event_espresso' |
|
30 | - ), |
|
31 | - '[LINE_ITEM_TOTAL]' => esc_html__('This outputs the line item total.', 'event_espresso'), |
|
32 | - '[LINE_ITEM_TAXABLE_*]' => esc_html__( |
|
33 | - 'This attribute type shortcode allows users to indicate what to output if a line item is taxable or not. One can use the key "symbol=" with the shortcode to indicate what they\'d like to represent a taxable line item. So doing something like <code>[LINE_ITEM_TAXABLE_* symbol="*"]</code> means that when the line item is parsed, if it\'s taxable the "*" symbol will be returned. The default symbol if no attribute is included is the "*" symbol.', |
|
34 | - 'event_espresso' |
|
35 | - ), |
|
36 | - ); |
|
37 | - } |
|
19 | + protected function _init_props() |
|
20 | + { |
|
21 | + $this->label = esc_html__('Line Item Shortcodes', 'event_espresso'); |
|
22 | + $this->description = esc_html__('All shortcodes specific to line items', 'event_espresso'); |
|
23 | + $this->_shortcodes = array( |
|
24 | + '[LINE_ITEM_NAME]' => esc_html__('Outputs the line item name.', 'event_espresso'), |
|
25 | + '[LINE_ITEM_DESCRIPTION]' => esc_html__('Outputs a the description for the line item.', 'event_espresso'), |
|
26 | + '[LINE_ITEM_QUANTITY]' => esc_html__('Outputs the quantity for this line item.', 'event_espresso'), |
|
27 | + '[LINE_ITEM_AMOUNT]' => esc_html__( |
|
28 | + 'This will either output the unit price for a line item if its not a percent, or the percent of the line item (if it is percent).', |
|
29 | + 'event_espresso' |
|
30 | + ), |
|
31 | + '[LINE_ITEM_TOTAL]' => esc_html__('This outputs the line item total.', 'event_espresso'), |
|
32 | + '[LINE_ITEM_TAXABLE_*]' => esc_html__( |
|
33 | + 'This attribute type shortcode allows users to indicate what to output if a line item is taxable or not. One can use the key "symbol=" with the shortcode to indicate what they\'d like to represent a taxable line item. So doing something like <code>[LINE_ITEM_TAXABLE_* symbol="*"]</code> means that when the line item is parsed, if it\'s taxable the "*" symbol will be returned. The default symbol if no attribute is included is the "*" symbol.', |
|
34 | + 'event_espresso' |
|
35 | + ), |
|
36 | + ); |
|
37 | + } |
|
38 | 38 | |
39 | 39 | |
40 | - protected function _parser($shortcode) |
|
41 | - { |
|
42 | - // ensure that the incoming object IS a line item. If it isn't then bail early. |
|
43 | - if (! $this->_data instanceof EE_Line_Item) { |
|
44 | - return ''; |
|
45 | - } |
|
40 | + protected function _parser($shortcode) |
|
41 | + { |
|
42 | + // ensure that the incoming object IS a line item. If it isn't then bail early. |
|
43 | + if (! $this->_data instanceof EE_Line_Item) { |
|
44 | + return ''; |
|
45 | + } |
|
46 | 46 | |
47 | - $line_item = $this->_data; |
|
47 | + $line_item = $this->_data; |
|
48 | 48 | |
49 | - switch ($shortcode) { |
|
50 | - case '[LINE_ITEM_NAME]': |
|
51 | - return $line_item->name(); |
|
52 | - break; |
|
49 | + switch ($shortcode) { |
|
50 | + case '[LINE_ITEM_NAME]': |
|
51 | + return $line_item->name(); |
|
52 | + break; |
|
53 | 53 | |
54 | - case '[LINE_ITEM_DESCRIPTION]': |
|
55 | - return $line_item->desc(); |
|
56 | - break; |
|
54 | + case '[LINE_ITEM_DESCRIPTION]': |
|
55 | + return $line_item->desc(); |
|
56 | + break; |
|
57 | 57 | |
58 | - case '[LINE_ITEM_QUANTITY]': |
|
59 | - return $line_item->quantity(); |
|
60 | - break; |
|
58 | + case '[LINE_ITEM_QUANTITY]': |
|
59 | + return $line_item->quantity(); |
|
60 | + break; |
|
61 | 61 | |
62 | - case '[LINE_ITEM_AMOUNT]': |
|
63 | - return $line_item->is_percent() ? $line_item->percent() . '%' : $line_item->unit_price_no_code(); |
|
64 | - break; |
|
62 | + case '[LINE_ITEM_AMOUNT]': |
|
63 | + return $line_item->is_percent() ? $line_item->percent() . '%' : $line_item->unit_price_no_code(); |
|
64 | + break; |
|
65 | 65 | |
66 | - case '[LINE_ITEM_TOTAL]': |
|
67 | - return $line_item->total_no_code(); |
|
68 | - break; |
|
69 | - } |
|
66 | + case '[LINE_ITEM_TOTAL]': |
|
67 | + return $line_item->total_no_code(); |
|
68 | + break; |
|
69 | + } |
|
70 | 70 | |
71 | - if (strpos($shortcode, '[LINE_ITEM_TAXABLE_*') !== false) { |
|
72 | - $attrs = $this->_get_shortcode_attrs($shortcode); |
|
73 | - if ($line_item->is_taxable()) { |
|
74 | - return ! empty($attrs['symbol']) ? $attrs['symbol'] : '*'; |
|
75 | - } |
|
76 | - } |
|
71 | + if (strpos($shortcode, '[LINE_ITEM_TAXABLE_*') !== false) { |
|
72 | + $attrs = $this->_get_shortcode_attrs($shortcode); |
|
73 | + if ($line_item->is_taxable()) { |
|
74 | + return ! empty($attrs['symbol']) ? $attrs['symbol'] : '*'; |
|
75 | + } |
|
76 | + } |
|
77 | 77 | |
78 | - return ''; |
|
79 | - } |
|
78 | + return ''; |
|
79 | + } |
|
80 | 80 | } |
@@ -54,7 +54,7 @@ discard block |
||
54 | 54 | protected function _parser($shortcode) |
55 | 55 | { |
56 | 56 | |
57 | - if (! $this->_data instanceof EE_Datetime) { |
|
57 | + if ( ! $this->_data instanceof EE_Datetime) { |
|
58 | 58 | return ''; // get out cause we can only parse with the datetime object. |
59 | 59 | } |
60 | 60 | |
@@ -92,7 +92,7 @@ discard block |
||
92 | 92 | |
93 | 93 | $URL = add_query_arg(array('ee' => 'download_ics_file', 'ics_id' => $this->_data->ID()), site_url()); |
94 | 94 | |
95 | - return '<a class="ee-ical" href="' . $URL . '">' . $link_text . '</a>'; |
|
95 | + return '<a class="ee-ical" href="'.$URL.'">'.$link_text.'</a>'; |
|
96 | 96 | } |
97 | 97 | |
98 | 98 | return ''; |
@@ -15,77 +15,77 @@ |
||
15 | 15 | */ |
16 | 16 | class EE_Datetime_Shortcodes extends EE_Shortcodes |
17 | 17 | { |
18 | - /** |
|
19 | - * @return void |
|
20 | - */ |
|
21 | - protected function _init_props() |
|
22 | - { |
|
23 | - $this->label = esc_html__('Datetime Shortcodes', 'event_espresso'); |
|
24 | - $this->description = esc_html__('All shortcodes specific to datetime related data', 'event_espresso'); |
|
25 | - $this->_shortcodes = array( |
|
26 | - '[DATETIME_START]' => esc_html__('The start date and time.', 'event_espresso'), |
|
27 | - '[DATETIME_END]' => esc_html__('The end date and time.', 'event_espresso'), |
|
28 | - '[DATETIME_TIMEZONE]' => esc_html__('The timezone for the date and time', 'event_espresso'), |
|
29 | - '[DATE_START]' => esc_html__('The datetime start date.', 'event_espresso'), |
|
30 | - '[DATE_END]' => esc_html__('The datetime end date.', 'event_espresso'), |
|
31 | - '[TIME_START]' => esc_html__('The datetime start time.', 'event_espresso'), |
|
32 | - '[TIME_END]' => esc_html__('The datetime end time.', 'event_espresso'), |
|
33 | - '[ICAL_LINK_*]' => esc_html__( |
|
34 | - 'The datetime iCal link. The optional "link_text" attribute can be used to set custom text within the link (Default is "Add to iCal Calendar").', |
|
35 | - 'event_espresso' |
|
36 | - ), |
|
37 | - ); |
|
38 | - } |
|
39 | - |
|
40 | - |
|
41 | - /** |
|
42 | - * @param string $shortcode |
|
43 | - * @return string |
|
44 | - * @throws EE_Error |
|
45 | - * @throws ReflectionException |
|
46 | - */ |
|
47 | - protected function _parser($shortcode) |
|
48 | - { |
|
49 | - |
|
50 | - if (! $this->_data instanceof EE_Datetime) { |
|
51 | - return ''; // get out cause we can only parse with the datetime object. |
|
52 | - } |
|
53 | - |
|
54 | - switch ($shortcode) { |
|
55 | - case '[DATETIME_START]': |
|
56 | - return $this->_data->get_i18n_datetime('DTT_EVT_start'); |
|
57 | - |
|
58 | - case '[DATETIME_END]': |
|
59 | - return $this->_data->get_i18n_datetime('DTT_EVT_end'); |
|
60 | - |
|
61 | - case '[DATETIME_TIMEZONE]': |
|
62 | - return $this->_data->get_timezone(); |
|
63 | - |
|
64 | - case '[DATE_START]': |
|
65 | - return $this->_data->get_i18n_datetime('DTT_EVT_start', get_option('date_format')); |
|
66 | - |
|
67 | - case '[DATE_END]': |
|
68 | - return $this->_data->get_i18n_datetime('DTT_EVT_end', get_option('date_format')); |
|
69 | - |
|
70 | - case '[TIME_START]': |
|
71 | - return $this->_data->get_i18n_datetime('DTT_EVT_start', get_option('time_format')); |
|
72 | - |
|
73 | - case '[TIME_END]': |
|
74 | - return $this->_data->get_i18n_datetime('DTT_EVT_end', get_option('time_format')); |
|
75 | - |
|
76 | - } |
|
77 | - |
|
78 | - if (strpos($shortcode, '[ICAL_LINK_*') !== false) { |
|
79 | - $attrs = $this->_get_shortcode_attrs($shortcode); |
|
80 | - |
|
81 | - $link_text = empty($attrs['link_text']) ? esc_html__('Add to iCal Calendar', 'event_espresso') |
|
82 | - : $attrs['link_text']; |
|
83 | - |
|
84 | - $URL = add_query_arg(array('ee' => 'download_ics_file', 'ics_id' => $this->_data->ID()), site_url()); |
|
85 | - |
|
86 | - return '<a class="ee-ical" href="' . $URL . '">' . $link_text . '</a>'; |
|
87 | - } |
|
88 | - |
|
89 | - return ''; |
|
90 | - } |
|
18 | + /** |
|
19 | + * @return void |
|
20 | + */ |
|
21 | + protected function _init_props() |
|
22 | + { |
|
23 | + $this->label = esc_html__('Datetime Shortcodes', 'event_espresso'); |
|
24 | + $this->description = esc_html__('All shortcodes specific to datetime related data', 'event_espresso'); |
|
25 | + $this->_shortcodes = array( |
|
26 | + '[DATETIME_START]' => esc_html__('The start date and time.', 'event_espresso'), |
|
27 | + '[DATETIME_END]' => esc_html__('The end date and time.', 'event_espresso'), |
|
28 | + '[DATETIME_TIMEZONE]' => esc_html__('The timezone for the date and time', 'event_espresso'), |
|
29 | + '[DATE_START]' => esc_html__('The datetime start date.', 'event_espresso'), |
|
30 | + '[DATE_END]' => esc_html__('The datetime end date.', 'event_espresso'), |
|
31 | + '[TIME_START]' => esc_html__('The datetime start time.', 'event_espresso'), |
|
32 | + '[TIME_END]' => esc_html__('The datetime end time.', 'event_espresso'), |
|
33 | + '[ICAL_LINK_*]' => esc_html__( |
|
34 | + 'The datetime iCal link. The optional "link_text" attribute can be used to set custom text within the link (Default is "Add to iCal Calendar").', |
|
35 | + 'event_espresso' |
|
36 | + ), |
|
37 | + ); |
|
38 | + } |
|
39 | + |
|
40 | + |
|
41 | + /** |
|
42 | + * @param string $shortcode |
|
43 | + * @return string |
|
44 | + * @throws EE_Error |
|
45 | + * @throws ReflectionException |
|
46 | + */ |
|
47 | + protected function _parser($shortcode) |
|
48 | + { |
|
49 | + |
|
50 | + if (! $this->_data instanceof EE_Datetime) { |
|
51 | + return ''; // get out cause we can only parse with the datetime object. |
|
52 | + } |
|
53 | + |
|
54 | + switch ($shortcode) { |
|
55 | + case '[DATETIME_START]': |
|
56 | + return $this->_data->get_i18n_datetime('DTT_EVT_start'); |
|
57 | + |
|
58 | + case '[DATETIME_END]': |
|
59 | + return $this->_data->get_i18n_datetime('DTT_EVT_end'); |
|
60 | + |
|
61 | + case '[DATETIME_TIMEZONE]': |
|
62 | + return $this->_data->get_timezone(); |
|
63 | + |
|
64 | + case '[DATE_START]': |
|
65 | + return $this->_data->get_i18n_datetime('DTT_EVT_start', get_option('date_format')); |
|
66 | + |
|
67 | + case '[DATE_END]': |
|
68 | + return $this->_data->get_i18n_datetime('DTT_EVT_end', get_option('date_format')); |
|
69 | + |
|
70 | + case '[TIME_START]': |
|
71 | + return $this->_data->get_i18n_datetime('DTT_EVT_start', get_option('time_format')); |
|
72 | + |
|
73 | + case '[TIME_END]': |
|
74 | + return $this->_data->get_i18n_datetime('DTT_EVT_end', get_option('time_format')); |
|
75 | + |
|
76 | + } |
|
77 | + |
|
78 | + if (strpos($shortcode, '[ICAL_LINK_*') !== false) { |
|
79 | + $attrs = $this->_get_shortcode_attrs($shortcode); |
|
80 | + |
|
81 | + $link_text = empty($attrs['link_text']) ? esc_html__('Add to iCal Calendar', 'event_espresso') |
|
82 | + : $attrs['link_text']; |
|
83 | + |
|
84 | + $URL = add_query_arg(array('ee' => 'download_ics_file', 'ics_id' => $this->_data->ID()), site_url()); |
|
85 | + |
|
86 | + return '<a class="ee-ical" href="' . $URL . '">' . $link_text . '</a>'; |
|
87 | + } |
|
88 | + |
|
89 | + return ''; |
|
90 | + } |
|
91 | 91 | } |