@@ -15,31 +15,31 @@ |
||
| 15 | 15 | { |
| 16 | 16 | |
| 17 | 17 | |
| 18 | - public function __construct($fields, $context) |
|
| 19 | - { |
|
| 20 | - $this->_m_name = 'email'; |
|
| 21 | - $this->_mt_name = 'registration'; |
|
| 18 | + public function __construct($fields, $context) |
|
| 19 | + { |
|
| 20 | + $this->_m_name = 'email'; |
|
| 21 | + $this->_mt_name = 'registration'; |
|
| 22 | 22 | |
| 23 | - parent::__construct($fields, $context); |
|
| 24 | - } |
|
| 23 | + parent::__construct($fields, $context); |
|
| 24 | + } |
|
| 25 | 25 | |
| 26 | - /** |
|
| 27 | - * custom validator (restricting what was originally set by the messenger) |
|
| 28 | - */ |
|
| 29 | - protected function _modify_validator() |
|
| 30 | - { |
|
| 31 | - $new_config = $this->_messenger->get_validator_config(); |
|
| 32 | - // modify just event_list |
|
| 33 | - $new_config['event_list'] = array( |
|
| 34 | - 'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list'), |
|
| 35 | - 'required' => array('[EVENT_LIST]') |
|
| 36 | - ); |
|
| 37 | - $this->_messenger->set_validator_config($new_config); |
|
| 26 | + /** |
|
| 27 | + * custom validator (restricting what was originally set by the messenger) |
|
| 28 | + */ |
|
| 29 | + protected function _modify_validator() |
|
| 30 | + { |
|
| 31 | + $new_config = $this->_messenger->get_validator_config(); |
|
| 32 | + // modify just event_list |
|
| 33 | + $new_config['event_list'] = array( |
|
| 34 | + 'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list'), |
|
| 35 | + 'required' => array('[EVENT_LIST]') |
|
| 36 | + ); |
|
| 37 | + $this->_messenger->set_validator_config($new_config); |
|
| 38 | 38 | |
| 39 | - if ($this->_context != 'admin') { |
|
| 40 | - $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 | - } |
|
| 39 | + if ($this->_context != 'admin') { |
|
| 40 | + $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 | + } |
|
| 42 | 42 | |
| 43 | - $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]'); |
|
| 44 | - } |
|
| 43 | + $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]'); |
|
| 44 | + } |
|
| 45 | 45 | } |
@@ -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]'); |
@@ -15,30 +15,30 @@ |
||
| 15 | 15 | { |
| 16 | 16 | |
| 17 | 17 | |
| 18 | - public function __construct($fields, $context) |
|
| 19 | - { |
|
| 20 | - $this->_m_name = 'email'; |
|
| 21 | - $this->_mt_name = 'not_approved_registration'; |
|
| 18 | + public function __construct($fields, $context) |
|
| 19 | + { |
|
| 20 | + $this->_m_name = 'email'; |
|
| 21 | + $this->_mt_name = 'not_approved_registration'; |
|
| 22 | 22 | |
| 23 | - parent::__construct($fields, $context); |
|
| 24 | - } |
|
| 23 | + parent::__construct($fields, $context); |
|
| 24 | + } |
|
| 25 | 25 | |
| 26 | - /** |
|
| 27 | - * custom validator (restricting what was originally set by the messenger) |
|
| 28 | - */ |
|
| 29 | - protected function _modify_validator() |
|
| 30 | - { |
|
| 31 | - $new_config = $this->_messenger->get_validator_config(); |
|
| 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); |
|
| 26 | + /** |
|
| 27 | + * custom validator (restricting what was originally set by the messenger) |
|
| 28 | + */ |
|
| 29 | + protected function _modify_validator() |
|
| 30 | + { |
|
| 31 | + $new_config = $this->_messenger->get_validator_config(); |
|
| 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 | } |
@@ -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]'); |
@@ -15,31 +15,31 @@ |
||
| 15 | 15 | { |
| 16 | 16 | |
| 17 | 17 | |
| 18 | - public function __construct($fields, $context) |
|
| 19 | - { |
|
| 20 | - $this->_m_name = 'email'; |
|
| 21 | - $this->_mt_name = 'pending_approval'; |
|
| 18 | + public function __construct($fields, $context) |
|
| 19 | + { |
|
| 20 | + $this->_m_name = 'email'; |
|
| 21 | + $this->_mt_name = 'pending_approval'; |
|
| 22 | 22 | |
| 23 | - parent::__construct($fields, $context); |
|
| 24 | - } |
|
| 23 | + parent::__construct($fields, $context); |
|
| 24 | + } |
|
| 25 | 25 | |
| 26 | - /** |
|
| 27 | - * custom validator (restricting what was originally set by the messenger) |
|
| 28 | - */ |
|
| 29 | - protected function _modify_validator() |
|
| 30 | - { |
|
| 31 | - $new_config = $this->_messenger->get_validator_config(); |
|
| 32 | - // modify just event_list |
|
| 33 | - $new_config['event_list'] = array( |
|
| 34 | - 'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list'), |
|
| 35 | - 'required' => array('[EVENT_LIST]') |
|
| 36 | - ); |
|
| 37 | - $this->_messenger->set_validator_config($new_config); |
|
| 26 | + /** |
|
| 27 | + * custom validator (restricting what was originally set by the messenger) |
|
| 28 | + */ |
|
| 29 | + protected function _modify_validator() |
|
| 30 | + { |
|
| 31 | + $new_config = $this->_messenger->get_validator_config(); |
|
| 32 | + // modify just event_list |
|
| 33 | + $new_config['event_list'] = array( |
|
| 34 | + 'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'datetime_list', 'venue', 'organization', 'event_author', 'primary_registration_details', 'primary_registration_list', 'recipient_details', 'recipient_list'), |
|
| 35 | + 'required' => array('[EVENT_LIST]') |
|
| 36 | + ); |
|
| 37 | + $this->_messenger->set_validator_config($new_config); |
|
| 38 | 38 | |
| 39 | - if ($this->_context != 'admin') { |
|
| 40 | - $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 | - } |
|
| 39 | + if ($this->_context != 'admin') { |
|
| 40 | + $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 | + } |
|
| 42 | 42 | |
| 43 | - $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]'); |
|
| 44 | - } |
|
| 43 | + $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]'); |
|
| 44 | + } |
|
| 45 | 45 | } |
@@ -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]'); |
@@ -15,37 +15,37 @@ |
||
| 15 | 15 | { |
| 16 | 16 | |
| 17 | 17 | |
| 18 | - public function __construct($fields, $context) |
|
| 19 | - { |
|
| 20 | - $this->_m_name = 'email'; |
|
| 21 | - $this->_mt_name = 'payment'; |
|
| 22 | - |
|
| 23 | - parent::__construct($fields, $context); |
|
| 24 | - } |
|
| 25 | - |
|
| 26 | - /** |
|
| 27 | - * at this point no custom validation needed for this messenger/message_type combo. |
|
| 28 | - */ |
|
| 29 | - protected function _modify_validator() |
|
| 30 | - { |
|
| 31 | - $new_config = $this->_messenger->get_validator_config(); |
|
| 32 | - |
|
| 33 | - // modify just event_list |
|
| 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') |
|
| 36 | - ); |
|
| 37 | - $new_config['ticket_list'] = array( |
|
| 38 | - 'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list', 'recipient_details', 'transaction') |
|
| 39 | - ); |
|
| 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') |
|
| 42 | - ); |
|
| 43 | - $this->_messenger->set_validator_config($new_config); |
|
| 44 | - |
|
| 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'); |
|
| 47 | - } |
|
| 48 | - |
|
| 49 | - $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]'); |
|
| 50 | - } |
|
| 18 | + public function __construct($fields, $context) |
|
| 19 | + { |
|
| 20 | + $this->_m_name = 'email'; |
|
| 21 | + $this->_mt_name = 'payment'; |
|
| 22 | + |
|
| 23 | + parent::__construct($fields, $context); |
|
| 24 | + } |
|
| 25 | + |
|
| 26 | + /** |
|
| 27 | + * at this point no custom validation needed for this messenger/message_type combo. |
|
| 28 | + */ |
|
| 29 | + protected function _modify_validator() |
|
| 30 | + { |
|
| 31 | + $new_config = $this->_messenger->get_validator_config(); |
|
| 32 | + |
|
| 33 | + // modify just event_list |
|
| 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') |
|
| 36 | + ); |
|
| 37 | + $new_config['ticket_list'] = array( |
|
| 38 | + 'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list', 'recipient_details', 'transaction') |
|
| 39 | + ); |
|
| 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') |
|
| 42 | + ); |
|
| 43 | + $this->_messenger->set_validator_config($new_config); |
|
| 44 | + |
|
| 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'); |
|
| 47 | + } |
|
| 48 | + |
|
| 49 | + $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]'); |
|
| 50 | + } |
|
| 51 | 51 | } |
@@ -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]'); |
@@ -16,21 +16,21 @@ |
||
| 16 | 16 | class EE_Messages_Html_Invoice_Validator extends EE_Messages_Validator |
| 17 | 17 | { |
| 18 | 18 | |
| 19 | - public function __construct($fields, $context) |
|
| 20 | - { |
|
| 21 | - $this->_m_name = 'html'; |
|
| 22 | - $this->_mt_name = 'invoice'; |
|
| 19 | + public function __construct($fields, $context) |
|
| 20 | + { |
|
| 21 | + $this->_m_name = 'html'; |
|
| 22 | + $this->_mt_name = 'invoice'; |
|
| 23 | 23 | |
| 24 | - parent::__construct($fields, $context); |
|
| 25 | - } |
|
| 24 | + parent::__construct($fields, $context); |
|
| 25 | + } |
|
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * custom validator (restricting what was originally set by the messenger). |
|
| 29 | - * Note nothing is currently done for this messenger and message type. |
|
| 30 | - */ |
|
| 31 | - protected function _modify_validator() |
|
| 32 | - { |
|
| 33 | - $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_HTML_URL]'); |
|
| 34 | - return; |
|
| 35 | - } |
|
| 27 | + /** |
|
| 28 | + * custom validator (restricting what was originally set by the messenger). |
|
| 29 | + * Note nothing is currently done for this messenger and message type. |
|
| 30 | + */ |
|
| 31 | + protected function _modify_validator() |
|
| 32 | + { |
|
| 33 | + $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_HTML_URL]'); |
|
| 34 | + return; |
|
| 35 | + } |
|
| 36 | 36 | } |
@@ -16,21 +16,21 @@ |
||
| 16 | 16 | class EE_Messages_Html_Receipt_Validator extends EE_Messages_Validator |
| 17 | 17 | { |
| 18 | 18 | |
| 19 | - public function __construct($fields, $context) |
|
| 20 | - { |
|
| 21 | - $this->_m_name = 'html'; |
|
| 22 | - $this->_mt_name = 'receipt'; |
|
| 19 | + public function __construct($fields, $context) |
|
| 20 | + { |
|
| 21 | + $this->_m_name = 'html'; |
|
| 22 | + $this->_mt_name = 'receipt'; |
|
| 23 | 23 | |
| 24 | - parent::__construct($fields, $context); |
|
| 25 | - } |
|
| 24 | + parent::__construct($fields, $context); |
|
| 25 | + } |
|
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * custom validator (restricting what was originally set by the messenger). |
|
| 29 | - * Note nothing is currently done for this messenger and message type. |
|
| 30 | - */ |
|
| 31 | - protected function _modify_validator() |
|
| 32 | - { |
|
| 33 | - $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_HTML_URL]'); |
|
| 34 | - return; |
|
| 35 | - } |
|
| 27 | + /** |
|
| 28 | + * custom validator (restricting what was originally set by the messenger). |
|
| 29 | + * Note nothing is currently done for this messenger and message type. |
|
| 30 | + */ |
|
| 31 | + protected function _modify_validator() |
|
| 32 | + { |
|
| 33 | + $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_HTML_URL]'); |
|
| 34 | + return; |
|
| 35 | + } |
|
| 36 | 36 | } |
@@ -14,44 +14,44 @@ discard block |
||
| 14 | 14 | abstract class EE_Messages_Base extends EE_Base |
| 15 | 15 | { |
| 16 | 16 | |
| 17 | - /** DETAILS PROPERTIES **/ |
|
| 18 | - /** |
|
| 19 | - * The following are used to hold details on the type for reference (i.e. on admin screens) |
|
| 20 | - * and also used by the EE_message_type object to figure out where to get template data. |
|
| 21 | - */ |
|
| 22 | - public $name; |
|
| 23 | - public $description; |
|
| 24 | - protected $_messages_item_type; // messenger OR message_type? |
|
| 25 | - |
|
| 26 | - |
|
| 27 | - /** |
|
| 28 | - * This is an array describing the ui facing labels |
|
| 29 | - * that will be used whenever the messenger is referenced in the ui |
|
| 30 | - * |
|
| 31 | - * array( |
|
| 32 | - * 'singular' => __('something'), |
|
| 33 | - * 'plural' => __('somethings') |
|
| 34 | - * ) |
|
| 35 | - * |
|
| 36 | - * @var array |
|
| 37 | - */ |
|
| 38 | - public $label; |
|
| 39 | - |
|
| 40 | - |
|
| 41 | - |
|
| 42 | - |
|
| 43 | - /** |
|
| 44 | - * This property when set will hold the slugs of all EE admin pages that we will need to retrieve fields for |
|
| 45 | - * (and used to determine which callback method to call from the child class) |
|
| 46 | - * |
|
| 47 | - * structure should be |
|
| 48 | - * array( |
|
| 49 | - * 'page_action' => true |
|
| 50 | - * ) |
|
| 51 | - * |
|
| 17 | + /** DETAILS PROPERTIES **/ |
|
| 18 | + /** |
|
| 19 | + * The following are used to hold details on the type for reference (i.e. on admin screens) |
|
| 20 | + * and also used by the EE_message_type object to figure out where to get template data. |
|
| 21 | + */ |
|
| 22 | + public $name; |
|
| 23 | + public $description; |
|
| 24 | + protected $_messages_item_type; // messenger OR message_type? |
|
| 25 | + |
|
| 26 | + |
|
| 27 | + /** |
|
| 28 | + * This is an array describing the ui facing labels |
|
| 29 | + * that will be used whenever the messenger is referenced in the ui |
|
| 30 | + * |
|
| 31 | + * array( |
|
| 32 | + * 'singular' => __('something'), |
|
| 33 | + * 'plural' => __('somethings') |
|
| 34 | + * ) |
|
| 35 | + * |
|
| 36 | + * @var array |
|
| 37 | + */ |
|
| 38 | + public $label; |
|
| 39 | + |
|
| 40 | + |
|
| 41 | + |
|
| 42 | + |
|
| 43 | + /** |
|
| 44 | + * This property when set will hold the slugs of all EE admin pages that we will need to retrieve fields for |
|
| 45 | + * (and used to determine which callback method to call from the child class) |
|
| 46 | + * |
|
| 47 | + * structure should be |
|
| 48 | + * array( |
|
| 49 | + * 'page_action' => true |
|
| 50 | + * ) |
|
| 51 | + * |
|
| 52 | 52 | *@var array |
| 53 | - */ |
|
| 54 | - public $admin_registered_pages = array(); |
|
| 53 | + */ |
|
| 54 | + public $admin_registered_pages = array(); |
|
| 55 | 55 | |
| 56 | 56 | |
| 57 | 57 | |
@@ -60,264 +60,264 @@ discard block |
||
| 60 | 60 | |
| 61 | 61 | |
| 62 | 62 | |
| 63 | - /** |
|
| 64 | - * this property holds any specific fields for holding any settings related to a messenger (if any needed) |
|
| 65 | - * @var array |
|
| 66 | - */ |
|
| 67 | - protected $_admin_settings_fields = array(); |
|
| 63 | + /** |
|
| 64 | + * this property holds any specific fields for holding any settings related to a messenger (if any needed) |
|
| 65 | + * @var array |
|
| 66 | + */ |
|
| 67 | + protected $_admin_settings_fields = array(); |
|
| 68 | 68 | |
| 69 | 69 | |
| 70 | 70 | |
| 71 | 71 | |
| 72 | 72 | |
| 73 | - /** |
|
| 74 | - * this property will hold any existing settings that may have been set in the admin. |
|
| 75 | - * @var array |
|
| 76 | - */ |
|
| 77 | - protected $_existing_admin_settings = array(); |
|
| 73 | + /** |
|
| 74 | + * this property will hold any existing settings that may have been set in the admin. |
|
| 75 | + * @var array |
|
| 76 | + */ |
|
| 77 | + protected $_existing_admin_settings = array(); |
|
| 78 | 78 | |
| 79 | 79 | |
| 80 | 80 | |
| 81 | 81 | |
| 82 | 82 | |
| 83 | - /** |
|
| 84 | - * this property will hold an array of valid shortcodes for this message type and messengers. |
|
| 85 | - * #For Message Types: |
|
| 86 | - * This is an array of strings that correspond to defined EE_Shortcode libraries and per context. |
|
| 87 | - * For example: |
|
| 88 | - * array( 'admin' => array('transaction', 'event', 'attendee') ) |
|
| 89 | - * corresponds to 'EE_Transaction_Shortcodes.lib.php, EE_Event_Shortcodes.lib.php, EE_Attendee_Shortcodes.lib.php' |
|
| 90 | - * for the admin context; |
|
| 91 | - * |
|
| 92 | - * |
|
| 93 | - * #For Messengers: |
|
| 94 | - * For example: |
|
| 95 | - * array('subject' => array('transaction', 'event', 'attendee')) |
|
| 96 | - * corresponds to 'EE_Transaction_Shortcodes.lib.php, EE_Event_Shortcodes.lib.php, EE_Attendee_Shortcodes.lib.php' |
|
| 97 | - * for the 'subject' field; |
|
| 98 | - * NOTE: by default, with messengers, if the valid shortcodes for a field is left blank, |
|
| 99 | - * that field will inherit whatever are set as valid shortcodes by message_type. |
|
| 100 | - * This is so messenger can set specific valid codes for fields and leave other |
|
| 101 | - * valid shortcodes up to the message type matched with the messenger. |
|
| 102 | - * |
|
| 103 | - * @access protected |
|
| 104 | - * @var array |
|
| 105 | - */ |
|
| 106 | - protected $_valid_shortcodes = array(); |
|
| 83 | + /** |
|
| 84 | + * this property will hold an array of valid shortcodes for this message type and messengers. |
|
| 85 | + * #For Message Types: |
|
| 86 | + * This is an array of strings that correspond to defined EE_Shortcode libraries and per context. |
|
| 87 | + * For example: |
|
| 88 | + * array( 'admin' => array('transaction', 'event', 'attendee') ) |
|
| 89 | + * corresponds to 'EE_Transaction_Shortcodes.lib.php, EE_Event_Shortcodes.lib.php, EE_Attendee_Shortcodes.lib.php' |
|
| 90 | + * for the admin context; |
|
| 91 | + * |
|
| 92 | + * |
|
| 93 | + * #For Messengers: |
|
| 94 | + * For example: |
|
| 95 | + * array('subject' => array('transaction', 'event', 'attendee')) |
|
| 96 | + * corresponds to 'EE_Transaction_Shortcodes.lib.php, EE_Event_Shortcodes.lib.php, EE_Attendee_Shortcodes.lib.php' |
|
| 97 | + * for the 'subject' field; |
|
| 98 | + * NOTE: by default, with messengers, if the valid shortcodes for a field is left blank, |
|
| 99 | + * that field will inherit whatever are set as valid shortcodes by message_type. |
|
| 100 | + * This is so messenger can set specific valid codes for fields and leave other |
|
| 101 | + * valid shortcodes up to the message type matched with the messenger. |
|
| 102 | + * |
|
| 103 | + * @access protected |
|
| 104 | + * @var array |
|
| 105 | + */ |
|
| 106 | + protected $_valid_shortcodes = array(); |
|
| 107 | 107 | |
| 108 | 108 | |
| 109 | 109 | |
| 110 | 110 | |
| 111 | 111 | |
| 112 | - public function __construct() |
|
| 113 | - { |
|
| 114 | - $this->_set_admin_settings_fields(); |
|
| 115 | - $this->_set_valid_shortcodes(); |
|
| 116 | - $this->_set_admin_pages(); |
|
| 117 | - } |
|
| 112 | + public function __construct() |
|
| 113 | + { |
|
| 114 | + $this->_set_admin_settings_fields(); |
|
| 115 | + $this->_set_valid_shortcodes(); |
|
| 116 | + $this->_set_admin_pages(); |
|
| 117 | + } |
|
| 118 | 118 | |
| 119 | 119 | |
| 120 | 120 | |
| 121 | 121 | |
| 122 | 122 | |
| 123 | - /** |
|
| 124 | - * sets the _admin_settings_fields property which needs to be defined by child classes. |
|
| 125 | - * You will want to set the _admin_settings_fields properties as a multi-dimensional array with the following format |
|
| 126 | - * array( |
|
| 127 | - * {field_name - also used for setting index} => array( |
|
| 128 | - * 'field_type' => {type of field: 'text', 'textarea', 'checkbox'}, |
|
| 129 | - * 'value_type' => {type of value: 'string', 'int', 'array', 'bool'}, |
|
| 130 | - * 'required' => {bool, required or not}, |
|
| 131 | - * 'validation' => {bool, true if we want validation, false if not}, |
|
| 132 | - * 'format' => {%d, or %s}, |
|
| 133 | - * 'label' => {label for the field, make sure it's localized}, |
|
| 134 | - * 'default' => {default value for the setting} |
|
| 135 | - * ), |
|
| 136 | - * ); |
|
| 137 | - * |
|
| 138 | - * @abstract |
|
| 139 | - * @access protected |
|
| 140 | - * @return void |
|
| 141 | - */ |
|
| 142 | - abstract protected function _set_admin_settings_fields(); |
|
| 123 | + /** |
|
| 124 | + * sets the _admin_settings_fields property which needs to be defined by child classes. |
|
| 125 | + * You will want to set the _admin_settings_fields properties as a multi-dimensional array with the following format |
|
| 126 | + * array( |
|
| 127 | + * {field_name - also used for setting index} => array( |
|
| 128 | + * 'field_type' => {type of field: 'text', 'textarea', 'checkbox'}, |
|
| 129 | + * 'value_type' => {type of value: 'string', 'int', 'array', 'bool'}, |
|
| 130 | + * 'required' => {bool, required or not}, |
|
| 131 | + * 'validation' => {bool, true if we want validation, false if not}, |
|
| 132 | + * 'format' => {%d, or %s}, |
|
| 133 | + * 'label' => {label for the field, make sure it's localized}, |
|
| 134 | + * 'default' => {default value for the setting} |
|
| 135 | + * ), |
|
| 136 | + * ); |
|
| 137 | + * |
|
| 138 | + * @abstract |
|
| 139 | + * @access protected |
|
| 140 | + * @return void |
|
| 141 | + */ |
|
| 142 | + abstract protected function _set_admin_settings_fields(); |
|
| 143 | 143 | |
| 144 | 144 | |
| 145 | 145 | |
| 146 | 146 | |
| 147 | 147 | |
| 148 | - /** |
|
| 149 | - * sets any properties on whether a message type or messenger interface shows up on a ee administration page. |
|
| 150 | - * Child classes have to define this method but don't necessarily have to set the flags |
|
| 151 | - * as they will be set to false by default. |
|
| 152 | - * |
|
| 153 | - * Child classes use this method to set the `_admin_registered_page` property. |
|
| 154 | - * That property is to indicate what EE admin pages we have a corresponding callback for in the child class |
|
| 155 | - * so Message Type/messenger fields/content is included on that admin page. |
|
| 156 | - * |
|
| 157 | - * @abstract |
|
| 158 | - * @access protected |
|
| 159 | - * @return void |
|
| 160 | - */ |
|
| 161 | - abstract protected function _set_admin_pages(); |
|
| 148 | + /** |
|
| 149 | + * sets any properties on whether a message type or messenger interface shows up on a ee administration page. |
|
| 150 | + * Child classes have to define this method but don't necessarily have to set the flags |
|
| 151 | + * as they will be set to false by default. |
|
| 152 | + * |
|
| 153 | + * Child classes use this method to set the `_admin_registered_page` property. |
|
| 154 | + * That property is to indicate what EE admin pages we have a corresponding callback for in the child class |
|
| 155 | + * so Message Type/messenger fields/content is included on that admin page. |
|
| 156 | + * |
|
| 157 | + * @abstract |
|
| 158 | + * @access protected |
|
| 159 | + * @return void |
|
| 160 | + */ |
|
| 161 | + abstract protected function _set_admin_pages(); |
|
| 162 | 162 | |
| 163 | 163 | |
| 164 | 164 | |
| 165 | 165 | |
| 166 | 166 | |
| 167 | - /** |
|
| 168 | - * Child classes must declare the $_valid_shortcodes property using this method. |
|
| 169 | - * See comments for $_valid_shortcodes property for details on what it is used for. |
|
| 170 | - * |
|
| 171 | - * @access protected |
|
| 172 | - * @return void |
|
| 173 | - */ |
|
| 174 | - abstract protected function _set_valid_shortcodes(); |
|
| 167 | + /** |
|
| 168 | + * Child classes must declare the $_valid_shortcodes property using this method. |
|
| 169 | + * See comments for $_valid_shortcodes property for details on what it is used for. |
|
| 170 | + * |
|
| 171 | + * @access protected |
|
| 172 | + * @return void |
|
| 173 | + */ |
|
| 174 | + abstract protected function _set_valid_shortcodes(); |
|
| 175 | 175 | |
| 176 | 176 | |
| 177 | 177 | |
| 178 | - /** |
|
| 179 | - * sets the _existing_admin_settings property can be overridden by child classes. |
|
| 180 | - * We do this so we only do database calls if needed. |
|
| 181 | - * |
|
| 182 | - * @access protected |
|
| 183 | - * @param string $messenger |
|
| 184 | - */ |
|
| 185 | - protected function _set_existing_admin_settings($messenger = '') |
|
| 186 | - { |
|
| 187 | - /** @var EE_Message_Resource_Manager $Message_Resource_Manager */ |
|
| 188 | - $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager'); |
|
| 189 | - $active_messengers = $Message_Resource_Manager->get_active_messengers_option(); |
|
| 190 | - $settings_to_use = $active_messengers; |
|
| 191 | - |
|
| 192 | - /** |
|
| 193 | - * This determines what will be used for the getting the settings. |
|
| 194 | - */ |
|
| 195 | - if (! empty($messenger) |
|
| 196 | - && $Message_Resource_Manager->is_message_type_active_for_messenger($messenger, $this->name) |
|
| 197 | - ) { |
|
| 198 | - $settings_to_use = $active_messengers[ $messenger ]['settings'][ $messenger . '-message_types' ]; |
|
| 199 | - } |
|
| 200 | - |
|
| 201 | - $this->_existing_admin_settings = isset($settings_to_use[ $this->name ]['settings']) |
|
| 202 | - ? $settings_to_use[ $this->name ]['settings'] |
|
| 203 | - : null; |
|
| 204 | - } |
|
| 205 | - |
|
| 206 | - |
|
| 207 | - |
|
| 208 | - |
|
| 209 | - |
|
| 210 | - |
|
| 211 | - /** |
|
| 212 | - * get_existing_admin_settings |
|
| 213 | - * (if needed) sets and returns the _existing_admin_settings property. |
|
| 214 | - * |
|
| 215 | - * @access public |
|
| 216 | - * @param string $messenger |
|
| 217 | - * @return array settings |
|
| 218 | - */ |
|
| 219 | - public function get_existing_admin_settings($messenger = '') |
|
| 220 | - { |
|
| 221 | - // if admin_settings property empty lets try setting it. |
|
| 222 | - if (method_exists($this, '_set_existing_admin_settings') && empty($this->_existing_admin_settings)) { |
|
| 223 | - $this->_set_existing_admin_settings($messenger); |
|
| 224 | - } |
|
| 225 | - return property_exists($this, '_existing_admin_settings') |
|
| 226 | - ? $this->_existing_admin_settings |
|
| 227 | - : null; |
|
| 228 | - } |
|
| 229 | - |
|
| 230 | - |
|
| 231 | - |
|
| 232 | - |
|
| 233 | - |
|
| 234 | - |
|
| 235 | - /** |
|
| 236 | - * This returns the array of valid shortcodes for a message type or messenger as set by the child in the $_valid_shortcode property. |
|
| 237 | - * @return array an array of valid shortcodes. |
|
| 238 | - */ |
|
| 239 | - public function get_valid_shortcodes() |
|
| 240 | - { |
|
| 241 | - $valid_shortcodes = apply_filters( |
|
| 242 | - 'FHEE__' . get_class($this) . '__get_valid_shortcodes', |
|
| 243 | - $this->_valid_shortcodes, |
|
| 244 | - $this |
|
| 245 | - ); |
|
| 246 | - // The below filter applies to ALL messengers and message types so use with care! |
|
| 247 | - $valid_shortcodes = apply_filters('FHEE__EE_Messages_Base__get_valid_shortcodes', $valid_shortcodes, $this); |
|
| 248 | - return $valid_shortcodes; |
|
| 249 | - } |
|
| 250 | - |
|
| 251 | - |
|
| 252 | - |
|
| 253 | - |
|
| 254 | - /** |
|
| 255 | - * getter that returns the protected admin_settings_fields property |
|
| 256 | - * |
|
| 257 | - * @access public |
|
| 258 | - * @return array admin settings fields |
|
| 259 | - */ |
|
| 260 | - public function get_admin_settings_fields() |
|
| 261 | - { |
|
| 262 | - return $this->_admin_settings_fields; |
|
| 263 | - } |
|
| 264 | - |
|
| 265 | - |
|
| 266 | - |
|
| 267 | - |
|
| 268 | - |
|
| 269 | - /** |
|
| 270 | - * this public method accepts a page slug (for an EE_admin page) |
|
| 271 | - * and will return the response from the child class callback function |
|
| 272 | - * if that page is registered via the `_admin_registered_page` property set by the child class. |
|
| 273 | - * |
|
| 274 | - * @param string $page the slug of the EE admin page |
|
| 275 | - * @param array $actives an array of active message type (or messenger) objects. |
|
| 276 | - * @param string $action the page action (to allow for more specific handling - i.e. edit vs. add pages) |
|
| 277 | - * @param array $extra This is just an extra argument that can be used |
|
| 278 | - * to pass additional data for setting up page content. |
|
| 279 | - * @access protected |
|
| 280 | - * @return string $content for page. |
|
| 281 | - */ |
|
| 282 | - protected function _get_admin_page_content($page, $action, $extra, $actives) |
|
| 283 | - { |
|
| 284 | - // we can also further refine the context by action (if present). |
|
| 285 | - if (!empty($action)) { |
|
| 286 | - $page = $page . '_' . $action; |
|
| 287 | - } |
|
| 288 | - |
|
| 289 | - if (!isset($this->admin_registered_pages[ $page ])) { |
|
| 290 | - // todo: a place to throw an exception? |
|
| 291 | - // We need to indicate there is no registered page so this function is not being called correctly. |
|
| 292 | - return false; |
|
| 293 | - } |
|
| 294 | - // k made it here so let's call the method |
|
| 295 | - $content = call_user_func_array( |
|
| 296 | - array( $this, '_get_admin_content_' . $page ), |
|
| 297 | - array( $actives, $extra ) |
|
| 298 | - ); |
|
| 299 | - if ($content === false) { |
|
| 300 | - // todo this needs to be an exception once we've got exceptions in place. |
|
| 301 | - return false; |
|
| 302 | - } |
|
| 303 | - return $content; |
|
| 304 | - } |
|
| 305 | - |
|
| 306 | - |
|
| 307 | - /** |
|
| 308 | - * Allows a message type to specifically exclude template fields for the provided messenger. |
|
| 309 | - * Filtered so this can be programmatically altered as well. |
|
| 310 | - * @param string $messenger_name name of messenger |
|
| 311 | - * @return array |
|
| 312 | - */ |
|
| 313 | - public function excludedFieldsForMessenger($messenger_name) |
|
| 314 | - { |
|
| 315 | - return apply_filters( |
|
| 316 | - 'FHEE__EE_Messages_Base__excludedFieldForMessenger', |
|
| 317 | - array(), |
|
| 318 | - $messenger_name, |
|
| 319 | - $this->name, |
|
| 320 | - $this |
|
| 321 | - ); |
|
| 322 | - } |
|
| 178 | + /** |
|
| 179 | + * sets the _existing_admin_settings property can be overridden by child classes. |
|
| 180 | + * We do this so we only do database calls if needed. |
|
| 181 | + * |
|
| 182 | + * @access protected |
|
| 183 | + * @param string $messenger |
|
| 184 | + */ |
|
| 185 | + protected function _set_existing_admin_settings($messenger = '') |
|
| 186 | + { |
|
| 187 | + /** @var EE_Message_Resource_Manager $Message_Resource_Manager */ |
|
| 188 | + $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager'); |
|
| 189 | + $active_messengers = $Message_Resource_Manager->get_active_messengers_option(); |
|
| 190 | + $settings_to_use = $active_messengers; |
|
| 191 | + |
|
| 192 | + /** |
|
| 193 | + * This determines what will be used for the getting the settings. |
|
| 194 | + */ |
|
| 195 | + if (! empty($messenger) |
|
| 196 | + && $Message_Resource_Manager->is_message_type_active_for_messenger($messenger, $this->name) |
|
| 197 | + ) { |
|
| 198 | + $settings_to_use = $active_messengers[ $messenger ]['settings'][ $messenger . '-message_types' ]; |
|
| 199 | + } |
|
| 200 | + |
|
| 201 | + $this->_existing_admin_settings = isset($settings_to_use[ $this->name ]['settings']) |
|
| 202 | + ? $settings_to_use[ $this->name ]['settings'] |
|
| 203 | + : null; |
|
| 204 | + } |
|
| 205 | + |
|
| 206 | + |
|
| 207 | + |
|
| 208 | + |
|
| 209 | + |
|
| 210 | + |
|
| 211 | + /** |
|
| 212 | + * get_existing_admin_settings |
|
| 213 | + * (if needed) sets and returns the _existing_admin_settings property. |
|
| 214 | + * |
|
| 215 | + * @access public |
|
| 216 | + * @param string $messenger |
|
| 217 | + * @return array settings |
|
| 218 | + */ |
|
| 219 | + public function get_existing_admin_settings($messenger = '') |
|
| 220 | + { |
|
| 221 | + // if admin_settings property empty lets try setting it. |
|
| 222 | + if (method_exists($this, '_set_existing_admin_settings') && empty($this->_existing_admin_settings)) { |
|
| 223 | + $this->_set_existing_admin_settings($messenger); |
|
| 224 | + } |
|
| 225 | + return property_exists($this, '_existing_admin_settings') |
|
| 226 | + ? $this->_existing_admin_settings |
|
| 227 | + : null; |
|
| 228 | + } |
|
| 229 | + |
|
| 230 | + |
|
| 231 | + |
|
| 232 | + |
|
| 233 | + |
|
| 234 | + |
|
| 235 | + /** |
|
| 236 | + * This returns the array of valid shortcodes for a message type or messenger as set by the child in the $_valid_shortcode property. |
|
| 237 | + * @return array an array of valid shortcodes. |
|
| 238 | + */ |
|
| 239 | + public function get_valid_shortcodes() |
|
| 240 | + { |
|
| 241 | + $valid_shortcodes = apply_filters( |
|
| 242 | + 'FHEE__' . get_class($this) . '__get_valid_shortcodes', |
|
| 243 | + $this->_valid_shortcodes, |
|
| 244 | + $this |
|
| 245 | + ); |
|
| 246 | + // The below filter applies to ALL messengers and message types so use with care! |
|
| 247 | + $valid_shortcodes = apply_filters('FHEE__EE_Messages_Base__get_valid_shortcodes', $valid_shortcodes, $this); |
|
| 248 | + return $valid_shortcodes; |
|
| 249 | + } |
|
| 250 | + |
|
| 251 | + |
|
| 252 | + |
|
| 253 | + |
|
| 254 | + /** |
|
| 255 | + * getter that returns the protected admin_settings_fields property |
|
| 256 | + * |
|
| 257 | + * @access public |
|
| 258 | + * @return array admin settings fields |
|
| 259 | + */ |
|
| 260 | + public function get_admin_settings_fields() |
|
| 261 | + { |
|
| 262 | + return $this->_admin_settings_fields; |
|
| 263 | + } |
|
| 264 | + |
|
| 265 | + |
|
| 266 | + |
|
| 267 | + |
|
| 268 | + |
|
| 269 | + /** |
|
| 270 | + * this public method accepts a page slug (for an EE_admin page) |
|
| 271 | + * and will return the response from the child class callback function |
|
| 272 | + * if that page is registered via the `_admin_registered_page` property set by the child class. |
|
| 273 | + * |
|
| 274 | + * @param string $page the slug of the EE admin page |
|
| 275 | + * @param array $actives an array of active message type (or messenger) objects. |
|
| 276 | + * @param string $action the page action (to allow for more specific handling - i.e. edit vs. add pages) |
|
| 277 | + * @param array $extra This is just an extra argument that can be used |
|
| 278 | + * to pass additional data for setting up page content. |
|
| 279 | + * @access protected |
|
| 280 | + * @return string $content for page. |
|
| 281 | + */ |
|
| 282 | + protected function _get_admin_page_content($page, $action, $extra, $actives) |
|
| 283 | + { |
|
| 284 | + // we can also further refine the context by action (if present). |
|
| 285 | + if (!empty($action)) { |
|
| 286 | + $page = $page . '_' . $action; |
|
| 287 | + } |
|
| 288 | + |
|
| 289 | + if (!isset($this->admin_registered_pages[ $page ])) { |
|
| 290 | + // todo: a place to throw an exception? |
|
| 291 | + // We need to indicate there is no registered page so this function is not being called correctly. |
|
| 292 | + return false; |
|
| 293 | + } |
|
| 294 | + // k made it here so let's call the method |
|
| 295 | + $content = call_user_func_array( |
|
| 296 | + array( $this, '_get_admin_content_' . $page ), |
|
| 297 | + array( $actives, $extra ) |
|
| 298 | + ); |
|
| 299 | + if ($content === false) { |
|
| 300 | + // todo this needs to be an exception once we've got exceptions in place. |
|
| 301 | + return false; |
|
| 302 | + } |
|
| 303 | + return $content; |
|
| 304 | + } |
|
| 305 | + |
|
| 306 | + |
|
| 307 | + /** |
|
| 308 | + * Allows a message type to specifically exclude template fields for the provided messenger. |
|
| 309 | + * Filtered so this can be programmatically altered as well. |
|
| 310 | + * @param string $messenger_name name of messenger |
|
| 311 | + * @return array |
|
| 312 | + */ |
|
| 313 | + public function excludedFieldsForMessenger($messenger_name) |
|
| 314 | + { |
|
| 315 | + return apply_filters( |
|
| 316 | + 'FHEE__EE_Messages_Base__excludedFieldForMessenger', |
|
| 317 | + array(), |
|
| 318 | + $messenger_name, |
|
| 319 | + $this->name, |
|
| 320 | + $this |
|
| 321 | + ); |
|
| 322 | + } |
|
| 323 | 323 | } |
@@ -192,14 +192,14 @@ discard block |
||
| 192 | 192 | /** |
| 193 | 193 | * This determines what will be used for the getting the settings. |
| 194 | 194 | */ |
| 195 | - if (! empty($messenger) |
|
| 195 | + if ( ! empty($messenger) |
|
| 196 | 196 | && $Message_Resource_Manager->is_message_type_active_for_messenger($messenger, $this->name) |
| 197 | 197 | ) { |
| 198 | - $settings_to_use = $active_messengers[ $messenger ]['settings'][ $messenger . '-message_types' ]; |
|
| 198 | + $settings_to_use = $active_messengers[$messenger]['settings'][$messenger.'-message_types']; |
|
| 199 | 199 | } |
| 200 | 200 | |
| 201 | - $this->_existing_admin_settings = isset($settings_to_use[ $this->name ]['settings']) |
|
| 202 | - ? $settings_to_use[ $this->name ]['settings'] |
|
| 201 | + $this->_existing_admin_settings = isset($settings_to_use[$this->name]['settings']) |
|
| 202 | + ? $settings_to_use[$this->name]['settings'] |
|
| 203 | 203 | : null; |
| 204 | 204 | } |
| 205 | 205 | |
@@ -239,7 +239,7 @@ discard block |
||
| 239 | 239 | public function get_valid_shortcodes() |
| 240 | 240 | { |
| 241 | 241 | $valid_shortcodes = apply_filters( |
| 242 | - 'FHEE__' . get_class($this) . '__get_valid_shortcodes', |
|
| 242 | + 'FHEE__'.get_class($this).'__get_valid_shortcodes', |
|
| 243 | 243 | $this->_valid_shortcodes, |
| 244 | 244 | $this |
| 245 | 245 | ); |
@@ -282,19 +282,19 @@ discard block |
||
| 282 | 282 | protected function _get_admin_page_content($page, $action, $extra, $actives) |
| 283 | 283 | { |
| 284 | 284 | // we can also further refine the context by action (if present). |
| 285 | - if (!empty($action)) { |
|
| 286 | - $page = $page . '_' . $action; |
|
| 285 | + if ( ! empty($action)) { |
|
| 286 | + $page = $page.'_'.$action; |
|
| 287 | 287 | } |
| 288 | 288 | |
| 289 | - if (!isset($this->admin_registered_pages[ $page ])) { |
|
| 289 | + if ( ! isset($this->admin_registered_pages[$page])) { |
|
| 290 | 290 | // todo: a place to throw an exception? |
| 291 | 291 | // We need to indicate there is no registered page so this function is not being called correctly. |
| 292 | 292 | return false; |
| 293 | 293 | } |
| 294 | 294 | // k made it here so let's call the method |
| 295 | 295 | $content = call_user_func_array( |
| 296 | - array( $this, '_get_admin_content_' . $page ), |
|
| 297 | - array( $actives, $extra ) |
|
| 296 | + array($this, '_get_admin_content_'.$page), |
|
| 297 | + array($actives, $extra) |
|
| 298 | 298 | ); |
| 299 | 299 | if ($content === false) { |
| 300 | 300 | // todo this needs to be an exception once we've got exceptions in place. |
@@ -14,183 +14,183 @@ |
||
| 14 | 14 | class EE_Messenger_Collection extends EE_Object_Collection |
| 15 | 15 | { |
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * EE_Messenger_Collection constructor. |
|
| 19 | - */ |
|
| 20 | - public function __construct() |
|
| 21 | - { |
|
| 22 | - $this->interface = 'EE_messenger'; |
|
| 23 | - } |
|
| 24 | - |
|
| 25 | - |
|
| 26 | - |
|
| 27 | - /** |
|
| 28 | - * add |
|
| 29 | - * |
|
| 30 | - * attaches an object to the Collection |
|
| 31 | - * and sets any supplied data associated with the current iterator entry |
|
| 32 | - * by calling EE_Object_Collection::set_info() |
|
| 33 | - * |
|
| 34 | - * @access public |
|
| 35 | - * @param object $object |
|
| 36 | - * @param mixed $info |
|
| 37 | - * @return bool |
|
| 38 | - */ |
|
| 39 | - public function add($object, $info = null) |
|
| 40 | - { |
|
| 41 | - $info = empty($info) && $object instanceof $this->interface ? $object->name : $info; |
|
| 42 | - return parent::add($object, $info); |
|
| 43 | - } |
|
| 44 | - |
|
| 45 | - |
|
| 46 | - |
|
| 47 | - /** |
|
| 48 | - * set_info |
|
| 49 | - * |
|
| 50 | - * Sets the data associated with an object in the Collection |
|
| 51 | - * if no $info is supplied, then the spl_object_hash() is used |
|
| 52 | - * |
|
| 53 | - * @access public |
|
| 54 | - * @param object $object |
|
| 55 | - * @param mixed $info |
|
| 56 | - * @return bool |
|
| 57 | - */ |
|
| 58 | - public function set_info($object, $info = null) |
|
| 59 | - { |
|
| 60 | - $info = empty($info) && $object instanceof $this->interface ? $object->name : $info; |
|
| 61 | - return parent::set_info($object, $info); |
|
| 62 | - } |
|
| 63 | - |
|
| 64 | - |
|
| 65 | - |
|
| 66 | - /** |
|
| 67 | - * get_by_info |
|
| 68 | - * |
|
| 69 | - * finds and returns an object in the Collection based on the info that was set using addObject() |
|
| 70 | - * PLZ NOTE: the pointer is reset to the beginning of the collection before returning |
|
| 71 | - * |
|
| 72 | - * @access public |
|
| 73 | - * @param mixed |
|
| 74 | - * @return null | object |
|
| 75 | - */ |
|
| 76 | - public function get_by_info($info) |
|
| 77 | - { |
|
| 78 | - return parent::get_by_info(str_replace(' ', '_', strtolower($info))); |
|
| 79 | - } |
|
| 80 | - |
|
| 81 | - |
|
| 82 | - |
|
| 83 | - /** |
|
| 84 | - * has |
|
| 85 | - * |
|
| 86 | - * returns TRUE or FALSE depending on whether the supplied object is within the Collection |
|
| 87 | - * |
|
| 88 | - * @access public |
|
| 89 | - * @param object $object |
|
| 90 | - * @return bool |
|
| 91 | - */ |
|
| 92 | - public function has($object) |
|
| 93 | - { |
|
| 94 | - return parent::has($object); |
|
| 95 | - } |
|
| 96 | - |
|
| 97 | - |
|
| 98 | - |
|
| 99 | - /** |
|
| 100 | - * has_by_name |
|
| 101 | - * |
|
| 102 | - * returns TRUE or FALSE depending on whether the supplied messenger name is within the Collection |
|
| 103 | - * |
|
| 104 | - * @access public |
|
| 105 | - * @param string $messenger_name |
|
| 106 | - * @return bool |
|
| 107 | - */ |
|
| 108 | - public function has_by_name($messenger_name) |
|
| 109 | - { |
|
| 110 | - return $this->get_by_info($messenger_name) instanceof $this->interface ? true : false; |
|
| 111 | - } |
|
| 112 | - |
|
| 113 | - |
|
| 114 | - |
|
| 115 | - /** |
|
| 116 | - * remove |
|
| 117 | - * |
|
| 118 | - * detaches an object from the Collection |
|
| 119 | - * |
|
| 120 | - * @access public |
|
| 121 | - * @param $object |
|
| 122 | - * @return bool |
|
| 123 | - */ |
|
| 124 | - public function remove($object) |
|
| 125 | - { |
|
| 126 | - return parent::remove($object); |
|
| 127 | - } |
|
| 128 | - |
|
| 129 | - |
|
| 130 | - |
|
| 131 | - /** |
|
| 132 | - * current |
|
| 133 | - * |
|
| 134 | - * current object from the Collection |
|
| 135 | - * |
|
| 136 | - * @access public |
|
| 137 | - * @return EE_messenger |
|
| 138 | - */ |
|
| 139 | - public function current() |
|
| 140 | - { |
|
| 141 | - return parent::current(); |
|
| 142 | - } |
|
| 143 | - |
|
| 144 | - |
|
| 145 | - |
|
| 146 | - /** |
|
| 147 | - * set_current |
|
| 148 | - * |
|
| 149 | - * advances pointer to the provided object |
|
| 150 | - * |
|
| 151 | - * @access public |
|
| 152 | - * @param $object |
|
| 153 | - * @return void |
|
| 154 | - */ |
|
| 155 | - public function set_current($object) |
|
| 156 | - { |
|
| 157 | - parent::set_current($object); |
|
| 158 | - } |
|
| 159 | - |
|
| 160 | - |
|
| 161 | - |
|
| 162 | - /** |
|
| 163 | - * set_current_by_info |
|
| 164 | - * |
|
| 165 | - * advances pointer to the object whose info matches that which was provided |
|
| 166 | - * |
|
| 167 | - * @access public |
|
| 168 | - * @param $info |
|
| 169 | - * @return void |
|
| 170 | - */ |
|
| 171 | - public function set_current_by_info($info) |
|
| 172 | - { |
|
| 173 | - parent::set_current_by_info($info); |
|
| 174 | - } |
|
| 175 | - |
|
| 176 | - |
|
| 177 | - |
|
| 178 | - /** |
|
| 179 | - * show_collection_classes |
|
| 180 | - * |
|
| 181 | - * displays list of collection classes if WP_DEBUG is on |
|
| 182 | - * |
|
| 183 | - * @access public |
|
| 184 | - * @return void |
|
| 185 | - */ |
|
| 186 | - public function show_collection_classes() |
|
| 187 | - { |
|
| 188 | - if (WP_DEBUG) { |
|
| 189 | - $this->rewind(); |
|
| 190 | - while ($this->valid()) { |
|
| 191 | - echo '<h5 style="color:#2EA2CC;">' . __CLASS__ . ' class : . <span style="color:#E76700">' . $this->getInfo() . '</span></h5>'; |
|
| 192 | - $this->next(); |
|
| 193 | - } |
|
| 194 | - } |
|
| 195 | - } |
|
| 17 | + /** |
|
| 18 | + * EE_Messenger_Collection constructor. |
|
| 19 | + */ |
|
| 20 | + public function __construct() |
|
| 21 | + { |
|
| 22 | + $this->interface = 'EE_messenger'; |
|
| 23 | + } |
|
| 24 | + |
|
| 25 | + |
|
| 26 | + |
|
| 27 | + /** |
|
| 28 | + * add |
|
| 29 | + * |
|
| 30 | + * attaches an object to the Collection |
|
| 31 | + * and sets any supplied data associated with the current iterator entry |
|
| 32 | + * by calling EE_Object_Collection::set_info() |
|
| 33 | + * |
|
| 34 | + * @access public |
|
| 35 | + * @param object $object |
|
| 36 | + * @param mixed $info |
|
| 37 | + * @return bool |
|
| 38 | + */ |
|
| 39 | + public function add($object, $info = null) |
|
| 40 | + { |
|
| 41 | + $info = empty($info) && $object instanceof $this->interface ? $object->name : $info; |
|
| 42 | + return parent::add($object, $info); |
|
| 43 | + } |
|
| 44 | + |
|
| 45 | + |
|
| 46 | + |
|
| 47 | + /** |
|
| 48 | + * set_info |
|
| 49 | + * |
|
| 50 | + * Sets the data associated with an object in the Collection |
|
| 51 | + * if no $info is supplied, then the spl_object_hash() is used |
|
| 52 | + * |
|
| 53 | + * @access public |
|
| 54 | + * @param object $object |
|
| 55 | + * @param mixed $info |
|
| 56 | + * @return bool |
|
| 57 | + */ |
|
| 58 | + public function set_info($object, $info = null) |
|
| 59 | + { |
|
| 60 | + $info = empty($info) && $object instanceof $this->interface ? $object->name : $info; |
|
| 61 | + return parent::set_info($object, $info); |
|
| 62 | + } |
|
| 63 | + |
|
| 64 | + |
|
| 65 | + |
|
| 66 | + /** |
|
| 67 | + * get_by_info |
|
| 68 | + * |
|
| 69 | + * finds and returns an object in the Collection based on the info that was set using addObject() |
|
| 70 | + * PLZ NOTE: the pointer is reset to the beginning of the collection before returning |
|
| 71 | + * |
|
| 72 | + * @access public |
|
| 73 | + * @param mixed |
|
| 74 | + * @return null | object |
|
| 75 | + */ |
|
| 76 | + public function get_by_info($info) |
|
| 77 | + { |
|
| 78 | + return parent::get_by_info(str_replace(' ', '_', strtolower($info))); |
|
| 79 | + } |
|
| 80 | + |
|
| 81 | + |
|
| 82 | + |
|
| 83 | + /** |
|
| 84 | + * has |
|
| 85 | + * |
|
| 86 | + * returns TRUE or FALSE depending on whether the supplied object is within the Collection |
|
| 87 | + * |
|
| 88 | + * @access public |
|
| 89 | + * @param object $object |
|
| 90 | + * @return bool |
|
| 91 | + */ |
|
| 92 | + public function has($object) |
|
| 93 | + { |
|
| 94 | + return parent::has($object); |
|
| 95 | + } |
|
| 96 | + |
|
| 97 | + |
|
| 98 | + |
|
| 99 | + /** |
|
| 100 | + * has_by_name |
|
| 101 | + * |
|
| 102 | + * returns TRUE or FALSE depending on whether the supplied messenger name is within the Collection |
|
| 103 | + * |
|
| 104 | + * @access public |
|
| 105 | + * @param string $messenger_name |
|
| 106 | + * @return bool |
|
| 107 | + */ |
|
| 108 | + public function has_by_name($messenger_name) |
|
| 109 | + { |
|
| 110 | + return $this->get_by_info($messenger_name) instanceof $this->interface ? true : false; |
|
| 111 | + } |
|
| 112 | + |
|
| 113 | + |
|
| 114 | + |
|
| 115 | + /** |
|
| 116 | + * remove |
|
| 117 | + * |
|
| 118 | + * detaches an object from the Collection |
|
| 119 | + * |
|
| 120 | + * @access public |
|
| 121 | + * @param $object |
|
| 122 | + * @return bool |
|
| 123 | + */ |
|
| 124 | + public function remove($object) |
|
| 125 | + { |
|
| 126 | + return parent::remove($object); |
|
| 127 | + } |
|
| 128 | + |
|
| 129 | + |
|
| 130 | + |
|
| 131 | + /** |
|
| 132 | + * current |
|
| 133 | + * |
|
| 134 | + * current object from the Collection |
|
| 135 | + * |
|
| 136 | + * @access public |
|
| 137 | + * @return EE_messenger |
|
| 138 | + */ |
|
| 139 | + public function current() |
|
| 140 | + { |
|
| 141 | + return parent::current(); |
|
| 142 | + } |
|
| 143 | + |
|
| 144 | + |
|
| 145 | + |
|
| 146 | + /** |
|
| 147 | + * set_current |
|
| 148 | + * |
|
| 149 | + * advances pointer to the provided object |
|
| 150 | + * |
|
| 151 | + * @access public |
|
| 152 | + * @param $object |
|
| 153 | + * @return void |
|
| 154 | + */ |
|
| 155 | + public function set_current($object) |
|
| 156 | + { |
|
| 157 | + parent::set_current($object); |
|
| 158 | + } |
|
| 159 | + |
|
| 160 | + |
|
| 161 | + |
|
| 162 | + /** |
|
| 163 | + * set_current_by_info |
|
| 164 | + * |
|
| 165 | + * advances pointer to the object whose info matches that which was provided |
|
| 166 | + * |
|
| 167 | + * @access public |
|
| 168 | + * @param $info |
|
| 169 | + * @return void |
|
| 170 | + */ |
|
| 171 | + public function set_current_by_info($info) |
|
| 172 | + { |
|
| 173 | + parent::set_current_by_info($info); |
|
| 174 | + } |
|
| 175 | + |
|
| 176 | + |
|
| 177 | + |
|
| 178 | + /** |
|
| 179 | + * show_collection_classes |
|
| 180 | + * |
|
| 181 | + * displays list of collection classes if WP_DEBUG is on |
|
| 182 | + * |
|
| 183 | + * @access public |
|
| 184 | + * @return void |
|
| 185 | + */ |
|
| 186 | + public function show_collection_classes() |
|
| 187 | + { |
|
| 188 | + if (WP_DEBUG) { |
|
| 189 | + $this->rewind(); |
|
| 190 | + while ($this->valid()) { |
|
| 191 | + echo '<h5 style="color:#2EA2CC;">' . __CLASS__ . ' class : . <span style="color:#E76700">' . $this->getInfo() . '</span></h5>'; |
|
| 192 | + $this->next(); |
|
| 193 | + } |
|
| 194 | + } |
|
| 195 | + } |
|
| 196 | 196 | } |
@@ -188,7 +188,7 @@ |
||
| 188 | 188 | if (WP_DEBUG) { |
| 189 | 189 | $this->rewind(); |
| 190 | 190 | while ($this->valid()) { |
| 191 | - echo '<h5 style="color:#2EA2CC;">' . __CLASS__ . ' class : . <span style="color:#E76700">' . $this->getInfo() . '</span></h5>'; |
|
| 191 | + echo '<h5 style="color:#2EA2CC;">'.__CLASS__.' class : . <span style="color:#E76700">'.$this->getInfo().'</span></h5>'; |
|
| 192 | 192 | $this->next(); |
| 193 | 193 | } |
| 194 | 194 | } |
@@ -12,548 +12,548 @@ |
||
| 12 | 12 | { |
| 13 | 13 | |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * The following are the properties that this messenger requires for displaying the html |
|
| 17 | - */ |
|
| 18 | - /** |
|
| 19 | - * This is the html body generated by the template via the message type. |
|
| 20 | - * |
|
| 21 | - * @var string |
|
| 22 | - */ |
|
| 23 | - protected $_content; |
|
| 24 | - |
|
| 25 | - |
|
| 26 | - /** |
|
| 27 | - * This is for the page title that gets displayed. (Why use "subject"? Because the "title" tag in html is |
|
| 28 | - * equivalent to the "subject" of the page. |
|
| 29 | - * |
|
| 30 | - * @var string |
|
| 31 | - */ |
|
| 32 | - protected $_subject; |
|
| 33 | - |
|
| 34 | - |
|
| 35 | - /** |
|
| 36 | - * EE_Html_messenger constructor. |
|
| 37 | - */ |
|
| 38 | - public function __construct() |
|
| 39 | - { |
|
| 40 | - // set properties |
|
| 41 | - $this->name = 'html'; |
|
| 42 | - $this->description = __('This messenger outputs a message to a browser for display.', 'event_espresso'); |
|
| 43 | - $this->label = array( |
|
| 44 | - 'singular' => __('html', 'event_espresso'), |
|
| 45 | - 'plural' => __('html', 'event_espresso'), |
|
| 46 | - ); |
|
| 47 | - $this->activate_on_install = true; |
|
| 48 | - // add the "powered by EE" credit link to the HTML receipt and invoice |
|
| 49 | - add_filter( |
|
| 50 | - 'FHEE__EE_Html_messenger___send_message__main_body', |
|
| 51 | - array($this, 'add_powered_by_credit_link_to_receipt_and_invoice'), |
|
| 52 | - 10, |
|
| 53 | - 3 |
|
| 54 | - ); |
|
| 55 | - parent::__construct(); |
|
| 56 | - } |
|
| 57 | - |
|
| 58 | - |
|
| 59 | - /** |
|
| 60 | - * HTML Messenger desires execution immediately. |
|
| 61 | - * |
|
| 62 | - * @see parent::send_now() for documentation. |
|
| 63 | - * @since 4.9.0 |
|
| 64 | - * @return bool |
|
| 65 | - */ |
|
| 66 | - public function send_now() |
|
| 67 | - { |
|
| 68 | - return true; |
|
| 69 | - } |
|
| 70 | - |
|
| 71 | - |
|
| 72 | - /** |
|
| 73 | - * HTML Messenger allows an empty to field. |
|
| 74 | - * |
|
| 75 | - * @see parent::allow_empty_to_field() for documentation |
|
| 76 | - * @since 4.9.0 |
|
| 77 | - * @return bool |
|
| 78 | - */ |
|
| 79 | - public function allow_empty_to_field() |
|
| 80 | - { |
|
| 81 | - return true; |
|
| 82 | - } |
|
| 83 | - |
|
| 84 | - |
|
| 85 | - /** |
|
| 86 | - * @see abstract declaration in EE_messenger for details. |
|
| 87 | - */ |
|
| 88 | - protected function _set_admin_pages() |
|
| 89 | - { |
|
| 90 | - $this->admin_registered_pages = array('events_edit' => true); |
|
| 91 | - } |
|
| 92 | - |
|
| 93 | - |
|
| 94 | - /** |
|
| 95 | - * @see abstract declaration in EE_messenger for details. |
|
| 96 | - */ |
|
| 97 | - protected function _set_valid_shortcodes() |
|
| 98 | - { |
|
| 99 | - $this->_valid_shortcodes = array(); |
|
| 100 | - } |
|
| 101 | - |
|
| 102 | - |
|
| 103 | - /** |
|
| 104 | - * @see abstract declaration in EE_messenger for details. |
|
| 105 | - */ |
|
| 106 | - protected function _set_validator_config() |
|
| 107 | - { |
|
| 108 | - $this->_validator_config = array( |
|
| 109 | - 'subject' => array( |
|
| 110 | - 'shortcodes' => array('organization', 'primary_registration_details', 'email', 'transaction'), |
|
| 111 | - ), |
|
| 112 | - 'content' => array( |
|
| 113 | - 'shortcodes' => array( |
|
| 114 | - 'organization', |
|
| 115 | - 'primary_registration_list', |
|
| 116 | - 'primary_registration_details', |
|
| 117 | - 'email', |
|
| 118 | - 'transaction', |
|
| 119 | - 'event_list', |
|
| 120 | - 'payment_list', |
|
| 121 | - 'venue', |
|
| 122 | - 'line_item_list', |
|
| 123 | - 'messenger', |
|
| 124 | - 'ticket_list', |
|
| 125 | - ), |
|
| 126 | - ), |
|
| 127 | - 'event_list' => array( |
|
| 128 | - 'shortcodes' => array( |
|
| 129 | - 'event', |
|
| 130 | - 'ticket_list', |
|
| 131 | - 'venue', |
|
| 132 | - 'primary_registration_details', |
|
| 133 | - 'primary_registration_list', |
|
| 134 | - 'event_author', |
|
| 135 | - ), |
|
| 136 | - 'required' => array('[EVENT_LIST]'), |
|
| 137 | - ), |
|
| 138 | - 'ticket_list' => array( |
|
| 139 | - 'shortcodes' => array( |
|
| 140 | - 'attendee_list', |
|
| 141 | - 'ticket', |
|
| 142 | - 'datetime_list', |
|
| 143 | - 'primary_registration_details', |
|
| 144 | - 'line_item_list', |
|
| 145 | - 'venue', |
|
| 146 | - ), |
|
| 147 | - 'required' => array('[TICKET_LIST]'), |
|
| 148 | - ), |
|
| 149 | - 'ticket_line_item_no_pms' => array( |
|
| 150 | - 'shortcodes' => array('line_item', 'ticket'), |
|
| 151 | - 'required' => array('[TICKET_LINE_ITEM_LIST]'), |
|
| 152 | - ), |
|
| 153 | - 'ticket_line_item_pms' => array( |
|
| 154 | - 'shortcodes' => array('line_item', 'ticket', 'line_item_list'), |
|
| 155 | - 'required' => array('[TICKET_LINE_ITEM_LIST]'), |
|
| 156 | - ), |
|
| 157 | - 'price_modifier_line_item_list' => array( |
|
| 158 | - 'shortcodes' => array('line_item'), |
|
| 159 | - 'required' => array('[PRICE_MODIFIER_LINE_ITEM_LIST]'), |
|
| 160 | - ), |
|
| 161 | - 'datetime_list' => array( |
|
| 162 | - 'shortcodes' => array('datetime'), |
|
| 163 | - 'required' => array('[DATETIME_LIST]'), |
|
| 164 | - ), |
|
| 165 | - 'attendee_list' => array( |
|
| 166 | - 'shortcodes' => array('attendee'), |
|
| 167 | - 'required' => array('[ATTENDEE_LIST]'), |
|
| 168 | - ), |
|
| 169 | - 'tax_line_item_list' => array( |
|
| 170 | - 'shortcodes' => array('line_item'), |
|
| 171 | - 'required' => array('[TAX_LINE_ITEM_LIST]'), |
|
| 172 | - ), |
|
| 173 | - 'additional_line_item_list' => array( |
|
| 174 | - 'shortcodes' => array('line_item'), |
|
| 175 | - 'required' => array('[ADDITIONAL_LINE_ITEM_LIST]'), |
|
| 176 | - ), |
|
| 177 | - 'payment_list' => array( |
|
| 178 | - 'shortcodes' => array('payment'), |
|
| 179 | - 'required' => array('[PAYMENT_LIST_*]'), |
|
| 180 | - ), |
|
| 181 | - ); |
|
| 182 | - } |
|
| 183 | - |
|
| 184 | - |
|
| 185 | - /** |
|
| 186 | - * This is a method called from EE_messages when this messenger is a generating messenger and the sending messenger |
|
| 187 | - * is a different messenger. Child messengers can set hooks for the sending messenger to callback on if necessary |
|
| 188 | - * (i.e. swap out css files or something else). |
|
| 189 | - * |
|
| 190 | - * @since 4.5.0 |
|
| 191 | - * @param string $sending_messenger_name the name of the sending messenger so we only set the hooks needed. |
|
| 192 | - * @return void |
|
| 193 | - */ |
|
| 194 | - public function do_secondary_messenger_hooks($sending_messenger_name) |
|
| 195 | - { |
|
| 196 | - if ($sending_messenger_name = 'pdf') { |
|
| 197 | - add_filter('EE_messenger__get_variation__variation', array($this, 'add_html_css'), 10, 8); |
|
| 198 | - } |
|
| 199 | - } |
|
| 200 | - |
|
| 201 | - |
|
| 202 | - /** |
|
| 203 | - * @param $variation_path |
|
| 204 | - * @param \EE_Messages_Template_Pack $template_pack |
|
| 205 | - * @param $messenger_name |
|
| 206 | - * @param $message_type_name |
|
| 207 | - * @param $url |
|
| 208 | - * @param $type |
|
| 209 | - * @param $variation |
|
| 210 | - * @param $skip_filters |
|
| 211 | - * @return string |
|
| 212 | - */ |
|
| 213 | - public function add_html_css( |
|
| 214 | - $variation_path, |
|
| 215 | - EE_Messages_Template_Pack $template_pack, |
|
| 216 | - $messenger_name, |
|
| 217 | - $message_type_name, |
|
| 218 | - $url, |
|
| 219 | - $type, |
|
| 220 | - $variation, |
|
| 221 | - $skip_filters |
|
| 222 | - ) { |
|
| 223 | - $variation = $template_pack->get_variation( |
|
| 224 | - $this->name, |
|
| 225 | - $message_type_name, |
|
| 226 | - $type, |
|
| 227 | - $variation, |
|
| 228 | - $url, |
|
| 229 | - '.css', |
|
| 230 | - $skip_filters |
|
| 231 | - ); |
|
| 232 | - return $variation; |
|
| 233 | - } |
|
| 234 | - |
|
| 235 | - |
|
| 236 | - /** |
|
| 237 | - * Takes care of enqueuing any necessary scripts or styles for the page. A do_action() so message types using this |
|
| 238 | - * messenger can add their own js. |
|
| 239 | - * |
|
| 240 | - * @return void. |
|
| 241 | - */ |
|
| 242 | - public function enqueue_scripts_styles() |
|
| 243 | - { |
|
| 244 | - parent::enqueue_scripts_styles(); |
|
| 245 | - do_action('AHEE__EE_Html_messenger__enqueue_scripts_styles'); |
|
| 246 | - } |
|
| 247 | - |
|
| 248 | - |
|
| 249 | - /** |
|
| 250 | - * _set_template_fields |
|
| 251 | - * This sets up the fields that a messenger requires for the message to go out. |
|
| 252 | - * |
|
| 253 | - * @access protected |
|
| 254 | - * @return void |
|
| 255 | - */ |
|
| 256 | - protected function _set_template_fields() |
|
| 257 | - { |
|
| 258 | - // any extra template fields that are NOT used by the messenger |
|
| 259 | - // but will get used by a messenger field for shortcode replacement |
|
| 260 | - // get added to the 'extra' key in an associated array |
|
| 261 | - // indexed by the messenger field they relate to. |
|
| 262 | - // This is important for the Messages_admin to know what fields to display to the user. |
|
| 263 | - // Also, notice that the "values" are equal to the field type |
|
| 264 | - // that messages admin will use to know what kind of field to display. |
|
| 265 | - // The values ALSO have one index labeled "shortcode". |
|
| 266 | - // The values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) |
|
| 267 | - // is required in order for this extra field to be displayed. |
|
| 268 | - // If the required shortcode isn't part of the shortcodes array |
|
| 269 | - // then the field is not needed and will not be displayed/parsed. |
|
| 270 | - $this->_template_fields = array( |
|
| 271 | - 'subject' => array( |
|
| 272 | - 'input' => 'text', |
|
| 273 | - 'label' => __('Page Title', 'event_espresso'), |
|
| 274 | - 'type' => 'string', |
|
| 275 | - 'required' => true, |
|
| 276 | - 'validation' => true, |
|
| 277 | - 'css_class' => 'large-text', |
|
| 278 | - 'format' => '%s', |
|
| 279 | - ), |
|
| 280 | - 'content' => '', |
|
| 281 | - // left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field. |
|
| 282 | - 'extra' => array( |
|
| 283 | - 'content' => array( |
|
| 284 | - 'main' => array( |
|
| 285 | - 'input' => 'wp_editor', |
|
| 286 | - 'label' => __('Main Content', 'event_espresso'), |
|
| 287 | - 'type' => 'string', |
|
| 288 | - 'required' => true, |
|
| 289 | - 'validation' => true, |
|
| 290 | - 'format' => '%s', |
|
| 291 | - 'rows' => '15', |
|
| 292 | - ), |
|
| 293 | - 'event_list' => array( |
|
| 294 | - 'input' => 'wp_editor', |
|
| 295 | - 'label' => '[EVENT_LIST]', |
|
| 296 | - 'type' => 'string', |
|
| 297 | - 'required' => true, |
|
| 298 | - 'validation' => true, |
|
| 299 | - 'format' => '%s', |
|
| 300 | - 'rows' => '15', |
|
| 301 | - 'shortcodes_required' => array('[EVENT_LIST]'), |
|
| 302 | - ), |
|
| 303 | - 'ticket_list' => array( |
|
| 304 | - 'input' => 'textarea', |
|
| 305 | - 'label' => '[TICKET_LIST]', |
|
| 306 | - 'type' => 'string', |
|
| 307 | - 'required' => true, |
|
| 308 | - 'validation' => true, |
|
| 309 | - 'format' => '%s', |
|
| 310 | - 'css_class' => 'large-text', |
|
| 311 | - 'rows' => '10', |
|
| 312 | - 'shortcodes_required' => array('[TICKET_LIST]'), |
|
| 313 | - ), |
|
| 314 | - 'ticket_line_item_no_pms' => array( |
|
| 315 | - 'input' => 'textarea', |
|
| 316 | - 'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __( |
|
| 317 | - 'Ticket Line Item List with no Price Modifiers', |
|
| 318 | - 'event_espresso' |
|
| 319 | - ), |
|
| 320 | - 'type' => 'string', |
|
| 321 | - 'required' => false, |
|
| 322 | - 'validation' => true, |
|
| 323 | - 'format' => '%s', |
|
| 324 | - 'css_class' => 'large-text', |
|
| 325 | - 'rows' => '5', |
|
| 326 | - 'shortcodes_required' => array('[TICKET_LINE_ITEM_LIST]'), |
|
| 327 | - ), |
|
| 328 | - 'ticket_line_item_pms' => array( |
|
| 329 | - 'input' => 'textarea', |
|
| 330 | - 'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __( |
|
| 331 | - 'Ticket Line Item List with Price Modifiers', |
|
| 332 | - 'event_espresso' |
|
| 333 | - ), |
|
| 334 | - 'type' => 'string', |
|
| 335 | - 'required' => false, |
|
| 336 | - 'validation' => true, |
|
| 337 | - 'format' => '%s', |
|
| 338 | - 'css_class' => 'large-text', |
|
| 339 | - 'rows' => '5', |
|
| 340 | - 'shortcodes_required' => array('[TICKET_LINE_ITEM_LIST]'), |
|
| 341 | - ), |
|
| 342 | - 'price_modifier_line_item_list' => array( |
|
| 343 | - 'input' => 'textarea', |
|
| 344 | - 'label' => '[PRICE_MODIFIER_LINE_ITEM_LIST]', |
|
| 345 | - 'type' => 'string', |
|
| 346 | - 'required' => false, |
|
| 347 | - 'validation' => true, |
|
| 348 | - 'format' => '%s', |
|
| 349 | - 'css_class' => 'large-text', |
|
| 350 | - 'rows' => '5', |
|
| 351 | - 'shortcodes_required' => array('[PRICE_MODIFIER_LINE_ITEM_LIST]'), |
|
| 352 | - ), |
|
| 353 | - 'datetime_list' => array( |
|
| 354 | - 'input' => 'textarea', |
|
| 355 | - 'label' => '[DATETIME_LIST]', |
|
| 356 | - 'type' => 'string', |
|
| 357 | - 'required' => true, |
|
| 358 | - 'validation' => true, |
|
| 359 | - 'format' => '%s', |
|
| 360 | - 'css_class' => 'large-text', |
|
| 361 | - 'rows' => '5', |
|
| 362 | - 'shortcodes_required' => array('[DATETIME_LIST]'), |
|
| 363 | - ), |
|
| 364 | - 'attendee_list' => array( |
|
| 365 | - 'input' => 'textarea', |
|
| 366 | - 'label' => '[ATTENDEE_LIST]', |
|
| 367 | - 'type' => 'string', |
|
| 368 | - 'required' => true, |
|
| 369 | - 'validation' => true, |
|
| 370 | - 'format' => '%s', |
|
| 371 | - 'css_class' => 'large-text', |
|
| 372 | - 'rows' => '5', |
|
| 373 | - 'shortcodes_required' => array('[ATTENDEE_LIST]'), |
|
| 374 | - ), |
|
| 375 | - 'tax_line_item_list' => array( |
|
| 376 | - 'input' => 'textarea', |
|
| 377 | - 'label' => '[TAX_LINE_ITEM_LIST]', |
|
| 378 | - 'type' => 'string', |
|
| 379 | - 'required' => false, |
|
| 380 | - 'validation' => true, |
|
| 381 | - 'format' => '%s', |
|
| 382 | - 'css_class' => 'large-text', |
|
| 383 | - 'rows' => '5', |
|
| 384 | - 'shortcodes_required' => array('[TAX_LINE_ITEM_LIST]'), |
|
| 385 | - ), |
|
| 386 | - 'additional_line_item_list' => array( |
|
| 387 | - 'input' => 'textarea', |
|
| 388 | - 'label' => '[ADDITIONAL_LINE_ITEM_LIST]', |
|
| 389 | - 'type' => 'string', |
|
| 390 | - 'required' => false, |
|
| 391 | - 'validation' => true, |
|
| 392 | - 'format' => '%s', |
|
| 393 | - 'css_class' => 'large-text', |
|
| 394 | - 'rows' => '5', |
|
| 395 | - 'shortcodes_required' => array('[ADDITIONAL_LINE_ITEM_LIST]'), |
|
| 396 | - ), |
|
| 397 | - 'payment_list' => array( |
|
| 398 | - 'input' => 'textarea', |
|
| 399 | - 'label' => '[PAYMENT_LIST]', |
|
| 400 | - 'type' => 'string', |
|
| 401 | - 'required' => true, |
|
| 402 | - 'validation' => true, |
|
| 403 | - 'format' => '%s', |
|
| 404 | - 'css_class' => 'large-text', |
|
| 405 | - 'rows' => '5', |
|
| 406 | - 'shortcodes_required' => array('[PAYMENT_LIST_*]'), |
|
| 407 | - ), |
|
| 408 | - ), |
|
| 409 | - ), |
|
| 410 | - ); |
|
| 411 | - } |
|
| 412 | - |
|
| 413 | - |
|
| 414 | - /** |
|
| 415 | - * @see definition of this method in parent |
|
| 416 | - * @since 4.5.0 |
|
| 417 | - */ |
|
| 418 | - protected function _set_default_message_types() |
|
| 419 | - { |
|
| 420 | - $this->_default_message_types = array('receipt', 'invoice'); |
|
| 421 | - } |
|
| 422 | - |
|
| 423 | - |
|
| 424 | - /** |
|
| 425 | - * @see definition of this method in parent |
|
| 426 | - * @since 4.5.0 |
|
| 427 | - */ |
|
| 428 | - protected function _set_valid_message_types() |
|
| 429 | - { |
|
| 430 | - $this->_valid_message_types = array('receipt', 'invoice'); |
|
| 431 | - } |
|
| 432 | - |
|
| 433 | - |
|
| 434 | - /** |
|
| 435 | - * Displays the message in the browser. |
|
| 436 | - * |
|
| 437 | - * @since 4.5.0 |
|
| 438 | - * @return string. |
|
| 439 | - */ |
|
| 440 | - protected function _send_message() |
|
| 441 | - { |
|
| 442 | - $this->_template_args = array( |
|
| 443 | - 'page_title' => $this->_subject, |
|
| 444 | - 'base_css' => $this->get_variation( |
|
| 445 | - $this->_tmp_pack, |
|
| 446 | - $this->_incoming_message_type->name, |
|
| 447 | - true, |
|
| 448 | - 'base', |
|
| 449 | - $this->_variation |
|
| 450 | - ), |
|
| 451 | - 'print_css' => $this->get_variation( |
|
| 452 | - $this->_tmp_pack, |
|
| 453 | - $this->_incoming_message_type->name, |
|
| 454 | - true, |
|
| 455 | - 'print', |
|
| 456 | - $this->_variation |
|
| 457 | - ), |
|
| 458 | - 'main_css' => $this->get_variation( |
|
| 459 | - $this->_tmp_pack, |
|
| 460 | - $this->_incoming_message_type->name, |
|
| 461 | - true, |
|
| 462 | - 'main', |
|
| 463 | - $this->_variation |
|
| 464 | - ), |
|
| 465 | - 'main_body' => wpautop( |
|
| 466 | - apply_filters( |
|
| 467 | - 'FHEE__EE_Html_messenger___send_message__main_body', |
|
| 468 | - $this->_content, |
|
| 469 | - $this->_content, |
|
| 470 | - $this->_incoming_message_type |
|
| 471 | - ) |
|
| 472 | - ) |
|
| 473 | - ); |
|
| 474 | - $this->_deregister_wp_hooks(); |
|
| 475 | - add_action('wp_enqueue_scripts', array($this, 'enqueue_scripts_styles')); |
|
| 476 | - echo $this->_get_main_template(); |
|
| 477 | - exit(); |
|
| 478 | - } |
|
| 479 | - |
|
| 480 | - |
|
| 481 | - /** |
|
| 482 | - * The purpose of this function is to de register all actions hooked into wp_head and wp_footer so that it doesn't |
|
| 483 | - * interfere with our templates. If users want to add any custom styles or scripts they must use the |
|
| 484 | - * AHEE__EE_Html_messenger__enqueue_scripts_styles hook. |
|
| 485 | - * |
|
| 486 | - * @since 4.5.0 |
|
| 487 | - * @return void |
|
| 488 | - */ |
|
| 489 | - protected function _deregister_wp_hooks() |
|
| 490 | - { |
|
| 491 | - remove_all_actions('wp_head'); |
|
| 492 | - remove_all_actions('wp_footer'); |
|
| 493 | - remove_all_actions('wp_print_footer_scripts'); |
|
| 494 | - remove_all_actions('wp_enqueue_scripts'); |
|
| 495 | - global $wp_scripts, $wp_styles; |
|
| 496 | - $wp_scripts = $wp_styles = array(); |
|
| 497 | - // just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load. |
|
| 498 | - add_action('wp_footer', 'wp_print_footer_scripts'); |
|
| 499 | - add_action('wp_print_footer_scripts', '_wp_footer_scripts'); |
|
| 500 | - add_action('wp_head', 'wp_enqueue_scripts'); |
|
| 501 | - } |
|
| 502 | - |
|
| 503 | - |
|
| 504 | - /** |
|
| 505 | - * Overwrite parent _get_main_template for display_html purposes. |
|
| 506 | - * |
|
| 507 | - * @since 4.5.0 |
|
| 508 | - * @param bool $preview |
|
| 509 | - * @return string |
|
| 510 | - */ |
|
| 511 | - protected function _get_main_template($preview = false) |
|
| 512 | - { |
|
| 513 | - $wrapper_template = $this->_tmp_pack->get_wrapper($this->name, 'main'); |
|
| 514 | - // include message type as a template arg |
|
| 515 | - $this->_template_args['message_type'] = $this->_incoming_message_type; |
|
| 516 | - return EEH_Template::display_template($wrapper_template, $this->_template_args, true); |
|
| 517 | - } |
|
| 518 | - |
|
| 519 | - |
|
| 520 | - /** |
|
| 521 | - * @return string |
|
| 522 | - */ |
|
| 523 | - protected function _preview() |
|
| 524 | - { |
|
| 525 | - return $this->_send_message(); |
|
| 526 | - } |
|
| 527 | - |
|
| 528 | - |
|
| 529 | - protected function _set_admin_settings_fields() |
|
| 530 | - { |
|
| 531 | - } |
|
| 532 | - |
|
| 533 | - |
|
| 534 | - /** |
|
| 535 | - * add the "powered by EE" credit link to the HTML receipt and invoice |
|
| 536 | - * |
|
| 537 | - * @param string $content |
|
| 538 | - * @param string $content_again |
|
| 539 | - * @param \EE_message_type $incoming_message_type |
|
| 540 | - * @return string |
|
| 541 | - */ |
|
| 542 | - public function add_powered_by_credit_link_to_receipt_and_invoice( |
|
| 543 | - $content = '', |
|
| 544 | - $content_again = '', |
|
| 545 | - EE_message_type $incoming_message_type |
|
| 546 | - ) { |
|
| 547 | - if (($incoming_message_type->name === 'invoice' || $incoming_message_type->name === 'receipt') |
|
| 548 | - && apply_filters('FHEE_EE_Html_messenger__add_powered_by_credit_link_to_receipt_and_invoice', true) |
|
| 549 | - ) { |
|
| 550 | - $content .= \EEH_Template::powered_by_event_espresso( |
|
| 551 | - 'aln-cntr', |
|
| 552 | - '', |
|
| 553 | - array('utm_content' => 'messages_system') |
|
| 554 | - ) |
|
| 555 | - . EEH_HTML::div(EEH_HTML::p(' ')); |
|
| 556 | - } |
|
| 557 | - return $content; |
|
| 558 | - } |
|
| 15 | + /** |
|
| 16 | + * The following are the properties that this messenger requires for displaying the html |
|
| 17 | + */ |
|
| 18 | + /** |
|
| 19 | + * This is the html body generated by the template via the message type. |
|
| 20 | + * |
|
| 21 | + * @var string |
|
| 22 | + */ |
|
| 23 | + protected $_content; |
|
| 24 | + |
|
| 25 | + |
|
| 26 | + /** |
|
| 27 | + * This is for the page title that gets displayed. (Why use "subject"? Because the "title" tag in html is |
|
| 28 | + * equivalent to the "subject" of the page. |
|
| 29 | + * |
|
| 30 | + * @var string |
|
| 31 | + */ |
|
| 32 | + protected $_subject; |
|
| 33 | + |
|
| 34 | + |
|
| 35 | + /** |
|
| 36 | + * EE_Html_messenger constructor. |
|
| 37 | + */ |
|
| 38 | + public function __construct() |
|
| 39 | + { |
|
| 40 | + // set properties |
|
| 41 | + $this->name = 'html'; |
|
| 42 | + $this->description = __('This messenger outputs a message to a browser for display.', 'event_espresso'); |
|
| 43 | + $this->label = array( |
|
| 44 | + 'singular' => __('html', 'event_espresso'), |
|
| 45 | + 'plural' => __('html', 'event_espresso'), |
|
| 46 | + ); |
|
| 47 | + $this->activate_on_install = true; |
|
| 48 | + // add the "powered by EE" credit link to the HTML receipt and invoice |
|
| 49 | + add_filter( |
|
| 50 | + 'FHEE__EE_Html_messenger___send_message__main_body', |
|
| 51 | + array($this, 'add_powered_by_credit_link_to_receipt_and_invoice'), |
|
| 52 | + 10, |
|
| 53 | + 3 |
|
| 54 | + ); |
|
| 55 | + parent::__construct(); |
|
| 56 | + } |
|
| 57 | + |
|
| 58 | + |
|
| 59 | + /** |
|
| 60 | + * HTML Messenger desires execution immediately. |
|
| 61 | + * |
|
| 62 | + * @see parent::send_now() for documentation. |
|
| 63 | + * @since 4.9.0 |
|
| 64 | + * @return bool |
|
| 65 | + */ |
|
| 66 | + public function send_now() |
|
| 67 | + { |
|
| 68 | + return true; |
|
| 69 | + } |
|
| 70 | + |
|
| 71 | + |
|
| 72 | + /** |
|
| 73 | + * HTML Messenger allows an empty to field. |
|
| 74 | + * |
|
| 75 | + * @see parent::allow_empty_to_field() for documentation |
|
| 76 | + * @since 4.9.0 |
|
| 77 | + * @return bool |
|
| 78 | + */ |
|
| 79 | + public function allow_empty_to_field() |
|
| 80 | + { |
|
| 81 | + return true; |
|
| 82 | + } |
|
| 83 | + |
|
| 84 | + |
|
| 85 | + /** |
|
| 86 | + * @see abstract declaration in EE_messenger for details. |
|
| 87 | + */ |
|
| 88 | + protected function _set_admin_pages() |
|
| 89 | + { |
|
| 90 | + $this->admin_registered_pages = array('events_edit' => true); |
|
| 91 | + } |
|
| 92 | + |
|
| 93 | + |
|
| 94 | + /** |
|
| 95 | + * @see abstract declaration in EE_messenger for details. |
|
| 96 | + */ |
|
| 97 | + protected function _set_valid_shortcodes() |
|
| 98 | + { |
|
| 99 | + $this->_valid_shortcodes = array(); |
|
| 100 | + } |
|
| 101 | + |
|
| 102 | + |
|
| 103 | + /** |
|
| 104 | + * @see abstract declaration in EE_messenger for details. |
|
| 105 | + */ |
|
| 106 | + protected function _set_validator_config() |
|
| 107 | + { |
|
| 108 | + $this->_validator_config = array( |
|
| 109 | + 'subject' => array( |
|
| 110 | + 'shortcodes' => array('organization', 'primary_registration_details', 'email', 'transaction'), |
|
| 111 | + ), |
|
| 112 | + 'content' => array( |
|
| 113 | + 'shortcodes' => array( |
|
| 114 | + 'organization', |
|
| 115 | + 'primary_registration_list', |
|
| 116 | + 'primary_registration_details', |
|
| 117 | + 'email', |
|
| 118 | + 'transaction', |
|
| 119 | + 'event_list', |
|
| 120 | + 'payment_list', |
|
| 121 | + 'venue', |
|
| 122 | + 'line_item_list', |
|
| 123 | + 'messenger', |
|
| 124 | + 'ticket_list', |
|
| 125 | + ), |
|
| 126 | + ), |
|
| 127 | + 'event_list' => array( |
|
| 128 | + 'shortcodes' => array( |
|
| 129 | + 'event', |
|
| 130 | + 'ticket_list', |
|
| 131 | + 'venue', |
|
| 132 | + 'primary_registration_details', |
|
| 133 | + 'primary_registration_list', |
|
| 134 | + 'event_author', |
|
| 135 | + ), |
|
| 136 | + 'required' => array('[EVENT_LIST]'), |
|
| 137 | + ), |
|
| 138 | + 'ticket_list' => array( |
|
| 139 | + 'shortcodes' => array( |
|
| 140 | + 'attendee_list', |
|
| 141 | + 'ticket', |
|
| 142 | + 'datetime_list', |
|
| 143 | + 'primary_registration_details', |
|
| 144 | + 'line_item_list', |
|
| 145 | + 'venue', |
|
| 146 | + ), |
|
| 147 | + 'required' => array('[TICKET_LIST]'), |
|
| 148 | + ), |
|
| 149 | + 'ticket_line_item_no_pms' => array( |
|
| 150 | + 'shortcodes' => array('line_item', 'ticket'), |
|
| 151 | + 'required' => array('[TICKET_LINE_ITEM_LIST]'), |
|
| 152 | + ), |
|
| 153 | + 'ticket_line_item_pms' => array( |
|
| 154 | + 'shortcodes' => array('line_item', 'ticket', 'line_item_list'), |
|
| 155 | + 'required' => array('[TICKET_LINE_ITEM_LIST]'), |
|
| 156 | + ), |
|
| 157 | + 'price_modifier_line_item_list' => array( |
|
| 158 | + 'shortcodes' => array('line_item'), |
|
| 159 | + 'required' => array('[PRICE_MODIFIER_LINE_ITEM_LIST]'), |
|
| 160 | + ), |
|
| 161 | + 'datetime_list' => array( |
|
| 162 | + 'shortcodes' => array('datetime'), |
|
| 163 | + 'required' => array('[DATETIME_LIST]'), |
|
| 164 | + ), |
|
| 165 | + 'attendee_list' => array( |
|
| 166 | + 'shortcodes' => array('attendee'), |
|
| 167 | + 'required' => array('[ATTENDEE_LIST]'), |
|
| 168 | + ), |
|
| 169 | + 'tax_line_item_list' => array( |
|
| 170 | + 'shortcodes' => array('line_item'), |
|
| 171 | + 'required' => array('[TAX_LINE_ITEM_LIST]'), |
|
| 172 | + ), |
|
| 173 | + 'additional_line_item_list' => array( |
|
| 174 | + 'shortcodes' => array('line_item'), |
|
| 175 | + 'required' => array('[ADDITIONAL_LINE_ITEM_LIST]'), |
|
| 176 | + ), |
|
| 177 | + 'payment_list' => array( |
|
| 178 | + 'shortcodes' => array('payment'), |
|
| 179 | + 'required' => array('[PAYMENT_LIST_*]'), |
|
| 180 | + ), |
|
| 181 | + ); |
|
| 182 | + } |
|
| 183 | + |
|
| 184 | + |
|
| 185 | + /** |
|
| 186 | + * This is a method called from EE_messages when this messenger is a generating messenger and the sending messenger |
|
| 187 | + * is a different messenger. Child messengers can set hooks for the sending messenger to callback on if necessary |
|
| 188 | + * (i.e. swap out css files or something else). |
|
| 189 | + * |
|
| 190 | + * @since 4.5.0 |
|
| 191 | + * @param string $sending_messenger_name the name of the sending messenger so we only set the hooks needed. |
|
| 192 | + * @return void |
|
| 193 | + */ |
|
| 194 | + public function do_secondary_messenger_hooks($sending_messenger_name) |
|
| 195 | + { |
|
| 196 | + if ($sending_messenger_name = 'pdf') { |
|
| 197 | + add_filter('EE_messenger__get_variation__variation', array($this, 'add_html_css'), 10, 8); |
|
| 198 | + } |
|
| 199 | + } |
|
| 200 | + |
|
| 201 | + |
|
| 202 | + /** |
|
| 203 | + * @param $variation_path |
|
| 204 | + * @param \EE_Messages_Template_Pack $template_pack |
|
| 205 | + * @param $messenger_name |
|
| 206 | + * @param $message_type_name |
|
| 207 | + * @param $url |
|
| 208 | + * @param $type |
|
| 209 | + * @param $variation |
|
| 210 | + * @param $skip_filters |
|
| 211 | + * @return string |
|
| 212 | + */ |
|
| 213 | + public function add_html_css( |
|
| 214 | + $variation_path, |
|
| 215 | + EE_Messages_Template_Pack $template_pack, |
|
| 216 | + $messenger_name, |
|
| 217 | + $message_type_name, |
|
| 218 | + $url, |
|
| 219 | + $type, |
|
| 220 | + $variation, |
|
| 221 | + $skip_filters |
|
| 222 | + ) { |
|
| 223 | + $variation = $template_pack->get_variation( |
|
| 224 | + $this->name, |
|
| 225 | + $message_type_name, |
|
| 226 | + $type, |
|
| 227 | + $variation, |
|
| 228 | + $url, |
|
| 229 | + '.css', |
|
| 230 | + $skip_filters |
|
| 231 | + ); |
|
| 232 | + return $variation; |
|
| 233 | + } |
|
| 234 | + |
|
| 235 | + |
|
| 236 | + /** |
|
| 237 | + * Takes care of enqueuing any necessary scripts or styles for the page. A do_action() so message types using this |
|
| 238 | + * messenger can add their own js. |
|
| 239 | + * |
|
| 240 | + * @return void. |
|
| 241 | + */ |
|
| 242 | + public function enqueue_scripts_styles() |
|
| 243 | + { |
|
| 244 | + parent::enqueue_scripts_styles(); |
|
| 245 | + do_action('AHEE__EE_Html_messenger__enqueue_scripts_styles'); |
|
| 246 | + } |
|
| 247 | + |
|
| 248 | + |
|
| 249 | + /** |
|
| 250 | + * _set_template_fields |
|
| 251 | + * This sets up the fields that a messenger requires for the message to go out. |
|
| 252 | + * |
|
| 253 | + * @access protected |
|
| 254 | + * @return void |
|
| 255 | + */ |
|
| 256 | + protected function _set_template_fields() |
|
| 257 | + { |
|
| 258 | + // any extra template fields that are NOT used by the messenger |
|
| 259 | + // but will get used by a messenger field for shortcode replacement |
|
| 260 | + // get added to the 'extra' key in an associated array |
|
| 261 | + // indexed by the messenger field they relate to. |
|
| 262 | + // This is important for the Messages_admin to know what fields to display to the user. |
|
| 263 | + // Also, notice that the "values" are equal to the field type |
|
| 264 | + // that messages admin will use to know what kind of field to display. |
|
| 265 | + // The values ALSO have one index labeled "shortcode". |
|
| 266 | + // The values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) |
|
| 267 | + // is required in order for this extra field to be displayed. |
|
| 268 | + // If the required shortcode isn't part of the shortcodes array |
|
| 269 | + // then the field is not needed and will not be displayed/parsed. |
|
| 270 | + $this->_template_fields = array( |
|
| 271 | + 'subject' => array( |
|
| 272 | + 'input' => 'text', |
|
| 273 | + 'label' => __('Page Title', 'event_espresso'), |
|
| 274 | + 'type' => 'string', |
|
| 275 | + 'required' => true, |
|
| 276 | + 'validation' => true, |
|
| 277 | + 'css_class' => 'large-text', |
|
| 278 | + 'format' => '%s', |
|
| 279 | + ), |
|
| 280 | + 'content' => '', |
|
| 281 | + // left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field. |
|
| 282 | + 'extra' => array( |
|
| 283 | + 'content' => array( |
|
| 284 | + 'main' => array( |
|
| 285 | + 'input' => 'wp_editor', |
|
| 286 | + 'label' => __('Main Content', 'event_espresso'), |
|
| 287 | + 'type' => 'string', |
|
| 288 | + 'required' => true, |
|
| 289 | + 'validation' => true, |
|
| 290 | + 'format' => '%s', |
|
| 291 | + 'rows' => '15', |
|
| 292 | + ), |
|
| 293 | + 'event_list' => array( |
|
| 294 | + 'input' => 'wp_editor', |
|
| 295 | + 'label' => '[EVENT_LIST]', |
|
| 296 | + 'type' => 'string', |
|
| 297 | + 'required' => true, |
|
| 298 | + 'validation' => true, |
|
| 299 | + 'format' => '%s', |
|
| 300 | + 'rows' => '15', |
|
| 301 | + 'shortcodes_required' => array('[EVENT_LIST]'), |
|
| 302 | + ), |
|
| 303 | + 'ticket_list' => array( |
|
| 304 | + 'input' => 'textarea', |
|
| 305 | + 'label' => '[TICKET_LIST]', |
|
| 306 | + 'type' => 'string', |
|
| 307 | + 'required' => true, |
|
| 308 | + 'validation' => true, |
|
| 309 | + 'format' => '%s', |
|
| 310 | + 'css_class' => 'large-text', |
|
| 311 | + 'rows' => '10', |
|
| 312 | + 'shortcodes_required' => array('[TICKET_LIST]'), |
|
| 313 | + ), |
|
| 314 | + 'ticket_line_item_no_pms' => array( |
|
| 315 | + 'input' => 'textarea', |
|
| 316 | + 'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __( |
|
| 317 | + 'Ticket Line Item List with no Price Modifiers', |
|
| 318 | + 'event_espresso' |
|
| 319 | + ), |
|
| 320 | + 'type' => 'string', |
|
| 321 | + 'required' => false, |
|
| 322 | + 'validation' => true, |
|
| 323 | + 'format' => '%s', |
|
| 324 | + 'css_class' => 'large-text', |
|
| 325 | + 'rows' => '5', |
|
| 326 | + 'shortcodes_required' => array('[TICKET_LINE_ITEM_LIST]'), |
|
| 327 | + ), |
|
| 328 | + 'ticket_line_item_pms' => array( |
|
| 329 | + 'input' => 'textarea', |
|
| 330 | + 'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __( |
|
| 331 | + 'Ticket Line Item List with Price Modifiers', |
|
| 332 | + 'event_espresso' |
|
| 333 | + ), |
|
| 334 | + 'type' => 'string', |
|
| 335 | + 'required' => false, |
|
| 336 | + 'validation' => true, |
|
| 337 | + 'format' => '%s', |
|
| 338 | + 'css_class' => 'large-text', |
|
| 339 | + 'rows' => '5', |
|
| 340 | + 'shortcodes_required' => array('[TICKET_LINE_ITEM_LIST]'), |
|
| 341 | + ), |
|
| 342 | + 'price_modifier_line_item_list' => array( |
|
| 343 | + 'input' => 'textarea', |
|
| 344 | + 'label' => '[PRICE_MODIFIER_LINE_ITEM_LIST]', |
|
| 345 | + 'type' => 'string', |
|
| 346 | + 'required' => false, |
|
| 347 | + 'validation' => true, |
|
| 348 | + 'format' => '%s', |
|
| 349 | + 'css_class' => 'large-text', |
|
| 350 | + 'rows' => '5', |
|
| 351 | + 'shortcodes_required' => array('[PRICE_MODIFIER_LINE_ITEM_LIST]'), |
|
| 352 | + ), |
|
| 353 | + 'datetime_list' => array( |
|
| 354 | + 'input' => 'textarea', |
|
| 355 | + 'label' => '[DATETIME_LIST]', |
|
| 356 | + 'type' => 'string', |
|
| 357 | + 'required' => true, |
|
| 358 | + 'validation' => true, |
|
| 359 | + 'format' => '%s', |
|
| 360 | + 'css_class' => 'large-text', |
|
| 361 | + 'rows' => '5', |
|
| 362 | + 'shortcodes_required' => array('[DATETIME_LIST]'), |
|
| 363 | + ), |
|
| 364 | + 'attendee_list' => array( |
|
| 365 | + 'input' => 'textarea', |
|
| 366 | + 'label' => '[ATTENDEE_LIST]', |
|
| 367 | + 'type' => 'string', |
|
| 368 | + 'required' => true, |
|
| 369 | + 'validation' => true, |
|
| 370 | + 'format' => '%s', |
|
| 371 | + 'css_class' => 'large-text', |
|
| 372 | + 'rows' => '5', |
|
| 373 | + 'shortcodes_required' => array('[ATTENDEE_LIST]'), |
|
| 374 | + ), |
|
| 375 | + 'tax_line_item_list' => array( |
|
| 376 | + 'input' => 'textarea', |
|
| 377 | + 'label' => '[TAX_LINE_ITEM_LIST]', |
|
| 378 | + 'type' => 'string', |
|
| 379 | + 'required' => false, |
|
| 380 | + 'validation' => true, |
|
| 381 | + 'format' => '%s', |
|
| 382 | + 'css_class' => 'large-text', |
|
| 383 | + 'rows' => '5', |
|
| 384 | + 'shortcodes_required' => array('[TAX_LINE_ITEM_LIST]'), |
|
| 385 | + ), |
|
| 386 | + 'additional_line_item_list' => array( |
|
| 387 | + 'input' => 'textarea', |
|
| 388 | + 'label' => '[ADDITIONAL_LINE_ITEM_LIST]', |
|
| 389 | + 'type' => 'string', |
|
| 390 | + 'required' => false, |
|
| 391 | + 'validation' => true, |
|
| 392 | + 'format' => '%s', |
|
| 393 | + 'css_class' => 'large-text', |
|
| 394 | + 'rows' => '5', |
|
| 395 | + 'shortcodes_required' => array('[ADDITIONAL_LINE_ITEM_LIST]'), |
|
| 396 | + ), |
|
| 397 | + 'payment_list' => array( |
|
| 398 | + 'input' => 'textarea', |
|
| 399 | + 'label' => '[PAYMENT_LIST]', |
|
| 400 | + 'type' => 'string', |
|
| 401 | + 'required' => true, |
|
| 402 | + 'validation' => true, |
|
| 403 | + 'format' => '%s', |
|
| 404 | + 'css_class' => 'large-text', |
|
| 405 | + 'rows' => '5', |
|
| 406 | + 'shortcodes_required' => array('[PAYMENT_LIST_*]'), |
|
| 407 | + ), |
|
| 408 | + ), |
|
| 409 | + ), |
|
| 410 | + ); |
|
| 411 | + } |
|
| 412 | + |
|
| 413 | + |
|
| 414 | + /** |
|
| 415 | + * @see definition of this method in parent |
|
| 416 | + * @since 4.5.0 |
|
| 417 | + */ |
|
| 418 | + protected function _set_default_message_types() |
|
| 419 | + { |
|
| 420 | + $this->_default_message_types = array('receipt', 'invoice'); |
|
| 421 | + } |
|
| 422 | + |
|
| 423 | + |
|
| 424 | + /** |
|
| 425 | + * @see definition of this method in parent |
|
| 426 | + * @since 4.5.0 |
|
| 427 | + */ |
|
| 428 | + protected function _set_valid_message_types() |
|
| 429 | + { |
|
| 430 | + $this->_valid_message_types = array('receipt', 'invoice'); |
|
| 431 | + } |
|
| 432 | + |
|
| 433 | + |
|
| 434 | + /** |
|
| 435 | + * Displays the message in the browser. |
|
| 436 | + * |
|
| 437 | + * @since 4.5.0 |
|
| 438 | + * @return string. |
|
| 439 | + */ |
|
| 440 | + protected function _send_message() |
|
| 441 | + { |
|
| 442 | + $this->_template_args = array( |
|
| 443 | + 'page_title' => $this->_subject, |
|
| 444 | + 'base_css' => $this->get_variation( |
|
| 445 | + $this->_tmp_pack, |
|
| 446 | + $this->_incoming_message_type->name, |
|
| 447 | + true, |
|
| 448 | + 'base', |
|
| 449 | + $this->_variation |
|
| 450 | + ), |
|
| 451 | + 'print_css' => $this->get_variation( |
|
| 452 | + $this->_tmp_pack, |
|
| 453 | + $this->_incoming_message_type->name, |
|
| 454 | + true, |
|
| 455 | + 'print', |
|
| 456 | + $this->_variation |
|
| 457 | + ), |
|
| 458 | + 'main_css' => $this->get_variation( |
|
| 459 | + $this->_tmp_pack, |
|
| 460 | + $this->_incoming_message_type->name, |
|
| 461 | + true, |
|
| 462 | + 'main', |
|
| 463 | + $this->_variation |
|
| 464 | + ), |
|
| 465 | + 'main_body' => wpautop( |
|
| 466 | + apply_filters( |
|
| 467 | + 'FHEE__EE_Html_messenger___send_message__main_body', |
|
| 468 | + $this->_content, |
|
| 469 | + $this->_content, |
|
| 470 | + $this->_incoming_message_type |
|
| 471 | + ) |
|
| 472 | + ) |
|
| 473 | + ); |
|
| 474 | + $this->_deregister_wp_hooks(); |
|
| 475 | + add_action('wp_enqueue_scripts', array($this, 'enqueue_scripts_styles')); |
|
| 476 | + echo $this->_get_main_template(); |
|
| 477 | + exit(); |
|
| 478 | + } |
|
| 479 | + |
|
| 480 | + |
|
| 481 | + /** |
|
| 482 | + * The purpose of this function is to de register all actions hooked into wp_head and wp_footer so that it doesn't |
|
| 483 | + * interfere with our templates. If users want to add any custom styles or scripts they must use the |
|
| 484 | + * AHEE__EE_Html_messenger__enqueue_scripts_styles hook. |
|
| 485 | + * |
|
| 486 | + * @since 4.5.0 |
|
| 487 | + * @return void |
|
| 488 | + */ |
|
| 489 | + protected function _deregister_wp_hooks() |
|
| 490 | + { |
|
| 491 | + remove_all_actions('wp_head'); |
|
| 492 | + remove_all_actions('wp_footer'); |
|
| 493 | + remove_all_actions('wp_print_footer_scripts'); |
|
| 494 | + remove_all_actions('wp_enqueue_scripts'); |
|
| 495 | + global $wp_scripts, $wp_styles; |
|
| 496 | + $wp_scripts = $wp_styles = array(); |
|
| 497 | + // just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load. |
|
| 498 | + add_action('wp_footer', 'wp_print_footer_scripts'); |
|
| 499 | + add_action('wp_print_footer_scripts', '_wp_footer_scripts'); |
|
| 500 | + add_action('wp_head', 'wp_enqueue_scripts'); |
|
| 501 | + } |
|
| 502 | + |
|
| 503 | + |
|
| 504 | + /** |
|
| 505 | + * Overwrite parent _get_main_template for display_html purposes. |
|
| 506 | + * |
|
| 507 | + * @since 4.5.0 |
|
| 508 | + * @param bool $preview |
|
| 509 | + * @return string |
|
| 510 | + */ |
|
| 511 | + protected function _get_main_template($preview = false) |
|
| 512 | + { |
|
| 513 | + $wrapper_template = $this->_tmp_pack->get_wrapper($this->name, 'main'); |
|
| 514 | + // include message type as a template arg |
|
| 515 | + $this->_template_args['message_type'] = $this->_incoming_message_type; |
|
| 516 | + return EEH_Template::display_template($wrapper_template, $this->_template_args, true); |
|
| 517 | + } |
|
| 518 | + |
|
| 519 | + |
|
| 520 | + /** |
|
| 521 | + * @return string |
|
| 522 | + */ |
|
| 523 | + protected function _preview() |
|
| 524 | + { |
|
| 525 | + return $this->_send_message(); |
|
| 526 | + } |
|
| 527 | + |
|
| 528 | + |
|
| 529 | + protected function _set_admin_settings_fields() |
|
| 530 | + { |
|
| 531 | + } |
|
| 532 | + |
|
| 533 | + |
|
| 534 | + /** |
|
| 535 | + * add the "powered by EE" credit link to the HTML receipt and invoice |
|
| 536 | + * |
|
| 537 | + * @param string $content |
|
| 538 | + * @param string $content_again |
|
| 539 | + * @param \EE_message_type $incoming_message_type |
|
| 540 | + * @return string |
|
| 541 | + */ |
|
| 542 | + public function add_powered_by_credit_link_to_receipt_and_invoice( |
|
| 543 | + $content = '', |
|
| 544 | + $content_again = '', |
|
| 545 | + EE_message_type $incoming_message_type |
|
| 546 | + ) { |
|
| 547 | + if (($incoming_message_type->name === 'invoice' || $incoming_message_type->name === 'receipt') |
|
| 548 | + && apply_filters('FHEE_EE_Html_messenger__add_powered_by_credit_link_to_receipt_and_invoice', true) |
|
| 549 | + ) { |
|
| 550 | + $content .= \EEH_Template::powered_by_event_espresso( |
|
| 551 | + 'aln-cntr', |
|
| 552 | + '', |
|
| 553 | + array('utm_content' => 'messages_system') |
|
| 554 | + ) |
|
| 555 | + . EEH_HTML::div(EEH_HTML::p(' ')); |
|
| 556 | + } |
|
| 557 | + return $content; |
|
| 558 | + } |
|
| 559 | 559 | } |
@@ -313,7 +313,7 @@ discard block |
||
| 313 | 313 | ), |
| 314 | 314 | 'ticket_line_item_no_pms' => array( |
| 315 | 315 | 'input' => 'textarea', |
| 316 | - 'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __( |
|
| 316 | + 'label' => '[TICKET_LINE_ITEM_LIST] <br>'.__( |
|
| 317 | 317 | 'Ticket Line Item List with no Price Modifiers', |
| 318 | 318 | 'event_espresso' |
| 319 | 319 | ), |
@@ -327,7 +327,7 @@ discard block |
||
| 327 | 327 | ), |
| 328 | 328 | 'ticket_line_item_pms' => array( |
| 329 | 329 | 'input' => 'textarea', |
| 330 | - 'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __( |
|
| 330 | + 'label' => '[TICKET_LINE_ITEM_LIST] <br>'.__( |
|
| 331 | 331 | 'Ticket Line Item List with Price Modifiers', |
| 332 | 332 | 'event_espresso' |
| 333 | 333 | ), |