@@ -19,45 +19,45 @@ |
||
| 19 | 19 | class VsprintfFilter extends FormHtmlFilter |
| 20 | 20 | { |
| 21 | 21 | |
| 22 | - /** |
|
| 23 | - * @var string $format |
|
| 24 | - */ |
|
| 25 | - protected $format = ''; |
|
| 26 | - |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * @var array $args |
|
| 30 | - */ |
|
| 31 | - protected $args = array(); |
|
| 32 | - |
|
| 33 | - |
|
| 34 | - /** |
|
| 35 | - * VsprintfFilter constructor. |
|
| 36 | - * |
|
| 37 | - * @param string $format |
|
| 38 | - * @param array $args |
|
| 39 | - */ |
|
| 40 | - public function __construct($format, array $args) |
|
| 41 | - { |
|
| 42 | - $this->format = $format; |
|
| 43 | - $this->args = $args; |
|
| 44 | - } |
|
| 45 | - |
|
| 46 | - |
|
| 47 | - /** |
|
| 48 | - * @param $html |
|
| 49 | - * @param EE_Form_Section_Validatable $form_section |
|
| 50 | - * @return string |
|
| 51 | - */ |
|
| 52 | - public function filterHtml($html, EE_Form_Section_Validatable $form_section) |
|
| 53 | - { |
|
| 54 | - $this->args[] = $html; |
|
| 55 | - if ($form_section instanceof EE_Form_Section_Proper) { |
|
| 56 | - $subsections = $form_section->subsections(); |
|
| 57 | - foreach ((array) $subsections as $subsection) { |
|
| 58 | - $this->args[] = $subsection->get_html(); |
|
| 59 | - } |
|
| 60 | - } |
|
| 61 | - return vsprintf($this->format, $this->args); |
|
| 62 | - } |
|
| 22 | + /** |
|
| 23 | + * @var string $format |
|
| 24 | + */ |
|
| 25 | + protected $format = ''; |
|
| 26 | + |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * @var array $args |
|
| 30 | + */ |
|
| 31 | + protected $args = array(); |
|
| 32 | + |
|
| 33 | + |
|
| 34 | + /** |
|
| 35 | + * VsprintfFilter constructor. |
|
| 36 | + * |
|
| 37 | + * @param string $format |
|
| 38 | + * @param array $args |
|
| 39 | + */ |
|
| 40 | + public function __construct($format, array $args) |
|
| 41 | + { |
|
| 42 | + $this->format = $format; |
|
| 43 | + $this->args = $args; |
|
| 44 | + } |
|
| 45 | + |
|
| 46 | + |
|
| 47 | + /** |
|
| 48 | + * @param $html |
|
| 49 | + * @param EE_Form_Section_Validatable $form_section |
|
| 50 | + * @return string |
|
| 51 | + */ |
|
| 52 | + public function filterHtml($html, EE_Form_Section_Validatable $form_section) |
|
| 53 | + { |
|
| 54 | + $this->args[] = $html; |
|
| 55 | + if ($form_section instanceof EE_Form_Section_Proper) { |
|
| 56 | + $subsections = $form_section->subsections(); |
|
| 57 | + foreach ((array) $subsections as $subsection) { |
|
| 58 | + $this->args[] = $subsection->get_html(); |
|
| 59 | + } |
|
| 60 | + } |
|
| 61 | + return vsprintf($this->format, $this->args); |
|
| 62 | + } |
|
| 63 | 63 | } |
@@ -17,287 +17,287 @@ |
||
| 17 | 17 | class CustomPostTypeDefinitions |
| 18 | 18 | { |
| 19 | 19 | |
| 20 | - /** |
|
| 21 | - * @var EE_Core_Config |
|
| 22 | - */ |
|
| 23 | - public $core_config; |
|
| 20 | + /** |
|
| 21 | + * @var EE_Core_Config |
|
| 22 | + */ |
|
| 23 | + public $core_config; |
|
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * @var array $custom_post_types |
|
| 27 | - */ |
|
| 28 | - private $custom_post_types; |
|
| 25 | + /** |
|
| 26 | + * @var array $custom_post_types |
|
| 27 | + */ |
|
| 28 | + private $custom_post_types; |
|
| 29 | 29 | |
| 30 | - /** |
|
| 31 | - * @var LoaderInterface $loader |
|
| 32 | - */ |
|
| 33 | - private $loader; |
|
| 30 | + /** |
|
| 31 | + * @var LoaderInterface $loader |
|
| 32 | + */ |
|
| 33 | + private $loader; |
|
| 34 | 34 | |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * EspressoCustomPostTypeDefinitions constructor. |
|
| 38 | - * |
|
| 39 | - * @param EE_Core_Config $core_config |
|
| 40 | - * @param LoaderInterface $loader |
|
| 41 | - */ |
|
| 42 | - public function __construct(EE_Core_Config $core_config, LoaderInterface $loader) |
|
| 43 | - { |
|
| 44 | - $this->core_config = $core_config; |
|
| 45 | - $this->loader = $loader; |
|
| 46 | - $this->setDefinitions(); |
|
| 47 | - } |
|
| 36 | + /** |
|
| 37 | + * EspressoCustomPostTypeDefinitions constructor. |
|
| 38 | + * |
|
| 39 | + * @param EE_Core_Config $core_config |
|
| 40 | + * @param LoaderInterface $loader |
|
| 41 | + */ |
|
| 42 | + public function __construct(EE_Core_Config $core_config, LoaderInterface $loader) |
|
| 43 | + { |
|
| 44 | + $this->core_config = $core_config; |
|
| 45 | + $this->loader = $loader; |
|
| 46 | + $this->setDefinitions(); |
|
| 47 | + } |
|
| 48 | 48 | |
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * defines Espresso Custom Post Types |
|
| 52 | - * NOTE the ['args']['page_templates'] array index is something specific to our CPTs |
|
| 53 | - * and not part of the WP custom post type api. |
|
| 54 | - * |
|
| 55 | - * @return void |
|
| 56 | - */ |
|
| 57 | - private function setDefinitions() |
|
| 58 | - { |
|
| 59 | - $this->custom_post_types = array( |
|
| 60 | - 'espresso_events' => array( |
|
| 61 | - 'singular_name' => esc_html__('Event', 'event_espresso'), |
|
| 62 | - 'plural_name' => esc_html__('Events', 'event_espresso'), |
|
| 63 | - 'singular_slug' => esc_html__('event', 'event_espresso'), |
|
| 64 | - 'plural_slug' => $this->core_config->event_cpt_slug, |
|
| 65 | - 'class_name' => 'EE_Event', |
|
| 66 | - 'model_name' => 'EEM_Event', |
|
| 67 | - 'args' => array( |
|
| 68 | - 'public' => true, |
|
| 69 | - 'show_in_nav_menus' => true, |
|
| 70 | - 'capability_type' => 'event', |
|
| 71 | - 'capabilities' => array( |
|
| 72 | - 'edit_post' => 'ee_edit_event', |
|
| 73 | - 'read_post' => 'ee_read_event', |
|
| 74 | - 'delete_post' => 'ee_delete_event', |
|
| 75 | - 'edit_posts' => 'ee_edit_events', |
|
| 76 | - 'edit_others_posts' => 'ee_edit_others_events', |
|
| 77 | - 'publish_posts' => 'ee_publish_events', |
|
| 78 | - 'read_private_posts' => 'ee_read_private_events', |
|
| 79 | - 'delete_posts' => 'ee_delete_events', |
|
| 80 | - 'delete_private_posts' => 'ee_delete_private_events', |
|
| 81 | - 'delete_published_posts' => 'ee_delete_published_events', |
|
| 82 | - 'delete_others_posts' => 'ee_delete_others_events', |
|
| 83 | - 'edit_private_posts' => 'ee_edit_private_events', |
|
| 84 | - 'edit_published_posts' => 'ee_edit_published_events', |
|
| 85 | - ), |
|
| 86 | - 'taxonomies' => array( |
|
| 87 | - 'espresso_event_categories', |
|
| 88 | - 'espresso_event_type', |
|
| 89 | - 'post_tag', |
|
| 90 | - ), |
|
| 91 | - 'page_templates' => true, |
|
| 92 | - ), |
|
| 93 | - ), |
|
| 94 | - 'espresso_venues' => array( |
|
| 95 | - 'singular_name' => esc_html__('Venue', 'event_espresso'), |
|
| 96 | - 'plural_name' => esc_html__('Venues', 'event_espresso'), |
|
| 97 | - 'singular_slug' => esc_html__('venue', 'event_espresso'), |
|
| 98 | - 'plural_slug' => esc_html__('venues', 'event_espresso'), |
|
| 99 | - 'class_name' => 'EE_Venue', |
|
| 100 | - 'model_name' => 'EEM_Venue', |
|
| 101 | - 'args' => array( |
|
| 102 | - 'public' => true, |
|
| 103 | - 'show_in_nav_menus' => false, // by default this doesn't show for decaf, |
|
| 104 | - 'capability_type' => 'venue', |
|
| 105 | - 'capabilities' => array( |
|
| 106 | - 'edit_post' => 'ee_edit_venue', |
|
| 107 | - 'read_post' => 'ee_read_venue', |
|
| 108 | - 'delete_post' => 'ee_delete_venue', |
|
| 109 | - 'edit_posts' => 'ee_edit_venues', |
|
| 110 | - 'edit_others_posts' => 'ee_edit_others_venues', |
|
| 111 | - 'publish_posts' => 'ee_publish_venues', |
|
| 112 | - 'read_private_posts' => 'ee_read_private_venues', |
|
| 113 | - 'delete_posts' => 'ee_delete_venues', |
|
| 114 | - 'delete_private_posts' => 'ee_delete_private_venues', |
|
| 115 | - 'delete_published_posts' => 'ee_delete_published_venues', |
|
| 116 | - 'delete_others_posts' => 'ee_edit_others_venues', |
|
| 117 | - 'edit_private_posts' => 'ee_edit_private_venues', |
|
| 118 | - 'edit_published_posts' => 'ee_edit_published_venues', |
|
| 119 | - ), |
|
| 120 | - 'taxonomies' => array( |
|
| 121 | - 'espresso_venue_categories', |
|
| 122 | - 'post_tag', |
|
| 123 | - ), |
|
| 124 | - 'page_templates' => true, |
|
| 125 | - ), |
|
| 126 | - ), |
|
| 127 | - 'espresso_attendees' => array( |
|
| 128 | - 'singular_name' => esc_html__('Contact', 'event_espresso'), |
|
| 129 | - 'plural_name' => esc_html__('Contacts', 'event_espresso'), |
|
| 130 | - 'singular_slug' => esc_html__('contact', 'event_espresso'), |
|
| 131 | - 'plural_slug' => esc_html__('contacts', 'event_espresso'), |
|
| 132 | - 'class_name' => 'EE_Attendee', |
|
| 133 | - 'model_name' => 'EEM_Attendee', |
|
| 134 | - 'args' => array( |
|
| 135 | - 'public' => false, |
|
| 136 | - 'publicly_queryable' => false, |
|
| 137 | - 'hierarchical' => false, |
|
| 138 | - 'has_archive' => false, |
|
| 139 | - 'supports' => array( |
|
| 140 | - 'editor', |
|
| 141 | - 'thumbnail', |
|
| 142 | - 'excerpt', |
|
| 143 | - 'custom-fields', |
|
| 144 | - 'comments', |
|
| 145 | - ), |
|
| 146 | - 'taxonomies' => array('post_tag'), |
|
| 147 | - 'capability_type' => 'contact', |
|
| 148 | - 'capabilities' => array( |
|
| 149 | - 'edit_post' => 'ee_edit_contact', |
|
| 150 | - 'read_post' => 'ee_read_contact', |
|
| 151 | - 'delete_post' => 'ee_delete_contact', |
|
| 152 | - 'edit_posts' => 'ee_edit_contacts', |
|
| 153 | - 'edit_others_posts' => 'ee_edit_contacts', |
|
| 154 | - 'publish_posts' => 'ee_edit_contacts', |
|
| 155 | - 'read_private_posts' => 'ee_edit_contacts', |
|
| 156 | - 'delete_posts' => 'ee_delete_contacts', |
|
| 157 | - 'delete_private_posts' => 'ee_delete_contacts', |
|
| 158 | - 'delete_published_posts' => 'ee_delete_contacts', |
|
| 159 | - 'delete_others_posts' => 'ee_delete_contacts', |
|
| 160 | - 'edit_private_posts' => 'ee_edit_contacts', |
|
| 161 | - 'edit_published_posts' => 'ee_edit_contacts', |
|
| 162 | - ), |
|
| 163 | - ), |
|
| 164 | - ), |
|
| 165 | - ); |
|
| 166 | - } |
|
| 50 | + /** |
|
| 51 | + * defines Espresso Custom Post Types |
|
| 52 | + * NOTE the ['args']['page_templates'] array index is something specific to our CPTs |
|
| 53 | + * and not part of the WP custom post type api. |
|
| 54 | + * |
|
| 55 | + * @return void |
|
| 56 | + */ |
|
| 57 | + private function setDefinitions() |
|
| 58 | + { |
|
| 59 | + $this->custom_post_types = array( |
|
| 60 | + 'espresso_events' => array( |
|
| 61 | + 'singular_name' => esc_html__('Event', 'event_espresso'), |
|
| 62 | + 'plural_name' => esc_html__('Events', 'event_espresso'), |
|
| 63 | + 'singular_slug' => esc_html__('event', 'event_espresso'), |
|
| 64 | + 'plural_slug' => $this->core_config->event_cpt_slug, |
|
| 65 | + 'class_name' => 'EE_Event', |
|
| 66 | + 'model_name' => 'EEM_Event', |
|
| 67 | + 'args' => array( |
|
| 68 | + 'public' => true, |
|
| 69 | + 'show_in_nav_menus' => true, |
|
| 70 | + 'capability_type' => 'event', |
|
| 71 | + 'capabilities' => array( |
|
| 72 | + 'edit_post' => 'ee_edit_event', |
|
| 73 | + 'read_post' => 'ee_read_event', |
|
| 74 | + 'delete_post' => 'ee_delete_event', |
|
| 75 | + 'edit_posts' => 'ee_edit_events', |
|
| 76 | + 'edit_others_posts' => 'ee_edit_others_events', |
|
| 77 | + 'publish_posts' => 'ee_publish_events', |
|
| 78 | + 'read_private_posts' => 'ee_read_private_events', |
|
| 79 | + 'delete_posts' => 'ee_delete_events', |
|
| 80 | + 'delete_private_posts' => 'ee_delete_private_events', |
|
| 81 | + 'delete_published_posts' => 'ee_delete_published_events', |
|
| 82 | + 'delete_others_posts' => 'ee_delete_others_events', |
|
| 83 | + 'edit_private_posts' => 'ee_edit_private_events', |
|
| 84 | + 'edit_published_posts' => 'ee_edit_published_events', |
|
| 85 | + ), |
|
| 86 | + 'taxonomies' => array( |
|
| 87 | + 'espresso_event_categories', |
|
| 88 | + 'espresso_event_type', |
|
| 89 | + 'post_tag', |
|
| 90 | + ), |
|
| 91 | + 'page_templates' => true, |
|
| 92 | + ), |
|
| 93 | + ), |
|
| 94 | + 'espresso_venues' => array( |
|
| 95 | + 'singular_name' => esc_html__('Venue', 'event_espresso'), |
|
| 96 | + 'plural_name' => esc_html__('Venues', 'event_espresso'), |
|
| 97 | + 'singular_slug' => esc_html__('venue', 'event_espresso'), |
|
| 98 | + 'plural_slug' => esc_html__('venues', 'event_espresso'), |
|
| 99 | + 'class_name' => 'EE_Venue', |
|
| 100 | + 'model_name' => 'EEM_Venue', |
|
| 101 | + 'args' => array( |
|
| 102 | + 'public' => true, |
|
| 103 | + 'show_in_nav_menus' => false, // by default this doesn't show for decaf, |
|
| 104 | + 'capability_type' => 'venue', |
|
| 105 | + 'capabilities' => array( |
|
| 106 | + 'edit_post' => 'ee_edit_venue', |
|
| 107 | + 'read_post' => 'ee_read_venue', |
|
| 108 | + 'delete_post' => 'ee_delete_venue', |
|
| 109 | + 'edit_posts' => 'ee_edit_venues', |
|
| 110 | + 'edit_others_posts' => 'ee_edit_others_venues', |
|
| 111 | + 'publish_posts' => 'ee_publish_venues', |
|
| 112 | + 'read_private_posts' => 'ee_read_private_venues', |
|
| 113 | + 'delete_posts' => 'ee_delete_venues', |
|
| 114 | + 'delete_private_posts' => 'ee_delete_private_venues', |
|
| 115 | + 'delete_published_posts' => 'ee_delete_published_venues', |
|
| 116 | + 'delete_others_posts' => 'ee_edit_others_venues', |
|
| 117 | + 'edit_private_posts' => 'ee_edit_private_venues', |
|
| 118 | + 'edit_published_posts' => 'ee_edit_published_venues', |
|
| 119 | + ), |
|
| 120 | + 'taxonomies' => array( |
|
| 121 | + 'espresso_venue_categories', |
|
| 122 | + 'post_tag', |
|
| 123 | + ), |
|
| 124 | + 'page_templates' => true, |
|
| 125 | + ), |
|
| 126 | + ), |
|
| 127 | + 'espresso_attendees' => array( |
|
| 128 | + 'singular_name' => esc_html__('Contact', 'event_espresso'), |
|
| 129 | + 'plural_name' => esc_html__('Contacts', 'event_espresso'), |
|
| 130 | + 'singular_slug' => esc_html__('contact', 'event_espresso'), |
|
| 131 | + 'plural_slug' => esc_html__('contacts', 'event_espresso'), |
|
| 132 | + 'class_name' => 'EE_Attendee', |
|
| 133 | + 'model_name' => 'EEM_Attendee', |
|
| 134 | + 'args' => array( |
|
| 135 | + 'public' => false, |
|
| 136 | + 'publicly_queryable' => false, |
|
| 137 | + 'hierarchical' => false, |
|
| 138 | + 'has_archive' => false, |
|
| 139 | + 'supports' => array( |
|
| 140 | + 'editor', |
|
| 141 | + 'thumbnail', |
|
| 142 | + 'excerpt', |
|
| 143 | + 'custom-fields', |
|
| 144 | + 'comments', |
|
| 145 | + ), |
|
| 146 | + 'taxonomies' => array('post_tag'), |
|
| 147 | + 'capability_type' => 'contact', |
|
| 148 | + 'capabilities' => array( |
|
| 149 | + 'edit_post' => 'ee_edit_contact', |
|
| 150 | + 'read_post' => 'ee_read_contact', |
|
| 151 | + 'delete_post' => 'ee_delete_contact', |
|
| 152 | + 'edit_posts' => 'ee_edit_contacts', |
|
| 153 | + 'edit_others_posts' => 'ee_edit_contacts', |
|
| 154 | + 'publish_posts' => 'ee_edit_contacts', |
|
| 155 | + 'read_private_posts' => 'ee_edit_contacts', |
|
| 156 | + 'delete_posts' => 'ee_delete_contacts', |
|
| 157 | + 'delete_private_posts' => 'ee_delete_contacts', |
|
| 158 | + 'delete_published_posts' => 'ee_delete_contacts', |
|
| 159 | + 'delete_others_posts' => 'ee_delete_contacts', |
|
| 160 | + 'edit_private_posts' => 'ee_edit_contacts', |
|
| 161 | + 'edit_published_posts' => 'ee_edit_contacts', |
|
| 162 | + ), |
|
| 163 | + ), |
|
| 164 | + ), |
|
| 165 | + ); |
|
| 166 | + } |
|
| 167 | 167 | |
| 168 | 168 | |
| 169 | - /** |
|
| 170 | - * @return array |
|
| 171 | - */ |
|
| 172 | - public function getDefinitions() |
|
| 173 | - { |
|
| 174 | - return (array) apply_filters( |
|
| 175 | - 'FHEE__EventEspresso_core_domain_entities_custom_post_types_CustomPostTypeDefinitions__getCustomPostTypes', |
|
| 176 | - // legacy filter applied for now, |
|
| 177 | - // later on we'll run a has_filter($tag) check and throw a doing_it_wrong() notice |
|
| 178 | - apply_filters( |
|
| 179 | - 'FHEE__EE_Register_CPTs__get_CPTs__cpts', |
|
| 180 | - $this->custom_post_types |
|
| 181 | - ) |
|
| 182 | - ); |
|
| 183 | - } |
|
| 169 | + /** |
|
| 170 | + * @return array |
|
| 171 | + */ |
|
| 172 | + public function getDefinitions() |
|
| 173 | + { |
|
| 174 | + return (array) apply_filters( |
|
| 175 | + 'FHEE__EventEspresso_core_domain_entities_custom_post_types_CustomPostTypeDefinitions__getCustomPostTypes', |
|
| 176 | + // legacy filter applied for now, |
|
| 177 | + // later on we'll run a has_filter($tag) check and throw a doing_it_wrong() notice |
|
| 178 | + apply_filters( |
|
| 179 | + 'FHEE__EE_Register_CPTs__get_CPTs__cpts', |
|
| 180 | + $this->custom_post_types |
|
| 181 | + ) |
|
| 182 | + ); |
|
| 183 | + } |
|
| 184 | 184 | |
| 185 | 185 | |
| 186 | - /** |
|
| 187 | - * @return array |
|
| 188 | - */ |
|
| 189 | - public function getCustomPostTypeSlugs() |
|
| 190 | - { |
|
| 191 | - return array_keys($this->getDefinitions()); |
|
| 192 | - } |
|
| 186 | + /** |
|
| 187 | + * @return array |
|
| 188 | + */ |
|
| 189 | + public function getCustomPostTypeSlugs() |
|
| 190 | + { |
|
| 191 | + return array_keys($this->getDefinitions()); |
|
| 192 | + } |
|
| 193 | 193 | |
| 194 | 194 | |
| 195 | - /** |
|
| 196 | - * This basically goes through the CPT array and returns only CPT's |
|
| 197 | - * that have the ['args']['public'] option set as false |
|
| 198 | - * |
|
| 199 | - * @return array |
|
| 200 | - */ |
|
| 201 | - public function getPrivateCustomPostTypes() |
|
| 202 | - { |
|
| 203 | - $private_CPTs = array(); |
|
| 204 | - foreach ($this->getDefinitions() as $CPT => $details) { |
|
| 205 | - if (empty($details['args']['public'])) { |
|
| 206 | - $private_CPTs[ $CPT ] = $details; |
|
| 207 | - } |
|
| 208 | - } |
|
| 209 | - return $private_CPTs; |
|
| 210 | - } |
|
| 195 | + /** |
|
| 196 | + * This basically goes through the CPT array and returns only CPT's |
|
| 197 | + * that have the ['args']['public'] option set as false |
|
| 198 | + * |
|
| 199 | + * @return array |
|
| 200 | + */ |
|
| 201 | + public function getPrivateCustomPostTypes() |
|
| 202 | + { |
|
| 203 | + $private_CPTs = array(); |
|
| 204 | + foreach ($this->getDefinitions() as $CPT => $details) { |
|
| 205 | + if (empty($details['args']['public'])) { |
|
| 206 | + $private_CPTs[ $CPT ] = $details; |
|
| 207 | + } |
|
| 208 | + } |
|
| 209 | + return $private_CPTs; |
|
| 210 | + } |
|
| 211 | 211 | |
| 212 | 212 | |
| 213 | - /** |
|
| 214 | - * This returns the corresponding model name for cpts registered by EE. |
|
| 215 | - * |
|
| 216 | - * @param string $post_type_slug If a slug is included, then attempt to retrieve |
|
| 217 | - * the model name for the given cpt slug. |
|
| 218 | - * Otherwise if empty, then we'll return |
|
| 219 | - * all cpt model names for cpts registered in EE. |
|
| 220 | - * @return array Empty array if no matching model names for the given slug |
|
| 221 | - * or an array of model names indexed by post type slug. |
|
| 222 | - */ |
|
| 223 | - public function getCustomPostTypeModelNames($post_type_slug = '') |
|
| 224 | - { |
|
| 225 | - $cpts = $this->getDefinitions(); |
|
| 226 | - // first if slug passed in... |
|
| 227 | - if (! empty($post_type_slug)) { |
|
| 228 | - // check that slug and cpt match |
|
| 229 | - if (! isset($cpts[ $post_type_slug ])) { |
|
| 230 | - return array(); |
|
| 231 | - } |
|
| 232 | - if (empty($cpts[ $post_type_slug ]['class_name']) |
|
| 233 | - && empty($cpts[ $post_type_slug ]['model_name']) |
|
| 234 | - ) { |
|
| 235 | - return array(); |
|
| 236 | - } |
|
| 237 | - // k let's get the model name for this cpt. |
|
| 238 | - return $this->getCustomPostTypeModelName($post_type_slug, $cpts[ $post_type_slug ]); |
|
| 239 | - } |
|
| 240 | - // if we made it here then we're returning an array of cpt model names indexed by post_type_slug. |
|
| 241 | - $cpt_models = array(); |
|
| 242 | - foreach ($cpts as $slug => $args) { |
|
| 243 | - $model = $this->getCustomPostTypeModelName($post_type_slug, $cpts[ $post_type_slug ]); |
|
| 244 | - if (! empty($model)) { |
|
| 245 | - $cpt_models[ $slug ] = $model; |
|
| 246 | - } |
|
| 247 | - } |
|
| 248 | - return $cpt_models; |
|
| 249 | - } |
|
| 213 | + /** |
|
| 214 | + * This returns the corresponding model name for cpts registered by EE. |
|
| 215 | + * |
|
| 216 | + * @param string $post_type_slug If a slug is included, then attempt to retrieve |
|
| 217 | + * the model name for the given cpt slug. |
|
| 218 | + * Otherwise if empty, then we'll return |
|
| 219 | + * all cpt model names for cpts registered in EE. |
|
| 220 | + * @return array Empty array if no matching model names for the given slug |
|
| 221 | + * or an array of model names indexed by post type slug. |
|
| 222 | + */ |
|
| 223 | + public function getCustomPostTypeModelNames($post_type_slug = '') |
|
| 224 | + { |
|
| 225 | + $cpts = $this->getDefinitions(); |
|
| 226 | + // first if slug passed in... |
|
| 227 | + if (! empty($post_type_slug)) { |
|
| 228 | + // check that slug and cpt match |
|
| 229 | + if (! isset($cpts[ $post_type_slug ])) { |
|
| 230 | + return array(); |
|
| 231 | + } |
|
| 232 | + if (empty($cpts[ $post_type_slug ]['class_name']) |
|
| 233 | + && empty($cpts[ $post_type_slug ]['model_name']) |
|
| 234 | + ) { |
|
| 235 | + return array(); |
|
| 236 | + } |
|
| 237 | + // k let's get the model name for this cpt. |
|
| 238 | + return $this->getCustomPostTypeModelName($post_type_slug, $cpts[ $post_type_slug ]); |
|
| 239 | + } |
|
| 240 | + // if we made it here then we're returning an array of cpt model names indexed by post_type_slug. |
|
| 241 | + $cpt_models = array(); |
|
| 242 | + foreach ($cpts as $slug => $args) { |
|
| 243 | + $model = $this->getCustomPostTypeModelName($post_type_slug, $cpts[ $post_type_slug ]); |
|
| 244 | + if (! empty($model)) { |
|
| 245 | + $cpt_models[ $slug ] = $model; |
|
| 246 | + } |
|
| 247 | + } |
|
| 248 | + return $cpt_models; |
|
| 249 | + } |
|
| 250 | 250 | |
| 251 | 251 | |
| 252 | - /** |
|
| 253 | - * @param $post_type_slug |
|
| 254 | - * @param array $cpt |
|
| 255 | - * @return array |
|
| 256 | - */ |
|
| 257 | - private function getCustomPostTypeModelName($post_type_slug, array $cpt) |
|
| 258 | - { |
|
| 259 | - if (! empty($cpt['model_name'])) { |
|
| 260 | - return array($post_type_slug => $cpt['model_name']); |
|
| 261 | - } |
|
| 262 | - if (! empty($cpt['class_name'])) { |
|
| 263 | - return array( |
|
| 264 | - $post_type_slug => $this->deriveCptModelNameFromClassName($cpt['class_name']), |
|
| 265 | - ); |
|
| 266 | - } |
|
| 267 | - return array(); |
|
| 268 | - } |
|
| 252 | + /** |
|
| 253 | + * @param $post_type_slug |
|
| 254 | + * @param array $cpt |
|
| 255 | + * @return array |
|
| 256 | + */ |
|
| 257 | + private function getCustomPostTypeModelName($post_type_slug, array $cpt) |
|
| 258 | + { |
|
| 259 | + if (! empty($cpt['model_name'])) { |
|
| 260 | + return array($post_type_slug => $cpt['model_name']); |
|
| 261 | + } |
|
| 262 | + if (! empty($cpt['class_name'])) { |
|
| 263 | + return array( |
|
| 264 | + $post_type_slug => $this->deriveCptModelNameFromClassName($cpt['class_name']), |
|
| 265 | + ); |
|
| 266 | + } |
|
| 267 | + return array(); |
|
| 268 | + } |
|
| 269 | 269 | |
| 270 | 270 | |
| 271 | - /** |
|
| 272 | - * @param string $class_name |
|
| 273 | - * @return string |
|
| 274 | - */ |
|
| 275 | - private function deriveCptModelNameFromClassName($class_name) |
|
| 276 | - { |
|
| 277 | - return str_replace('EE', 'EEM', $class_name); |
|
| 278 | - } |
|
| 271 | + /** |
|
| 272 | + * @param string $class_name |
|
| 273 | + * @return string |
|
| 274 | + */ |
|
| 275 | + private function deriveCptModelNameFromClassName($class_name) |
|
| 276 | + { |
|
| 277 | + return str_replace('EE', 'EEM', $class_name); |
|
| 278 | + } |
|
| 279 | 279 | |
| 280 | 280 | |
| 281 | - /** |
|
| 282 | - * This instantiates cpt models related to the cpts registered via EE. |
|
| 283 | - * |
|
| 284 | - * @since 4.6.16.rc.000 |
|
| 285 | - * @param string $post_type_slug If valid slug is provided, then will instantiate the model only for |
|
| 286 | - * the cpt matching the given slug. Otherwise all cpt models will be |
|
| 287 | - * instantiated (if possible). |
|
| 288 | - * @return EEM_CPT_Base[] successful instantiation will return an array of successfully instantiated |
|
| 289 | - * EEM models indexed by post slug. |
|
| 290 | - */ |
|
| 291 | - public function getCustomPostTypeModels($post_type_slug = '') |
|
| 292 | - { |
|
| 293 | - $cpt_model_names = $this->getCustomPostTypeModelNames($post_type_slug); |
|
| 294 | - $instantiated = array(); |
|
| 295 | - foreach ($cpt_model_names as $slug => $model_name) { |
|
| 296 | - $model = $this->loader->getShared($model_name); |
|
| 297 | - if ($model instanceof EEM_CPT_Base) { |
|
| 298 | - $instantiated[ $slug ] = $model; |
|
| 299 | - } |
|
| 300 | - } |
|
| 301 | - return $instantiated; |
|
| 302 | - } |
|
| 281 | + /** |
|
| 282 | + * This instantiates cpt models related to the cpts registered via EE. |
|
| 283 | + * |
|
| 284 | + * @since 4.6.16.rc.000 |
|
| 285 | + * @param string $post_type_slug If valid slug is provided, then will instantiate the model only for |
|
| 286 | + * the cpt matching the given slug. Otherwise all cpt models will be |
|
| 287 | + * instantiated (if possible). |
|
| 288 | + * @return EEM_CPT_Base[] successful instantiation will return an array of successfully instantiated |
|
| 289 | + * EEM models indexed by post slug. |
|
| 290 | + */ |
|
| 291 | + public function getCustomPostTypeModels($post_type_slug = '') |
|
| 292 | + { |
|
| 293 | + $cpt_model_names = $this->getCustomPostTypeModelNames($post_type_slug); |
|
| 294 | + $instantiated = array(); |
|
| 295 | + foreach ($cpt_model_names as $slug => $model_name) { |
|
| 296 | + $model = $this->loader->getShared($model_name); |
|
| 297 | + if ($model instanceof EEM_CPT_Base) { |
|
| 298 | + $instantiated[ $slug ] = $model; |
|
| 299 | + } |
|
| 300 | + } |
|
| 301 | + return $instantiated; |
|
| 302 | + } |
|
| 303 | 303 | } |
@@ -203,7 +203,7 @@ discard block |
||
| 203 | 203 | $private_CPTs = array(); |
| 204 | 204 | foreach ($this->getDefinitions() as $CPT => $details) { |
| 205 | 205 | if (empty($details['args']['public'])) { |
| 206 | - $private_CPTs[ $CPT ] = $details; |
|
| 206 | + $private_CPTs[$CPT] = $details; |
|
| 207 | 207 | } |
| 208 | 208 | } |
| 209 | 209 | return $private_CPTs; |
@@ -224,25 +224,25 @@ discard block |
||
| 224 | 224 | { |
| 225 | 225 | $cpts = $this->getDefinitions(); |
| 226 | 226 | // first if slug passed in... |
| 227 | - if (! empty($post_type_slug)) { |
|
| 227 | + if ( ! empty($post_type_slug)) { |
|
| 228 | 228 | // check that slug and cpt match |
| 229 | - if (! isset($cpts[ $post_type_slug ])) { |
|
| 229 | + if ( ! isset($cpts[$post_type_slug])) { |
|
| 230 | 230 | return array(); |
| 231 | 231 | } |
| 232 | - if (empty($cpts[ $post_type_slug ]['class_name']) |
|
| 233 | - && empty($cpts[ $post_type_slug ]['model_name']) |
|
| 232 | + if (empty($cpts[$post_type_slug]['class_name']) |
|
| 233 | + && empty($cpts[$post_type_slug]['model_name']) |
|
| 234 | 234 | ) { |
| 235 | 235 | return array(); |
| 236 | 236 | } |
| 237 | 237 | // k let's get the model name for this cpt. |
| 238 | - return $this->getCustomPostTypeModelName($post_type_slug, $cpts[ $post_type_slug ]); |
|
| 238 | + return $this->getCustomPostTypeModelName($post_type_slug, $cpts[$post_type_slug]); |
|
| 239 | 239 | } |
| 240 | 240 | // if we made it here then we're returning an array of cpt model names indexed by post_type_slug. |
| 241 | 241 | $cpt_models = array(); |
| 242 | 242 | foreach ($cpts as $slug => $args) { |
| 243 | - $model = $this->getCustomPostTypeModelName($post_type_slug, $cpts[ $post_type_slug ]); |
|
| 244 | - if (! empty($model)) { |
|
| 245 | - $cpt_models[ $slug ] = $model; |
|
| 243 | + $model = $this->getCustomPostTypeModelName($post_type_slug, $cpts[$post_type_slug]); |
|
| 244 | + if ( ! empty($model)) { |
|
| 245 | + $cpt_models[$slug] = $model; |
|
| 246 | 246 | } |
| 247 | 247 | } |
| 248 | 248 | return $cpt_models; |
@@ -256,10 +256,10 @@ discard block |
||
| 256 | 256 | */ |
| 257 | 257 | private function getCustomPostTypeModelName($post_type_slug, array $cpt) |
| 258 | 258 | { |
| 259 | - if (! empty($cpt['model_name'])) { |
|
| 259 | + if ( ! empty($cpt['model_name'])) { |
|
| 260 | 260 | return array($post_type_slug => $cpt['model_name']); |
| 261 | 261 | } |
| 262 | - if (! empty($cpt['class_name'])) { |
|
| 262 | + if ( ! empty($cpt['class_name'])) { |
|
| 263 | 263 | return array( |
| 264 | 264 | $post_type_slug => $this->deriveCptModelNameFromClassName($cpt['class_name']), |
| 265 | 265 | ); |
@@ -295,7 +295,7 @@ discard block |
||
| 295 | 295 | foreach ($cpt_model_names as $slug => $model_name) { |
| 296 | 296 | $model = $this->loader->getShared($model_name); |
| 297 | 297 | if ($model instanceof EEM_CPT_Base) { |
| 298 | - $instantiated[ $slug ] = $model; |
|
| 298 | + $instantiated[$slug] = $model; |
|
| 299 | 299 | } |
| 300 | 300 | } |
| 301 | 301 | return $instantiated; |
@@ -18,97 +18,97 @@ |
||
| 18 | 18 | class RegUrlLink |
| 19 | 19 | { |
| 20 | 20 | |
| 21 | - /* |
|
| 21 | + /* |
|
| 22 | 22 | * @var string $reg_url_link |
| 23 | 23 | */ |
| 24 | - private $reg_url_link; |
|
| 24 | + private $reg_url_link; |
|
| 25 | 25 | |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * @param string $reg_url_link |
|
| 29 | - * @return RegUrlLink |
|
| 30 | - * @throws InvalidArgumentException |
|
| 31 | - */ |
|
| 32 | - public static function fromRegUrlLinkString($reg_url_link) |
|
| 33 | - { |
|
| 34 | - if (empty($reg_url_link) || ! is_string($reg_url_link)) { |
|
| 35 | - throw new InvalidArgumentException( |
|
| 36 | - __( |
|
| 37 | - 'You must supply a valid non-empty string to generate a reg_url_link.', |
|
| 38 | - 'event_espresso' |
|
| 39 | - ) |
|
| 40 | - ); |
|
| 41 | - } |
|
| 42 | - return new RegUrlLink(1, '', $reg_url_link); |
|
| 43 | - } |
|
| 27 | + /** |
|
| 28 | + * @param string $reg_url_link |
|
| 29 | + * @return RegUrlLink |
|
| 30 | + * @throws InvalidArgumentException |
|
| 31 | + */ |
|
| 32 | + public static function fromRegUrlLinkString($reg_url_link) |
|
| 33 | + { |
|
| 34 | + if (empty($reg_url_link) || ! is_string($reg_url_link)) { |
|
| 35 | + throw new InvalidArgumentException( |
|
| 36 | + __( |
|
| 37 | + 'You must supply a valid non-empty string to generate a reg_url_link.', |
|
| 38 | + 'event_espresso' |
|
| 39 | + ) |
|
| 40 | + ); |
|
| 41 | + } |
|
| 42 | + return new RegUrlLink(1, '', $reg_url_link); |
|
| 43 | + } |
|
| 44 | 44 | |
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * @param EE_Registration $registration |
|
| 48 | - * @return RegUrlLink |
|
| 49 | - * @throws EntityNotFoundException |
|
| 50 | - * @throws EE_Error |
|
| 51 | - * @throws InvalidArgumentException |
|
| 52 | - */ |
|
| 53 | - public static function fromRegistration(EE_Registration $registration) |
|
| 54 | - { |
|
| 55 | - return new RegUrlLink( |
|
| 56 | - $registration->count(), |
|
| 57 | - $registration->ticket_line_item() |
|
| 58 | - ); |
|
| 59 | - } |
|
| 46 | + /** |
|
| 47 | + * @param EE_Registration $registration |
|
| 48 | + * @return RegUrlLink |
|
| 49 | + * @throws EntityNotFoundException |
|
| 50 | + * @throws EE_Error |
|
| 51 | + * @throws InvalidArgumentException |
|
| 52 | + */ |
|
| 53 | + public static function fromRegistration(EE_Registration $registration) |
|
| 54 | + { |
|
| 55 | + return new RegUrlLink( |
|
| 56 | + $registration->count(), |
|
| 57 | + $registration->ticket_line_item() |
|
| 58 | + ); |
|
| 59 | + } |
|
| 60 | 60 | |
| 61 | 61 | |
| 62 | - /** |
|
| 63 | - * CreateRegUrlLinkCommand constructor. |
|
| 64 | - * |
|
| 65 | - * @param int $reg_count |
|
| 66 | - * @param mixed $base_code |
|
| 67 | - * @param string $reg_url_link |
|
| 68 | - * @throws InvalidArgumentException |
|
| 69 | - */ |
|
| 70 | - public function __construct( |
|
| 71 | - $reg_count = 1, |
|
| 72 | - $base_code = '', |
|
| 73 | - $reg_url_link = '' |
|
| 74 | - ) { |
|
| 75 | - if (! empty($reg_url_link) && is_string($reg_url_link)) { |
|
| 76 | - $this->reg_url_link = apply_filters( |
|
| 77 | - 'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link', |
|
| 78 | - $reg_url_link, |
|
| 79 | - $reg_count, |
|
| 80 | - $base_code, |
|
| 81 | - $reg_url_link |
|
| 82 | - ); |
|
| 83 | - return; |
|
| 84 | - } |
|
| 85 | - $reg_count = max(1, absint($reg_count)); |
|
| 86 | - $base_code = $base_code instanceof \EE_Line_Item ? $base_code->code() : $base_code; |
|
| 87 | - if (empty($base_code) || ! is_string($base_code)) { |
|
| 88 | - throw new InvalidArgumentException( |
|
| 89 | - __( |
|
| 90 | - 'You must supply a valid EE_Line_Item or a non-empty string to generate a reg_url_link.', |
|
| 91 | - 'event_espresso' |
|
| 92 | - ) |
|
| 93 | - ); |
|
| 94 | - } |
|
| 95 | - $this->reg_url_link = (string) apply_filters( |
|
| 96 | - 'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link', |
|
| 97 | - $reg_count . '-' . md5($base_code . microtime()), |
|
| 98 | - $reg_count, |
|
| 99 | - $base_code, |
|
| 100 | - $reg_url_link |
|
| 101 | - ); |
|
| 102 | - } |
|
| 62 | + /** |
|
| 63 | + * CreateRegUrlLinkCommand constructor. |
|
| 64 | + * |
|
| 65 | + * @param int $reg_count |
|
| 66 | + * @param mixed $base_code |
|
| 67 | + * @param string $reg_url_link |
|
| 68 | + * @throws InvalidArgumentException |
|
| 69 | + */ |
|
| 70 | + public function __construct( |
|
| 71 | + $reg_count = 1, |
|
| 72 | + $base_code = '', |
|
| 73 | + $reg_url_link = '' |
|
| 74 | + ) { |
|
| 75 | + if (! empty($reg_url_link) && is_string($reg_url_link)) { |
|
| 76 | + $this->reg_url_link = apply_filters( |
|
| 77 | + 'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link', |
|
| 78 | + $reg_url_link, |
|
| 79 | + $reg_count, |
|
| 80 | + $base_code, |
|
| 81 | + $reg_url_link |
|
| 82 | + ); |
|
| 83 | + return; |
|
| 84 | + } |
|
| 85 | + $reg_count = max(1, absint($reg_count)); |
|
| 86 | + $base_code = $base_code instanceof \EE_Line_Item ? $base_code->code() : $base_code; |
|
| 87 | + if (empty($base_code) || ! is_string($base_code)) { |
|
| 88 | + throw new InvalidArgumentException( |
|
| 89 | + __( |
|
| 90 | + 'You must supply a valid EE_Line_Item or a non-empty string to generate a reg_url_link.', |
|
| 91 | + 'event_espresso' |
|
| 92 | + ) |
|
| 93 | + ); |
|
| 94 | + } |
|
| 95 | + $this->reg_url_link = (string) apply_filters( |
|
| 96 | + 'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link', |
|
| 97 | + $reg_count . '-' . md5($base_code . microtime()), |
|
| 98 | + $reg_count, |
|
| 99 | + $base_code, |
|
| 100 | + $reg_url_link |
|
| 101 | + ); |
|
| 102 | + } |
|
| 103 | 103 | |
| 104 | 104 | |
| 105 | - /** |
|
| 106 | - * Return the object as a string |
|
| 107 | - * |
|
| 108 | - * @return string |
|
| 109 | - */ |
|
| 110 | - public function __toString() |
|
| 111 | - { |
|
| 112 | - return $this->reg_url_link; |
|
| 113 | - } |
|
| 105 | + /** |
|
| 106 | + * Return the object as a string |
|
| 107 | + * |
|
| 108 | + * @return string |
|
| 109 | + */ |
|
| 110 | + public function __toString() |
|
| 111 | + { |
|
| 112 | + return $this->reg_url_link; |
|
| 113 | + } |
|
| 114 | 114 | } |
@@ -72,7 +72,7 @@ discard block |
||
| 72 | 72 | $base_code = '', |
| 73 | 73 | $reg_url_link = '' |
| 74 | 74 | ) { |
| 75 | - if (! empty($reg_url_link) && is_string($reg_url_link)) { |
|
| 75 | + if ( ! empty($reg_url_link) && is_string($reg_url_link)) { |
|
| 76 | 76 | $this->reg_url_link = apply_filters( |
| 77 | 77 | 'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link', |
| 78 | 78 | $reg_url_link, |
@@ -94,7 +94,7 @@ discard block |
||
| 94 | 94 | } |
| 95 | 95 | $this->reg_url_link = (string) apply_filters( |
| 96 | 96 | 'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link', |
| 97 | - $reg_count . '-' . md5($base_code . microtime()), |
|
| 97 | + $reg_count.'-'.md5($base_code.microtime()), |
|
| 98 | 98 | $reg_count, |
| 99 | 99 | $base_code, |
| 100 | 100 | $reg_url_link |
@@ -30,132 +30,132 @@ |
||
| 30 | 30 | { |
| 31 | 31 | |
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * the actual shortcode tag that gets registered with WordPress |
|
| 35 | - * |
|
| 36 | - * @return string |
|
| 37 | - */ |
|
| 38 | - public function getTag() |
|
| 39 | - { |
|
| 40 | - return 'ESPRESSO_EVENTS'; |
|
| 41 | - } |
|
| 33 | + /** |
|
| 34 | + * the actual shortcode tag that gets registered with WordPress |
|
| 35 | + * |
|
| 36 | + * @return string |
|
| 37 | + */ |
|
| 38 | + public function getTag() |
|
| 39 | + { |
|
| 40 | + return 'ESPRESSO_EVENTS'; |
|
| 41 | + } |
|
| 42 | 42 | |
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * the time in seconds to cache the results of the processShortcode() method |
|
| 46 | - * 0 means the processShortcode() results will NOT be cached at all |
|
| 47 | - * |
|
| 48 | - * @return int |
|
| 49 | - */ |
|
| 50 | - public function cacheExpiration() |
|
| 51 | - { |
|
| 52 | - return 0; |
|
| 53 | - } |
|
| 44 | + /** |
|
| 45 | + * the time in seconds to cache the results of the processShortcode() method |
|
| 46 | + * 0 means the processShortcode() results will NOT be cached at all |
|
| 47 | + * |
|
| 48 | + * @return int |
|
| 49 | + */ |
|
| 50 | + public function cacheExpiration() |
|
| 51 | + { |
|
| 52 | + return 0; |
|
| 53 | + } |
|
| 54 | 54 | |
| 55 | 55 | |
| 56 | - /** |
|
| 57 | - * a place for adding any initialization code that needs to run prior to wp_header(). |
|
| 58 | - * this may be required for shortcodes that utilize a corresponding module, |
|
| 59 | - * and need to enqueue assets for that module |
|
| 60 | - * |
|
| 61 | - * @return void |
|
| 62 | - */ |
|
| 63 | - public function initializeShortcode() |
|
| 64 | - { |
|
| 65 | - EED_Events_Archive::instance()->event_list(); |
|
| 66 | - $this->shortcodeHasBeenInitialized(); |
|
| 67 | - } |
|
| 56 | + /** |
|
| 57 | + * a place for adding any initialization code that needs to run prior to wp_header(). |
|
| 58 | + * this may be required for shortcodes that utilize a corresponding module, |
|
| 59 | + * and need to enqueue assets for that module |
|
| 60 | + * |
|
| 61 | + * @return void |
|
| 62 | + */ |
|
| 63 | + public function initializeShortcode() |
|
| 64 | + { |
|
| 65 | + EED_Events_Archive::instance()->event_list(); |
|
| 66 | + $this->shortcodeHasBeenInitialized(); |
|
| 67 | + } |
|
| 68 | 68 | |
| 69 | 69 | |
| 70 | - /** |
|
| 71 | - * callback that runs when the shortcode is encountered in post content. |
|
| 72 | - * IMPORTANT !!! |
|
| 73 | - * remember that shortcode content should be RETURNED and NOT echoed out |
|
| 74 | - * |
|
| 75 | - * @param array $attributes |
|
| 76 | - * @return string |
|
| 77 | - */ |
|
| 78 | - public function processShortcode($attributes = array()) |
|
| 79 | - { |
|
| 80 | - // grab attributes and merge with defaults |
|
| 81 | - $attributes = $this->getAttributes($attributes); |
|
| 82 | - // make sure we use the_excerpt() |
|
| 83 | - add_filter('FHEE__EES_Espresso_Events__process_shortcode__true', '__return_true'); |
|
| 84 | - // apply query filters |
|
| 85 | - add_filter('FHEE__EEH_Event_Query__apply_query_filters', '__return_true'); |
|
| 86 | - // run the query |
|
| 87 | - global $wp_query; |
|
| 88 | - // yes we have to overwrite the main wp query, but it's ok... |
|
| 89 | - // we're going to reset it again below, so everything will be Hunky Dory (amazing album) |
|
| 90 | - $wp_query = new EventListQuery($attributes); |
|
| 91 | - // check what template is loaded and load filters accordingly |
|
| 92 | - EED_Events_Archive::instance()->template_include('loop-espresso_events.php'); |
|
| 93 | - // load our template |
|
| 94 | - $event_list = EEH_Template::locate_template( |
|
| 95 | - 'loop-espresso_events.php', |
|
| 96 | - array(), |
|
| 97 | - true, |
|
| 98 | - true |
|
| 99 | - ); |
|
| 100 | - // now reset the query and post data |
|
| 101 | - wp_reset_query(); |
|
| 102 | - wp_reset_postdata(); |
|
| 103 | - EED_Events_Archive::remove_all_events_archive_filters(); |
|
| 104 | - // remove query filters |
|
| 105 | - remove_filter('FHEE__EEH_Event_Query__apply_query_filters', '__return_true'); |
|
| 106 | - // pull our content from the output buffer and return it |
|
| 107 | - return $event_list; |
|
| 108 | - } |
|
| 70 | + /** |
|
| 71 | + * callback that runs when the shortcode is encountered in post content. |
|
| 72 | + * IMPORTANT !!! |
|
| 73 | + * remember that shortcode content should be RETURNED and NOT echoed out |
|
| 74 | + * |
|
| 75 | + * @param array $attributes |
|
| 76 | + * @return string |
|
| 77 | + */ |
|
| 78 | + public function processShortcode($attributes = array()) |
|
| 79 | + { |
|
| 80 | + // grab attributes and merge with defaults |
|
| 81 | + $attributes = $this->getAttributes($attributes); |
|
| 82 | + // make sure we use the_excerpt() |
|
| 83 | + add_filter('FHEE__EES_Espresso_Events__process_shortcode__true', '__return_true'); |
|
| 84 | + // apply query filters |
|
| 85 | + add_filter('FHEE__EEH_Event_Query__apply_query_filters', '__return_true'); |
|
| 86 | + // run the query |
|
| 87 | + global $wp_query; |
|
| 88 | + // yes we have to overwrite the main wp query, but it's ok... |
|
| 89 | + // we're going to reset it again below, so everything will be Hunky Dory (amazing album) |
|
| 90 | + $wp_query = new EventListQuery($attributes); |
|
| 91 | + // check what template is loaded and load filters accordingly |
|
| 92 | + EED_Events_Archive::instance()->template_include('loop-espresso_events.php'); |
|
| 93 | + // load our template |
|
| 94 | + $event_list = EEH_Template::locate_template( |
|
| 95 | + 'loop-espresso_events.php', |
|
| 96 | + array(), |
|
| 97 | + true, |
|
| 98 | + true |
|
| 99 | + ); |
|
| 100 | + // now reset the query and post data |
|
| 101 | + wp_reset_query(); |
|
| 102 | + wp_reset_postdata(); |
|
| 103 | + EED_Events_Archive::remove_all_events_archive_filters(); |
|
| 104 | + // remove query filters |
|
| 105 | + remove_filter('FHEE__EEH_Event_Query__apply_query_filters', '__return_true'); |
|
| 106 | + // pull our content from the output buffer and return it |
|
| 107 | + return $event_list; |
|
| 108 | + } |
|
| 109 | 109 | |
| 110 | 110 | |
| 111 | - /** |
|
| 112 | - * merge incoming attributes with filtered defaults |
|
| 113 | - * |
|
| 114 | - * @param array $attributes |
|
| 115 | - * @return array |
|
| 116 | - */ |
|
| 117 | - private function getAttributes(array $attributes) |
|
| 118 | - { |
|
| 119 | - return array_merge( |
|
| 120 | - (array) apply_filters( |
|
| 121 | - 'EES_Espresso_Events__process_shortcode__default_espresso_events_shortcode_atts', |
|
| 122 | - array( |
|
| 123 | - 'title' => '', |
|
| 124 | - 'limit' => 10, |
|
| 125 | - 'css_class' => '', |
|
| 126 | - 'show_expired' => false, |
|
| 127 | - 'month' => '', |
|
| 128 | - 'category_slug' => '', |
|
| 129 | - 'order_by' => 'start_date', |
|
| 130 | - 'sort' => 'ASC', |
|
| 131 | - 'show_title' => true, |
|
| 132 | - ) |
|
| 133 | - ), |
|
| 134 | - $attributes |
|
| 135 | - ); |
|
| 136 | - } |
|
| 111 | + /** |
|
| 112 | + * merge incoming attributes with filtered defaults |
|
| 113 | + * |
|
| 114 | + * @param array $attributes |
|
| 115 | + * @return array |
|
| 116 | + */ |
|
| 117 | + private function getAttributes(array $attributes) |
|
| 118 | + { |
|
| 119 | + return array_merge( |
|
| 120 | + (array) apply_filters( |
|
| 121 | + 'EES_Espresso_Events__process_shortcode__default_espresso_events_shortcode_atts', |
|
| 122 | + array( |
|
| 123 | + 'title' => '', |
|
| 124 | + 'limit' => 10, |
|
| 125 | + 'css_class' => '', |
|
| 126 | + 'show_expired' => false, |
|
| 127 | + 'month' => '', |
|
| 128 | + 'category_slug' => '', |
|
| 129 | + 'order_by' => 'start_date', |
|
| 130 | + 'sort' => 'ASC', |
|
| 131 | + 'show_title' => true, |
|
| 132 | + ) |
|
| 133 | + ), |
|
| 134 | + $attributes |
|
| 135 | + ); |
|
| 136 | + } |
|
| 137 | 137 | |
| 138 | 138 | |
| 139 | - /** |
|
| 140 | - * array for defining custom attribute sanitization callbacks, |
|
| 141 | - * where keys match keys in your attributes array, |
|
| 142 | - * and values represent the sanitization function you wish to be applied to that attribute. |
|
| 143 | - * So for example, if you had an integer attribute named "event_id" |
|
| 144 | - * that you wanted to be sanitized using absint(), |
|
| 145 | - * then you would pass the following for your $custom_sanitization array: |
|
| 146 | - * array('event_id' => 'absint') |
|
| 147 | - * |
|
| 148 | - * @return array |
|
| 149 | - */ |
|
| 150 | - protected function customAttributeSanitizationMap() |
|
| 151 | - { |
|
| 152 | - // the following get sanitized/whitelisted in EEH_Event_Query |
|
| 153 | - return array( |
|
| 154 | - 'category_slug' => 'skip_sanitization', |
|
| 155 | - 'show_expired' => 'skip_sanitization', |
|
| 156 | - 'order_by' => 'skip_sanitization', |
|
| 157 | - 'month' => 'skip_sanitization', |
|
| 158 | - 'sort' => 'skip_sanitization', |
|
| 159 | - ); |
|
| 160 | - } |
|
| 139 | + /** |
|
| 140 | + * array for defining custom attribute sanitization callbacks, |
|
| 141 | + * where keys match keys in your attributes array, |
|
| 142 | + * and values represent the sanitization function you wish to be applied to that attribute. |
|
| 143 | + * So for example, if you had an integer attribute named "event_id" |
|
| 144 | + * that you wanted to be sanitized using absint(), |
|
| 145 | + * then you would pass the following for your $custom_sanitization array: |
|
| 146 | + * array('event_id' => 'absint') |
|
| 147 | + * |
|
| 148 | + * @return array |
|
| 149 | + */ |
|
| 150 | + protected function customAttributeSanitizationMap() |
|
| 151 | + { |
|
| 152 | + // the following get sanitized/whitelisted in EEH_Event_Query |
|
| 153 | + return array( |
|
| 154 | + 'category_slug' => 'skip_sanitization', |
|
| 155 | + 'show_expired' => 'skip_sanitization', |
|
| 156 | + 'order_by' => 'skip_sanitization', |
|
| 157 | + 'month' => 'skip_sanitization', |
|
| 158 | + 'sort' => 'skip_sanitization', |
|
| 159 | + ); |
|
| 160 | + } |
|
| 161 | 161 | } |
@@ -20,78 +20,78 @@ |
||
| 20 | 20 | { |
| 21 | 21 | |
| 22 | 22 | |
| 23 | - /** |
|
| 24 | - * the actual shortcode tag that gets registered with WordPress |
|
| 25 | - * |
|
| 26 | - * @return string |
|
| 27 | - */ |
|
| 28 | - public function getTag() |
|
| 29 | - { |
|
| 30 | - return 'ESPRESSO_CANCELLED'; |
|
| 31 | - } |
|
| 23 | + /** |
|
| 24 | + * the actual shortcode tag that gets registered with WordPress |
|
| 25 | + * |
|
| 26 | + * @return string |
|
| 27 | + */ |
|
| 28 | + public function getTag() |
|
| 29 | + { |
|
| 30 | + return 'ESPRESSO_CANCELLED'; |
|
| 31 | + } |
|
| 32 | 32 | |
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * the time in seconds to cache the results of the processShortcode() method |
|
| 36 | - * 0 means the processShortcode() results will NOT be cached at all |
|
| 37 | - * |
|
| 38 | - * @return int |
|
| 39 | - */ |
|
| 40 | - public function cacheExpiration() |
|
| 41 | - { |
|
| 42 | - return 0; |
|
| 43 | - } |
|
| 34 | + /** |
|
| 35 | + * the time in seconds to cache the results of the processShortcode() method |
|
| 36 | + * 0 means the processShortcode() results will NOT be cached at all |
|
| 37 | + * |
|
| 38 | + * @return int |
|
| 39 | + */ |
|
| 40 | + public function cacheExpiration() |
|
| 41 | + { |
|
| 42 | + return 0; |
|
| 43 | + } |
|
| 44 | 44 | |
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * a place for adding any initialization code that needs to run prior to wp_header(). |
|
| 48 | - * this may be required for shortcodes that utilize a corresponding module, |
|
| 49 | - * and need to enqueue assets for that module |
|
| 50 | - * |
|
| 51 | - * @return void |
|
| 52 | - */ |
|
| 53 | - public function initializeShortcode() |
|
| 54 | - { |
|
| 55 | - $this->shortcodeHasBeenInitialized(); |
|
| 56 | - } |
|
| 46 | + /** |
|
| 47 | + * a place for adding any initialization code that needs to run prior to wp_header(). |
|
| 48 | + * this may be required for shortcodes that utilize a corresponding module, |
|
| 49 | + * and need to enqueue assets for that module |
|
| 50 | + * |
|
| 51 | + * @return void |
|
| 52 | + */ |
|
| 53 | + public function initializeShortcode() |
|
| 54 | + { |
|
| 55 | + $this->shortcodeHasBeenInitialized(); |
|
| 56 | + } |
|
| 57 | 57 | |
| 58 | 58 | |
| 59 | - /** |
|
| 60 | - * callback that runs when the shortcode is encountered in post content. |
|
| 61 | - * IMPORTANT !!! |
|
| 62 | - * remember that shortcode content should be RETURNED and NOT echoed out |
|
| 63 | - * |
|
| 64 | - * @param array $attributes |
|
| 65 | - * @return string |
|
| 66 | - * @throws \EE_Error |
|
| 67 | - */ |
|
| 68 | - public function processShortcode($attributes = array()) |
|
| 69 | - { |
|
| 70 | - $transaction = EE_Registry::instance()->SSN->get_session_data('transaction'); |
|
| 71 | - if ($transaction instanceof EE_Transaction) { |
|
| 72 | - do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__transaction', $transaction); |
|
| 73 | - $registrations = $transaction->registrations(); |
|
| 74 | - foreach ($registrations as $registration) { |
|
| 75 | - if ($registration instanceof EE_Registration) { |
|
| 76 | - do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__registration', $registration); |
|
| 77 | - } |
|
| 78 | - } |
|
| 79 | - } |
|
| 80 | - do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__clear_session'); |
|
| 81 | - // remove all unwanted records from the db |
|
| 82 | - if (EE_Registry::instance()->CART instanceof EE_Cart) { |
|
| 83 | - EE_Registry::instance()->CART->delete_cart(); |
|
| 84 | - } |
|
| 85 | - // phpcs:disable WordPress.WP.I18n.UnorderedPlaceholdersText |
|
| 86 | - EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
| 87 | - return sprintf( |
|
| 88 | - __( |
|
| 89 | - '%sAll unsaved registration information entered during this session has been deleted.%s', |
|
| 90 | - 'event_espresso' |
|
| 91 | - ), |
|
| 92 | - '<p class="ee-registrations-cancelled-pg ee-attention">', |
|
| 93 | - '</p>' |
|
| 94 | - ); |
|
| 95 | - // phpcs:enable |
|
| 96 | - } |
|
| 59 | + /** |
|
| 60 | + * callback that runs when the shortcode is encountered in post content. |
|
| 61 | + * IMPORTANT !!! |
|
| 62 | + * remember that shortcode content should be RETURNED and NOT echoed out |
|
| 63 | + * |
|
| 64 | + * @param array $attributes |
|
| 65 | + * @return string |
|
| 66 | + * @throws \EE_Error |
|
| 67 | + */ |
|
| 68 | + public function processShortcode($attributes = array()) |
|
| 69 | + { |
|
| 70 | + $transaction = EE_Registry::instance()->SSN->get_session_data('transaction'); |
|
| 71 | + if ($transaction instanceof EE_Transaction) { |
|
| 72 | + do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__transaction', $transaction); |
|
| 73 | + $registrations = $transaction->registrations(); |
|
| 74 | + foreach ($registrations as $registration) { |
|
| 75 | + if ($registration instanceof EE_Registration) { |
|
| 76 | + do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__registration', $registration); |
|
| 77 | + } |
|
| 78 | + } |
|
| 79 | + } |
|
| 80 | + do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__clear_session'); |
|
| 81 | + // remove all unwanted records from the db |
|
| 82 | + if (EE_Registry::instance()->CART instanceof EE_Cart) { |
|
| 83 | + EE_Registry::instance()->CART->delete_cart(); |
|
| 84 | + } |
|
| 85 | + // phpcs:disable WordPress.WP.I18n.UnorderedPlaceholdersText |
|
| 86 | + EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
| 87 | + return sprintf( |
|
| 88 | + __( |
|
| 89 | + '%sAll unsaved registration information entered during this session has been deleted.%s', |
|
| 90 | + 'event_espresso' |
|
| 91 | + ), |
|
| 92 | + '<p class="ee-registrations-cancelled-pg ee-attention">', |
|
| 93 | + '</p>' |
|
| 94 | + ); |
|
| 95 | + // phpcs:enable |
|
| 96 | + } |
|
| 97 | 97 | } |
@@ -16,198 +16,198 @@ |
||
| 16 | 16 | class EventListQuery extends WP_Query |
| 17 | 17 | { |
| 18 | 18 | |
| 19 | - /** |
|
| 20 | - * @var string $title |
|
| 21 | - */ |
|
| 22 | - private $title; |
|
| 23 | - |
|
| 24 | - /** |
|
| 25 | - * @var integer $limit |
|
| 26 | - */ |
|
| 27 | - private $limit = 10; |
|
| 28 | - |
|
| 29 | - /** |
|
| 30 | - * @var string $css_class |
|
| 31 | - */ |
|
| 32 | - private $css_class; |
|
| 33 | - |
|
| 34 | - /** |
|
| 35 | - * @var boolean $show_expired |
|
| 36 | - */ |
|
| 37 | - private $show_expired = false; |
|
| 38 | - |
|
| 39 | - /** |
|
| 40 | - * @var string $month |
|
| 41 | - */ |
|
| 42 | - private $month; |
|
| 43 | - |
|
| 44 | - /** |
|
| 45 | - * @var string $category_slug |
|
| 46 | - */ |
|
| 47 | - private $category_slug; |
|
| 48 | - |
|
| 49 | - /** |
|
| 50 | - * @var string $order_by |
|
| 51 | - */ |
|
| 52 | - private $order_by; |
|
| 53 | - |
|
| 54 | - /** |
|
| 55 | - * @var string $sort |
|
| 56 | - */ |
|
| 57 | - private $sort; |
|
| 58 | - |
|
| 59 | - /** |
|
| 60 | - * @var boolean $show_title |
|
| 61 | - */ |
|
| 62 | - private $show_title = true; |
|
| 63 | - |
|
| 64 | - |
|
| 65 | - /** |
|
| 66 | - * EE_Event_List_Query Constructor * |
|
| 67 | - * |
|
| 68 | - * @param array $args |
|
| 69 | - */ |
|
| 70 | - public function __construct($args = array()) |
|
| 71 | - { |
|
| 72 | - $args = $this->parseArgs((array) $args); |
|
| 73 | - $this->setupEventQueryHelper(); |
|
| 74 | - $this->setupFilters(); |
|
| 75 | - $args = $this->getQueryArgs($args); |
|
| 76 | - // run the query |
|
| 77 | - parent::__construct($args); |
|
| 78 | - } |
|
| 79 | - |
|
| 80 | - |
|
| 81 | - /** |
|
| 82 | - * @param array $args |
|
| 83 | - * @return array |
|
| 84 | - */ |
|
| 85 | - private function parseArgs(array $args) |
|
| 86 | - { |
|
| 87 | - // incoming args could be a mix of WP query args + EE shortcode args |
|
| 88 | - foreach ($args as $property => $value) { |
|
| 89 | - // if the arg is a property of this class, then it's an EE shortcode arg |
|
| 90 | - if (property_exists($this, $property) && ! property_exists('WP_Query', $property)) { |
|
| 91 | - // set the property value |
|
| 92 | - $this->{$property} = $value; |
|
| 93 | - // then remove it from the array of args that will later be passed to WP_Query() |
|
| 94 | - unset($args[ $property ]); |
|
| 95 | - } |
|
| 96 | - } |
|
| 97 | - return $args; |
|
| 98 | - } |
|
| 99 | - |
|
| 100 | - |
|
| 101 | - private function setupEventQueryHelper() |
|
| 102 | - { |
|
| 103 | - // add query filters |
|
| 104 | - EEH_Event_Query::add_query_filters(); |
|
| 105 | - // set params that will get used by the filters |
|
| 106 | - EEH_Event_Query::set_query_params( |
|
| 107 | - $this->month, |
|
| 108 | - $this->category_slug, |
|
| 109 | - $this->show_expired, |
|
| 110 | - $this->order_by, |
|
| 111 | - $this->sort |
|
| 112 | - ); |
|
| 113 | - } |
|
| 114 | - |
|
| 115 | - |
|
| 116 | - private function setupFilters() |
|
| 117 | - { |
|
| 118 | - // first off, let's remove any filters from previous queries |
|
| 119 | - remove_filter( |
|
| 120 | - 'FHEE__archive_espresso_events_template__show_header', |
|
| 121 | - array($this, 'show_event_list_title') |
|
| 122 | - ); |
|
| 123 | - remove_filter( |
|
| 124 | - 'FHEE__archive_espresso_events_template__upcoming_events_h1', |
|
| 125 | - array($this, 'event_list_title') |
|
| 126 | - ); |
|
| 127 | - remove_all_filters('FHEE__content_espresso_events__event_class'); |
|
| 128 | - // Event List Title ? |
|
| 129 | - add_filter( |
|
| 130 | - 'FHEE__archive_espresso_events_template__show_header', |
|
| 131 | - array($this, 'show_event_list_title') |
|
| 132 | - ); |
|
| 133 | - add_filter( |
|
| 134 | - 'FHEE__archive_espresso_events_template__upcoming_events_h1', |
|
| 135 | - array($this, 'event_list_title'), |
|
| 136 | - 10, |
|
| 137 | - 1 |
|
| 138 | - ); |
|
| 139 | - // add the css class |
|
| 140 | - add_filter( |
|
| 141 | - 'FHEE__content_espresso_events__event_class', |
|
| 142 | - array($this, 'event_list_css'), |
|
| 143 | - 10, |
|
| 144 | - 1 |
|
| 145 | - ); |
|
| 146 | - } |
|
| 147 | - |
|
| 148 | - |
|
| 149 | - private function getQueryArgs(array $args) |
|
| 150 | - { |
|
| 151 | - // the current "page" we are viewing |
|
| 152 | - $paged = max(1, get_query_var('paged')); |
|
| 153 | - // Force these args |
|
| 154 | - return array_merge( |
|
| 155 | - $args, |
|
| 156 | - array( |
|
| 157 | - 'post_type' => 'espresso_events', |
|
| 158 | - 'posts_per_page' => $this->limit, |
|
| 159 | - 'update_post_term_cache' => false, |
|
| 160 | - 'update_post_meta_cache' => false, |
|
| 161 | - 'paged' => $paged, |
|
| 162 | - 'offset' => ($paged - 1) * $this->limit, |
|
| 163 | - ) |
|
| 164 | - ); |
|
| 165 | - } |
|
| 166 | - |
|
| 167 | - // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps |
|
| 168 | - |
|
| 169 | - /** |
|
| 170 | - * show_event_list_title |
|
| 171 | - * |
|
| 172 | - * @return boolean |
|
| 173 | - */ |
|
| 174 | - public function show_event_list_title() |
|
| 175 | - { |
|
| 176 | - return filter_var( |
|
| 177 | - $this->show_title, |
|
| 178 | - FILTER_VALIDATE_BOOLEAN |
|
| 179 | - ); |
|
| 180 | - } |
|
| 181 | - |
|
| 182 | - |
|
| 183 | - /** |
|
| 184 | - * callback for FHEE__archive_espresso_events_template__upcoming_events_h1 filter |
|
| 185 | - * |
|
| 186 | - * @param string $event_list_title |
|
| 187 | - * @return string |
|
| 188 | - */ |
|
| 189 | - public function event_list_title($event_list_title = '') |
|
| 190 | - { |
|
| 191 | - if (! empty($this->title)) { |
|
| 192 | - return $this->title; |
|
| 193 | - } |
|
| 194 | - return $event_list_title; |
|
| 195 | - } |
|
| 196 | - |
|
| 197 | - |
|
| 198 | - /** |
|
| 199 | - * callback for FHEE__content_espresso_events__event_class filter |
|
| 200 | - * |
|
| 201 | - * @param string $event_list_css |
|
| 202 | - * @return string |
|
| 203 | - */ |
|
| 204 | - public function event_list_css($event_list_css = '') |
|
| 205 | - { |
|
| 206 | - $event_list_css .= ! empty($event_list_css) ? ' ' : ''; |
|
| 207 | - $event_list_css .= ! empty($this->css_class) ? $this->css_class : ''; |
|
| 208 | - $event_list_css .= ! empty($event_list_css) ? ' ' : ''; |
|
| 209 | - $event_list_css .= ! empty($this->category_slug) ? $this->category_slug : ''; |
|
| 210 | - return $event_list_css; |
|
| 211 | - } |
|
| 212 | - // phpcs:enable |
|
| 19 | + /** |
|
| 20 | + * @var string $title |
|
| 21 | + */ |
|
| 22 | + private $title; |
|
| 23 | + |
|
| 24 | + /** |
|
| 25 | + * @var integer $limit |
|
| 26 | + */ |
|
| 27 | + private $limit = 10; |
|
| 28 | + |
|
| 29 | + /** |
|
| 30 | + * @var string $css_class |
|
| 31 | + */ |
|
| 32 | + private $css_class; |
|
| 33 | + |
|
| 34 | + /** |
|
| 35 | + * @var boolean $show_expired |
|
| 36 | + */ |
|
| 37 | + private $show_expired = false; |
|
| 38 | + |
|
| 39 | + /** |
|
| 40 | + * @var string $month |
|
| 41 | + */ |
|
| 42 | + private $month; |
|
| 43 | + |
|
| 44 | + /** |
|
| 45 | + * @var string $category_slug |
|
| 46 | + */ |
|
| 47 | + private $category_slug; |
|
| 48 | + |
|
| 49 | + /** |
|
| 50 | + * @var string $order_by |
|
| 51 | + */ |
|
| 52 | + private $order_by; |
|
| 53 | + |
|
| 54 | + /** |
|
| 55 | + * @var string $sort |
|
| 56 | + */ |
|
| 57 | + private $sort; |
|
| 58 | + |
|
| 59 | + /** |
|
| 60 | + * @var boolean $show_title |
|
| 61 | + */ |
|
| 62 | + private $show_title = true; |
|
| 63 | + |
|
| 64 | + |
|
| 65 | + /** |
|
| 66 | + * EE_Event_List_Query Constructor * |
|
| 67 | + * |
|
| 68 | + * @param array $args |
|
| 69 | + */ |
|
| 70 | + public function __construct($args = array()) |
|
| 71 | + { |
|
| 72 | + $args = $this->parseArgs((array) $args); |
|
| 73 | + $this->setupEventQueryHelper(); |
|
| 74 | + $this->setupFilters(); |
|
| 75 | + $args = $this->getQueryArgs($args); |
|
| 76 | + // run the query |
|
| 77 | + parent::__construct($args); |
|
| 78 | + } |
|
| 79 | + |
|
| 80 | + |
|
| 81 | + /** |
|
| 82 | + * @param array $args |
|
| 83 | + * @return array |
|
| 84 | + */ |
|
| 85 | + private function parseArgs(array $args) |
|
| 86 | + { |
|
| 87 | + // incoming args could be a mix of WP query args + EE shortcode args |
|
| 88 | + foreach ($args as $property => $value) { |
|
| 89 | + // if the arg is a property of this class, then it's an EE shortcode arg |
|
| 90 | + if (property_exists($this, $property) && ! property_exists('WP_Query', $property)) { |
|
| 91 | + // set the property value |
|
| 92 | + $this->{$property} = $value; |
|
| 93 | + // then remove it from the array of args that will later be passed to WP_Query() |
|
| 94 | + unset($args[ $property ]); |
|
| 95 | + } |
|
| 96 | + } |
|
| 97 | + return $args; |
|
| 98 | + } |
|
| 99 | + |
|
| 100 | + |
|
| 101 | + private function setupEventQueryHelper() |
|
| 102 | + { |
|
| 103 | + // add query filters |
|
| 104 | + EEH_Event_Query::add_query_filters(); |
|
| 105 | + // set params that will get used by the filters |
|
| 106 | + EEH_Event_Query::set_query_params( |
|
| 107 | + $this->month, |
|
| 108 | + $this->category_slug, |
|
| 109 | + $this->show_expired, |
|
| 110 | + $this->order_by, |
|
| 111 | + $this->sort |
|
| 112 | + ); |
|
| 113 | + } |
|
| 114 | + |
|
| 115 | + |
|
| 116 | + private function setupFilters() |
|
| 117 | + { |
|
| 118 | + // first off, let's remove any filters from previous queries |
|
| 119 | + remove_filter( |
|
| 120 | + 'FHEE__archive_espresso_events_template__show_header', |
|
| 121 | + array($this, 'show_event_list_title') |
|
| 122 | + ); |
|
| 123 | + remove_filter( |
|
| 124 | + 'FHEE__archive_espresso_events_template__upcoming_events_h1', |
|
| 125 | + array($this, 'event_list_title') |
|
| 126 | + ); |
|
| 127 | + remove_all_filters('FHEE__content_espresso_events__event_class'); |
|
| 128 | + // Event List Title ? |
|
| 129 | + add_filter( |
|
| 130 | + 'FHEE__archive_espresso_events_template__show_header', |
|
| 131 | + array($this, 'show_event_list_title') |
|
| 132 | + ); |
|
| 133 | + add_filter( |
|
| 134 | + 'FHEE__archive_espresso_events_template__upcoming_events_h1', |
|
| 135 | + array($this, 'event_list_title'), |
|
| 136 | + 10, |
|
| 137 | + 1 |
|
| 138 | + ); |
|
| 139 | + // add the css class |
|
| 140 | + add_filter( |
|
| 141 | + 'FHEE__content_espresso_events__event_class', |
|
| 142 | + array($this, 'event_list_css'), |
|
| 143 | + 10, |
|
| 144 | + 1 |
|
| 145 | + ); |
|
| 146 | + } |
|
| 147 | + |
|
| 148 | + |
|
| 149 | + private function getQueryArgs(array $args) |
|
| 150 | + { |
|
| 151 | + // the current "page" we are viewing |
|
| 152 | + $paged = max(1, get_query_var('paged')); |
|
| 153 | + // Force these args |
|
| 154 | + return array_merge( |
|
| 155 | + $args, |
|
| 156 | + array( |
|
| 157 | + 'post_type' => 'espresso_events', |
|
| 158 | + 'posts_per_page' => $this->limit, |
|
| 159 | + 'update_post_term_cache' => false, |
|
| 160 | + 'update_post_meta_cache' => false, |
|
| 161 | + 'paged' => $paged, |
|
| 162 | + 'offset' => ($paged - 1) * $this->limit, |
|
| 163 | + ) |
|
| 164 | + ); |
|
| 165 | + } |
|
| 166 | + |
|
| 167 | + // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps |
|
| 168 | + |
|
| 169 | + /** |
|
| 170 | + * show_event_list_title |
|
| 171 | + * |
|
| 172 | + * @return boolean |
|
| 173 | + */ |
|
| 174 | + public function show_event_list_title() |
|
| 175 | + { |
|
| 176 | + return filter_var( |
|
| 177 | + $this->show_title, |
|
| 178 | + FILTER_VALIDATE_BOOLEAN |
|
| 179 | + ); |
|
| 180 | + } |
|
| 181 | + |
|
| 182 | + |
|
| 183 | + /** |
|
| 184 | + * callback for FHEE__archive_espresso_events_template__upcoming_events_h1 filter |
|
| 185 | + * |
|
| 186 | + * @param string $event_list_title |
|
| 187 | + * @return string |
|
| 188 | + */ |
|
| 189 | + public function event_list_title($event_list_title = '') |
|
| 190 | + { |
|
| 191 | + if (! empty($this->title)) { |
|
| 192 | + return $this->title; |
|
| 193 | + } |
|
| 194 | + return $event_list_title; |
|
| 195 | + } |
|
| 196 | + |
|
| 197 | + |
|
| 198 | + /** |
|
| 199 | + * callback for FHEE__content_espresso_events__event_class filter |
|
| 200 | + * |
|
| 201 | + * @param string $event_list_css |
|
| 202 | + * @return string |
|
| 203 | + */ |
|
| 204 | + public function event_list_css($event_list_css = '') |
|
| 205 | + { |
|
| 206 | + $event_list_css .= ! empty($event_list_css) ? ' ' : ''; |
|
| 207 | + $event_list_css .= ! empty($this->css_class) ? $this->css_class : ''; |
|
| 208 | + $event_list_css .= ! empty($event_list_css) ? ' ' : ''; |
|
| 209 | + $event_list_css .= ! empty($this->category_slug) ? $this->category_slug : ''; |
|
| 210 | + return $event_list_css; |
|
| 211 | + } |
|
| 212 | + // phpcs:enable |
|
| 213 | 213 | } |
@@ -91,7 +91,7 @@ discard block |
||
| 91 | 91 | // set the property value |
| 92 | 92 | $this->{$property} = $value; |
| 93 | 93 | // then remove it from the array of args that will later be passed to WP_Query() |
| 94 | - unset($args[ $property ]); |
|
| 94 | + unset($args[$property]); |
|
| 95 | 95 | } |
| 96 | 96 | } |
| 97 | 97 | return $args; |
@@ -188,7 +188,7 @@ discard block |
||
| 188 | 188 | */ |
| 189 | 189 | public function event_list_title($event_list_title = '') |
| 190 | 190 | { |
| 191 | - if (! empty($this->title)) { |
|
| 191 | + if ( ! empty($this->title)) { |
|
| 192 | 192 | return $this->title; |
| 193 | 193 | } |
| 194 | 194 | return $event_list_title; |
@@ -15,112 +15,112 @@ |
||
| 15 | 15 | class Basic implements EmailValidatorInterface |
| 16 | 16 | { |
| 17 | 17 | |
| 18 | - /** |
|
| 19 | - * @param string $email_address |
|
| 20 | - * @return bool |
|
| 21 | - * @throws EmailValidationException |
|
| 22 | - */ |
|
| 23 | - public function validate($email_address) |
|
| 24 | - { |
|
| 25 | - if (! preg_match('/^.+\@\S+$/', $email_address)) { |
|
| 26 | - // email not in correct {string}@{string} format |
|
| 27 | - throw new EmailValidationException( |
|
| 28 | - esc_html__('Email does not have the required @ sign.', 'event_espresso') |
|
| 29 | - ); |
|
| 30 | - } |
|
| 31 | - $atIndex = $this->getAtIndex($email_address); |
|
| 32 | - $local = $this->getLocalPartOfEmail($email_address, $atIndex); |
|
| 33 | - $localLen = strlen($local); |
|
| 34 | - if ($localLen < 1) { |
|
| 35 | - // no local part |
|
| 36 | - throw new EmailValidationException( |
|
| 37 | - esc_html__('Email local-part (before the @) is required.', 'event_espresso') |
|
| 38 | - ); |
|
| 39 | - } |
|
| 40 | - if ($localLen > 64) { |
|
| 41 | - // local part length exceeded |
|
| 42 | - throw new EmailValidationException( |
|
| 43 | - esc_html__('Email local-part (before the @) is too long.', 'event_espresso') |
|
| 44 | - ); |
|
| 45 | - } |
|
| 46 | - if ($local[0] === '.') { |
|
| 47 | - // local part starts with '.' |
|
| 48 | - throw new EmailValidationException( |
|
| 49 | - esc_html__('Email local-part (before the @) must not begin with a period.', 'event_espresso') |
|
| 50 | - ); |
|
| 51 | - } |
|
| 52 | - if ($local[ $localLen - 1 ] === '.') { |
|
| 53 | - // local part starts or ends with '.' |
|
| 54 | - throw new EmailValidationException( |
|
| 55 | - esc_html__('Email local-part (before the @) must not end with a period.', 'event_espresso') |
|
| 56 | - ); |
|
| 57 | - } |
|
| 58 | - if (preg_match('/\\.\\./', $local)) { |
|
| 59 | - // local part has two consecutive dots |
|
| 60 | - throw new EmailValidationException( |
|
| 61 | - esc_html__( |
|
| 62 | - 'Email local-part (before the @) must not have two consecutive periods.', |
|
| 63 | - 'event_espresso' |
|
| 64 | - ) |
|
| 65 | - ); |
|
| 66 | - } |
|
| 67 | - $domain = $this->getDomainPartOfEmail($email_address, $atIndex); |
|
| 68 | - $domainLen = strlen($domain); |
|
| 69 | - if ($domainLen < 1) { |
|
| 70 | - throw new EmailValidationException( |
|
| 71 | - esc_html__('Email domain (after the @) is required.', 'event_espresso') |
|
| 72 | - ); |
|
| 73 | - } |
|
| 74 | - if ($domainLen > 255) { |
|
| 75 | - // domain part length exceeded |
|
| 76 | - throw new EmailValidationException( |
|
| 77 | - esc_html__('Email domain (after the @) is too long.', 'event_espresso') |
|
| 78 | - ); |
|
| 79 | - } |
|
| 80 | - if (preg_match('/\\.\\./', $domain)) { |
|
| 81 | - // domain part has two consecutive dots |
|
| 82 | - throw new EmailValidationException( |
|
| 83 | - esc_html__('Email domain (after the @) must not have two consecutive periods.', 'event_espresso') |
|
| 84 | - ); |
|
| 85 | - } |
|
| 86 | - return true; |
|
| 87 | - } |
|
| 18 | + /** |
|
| 19 | + * @param string $email_address |
|
| 20 | + * @return bool |
|
| 21 | + * @throws EmailValidationException |
|
| 22 | + */ |
|
| 23 | + public function validate($email_address) |
|
| 24 | + { |
|
| 25 | + if (! preg_match('/^.+\@\S+$/', $email_address)) { |
|
| 26 | + // email not in correct {string}@{string} format |
|
| 27 | + throw new EmailValidationException( |
|
| 28 | + esc_html__('Email does not have the required @ sign.', 'event_espresso') |
|
| 29 | + ); |
|
| 30 | + } |
|
| 31 | + $atIndex = $this->getAtIndex($email_address); |
|
| 32 | + $local = $this->getLocalPartOfEmail($email_address, $atIndex); |
|
| 33 | + $localLen = strlen($local); |
|
| 34 | + if ($localLen < 1) { |
|
| 35 | + // no local part |
|
| 36 | + throw new EmailValidationException( |
|
| 37 | + esc_html__('Email local-part (before the @) is required.', 'event_espresso') |
|
| 38 | + ); |
|
| 39 | + } |
|
| 40 | + if ($localLen > 64) { |
|
| 41 | + // local part length exceeded |
|
| 42 | + throw new EmailValidationException( |
|
| 43 | + esc_html__('Email local-part (before the @) is too long.', 'event_espresso') |
|
| 44 | + ); |
|
| 45 | + } |
|
| 46 | + if ($local[0] === '.') { |
|
| 47 | + // local part starts with '.' |
|
| 48 | + throw new EmailValidationException( |
|
| 49 | + esc_html__('Email local-part (before the @) must not begin with a period.', 'event_espresso') |
|
| 50 | + ); |
|
| 51 | + } |
|
| 52 | + if ($local[ $localLen - 1 ] === '.') { |
|
| 53 | + // local part starts or ends with '.' |
|
| 54 | + throw new EmailValidationException( |
|
| 55 | + esc_html__('Email local-part (before the @) must not end with a period.', 'event_espresso') |
|
| 56 | + ); |
|
| 57 | + } |
|
| 58 | + if (preg_match('/\\.\\./', $local)) { |
|
| 59 | + // local part has two consecutive dots |
|
| 60 | + throw new EmailValidationException( |
|
| 61 | + esc_html__( |
|
| 62 | + 'Email local-part (before the @) must not have two consecutive periods.', |
|
| 63 | + 'event_espresso' |
|
| 64 | + ) |
|
| 65 | + ); |
|
| 66 | + } |
|
| 67 | + $domain = $this->getDomainPartOfEmail($email_address, $atIndex); |
|
| 68 | + $domainLen = strlen($domain); |
|
| 69 | + if ($domainLen < 1) { |
|
| 70 | + throw new EmailValidationException( |
|
| 71 | + esc_html__('Email domain (after the @) is required.', 'event_espresso') |
|
| 72 | + ); |
|
| 73 | + } |
|
| 74 | + if ($domainLen > 255) { |
|
| 75 | + // domain part length exceeded |
|
| 76 | + throw new EmailValidationException( |
|
| 77 | + esc_html__('Email domain (after the @) is too long.', 'event_espresso') |
|
| 78 | + ); |
|
| 79 | + } |
|
| 80 | + if (preg_match('/\\.\\./', $domain)) { |
|
| 81 | + // domain part has two consecutive dots |
|
| 82 | + throw new EmailValidationException( |
|
| 83 | + esc_html__('Email domain (after the @) must not have two consecutive periods.', 'event_espresso') |
|
| 84 | + ); |
|
| 85 | + } |
|
| 86 | + return true; |
|
| 87 | + } |
|
| 88 | 88 | |
| 89 | 89 | |
| 90 | - /** |
|
| 91 | - * returns the location of the @ symbol |
|
| 92 | - * |
|
| 93 | - * @param string $email_address |
|
| 94 | - * @return bool|string |
|
| 95 | - */ |
|
| 96 | - protected function getAtIndex($email_address) |
|
| 97 | - { |
|
| 98 | - return strrpos($email_address, '@'); |
|
| 99 | - } |
|
| 90 | + /** |
|
| 91 | + * returns the location of the @ symbol |
|
| 92 | + * |
|
| 93 | + * @param string $email_address |
|
| 94 | + * @return bool|string |
|
| 95 | + */ |
|
| 96 | + protected function getAtIndex($email_address) |
|
| 97 | + { |
|
| 98 | + return strrpos($email_address, '@'); |
|
| 99 | + } |
|
| 100 | 100 | |
| 101 | 101 | |
| 102 | - /** |
|
| 103 | - * Gets the local part of the email |
|
| 104 | - * |
|
| 105 | - * @param string $email_address |
|
| 106 | - * @param bool|int $atIndex |
|
| 107 | - * @return bool|string |
|
| 108 | - */ |
|
| 109 | - protected function getLocalPartOfEmail($email_address, $atIndex) |
|
| 110 | - { |
|
| 111 | - return substr($email_address, 0, $atIndex); |
|
| 112 | - } |
|
| 102 | + /** |
|
| 103 | + * Gets the local part of the email |
|
| 104 | + * |
|
| 105 | + * @param string $email_address |
|
| 106 | + * @param bool|int $atIndex |
|
| 107 | + * @return bool|string |
|
| 108 | + */ |
|
| 109 | + protected function getLocalPartOfEmail($email_address, $atIndex) |
|
| 110 | + { |
|
| 111 | + return substr($email_address, 0, $atIndex); |
|
| 112 | + } |
|
| 113 | 113 | |
| 114 | 114 | |
| 115 | - /** |
|
| 116 | - * Gets the domain part of the email |
|
| 117 | - * |
|
| 118 | - * @param string $email_address |
|
| 119 | - * @param bool|int $atIndex |
|
| 120 | - * @return bool|string |
|
| 121 | - */ |
|
| 122 | - protected function getDomainPartOfEmail($email_address, $atIndex) |
|
| 123 | - { |
|
| 124 | - return substr($email_address, $atIndex + 1); |
|
| 125 | - } |
|
| 115 | + /** |
|
| 116 | + * Gets the domain part of the email |
|
| 117 | + * |
|
| 118 | + * @param string $email_address |
|
| 119 | + * @param bool|int $atIndex |
|
| 120 | + * @return bool|string |
|
| 121 | + */ |
|
| 122 | + protected function getDomainPartOfEmail($email_address, $atIndex) |
|
| 123 | + { |
|
| 124 | + return substr($email_address, $atIndex + 1); |
|
| 125 | + } |
|
| 126 | 126 | } |
@@ -22,7 +22,7 @@ discard block |
||
| 22 | 22 | */ |
| 23 | 23 | public function validate($email_address) |
| 24 | 24 | { |
| 25 | - if (! preg_match('/^.+\@\S+$/', $email_address)) { |
|
| 25 | + if ( ! preg_match('/^.+\@\S+$/', $email_address)) { |
|
| 26 | 26 | // email not in correct {string}@{string} format |
| 27 | 27 | throw new EmailValidationException( |
| 28 | 28 | esc_html__('Email does not have the required @ sign.', 'event_espresso') |
@@ -49,7 +49,7 @@ discard block |
||
| 49 | 49 | esc_html__('Email local-part (before the @) must not begin with a period.', 'event_espresso') |
| 50 | 50 | ); |
| 51 | 51 | } |
| 52 | - if ($local[ $localLen - 1 ] === '.') { |
|
| 52 | + if ($local[$localLen - 1] === '.') { |
|
| 53 | 53 | // local part starts or ends with '.' |
| 54 | 54 | throw new EmailValidationException( |
| 55 | 55 | esc_html__('Email local-part (before the @) must not end with a period.', 'event_espresso') |
@@ -26,149 +26,149 @@ |
||
| 26 | 26 | { |
| 27 | 27 | |
| 28 | 28 | |
| 29 | - /** |
|
| 30 | - * @param EE_Registration $target_registration |
|
| 31 | - * @param EE_Registration $registration_to_copy |
|
| 32 | - * @return bool |
|
| 33 | - * @throws UnexpectedEntityException |
|
| 34 | - * @throws EntityNotFoundException |
|
| 35 | - * @throws RuntimeException |
|
| 36 | - * @throws EE_Error |
|
| 37 | - */ |
|
| 38 | - public function copyRegistrationDetails( |
|
| 39 | - EE_Registration $target_registration, |
|
| 40 | - EE_Registration $registration_to_copy |
|
| 41 | - ) { |
|
| 42 | - // copy attendee |
|
| 43 | - $target_registration->set_attendee_id($registration_to_copy->attendee_ID()); |
|
| 44 | - $target_registration->updateStatusBasedOnTotalPaid(false); |
|
| 45 | - $target_registration->save(); |
|
| 46 | - // get answers to previous reg questions |
|
| 47 | - $answers = $this->reindexAnswersByQuestionId($registration_to_copy->answers()); |
|
| 48 | - // get questions to new event reg form |
|
| 49 | - $new_event = $target_registration->event(); |
|
| 50 | - $question_groups = $new_event->question_groups( |
|
| 51 | - array( |
|
| 52 | - array( |
|
| 53 | - 'Event.EVT_ID' => $new_event->ID(), |
|
| 54 | - 'Event_Question_Group.EQG_primary' => $registration_to_copy->is_primary_registrant(), |
|
| 55 | - ), |
|
| 56 | - 'order_by' => array('QSG_order' => 'ASC'), |
|
| 57 | - ) |
|
| 58 | - ); |
|
| 59 | - foreach ($question_groups as $question_group) { |
|
| 60 | - if ($question_group instanceof \EE_Question_Group) { |
|
| 61 | - foreach ($question_group->questions() as $question) { |
|
| 62 | - if ($question instanceof EE_Question) { |
|
| 63 | - $this->generateNewAnswer( |
|
| 64 | - $question, |
|
| 65 | - $target_registration, |
|
| 66 | - $answers |
|
| 67 | - ); |
|
| 68 | - } |
|
| 69 | - } |
|
| 70 | - } |
|
| 71 | - } |
|
| 72 | - return true; |
|
| 73 | - } |
|
| 29 | + /** |
|
| 30 | + * @param EE_Registration $target_registration |
|
| 31 | + * @param EE_Registration $registration_to_copy |
|
| 32 | + * @return bool |
|
| 33 | + * @throws UnexpectedEntityException |
|
| 34 | + * @throws EntityNotFoundException |
|
| 35 | + * @throws RuntimeException |
|
| 36 | + * @throws EE_Error |
|
| 37 | + */ |
|
| 38 | + public function copyRegistrationDetails( |
|
| 39 | + EE_Registration $target_registration, |
|
| 40 | + EE_Registration $registration_to_copy |
|
| 41 | + ) { |
|
| 42 | + // copy attendee |
|
| 43 | + $target_registration->set_attendee_id($registration_to_copy->attendee_ID()); |
|
| 44 | + $target_registration->updateStatusBasedOnTotalPaid(false); |
|
| 45 | + $target_registration->save(); |
|
| 46 | + // get answers to previous reg questions |
|
| 47 | + $answers = $this->reindexAnswersByQuestionId($registration_to_copy->answers()); |
|
| 48 | + // get questions to new event reg form |
|
| 49 | + $new_event = $target_registration->event(); |
|
| 50 | + $question_groups = $new_event->question_groups( |
|
| 51 | + array( |
|
| 52 | + array( |
|
| 53 | + 'Event.EVT_ID' => $new_event->ID(), |
|
| 54 | + 'Event_Question_Group.EQG_primary' => $registration_to_copy->is_primary_registrant(), |
|
| 55 | + ), |
|
| 56 | + 'order_by' => array('QSG_order' => 'ASC'), |
|
| 57 | + ) |
|
| 58 | + ); |
|
| 59 | + foreach ($question_groups as $question_group) { |
|
| 60 | + if ($question_group instanceof \EE_Question_Group) { |
|
| 61 | + foreach ($question_group->questions() as $question) { |
|
| 62 | + if ($question instanceof EE_Question) { |
|
| 63 | + $this->generateNewAnswer( |
|
| 64 | + $question, |
|
| 65 | + $target_registration, |
|
| 66 | + $answers |
|
| 67 | + ); |
|
| 68 | + } |
|
| 69 | + } |
|
| 70 | + } |
|
| 71 | + } |
|
| 72 | + return true; |
|
| 73 | + } |
|
| 74 | 74 | |
| 75 | 75 | |
| 76 | - /** |
|
| 77 | - * @param EE_Answer[] $answers |
|
| 78 | - * @return array |
|
| 79 | - * @throws EE_Error |
|
| 80 | - */ |
|
| 81 | - protected function reindexAnswersByQuestionId(array $answers) |
|
| 82 | - { |
|
| 83 | - $reindexed_answers = array(); |
|
| 84 | - foreach ($answers as $answer) { |
|
| 85 | - if ($answer instanceof EE_Answer) { |
|
| 86 | - $reindexed_answers[ $answer->question_ID() ] = $answer->value(); |
|
| 87 | - } |
|
| 88 | - } |
|
| 89 | - return $reindexed_answers; |
|
| 90 | - } |
|
| 76 | + /** |
|
| 77 | + * @param EE_Answer[] $answers |
|
| 78 | + * @return array |
|
| 79 | + * @throws EE_Error |
|
| 80 | + */ |
|
| 81 | + protected function reindexAnswersByQuestionId(array $answers) |
|
| 82 | + { |
|
| 83 | + $reindexed_answers = array(); |
|
| 84 | + foreach ($answers as $answer) { |
|
| 85 | + if ($answer instanceof EE_Answer) { |
|
| 86 | + $reindexed_answers[ $answer->question_ID() ] = $answer->value(); |
|
| 87 | + } |
|
| 88 | + } |
|
| 89 | + return $reindexed_answers; |
|
| 90 | + } |
|
| 91 | 91 | |
| 92 | 92 | |
| 93 | - /** |
|
| 94 | - * @param EE_Question $question |
|
| 95 | - * @param EE_Registration $registration |
|
| 96 | - * @param $previous_answers |
|
| 97 | - * @return EE_Answer |
|
| 98 | - * @throws UnexpectedEntityException |
|
| 99 | - * @throws EE_Error |
|
| 100 | - */ |
|
| 101 | - protected function generateNewAnswer( |
|
| 102 | - EE_Question $question, |
|
| 103 | - EE_Registration $registration, |
|
| 104 | - $previous_answers |
|
| 105 | - ) { |
|
| 106 | - $old_answer_value = isset($previous_answers[ $question->ID() ]) |
|
| 107 | - ? $previous_answers[ $question->ID() ] |
|
| 108 | - : ''; |
|
| 109 | - $new_answer = EE_Answer::new_instance( |
|
| 110 | - array( |
|
| 111 | - 'QST_ID' => $question->ID(), |
|
| 112 | - 'REG_ID' => $registration->ID(), |
|
| 113 | - 'ANS_value' => $old_answer_value, |
|
| 114 | - ) |
|
| 115 | - ); |
|
| 116 | - if (! $new_answer instanceof EE_Answer) { |
|
| 117 | - throw new UnexpectedEntityException($new_answer, 'EE_Answer'); |
|
| 118 | - } |
|
| 119 | - $new_answer->save(); |
|
| 120 | - return $new_answer; |
|
| 121 | - } |
|
| 93 | + /** |
|
| 94 | + * @param EE_Question $question |
|
| 95 | + * @param EE_Registration $registration |
|
| 96 | + * @param $previous_answers |
|
| 97 | + * @return EE_Answer |
|
| 98 | + * @throws UnexpectedEntityException |
|
| 99 | + * @throws EE_Error |
|
| 100 | + */ |
|
| 101 | + protected function generateNewAnswer( |
|
| 102 | + EE_Question $question, |
|
| 103 | + EE_Registration $registration, |
|
| 104 | + $previous_answers |
|
| 105 | + ) { |
|
| 106 | + $old_answer_value = isset($previous_answers[ $question->ID() ]) |
|
| 107 | + ? $previous_answers[ $question->ID() ] |
|
| 108 | + : ''; |
|
| 109 | + $new_answer = EE_Answer::new_instance( |
|
| 110 | + array( |
|
| 111 | + 'QST_ID' => $question->ID(), |
|
| 112 | + 'REG_ID' => $registration->ID(), |
|
| 113 | + 'ANS_value' => $old_answer_value, |
|
| 114 | + ) |
|
| 115 | + ); |
|
| 116 | + if (! $new_answer instanceof EE_Answer) { |
|
| 117 | + throw new UnexpectedEntityException($new_answer, 'EE_Answer'); |
|
| 118 | + } |
|
| 119 | + $new_answer->save(); |
|
| 120 | + return $new_answer; |
|
| 121 | + } |
|
| 122 | 122 | |
| 123 | 123 | |
| 124 | - /** |
|
| 125 | - * @param EE_Registration $target_registration |
|
| 126 | - * @param EE_Registration $registration_to_copy |
|
| 127 | - * @return bool |
|
| 128 | - * @throws RuntimeException |
|
| 129 | - * @throws UnexpectedEntityException |
|
| 130 | - * @throws EE_Error |
|
| 131 | - */ |
|
| 132 | - public function copyPaymentDetails( |
|
| 133 | - EE_Registration $target_registration, |
|
| 134 | - EE_Registration $registration_to_copy |
|
| 135 | - ) { |
|
| 136 | - $save = false; |
|
| 137 | - $previous_registration_payments = $registration_to_copy->registration_payments(); |
|
| 138 | - $new_registration_payment_total = 0; |
|
| 139 | - $registration_to_copy_total = $registration_to_copy->paid(); |
|
| 140 | - foreach ($previous_registration_payments as $previous_registration_payment) { |
|
| 141 | - if ($previous_registration_payment instanceof EE_Registration_Payment |
|
| 142 | - && $previous_registration_payment->payment() instanceof EE_Payment |
|
| 143 | - && $previous_registration_payment->payment()->is_approved() |
|
| 144 | - ) { |
|
| 145 | - $payment_amount = $previous_registration_payment->amount(); |
|
| 146 | - $new_registration_payment = EE_Registration_Payment::new_instance( |
|
| 147 | - array( |
|
| 148 | - 'REG_ID' => $target_registration->ID(), |
|
| 149 | - 'PAY_ID' => $previous_registration_payment->payment()->ID(), |
|
| 150 | - 'RPY_amount' => $payment_amount, |
|
| 151 | - ) |
|
| 152 | - ); |
|
| 153 | - if (! $new_registration_payment instanceof EE_Registration_Payment) { |
|
| 154 | - throw new UnexpectedEntityException($new_registration_payment, 'EE_Registration_Payment'); |
|
| 155 | - } |
|
| 156 | - $new_registration_payment->save(); |
|
| 157 | - // if new reg payment is good, then set old reg payment amount to zero |
|
| 158 | - $previous_registration_payment->set_amount(0); |
|
| 159 | - $previous_registration_payment->save(); |
|
| 160 | - // now increment/decrement payment amounts |
|
| 161 | - $new_registration_payment_total += $payment_amount; |
|
| 162 | - $registration_to_copy_total -= $payment_amount; |
|
| 163 | - $save = true; |
|
| 164 | - } |
|
| 165 | - } |
|
| 166 | - if ($save) { |
|
| 167 | - $target_registration->set_paid($new_registration_payment_total); |
|
| 168 | - $target_registration->save(); |
|
| 169 | - $registration_to_copy->set_paid($registration_to_copy_total); |
|
| 170 | - $registration_to_copy->save(); |
|
| 171 | - } |
|
| 172 | - return true; |
|
| 173 | - } |
|
| 124 | + /** |
|
| 125 | + * @param EE_Registration $target_registration |
|
| 126 | + * @param EE_Registration $registration_to_copy |
|
| 127 | + * @return bool |
|
| 128 | + * @throws RuntimeException |
|
| 129 | + * @throws UnexpectedEntityException |
|
| 130 | + * @throws EE_Error |
|
| 131 | + */ |
|
| 132 | + public function copyPaymentDetails( |
|
| 133 | + EE_Registration $target_registration, |
|
| 134 | + EE_Registration $registration_to_copy |
|
| 135 | + ) { |
|
| 136 | + $save = false; |
|
| 137 | + $previous_registration_payments = $registration_to_copy->registration_payments(); |
|
| 138 | + $new_registration_payment_total = 0; |
|
| 139 | + $registration_to_copy_total = $registration_to_copy->paid(); |
|
| 140 | + foreach ($previous_registration_payments as $previous_registration_payment) { |
|
| 141 | + if ($previous_registration_payment instanceof EE_Registration_Payment |
|
| 142 | + && $previous_registration_payment->payment() instanceof EE_Payment |
|
| 143 | + && $previous_registration_payment->payment()->is_approved() |
|
| 144 | + ) { |
|
| 145 | + $payment_amount = $previous_registration_payment->amount(); |
|
| 146 | + $new_registration_payment = EE_Registration_Payment::new_instance( |
|
| 147 | + array( |
|
| 148 | + 'REG_ID' => $target_registration->ID(), |
|
| 149 | + 'PAY_ID' => $previous_registration_payment->payment()->ID(), |
|
| 150 | + 'RPY_amount' => $payment_amount, |
|
| 151 | + ) |
|
| 152 | + ); |
|
| 153 | + if (! $new_registration_payment instanceof EE_Registration_Payment) { |
|
| 154 | + throw new UnexpectedEntityException($new_registration_payment, 'EE_Registration_Payment'); |
|
| 155 | + } |
|
| 156 | + $new_registration_payment->save(); |
|
| 157 | + // if new reg payment is good, then set old reg payment amount to zero |
|
| 158 | + $previous_registration_payment->set_amount(0); |
|
| 159 | + $previous_registration_payment->save(); |
|
| 160 | + // now increment/decrement payment amounts |
|
| 161 | + $new_registration_payment_total += $payment_amount; |
|
| 162 | + $registration_to_copy_total -= $payment_amount; |
|
| 163 | + $save = true; |
|
| 164 | + } |
|
| 165 | + } |
|
| 166 | + if ($save) { |
|
| 167 | + $target_registration->set_paid($new_registration_payment_total); |
|
| 168 | + $target_registration->save(); |
|
| 169 | + $registration_to_copy->set_paid($registration_to_copy_total); |
|
| 170 | + $registration_to_copy->save(); |
|
| 171 | + } |
|
| 172 | + return true; |
|
| 173 | + } |
|
| 174 | 174 | } |
@@ -83,7 +83,7 @@ discard block |
||
| 83 | 83 | $reindexed_answers = array(); |
| 84 | 84 | foreach ($answers as $answer) { |
| 85 | 85 | if ($answer instanceof EE_Answer) { |
| 86 | - $reindexed_answers[ $answer->question_ID() ] = $answer->value(); |
|
| 86 | + $reindexed_answers[$answer->question_ID()] = $answer->value(); |
|
| 87 | 87 | } |
| 88 | 88 | } |
| 89 | 89 | return $reindexed_answers; |
@@ -103,8 +103,8 @@ discard block |
||
| 103 | 103 | EE_Registration $registration, |
| 104 | 104 | $previous_answers |
| 105 | 105 | ) { |
| 106 | - $old_answer_value = isset($previous_answers[ $question->ID() ]) |
|
| 107 | - ? $previous_answers[ $question->ID() ] |
|
| 106 | + $old_answer_value = isset($previous_answers[$question->ID()]) |
|
| 107 | + ? $previous_answers[$question->ID()] |
|
| 108 | 108 | : ''; |
| 109 | 109 | $new_answer = EE_Answer::new_instance( |
| 110 | 110 | array( |
@@ -113,7 +113,7 @@ discard block |
||
| 113 | 113 | 'ANS_value' => $old_answer_value, |
| 114 | 114 | ) |
| 115 | 115 | ); |
| 116 | - if (! $new_answer instanceof EE_Answer) { |
|
| 116 | + if ( ! $new_answer instanceof EE_Answer) { |
|
| 117 | 117 | throw new UnexpectedEntityException($new_answer, 'EE_Answer'); |
| 118 | 118 | } |
| 119 | 119 | $new_answer->save(); |
@@ -150,7 +150,7 @@ discard block |
||
| 150 | 150 | 'RPY_amount' => $payment_amount, |
| 151 | 151 | ) |
| 152 | 152 | ); |
| 153 | - if (! $new_registration_payment instanceof EE_Registration_Payment) { |
|
| 153 | + if ( ! $new_registration_payment instanceof EE_Registration_Payment) { |
|
| 154 | 154 | throw new UnexpectedEntityException($new_registration_payment, 'EE_Registration_Payment'); |
| 155 | 155 | } |
| 156 | 156 | $new_registration_payment->save(); |
@@ -15,293 +15,293 @@ |
||
| 15 | 15 | class StatsGatherer |
| 16 | 16 | { |
| 17 | 17 | |
| 18 | - const COUNT_ALL_EVENTS = 'event'; |
|
| 19 | - const COUNT_ACTIVE_EVENTS = 'active_event'; |
|
| 20 | - const COUNT_DATETIMES = 'datetime'; |
|
| 21 | - const COUNT_TICKETS = 'ticket'; |
|
| 22 | - const COUNT_DATETIMES_SOLD = 'datetime_sold'; |
|
| 23 | - const COUNT_TICKETS_FREE = 'free_ticket'; |
|
| 24 | - const COUNT_TICKETS_PAID = 'paid_ticket'; |
|
| 25 | - const COUNT_TICKETS_SOLD = 'ticket_sold'; |
|
| 26 | - const COUNT_REGISTRATIONS_APPROVED = 'registrations_approved'; |
|
| 27 | - const COUNT_REGISTRATIONS_NOT_APPROVED = 'registrations_not_approved'; |
|
| 28 | - const COUNT_REGISTRATIONS_PENDING = 'registrations_pending'; |
|
| 29 | - const COUNT_REGISTRATIONS_INCOMPLETE = 'registrations_incomplete'; |
|
| 30 | - const COUNT_REGISTRATIONS_ALL = 'registrations_all'; |
|
| 31 | - const COUNT_REGISTRATIONS_CANCELLED = 'registrations_cancelled'; |
|
| 32 | - const COUNT_REGISTRATIONS_DECLINED = 'registrations_declined'; |
|
| 33 | - const SUM_TRANSACTIONS_COMPLETE_TOTAL = 'transactions_complete_total_sum'; |
|
| 34 | - const SUM_TRANSACTIONS_ALL_PAID = 'transactions_all_paid'; |
|
| 35 | - const INFO_SITE_CURRENCY = 'site_currency'; |
|
| 18 | + const COUNT_ALL_EVENTS = 'event'; |
|
| 19 | + const COUNT_ACTIVE_EVENTS = 'active_event'; |
|
| 20 | + const COUNT_DATETIMES = 'datetime'; |
|
| 21 | + const COUNT_TICKETS = 'ticket'; |
|
| 22 | + const COUNT_DATETIMES_SOLD = 'datetime_sold'; |
|
| 23 | + const COUNT_TICKETS_FREE = 'free_ticket'; |
|
| 24 | + const COUNT_TICKETS_PAID = 'paid_ticket'; |
|
| 25 | + const COUNT_TICKETS_SOLD = 'ticket_sold'; |
|
| 26 | + const COUNT_REGISTRATIONS_APPROVED = 'registrations_approved'; |
|
| 27 | + const COUNT_REGISTRATIONS_NOT_APPROVED = 'registrations_not_approved'; |
|
| 28 | + const COUNT_REGISTRATIONS_PENDING = 'registrations_pending'; |
|
| 29 | + const COUNT_REGISTRATIONS_INCOMPLETE = 'registrations_incomplete'; |
|
| 30 | + const COUNT_REGISTRATIONS_ALL = 'registrations_all'; |
|
| 31 | + const COUNT_REGISTRATIONS_CANCELLED = 'registrations_cancelled'; |
|
| 32 | + const COUNT_REGISTRATIONS_DECLINED = 'registrations_declined'; |
|
| 33 | + const SUM_TRANSACTIONS_COMPLETE_TOTAL = 'transactions_complete_total_sum'; |
|
| 34 | + const SUM_TRANSACTIONS_ALL_PAID = 'transactions_all_paid'; |
|
| 35 | + const INFO_SITE_CURRENCY = 'site_currency'; |
|
| 36 | 36 | |
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * @var EEM_Payment_Method |
|
| 40 | - */ |
|
| 41 | - private $payment_method_model; |
|
| 38 | + /** |
|
| 39 | + * @var EEM_Payment_Method |
|
| 40 | + */ |
|
| 41 | + private $payment_method_model; |
|
| 42 | 42 | |
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * @var EEM_Event |
|
| 46 | - */ |
|
| 47 | - private $event_model; |
|
| 44 | + /** |
|
| 45 | + * @var EEM_Event |
|
| 46 | + */ |
|
| 47 | + private $event_model; |
|
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * @var EEM_Datetime |
|
| 51 | - */ |
|
| 52 | - private $datetime_model; |
|
| 49 | + /** |
|
| 50 | + * @var EEM_Datetime |
|
| 51 | + */ |
|
| 52 | + private $datetime_model; |
|
| 53 | 53 | |
| 54 | 54 | |
| 55 | - /** |
|
| 56 | - * @var EEM_Ticket |
|
| 57 | - */ |
|
| 58 | - private $ticket_model; |
|
| 55 | + /** |
|
| 56 | + * @var EEM_Ticket |
|
| 57 | + */ |
|
| 58 | + private $ticket_model; |
|
| 59 | 59 | |
| 60 | 60 | |
| 61 | - /** |
|
| 62 | - * @var EEM_Registration |
|
| 63 | - */ |
|
| 64 | - private $registration_model; |
|
| 61 | + /** |
|
| 62 | + * @var EEM_Registration |
|
| 63 | + */ |
|
| 64 | + private $registration_model; |
|
| 65 | 65 | |
| 66 | 66 | |
| 67 | - /** |
|
| 68 | - * @var EEM_Transaction |
|
| 69 | - */ |
|
| 70 | - private $transaction_model; |
|
| 67 | + /** |
|
| 68 | + * @var EEM_Transaction |
|
| 69 | + */ |
|
| 70 | + private $transaction_model; |
|
| 71 | 71 | |
| 72 | 72 | |
| 73 | - /** |
|
| 74 | - * @var EE_Config |
|
| 75 | - */ |
|
| 76 | - private $config; |
|
| 73 | + /** |
|
| 74 | + * @var EE_Config |
|
| 75 | + */ |
|
| 76 | + private $config; |
|
| 77 | 77 | |
| 78 | 78 | |
| 79 | - /** |
|
| 80 | - * StatsGatherer constructor. |
|
| 81 | - * |
|
| 82 | - * @param EEM_Payment_Method $payment_method_model |
|
| 83 | - * @param EEM_Event $event_model |
|
| 84 | - * @param EEM_Datetime $datetime_model |
|
| 85 | - * @param EEM_Ticket $ticket_model |
|
| 86 | - * @param EEM_Registration $registration_model |
|
| 87 | - * @param EEM_Transaction $transaction_model |
|
| 88 | - * @param EE_Config $config |
|
| 89 | - */ |
|
| 90 | - public function __construct( |
|
| 91 | - EEM_Payment_Method $payment_method_model, |
|
| 92 | - EEM_Event $event_model, |
|
| 93 | - EEM_Datetime $datetime_model, |
|
| 94 | - EEM_Ticket $ticket_model, |
|
| 95 | - EEM_Registration $registration_model, |
|
| 96 | - EEM_Transaction $transaction_model, |
|
| 97 | - EE_Config $config |
|
| 98 | - ) { |
|
| 99 | - $this->payment_method_model = $payment_method_model; |
|
| 100 | - $this->event_model = $event_model; |
|
| 101 | - $this->datetime_model = $datetime_model; |
|
| 102 | - $this->ticket_model = $ticket_model; |
|
| 103 | - $this->registration_model = $registration_model; |
|
| 104 | - $this->transaction_model = $transaction_model; |
|
| 105 | - $this->config = $config; |
|
| 106 | - } |
|
| 79 | + /** |
|
| 80 | + * StatsGatherer constructor. |
|
| 81 | + * |
|
| 82 | + * @param EEM_Payment_Method $payment_method_model |
|
| 83 | + * @param EEM_Event $event_model |
|
| 84 | + * @param EEM_Datetime $datetime_model |
|
| 85 | + * @param EEM_Ticket $ticket_model |
|
| 86 | + * @param EEM_Registration $registration_model |
|
| 87 | + * @param EEM_Transaction $transaction_model |
|
| 88 | + * @param EE_Config $config |
|
| 89 | + */ |
|
| 90 | + public function __construct( |
|
| 91 | + EEM_Payment_Method $payment_method_model, |
|
| 92 | + EEM_Event $event_model, |
|
| 93 | + EEM_Datetime $datetime_model, |
|
| 94 | + EEM_Ticket $ticket_model, |
|
| 95 | + EEM_Registration $registration_model, |
|
| 96 | + EEM_Transaction $transaction_model, |
|
| 97 | + EE_Config $config |
|
| 98 | + ) { |
|
| 99 | + $this->payment_method_model = $payment_method_model; |
|
| 100 | + $this->event_model = $event_model; |
|
| 101 | + $this->datetime_model = $datetime_model; |
|
| 102 | + $this->ticket_model = $ticket_model; |
|
| 103 | + $this->registration_model = $registration_model; |
|
| 104 | + $this->transaction_model = $transaction_model; |
|
| 105 | + $this->config = $config; |
|
| 106 | + } |
|
| 107 | 107 | |
| 108 | 108 | |
| 109 | - /** |
|
| 110 | - * Return the stats array for PUE UXIP stats. |
|
| 111 | - * |
|
| 112 | - * @return array |
|
| 113 | - */ |
|
| 114 | - public function stats() |
|
| 115 | - { |
|
| 116 | - $stats = $this->paymentMethodStats(); |
|
| 117 | - // a-ok so let's setup our stats. |
|
| 118 | - $stats = array_merge($stats, array( |
|
| 119 | - 'is_multisite' => is_multisite() && is_main_site(), |
|
| 120 | - 'active_theme' => $this->getActiveThemeStat(), |
|
| 121 | - 'ee4_all_events_count' => $this->getCountFor(self::COUNT_ALL_EVENTS), |
|
| 122 | - 'ee4_active_events_count' => $this->getCountFor(self::COUNT_ACTIVE_EVENTS), |
|
| 123 | - 'all_dtts_count' => $this->getCountFor(self::COUNT_DATETIMES), |
|
| 124 | - 'dtt_sold' => $this->getCountFor(self::COUNT_DATETIMES_SOLD), |
|
| 125 | - 'all_tkt_count' => $this->getCountFor(self::COUNT_TICKETS), |
|
| 126 | - 'free_tkt_count' => $this->getCountFor(self::COUNT_TICKETS_FREE), |
|
| 127 | - 'paid_tkt_count' => $this->getCountFor(self::COUNT_TICKETS_PAID), |
|
| 128 | - 'tkt_sold' => $this->getCountFor(self::COUNT_TICKETS_SOLD), |
|
| 129 | - 'approve_registration_count' => $this->getCountFor(self::COUNT_REGISTRATIONS_APPROVED), |
|
| 130 | - 'pending_registration_count' => $this->getCountFor(self::COUNT_REGISTRATIONS_PENDING), |
|
| 131 | - 'not_approved_registration_count' => $this->getCountFor(self::COUNT_REGISTRATIONS_NOT_APPROVED), |
|
| 132 | - 'incomplete_registration_count' => $this->getCountFor(self::COUNT_REGISTRATIONS_INCOMPLETE), |
|
| 133 | - 'cancelled_registration_count' => $this->getCountFor(self::COUNT_REGISTRATIONS_CANCELLED), |
|
| 134 | - 'declined_registration_count' => $this->getCountFor(self::COUNT_REGISTRATIONS_DECLINED), |
|
| 135 | - 'all_registration_count' => $this->getCountFor(self::COUNT_REGISTRATIONS_ALL), |
|
| 136 | - 'completed_transaction_total_sum' => $this->getCountFor(self::SUM_TRANSACTIONS_COMPLETE_TOTAL), |
|
| 137 | - 'all_transaction_paid_sum' => $this->getCountFor(self::SUM_TRANSACTIONS_ALL_PAID), |
|
| 138 | - self::INFO_SITE_CURRENCY => $this->config->currency instanceof EE_Currency_Config |
|
| 139 | - ? $this->config->currency->code |
|
| 140 | - : 'unknown', |
|
| 141 | - 'phpversion' => implode( |
|
| 142 | - '.', |
|
| 143 | - array(PHP_MAJOR_VERSION, PHP_MINOR_VERSION, PHP_RELEASE_VERSION) |
|
| 144 | - ), |
|
| 145 | - )); |
|
| 146 | - // remove any values that equal null. This ensures any stats that weren't retrieved successfully are excluded. |
|
| 147 | - return array_filter($stats, function ($value) { |
|
| 148 | - return $value !== null; |
|
| 149 | - }); |
|
| 150 | - } |
|
| 109 | + /** |
|
| 110 | + * Return the stats array for PUE UXIP stats. |
|
| 111 | + * |
|
| 112 | + * @return array |
|
| 113 | + */ |
|
| 114 | + public function stats() |
|
| 115 | + { |
|
| 116 | + $stats = $this->paymentMethodStats(); |
|
| 117 | + // a-ok so let's setup our stats. |
|
| 118 | + $stats = array_merge($stats, array( |
|
| 119 | + 'is_multisite' => is_multisite() && is_main_site(), |
|
| 120 | + 'active_theme' => $this->getActiveThemeStat(), |
|
| 121 | + 'ee4_all_events_count' => $this->getCountFor(self::COUNT_ALL_EVENTS), |
|
| 122 | + 'ee4_active_events_count' => $this->getCountFor(self::COUNT_ACTIVE_EVENTS), |
|
| 123 | + 'all_dtts_count' => $this->getCountFor(self::COUNT_DATETIMES), |
|
| 124 | + 'dtt_sold' => $this->getCountFor(self::COUNT_DATETIMES_SOLD), |
|
| 125 | + 'all_tkt_count' => $this->getCountFor(self::COUNT_TICKETS), |
|
| 126 | + 'free_tkt_count' => $this->getCountFor(self::COUNT_TICKETS_FREE), |
|
| 127 | + 'paid_tkt_count' => $this->getCountFor(self::COUNT_TICKETS_PAID), |
|
| 128 | + 'tkt_sold' => $this->getCountFor(self::COUNT_TICKETS_SOLD), |
|
| 129 | + 'approve_registration_count' => $this->getCountFor(self::COUNT_REGISTRATIONS_APPROVED), |
|
| 130 | + 'pending_registration_count' => $this->getCountFor(self::COUNT_REGISTRATIONS_PENDING), |
|
| 131 | + 'not_approved_registration_count' => $this->getCountFor(self::COUNT_REGISTRATIONS_NOT_APPROVED), |
|
| 132 | + 'incomplete_registration_count' => $this->getCountFor(self::COUNT_REGISTRATIONS_INCOMPLETE), |
|
| 133 | + 'cancelled_registration_count' => $this->getCountFor(self::COUNT_REGISTRATIONS_CANCELLED), |
|
| 134 | + 'declined_registration_count' => $this->getCountFor(self::COUNT_REGISTRATIONS_DECLINED), |
|
| 135 | + 'all_registration_count' => $this->getCountFor(self::COUNT_REGISTRATIONS_ALL), |
|
| 136 | + 'completed_transaction_total_sum' => $this->getCountFor(self::SUM_TRANSACTIONS_COMPLETE_TOTAL), |
|
| 137 | + 'all_transaction_paid_sum' => $this->getCountFor(self::SUM_TRANSACTIONS_ALL_PAID), |
|
| 138 | + self::INFO_SITE_CURRENCY => $this->config->currency instanceof EE_Currency_Config |
|
| 139 | + ? $this->config->currency->code |
|
| 140 | + : 'unknown', |
|
| 141 | + 'phpversion' => implode( |
|
| 142 | + '.', |
|
| 143 | + array(PHP_MAJOR_VERSION, PHP_MINOR_VERSION, PHP_RELEASE_VERSION) |
|
| 144 | + ), |
|
| 145 | + )); |
|
| 146 | + // remove any values that equal null. This ensures any stats that weren't retrieved successfully are excluded. |
|
| 147 | + return array_filter($stats, function ($value) { |
|
| 148 | + return $value !== null; |
|
| 149 | + }); |
|
| 150 | + } |
|
| 151 | 151 | |
| 152 | - /** |
|
| 153 | - * @param string $which enum (@see constants prefixed with COUNT) |
|
| 154 | - * @return int|null |
|
| 155 | - */ |
|
| 156 | - private function getCountFor($which) |
|
| 157 | - { |
|
| 158 | - try { |
|
| 159 | - switch ($which) { |
|
| 160 | - case self::COUNT_ALL_EVENTS: |
|
| 161 | - $count = $this->event_model->count(); |
|
| 162 | - break; |
|
| 163 | - case self::COUNT_TICKETS: |
|
| 164 | - $count = $this->ticket_model->count(); |
|
| 165 | - break; |
|
| 166 | - case self::COUNT_DATETIMES: |
|
| 167 | - $count = $this->datetime_model->count(); |
|
| 168 | - break; |
|
| 169 | - case self::COUNT_ACTIVE_EVENTS: |
|
| 170 | - $count = $this->event_model->get_active_events(array(), true); |
|
| 171 | - break; |
|
| 172 | - case self::COUNT_DATETIMES_SOLD: |
|
| 173 | - $count = $this->datetime_model->sum(array(), 'DTT_sold'); |
|
| 174 | - break; |
|
| 175 | - case self::COUNT_TICKETS_FREE: |
|
| 176 | - $count = $this->ticket_model->count(array( |
|
| 177 | - array( |
|
| 178 | - 'TKT_price' => 0, |
|
| 179 | - ), |
|
| 180 | - )); |
|
| 181 | - break; |
|
| 182 | - case self::COUNT_TICKETS_PAID: |
|
| 183 | - $count = $this->ticket_model->count(array( |
|
| 184 | - array( |
|
| 185 | - 'TKT_price' => array('>', 0), |
|
| 186 | - ), |
|
| 187 | - )); |
|
| 188 | - break; |
|
| 189 | - case self::COUNT_TICKETS_SOLD: |
|
| 190 | - $count = $this->ticket_model->sum(array(), 'TKT_sold'); |
|
| 191 | - break; |
|
| 192 | - case self::COUNT_REGISTRATIONS_ALL: |
|
| 193 | - $count = $this->registration_model->count(); |
|
| 194 | - break; |
|
| 195 | - case self::COUNT_REGISTRATIONS_CANCELLED: |
|
| 196 | - $count = $this->registration_model->count( |
|
| 197 | - array( |
|
| 198 | - array( |
|
| 199 | - 'STS_ID' => EEM_Registration::status_id_cancelled, |
|
| 200 | - ), |
|
| 201 | - ) |
|
| 202 | - ); |
|
| 203 | - break; |
|
| 204 | - case self::COUNT_REGISTRATIONS_INCOMPLETE: |
|
| 205 | - $count = $this->registration_model->count( |
|
| 206 | - array( |
|
| 207 | - array( |
|
| 208 | - 'STS_ID' => EEM_Registration::status_id_incomplete, |
|
| 209 | - ), |
|
| 210 | - ) |
|
| 211 | - ); |
|
| 212 | - break; |
|
| 213 | - case self::COUNT_REGISTRATIONS_NOT_APPROVED: |
|
| 214 | - $count = $this->registration_model->count( |
|
| 215 | - array( |
|
| 216 | - array( |
|
| 217 | - 'STS_ID' => EEM_Registration::status_id_not_approved, |
|
| 218 | - ), |
|
| 219 | - ) |
|
| 220 | - ); |
|
| 221 | - break; |
|
| 222 | - case self::COUNT_REGISTRATIONS_DECLINED: |
|
| 223 | - $count = $this->registration_model->count( |
|
| 224 | - array( |
|
| 225 | - array( |
|
| 226 | - 'STS_ID' => EEM_Registration::status_id_declined, |
|
| 227 | - ), |
|
| 228 | - ) |
|
| 229 | - ); |
|
| 230 | - break; |
|
| 231 | - case self::COUNT_REGISTRATIONS_PENDING: |
|
| 232 | - $count = $this->registration_model->count( |
|
| 233 | - array( |
|
| 234 | - array( |
|
| 235 | - 'STS_ID' => EEM_Registration::status_id_pending_payment, |
|
| 236 | - ), |
|
| 237 | - ) |
|
| 238 | - ); |
|
| 239 | - break; |
|
| 240 | - case self::COUNT_REGISTRATIONS_APPROVED: |
|
| 241 | - $count = $this->registration_model->count( |
|
| 242 | - array( |
|
| 243 | - array( |
|
| 244 | - 'STS_ID' => EEM_Registration::status_id_approved, |
|
| 245 | - ), |
|
| 246 | - ) |
|
| 247 | - ); |
|
| 248 | - break; |
|
| 249 | - case self::SUM_TRANSACTIONS_COMPLETE_TOTAL: |
|
| 250 | - $count = $this->transaction_model->sum( |
|
| 251 | - array( |
|
| 252 | - array( |
|
| 253 | - 'STS_ID' => EEM_Transaction::complete_status_code, |
|
| 254 | - ), |
|
| 255 | - ), |
|
| 256 | - 'TXN_total' |
|
| 257 | - ); |
|
| 258 | - break; |
|
| 259 | - case self::SUM_TRANSACTIONS_ALL_PAID: |
|
| 260 | - $count = $this->transaction_model->sum( |
|
| 261 | - array(), |
|
| 262 | - 'TXN_paid' |
|
| 263 | - ); |
|
| 264 | - break; |
|
| 265 | - default: |
|
| 266 | - $count = null; |
|
| 267 | - break; |
|
| 268 | - } |
|
| 269 | - } catch (Exception $e) { |
|
| 270 | - $count = null; |
|
| 271 | - } |
|
| 272 | - return $count; |
|
| 273 | - } |
|
| 152 | + /** |
|
| 153 | + * @param string $which enum (@see constants prefixed with COUNT) |
|
| 154 | + * @return int|null |
|
| 155 | + */ |
|
| 156 | + private function getCountFor($which) |
|
| 157 | + { |
|
| 158 | + try { |
|
| 159 | + switch ($which) { |
|
| 160 | + case self::COUNT_ALL_EVENTS: |
|
| 161 | + $count = $this->event_model->count(); |
|
| 162 | + break; |
|
| 163 | + case self::COUNT_TICKETS: |
|
| 164 | + $count = $this->ticket_model->count(); |
|
| 165 | + break; |
|
| 166 | + case self::COUNT_DATETIMES: |
|
| 167 | + $count = $this->datetime_model->count(); |
|
| 168 | + break; |
|
| 169 | + case self::COUNT_ACTIVE_EVENTS: |
|
| 170 | + $count = $this->event_model->get_active_events(array(), true); |
|
| 171 | + break; |
|
| 172 | + case self::COUNT_DATETIMES_SOLD: |
|
| 173 | + $count = $this->datetime_model->sum(array(), 'DTT_sold'); |
|
| 174 | + break; |
|
| 175 | + case self::COUNT_TICKETS_FREE: |
|
| 176 | + $count = $this->ticket_model->count(array( |
|
| 177 | + array( |
|
| 178 | + 'TKT_price' => 0, |
|
| 179 | + ), |
|
| 180 | + )); |
|
| 181 | + break; |
|
| 182 | + case self::COUNT_TICKETS_PAID: |
|
| 183 | + $count = $this->ticket_model->count(array( |
|
| 184 | + array( |
|
| 185 | + 'TKT_price' => array('>', 0), |
|
| 186 | + ), |
|
| 187 | + )); |
|
| 188 | + break; |
|
| 189 | + case self::COUNT_TICKETS_SOLD: |
|
| 190 | + $count = $this->ticket_model->sum(array(), 'TKT_sold'); |
|
| 191 | + break; |
|
| 192 | + case self::COUNT_REGISTRATIONS_ALL: |
|
| 193 | + $count = $this->registration_model->count(); |
|
| 194 | + break; |
|
| 195 | + case self::COUNT_REGISTRATIONS_CANCELLED: |
|
| 196 | + $count = $this->registration_model->count( |
|
| 197 | + array( |
|
| 198 | + array( |
|
| 199 | + 'STS_ID' => EEM_Registration::status_id_cancelled, |
|
| 200 | + ), |
|
| 201 | + ) |
|
| 202 | + ); |
|
| 203 | + break; |
|
| 204 | + case self::COUNT_REGISTRATIONS_INCOMPLETE: |
|
| 205 | + $count = $this->registration_model->count( |
|
| 206 | + array( |
|
| 207 | + array( |
|
| 208 | + 'STS_ID' => EEM_Registration::status_id_incomplete, |
|
| 209 | + ), |
|
| 210 | + ) |
|
| 211 | + ); |
|
| 212 | + break; |
|
| 213 | + case self::COUNT_REGISTRATIONS_NOT_APPROVED: |
|
| 214 | + $count = $this->registration_model->count( |
|
| 215 | + array( |
|
| 216 | + array( |
|
| 217 | + 'STS_ID' => EEM_Registration::status_id_not_approved, |
|
| 218 | + ), |
|
| 219 | + ) |
|
| 220 | + ); |
|
| 221 | + break; |
|
| 222 | + case self::COUNT_REGISTRATIONS_DECLINED: |
|
| 223 | + $count = $this->registration_model->count( |
|
| 224 | + array( |
|
| 225 | + array( |
|
| 226 | + 'STS_ID' => EEM_Registration::status_id_declined, |
|
| 227 | + ), |
|
| 228 | + ) |
|
| 229 | + ); |
|
| 230 | + break; |
|
| 231 | + case self::COUNT_REGISTRATIONS_PENDING: |
|
| 232 | + $count = $this->registration_model->count( |
|
| 233 | + array( |
|
| 234 | + array( |
|
| 235 | + 'STS_ID' => EEM_Registration::status_id_pending_payment, |
|
| 236 | + ), |
|
| 237 | + ) |
|
| 238 | + ); |
|
| 239 | + break; |
|
| 240 | + case self::COUNT_REGISTRATIONS_APPROVED: |
|
| 241 | + $count = $this->registration_model->count( |
|
| 242 | + array( |
|
| 243 | + array( |
|
| 244 | + 'STS_ID' => EEM_Registration::status_id_approved, |
|
| 245 | + ), |
|
| 246 | + ) |
|
| 247 | + ); |
|
| 248 | + break; |
|
| 249 | + case self::SUM_TRANSACTIONS_COMPLETE_TOTAL: |
|
| 250 | + $count = $this->transaction_model->sum( |
|
| 251 | + array( |
|
| 252 | + array( |
|
| 253 | + 'STS_ID' => EEM_Transaction::complete_status_code, |
|
| 254 | + ), |
|
| 255 | + ), |
|
| 256 | + 'TXN_total' |
|
| 257 | + ); |
|
| 258 | + break; |
|
| 259 | + case self::SUM_TRANSACTIONS_ALL_PAID: |
|
| 260 | + $count = $this->transaction_model->sum( |
|
| 261 | + array(), |
|
| 262 | + 'TXN_paid' |
|
| 263 | + ); |
|
| 264 | + break; |
|
| 265 | + default: |
|
| 266 | + $count = null; |
|
| 267 | + break; |
|
| 268 | + } |
|
| 269 | + } catch (Exception $e) { |
|
| 270 | + $count = null; |
|
| 271 | + } |
|
| 272 | + return $count; |
|
| 273 | + } |
|
| 274 | 274 | |
| 275 | - /** |
|
| 276 | - * Return the active theme. |
|
| 277 | - * |
|
| 278 | - * @return false|string |
|
| 279 | - */ |
|
| 280 | - private function getActiveThemeStat() |
|
| 281 | - { |
|
| 282 | - $theme = wp_get_theme(); |
|
| 283 | - return $theme->get('Name'); |
|
| 284 | - } |
|
| 275 | + /** |
|
| 276 | + * Return the active theme. |
|
| 277 | + * |
|
| 278 | + * @return false|string |
|
| 279 | + */ |
|
| 280 | + private function getActiveThemeStat() |
|
| 281 | + { |
|
| 282 | + $theme = wp_get_theme(); |
|
| 283 | + return $theme->get('Name'); |
|
| 284 | + } |
|
| 285 | 285 | |
| 286 | - /** |
|
| 287 | - * @return array |
|
| 288 | - */ |
|
| 289 | - private function paymentMethodStats() |
|
| 290 | - { |
|
| 291 | - $payment_method_stats = array(); |
|
| 292 | - try { |
|
| 293 | - $active_payment_methods = $this->payment_method_model->get_all_active( |
|
| 294 | - null, |
|
| 295 | - array('group_by' => 'PMD_type') |
|
| 296 | - ); |
|
| 297 | - if ($active_payment_methods) { |
|
| 298 | - foreach ($active_payment_methods as $payment_method) { |
|
| 299 | - $payment_method_stats[ $payment_method->name() . '_active_payment_method' ] = 1; |
|
| 300 | - } |
|
| 301 | - } |
|
| 302 | - } catch (Exception $e) { |
|
| 303 | - // do nothing just prevents fatals. |
|
| 304 | - } |
|
| 305 | - return $payment_method_stats; |
|
| 306 | - } |
|
| 286 | + /** |
|
| 287 | + * @return array |
|
| 288 | + */ |
|
| 289 | + private function paymentMethodStats() |
|
| 290 | + { |
|
| 291 | + $payment_method_stats = array(); |
|
| 292 | + try { |
|
| 293 | + $active_payment_methods = $this->payment_method_model->get_all_active( |
|
| 294 | + null, |
|
| 295 | + array('group_by' => 'PMD_type') |
|
| 296 | + ); |
|
| 297 | + if ($active_payment_methods) { |
|
| 298 | + foreach ($active_payment_methods as $payment_method) { |
|
| 299 | + $payment_method_stats[ $payment_method->name() . '_active_payment_method' ] = 1; |
|
| 300 | + } |
|
| 301 | + } |
|
| 302 | + } catch (Exception $e) { |
|
| 303 | + // do nothing just prevents fatals. |
|
| 304 | + } |
|
| 305 | + return $payment_method_stats; |
|
| 306 | + } |
|
| 307 | 307 | } |
@@ -144,7 +144,7 @@ discard block |
||
| 144 | 144 | ), |
| 145 | 145 | )); |
| 146 | 146 | // remove any values that equal null. This ensures any stats that weren't retrieved successfully are excluded. |
| 147 | - return array_filter($stats, function ($value) { |
|
| 147 | + return array_filter($stats, function($value) { |
|
| 148 | 148 | return $value !== null; |
| 149 | 149 | }); |
| 150 | 150 | } |
@@ -296,7 +296,7 @@ discard block |
||
| 296 | 296 | ); |
| 297 | 297 | if ($active_payment_methods) { |
| 298 | 298 | foreach ($active_payment_methods as $payment_method) { |
| 299 | - $payment_method_stats[ $payment_method->name() . '_active_payment_method' ] = 1; |
|
| 299 | + $payment_method_stats[$payment_method->name().'_active_payment_method'] = 1; |
|
| 300 | 300 | } |
| 301 | 301 | } |
| 302 | 302 | } catch (Exception $e) { |