@@ -18,14 +18,14 @@ |
||
18 | 18 | interface EmailValidatorInterface |
19 | 19 | { |
20 | 20 | |
21 | - /** |
|
22 | - * Validates the supplied email address. If it is invalid, throws EmailValidationException |
|
23 | - * |
|
24 | - * @param string $email_address |
|
25 | - * @return boolean |
|
26 | - * @throws EmailValidationException |
|
27 | - */ |
|
28 | - public function validate($email_address); |
|
21 | + /** |
|
22 | + * Validates the supplied email address. If it is invalid, throws EmailValidationException |
|
23 | + * |
|
24 | + * @param string $email_address |
|
25 | + * @return boolean |
|
26 | + * @throws EmailValidationException |
|
27 | + */ |
|
28 | + public function validate($email_address); |
|
29 | 29 | |
30 | 30 | |
31 | 31 | } |
@@ -19,61 +19,61 @@ |
||
19 | 19 | class EmailAddress |
20 | 20 | { |
21 | 21 | |
22 | - /** |
|
23 | - * @var string $email_address |
|
24 | - */ |
|
25 | - private $email_address; |
|
26 | - |
|
27 | - |
|
28 | - |
|
29 | - /** |
|
30 | - * EmailAddress constructor. |
|
31 | - * |
|
32 | - * @param string $email_address |
|
33 | - * @param EmailValidatorInterface $validator |
|
34 | - * @throws EmailValidationException |
|
35 | - */ |
|
36 | - public function __construct($email_address, EmailValidatorInterface $validator) |
|
37 | - { |
|
38 | - $validator->validate($email_address); |
|
39 | - $this->email_address = $email_address; |
|
40 | - } |
|
41 | - |
|
42 | - |
|
43 | - |
|
44 | - /** |
|
45 | - * returns the string value for this EmailAddress |
|
46 | - * |
|
47 | - * @return string |
|
48 | - */ |
|
49 | - public function get() |
|
50 | - { |
|
51 | - return $this->email_address; |
|
52 | - } |
|
53 | - |
|
54 | - |
|
55 | - |
|
56 | - /** |
|
57 | - * compare another EmailAddress to this one to determine if they are the same |
|
58 | - * |
|
59 | - * @param EmailAddress $address |
|
60 | - * @return bool |
|
61 | - */ |
|
62 | - public function equals(EmailAddress $address) |
|
63 | - { |
|
64 | - return strtolower((string)$this) === strtolower((string)$address); |
|
65 | - } |
|
66 | - |
|
67 | - |
|
68 | - /** |
|
69 | - * allows an EmailAddress object to be used as a string |
|
70 | - * |
|
71 | - * @return string |
|
72 | - */ |
|
73 | - public function __toString() |
|
74 | - { |
|
75 | - return $this->email_address; |
|
76 | - } |
|
22 | + /** |
|
23 | + * @var string $email_address |
|
24 | + */ |
|
25 | + private $email_address; |
|
26 | + |
|
27 | + |
|
28 | + |
|
29 | + /** |
|
30 | + * EmailAddress constructor. |
|
31 | + * |
|
32 | + * @param string $email_address |
|
33 | + * @param EmailValidatorInterface $validator |
|
34 | + * @throws EmailValidationException |
|
35 | + */ |
|
36 | + public function __construct($email_address, EmailValidatorInterface $validator) |
|
37 | + { |
|
38 | + $validator->validate($email_address); |
|
39 | + $this->email_address = $email_address; |
|
40 | + } |
|
41 | + |
|
42 | + |
|
43 | + |
|
44 | + /** |
|
45 | + * returns the string value for this EmailAddress |
|
46 | + * |
|
47 | + * @return string |
|
48 | + */ |
|
49 | + public function get() |
|
50 | + { |
|
51 | + return $this->email_address; |
|
52 | + } |
|
53 | + |
|
54 | + |
|
55 | + |
|
56 | + /** |
|
57 | + * compare another EmailAddress to this one to determine if they are the same |
|
58 | + * |
|
59 | + * @param EmailAddress $address |
|
60 | + * @return bool |
|
61 | + */ |
|
62 | + public function equals(EmailAddress $address) |
|
63 | + { |
|
64 | + return strtolower((string)$this) === strtolower((string)$address); |
|
65 | + } |
|
66 | + |
|
67 | + |
|
68 | + /** |
|
69 | + * allows an EmailAddress object to be used as a string |
|
70 | + * |
|
71 | + * @return string |
|
72 | + */ |
|
73 | + public function __toString() |
|
74 | + { |
|
75 | + return $this->email_address; |
|
76 | + } |
|
77 | 77 | |
78 | 78 | |
79 | 79 |
@@ -61,7 +61,7 @@ |
||
61 | 61 | */ |
62 | 62 | public function equals(EmailAddress $address) |
63 | 63 | { |
64 | - return strtolower((string)$this) === strtolower((string)$address); |
|
64 | + return strtolower((string) $this) === strtolower((string) $address); |
|
65 | 65 | } |
66 | 66 | |
67 | 67 |
@@ -18,72 +18,72 @@ |
||
18 | 18 | { |
19 | 19 | |
20 | 20 | |
21 | - /** |
|
22 | - * @param string $validation_error_message |
|
23 | - */ |
|
24 | - public function __construct($validation_error_message = '') |
|
25 | - { |
|
26 | - if (! $validation_error_message) { |
|
27 | - $validation_error_message = esc_html__('Please enter a valid email address.', 'event_espresso'); |
|
28 | - } |
|
29 | - parent::__construct($validation_error_message); |
|
30 | - } |
|
21 | + /** |
|
22 | + * @param string $validation_error_message |
|
23 | + */ |
|
24 | + public function __construct($validation_error_message = '') |
|
25 | + { |
|
26 | + if (! $validation_error_message) { |
|
27 | + $validation_error_message = esc_html__('Please enter a valid email address.', 'event_espresso'); |
|
28 | + } |
|
29 | + parent::__construct($validation_error_message); |
|
30 | + } |
|
31 | 31 | |
32 | 32 | |
33 | 33 | |
34 | - /** |
|
35 | - * just checks the field isn't blank |
|
36 | - * |
|
37 | - * @param $normalized_value |
|
38 | - * @return bool |
|
39 | - * @throws InvalidArgumentException |
|
40 | - * @throws InvalidInterfaceException |
|
41 | - * @throws InvalidDataTypeException |
|
42 | - * @throws EE_Validation_Error |
|
43 | - */ |
|
44 | - public function validate($normalized_value) |
|
45 | - { |
|
46 | - if ($normalized_value && ! $this->_validate_email($normalized_value)) { |
|
47 | - throw new EE_Validation_Error($this->get_validation_error_message(), 'required'); |
|
48 | - } |
|
49 | - return true; |
|
50 | - } |
|
34 | + /** |
|
35 | + * just checks the field isn't blank |
|
36 | + * |
|
37 | + * @param $normalized_value |
|
38 | + * @return bool |
|
39 | + * @throws InvalidArgumentException |
|
40 | + * @throws InvalidInterfaceException |
|
41 | + * @throws InvalidDataTypeException |
|
42 | + * @throws EE_Validation_Error |
|
43 | + */ |
|
44 | + public function validate($normalized_value) |
|
45 | + { |
|
46 | + if ($normalized_value && ! $this->_validate_email($normalized_value)) { |
|
47 | + throw new EE_Validation_Error($this->get_validation_error_message(), 'required'); |
|
48 | + } |
|
49 | + return true; |
|
50 | + } |
|
51 | 51 | |
52 | 52 | |
53 | 53 | |
54 | - /** |
|
55 | - * @return array |
|
56 | - */ |
|
57 | - public function get_jquery_validation_rule_array() |
|
58 | - { |
|
59 | - return array('email' => true, 'messages' => array('email' => $this->get_validation_error_message())); |
|
60 | - } |
|
54 | + /** |
|
55 | + * @return array |
|
56 | + */ |
|
57 | + public function get_jquery_validation_rule_array() |
|
58 | + { |
|
59 | + return array('email' => true, 'messages' => array('email' => $this->get_validation_error_message())); |
|
60 | + } |
|
61 | 61 | |
62 | 62 | |
63 | 63 | |
64 | - /** |
|
65 | - * Validate an email address. |
|
66 | - * Provide email address (raw input) |
|
67 | - * |
|
68 | - * @param $email |
|
69 | - * @return bool of whether the email is valid or not |
|
70 | - * @throws InvalidArgumentException |
|
71 | - * @throws InvalidInterfaceException |
|
72 | - * @throws InvalidDataTypeException |
|
73 | - * @throws EE_Validation_Error |
|
74 | - */ |
|
75 | - private function _validate_email($email) |
|
76 | - { |
|
77 | - try { |
|
78 | - EmailAddressFactory::create($email); |
|
79 | - } catch (EmailValidationException $e) { |
|
80 | - throw new EE_Validation_Error( |
|
81 | - $e->getMessage(), |
|
82 | - 'invalid_email', |
|
83 | - $this->_input, |
|
84 | - $e |
|
85 | - ); |
|
86 | - } |
|
87 | - return true; |
|
88 | - } |
|
64 | + /** |
|
65 | + * Validate an email address. |
|
66 | + * Provide email address (raw input) |
|
67 | + * |
|
68 | + * @param $email |
|
69 | + * @return bool of whether the email is valid or not |
|
70 | + * @throws InvalidArgumentException |
|
71 | + * @throws InvalidInterfaceException |
|
72 | + * @throws InvalidDataTypeException |
|
73 | + * @throws EE_Validation_Error |
|
74 | + */ |
|
75 | + private function _validate_email($email) |
|
76 | + { |
|
77 | + try { |
|
78 | + EmailAddressFactory::create($email); |
|
79 | + } catch (EmailValidationException $e) { |
|
80 | + throw new EE_Validation_Error( |
|
81 | + $e->getMessage(), |
|
82 | + 'invalid_email', |
|
83 | + $this->_input, |
|
84 | + $e |
|
85 | + ); |
|
86 | + } |
|
87 | + return true; |
|
88 | + } |
|
89 | 89 | } |
@@ -23,7 +23,7 @@ |
||
23 | 23 | */ |
24 | 24 | public function __construct($validation_error_message = '') |
25 | 25 | { |
26 | - if (! $validation_error_message) { |
|
26 | + if ( ! $validation_error_message) { |
|
27 | 27 | $validation_error_message = esc_html__('Please enter a valid email address.', 'event_espresso'); |
28 | 28 | } |
29 | 29 | parent::__construct($validation_error_message); |
@@ -23,21 +23,21 @@ |
||
23 | 23 | class EmailAddressFactory implements FactoryInterface |
24 | 24 | { |
25 | 25 | |
26 | - /** |
|
27 | - * @param string $email_address |
|
28 | - * @return EmailAddress |
|
29 | - * @throws EmailValidationException |
|
30 | - * @throws InvalidDataTypeException |
|
31 | - * @throws InvalidInterfaceException |
|
32 | - * @throws InvalidArgumentException |
|
33 | - */ |
|
34 | - public static function create($email_address) |
|
35 | - { |
|
36 | - return LoaderFactory::getLoader()->getNew( |
|
37 | - 'EventEspresso\core\domain\values\EmailAddress', |
|
38 | - array($email_address) |
|
39 | - ); |
|
40 | - } |
|
26 | + /** |
|
27 | + * @param string $email_address |
|
28 | + * @return EmailAddress |
|
29 | + * @throws EmailValidationException |
|
30 | + * @throws InvalidDataTypeException |
|
31 | + * @throws InvalidInterfaceException |
|
32 | + * @throws InvalidArgumentException |
|
33 | + */ |
|
34 | + public static function create($email_address) |
|
35 | + { |
|
36 | + return LoaderFactory::getLoader()->getNew( |
|
37 | + 'EventEspresso\core\domain\values\EmailAddress', |
|
38 | + array($email_address) |
|
39 | + ); |
|
40 | + } |
|
41 | 41 | |
42 | 42 | } |
43 | 43 | // Location: core/domain/services/factories/EmailAddressFactory.php |
@@ -1,5 +1,4 @@ |
||
1 | 1 | <?php |
2 | -use EventEspresso\core\services\loaders\Loader; |
|
3 | 2 | use EventEspresso\core\services\orm\ModelFieldFactory; |
4 | 3 | |
5 | 4 | defined('EVENT_ESPRESSO_VERSION') || exit('No direct script access allowed'); |
@@ -358,7 +358,7 @@ discard block |
||
358 | 358 | return false; |
359 | 359 | } |
360 | 360 | $attendee = $this->get_all(array($where_cols_n_values)); |
361 | - if (! empty($attendee)) { |
|
361 | + if ( ! empty($attendee)) { |
|
362 | 362 | return array_shift($attendee); |
363 | 363 | } |
364 | 364 | return false; |
@@ -418,7 +418,7 @@ discard block |
||
418 | 418 | */ |
419 | 419 | public function get_array_of_contacts_from_reg_ids($ids) |
420 | 420 | { |
421 | - $ids = (array)$ids; |
|
421 | + $ids = (array) $ids; |
|
422 | 422 | $_where = array( |
423 | 423 | 'Registration.REG_ID' => array('in', $ids), |
424 | 424 | ); |
@@ -3,7 +3,7 @@ discard block |
||
3 | 3 | use EventEspresso\core\services\orm\ModelFieldFactory; |
4 | 4 | |
5 | 5 | if (! defined('EVENT_ESPRESSO_VERSION')) { |
6 | - exit('No direct script access allowed'); |
|
6 | + exit('No direct script access allowed'); |
|
7 | 7 | } |
8 | 8 | |
9 | 9 | |
@@ -19,128 +19,128 @@ discard block |
||
19 | 19 | class EEM_WP_User extends EEM_Base |
20 | 20 | { |
21 | 21 | |
22 | - /** |
|
23 | - * private instance of the EEM_WP_User object |
|
24 | - * |
|
25 | - * @type EEM_WP_User |
|
26 | - */ |
|
27 | - protected static $_instance; |
|
28 | - |
|
29 | - |
|
30 | - |
|
31 | - /** |
|
32 | - * constructor |
|
33 | - * |
|
34 | - * @param null $timezone |
|
35 | - * @param ModelFieldFactory $model_field_factory |
|
36 | - * @throws EE_Error |
|
37 | - * @throws InvalidArgumentException |
|
38 | - */ |
|
39 | - protected function __construct($timezone = null, ModelFieldFactory $model_field_factory) |
|
40 | - { |
|
41 | - $this->singular_item = __('WP_User', 'event_espresso'); |
|
42 | - $this->plural_item = __('WP_Users', 'event_espresso'); |
|
43 | - global $wpdb; |
|
44 | - $this->_tables = array( |
|
45 | - 'WP_User' => new EE_Primary_Table($wpdb->users, 'ID', true), |
|
46 | - ); |
|
47 | - $this->_fields = array( |
|
48 | - 'WP_User' => array( |
|
49 | - 'ID' => $model_field_factory->createPrimaryKeyIntField( |
|
50 | - 'ID', |
|
51 | - __('WP_User ID', 'event_espresso') |
|
52 | - ), |
|
53 | - 'user_login' => $model_field_factory->createPlainTextField( |
|
54 | - 'user_login', |
|
55 | - __('User Login', 'event_espresso'), |
|
56 | - false |
|
57 | - ), |
|
58 | - 'user_pass' => $model_field_factory->createPlainTextField( |
|
59 | - 'user_pass', |
|
60 | - __('User Password', 'event_espresso'), |
|
61 | - false |
|
62 | - ), |
|
63 | - 'user_nicename' => $model_field_factory->createPlainTextField( |
|
64 | - 'user_nicename', |
|
65 | - __(' User Nice Name', 'event_espresso'), |
|
66 | - false |
|
67 | - ), |
|
68 | - 'user_email' => $model_field_factory->createEmailField( |
|
69 | - 'user_email', |
|
70 | - __('User Email', 'event_espresso'), |
|
71 | - false, |
|
72 | - null |
|
73 | - ), |
|
74 | - 'user_registered' => $model_field_factory->createDatetimeField( |
|
75 | - 'user_registered', |
|
76 | - __('Date User Registered', 'event_espresso'), |
|
77 | - $timezone |
|
78 | - ), |
|
79 | - 'user_activation_key' => $model_field_factory->createPlainTextField( |
|
80 | - 'user_activation_key', |
|
81 | - __('User Activation Key', 'event_espresso'), |
|
82 | - false |
|
83 | - ), |
|
84 | - 'user_status' => $model_field_factory->createIntegerField( |
|
85 | - 'user_status', |
|
86 | - __('User Status', 'event_espresso') |
|
87 | - ), |
|
88 | - 'display_name' => $model_field_factory->createPlainTextField( |
|
89 | - 'display_name', |
|
90 | - __('Display Name', 'event_espresso'), |
|
91 | - false |
|
92 | - ), |
|
93 | - ), |
|
94 | - ); |
|
95 | - $this->_model_relations = array( |
|
96 | - 'Attendee' => new EE_Has_Many_Relation(), |
|
97 | - // all models are related to the change log |
|
98 | - // 'Change_Log' => new EE_Has_Many_Relation(), |
|
99 | - 'Event' => new EE_Has_Many_Relation(), |
|
100 | - 'Payment_Method' => new EE_Has_Many_Relation(), |
|
101 | - 'Price' => new EE_Has_Many_Relation(), |
|
102 | - 'Price_Type' => new EE_Has_Many_Relation(), |
|
103 | - 'Question' => new EE_Has_Many_Relation(), |
|
104 | - 'Question_Group' => new EE_Has_Many_Relation(), |
|
105 | - 'Ticket' => new EE_Has_Many_Relation(), |
|
106 | - 'Venue' => new EE_Has_Many_Relation(), |
|
107 | - 'Message' => new EE_Has_Many_Relation(), |
|
108 | - ); |
|
109 | - $this->_wp_core_model = true; |
|
110 | - $this->_caps_slug = 'users'; |
|
111 | - $this->_cap_contexts_to_cap_action_map[EEM_Base::caps_read] = 'list'; |
|
112 | - $this->_cap_contexts_to_cap_action_map[EEM_Base::caps_read_admin] = 'list'; |
|
113 | - foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) { |
|
114 | - $this->_cap_restriction_generators[$context] = new EE_Restriction_Generator_WP_User(); |
|
115 | - } |
|
116 | - //@todo: account for create_users controls whether they can create users at all |
|
117 | - parent::__construct($timezone); |
|
118 | - } |
|
119 | - |
|
120 | - |
|
121 | - |
|
122 | - /** |
|
123 | - * We don't need a foreign key to the WP_User model, we just need its primary key |
|
124 | - * |
|
125 | - * @return string |
|
126 | - * @throws EE_Error |
|
127 | - */ |
|
128 | - public function wp_user_field_name() |
|
129 | - { |
|
130 | - return $this->primary_key_name(); |
|
131 | - } |
|
132 | - |
|
133 | - |
|
134 | - |
|
135 | - /** |
|
136 | - * This WP_User model IS owned, even though it doesn't have a foreign key to itself |
|
137 | - * |
|
138 | - * @return boolean |
|
139 | - */ |
|
140 | - public function is_owned() |
|
141 | - { |
|
142 | - return true; |
|
143 | - } |
|
22 | + /** |
|
23 | + * private instance of the EEM_WP_User object |
|
24 | + * |
|
25 | + * @type EEM_WP_User |
|
26 | + */ |
|
27 | + protected static $_instance; |
|
28 | + |
|
29 | + |
|
30 | + |
|
31 | + /** |
|
32 | + * constructor |
|
33 | + * |
|
34 | + * @param null $timezone |
|
35 | + * @param ModelFieldFactory $model_field_factory |
|
36 | + * @throws EE_Error |
|
37 | + * @throws InvalidArgumentException |
|
38 | + */ |
|
39 | + protected function __construct($timezone = null, ModelFieldFactory $model_field_factory) |
|
40 | + { |
|
41 | + $this->singular_item = __('WP_User', 'event_espresso'); |
|
42 | + $this->plural_item = __('WP_Users', 'event_espresso'); |
|
43 | + global $wpdb; |
|
44 | + $this->_tables = array( |
|
45 | + 'WP_User' => new EE_Primary_Table($wpdb->users, 'ID', true), |
|
46 | + ); |
|
47 | + $this->_fields = array( |
|
48 | + 'WP_User' => array( |
|
49 | + 'ID' => $model_field_factory->createPrimaryKeyIntField( |
|
50 | + 'ID', |
|
51 | + __('WP_User ID', 'event_espresso') |
|
52 | + ), |
|
53 | + 'user_login' => $model_field_factory->createPlainTextField( |
|
54 | + 'user_login', |
|
55 | + __('User Login', 'event_espresso'), |
|
56 | + false |
|
57 | + ), |
|
58 | + 'user_pass' => $model_field_factory->createPlainTextField( |
|
59 | + 'user_pass', |
|
60 | + __('User Password', 'event_espresso'), |
|
61 | + false |
|
62 | + ), |
|
63 | + 'user_nicename' => $model_field_factory->createPlainTextField( |
|
64 | + 'user_nicename', |
|
65 | + __(' User Nice Name', 'event_espresso'), |
|
66 | + false |
|
67 | + ), |
|
68 | + 'user_email' => $model_field_factory->createEmailField( |
|
69 | + 'user_email', |
|
70 | + __('User Email', 'event_espresso'), |
|
71 | + false, |
|
72 | + null |
|
73 | + ), |
|
74 | + 'user_registered' => $model_field_factory->createDatetimeField( |
|
75 | + 'user_registered', |
|
76 | + __('Date User Registered', 'event_espresso'), |
|
77 | + $timezone |
|
78 | + ), |
|
79 | + 'user_activation_key' => $model_field_factory->createPlainTextField( |
|
80 | + 'user_activation_key', |
|
81 | + __('User Activation Key', 'event_espresso'), |
|
82 | + false |
|
83 | + ), |
|
84 | + 'user_status' => $model_field_factory->createIntegerField( |
|
85 | + 'user_status', |
|
86 | + __('User Status', 'event_espresso') |
|
87 | + ), |
|
88 | + 'display_name' => $model_field_factory->createPlainTextField( |
|
89 | + 'display_name', |
|
90 | + __('Display Name', 'event_espresso'), |
|
91 | + false |
|
92 | + ), |
|
93 | + ), |
|
94 | + ); |
|
95 | + $this->_model_relations = array( |
|
96 | + 'Attendee' => new EE_Has_Many_Relation(), |
|
97 | + // all models are related to the change log |
|
98 | + // 'Change_Log' => new EE_Has_Many_Relation(), |
|
99 | + 'Event' => new EE_Has_Many_Relation(), |
|
100 | + 'Payment_Method' => new EE_Has_Many_Relation(), |
|
101 | + 'Price' => new EE_Has_Many_Relation(), |
|
102 | + 'Price_Type' => new EE_Has_Many_Relation(), |
|
103 | + 'Question' => new EE_Has_Many_Relation(), |
|
104 | + 'Question_Group' => new EE_Has_Many_Relation(), |
|
105 | + 'Ticket' => new EE_Has_Many_Relation(), |
|
106 | + 'Venue' => new EE_Has_Many_Relation(), |
|
107 | + 'Message' => new EE_Has_Many_Relation(), |
|
108 | + ); |
|
109 | + $this->_wp_core_model = true; |
|
110 | + $this->_caps_slug = 'users'; |
|
111 | + $this->_cap_contexts_to_cap_action_map[EEM_Base::caps_read] = 'list'; |
|
112 | + $this->_cap_contexts_to_cap_action_map[EEM_Base::caps_read_admin] = 'list'; |
|
113 | + foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) { |
|
114 | + $this->_cap_restriction_generators[$context] = new EE_Restriction_Generator_WP_User(); |
|
115 | + } |
|
116 | + //@todo: account for create_users controls whether they can create users at all |
|
117 | + parent::__construct($timezone); |
|
118 | + } |
|
119 | + |
|
120 | + |
|
121 | + |
|
122 | + /** |
|
123 | + * We don't need a foreign key to the WP_User model, we just need its primary key |
|
124 | + * |
|
125 | + * @return string |
|
126 | + * @throws EE_Error |
|
127 | + */ |
|
128 | + public function wp_user_field_name() |
|
129 | + { |
|
130 | + return $this->primary_key_name(); |
|
131 | + } |
|
132 | + |
|
133 | + |
|
134 | + |
|
135 | + /** |
|
136 | + * This WP_User model IS owned, even though it doesn't have a foreign key to itself |
|
137 | + * |
|
138 | + * @return boolean |
|
139 | + */ |
|
140 | + public function is_owned() |
|
141 | + { |
|
142 | + return true; |
|
143 | + } |
|
144 | 144 | |
145 | 145 | |
146 | 146 |
@@ -2,7 +2,7 @@ |
||
2 | 2 | |
3 | 3 | use EventEspresso\core\services\orm\ModelFieldFactory; |
4 | 4 | |
5 | -if (! defined('EVENT_ESPRESSO_VERSION')) { |
|
5 | +if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
6 | 6 | exit('No direct script access allowed'); |
7 | 7 | } |
8 | 8 |
@@ -1,7 +1,7 @@ discard block |
||
1 | 1 | <?php use EventEspresso\core\services\orm\ModelFieldFactory; |
2 | 2 | |
3 | 3 | if (! defined('EVENT_ESPRESSO_VERSION')) { |
4 | - exit('No direct script access allowed'); |
|
4 | + exit('No direct script access allowed'); |
|
5 | 5 | } |
6 | 6 | require_once(EE_MODELS . 'EEM_CPT_Base.model.php'); |
7 | 7 | |
@@ -18,772 +18,772 @@ discard block |
||
18 | 18 | class EEM_Event extends EEM_CPT_Base |
19 | 19 | { |
20 | 20 | |
21 | - /** |
|
22 | - * constant used by status(), indicating that no more tickets can be purchased for any of the datetimes for the |
|
23 | - * event |
|
24 | - */ |
|
25 | - const sold_out = 'sold_out'; |
|
26 | - |
|
27 | - /** |
|
28 | - * constant used by status(), indicating that upcoming event dates have been postponed (may be pushed to a later |
|
29 | - * date) |
|
30 | - */ |
|
31 | - const postponed = 'postponed'; |
|
32 | - |
|
33 | - /** |
|
34 | - * constant used by status(), indicating that the event will no longer occur |
|
35 | - */ |
|
36 | - const cancelled = 'cancelled'; |
|
37 | - |
|
38 | - |
|
39 | - /** |
|
40 | - * @var string |
|
41 | - */ |
|
42 | - protected static $_default_reg_status; |
|
43 | - |
|
44 | - |
|
45 | - /** |
|
46 | - * This is the default for the additional limit field. |
|
47 | - * @var int |
|
48 | - */ |
|
49 | - protected static $_default_additional_limit = 10; |
|
50 | - |
|
51 | - |
|
52 | - /** |
|
53 | - * private instance of the Event object |
|
54 | - * |
|
55 | - * @var EEM_Event |
|
56 | - */ |
|
57 | - protected static $_instance; |
|
58 | - |
|
59 | - |
|
60 | - |
|
61 | - |
|
62 | - /** |
|
63 | - * Adds a relationship to Term_Taxonomy for each CPT_Base |
|
64 | - * |
|
65 | - * @param string $timezone |
|
66 | - * @throws \EE_Error |
|
67 | - */ |
|
68 | - protected function __construct($timezone = null) |
|
69 | - { |
|
70 | - EE_Registry::instance()->load_model('Registration'); |
|
71 | - $this->singular_item = esc_html__('Event', 'event_espresso'); |
|
72 | - $this->plural_item = esc_html__('Events', 'event_espresso'); |
|
73 | - // to remove Cancelled events from the frontend, copy the following filter to your functions.php file |
|
74 | - // add_filter( 'AFEE__EEM_Event__construct___custom_stati__cancelled__Public', '__return_false' ); |
|
75 | - // to remove Postponed events from the frontend, copy the following filter to your functions.php file |
|
76 | - // add_filter( 'AFEE__EEM_Event__construct___custom_stati__postponed__Public', '__return_false' ); |
|
77 | - // to remove Sold Out events from the frontend, copy the following filter to your functions.php file |
|
78 | - // add_filter( 'AFEE__EEM_Event__construct___custom_stati__sold_out__Public', '__return_false' ); |
|
79 | - $this->_custom_stati = apply_filters( |
|
80 | - 'AFEE__EEM_Event__construct___custom_stati', |
|
81 | - array( |
|
82 | - EEM_Event::cancelled => array( |
|
83 | - 'label' => esc_html__('Cancelled', 'event_espresso'), |
|
84 | - 'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__cancelled__Public', true), |
|
85 | - ), |
|
86 | - EEM_Event::postponed => array( |
|
87 | - 'label' => esc_html__('Postponed', 'event_espresso'), |
|
88 | - 'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__postponed__Public', true), |
|
89 | - ), |
|
90 | - EEM_Event::sold_out => array( |
|
91 | - 'label' => esc_html__('Sold Out', 'event_espresso'), |
|
92 | - 'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__sold_out__Public', true), |
|
93 | - ), |
|
94 | - ) |
|
95 | - ); |
|
96 | - self::$_default_reg_status = empty(self::$_default_reg_status) ? EEM_Registration::status_id_pending_payment |
|
97 | - : self::$_default_reg_status; |
|
98 | - $this->_tables = array( |
|
99 | - 'Event_CPT' => new EE_Primary_Table('posts', 'ID'), |
|
100 | - 'Event_Meta' => new EE_Secondary_Table('esp_event_meta', 'EVTM_ID', 'EVT_ID'), |
|
101 | - ); |
|
102 | - $this->_fields = array( |
|
103 | - 'Event_CPT' => array( |
|
104 | - 'EVT_ID' => new EE_Primary_Key_Int_Field('ID', |
|
105 | - esc_html__('Post ID for Event', 'event_espresso')), |
|
106 | - 'EVT_name' => new EE_Plain_Text_Field('post_title', esc_html__('Event Name', 'event_espresso'), |
|
107 | - false, |
|
108 | - ''), |
|
109 | - 'EVT_desc' => new EE_Post_Content_Field('post_content', |
|
110 | - esc_html__('Event Description', 'event_espresso'), |
|
111 | - false, ''), |
|
112 | - 'EVT_slug' => new EE_Slug_Field('post_name', esc_html__('Event Slug', 'event_espresso'), false, |
|
113 | - ''), |
|
114 | - 'EVT_created' => new EE_Datetime_Field('post_date', |
|
115 | - esc_html__('Date/Time Event Created', 'event_espresso'), |
|
116 | - false, EE_Datetime_Field::now), |
|
117 | - 'EVT_short_desc' => new EE_Simple_HTML_Field('post_excerpt', |
|
118 | - esc_html__('Event Short Description', 'event_espresso'), false, ''), |
|
119 | - 'EVT_modified' => new EE_Datetime_Field('post_modified', |
|
120 | - esc_html__('Date/Time Event Modified', 'event_espresso'), false, EE_Datetime_Field::now), |
|
121 | - 'EVT_wp_user' => new EE_WP_User_Field('post_author', |
|
122 | - esc_html__('Event Creator ID', 'event_espresso'), |
|
123 | - false), |
|
124 | - 'parent' => new EE_Integer_Field('post_parent', esc_html__('Event Parent ID', 'event_espresso'), |
|
125 | - false, |
|
126 | - 0), |
|
127 | - 'EVT_order' => new EE_Integer_Field('menu_order', esc_html__('Event Menu Order', 'event_espresso'), |
|
128 | - false, |
|
129 | - 1), |
|
130 | - 'post_type' => new EE_WP_Post_Type_Field('espresso_events'), |
|
131 | - // EE_Plain_Text_Field( 'post_type', esc_html__( 'Event Post Type', 'event_espresso' ), FALSE, 'espresso_events' ), |
|
132 | - 'status' => new EE_WP_Post_Status_Field('post_status', |
|
133 | - esc_html__('Event Status', 'event_espresso'), |
|
134 | - false, 'draft', $this->_custom_stati), |
|
135 | - ), |
|
136 | - 'Event_Meta' => array( |
|
137 | - 'EVTM_ID' => new EE_DB_Only_Float_Field('EVTM_ID', |
|
138 | - esc_html__('Event Meta Row ID', 'event_espresso'), false), |
|
139 | - 'EVT_ID_fk' => new EE_DB_Only_Int_Field('EVT_ID', |
|
140 | - esc_html__('Foreign key to Event ID from Event Meta table', 'event_espresso'), false), |
|
141 | - 'EVT_display_desc' => new EE_Boolean_Field('EVT_display_desc', |
|
142 | - esc_html__('Display Description Flag', 'event_espresso'), false, 1), |
|
143 | - 'EVT_display_ticket_selector' => new EE_Boolean_Field('EVT_display_ticket_selector', |
|
144 | - esc_html__('Display Ticket Selector Flag', 'event_espresso'), false, 1), |
|
145 | - 'EVT_visible_on' => new EE_Datetime_Field('EVT_visible_on', |
|
146 | - esc_html__('Event Visible Date', 'event_espresso'), true, EE_Datetime_Field::now), |
|
147 | - 'EVT_additional_limit' => new EE_Integer_Field( |
|
148 | - 'EVT_additional_limit', |
|
149 | - esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'), |
|
150 | - true, |
|
151 | - self::$_default_additional_limit |
|
152 | - ), |
|
153 | - 'EVT_default_registration_status' => new EE_Enum_Text_Field( |
|
154 | - 'EVT_default_registration_status', |
|
155 | - esc_html__('Default Registration Status on this Event', 'event_espresso'), false, |
|
156 | - EEM_Event::$_default_reg_status, EEM_Registration::reg_status_array() |
|
157 | - ), |
|
158 | - 'EVT_member_only' => new EE_Boolean_Field('EVT_member_only', |
|
159 | - esc_html__('Member-Only Event Flag', 'event_espresso'), false, false), |
|
160 | - 'EVT_phone' => new EE_Plain_Text_Field('EVT_phone', |
|
161 | - esc_html__('Event Phone Number', 'event_espresso'), false,''), |
|
162 | - 'EVT_allow_overflow' => new EE_Boolean_Field('EVT_allow_overflow', |
|
163 | - esc_html__('Allow Overflow on Event', 'event_espresso'), false, false), |
|
164 | - 'EVT_timezone_string' => new EE_Plain_Text_Field('EVT_timezone_string', |
|
165 | - esc_html__('Timezone (name) for Event times', 'event_espresso'), false,''), |
|
166 | - 'EVT_external_URL' => new EE_Plain_Text_Field('EVT_external_URL', |
|
167 | - esc_html__('URL of Event Page if hosted elsewhere', 'event_espresso'), true), |
|
168 | - 'EVT_donations' => new EE_Boolean_Field('EVT_donations', |
|
169 | - esc_html__('Accept Donations?', 'event_espresso'), false, false), |
|
170 | - ), |
|
171 | - ); |
|
172 | - $this->_model_relations = array( |
|
173 | - 'Registration' => new EE_Has_Many_Relation(), |
|
174 | - 'Datetime' => new EE_Has_Many_Relation(), |
|
175 | - 'Question_Group' => new EE_HABTM_Relation('Event_Question_Group'), |
|
176 | - 'Venue' => new EE_HABTM_Relation('Event_Venue'), |
|
177 | - 'Term_Relationship' => new EE_Has_Many_Relation(), |
|
178 | - 'Term_Taxonomy' => new EE_HABTM_Relation('Term_Relationship'), |
|
179 | - 'Message_Template_Group' => new EE_HABTM_Relation('Event_Message_Template'), |
|
180 | - 'Attendee' => new EE_HABTM_Relation('Registration'), |
|
181 | - 'WP_User' => new EE_Belongs_To_Relation(), |
|
182 | - ); |
|
183 | - //this model is generally available for reading |
|
184 | - $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public(); |
|
185 | - parent::__construct($timezone); |
|
186 | - } |
|
187 | - |
|
188 | - |
|
189 | - |
|
190 | - /** |
|
191 | - * @param string $default_reg_status |
|
192 | - */ |
|
193 | - public static function set_default_reg_status($default_reg_status) |
|
194 | - { |
|
195 | - self::$_default_reg_status = $default_reg_status; |
|
196 | - // if EEM_Event has already been instantiated, |
|
197 | - // then we need to reset the `EVT_default_reg_status` field to use the new default. |
|
198 | - if (self::$_instance instanceof EEM_Event) { |
|
199 | - $default_reg_status = new EE_Enum_Text_Field( |
|
200 | - 'EVT_default_registration_status', |
|
201 | - esc_html__('Default Registration Status on this Event', 'event_espresso'), |
|
202 | - false, |
|
203 | - $default_reg_status, |
|
204 | - EEM_Registration::reg_status_array() |
|
205 | - ); |
|
206 | - $default_reg_status->_construct_finalize( |
|
207 | - 'Event_Meta', |
|
208 | - 'EVT_default_registration_status', |
|
209 | - 'EEM_Event' |
|
210 | - ); |
|
211 | - self::$_instance->_fields['Event_Meta']['EVT_default_registration_status'] = $default_reg_status; |
|
212 | - } |
|
213 | - } |
|
214 | - |
|
215 | - |
|
216 | - /** |
|
217 | - * Used to override the default for the additional limit field. |
|
218 | - * @param $additional_limit |
|
219 | - */ |
|
220 | - public static function set_default_additional_limit($additional_limit) |
|
221 | - { |
|
222 | - self::$_default_additional_limit = (int) $additional_limit; |
|
223 | - if (self::$_instance instanceof EEM_Event) { |
|
224 | - self::$_instance->_fields['Event_Meta']['EVT_additional_limit'] = new EE_Integer_Field( |
|
225 | - 'EVT_additional_limit', |
|
226 | - __('Limit of Additional Registrations on Same Transaction', 'event_espresso'), |
|
227 | - true, |
|
228 | - self::$_default_additional_limit |
|
229 | - ); |
|
230 | - self::$_instance->_fields['Event_Meta']['EVT_additional_limit']->_construct_finalize( |
|
231 | - 'Event_Meta', |
|
232 | - 'EVT_additional_limit', |
|
233 | - 'EEM_Event' |
|
234 | - ); |
|
235 | - } |
|
236 | - } |
|
237 | - |
|
238 | - |
|
239 | - /** |
|
240 | - * Return what is currently set as the default additional limit for the event. |
|
241 | - * @return int |
|
242 | - */ |
|
243 | - public static function get_default_additional_limit() |
|
244 | - { |
|
245 | - return apply_filters('FHEE__EEM_Event__get_default_additional_limit', self::$_default_additional_limit); |
|
246 | - } |
|
247 | - |
|
248 | - |
|
249 | - /** |
|
250 | - * get_question_groups |
|
251 | - * |
|
252 | - * @return array |
|
253 | - * @throws \EE_Error |
|
254 | - */ |
|
255 | - public function get_all_question_groups() |
|
256 | - { |
|
257 | - return EE_Registry::instance()->load_model('Question_Group')->get_all( |
|
258 | - array( |
|
259 | - array('QSG_deleted' => false), |
|
260 | - 'order_by' => array('QSG_order' => 'ASC'), |
|
261 | - ) |
|
262 | - ); |
|
263 | - } |
|
264 | - |
|
265 | - |
|
266 | - |
|
267 | - /** |
|
268 | - * get_question_groups |
|
269 | - * |
|
270 | - * @param int $EVT_ID |
|
271 | - * @return array|bool |
|
272 | - * @throws \EE_Error |
|
273 | - */ |
|
274 | - public function get_all_event_question_groups($EVT_ID = 0) |
|
275 | - { |
|
276 | - if (! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
277 | - EE_Error::add_error( |
|
278 | - esc_html__( |
|
279 | - 'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.', |
|
280 | - 'event_espresso' |
|
281 | - ), |
|
282 | - __FILE__, __FUNCTION__, __LINE__ |
|
283 | - ); |
|
284 | - return false; |
|
285 | - } |
|
286 | - return EE_Registry::instance()->load_model('Event_Question_Group')->get_all( |
|
287 | - array( |
|
288 | - array('EVT_ID' => $EVT_ID), |
|
289 | - ) |
|
290 | - ); |
|
291 | - } |
|
292 | - |
|
293 | - |
|
294 | - |
|
295 | - /** |
|
296 | - * get_question_groups |
|
297 | - * |
|
298 | - * @param int $EVT_ID |
|
299 | - * @param boolean $for_primary_attendee |
|
300 | - * @return array|bool |
|
301 | - * @throws \EE_Error |
|
302 | - */ |
|
303 | - public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true) |
|
304 | - { |
|
305 | - if (! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
306 | - EE_Error::add_error( |
|
307 | - esc_html__( |
|
308 | - 'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.', |
|
309 | - 'event_espresso' |
|
310 | - ), |
|
311 | - __FILE__, __FUNCTION__, __LINE__ |
|
312 | - ); |
|
313 | - return false; |
|
314 | - } |
|
315 | - return EE_Registry::instance()->load_model('Event_Question_Group')->get_all( |
|
316 | - array( |
|
317 | - array( |
|
318 | - 'EVT_ID' => $EVT_ID, |
|
319 | - 'EQG_primary' => $for_primary_attendee, |
|
320 | - ), |
|
321 | - ) |
|
322 | - ); |
|
323 | - } |
|
324 | - |
|
325 | - |
|
326 | - |
|
327 | - /** |
|
328 | - * get_question_groups |
|
329 | - * |
|
330 | - * @param int $EVT_ID |
|
331 | - * @param EE_Registration $registration |
|
332 | - * @return array|bool |
|
333 | - * @throws \EE_Error |
|
334 | - */ |
|
335 | - public function get_question_groups_for_event($EVT_ID = 0, EE_Registration $registration) |
|
336 | - { |
|
337 | - if (! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
338 | - EE_Error::add_error( |
|
339 | - esc_html__( |
|
340 | - 'An error occurred. No Question Groups could be retrieved because an Event ID was not received.', |
|
341 | - 'event_espresso' |
|
342 | - ), |
|
343 | - __FILE__, __FUNCTION__, __LINE__ |
|
344 | - ); |
|
345 | - return false; |
|
346 | - } |
|
347 | - $where_params = array( |
|
348 | - 'Event_Question_Group.EVT_ID' => $EVT_ID, |
|
349 | - 'Event_Question_Group.EQG_primary' => $registration->count() === 1 ? true : false, |
|
350 | - 'QSG_deleted' => false, |
|
351 | - ); |
|
352 | - return EE_Registry::instance()->load_model('Question_Group')->get_all( |
|
353 | - array( |
|
354 | - $where_params, |
|
355 | - 'order_by' => array('QSG_order' => 'ASC'), |
|
356 | - ) |
|
357 | - ); |
|
358 | - } |
|
359 | - |
|
360 | - |
|
361 | - |
|
362 | - /** |
|
363 | - * get_question_target_db_column |
|
364 | - * |
|
365 | - * @param string $QSG_IDs csv list of $QSG IDs |
|
366 | - * @return array|bool |
|
367 | - * @throws \EE_Error |
|
368 | - */ |
|
369 | - public function get_questions_in_groups($QSG_IDs = '') |
|
370 | - { |
|
371 | - if (empty($QSG_IDs)) { |
|
372 | - EE_Error::add_error( |
|
373 | - esc_html__('An error occurred. No Question Group IDs were received.', 'event_espresso'), |
|
374 | - __FILE__, __FUNCTION__, __LINE__ |
|
375 | - ); |
|
376 | - return false; |
|
377 | - } |
|
378 | - return EE_Registry::instance()->load_model('Question')->get_all( |
|
379 | - array( |
|
380 | - array( |
|
381 | - 'Question_Group.QSG_ID' => array('IN', $QSG_IDs), |
|
382 | - 'QST_deleted' => false, |
|
383 | - 'QST_admin_only' => is_admin(), |
|
384 | - ), |
|
385 | - 'order_by' => 'QST_order', |
|
386 | - ) |
|
387 | - ); |
|
388 | - } |
|
389 | - |
|
390 | - |
|
391 | - |
|
392 | - /** |
|
393 | - * get_options_for_question |
|
394 | - * |
|
395 | - * @param string $QST_IDs csv list of $QST IDs |
|
396 | - * @return array|bool |
|
397 | - * @throws \EE_Error |
|
398 | - */ |
|
399 | - public function get_options_for_question($QST_IDs) |
|
400 | - { |
|
401 | - if (empty($QST_IDs)) { |
|
402 | - EE_Error::add_error( |
|
403 | - esc_html__('An error occurred. No Question IDs were received.', 'event_espresso'), |
|
404 | - __FILE__, __FUNCTION__, __LINE__ |
|
405 | - ); |
|
406 | - return false; |
|
407 | - } |
|
408 | - return EE_Registry::instance()->load_model('Question_Option')->get_all( |
|
409 | - array( |
|
410 | - array( |
|
411 | - 'Question.QST_ID' => array('IN', $QST_IDs), |
|
412 | - 'QSO_deleted' => false, |
|
413 | - ), |
|
414 | - 'order_by' => 'QSO_ID', |
|
415 | - ) |
|
416 | - ); |
|
417 | - } |
|
418 | - |
|
419 | - |
|
420 | - |
|
421 | - |
|
422 | - |
|
423 | - |
|
424 | - |
|
425 | - /** |
|
426 | - * Gets all events that are published |
|
427 | - * and have event start time earlier than now and an event end time later than now |
|
428 | - * |
|
429 | - * @param array $query_params An array of query params to further filter on |
|
430 | - * (note that status and DTT_EVT_start and DTT_EVT_end will be overridden) |
|
431 | - * @param bool $count whether to return the count or not (default FALSE) |
|
432 | - * @return EE_Event[]|int |
|
433 | - * @throws \EE_Error |
|
434 | - */ |
|
435 | - public function get_active_events($query_params, $count = false) |
|
436 | - { |
|
437 | - if (array_key_exists(0, $query_params)) { |
|
438 | - $where_params = $query_params[0]; |
|
439 | - unset($query_params[0]); |
|
440 | - } else { |
|
441 | - $where_params = array(); |
|
442 | - } |
|
443 | - // if we have count make sure we don't include group by |
|
444 | - if ($count && isset($query_params['group_by'])) { |
|
445 | - unset($query_params['group_by']); |
|
446 | - } |
|
447 | - // let's add specific query_params for active_events |
|
448 | - // keep in mind this will override any sent status in the query AND any date queries. |
|
449 | - $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out)); |
|
450 | - //if already have where params for DTT_EVT_start or DTT_EVT_end then append these conditions |
|
451 | - if (isset($where_params['Datetime.DTT_EVT_start'])) { |
|
452 | - $where_params['Datetime.DTT_EVT_start******'] = array( |
|
453 | - '<', |
|
454 | - EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'), |
|
455 | - ); |
|
456 | - } else { |
|
457 | - $where_params['Datetime.DTT_EVT_start'] = array( |
|
458 | - '<', |
|
459 | - EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'), |
|
460 | - ); |
|
461 | - } |
|
462 | - if (isset($where_params['Datetime.DTT_EVT_end'])) { |
|
463 | - $where_params['Datetime.DTT_EVT_end*****'] = array( |
|
464 | - '>', |
|
465 | - EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
466 | - ); |
|
467 | - } else { |
|
468 | - $where_params['Datetime.DTT_EVT_end'] = array( |
|
469 | - '>', |
|
470 | - EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
471 | - ); |
|
472 | - } |
|
473 | - $query_params[0] = $where_params; |
|
474 | - // don't use $query_params with count() |
|
475 | - // because we don't want to include additional query clauses like "GROUP BY" |
|
476 | - return $count |
|
477 | - ? $this->count(array($where_params), 'EVT_ID', true) |
|
478 | - : $this->get_all($query_params); |
|
479 | - } |
|
480 | - |
|
481 | - |
|
482 | - |
|
483 | - /** |
|
484 | - * get all events that are published and have an event start time later than now |
|
485 | - * |
|
486 | - * @param array $query_params An array of query params to further filter on |
|
487 | - * (Note that status and DTT_EVT_start will be overridden) |
|
488 | - * @param bool $count whether to return the count or not (default FALSE) |
|
489 | - * @return EE_Event[]|int |
|
490 | - * @throws \EE_Error |
|
491 | - */ |
|
492 | - public function get_upcoming_events($query_params, $count = false) |
|
493 | - { |
|
494 | - if (array_key_exists(0, $query_params)) { |
|
495 | - $where_params = $query_params[0]; |
|
496 | - unset($query_params[0]); |
|
497 | - } else { |
|
498 | - $where_params = array(); |
|
499 | - } |
|
500 | - // if we have count make sure we don't include group by |
|
501 | - if ($count && isset($query_params['group_by'])) { |
|
502 | - unset($query_params['group_by']); |
|
503 | - } |
|
504 | - // let's add specific query_params for active_events |
|
505 | - // keep in mind this will override any sent status in the query AND any date queries. |
|
506 | - $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out)); |
|
507 | - // if there are already query_params matching DTT_EVT_start then we need to modify that to add them. |
|
508 | - if (isset($where_params['Datetime.DTT_EVT_start'])) { |
|
509 | - $where_params['Datetime.DTT_EVT_start*****'] = array( |
|
510 | - '>', |
|
511 | - EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'), |
|
512 | - ); |
|
513 | - } else { |
|
514 | - $where_params['Datetime.DTT_EVT_start'] = array( |
|
515 | - '>', |
|
516 | - EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'), |
|
517 | - ); |
|
518 | - } |
|
519 | - $query_params[0] = $where_params; |
|
520 | - // don't use $query_params with count() |
|
521 | - // because we don't want to include additional query clauses like "GROUP BY" |
|
522 | - return $count |
|
523 | - ? $this->count(array($where_params), 'EVT_ID', true) |
|
524 | - : $this->get_all($query_params); |
|
525 | - } |
|
526 | - |
|
527 | - |
|
528 | - |
|
529 | - /** |
|
530 | - * Gets all events that are published |
|
531 | - * and have an event end time later than now |
|
532 | - * |
|
533 | - * @param array $query_params An array of query params to further filter on |
|
534 | - * (note that status and DTT_EVT_end will be overridden) |
|
535 | - * @param bool $count whether to return the count or not (default FALSE) |
|
536 | - * @return EE_Event[]|int |
|
537 | - * @throws \EE_Error |
|
538 | - */ |
|
539 | - public function get_active_and_upcoming_events($query_params, $count = false) |
|
540 | - { |
|
541 | - if (array_key_exists(0, $query_params)) { |
|
542 | - $where_params = $query_params[0]; |
|
543 | - unset($query_params[0]); |
|
544 | - } else { |
|
545 | - $where_params = array(); |
|
546 | - } |
|
547 | - // if we have count make sure we don't include group by |
|
548 | - if ($count && isset($query_params['group_by'])) { |
|
549 | - unset($query_params['group_by']); |
|
550 | - } |
|
551 | - // let's add specific query_params for active_events |
|
552 | - // keep in mind this will override any sent status in the query AND any date queries. |
|
553 | - $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out)); |
|
554 | - // add where params for DTT_EVT_end |
|
555 | - if (isset($where_params['Datetime.DTT_EVT_end'])) { |
|
556 | - $where_params['Datetime.DTT_EVT_end*****'] = array( |
|
557 | - '>', |
|
558 | - EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
559 | - ); |
|
560 | - } else { |
|
561 | - $where_params['Datetime.DTT_EVT_end'] = array( |
|
562 | - '>', |
|
563 | - EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
564 | - ); |
|
565 | - } |
|
566 | - $query_params[0] = $where_params; |
|
567 | - // don't use $query_params with count() |
|
568 | - // because we don't want to include additional query clauses like "GROUP BY" |
|
569 | - return $count |
|
570 | - ? $this->count(array($where_params), 'EVT_ID', true) |
|
571 | - : $this->get_all($query_params); |
|
572 | - } |
|
573 | - |
|
574 | - |
|
575 | - |
|
576 | - /** |
|
577 | - * This only returns events that are expired. |
|
578 | - * They may still be published but all their datetimes have expired. |
|
579 | - * |
|
580 | - * @param array $query_params An array of query params to further filter on |
|
581 | - * (note that status and DTT_EVT_end will be overridden) |
|
582 | - * @param bool $count whether to return the count or not (default FALSE) |
|
583 | - * @return EE_Event[]|int |
|
584 | - * @throws \EE_Error |
|
585 | - */ |
|
586 | - public function get_expired_events($query_params, $count = false) |
|
587 | - { |
|
588 | - $where_params = isset($query_params[0]) ? $query_params[0] : array(); |
|
589 | - // if we have count make sure we don't include group by |
|
590 | - if ($count && isset($query_params['group_by'])) { |
|
591 | - unset($query_params['group_by']); |
|
592 | - } |
|
593 | - // let's add specific query_params for active_events |
|
594 | - // keep in mind this will override any sent status in the query AND any date queries. |
|
595 | - if (isset($where_params['status'])) { |
|
596 | - unset($where_params['status']); |
|
597 | - } |
|
598 | - $exclude_query = $query_params; |
|
599 | - if (isset($exclude_query[0])) { |
|
600 | - unset($exclude_query[0]); |
|
601 | - } |
|
602 | - $exclude_query[0] = array( |
|
603 | - 'Datetime.DTT_EVT_end' => array( |
|
604 | - '>', |
|
605 | - EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
606 | - ), |
|
607 | - ); |
|
608 | - // first get all events that have datetimes where its not expired. |
|
609 | - $event_ids = $this->_get_all_wpdb_results($exclude_query, OBJECT_K, 'Event_CPT.ID'); |
|
610 | - $event_ids = array_keys($event_ids); |
|
611 | - // if we have any additional query_params, let's add them to the 'AND' condition |
|
612 | - $and_condition = array( |
|
613 | - 'Datetime.DTT_EVT_end' => array('<', EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end')), |
|
614 | - 'EVT_ID' => array('NOT IN', $event_ids), |
|
615 | - ); |
|
616 | - if (isset($where_params['OR'])) { |
|
617 | - $and_condition['OR'] = $where_params['OR']; |
|
618 | - unset($where_params['OR']); |
|
619 | - } |
|
620 | - if (isset($where_params['Datetime.DTT_EVT_end'])) { |
|
621 | - $and_condition['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end']; |
|
622 | - unset($where_params['Datetime.DTT_EVT_end']); |
|
623 | - } |
|
624 | - if (isset($where_params['Datetime.DTT_EVT_start'])) { |
|
625 | - $and_condition['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start']; |
|
626 | - unset($where_params['Datetime.DTT_EVT_start']); |
|
627 | - } |
|
628 | - // merge remaining $where params with the and conditions. |
|
629 | - $where_params['AND'] = array_merge($and_condition, $where_params); |
|
630 | - $query_params[0] = $where_params; |
|
631 | - // don't use $query_params with count() |
|
632 | - // because we don't want to include additional query clauses like "GROUP BY" |
|
633 | - return $count |
|
634 | - ? $this->count(array($where_params), 'EVT_ID', true) |
|
635 | - : $this->get_all($query_params); |
|
636 | - } |
|
637 | - |
|
638 | - |
|
639 | - |
|
640 | - /** |
|
641 | - * This basically just returns the events that do not have the publish status. |
|
642 | - * |
|
643 | - * @param array $query_params An array of query params to further filter on |
|
644 | - * (note that status will be overwritten) |
|
645 | - * @param boolean $count whether to return the count or not (default FALSE) |
|
646 | - * @return EE_Event[]|int |
|
647 | - * @throws \EE_Error |
|
648 | - */ |
|
649 | - public function get_inactive_events($query_params, $count = false) |
|
650 | - { |
|
651 | - $where_params = isset($query_params[0]) ? $query_params[0] : array(); |
|
652 | - // let's add in specific query_params for inactive events. |
|
653 | - if (isset($where_params['status'])) { |
|
654 | - unset($where_params['status']); |
|
655 | - } |
|
656 | - // if we have count make sure we don't include group by |
|
657 | - if ($count && isset($query_params['group_by'])) { |
|
658 | - unset($query_params['group_by']); |
|
659 | - } |
|
660 | - // if we have any additional query_params, let's add them to the 'AND' condition |
|
661 | - $where_params['AND']['status'] = array('!=', 'publish'); |
|
662 | - if (isset($where_params['OR'])) { |
|
663 | - $where_params['AND']['OR'] = $where_params['OR']; |
|
664 | - unset($where_params['OR']); |
|
665 | - } |
|
666 | - if (isset($where_params['Datetime.DTT_EVT_end'])) { |
|
667 | - $where_params['AND']['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end']; |
|
668 | - unset($where_params['Datetime.DTT_EVT_end']); |
|
669 | - } |
|
670 | - if (isset($where_params['Datetime.DTT_EVT_start'])) { |
|
671 | - $where_params['AND']['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start']; |
|
672 | - unset($where_params['Datetime.DTT_EVT_start']); |
|
673 | - } |
|
674 | - $query_params[0] = $where_params; |
|
675 | - // don't use $query_params with count() |
|
676 | - // because we don't want to include additional query clauses like "GROUP BY" |
|
677 | - return $count |
|
678 | - ? $this->count(array($where_params), 'EVT_ID', true) |
|
679 | - : $this->get_all($query_params); |
|
680 | - } |
|
681 | - |
|
682 | - |
|
683 | - |
|
684 | - /** |
|
685 | - * This is just injecting into the parent add_relationship_to so we do special handling on price relationships |
|
686 | - * because we don't want to override any existing global default prices but instead insert NEW prices that get |
|
687 | - * attached to the event. See parent for param descriptions |
|
688 | - * |
|
689 | - * @param $id_or_obj |
|
690 | - * @param $other_model_id_or_obj |
|
691 | - * @param string $relationName |
|
692 | - * @param array $where_query |
|
693 | - * @return EE_Base_Class |
|
694 | - * @throws EE_Error |
|
695 | - */ |
|
696 | - public function add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array()) |
|
697 | - { |
|
698 | - if ($relationName === 'Price') { |
|
699 | - //let's get the PRC object for the given ID to make sure that we aren't dealing with a default |
|
700 | - $prc_chk = $this->get_related_model_obj($relationName)->ensure_is_obj($other_model_id_or_obj); |
|
701 | - //if EVT_ID = 0, then this is a default |
|
702 | - if ((int) $prc_chk->get('EVT_ID') === 0) { |
|
703 | - //let's set the prc_id as 0 so we force an insert on the add_relation_to carried out by relation |
|
704 | - $prc_chk->set('PRC_ID', 0); |
|
705 | - } |
|
706 | - //run parent |
|
707 | - return parent::add_relationship_to($id_or_obj, $prc_chk, $relationName, $where_query); |
|
708 | - } |
|
709 | - //otherwise carry on as normal |
|
710 | - return parent::add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query); |
|
711 | - } |
|
712 | - |
|
713 | - |
|
714 | - |
|
715 | - /******************** DEPRECATED METHODS ********************/ |
|
716 | - |
|
717 | - |
|
718 | - |
|
719 | - /** |
|
720 | - * _get_question_target_db_column |
|
721 | - * |
|
722 | - * @deprecated as of 4.8.32.rc.001. Instead consider using |
|
723 | - * EE_Registration_Custom_Questions_Form located in |
|
724 | - * admin_pages/registrations/form_sections/EE_Registration_Custom_Questions_Form.form.php |
|
725 | - * @access public |
|
726 | - * @param EE_Registration $registration (so existing answers for registration are included) |
|
727 | - * @param int $EVT_ID so all question groups are included for event (not just answers from |
|
728 | - * registration). |
|
729 | - * @throws EE_Error |
|
730 | - * @return array |
|
731 | - */ |
|
732 | - public function assemble_array_of_groups_questions_and_options(EE_Registration $registration, $EVT_ID = 0) |
|
733 | - { |
|
734 | - if (empty($EVT_ID)) { |
|
735 | - throw new EE_Error(__('An error occurred. No EVT_ID is included. Needed to know which question groups to retrieve.', |
|
736 | - 'event_espresso')); |
|
737 | - } |
|
738 | - $questions = array(); |
|
739 | - // get all question groups for event |
|
740 | - $qgs = $this->get_question_groups_for_event($EVT_ID, $registration); |
|
741 | - if (! empty($qgs)) { |
|
742 | - foreach ($qgs as $qg) { |
|
743 | - $qsts = $qg->questions(); |
|
744 | - $questions[$qg->ID()] = $qg->model_field_array(); |
|
745 | - $questions[$qg->ID()]['QSG_questions'] = array(); |
|
746 | - foreach ($qsts as $qst) { |
|
747 | - if ($qst->is_system_question()) { |
|
748 | - continue; |
|
749 | - } |
|
750 | - $answer = EEM_Answer::instance()->get_one(array( |
|
751 | - array( |
|
752 | - 'QST_ID' => $qst->ID(), |
|
753 | - 'REG_ID' => $registration->ID(), |
|
754 | - ), |
|
755 | - )); |
|
756 | - $answer = $answer instanceof EE_Answer ? $answer : EEM_Answer::instance()->create_default_object(); |
|
757 | - $qst_name = $qstn_id = $qst->ID(); |
|
758 | - $ans_id = $answer->ID(); |
|
759 | - $qst_name = ! empty($ans_id) ? '[' . $qst_name . '][' . $ans_id . ']' : '[' . $qst_name . ']'; |
|
760 | - $input_name = ''; |
|
761 | - $input_id = sanitize_key($qst->display_text()); |
|
762 | - $input_class = ''; |
|
763 | - $questions[$qg->ID()]['QSG_questions'][$qst->ID()] = $qst->model_field_array(); |
|
764 | - $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_name'] = 'qstn' |
|
765 | - . $input_name |
|
766 | - . $qst_name; |
|
767 | - $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_id'] = $input_id . '-' . $qstn_id; |
|
768 | - $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_class'] = $input_class; |
|
769 | - $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'] = array(); |
|
770 | - $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['qst_obj'] = $qst; |
|
771 | - $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['ans_obj'] = $answer; |
|
772 | - //leave responses as-is, don't convert stuff into html entities please! |
|
773 | - $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['htmlentities'] = false; |
|
774 | - if ($qst->type() == 'RADIO_BTN' || $qst->type() == 'CHECKBOX' || $qst->type() == 'DROPDOWN') { |
|
775 | - $QSOs = $qst->options(true, $answer->value()); |
|
776 | - if (is_array($QSOs)) { |
|
777 | - foreach ($QSOs as $QSO_ID => $QSO) { |
|
778 | - $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'][$QSO_ID] = $QSO->model_field_array(); |
|
779 | - } |
|
780 | - } |
|
781 | - } |
|
782 | - } |
|
783 | - } |
|
784 | - } |
|
785 | - return $questions; |
|
786 | - } |
|
21 | + /** |
|
22 | + * constant used by status(), indicating that no more tickets can be purchased for any of the datetimes for the |
|
23 | + * event |
|
24 | + */ |
|
25 | + const sold_out = 'sold_out'; |
|
26 | + |
|
27 | + /** |
|
28 | + * constant used by status(), indicating that upcoming event dates have been postponed (may be pushed to a later |
|
29 | + * date) |
|
30 | + */ |
|
31 | + const postponed = 'postponed'; |
|
32 | + |
|
33 | + /** |
|
34 | + * constant used by status(), indicating that the event will no longer occur |
|
35 | + */ |
|
36 | + const cancelled = 'cancelled'; |
|
37 | + |
|
38 | + |
|
39 | + /** |
|
40 | + * @var string |
|
41 | + */ |
|
42 | + protected static $_default_reg_status; |
|
43 | + |
|
44 | + |
|
45 | + /** |
|
46 | + * This is the default for the additional limit field. |
|
47 | + * @var int |
|
48 | + */ |
|
49 | + protected static $_default_additional_limit = 10; |
|
50 | + |
|
51 | + |
|
52 | + /** |
|
53 | + * private instance of the Event object |
|
54 | + * |
|
55 | + * @var EEM_Event |
|
56 | + */ |
|
57 | + protected static $_instance; |
|
58 | + |
|
59 | + |
|
60 | + |
|
61 | + |
|
62 | + /** |
|
63 | + * Adds a relationship to Term_Taxonomy for each CPT_Base |
|
64 | + * |
|
65 | + * @param string $timezone |
|
66 | + * @throws \EE_Error |
|
67 | + */ |
|
68 | + protected function __construct($timezone = null) |
|
69 | + { |
|
70 | + EE_Registry::instance()->load_model('Registration'); |
|
71 | + $this->singular_item = esc_html__('Event', 'event_espresso'); |
|
72 | + $this->plural_item = esc_html__('Events', 'event_espresso'); |
|
73 | + // to remove Cancelled events from the frontend, copy the following filter to your functions.php file |
|
74 | + // add_filter( 'AFEE__EEM_Event__construct___custom_stati__cancelled__Public', '__return_false' ); |
|
75 | + // to remove Postponed events from the frontend, copy the following filter to your functions.php file |
|
76 | + // add_filter( 'AFEE__EEM_Event__construct___custom_stati__postponed__Public', '__return_false' ); |
|
77 | + // to remove Sold Out events from the frontend, copy the following filter to your functions.php file |
|
78 | + // add_filter( 'AFEE__EEM_Event__construct___custom_stati__sold_out__Public', '__return_false' ); |
|
79 | + $this->_custom_stati = apply_filters( |
|
80 | + 'AFEE__EEM_Event__construct___custom_stati', |
|
81 | + array( |
|
82 | + EEM_Event::cancelled => array( |
|
83 | + 'label' => esc_html__('Cancelled', 'event_espresso'), |
|
84 | + 'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__cancelled__Public', true), |
|
85 | + ), |
|
86 | + EEM_Event::postponed => array( |
|
87 | + 'label' => esc_html__('Postponed', 'event_espresso'), |
|
88 | + 'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__postponed__Public', true), |
|
89 | + ), |
|
90 | + EEM_Event::sold_out => array( |
|
91 | + 'label' => esc_html__('Sold Out', 'event_espresso'), |
|
92 | + 'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__sold_out__Public', true), |
|
93 | + ), |
|
94 | + ) |
|
95 | + ); |
|
96 | + self::$_default_reg_status = empty(self::$_default_reg_status) ? EEM_Registration::status_id_pending_payment |
|
97 | + : self::$_default_reg_status; |
|
98 | + $this->_tables = array( |
|
99 | + 'Event_CPT' => new EE_Primary_Table('posts', 'ID'), |
|
100 | + 'Event_Meta' => new EE_Secondary_Table('esp_event_meta', 'EVTM_ID', 'EVT_ID'), |
|
101 | + ); |
|
102 | + $this->_fields = array( |
|
103 | + 'Event_CPT' => array( |
|
104 | + 'EVT_ID' => new EE_Primary_Key_Int_Field('ID', |
|
105 | + esc_html__('Post ID for Event', 'event_espresso')), |
|
106 | + 'EVT_name' => new EE_Plain_Text_Field('post_title', esc_html__('Event Name', 'event_espresso'), |
|
107 | + false, |
|
108 | + ''), |
|
109 | + 'EVT_desc' => new EE_Post_Content_Field('post_content', |
|
110 | + esc_html__('Event Description', 'event_espresso'), |
|
111 | + false, ''), |
|
112 | + 'EVT_slug' => new EE_Slug_Field('post_name', esc_html__('Event Slug', 'event_espresso'), false, |
|
113 | + ''), |
|
114 | + 'EVT_created' => new EE_Datetime_Field('post_date', |
|
115 | + esc_html__('Date/Time Event Created', 'event_espresso'), |
|
116 | + false, EE_Datetime_Field::now), |
|
117 | + 'EVT_short_desc' => new EE_Simple_HTML_Field('post_excerpt', |
|
118 | + esc_html__('Event Short Description', 'event_espresso'), false, ''), |
|
119 | + 'EVT_modified' => new EE_Datetime_Field('post_modified', |
|
120 | + esc_html__('Date/Time Event Modified', 'event_espresso'), false, EE_Datetime_Field::now), |
|
121 | + 'EVT_wp_user' => new EE_WP_User_Field('post_author', |
|
122 | + esc_html__('Event Creator ID', 'event_espresso'), |
|
123 | + false), |
|
124 | + 'parent' => new EE_Integer_Field('post_parent', esc_html__('Event Parent ID', 'event_espresso'), |
|
125 | + false, |
|
126 | + 0), |
|
127 | + 'EVT_order' => new EE_Integer_Field('menu_order', esc_html__('Event Menu Order', 'event_espresso'), |
|
128 | + false, |
|
129 | + 1), |
|
130 | + 'post_type' => new EE_WP_Post_Type_Field('espresso_events'), |
|
131 | + // EE_Plain_Text_Field( 'post_type', esc_html__( 'Event Post Type', 'event_espresso' ), FALSE, 'espresso_events' ), |
|
132 | + 'status' => new EE_WP_Post_Status_Field('post_status', |
|
133 | + esc_html__('Event Status', 'event_espresso'), |
|
134 | + false, 'draft', $this->_custom_stati), |
|
135 | + ), |
|
136 | + 'Event_Meta' => array( |
|
137 | + 'EVTM_ID' => new EE_DB_Only_Float_Field('EVTM_ID', |
|
138 | + esc_html__('Event Meta Row ID', 'event_espresso'), false), |
|
139 | + 'EVT_ID_fk' => new EE_DB_Only_Int_Field('EVT_ID', |
|
140 | + esc_html__('Foreign key to Event ID from Event Meta table', 'event_espresso'), false), |
|
141 | + 'EVT_display_desc' => new EE_Boolean_Field('EVT_display_desc', |
|
142 | + esc_html__('Display Description Flag', 'event_espresso'), false, 1), |
|
143 | + 'EVT_display_ticket_selector' => new EE_Boolean_Field('EVT_display_ticket_selector', |
|
144 | + esc_html__('Display Ticket Selector Flag', 'event_espresso'), false, 1), |
|
145 | + 'EVT_visible_on' => new EE_Datetime_Field('EVT_visible_on', |
|
146 | + esc_html__('Event Visible Date', 'event_espresso'), true, EE_Datetime_Field::now), |
|
147 | + 'EVT_additional_limit' => new EE_Integer_Field( |
|
148 | + 'EVT_additional_limit', |
|
149 | + esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'), |
|
150 | + true, |
|
151 | + self::$_default_additional_limit |
|
152 | + ), |
|
153 | + 'EVT_default_registration_status' => new EE_Enum_Text_Field( |
|
154 | + 'EVT_default_registration_status', |
|
155 | + esc_html__('Default Registration Status on this Event', 'event_espresso'), false, |
|
156 | + EEM_Event::$_default_reg_status, EEM_Registration::reg_status_array() |
|
157 | + ), |
|
158 | + 'EVT_member_only' => new EE_Boolean_Field('EVT_member_only', |
|
159 | + esc_html__('Member-Only Event Flag', 'event_espresso'), false, false), |
|
160 | + 'EVT_phone' => new EE_Plain_Text_Field('EVT_phone', |
|
161 | + esc_html__('Event Phone Number', 'event_espresso'), false,''), |
|
162 | + 'EVT_allow_overflow' => new EE_Boolean_Field('EVT_allow_overflow', |
|
163 | + esc_html__('Allow Overflow on Event', 'event_espresso'), false, false), |
|
164 | + 'EVT_timezone_string' => new EE_Plain_Text_Field('EVT_timezone_string', |
|
165 | + esc_html__('Timezone (name) for Event times', 'event_espresso'), false,''), |
|
166 | + 'EVT_external_URL' => new EE_Plain_Text_Field('EVT_external_URL', |
|
167 | + esc_html__('URL of Event Page if hosted elsewhere', 'event_espresso'), true), |
|
168 | + 'EVT_donations' => new EE_Boolean_Field('EVT_donations', |
|
169 | + esc_html__('Accept Donations?', 'event_espresso'), false, false), |
|
170 | + ), |
|
171 | + ); |
|
172 | + $this->_model_relations = array( |
|
173 | + 'Registration' => new EE_Has_Many_Relation(), |
|
174 | + 'Datetime' => new EE_Has_Many_Relation(), |
|
175 | + 'Question_Group' => new EE_HABTM_Relation('Event_Question_Group'), |
|
176 | + 'Venue' => new EE_HABTM_Relation('Event_Venue'), |
|
177 | + 'Term_Relationship' => new EE_Has_Many_Relation(), |
|
178 | + 'Term_Taxonomy' => new EE_HABTM_Relation('Term_Relationship'), |
|
179 | + 'Message_Template_Group' => new EE_HABTM_Relation('Event_Message_Template'), |
|
180 | + 'Attendee' => new EE_HABTM_Relation('Registration'), |
|
181 | + 'WP_User' => new EE_Belongs_To_Relation(), |
|
182 | + ); |
|
183 | + //this model is generally available for reading |
|
184 | + $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public(); |
|
185 | + parent::__construct($timezone); |
|
186 | + } |
|
187 | + |
|
188 | + |
|
189 | + |
|
190 | + /** |
|
191 | + * @param string $default_reg_status |
|
192 | + */ |
|
193 | + public static function set_default_reg_status($default_reg_status) |
|
194 | + { |
|
195 | + self::$_default_reg_status = $default_reg_status; |
|
196 | + // if EEM_Event has already been instantiated, |
|
197 | + // then we need to reset the `EVT_default_reg_status` field to use the new default. |
|
198 | + if (self::$_instance instanceof EEM_Event) { |
|
199 | + $default_reg_status = new EE_Enum_Text_Field( |
|
200 | + 'EVT_default_registration_status', |
|
201 | + esc_html__('Default Registration Status on this Event', 'event_espresso'), |
|
202 | + false, |
|
203 | + $default_reg_status, |
|
204 | + EEM_Registration::reg_status_array() |
|
205 | + ); |
|
206 | + $default_reg_status->_construct_finalize( |
|
207 | + 'Event_Meta', |
|
208 | + 'EVT_default_registration_status', |
|
209 | + 'EEM_Event' |
|
210 | + ); |
|
211 | + self::$_instance->_fields['Event_Meta']['EVT_default_registration_status'] = $default_reg_status; |
|
212 | + } |
|
213 | + } |
|
214 | + |
|
215 | + |
|
216 | + /** |
|
217 | + * Used to override the default for the additional limit field. |
|
218 | + * @param $additional_limit |
|
219 | + */ |
|
220 | + public static function set_default_additional_limit($additional_limit) |
|
221 | + { |
|
222 | + self::$_default_additional_limit = (int) $additional_limit; |
|
223 | + if (self::$_instance instanceof EEM_Event) { |
|
224 | + self::$_instance->_fields['Event_Meta']['EVT_additional_limit'] = new EE_Integer_Field( |
|
225 | + 'EVT_additional_limit', |
|
226 | + __('Limit of Additional Registrations on Same Transaction', 'event_espresso'), |
|
227 | + true, |
|
228 | + self::$_default_additional_limit |
|
229 | + ); |
|
230 | + self::$_instance->_fields['Event_Meta']['EVT_additional_limit']->_construct_finalize( |
|
231 | + 'Event_Meta', |
|
232 | + 'EVT_additional_limit', |
|
233 | + 'EEM_Event' |
|
234 | + ); |
|
235 | + } |
|
236 | + } |
|
237 | + |
|
238 | + |
|
239 | + /** |
|
240 | + * Return what is currently set as the default additional limit for the event. |
|
241 | + * @return int |
|
242 | + */ |
|
243 | + public static function get_default_additional_limit() |
|
244 | + { |
|
245 | + return apply_filters('FHEE__EEM_Event__get_default_additional_limit', self::$_default_additional_limit); |
|
246 | + } |
|
247 | + |
|
248 | + |
|
249 | + /** |
|
250 | + * get_question_groups |
|
251 | + * |
|
252 | + * @return array |
|
253 | + * @throws \EE_Error |
|
254 | + */ |
|
255 | + public function get_all_question_groups() |
|
256 | + { |
|
257 | + return EE_Registry::instance()->load_model('Question_Group')->get_all( |
|
258 | + array( |
|
259 | + array('QSG_deleted' => false), |
|
260 | + 'order_by' => array('QSG_order' => 'ASC'), |
|
261 | + ) |
|
262 | + ); |
|
263 | + } |
|
264 | + |
|
265 | + |
|
266 | + |
|
267 | + /** |
|
268 | + * get_question_groups |
|
269 | + * |
|
270 | + * @param int $EVT_ID |
|
271 | + * @return array|bool |
|
272 | + * @throws \EE_Error |
|
273 | + */ |
|
274 | + public function get_all_event_question_groups($EVT_ID = 0) |
|
275 | + { |
|
276 | + if (! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
277 | + EE_Error::add_error( |
|
278 | + esc_html__( |
|
279 | + 'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.', |
|
280 | + 'event_espresso' |
|
281 | + ), |
|
282 | + __FILE__, __FUNCTION__, __LINE__ |
|
283 | + ); |
|
284 | + return false; |
|
285 | + } |
|
286 | + return EE_Registry::instance()->load_model('Event_Question_Group')->get_all( |
|
287 | + array( |
|
288 | + array('EVT_ID' => $EVT_ID), |
|
289 | + ) |
|
290 | + ); |
|
291 | + } |
|
292 | + |
|
293 | + |
|
294 | + |
|
295 | + /** |
|
296 | + * get_question_groups |
|
297 | + * |
|
298 | + * @param int $EVT_ID |
|
299 | + * @param boolean $for_primary_attendee |
|
300 | + * @return array|bool |
|
301 | + * @throws \EE_Error |
|
302 | + */ |
|
303 | + public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true) |
|
304 | + { |
|
305 | + if (! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
306 | + EE_Error::add_error( |
|
307 | + esc_html__( |
|
308 | + 'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.', |
|
309 | + 'event_espresso' |
|
310 | + ), |
|
311 | + __FILE__, __FUNCTION__, __LINE__ |
|
312 | + ); |
|
313 | + return false; |
|
314 | + } |
|
315 | + return EE_Registry::instance()->load_model('Event_Question_Group')->get_all( |
|
316 | + array( |
|
317 | + array( |
|
318 | + 'EVT_ID' => $EVT_ID, |
|
319 | + 'EQG_primary' => $for_primary_attendee, |
|
320 | + ), |
|
321 | + ) |
|
322 | + ); |
|
323 | + } |
|
324 | + |
|
325 | + |
|
326 | + |
|
327 | + /** |
|
328 | + * get_question_groups |
|
329 | + * |
|
330 | + * @param int $EVT_ID |
|
331 | + * @param EE_Registration $registration |
|
332 | + * @return array|bool |
|
333 | + * @throws \EE_Error |
|
334 | + */ |
|
335 | + public function get_question_groups_for_event($EVT_ID = 0, EE_Registration $registration) |
|
336 | + { |
|
337 | + if (! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
338 | + EE_Error::add_error( |
|
339 | + esc_html__( |
|
340 | + 'An error occurred. No Question Groups could be retrieved because an Event ID was not received.', |
|
341 | + 'event_espresso' |
|
342 | + ), |
|
343 | + __FILE__, __FUNCTION__, __LINE__ |
|
344 | + ); |
|
345 | + return false; |
|
346 | + } |
|
347 | + $where_params = array( |
|
348 | + 'Event_Question_Group.EVT_ID' => $EVT_ID, |
|
349 | + 'Event_Question_Group.EQG_primary' => $registration->count() === 1 ? true : false, |
|
350 | + 'QSG_deleted' => false, |
|
351 | + ); |
|
352 | + return EE_Registry::instance()->load_model('Question_Group')->get_all( |
|
353 | + array( |
|
354 | + $where_params, |
|
355 | + 'order_by' => array('QSG_order' => 'ASC'), |
|
356 | + ) |
|
357 | + ); |
|
358 | + } |
|
359 | + |
|
360 | + |
|
361 | + |
|
362 | + /** |
|
363 | + * get_question_target_db_column |
|
364 | + * |
|
365 | + * @param string $QSG_IDs csv list of $QSG IDs |
|
366 | + * @return array|bool |
|
367 | + * @throws \EE_Error |
|
368 | + */ |
|
369 | + public function get_questions_in_groups($QSG_IDs = '') |
|
370 | + { |
|
371 | + if (empty($QSG_IDs)) { |
|
372 | + EE_Error::add_error( |
|
373 | + esc_html__('An error occurred. No Question Group IDs were received.', 'event_espresso'), |
|
374 | + __FILE__, __FUNCTION__, __LINE__ |
|
375 | + ); |
|
376 | + return false; |
|
377 | + } |
|
378 | + return EE_Registry::instance()->load_model('Question')->get_all( |
|
379 | + array( |
|
380 | + array( |
|
381 | + 'Question_Group.QSG_ID' => array('IN', $QSG_IDs), |
|
382 | + 'QST_deleted' => false, |
|
383 | + 'QST_admin_only' => is_admin(), |
|
384 | + ), |
|
385 | + 'order_by' => 'QST_order', |
|
386 | + ) |
|
387 | + ); |
|
388 | + } |
|
389 | + |
|
390 | + |
|
391 | + |
|
392 | + /** |
|
393 | + * get_options_for_question |
|
394 | + * |
|
395 | + * @param string $QST_IDs csv list of $QST IDs |
|
396 | + * @return array|bool |
|
397 | + * @throws \EE_Error |
|
398 | + */ |
|
399 | + public function get_options_for_question($QST_IDs) |
|
400 | + { |
|
401 | + if (empty($QST_IDs)) { |
|
402 | + EE_Error::add_error( |
|
403 | + esc_html__('An error occurred. No Question IDs were received.', 'event_espresso'), |
|
404 | + __FILE__, __FUNCTION__, __LINE__ |
|
405 | + ); |
|
406 | + return false; |
|
407 | + } |
|
408 | + return EE_Registry::instance()->load_model('Question_Option')->get_all( |
|
409 | + array( |
|
410 | + array( |
|
411 | + 'Question.QST_ID' => array('IN', $QST_IDs), |
|
412 | + 'QSO_deleted' => false, |
|
413 | + ), |
|
414 | + 'order_by' => 'QSO_ID', |
|
415 | + ) |
|
416 | + ); |
|
417 | + } |
|
418 | + |
|
419 | + |
|
420 | + |
|
421 | + |
|
422 | + |
|
423 | + |
|
424 | + |
|
425 | + /** |
|
426 | + * Gets all events that are published |
|
427 | + * and have event start time earlier than now and an event end time later than now |
|
428 | + * |
|
429 | + * @param array $query_params An array of query params to further filter on |
|
430 | + * (note that status and DTT_EVT_start and DTT_EVT_end will be overridden) |
|
431 | + * @param bool $count whether to return the count or not (default FALSE) |
|
432 | + * @return EE_Event[]|int |
|
433 | + * @throws \EE_Error |
|
434 | + */ |
|
435 | + public function get_active_events($query_params, $count = false) |
|
436 | + { |
|
437 | + if (array_key_exists(0, $query_params)) { |
|
438 | + $where_params = $query_params[0]; |
|
439 | + unset($query_params[0]); |
|
440 | + } else { |
|
441 | + $where_params = array(); |
|
442 | + } |
|
443 | + // if we have count make sure we don't include group by |
|
444 | + if ($count && isset($query_params['group_by'])) { |
|
445 | + unset($query_params['group_by']); |
|
446 | + } |
|
447 | + // let's add specific query_params for active_events |
|
448 | + // keep in mind this will override any sent status in the query AND any date queries. |
|
449 | + $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out)); |
|
450 | + //if already have where params for DTT_EVT_start or DTT_EVT_end then append these conditions |
|
451 | + if (isset($where_params['Datetime.DTT_EVT_start'])) { |
|
452 | + $where_params['Datetime.DTT_EVT_start******'] = array( |
|
453 | + '<', |
|
454 | + EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'), |
|
455 | + ); |
|
456 | + } else { |
|
457 | + $where_params['Datetime.DTT_EVT_start'] = array( |
|
458 | + '<', |
|
459 | + EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'), |
|
460 | + ); |
|
461 | + } |
|
462 | + if (isset($where_params['Datetime.DTT_EVT_end'])) { |
|
463 | + $where_params['Datetime.DTT_EVT_end*****'] = array( |
|
464 | + '>', |
|
465 | + EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
466 | + ); |
|
467 | + } else { |
|
468 | + $where_params['Datetime.DTT_EVT_end'] = array( |
|
469 | + '>', |
|
470 | + EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
471 | + ); |
|
472 | + } |
|
473 | + $query_params[0] = $where_params; |
|
474 | + // don't use $query_params with count() |
|
475 | + // because we don't want to include additional query clauses like "GROUP BY" |
|
476 | + return $count |
|
477 | + ? $this->count(array($where_params), 'EVT_ID', true) |
|
478 | + : $this->get_all($query_params); |
|
479 | + } |
|
480 | + |
|
481 | + |
|
482 | + |
|
483 | + /** |
|
484 | + * get all events that are published and have an event start time later than now |
|
485 | + * |
|
486 | + * @param array $query_params An array of query params to further filter on |
|
487 | + * (Note that status and DTT_EVT_start will be overridden) |
|
488 | + * @param bool $count whether to return the count or not (default FALSE) |
|
489 | + * @return EE_Event[]|int |
|
490 | + * @throws \EE_Error |
|
491 | + */ |
|
492 | + public function get_upcoming_events($query_params, $count = false) |
|
493 | + { |
|
494 | + if (array_key_exists(0, $query_params)) { |
|
495 | + $where_params = $query_params[0]; |
|
496 | + unset($query_params[0]); |
|
497 | + } else { |
|
498 | + $where_params = array(); |
|
499 | + } |
|
500 | + // if we have count make sure we don't include group by |
|
501 | + if ($count && isset($query_params['group_by'])) { |
|
502 | + unset($query_params['group_by']); |
|
503 | + } |
|
504 | + // let's add specific query_params for active_events |
|
505 | + // keep in mind this will override any sent status in the query AND any date queries. |
|
506 | + $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out)); |
|
507 | + // if there are already query_params matching DTT_EVT_start then we need to modify that to add them. |
|
508 | + if (isset($where_params['Datetime.DTT_EVT_start'])) { |
|
509 | + $where_params['Datetime.DTT_EVT_start*****'] = array( |
|
510 | + '>', |
|
511 | + EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'), |
|
512 | + ); |
|
513 | + } else { |
|
514 | + $where_params['Datetime.DTT_EVT_start'] = array( |
|
515 | + '>', |
|
516 | + EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'), |
|
517 | + ); |
|
518 | + } |
|
519 | + $query_params[0] = $where_params; |
|
520 | + // don't use $query_params with count() |
|
521 | + // because we don't want to include additional query clauses like "GROUP BY" |
|
522 | + return $count |
|
523 | + ? $this->count(array($where_params), 'EVT_ID', true) |
|
524 | + : $this->get_all($query_params); |
|
525 | + } |
|
526 | + |
|
527 | + |
|
528 | + |
|
529 | + /** |
|
530 | + * Gets all events that are published |
|
531 | + * and have an event end time later than now |
|
532 | + * |
|
533 | + * @param array $query_params An array of query params to further filter on |
|
534 | + * (note that status and DTT_EVT_end will be overridden) |
|
535 | + * @param bool $count whether to return the count or not (default FALSE) |
|
536 | + * @return EE_Event[]|int |
|
537 | + * @throws \EE_Error |
|
538 | + */ |
|
539 | + public function get_active_and_upcoming_events($query_params, $count = false) |
|
540 | + { |
|
541 | + if (array_key_exists(0, $query_params)) { |
|
542 | + $where_params = $query_params[0]; |
|
543 | + unset($query_params[0]); |
|
544 | + } else { |
|
545 | + $where_params = array(); |
|
546 | + } |
|
547 | + // if we have count make sure we don't include group by |
|
548 | + if ($count && isset($query_params['group_by'])) { |
|
549 | + unset($query_params['group_by']); |
|
550 | + } |
|
551 | + // let's add specific query_params for active_events |
|
552 | + // keep in mind this will override any sent status in the query AND any date queries. |
|
553 | + $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out)); |
|
554 | + // add where params for DTT_EVT_end |
|
555 | + if (isset($where_params['Datetime.DTT_EVT_end'])) { |
|
556 | + $where_params['Datetime.DTT_EVT_end*****'] = array( |
|
557 | + '>', |
|
558 | + EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
559 | + ); |
|
560 | + } else { |
|
561 | + $where_params['Datetime.DTT_EVT_end'] = array( |
|
562 | + '>', |
|
563 | + EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
564 | + ); |
|
565 | + } |
|
566 | + $query_params[0] = $where_params; |
|
567 | + // don't use $query_params with count() |
|
568 | + // because we don't want to include additional query clauses like "GROUP BY" |
|
569 | + return $count |
|
570 | + ? $this->count(array($where_params), 'EVT_ID', true) |
|
571 | + : $this->get_all($query_params); |
|
572 | + } |
|
573 | + |
|
574 | + |
|
575 | + |
|
576 | + /** |
|
577 | + * This only returns events that are expired. |
|
578 | + * They may still be published but all their datetimes have expired. |
|
579 | + * |
|
580 | + * @param array $query_params An array of query params to further filter on |
|
581 | + * (note that status and DTT_EVT_end will be overridden) |
|
582 | + * @param bool $count whether to return the count or not (default FALSE) |
|
583 | + * @return EE_Event[]|int |
|
584 | + * @throws \EE_Error |
|
585 | + */ |
|
586 | + public function get_expired_events($query_params, $count = false) |
|
587 | + { |
|
588 | + $where_params = isset($query_params[0]) ? $query_params[0] : array(); |
|
589 | + // if we have count make sure we don't include group by |
|
590 | + if ($count && isset($query_params['group_by'])) { |
|
591 | + unset($query_params['group_by']); |
|
592 | + } |
|
593 | + // let's add specific query_params for active_events |
|
594 | + // keep in mind this will override any sent status in the query AND any date queries. |
|
595 | + if (isset($where_params['status'])) { |
|
596 | + unset($where_params['status']); |
|
597 | + } |
|
598 | + $exclude_query = $query_params; |
|
599 | + if (isset($exclude_query[0])) { |
|
600 | + unset($exclude_query[0]); |
|
601 | + } |
|
602 | + $exclude_query[0] = array( |
|
603 | + 'Datetime.DTT_EVT_end' => array( |
|
604 | + '>', |
|
605 | + EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
606 | + ), |
|
607 | + ); |
|
608 | + // first get all events that have datetimes where its not expired. |
|
609 | + $event_ids = $this->_get_all_wpdb_results($exclude_query, OBJECT_K, 'Event_CPT.ID'); |
|
610 | + $event_ids = array_keys($event_ids); |
|
611 | + // if we have any additional query_params, let's add them to the 'AND' condition |
|
612 | + $and_condition = array( |
|
613 | + 'Datetime.DTT_EVT_end' => array('<', EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end')), |
|
614 | + 'EVT_ID' => array('NOT IN', $event_ids), |
|
615 | + ); |
|
616 | + if (isset($where_params['OR'])) { |
|
617 | + $and_condition['OR'] = $where_params['OR']; |
|
618 | + unset($where_params['OR']); |
|
619 | + } |
|
620 | + if (isset($where_params['Datetime.DTT_EVT_end'])) { |
|
621 | + $and_condition['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end']; |
|
622 | + unset($where_params['Datetime.DTT_EVT_end']); |
|
623 | + } |
|
624 | + if (isset($where_params['Datetime.DTT_EVT_start'])) { |
|
625 | + $and_condition['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start']; |
|
626 | + unset($where_params['Datetime.DTT_EVT_start']); |
|
627 | + } |
|
628 | + // merge remaining $where params with the and conditions. |
|
629 | + $where_params['AND'] = array_merge($and_condition, $where_params); |
|
630 | + $query_params[0] = $where_params; |
|
631 | + // don't use $query_params with count() |
|
632 | + // because we don't want to include additional query clauses like "GROUP BY" |
|
633 | + return $count |
|
634 | + ? $this->count(array($where_params), 'EVT_ID', true) |
|
635 | + : $this->get_all($query_params); |
|
636 | + } |
|
637 | + |
|
638 | + |
|
639 | + |
|
640 | + /** |
|
641 | + * This basically just returns the events that do not have the publish status. |
|
642 | + * |
|
643 | + * @param array $query_params An array of query params to further filter on |
|
644 | + * (note that status will be overwritten) |
|
645 | + * @param boolean $count whether to return the count or not (default FALSE) |
|
646 | + * @return EE_Event[]|int |
|
647 | + * @throws \EE_Error |
|
648 | + */ |
|
649 | + public function get_inactive_events($query_params, $count = false) |
|
650 | + { |
|
651 | + $where_params = isset($query_params[0]) ? $query_params[0] : array(); |
|
652 | + // let's add in specific query_params for inactive events. |
|
653 | + if (isset($where_params['status'])) { |
|
654 | + unset($where_params['status']); |
|
655 | + } |
|
656 | + // if we have count make sure we don't include group by |
|
657 | + if ($count && isset($query_params['group_by'])) { |
|
658 | + unset($query_params['group_by']); |
|
659 | + } |
|
660 | + // if we have any additional query_params, let's add them to the 'AND' condition |
|
661 | + $where_params['AND']['status'] = array('!=', 'publish'); |
|
662 | + if (isset($where_params['OR'])) { |
|
663 | + $where_params['AND']['OR'] = $where_params['OR']; |
|
664 | + unset($where_params['OR']); |
|
665 | + } |
|
666 | + if (isset($where_params['Datetime.DTT_EVT_end'])) { |
|
667 | + $where_params['AND']['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end']; |
|
668 | + unset($where_params['Datetime.DTT_EVT_end']); |
|
669 | + } |
|
670 | + if (isset($where_params['Datetime.DTT_EVT_start'])) { |
|
671 | + $where_params['AND']['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start']; |
|
672 | + unset($where_params['Datetime.DTT_EVT_start']); |
|
673 | + } |
|
674 | + $query_params[0] = $where_params; |
|
675 | + // don't use $query_params with count() |
|
676 | + // because we don't want to include additional query clauses like "GROUP BY" |
|
677 | + return $count |
|
678 | + ? $this->count(array($where_params), 'EVT_ID', true) |
|
679 | + : $this->get_all($query_params); |
|
680 | + } |
|
681 | + |
|
682 | + |
|
683 | + |
|
684 | + /** |
|
685 | + * This is just injecting into the parent add_relationship_to so we do special handling on price relationships |
|
686 | + * because we don't want to override any existing global default prices but instead insert NEW prices that get |
|
687 | + * attached to the event. See parent for param descriptions |
|
688 | + * |
|
689 | + * @param $id_or_obj |
|
690 | + * @param $other_model_id_or_obj |
|
691 | + * @param string $relationName |
|
692 | + * @param array $where_query |
|
693 | + * @return EE_Base_Class |
|
694 | + * @throws EE_Error |
|
695 | + */ |
|
696 | + public function add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array()) |
|
697 | + { |
|
698 | + if ($relationName === 'Price') { |
|
699 | + //let's get the PRC object for the given ID to make sure that we aren't dealing with a default |
|
700 | + $prc_chk = $this->get_related_model_obj($relationName)->ensure_is_obj($other_model_id_or_obj); |
|
701 | + //if EVT_ID = 0, then this is a default |
|
702 | + if ((int) $prc_chk->get('EVT_ID') === 0) { |
|
703 | + //let's set the prc_id as 0 so we force an insert on the add_relation_to carried out by relation |
|
704 | + $prc_chk->set('PRC_ID', 0); |
|
705 | + } |
|
706 | + //run parent |
|
707 | + return parent::add_relationship_to($id_or_obj, $prc_chk, $relationName, $where_query); |
|
708 | + } |
|
709 | + //otherwise carry on as normal |
|
710 | + return parent::add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query); |
|
711 | + } |
|
712 | + |
|
713 | + |
|
714 | + |
|
715 | + /******************** DEPRECATED METHODS ********************/ |
|
716 | + |
|
717 | + |
|
718 | + |
|
719 | + /** |
|
720 | + * _get_question_target_db_column |
|
721 | + * |
|
722 | + * @deprecated as of 4.8.32.rc.001. Instead consider using |
|
723 | + * EE_Registration_Custom_Questions_Form located in |
|
724 | + * admin_pages/registrations/form_sections/EE_Registration_Custom_Questions_Form.form.php |
|
725 | + * @access public |
|
726 | + * @param EE_Registration $registration (so existing answers for registration are included) |
|
727 | + * @param int $EVT_ID so all question groups are included for event (not just answers from |
|
728 | + * registration). |
|
729 | + * @throws EE_Error |
|
730 | + * @return array |
|
731 | + */ |
|
732 | + public function assemble_array_of_groups_questions_and_options(EE_Registration $registration, $EVT_ID = 0) |
|
733 | + { |
|
734 | + if (empty($EVT_ID)) { |
|
735 | + throw new EE_Error(__('An error occurred. No EVT_ID is included. Needed to know which question groups to retrieve.', |
|
736 | + 'event_espresso')); |
|
737 | + } |
|
738 | + $questions = array(); |
|
739 | + // get all question groups for event |
|
740 | + $qgs = $this->get_question_groups_for_event($EVT_ID, $registration); |
|
741 | + if (! empty($qgs)) { |
|
742 | + foreach ($qgs as $qg) { |
|
743 | + $qsts = $qg->questions(); |
|
744 | + $questions[$qg->ID()] = $qg->model_field_array(); |
|
745 | + $questions[$qg->ID()]['QSG_questions'] = array(); |
|
746 | + foreach ($qsts as $qst) { |
|
747 | + if ($qst->is_system_question()) { |
|
748 | + continue; |
|
749 | + } |
|
750 | + $answer = EEM_Answer::instance()->get_one(array( |
|
751 | + array( |
|
752 | + 'QST_ID' => $qst->ID(), |
|
753 | + 'REG_ID' => $registration->ID(), |
|
754 | + ), |
|
755 | + )); |
|
756 | + $answer = $answer instanceof EE_Answer ? $answer : EEM_Answer::instance()->create_default_object(); |
|
757 | + $qst_name = $qstn_id = $qst->ID(); |
|
758 | + $ans_id = $answer->ID(); |
|
759 | + $qst_name = ! empty($ans_id) ? '[' . $qst_name . '][' . $ans_id . ']' : '[' . $qst_name . ']'; |
|
760 | + $input_name = ''; |
|
761 | + $input_id = sanitize_key($qst->display_text()); |
|
762 | + $input_class = ''; |
|
763 | + $questions[$qg->ID()]['QSG_questions'][$qst->ID()] = $qst->model_field_array(); |
|
764 | + $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_name'] = 'qstn' |
|
765 | + . $input_name |
|
766 | + . $qst_name; |
|
767 | + $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_id'] = $input_id . '-' . $qstn_id; |
|
768 | + $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_class'] = $input_class; |
|
769 | + $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'] = array(); |
|
770 | + $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['qst_obj'] = $qst; |
|
771 | + $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['ans_obj'] = $answer; |
|
772 | + //leave responses as-is, don't convert stuff into html entities please! |
|
773 | + $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['htmlentities'] = false; |
|
774 | + if ($qst->type() == 'RADIO_BTN' || $qst->type() == 'CHECKBOX' || $qst->type() == 'DROPDOWN') { |
|
775 | + $QSOs = $qst->options(true, $answer->value()); |
|
776 | + if (is_array($QSOs)) { |
|
777 | + foreach ($QSOs as $QSO_ID => $QSO) { |
|
778 | + $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'][$QSO_ID] = $QSO->model_field_array(); |
|
779 | + } |
|
780 | + } |
|
781 | + } |
|
782 | + } |
|
783 | + } |
|
784 | + } |
|
785 | + return $questions; |
|
786 | + } |
|
787 | 787 | |
788 | 788 | |
789 | 789 | } |
@@ -1,9 +1,9 @@ discard block |
||
1 | 1 | <?php use EventEspresso\core\services\orm\ModelFieldFactory; |
2 | 2 | |
3 | -if (! defined('EVENT_ESPRESSO_VERSION')) { |
|
3 | +if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
4 | 4 | exit('No direct script access allowed'); |
5 | 5 | } |
6 | -require_once(EE_MODELS . 'EEM_CPT_Base.model.php'); |
|
6 | +require_once(EE_MODELS.'EEM_CPT_Base.model.php'); |
|
7 | 7 | |
8 | 8 | |
9 | 9 | |
@@ -158,11 +158,11 @@ discard block |
||
158 | 158 | 'EVT_member_only' => new EE_Boolean_Field('EVT_member_only', |
159 | 159 | esc_html__('Member-Only Event Flag', 'event_espresso'), false, false), |
160 | 160 | 'EVT_phone' => new EE_Plain_Text_Field('EVT_phone', |
161 | - esc_html__('Event Phone Number', 'event_espresso'), false,''), |
|
161 | + esc_html__('Event Phone Number', 'event_espresso'), false, ''), |
|
162 | 162 | 'EVT_allow_overflow' => new EE_Boolean_Field('EVT_allow_overflow', |
163 | 163 | esc_html__('Allow Overflow on Event', 'event_espresso'), false, false), |
164 | 164 | 'EVT_timezone_string' => new EE_Plain_Text_Field('EVT_timezone_string', |
165 | - esc_html__('Timezone (name) for Event times', 'event_espresso'), false,''), |
|
165 | + esc_html__('Timezone (name) for Event times', 'event_espresso'), false, ''), |
|
166 | 166 | 'EVT_external_URL' => new EE_Plain_Text_Field('EVT_external_URL', |
167 | 167 | esc_html__('URL of Event Page if hosted elsewhere', 'event_espresso'), true), |
168 | 168 | 'EVT_donations' => new EE_Boolean_Field('EVT_donations', |
@@ -273,7 +273,7 @@ discard block |
||
273 | 273 | */ |
274 | 274 | public function get_all_event_question_groups($EVT_ID = 0) |
275 | 275 | { |
276 | - if (! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
276 | + if ( ! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
277 | 277 | EE_Error::add_error( |
278 | 278 | esc_html__( |
279 | 279 | 'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.', |
@@ -302,7 +302,7 @@ discard block |
||
302 | 302 | */ |
303 | 303 | public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true) |
304 | 304 | { |
305 | - if (! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
305 | + if ( ! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
306 | 306 | EE_Error::add_error( |
307 | 307 | esc_html__( |
308 | 308 | 'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.', |
@@ -334,7 +334,7 @@ discard block |
||
334 | 334 | */ |
335 | 335 | public function get_question_groups_for_event($EVT_ID = 0, EE_Registration $registration) |
336 | 336 | { |
337 | - if (! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
337 | + if ( ! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
338 | 338 | EE_Error::add_error( |
339 | 339 | esc_html__( |
340 | 340 | 'An error occurred. No Question Groups could be retrieved because an Event ID was not received.', |
@@ -738,7 +738,7 @@ discard block |
||
738 | 738 | $questions = array(); |
739 | 739 | // get all question groups for event |
740 | 740 | $qgs = $this->get_question_groups_for_event($EVT_ID, $registration); |
741 | - if (! empty($qgs)) { |
|
741 | + if ( ! empty($qgs)) { |
|
742 | 742 | foreach ($qgs as $qg) { |
743 | 743 | $qsts = $qg->questions(); |
744 | 744 | $questions[$qg->ID()] = $qg->model_field_array(); |
@@ -756,7 +756,7 @@ discard block |
||
756 | 756 | $answer = $answer instanceof EE_Answer ? $answer : EEM_Answer::instance()->create_default_object(); |
757 | 757 | $qst_name = $qstn_id = $qst->ID(); |
758 | 758 | $ans_id = $answer->ID(); |
759 | - $qst_name = ! empty($ans_id) ? '[' . $qst_name . '][' . $ans_id . ']' : '[' . $qst_name . ']'; |
|
759 | + $qst_name = ! empty($ans_id) ? '['.$qst_name.']['.$ans_id.']' : '['.$qst_name.']'; |
|
760 | 760 | $input_name = ''; |
761 | 761 | $input_id = sanitize_key($qst->display_text()); |
762 | 762 | $input_class = ''; |
@@ -764,7 +764,7 @@ discard block |
||
764 | 764 | $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_name'] = 'qstn' |
765 | 765 | . $input_name |
766 | 766 | . $qst_name; |
767 | - $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_id'] = $input_id . '-' . $qstn_id; |
|
767 | + $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_id'] = $input_id.'-'.$qstn_id; |
|
768 | 768 | $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_class'] = $input_class; |
769 | 769 | $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'] = array(); |
770 | 770 | $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['qst_obj'] = $qst; |
@@ -1,7 +1,7 @@ discard block |
||
1 | 1 | <?php use EventEspresso\core\services\Benchmark; |
2 | 2 | |
3 | 3 | if (! defined('EVENT_ESPRESSO_VERSION')) { |
4 | - exit('No direct script access allowed'); |
|
4 | + exit('No direct script access allowed'); |
|
5 | 5 | } |
6 | 6 | |
7 | 7 | |
@@ -17,632 +17,632 @@ discard block |
||
17 | 17 | class EEH_Debug_Tools |
18 | 18 | { |
19 | 19 | |
20 | - /** |
|
21 | - * instance of the EEH_Autoloader object |
|
22 | - * |
|
23 | - * @var $_instance |
|
24 | - * @access private |
|
25 | - */ |
|
26 | - private static $_instance; |
|
27 | - |
|
28 | - /** |
|
29 | - * @var array |
|
30 | - */ |
|
31 | - protected $_memory_usage_points = array(); |
|
32 | - |
|
33 | - |
|
34 | - |
|
35 | - /** |
|
36 | - * @singleton method used to instantiate class object |
|
37 | - * @access public |
|
38 | - * @return EEH_Debug_Tools |
|
39 | - */ |
|
40 | - public static function instance() |
|
41 | - { |
|
42 | - // check if class object is instantiated, and instantiated properly |
|
43 | - if (! self::$_instance instanceof EEH_Debug_Tools) { |
|
44 | - self::$_instance = new self(); |
|
45 | - } |
|
46 | - return self::$_instance; |
|
47 | - } |
|
48 | - |
|
49 | - |
|
50 | - |
|
51 | - /** |
|
52 | - * private class constructor |
|
53 | - */ |
|
54 | - private function __construct() |
|
55 | - { |
|
56 | - // load Kint PHP debugging library |
|
57 | - if (! class_exists('Kint') && file_exists(EE_PLUGIN_DIR_PATH . 'tests' . DS . 'kint' . DS . 'Kint.class.php')) { |
|
58 | - // despite EE4 having a check for an existing copy of the Kint debugging class, |
|
59 | - // if another plugin was loaded AFTER EE4 and they did NOT perform a similar check, |
|
60 | - // then hilarity would ensue as PHP throws a "Cannot redeclare class Kint" error |
|
61 | - // so we've moved it to our test folder so that it is not included with production releases |
|
62 | - // plz use https://wordpress.org/plugins/kint-debugger/ if testing production versions of EE |
|
63 | - require_once(EE_PLUGIN_DIR_PATH . 'tests' . DS . 'kint' . DS . 'Kint.class.php'); |
|
64 | - } |
|
65 | - // if ( ! defined('DOING_AJAX') || $_REQUEST['noheader'] !== 'true' || ! isset( $_REQUEST['noheader'], $_REQUEST['TB_iframe'] ) ) { |
|
66 | - //add_action( 'shutdown', array($this,'espresso_session_footer_dump') ); |
|
67 | - // } |
|
68 | - $plugin = basename(EE_PLUGIN_DIR_PATH); |
|
69 | - add_action("activate_{$plugin}", array('EEH_Debug_Tools', 'ee_plugin_activation_errors')); |
|
70 | - add_action('activated_plugin', array('EEH_Debug_Tools', 'ee_plugin_activation_errors')); |
|
71 | - add_action('shutdown', array('EEH_Debug_Tools', 'show_db_name')); |
|
72 | - } |
|
73 | - |
|
74 | - |
|
75 | - |
|
76 | - /** |
|
77 | - * show_db_name |
|
78 | - * |
|
79 | - * @return void |
|
80 | - */ |
|
81 | - public static function show_db_name() |
|
82 | - { |
|
83 | - if (! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) { |
|
84 | - echo '<p style="font-size:10px;font-weight:normal;color:#E76700;margin: 1em 2em; text-align: right;">DB_NAME: ' |
|
85 | - . DB_NAME |
|
86 | - . '</p>'; |
|
87 | - } |
|
88 | - if (EE_DEBUG) { |
|
89 | - Benchmark::displayResults(); |
|
90 | - } |
|
91 | - } |
|
92 | - |
|
93 | - |
|
94 | - |
|
95 | - /** |
|
96 | - * dump EE_Session object at bottom of page after everything else has happened |
|
97 | - * |
|
98 | - * @return void |
|
99 | - */ |
|
100 | - public function espresso_session_footer_dump() |
|
101 | - { |
|
102 | - if ( |
|
103 | - (defined('WP_DEBUG') && WP_DEBUG) |
|
104 | - && ! defined('DOING_AJAX') |
|
105 | - && class_exists('Kint') |
|
106 | - && function_exists('wp_get_current_user') |
|
107 | - && current_user_can('update_core') |
|
108 | - && class_exists('EE_Registry') |
|
109 | - ) { |
|
110 | - Kint::dump(EE_Registry::instance()->SSN->id()); |
|
111 | - Kint::dump(EE_Registry::instance()->SSN); |
|
112 | - // Kint::dump( EE_Registry::instance()->SSN->get_session_data('cart')->get_tickets() ); |
|
113 | - $this->espresso_list_hooked_functions(); |
|
114 | - Benchmark::displayResults(); |
|
115 | - } |
|
116 | - } |
|
117 | - |
|
118 | - |
|
119 | - |
|
120 | - /** |
|
121 | - * List All Hooked Functions |
|
122 | - * to list all functions for a specific hook, add ee_list_hooks={hook-name} to URL |
|
123 | - * http://wp.smashingmagazine.com/2009/08/18/10-useful-wordpress-hook-hacks/ |
|
124 | - * |
|
125 | - * @param string $tag |
|
126 | - * @return void |
|
127 | - */ |
|
128 | - public function espresso_list_hooked_functions($tag = '') |
|
129 | - { |
|
130 | - global $wp_filter; |
|
131 | - echo '<br/><br/><br/><h3>Hooked Functions</h3>'; |
|
132 | - if ($tag) { |
|
133 | - $hook[$tag] = $wp_filter[$tag]; |
|
134 | - if (! is_array($hook[$tag])) { |
|
135 | - trigger_error("Nothing found for '$tag' hook", E_USER_WARNING); |
|
136 | - return; |
|
137 | - } |
|
138 | - echo '<h5>For Tag: ' . $tag . '</h5>'; |
|
139 | - } else { |
|
140 | - $hook = is_array($wp_filter) ? $wp_filter : array($wp_filter); |
|
141 | - ksort($hook); |
|
142 | - } |
|
143 | - foreach ($hook as $tag_name => $priorities) { |
|
144 | - echo "<br />>>>>>\t<strong>$tag_name</strong><br />"; |
|
145 | - ksort($priorities); |
|
146 | - foreach ($priorities as $priority => $function) { |
|
147 | - echo $priority; |
|
148 | - foreach ($function as $name => $properties) { |
|
149 | - echo "\t$name<br />"; |
|
150 | - } |
|
151 | - } |
|
152 | - } |
|
153 | - } |
|
154 | - |
|
155 | - |
|
156 | - |
|
157 | - /** |
|
158 | - * registered_filter_callbacks |
|
159 | - * |
|
160 | - * @param string $hook_name |
|
161 | - * @return array |
|
162 | - */ |
|
163 | - public static function registered_filter_callbacks($hook_name = '') |
|
164 | - { |
|
165 | - $filters = array(); |
|
166 | - global $wp_filter; |
|
167 | - if (isset($wp_filter[$hook_name])) { |
|
168 | - $filters[$hook_name] = array(); |
|
169 | - foreach ($wp_filter[$hook_name] as $priority => $callbacks) { |
|
170 | - $filters[$hook_name][$priority] = array(); |
|
171 | - foreach ($callbacks as $callback) { |
|
172 | - $filters[$hook_name][$priority][] = $callback['function']; |
|
173 | - } |
|
174 | - } |
|
175 | - } |
|
176 | - return $filters; |
|
177 | - } |
|
178 | - |
|
179 | - |
|
180 | - |
|
181 | - /** |
|
182 | - * captures plugin activation errors for debugging |
|
183 | - * |
|
184 | - * @return void |
|
185 | - * @throws EE_Error |
|
186 | - */ |
|
187 | - public static function ee_plugin_activation_errors() |
|
188 | - { |
|
189 | - if (WP_DEBUG) { |
|
190 | - $activation_errors = ob_get_contents(); |
|
191 | - if (! empty($activation_errors)) { |
|
192 | - $activation_errors = date('Y-m-d H:i:s') . "\n" . $activation_errors; |
|
193 | - } |
|
194 | - espresso_load_required('EEH_File', EE_HELPERS . 'EEH_File.helper.php'); |
|
195 | - if (class_exists('EEH_File')) { |
|
196 | - try { |
|
197 | - EEH_File::ensure_file_exists_and_is_writable( |
|
198 | - EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html' |
|
199 | - ); |
|
200 | - EEH_File::write_to_file( |
|
201 | - EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html', |
|
202 | - $activation_errors |
|
203 | - ); |
|
204 | - } catch (EE_Error $e) { |
|
205 | - EE_Error::add_error( |
|
206 | - sprintf( |
|
207 | - __( |
|
208 | - 'The Event Espresso activation errors file could not be setup because: %s', |
|
209 | - 'event_espresso' |
|
210 | - ), |
|
211 | - $e->getMessage() |
|
212 | - ), |
|
213 | - __FILE__, __FUNCTION__, __LINE__ |
|
214 | - ); |
|
215 | - } |
|
216 | - } else { |
|
217 | - // old school attempt |
|
218 | - file_put_contents( |
|
219 | - EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html', |
|
220 | - $activation_errors |
|
221 | - ); |
|
222 | - } |
|
223 | - $activation_errors = get_option('ee_plugin_activation_errors', '') . $activation_errors; |
|
224 | - update_option('ee_plugin_activation_errors', $activation_errors); |
|
225 | - } |
|
226 | - } |
|
227 | - |
|
228 | - |
|
229 | - |
|
230 | - /** |
|
231 | - * This basically mimics the WordPress _doing_it_wrong() function except adds our own messaging etc. |
|
232 | - * Very useful for providing helpful messages to developers when the method of doing something has been deprecated, |
|
233 | - * or we want to make sure they use something the right way. |
|
234 | - * |
|
235 | - * @access public |
|
236 | - * @param string $function The function that was called |
|
237 | - * @param string $message A message explaining what has been done incorrectly |
|
238 | - * @param string $version The version of Event Espresso where the error was added |
|
239 | - * @param string $applies_when a version string for when you want the doing_it_wrong notice to begin appearing |
|
240 | - * for a deprecated function. This allows deprecation to occur during one version, |
|
241 | - * but not have any notices appear until a later version. This allows developers |
|
242 | - * extra time to update their code before notices appear. |
|
243 | - * @param int $error_type |
|
244 | - * @uses trigger_error() |
|
245 | - */ |
|
246 | - public function doing_it_wrong( |
|
247 | - $function, |
|
248 | - $message, |
|
249 | - $version, |
|
250 | - $applies_when = '', |
|
251 | - $error_type = null |
|
252 | - ) { |
|
253 | - $applies_when = ! empty($applies_when) ? $applies_when : espresso_version(); |
|
254 | - $error_type = $error_type !== null ? $error_type : E_USER_NOTICE; |
|
255 | - // because we swapped the parameter order around for the last two params, |
|
256 | - // let's verify that some third party isn't still passing an error type value for the third param |
|
257 | - if (is_int($applies_when)) { |
|
258 | - $error_type = $applies_when; |
|
259 | - $applies_when = espresso_version(); |
|
260 | - } |
|
261 | - // if not displaying notices yet, then just leave |
|
262 | - if (version_compare(espresso_version(), $applies_when, '<')) { |
|
263 | - return; |
|
264 | - } |
|
265 | - do_action('AHEE__EEH_Debug_Tools__doing_it_wrong_run', $function, $message, $version); |
|
266 | - $version = $version === null |
|
267 | - ? '' |
|
268 | - : sprintf( |
|
269 | - __('(This message was added in version %s of Event Espresso)', 'event_espresso'), |
|
270 | - $version |
|
271 | - ); |
|
272 | - $error_message = sprintf( |
|
273 | - esc_html__('%1$s was called %2$sincorrectly%3$s. %4$s %5$s', 'event_espresso'), |
|
274 | - $function, |
|
275 | - '<strong>', |
|
276 | - '</strong>', |
|
277 | - $message, |
|
278 | - $version |
|
279 | - ); |
|
280 | - // don't trigger error if doing ajax, |
|
281 | - // instead we'll add a transient EE_Error notice that in theory should show on the next request. |
|
282 | - if (defined('DOING_AJAX') && DOING_AJAX) { |
|
283 | - $error_message .= ' ' . esc_html__( |
|
284 | - 'This is a doing_it_wrong message that was triggered during an ajax request. The request params on this request were: ', |
|
285 | - 'event_espresso' |
|
286 | - ); |
|
287 | - $error_message .= '<ul><li>'; |
|
288 | - $error_message .= implode('</li><li>', EE_Registry::instance()->REQ->params()); |
|
289 | - $error_message .= '</ul>'; |
|
290 | - EE_Error::add_error($error_message, 'debug::doing_it_wrong', $function, '42'); |
|
291 | - //now we set this on the transient so it shows up on the next request. |
|
292 | - EE_Error::get_notices(false, true); |
|
293 | - } else { |
|
294 | - trigger_error($error_message, $error_type); |
|
295 | - } |
|
296 | - } |
|
297 | - |
|
298 | - |
|
299 | - |
|
300 | - |
|
301 | - /** |
|
302 | - * Logger helpers |
|
303 | - */ |
|
304 | - /** |
|
305 | - * debug |
|
306 | - * |
|
307 | - * @param string $class |
|
308 | - * @param string $func |
|
309 | - * @param string $line |
|
310 | - * @param array $info |
|
311 | - * @param bool $display_request |
|
312 | - * @param string $debug_index |
|
313 | - * @param string $debug_key |
|
314 | - * @throws EE_Error |
|
315 | - * @throws \EventEspresso\core\exceptions\InvalidSessionDataException |
|
316 | - */ |
|
317 | - public static function log( |
|
318 | - $class = '', |
|
319 | - $func = '', |
|
320 | - $line = '', |
|
321 | - $info = array(), |
|
322 | - $display_request = false, |
|
323 | - $debug_index = '', |
|
324 | - $debug_key = 'EE_DEBUG_SPCO' |
|
325 | - ) { |
|
326 | - if (WP_DEBUG) { |
|
327 | - $debug_key = $debug_key . '_' . EE_Session::instance()->id(); |
|
328 | - $debug_data = get_option($debug_key, array()); |
|
329 | - $default_data = array( |
|
330 | - $class => $func . '() : ' . $line, |
|
331 | - 'REQ' => $display_request ? $_REQUEST : '', |
|
332 | - ); |
|
333 | - // don't serialize objects |
|
334 | - $info = self::strip_objects($info); |
|
335 | - $index = ! empty($debug_index) ? $debug_index : 0; |
|
336 | - if (! isset($debug_data[$index])) { |
|
337 | - $debug_data[$index] = array(); |
|
338 | - } |
|
339 | - $debug_data[$index][microtime()] = array_merge($default_data, $info); |
|
340 | - update_option($debug_key, $debug_data); |
|
341 | - } |
|
342 | - } |
|
343 | - |
|
344 | - |
|
345 | - |
|
346 | - /** |
|
347 | - * strip_objects |
|
348 | - * |
|
349 | - * @param array $info |
|
350 | - * @return array |
|
351 | - */ |
|
352 | - public static function strip_objects($info = array()) |
|
353 | - { |
|
354 | - foreach ($info as $key => $value) { |
|
355 | - if (is_array($value)) { |
|
356 | - $info[$key] = self::strip_objects($value); |
|
357 | - } else if (is_object($value)) { |
|
358 | - $object_class = get_class($value); |
|
359 | - $info[$object_class] = array(); |
|
360 | - $info[$object_class]['ID'] = method_exists($value, 'ID') ? $value->ID() : spl_object_hash($value); |
|
361 | - if (method_exists($value, 'ID')) { |
|
362 | - $info[$object_class]['ID'] = $value->ID(); |
|
363 | - } |
|
364 | - if (method_exists($value, 'status')) { |
|
365 | - $info[$object_class]['status'] = $value->status(); |
|
366 | - } else if (method_exists($value, 'status_ID')) { |
|
367 | - $info[$object_class]['status'] = $value->status_ID(); |
|
368 | - } |
|
369 | - unset($info[$key]); |
|
370 | - } |
|
371 | - } |
|
372 | - return (array)$info; |
|
373 | - } |
|
374 | - |
|
375 | - |
|
376 | - |
|
377 | - /** |
|
378 | - * @param mixed $var |
|
379 | - * @param string $var_name |
|
380 | - * @param string $file |
|
381 | - * @param int|string $line |
|
382 | - * @param int $heading_tag |
|
383 | - * @param bool $die |
|
384 | - * @param string $margin |
|
385 | - */ |
|
386 | - public static function printv( |
|
387 | - $var, |
|
388 | - $var_name = '', |
|
389 | - $file = '', |
|
390 | - $line = '', |
|
391 | - $heading_tag = 5, |
|
392 | - $die = false, |
|
393 | - $margin = '' |
|
394 | - ) { |
|
395 | - $var_name = ! $var_name ? 'string' : $var_name; |
|
396 | - $var_name = ucwords(str_replace('$', '', $var_name)); |
|
397 | - $is_method = method_exists($var_name, $var); |
|
398 | - $var_name = ucwords(str_replace('_', ' ', $var_name)); |
|
399 | - $heading_tag = is_int($heading_tag) ? "h{$heading_tag}" : 'h5'; |
|
400 | - $result = EEH_Debug_Tools::heading($var_name, $heading_tag, $margin); |
|
401 | - $result .= $is_method |
|
402 | - ? EEH_Debug_Tools::grey_span('::') . EEH_Debug_Tools::orange_span($var . '()') |
|
403 | - : EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span($var); |
|
404 | - $result .= EEH_Debug_Tools::file_and_line($file, $line); |
|
405 | - $result .= EEH_Debug_Tools::headingX($heading_tag); |
|
406 | - if ($die) { |
|
407 | - die($result); |
|
408 | - } |
|
409 | - echo $result; |
|
410 | - } |
|
411 | - |
|
412 | - |
|
413 | - |
|
414 | - /** |
|
415 | - * @param string $var_name |
|
416 | - * @param string $heading_tag |
|
417 | - * @param string $margin |
|
418 | - * @return string |
|
419 | - */ |
|
420 | - protected static function heading($var_name = '', $heading_tag = 'h5', $margin = '') |
|
421 | - { |
|
422 | - if (defined('EE_TESTS_DIR')) { |
|
423 | - return "\n{$var_name}"; |
|
424 | - } |
|
425 | - $margin = "25px 0 0 {$margin}"; |
|
426 | - return '<' . $heading_tag . ' style="color:#2EA2CC; margin:' . $margin . ';"><b>' . $var_name . '</b>'; |
|
427 | - } |
|
428 | - |
|
429 | - |
|
430 | - |
|
431 | - /** |
|
432 | - * @param string $heading_tag |
|
433 | - * @return string |
|
434 | - */ |
|
435 | - protected static function headingX($heading_tag = 'h5') |
|
436 | - { |
|
437 | - if (defined('EE_TESTS_DIR')) { |
|
438 | - return ''; |
|
439 | - } |
|
440 | - return '</' . $heading_tag . '>'; |
|
441 | - } |
|
442 | - |
|
443 | - |
|
444 | - |
|
445 | - /** |
|
446 | - * @param string $content |
|
447 | - * @return string |
|
448 | - */ |
|
449 | - protected static function grey_span($content = '') |
|
450 | - { |
|
451 | - if (defined('EE_TESTS_DIR')) { |
|
452 | - return $content; |
|
453 | - } |
|
454 | - return '<span style="color:#999">' . $content . '</span>'; |
|
455 | - } |
|
456 | - |
|
457 | - |
|
458 | - |
|
459 | - /** |
|
460 | - * @param string $file |
|
461 | - * @param int $line |
|
462 | - * @return string |
|
463 | - */ |
|
464 | - protected static function file_and_line($file, $line) |
|
465 | - { |
|
466 | - if ($file === '' || $line === '') { |
|
467 | - return ''; |
|
468 | - } |
|
469 | - if (defined('EE_TESTS_DIR')) { |
|
470 | - return "\n\t(" . $file . ' line no: ' . $line . ' ) '; |
|
471 | - } |
|
472 | - return '<br /><span style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;">' |
|
473 | - . $file |
|
474 | - . '<br />line no: ' |
|
475 | - . $line |
|
476 | - . '</span>'; |
|
477 | - } |
|
478 | - |
|
479 | - |
|
480 | - |
|
481 | - /** |
|
482 | - * @param string $content |
|
483 | - * @return string |
|
484 | - */ |
|
485 | - protected static function orange_span($content = '') |
|
486 | - { |
|
487 | - if (defined('EE_TESTS_DIR')) { |
|
488 | - return $content; |
|
489 | - } |
|
490 | - return '<span style="color:#E76700">' . $content . '</span>'; |
|
491 | - } |
|
492 | - |
|
493 | - |
|
494 | - |
|
495 | - /** |
|
496 | - * @param mixed $var |
|
497 | - * @return string |
|
498 | - */ |
|
499 | - protected static function pre_span($var) |
|
500 | - { |
|
501 | - ob_start(); |
|
502 | - var_dump($var); |
|
503 | - $var = ob_get_clean(); |
|
504 | - if (defined('EE_TESTS_DIR')) { |
|
505 | - return "\n" . $var; |
|
506 | - } |
|
507 | - return '<pre style="color:#999; padding:1em; background: #fff">' . $var . '</pre>'; |
|
508 | - } |
|
509 | - |
|
510 | - |
|
511 | - |
|
512 | - /** |
|
513 | - * @param mixed $var |
|
514 | - * @param string $var_name |
|
515 | - * @param string $file |
|
516 | - * @param int|string $line |
|
517 | - * @param int $heading_tag |
|
518 | - * @param bool $die |
|
519 | - */ |
|
520 | - public static function printr( |
|
521 | - $var, |
|
522 | - $var_name = '', |
|
523 | - $file = '', |
|
524 | - $line = '', |
|
525 | - $heading_tag = 5, |
|
526 | - $die = false |
|
527 | - ) { |
|
528 | - // return; |
|
529 | - $file = str_replace(rtrim(ABSPATH, '\\/'), '', $file); |
|
530 | - $margin = is_admin() ? ' 180px' : '0'; |
|
531 | - //$print_r = false; |
|
532 | - if (is_string($var)) { |
|
533 | - EEH_Debug_Tools::printv($var, $var_name, $file, $line, $heading_tag, $die, $margin); |
|
534 | - return; |
|
535 | - } |
|
536 | - if (is_object($var)) { |
|
537 | - $var_name = ! $var_name ? 'object' : $var_name; |
|
538 | - //$print_r = true; |
|
539 | - } else if (is_array($var)) { |
|
540 | - $var_name = ! $var_name ? 'array' : $var_name; |
|
541 | - //$print_r = true; |
|
542 | - } else if (is_numeric($var)) { |
|
543 | - $var_name = ! $var_name ? 'numeric' : $var_name; |
|
544 | - } else if ($var === null) { |
|
545 | - $var_name = ! $var_name ? 'null' : $var_name; |
|
546 | - } |
|
547 | - $var_name = ucwords(str_replace(array('$', '_'), array('', ' '), $var_name)); |
|
548 | - $heading_tag = is_int($heading_tag) ? "h{$heading_tag}" : 'h5'; |
|
549 | - $result = EEH_Debug_Tools::heading($var_name, $heading_tag, $margin); |
|
550 | - $result .= EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span( |
|
551 | - EEH_Debug_Tools::pre_span($var) |
|
552 | - ); |
|
553 | - $result .= EEH_Debug_Tools::file_and_line($file, $line); |
|
554 | - $result .= EEH_Debug_Tools::headingX($heading_tag); |
|
555 | - if ($die) { |
|
556 | - die($result); |
|
557 | - } |
|
558 | - echo $result; |
|
559 | - } |
|
560 | - |
|
561 | - |
|
562 | - |
|
563 | - /******************** deprecated ********************/ |
|
564 | - |
|
565 | - |
|
566 | - |
|
567 | - /** |
|
568 | - * @deprecated 4.9.39.rc.034 |
|
569 | - */ |
|
570 | - public function reset_times() |
|
571 | - { |
|
572 | - Benchmark::resetTimes(); |
|
573 | - } |
|
574 | - |
|
575 | - |
|
576 | - |
|
577 | - /** |
|
578 | - * @deprecated 4.9.39.rc.034 |
|
579 | - * @param null $timer_name |
|
580 | - */ |
|
581 | - public function start_timer($timer_name = null) |
|
582 | - { |
|
583 | - Benchmark::startTimer($timer_name); |
|
584 | - } |
|
585 | - |
|
586 | - |
|
587 | - |
|
588 | - /** |
|
589 | - * @deprecated 4.9.39.rc.034 |
|
590 | - * @param string $timer_name |
|
591 | - */ |
|
592 | - public function stop_timer($timer_name = '') |
|
593 | - { |
|
594 | - Benchmark::stopTimer($timer_name); |
|
595 | - } |
|
596 | - |
|
597 | - |
|
598 | - |
|
599 | - /** |
|
600 | - * @deprecated 4.9.39.rc.034 |
|
601 | - * @param string $label The label to show for this time eg "Start of calling Some_Class::some_function" |
|
602 | - * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called |
|
603 | - * @return void |
|
604 | - */ |
|
605 | - public function measure_memory($label, $output_now = false) |
|
606 | - { |
|
607 | - Benchmark::measureMemory($label, $output_now); |
|
608 | - } |
|
609 | - |
|
610 | - |
|
611 | - |
|
612 | - /** |
|
613 | - * @deprecated 4.9.39.rc.034 |
|
614 | - * @param int $size |
|
615 | - * @return string |
|
616 | - */ |
|
617 | - public function convert($size) |
|
618 | - { |
|
619 | - return Benchmark::convert($size); |
|
620 | - } |
|
621 | - |
|
622 | - |
|
623 | - |
|
624 | - /** |
|
625 | - * @deprecated 4.9.39.rc.034 |
|
626 | - * @param bool $output_now |
|
627 | - * @return string |
|
628 | - */ |
|
629 | - public function show_times($output_now = true) |
|
630 | - { |
|
631 | - return Benchmark::displayResults($output_now); |
|
632 | - } |
|
633 | - |
|
634 | - |
|
635 | - |
|
636 | - /** |
|
637 | - * @deprecated 4.9.39.rc.034 |
|
638 | - * @param string $timer_name |
|
639 | - * @param float $total_time |
|
640 | - * @return string |
|
641 | - */ |
|
642 | - public function format_time($timer_name, $total_time) |
|
643 | - { |
|
644 | - return Benchmark::formatTime($timer_name, $total_time); |
|
645 | - } |
|
20 | + /** |
|
21 | + * instance of the EEH_Autoloader object |
|
22 | + * |
|
23 | + * @var $_instance |
|
24 | + * @access private |
|
25 | + */ |
|
26 | + private static $_instance; |
|
27 | + |
|
28 | + /** |
|
29 | + * @var array |
|
30 | + */ |
|
31 | + protected $_memory_usage_points = array(); |
|
32 | + |
|
33 | + |
|
34 | + |
|
35 | + /** |
|
36 | + * @singleton method used to instantiate class object |
|
37 | + * @access public |
|
38 | + * @return EEH_Debug_Tools |
|
39 | + */ |
|
40 | + public static function instance() |
|
41 | + { |
|
42 | + // check if class object is instantiated, and instantiated properly |
|
43 | + if (! self::$_instance instanceof EEH_Debug_Tools) { |
|
44 | + self::$_instance = new self(); |
|
45 | + } |
|
46 | + return self::$_instance; |
|
47 | + } |
|
48 | + |
|
49 | + |
|
50 | + |
|
51 | + /** |
|
52 | + * private class constructor |
|
53 | + */ |
|
54 | + private function __construct() |
|
55 | + { |
|
56 | + // load Kint PHP debugging library |
|
57 | + if (! class_exists('Kint') && file_exists(EE_PLUGIN_DIR_PATH . 'tests' . DS . 'kint' . DS . 'Kint.class.php')) { |
|
58 | + // despite EE4 having a check for an existing copy of the Kint debugging class, |
|
59 | + // if another plugin was loaded AFTER EE4 and they did NOT perform a similar check, |
|
60 | + // then hilarity would ensue as PHP throws a "Cannot redeclare class Kint" error |
|
61 | + // so we've moved it to our test folder so that it is not included with production releases |
|
62 | + // plz use https://wordpress.org/plugins/kint-debugger/ if testing production versions of EE |
|
63 | + require_once(EE_PLUGIN_DIR_PATH . 'tests' . DS . 'kint' . DS . 'Kint.class.php'); |
|
64 | + } |
|
65 | + // if ( ! defined('DOING_AJAX') || $_REQUEST['noheader'] !== 'true' || ! isset( $_REQUEST['noheader'], $_REQUEST['TB_iframe'] ) ) { |
|
66 | + //add_action( 'shutdown', array($this,'espresso_session_footer_dump') ); |
|
67 | + // } |
|
68 | + $plugin = basename(EE_PLUGIN_DIR_PATH); |
|
69 | + add_action("activate_{$plugin}", array('EEH_Debug_Tools', 'ee_plugin_activation_errors')); |
|
70 | + add_action('activated_plugin', array('EEH_Debug_Tools', 'ee_plugin_activation_errors')); |
|
71 | + add_action('shutdown', array('EEH_Debug_Tools', 'show_db_name')); |
|
72 | + } |
|
73 | + |
|
74 | + |
|
75 | + |
|
76 | + /** |
|
77 | + * show_db_name |
|
78 | + * |
|
79 | + * @return void |
|
80 | + */ |
|
81 | + public static function show_db_name() |
|
82 | + { |
|
83 | + if (! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) { |
|
84 | + echo '<p style="font-size:10px;font-weight:normal;color:#E76700;margin: 1em 2em; text-align: right;">DB_NAME: ' |
|
85 | + . DB_NAME |
|
86 | + . '</p>'; |
|
87 | + } |
|
88 | + if (EE_DEBUG) { |
|
89 | + Benchmark::displayResults(); |
|
90 | + } |
|
91 | + } |
|
92 | + |
|
93 | + |
|
94 | + |
|
95 | + /** |
|
96 | + * dump EE_Session object at bottom of page after everything else has happened |
|
97 | + * |
|
98 | + * @return void |
|
99 | + */ |
|
100 | + public function espresso_session_footer_dump() |
|
101 | + { |
|
102 | + if ( |
|
103 | + (defined('WP_DEBUG') && WP_DEBUG) |
|
104 | + && ! defined('DOING_AJAX') |
|
105 | + && class_exists('Kint') |
|
106 | + && function_exists('wp_get_current_user') |
|
107 | + && current_user_can('update_core') |
|
108 | + && class_exists('EE_Registry') |
|
109 | + ) { |
|
110 | + Kint::dump(EE_Registry::instance()->SSN->id()); |
|
111 | + Kint::dump(EE_Registry::instance()->SSN); |
|
112 | + // Kint::dump( EE_Registry::instance()->SSN->get_session_data('cart')->get_tickets() ); |
|
113 | + $this->espresso_list_hooked_functions(); |
|
114 | + Benchmark::displayResults(); |
|
115 | + } |
|
116 | + } |
|
117 | + |
|
118 | + |
|
119 | + |
|
120 | + /** |
|
121 | + * List All Hooked Functions |
|
122 | + * to list all functions for a specific hook, add ee_list_hooks={hook-name} to URL |
|
123 | + * http://wp.smashingmagazine.com/2009/08/18/10-useful-wordpress-hook-hacks/ |
|
124 | + * |
|
125 | + * @param string $tag |
|
126 | + * @return void |
|
127 | + */ |
|
128 | + public function espresso_list_hooked_functions($tag = '') |
|
129 | + { |
|
130 | + global $wp_filter; |
|
131 | + echo '<br/><br/><br/><h3>Hooked Functions</h3>'; |
|
132 | + if ($tag) { |
|
133 | + $hook[$tag] = $wp_filter[$tag]; |
|
134 | + if (! is_array($hook[$tag])) { |
|
135 | + trigger_error("Nothing found for '$tag' hook", E_USER_WARNING); |
|
136 | + return; |
|
137 | + } |
|
138 | + echo '<h5>For Tag: ' . $tag . '</h5>'; |
|
139 | + } else { |
|
140 | + $hook = is_array($wp_filter) ? $wp_filter : array($wp_filter); |
|
141 | + ksort($hook); |
|
142 | + } |
|
143 | + foreach ($hook as $tag_name => $priorities) { |
|
144 | + echo "<br />>>>>>\t<strong>$tag_name</strong><br />"; |
|
145 | + ksort($priorities); |
|
146 | + foreach ($priorities as $priority => $function) { |
|
147 | + echo $priority; |
|
148 | + foreach ($function as $name => $properties) { |
|
149 | + echo "\t$name<br />"; |
|
150 | + } |
|
151 | + } |
|
152 | + } |
|
153 | + } |
|
154 | + |
|
155 | + |
|
156 | + |
|
157 | + /** |
|
158 | + * registered_filter_callbacks |
|
159 | + * |
|
160 | + * @param string $hook_name |
|
161 | + * @return array |
|
162 | + */ |
|
163 | + public static function registered_filter_callbacks($hook_name = '') |
|
164 | + { |
|
165 | + $filters = array(); |
|
166 | + global $wp_filter; |
|
167 | + if (isset($wp_filter[$hook_name])) { |
|
168 | + $filters[$hook_name] = array(); |
|
169 | + foreach ($wp_filter[$hook_name] as $priority => $callbacks) { |
|
170 | + $filters[$hook_name][$priority] = array(); |
|
171 | + foreach ($callbacks as $callback) { |
|
172 | + $filters[$hook_name][$priority][] = $callback['function']; |
|
173 | + } |
|
174 | + } |
|
175 | + } |
|
176 | + return $filters; |
|
177 | + } |
|
178 | + |
|
179 | + |
|
180 | + |
|
181 | + /** |
|
182 | + * captures plugin activation errors for debugging |
|
183 | + * |
|
184 | + * @return void |
|
185 | + * @throws EE_Error |
|
186 | + */ |
|
187 | + public static function ee_plugin_activation_errors() |
|
188 | + { |
|
189 | + if (WP_DEBUG) { |
|
190 | + $activation_errors = ob_get_contents(); |
|
191 | + if (! empty($activation_errors)) { |
|
192 | + $activation_errors = date('Y-m-d H:i:s') . "\n" . $activation_errors; |
|
193 | + } |
|
194 | + espresso_load_required('EEH_File', EE_HELPERS . 'EEH_File.helper.php'); |
|
195 | + if (class_exists('EEH_File')) { |
|
196 | + try { |
|
197 | + EEH_File::ensure_file_exists_and_is_writable( |
|
198 | + EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html' |
|
199 | + ); |
|
200 | + EEH_File::write_to_file( |
|
201 | + EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html', |
|
202 | + $activation_errors |
|
203 | + ); |
|
204 | + } catch (EE_Error $e) { |
|
205 | + EE_Error::add_error( |
|
206 | + sprintf( |
|
207 | + __( |
|
208 | + 'The Event Espresso activation errors file could not be setup because: %s', |
|
209 | + 'event_espresso' |
|
210 | + ), |
|
211 | + $e->getMessage() |
|
212 | + ), |
|
213 | + __FILE__, __FUNCTION__, __LINE__ |
|
214 | + ); |
|
215 | + } |
|
216 | + } else { |
|
217 | + // old school attempt |
|
218 | + file_put_contents( |
|
219 | + EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html', |
|
220 | + $activation_errors |
|
221 | + ); |
|
222 | + } |
|
223 | + $activation_errors = get_option('ee_plugin_activation_errors', '') . $activation_errors; |
|
224 | + update_option('ee_plugin_activation_errors', $activation_errors); |
|
225 | + } |
|
226 | + } |
|
227 | + |
|
228 | + |
|
229 | + |
|
230 | + /** |
|
231 | + * This basically mimics the WordPress _doing_it_wrong() function except adds our own messaging etc. |
|
232 | + * Very useful for providing helpful messages to developers when the method of doing something has been deprecated, |
|
233 | + * or we want to make sure they use something the right way. |
|
234 | + * |
|
235 | + * @access public |
|
236 | + * @param string $function The function that was called |
|
237 | + * @param string $message A message explaining what has been done incorrectly |
|
238 | + * @param string $version The version of Event Espresso where the error was added |
|
239 | + * @param string $applies_when a version string for when you want the doing_it_wrong notice to begin appearing |
|
240 | + * for a deprecated function. This allows deprecation to occur during one version, |
|
241 | + * but not have any notices appear until a later version. This allows developers |
|
242 | + * extra time to update their code before notices appear. |
|
243 | + * @param int $error_type |
|
244 | + * @uses trigger_error() |
|
245 | + */ |
|
246 | + public function doing_it_wrong( |
|
247 | + $function, |
|
248 | + $message, |
|
249 | + $version, |
|
250 | + $applies_when = '', |
|
251 | + $error_type = null |
|
252 | + ) { |
|
253 | + $applies_when = ! empty($applies_when) ? $applies_when : espresso_version(); |
|
254 | + $error_type = $error_type !== null ? $error_type : E_USER_NOTICE; |
|
255 | + // because we swapped the parameter order around for the last two params, |
|
256 | + // let's verify that some third party isn't still passing an error type value for the third param |
|
257 | + if (is_int($applies_when)) { |
|
258 | + $error_type = $applies_when; |
|
259 | + $applies_when = espresso_version(); |
|
260 | + } |
|
261 | + // if not displaying notices yet, then just leave |
|
262 | + if (version_compare(espresso_version(), $applies_when, '<')) { |
|
263 | + return; |
|
264 | + } |
|
265 | + do_action('AHEE__EEH_Debug_Tools__doing_it_wrong_run', $function, $message, $version); |
|
266 | + $version = $version === null |
|
267 | + ? '' |
|
268 | + : sprintf( |
|
269 | + __('(This message was added in version %s of Event Espresso)', 'event_espresso'), |
|
270 | + $version |
|
271 | + ); |
|
272 | + $error_message = sprintf( |
|
273 | + esc_html__('%1$s was called %2$sincorrectly%3$s. %4$s %5$s', 'event_espresso'), |
|
274 | + $function, |
|
275 | + '<strong>', |
|
276 | + '</strong>', |
|
277 | + $message, |
|
278 | + $version |
|
279 | + ); |
|
280 | + // don't trigger error if doing ajax, |
|
281 | + // instead we'll add a transient EE_Error notice that in theory should show on the next request. |
|
282 | + if (defined('DOING_AJAX') && DOING_AJAX) { |
|
283 | + $error_message .= ' ' . esc_html__( |
|
284 | + 'This is a doing_it_wrong message that was triggered during an ajax request. The request params on this request were: ', |
|
285 | + 'event_espresso' |
|
286 | + ); |
|
287 | + $error_message .= '<ul><li>'; |
|
288 | + $error_message .= implode('</li><li>', EE_Registry::instance()->REQ->params()); |
|
289 | + $error_message .= '</ul>'; |
|
290 | + EE_Error::add_error($error_message, 'debug::doing_it_wrong', $function, '42'); |
|
291 | + //now we set this on the transient so it shows up on the next request. |
|
292 | + EE_Error::get_notices(false, true); |
|
293 | + } else { |
|
294 | + trigger_error($error_message, $error_type); |
|
295 | + } |
|
296 | + } |
|
297 | + |
|
298 | + |
|
299 | + |
|
300 | + |
|
301 | + /** |
|
302 | + * Logger helpers |
|
303 | + */ |
|
304 | + /** |
|
305 | + * debug |
|
306 | + * |
|
307 | + * @param string $class |
|
308 | + * @param string $func |
|
309 | + * @param string $line |
|
310 | + * @param array $info |
|
311 | + * @param bool $display_request |
|
312 | + * @param string $debug_index |
|
313 | + * @param string $debug_key |
|
314 | + * @throws EE_Error |
|
315 | + * @throws \EventEspresso\core\exceptions\InvalidSessionDataException |
|
316 | + */ |
|
317 | + public static function log( |
|
318 | + $class = '', |
|
319 | + $func = '', |
|
320 | + $line = '', |
|
321 | + $info = array(), |
|
322 | + $display_request = false, |
|
323 | + $debug_index = '', |
|
324 | + $debug_key = 'EE_DEBUG_SPCO' |
|
325 | + ) { |
|
326 | + if (WP_DEBUG) { |
|
327 | + $debug_key = $debug_key . '_' . EE_Session::instance()->id(); |
|
328 | + $debug_data = get_option($debug_key, array()); |
|
329 | + $default_data = array( |
|
330 | + $class => $func . '() : ' . $line, |
|
331 | + 'REQ' => $display_request ? $_REQUEST : '', |
|
332 | + ); |
|
333 | + // don't serialize objects |
|
334 | + $info = self::strip_objects($info); |
|
335 | + $index = ! empty($debug_index) ? $debug_index : 0; |
|
336 | + if (! isset($debug_data[$index])) { |
|
337 | + $debug_data[$index] = array(); |
|
338 | + } |
|
339 | + $debug_data[$index][microtime()] = array_merge($default_data, $info); |
|
340 | + update_option($debug_key, $debug_data); |
|
341 | + } |
|
342 | + } |
|
343 | + |
|
344 | + |
|
345 | + |
|
346 | + /** |
|
347 | + * strip_objects |
|
348 | + * |
|
349 | + * @param array $info |
|
350 | + * @return array |
|
351 | + */ |
|
352 | + public static function strip_objects($info = array()) |
|
353 | + { |
|
354 | + foreach ($info as $key => $value) { |
|
355 | + if (is_array($value)) { |
|
356 | + $info[$key] = self::strip_objects($value); |
|
357 | + } else if (is_object($value)) { |
|
358 | + $object_class = get_class($value); |
|
359 | + $info[$object_class] = array(); |
|
360 | + $info[$object_class]['ID'] = method_exists($value, 'ID') ? $value->ID() : spl_object_hash($value); |
|
361 | + if (method_exists($value, 'ID')) { |
|
362 | + $info[$object_class]['ID'] = $value->ID(); |
|
363 | + } |
|
364 | + if (method_exists($value, 'status')) { |
|
365 | + $info[$object_class]['status'] = $value->status(); |
|
366 | + } else if (method_exists($value, 'status_ID')) { |
|
367 | + $info[$object_class]['status'] = $value->status_ID(); |
|
368 | + } |
|
369 | + unset($info[$key]); |
|
370 | + } |
|
371 | + } |
|
372 | + return (array)$info; |
|
373 | + } |
|
374 | + |
|
375 | + |
|
376 | + |
|
377 | + /** |
|
378 | + * @param mixed $var |
|
379 | + * @param string $var_name |
|
380 | + * @param string $file |
|
381 | + * @param int|string $line |
|
382 | + * @param int $heading_tag |
|
383 | + * @param bool $die |
|
384 | + * @param string $margin |
|
385 | + */ |
|
386 | + public static function printv( |
|
387 | + $var, |
|
388 | + $var_name = '', |
|
389 | + $file = '', |
|
390 | + $line = '', |
|
391 | + $heading_tag = 5, |
|
392 | + $die = false, |
|
393 | + $margin = '' |
|
394 | + ) { |
|
395 | + $var_name = ! $var_name ? 'string' : $var_name; |
|
396 | + $var_name = ucwords(str_replace('$', '', $var_name)); |
|
397 | + $is_method = method_exists($var_name, $var); |
|
398 | + $var_name = ucwords(str_replace('_', ' ', $var_name)); |
|
399 | + $heading_tag = is_int($heading_tag) ? "h{$heading_tag}" : 'h5'; |
|
400 | + $result = EEH_Debug_Tools::heading($var_name, $heading_tag, $margin); |
|
401 | + $result .= $is_method |
|
402 | + ? EEH_Debug_Tools::grey_span('::') . EEH_Debug_Tools::orange_span($var . '()') |
|
403 | + : EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span($var); |
|
404 | + $result .= EEH_Debug_Tools::file_and_line($file, $line); |
|
405 | + $result .= EEH_Debug_Tools::headingX($heading_tag); |
|
406 | + if ($die) { |
|
407 | + die($result); |
|
408 | + } |
|
409 | + echo $result; |
|
410 | + } |
|
411 | + |
|
412 | + |
|
413 | + |
|
414 | + /** |
|
415 | + * @param string $var_name |
|
416 | + * @param string $heading_tag |
|
417 | + * @param string $margin |
|
418 | + * @return string |
|
419 | + */ |
|
420 | + protected static function heading($var_name = '', $heading_tag = 'h5', $margin = '') |
|
421 | + { |
|
422 | + if (defined('EE_TESTS_DIR')) { |
|
423 | + return "\n{$var_name}"; |
|
424 | + } |
|
425 | + $margin = "25px 0 0 {$margin}"; |
|
426 | + return '<' . $heading_tag . ' style="color:#2EA2CC; margin:' . $margin . ';"><b>' . $var_name . '</b>'; |
|
427 | + } |
|
428 | + |
|
429 | + |
|
430 | + |
|
431 | + /** |
|
432 | + * @param string $heading_tag |
|
433 | + * @return string |
|
434 | + */ |
|
435 | + protected static function headingX($heading_tag = 'h5') |
|
436 | + { |
|
437 | + if (defined('EE_TESTS_DIR')) { |
|
438 | + return ''; |
|
439 | + } |
|
440 | + return '</' . $heading_tag . '>'; |
|
441 | + } |
|
442 | + |
|
443 | + |
|
444 | + |
|
445 | + /** |
|
446 | + * @param string $content |
|
447 | + * @return string |
|
448 | + */ |
|
449 | + protected static function grey_span($content = '') |
|
450 | + { |
|
451 | + if (defined('EE_TESTS_DIR')) { |
|
452 | + return $content; |
|
453 | + } |
|
454 | + return '<span style="color:#999">' . $content . '</span>'; |
|
455 | + } |
|
456 | + |
|
457 | + |
|
458 | + |
|
459 | + /** |
|
460 | + * @param string $file |
|
461 | + * @param int $line |
|
462 | + * @return string |
|
463 | + */ |
|
464 | + protected static function file_and_line($file, $line) |
|
465 | + { |
|
466 | + if ($file === '' || $line === '') { |
|
467 | + return ''; |
|
468 | + } |
|
469 | + if (defined('EE_TESTS_DIR')) { |
|
470 | + return "\n\t(" . $file . ' line no: ' . $line . ' ) '; |
|
471 | + } |
|
472 | + return '<br /><span style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;">' |
|
473 | + . $file |
|
474 | + . '<br />line no: ' |
|
475 | + . $line |
|
476 | + . '</span>'; |
|
477 | + } |
|
478 | + |
|
479 | + |
|
480 | + |
|
481 | + /** |
|
482 | + * @param string $content |
|
483 | + * @return string |
|
484 | + */ |
|
485 | + protected static function orange_span($content = '') |
|
486 | + { |
|
487 | + if (defined('EE_TESTS_DIR')) { |
|
488 | + return $content; |
|
489 | + } |
|
490 | + return '<span style="color:#E76700">' . $content . '</span>'; |
|
491 | + } |
|
492 | + |
|
493 | + |
|
494 | + |
|
495 | + /** |
|
496 | + * @param mixed $var |
|
497 | + * @return string |
|
498 | + */ |
|
499 | + protected static function pre_span($var) |
|
500 | + { |
|
501 | + ob_start(); |
|
502 | + var_dump($var); |
|
503 | + $var = ob_get_clean(); |
|
504 | + if (defined('EE_TESTS_DIR')) { |
|
505 | + return "\n" . $var; |
|
506 | + } |
|
507 | + return '<pre style="color:#999; padding:1em; background: #fff">' . $var . '</pre>'; |
|
508 | + } |
|
509 | + |
|
510 | + |
|
511 | + |
|
512 | + /** |
|
513 | + * @param mixed $var |
|
514 | + * @param string $var_name |
|
515 | + * @param string $file |
|
516 | + * @param int|string $line |
|
517 | + * @param int $heading_tag |
|
518 | + * @param bool $die |
|
519 | + */ |
|
520 | + public static function printr( |
|
521 | + $var, |
|
522 | + $var_name = '', |
|
523 | + $file = '', |
|
524 | + $line = '', |
|
525 | + $heading_tag = 5, |
|
526 | + $die = false |
|
527 | + ) { |
|
528 | + // return; |
|
529 | + $file = str_replace(rtrim(ABSPATH, '\\/'), '', $file); |
|
530 | + $margin = is_admin() ? ' 180px' : '0'; |
|
531 | + //$print_r = false; |
|
532 | + if (is_string($var)) { |
|
533 | + EEH_Debug_Tools::printv($var, $var_name, $file, $line, $heading_tag, $die, $margin); |
|
534 | + return; |
|
535 | + } |
|
536 | + if (is_object($var)) { |
|
537 | + $var_name = ! $var_name ? 'object' : $var_name; |
|
538 | + //$print_r = true; |
|
539 | + } else if (is_array($var)) { |
|
540 | + $var_name = ! $var_name ? 'array' : $var_name; |
|
541 | + //$print_r = true; |
|
542 | + } else if (is_numeric($var)) { |
|
543 | + $var_name = ! $var_name ? 'numeric' : $var_name; |
|
544 | + } else if ($var === null) { |
|
545 | + $var_name = ! $var_name ? 'null' : $var_name; |
|
546 | + } |
|
547 | + $var_name = ucwords(str_replace(array('$', '_'), array('', ' '), $var_name)); |
|
548 | + $heading_tag = is_int($heading_tag) ? "h{$heading_tag}" : 'h5'; |
|
549 | + $result = EEH_Debug_Tools::heading($var_name, $heading_tag, $margin); |
|
550 | + $result .= EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span( |
|
551 | + EEH_Debug_Tools::pre_span($var) |
|
552 | + ); |
|
553 | + $result .= EEH_Debug_Tools::file_and_line($file, $line); |
|
554 | + $result .= EEH_Debug_Tools::headingX($heading_tag); |
|
555 | + if ($die) { |
|
556 | + die($result); |
|
557 | + } |
|
558 | + echo $result; |
|
559 | + } |
|
560 | + |
|
561 | + |
|
562 | + |
|
563 | + /******************** deprecated ********************/ |
|
564 | + |
|
565 | + |
|
566 | + |
|
567 | + /** |
|
568 | + * @deprecated 4.9.39.rc.034 |
|
569 | + */ |
|
570 | + public function reset_times() |
|
571 | + { |
|
572 | + Benchmark::resetTimes(); |
|
573 | + } |
|
574 | + |
|
575 | + |
|
576 | + |
|
577 | + /** |
|
578 | + * @deprecated 4.9.39.rc.034 |
|
579 | + * @param null $timer_name |
|
580 | + */ |
|
581 | + public function start_timer($timer_name = null) |
|
582 | + { |
|
583 | + Benchmark::startTimer($timer_name); |
|
584 | + } |
|
585 | + |
|
586 | + |
|
587 | + |
|
588 | + /** |
|
589 | + * @deprecated 4.9.39.rc.034 |
|
590 | + * @param string $timer_name |
|
591 | + */ |
|
592 | + public function stop_timer($timer_name = '') |
|
593 | + { |
|
594 | + Benchmark::stopTimer($timer_name); |
|
595 | + } |
|
596 | + |
|
597 | + |
|
598 | + |
|
599 | + /** |
|
600 | + * @deprecated 4.9.39.rc.034 |
|
601 | + * @param string $label The label to show for this time eg "Start of calling Some_Class::some_function" |
|
602 | + * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called |
|
603 | + * @return void |
|
604 | + */ |
|
605 | + public function measure_memory($label, $output_now = false) |
|
606 | + { |
|
607 | + Benchmark::measureMemory($label, $output_now); |
|
608 | + } |
|
609 | + |
|
610 | + |
|
611 | + |
|
612 | + /** |
|
613 | + * @deprecated 4.9.39.rc.034 |
|
614 | + * @param int $size |
|
615 | + * @return string |
|
616 | + */ |
|
617 | + public function convert($size) |
|
618 | + { |
|
619 | + return Benchmark::convert($size); |
|
620 | + } |
|
621 | + |
|
622 | + |
|
623 | + |
|
624 | + /** |
|
625 | + * @deprecated 4.9.39.rc.034 |
|
626 | + * @param bool $output_now |
|
627 | + * @return string |
|
628 | + */ |
|
629 | + public function show_times($output_now = true) |
|
630 | + { |
|
631 | + return Benchmark::displayResults($output_now); |
|
632 | + } |
|
633 | + |
|
634 | + |
|
635 | + |
|
636 | + /** |
|
637 | + * @deprecated 4.9.39.rc.034 |
|
638 | + * @param string $timer_name |
|
639 | + * @param float $total_time |
|
640 | + * @return string |
|
641 | + */ |
|
642 | + public function format_time($timer_name, $total_time) |
|
643 | + { |
|
644 | + return Benchmark::formatTime($timer_name, $total_time); |
|
645 | + } |
|
646 | 646 | |
647 | 647 | |
648 | 648 | |
@@ -655,31 +655,31 @@ discard block |
||
655 | 655 | * Plugin URI: http://upthemes.com/plugins/kint-debugger/ |
656 | 656 | */ |
657 | 657 | if (class_exists('Kint') && ! function_exists('dump_wp_query')) { |
658 | - function dump_wp_query() |
|
659 | - { |
|
660 | - global $wp_query; |
|
661 | - d($wp_query); |
|
662 | - } |
|
658 | + function dump_wp_query() |
|
659 | + { |
|
660 | + global $wp_query; |
|
661 | + d($wp_query); |
|
662 | + } |
|
663 | 663 | } |
664 | 664 | /** |
665 | 665 | * borrowed from Kint Debugger |
666 | 666 | * Plugin URI: http://upthemes.com/plugins/kint-debugger/ |
667 | 667 | */ |
668 | 668 | if (class_exists('Kint') && ! function_exists('dump_wp')) { |
669 | - function dump_wp() |
|
670 | - { |
|
671 | - global $wp; |
|
672 | - d($wp); |
|
673 | - } |
|
669 | + function dump_wp() |
|
670 | + { |
|
671 | + global $wp; |
|
672 | + d($wp); |
|
673 | + } |
|
674 | 674 | } |
675 | 675 | /** |
676 | 676 | * borrowed from Kint Debugger |
677 | 677 | * Plugin URI: http://upthemes.com/plugins/kint-debugger/ |
678 | 678 | */ |
679 | 679 | if (class_exists('Kint') && ! function_exists('dump_post')) { |
680 | - function dump_post() |
|
681 | - { |
|
682 | - global $post; |
|
683 | - d($post); |
|
684 | - } |
|
680 | + function dump_post() |
|
681 | + { |
|
682 | + global $post; |
|
683 | + d($post); |
|
684 | + } |
|
685 | 685 | } |
@@ -1,6 +1,6 @@ discard block |
||
1 | 1 | <?php use EventEspresso\core\services\Benchmark; |
2 | 2 | |
3 | -if (! defined('EVENT_ESPRESSO_VERSION')) { |
|
3 | +if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
4 | 4 | exit('No direct script access allowed'); |
5 | 5 | } |
6 | 6 | |
@@ -40,7 +40,7 @@ discard block |
||
40 | 40 | public static function instance() |
41 | 41 | { |
42 | 42 | // check if class object is instantiated, and instantiated properly |
43 | - if (! self::$_instance instanceof EEH_Debug_Tools) { |
|
43 | + if ( ! self::$_instance instanceof EEH_Debug_Tools) { |
|
44 | 44 | self::$_instance = new self(); |
45 | 45 | } |
46 | 46 | return self::$_instance; |
@@ -54,13 +54,13 @@ discard block |
||
54 | 54 | private function __construct() |
55 | 55 | { |
56 | 56 | // load Kint PHP debugging library |
57 | - if (! class_exists('Kint') && file_exists(EE_PLUGIN_DIR_PATH . 'tests' . DS . 'kint' . DS . 'Kint.class.php')) { |
|
57 | + if ( ! class_exists('Kint') && file_exists(EE_PLUGIN_DIR_PATH.'tests'.DS.'kint'.DS.'Kint.class.php')) { |
|
58 | 58 | // despite EE4 having a check for an existing copy of the Kint debugging class, |
59 | 59 | // if another plugin was loaded AFTER EE4 and they did NOT perform a similar check, |
60 | 60 | // then hilarity would ensue as PHP throws a "Cannot redeclare class Kint" error |
61 | 61 | // so we've moved it to our test folder so that it is not included with production releases |
62 | 62 | // plz use https://wordpress.org/plugins/kint-debugger/ if testing production versions of EE |
63 | - require_once(EE_PLUGIN_DIR_PATH . 'tests' . DS . 'kint' . DS . 'Kint.class.php'); |
|
63 | + require_once(EE_PLUGIN_DIR_PATH.'tests'.DS.'kint'.DS.'Kint.class.php'); |
|
64 | 64 | } |
65 | 65 | // if ( ! defined('DOING_AJAX') || $_REQUEST['noheader'] !== 'true' || ! isset( $_REQUEST['noheader'], $_REQUEST['TB_iframe'] ) ) { |
66 | 66 | //add_action( 'shutdown', array($this,'espresso_session_footer_dump') ); |
@@ -80,7 +80,7 @@ discard block |
||
80 | 80 | */ |
81 | 81 | public static function show_db_name() |
82 | 82 | { |
83 | - if (! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) { |
|
83 | + if ( ! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) { |
|
84 | 84 | echo '<p style="font-size:10px;font-weight:normal;color:#E76700;margin: 1em 2em; text-align: right;">DB_NAME: ' |
85 | 85 | . DB_NAME |
86 | 86 | . '</p>'; |
@@ -131,11 +131,11 @@ discard block |
||
131 | 131 | echo '<br/><br/><br/><h3>Hooked Functions</h3>'; |
132 | 132 | if ($tag) { |
133 | 133 | $hook[$tag] = $wp_filter[$tag]; |
134 | - if (! is_array($hook[$tag])) { |
|
134 | + if ( ! is_array($hook[$tag])) { |
|
135 | 135 | trigger_error("Nothing found for '$tag' hook", E_USER_WARNING); |
136 | 136 | return; |
137 | 137 | } |
138 | - echo '<h5>For Tag: ' . $tag . '</h5>'; |
|
138 | + echo '<h5>For Tag: '.$tag.'</h5>'; |
|
139 | 139 | } else { |
140 | 140 | $hook = is_array($wp_filter) ? $wp_filter : array($wp_filter); |
141 | 141 | ksort($hook); |
@@ -188,17 +188,17 @@ discard block |
||
188 | 188 | { |
189 | 189 | if (WP_DEBUG) { |
190 | 190 | $activation_errors = ob_get_contents(); |
191 | - if (! empty($activation_errors)) { |
|
192 | - $activation_errors = date('Y-m-d H:i:s') . "\n" . $activation_errors; |
|
191 | + if ( ! empty($activation_errors)) { |
|
192 | + $activation_errors = date('Y-m-d H:i:s')."\n".$activation_errors; |
|
193 | 193 | } |
194 | - espresso_load_required('EEH_File', EE_HELPERS . 'EEH_File.helper.php'); |
|
194 | + espresso_load_required('EEH_File', EE_HELPERS.'EEH_File.helper.php'); |
|
195 | 195 | if (class_exists('EEH_File')) { |
196 | 196 | try { |
197 | 197 | EEH_File::ensure_file_exists_and_is_writable( |
198 | - EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html' |
|
198 | + EVENT_ESPRESSO_UPLOAD_DIR.'logs'.DS.'espresso_plugin_activation_errors.html' |
|
199 | 199 | ); |
200 | 200 | EEH_File::write_to_file( |
201 | - EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html', |
|
201 | + EVENT_ESPRESSO_UPLOAD_DIR.'logs'.DS.'espresso_plugin_activation_errors.html', |
|
202 | 202 | $activation_errors |
203 | 203 | ); |
204 | 204 | } catch (EE_Error $e) { |
@@ -216,11 +216,11 @@ discard block |
||
216 | 216 | } else { |
217 | 217 | // old school attempt |
218 | 218 | file_put_contents( |
219 | - EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html', |
|
219 | + EVENT_ESPRESSO_UPLOAD_DIR.'logs'.DS.'espresso_plugin_activation_errors.html', |
|
220 | 220 | $activation_errors |
221 | 221 | ); |
222 | 222 | } |
223 | - $activation_errors = get_option('ee_plugin_activation_errors', '') . $activation_errors; |
|
223 | + $activation_errors = get_option('ee_plugin_activation_errors', '').$activation_errors; |
|
224 | 224 | update_option('ee_plugin_activation_errors', $activation_errors); |
225 | 225 | } |
226 | 226 | } |
@@ -280,7 +280,7 @@ discard block |
||
280 | 280 | // don't trigger error if doing ajax, |
281 | 281 | // instead we'll add a transient EE_Error notice that in theory should show on the next request. |
282 | 282 | if (defined('DOING_AJAX') && DOING_AJAX) { |
283 | - $error_message .= ' ' . esc_html__( |
|
283 | + $error_message .= ' '.esc_html__( |
|
284 | 284 | 'This is a doing_it_wrong message that was triggered during an ajax request. The request params on this request were: ', |
285 | 285 | 'event_espresso' |
286 | 286 | ); |
@@ -324,16 +324,16 @@ discard block |
||
324 | 324 | $debug_key = 'EE_DEBUG_SPCO' |
325 | 325 | ) { |
326 | 326 | if (WP_DEBUG) { |
327 | - $debug_key = $debug_key . '_' . EE_Session::instance()->id(); |
|
327 | + $debug_key = $debug_key.'_'.EE_Session::instance()->id(); |
|
328 | 328 | $debug_data = get_option($debug_key, array()); |
329 | 329 | $default_data = array( |
330 | - $class => $func . '() : ' . $line, |
|
330 | + $class => $func.'() : '.$line, |
|
331 | 331 | 'REQ' => $display_request ? $_REQUEST : '', |
332 | 332 | ); |
333 | 333 | // don't serialize objects |
334 | 334 | $info = self::strip_objects($info); |
335 | 335 | $index = ! empty($debug_index) ? $debug_index : 0; |
336 | - if (! isset($debug_data[$index])) { |
|
336 | + if ( ! isset($debug_data[$index])) { |
|
337 | 337 | $debug_data[$index] = array(); |
338 | 338 | } |
339 | 339 | $debug_data[$index][microtime()] = array_merge($default_data, $info); |
@@ -369,7 +369,7 @@ discard block |
||
369 | 369 | unset($info[$key]); |
370 | 370 | } |
371 | 371 | } |
372 | - return (array)$info; |
|
372 | + return (array) $info; |
|
373 | 373 | } |
374 | 374 | |
375 | 375 | |
@@ -399,8 +399,8 @@ discard block |
||
399 | 399 | $heading_tag = is_int($heading_tag) ? "h{$heading_tag}" : 'h5'; |
400 | 400 | $result = EEH_Debug_Tools::heading($var_name, $heading_tag, $margin); |
401 | 401 | $result .= $is_method |
402 | - ? EEH_Debug_Tools::grey_span('::') . EEH_Debug_Tools::orange_span($var . '()') |
|
403 | - : EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span($var); |
|
402 | + ? EEH_Debug_Tools::grey_span('::').EEH_Debug_Tools::orange_span($var.'()') |
|
403 | + : EEH_Debug_Tools::grey_span(' : ').EEH_Debug_Tools::orange_span($var); |
|
404 | 404 | $result .= EEH_Debug_Tools::file_and_line($file, $line); |
405 | 405 | $result .= EEH_Debug_Tools::headingX($heading_tag); |
406 | 406 | if ($die) { |
@@ -423,7 +423,7 @@ discard block |
||
423 | 423 | return "\n{$var_name}"; |
424 | 424 | } |
425 | 425 | $margin = "25px 0 0 {$margin}"; |
426 | - return '<' . $heading_tag . ' style="color:#2EA2CC; margin:' . $margin . ';"><b>' . $var_name . '</b>'; |
|
426 | + return '<'.$heading_tag.' style="color:#2EA2CC; margin:'.$margin.';"><b>'.$var_name.'</b>'; |
|
427 | 427 | } |
428 | 428 | |
429 | 429 | |
@@ -437,7 +437,7 @@ discard block |
||
437 | 437 | if (defined('EE_TESTS_DIR')) { |
438 | 438 | return ''; |
439 | 439 | } |
440 | - return '</' . $heading_tag . '>'; |
|
440 | + return '</'.$heading_tag.'>'; |
|
441 | 441 | } |
442 | 442 | |
443 | 443 | |
@@ -451,7 +451,7 @@ discard block |
||
451 | 451 | if (defined('EE_TESTS_DIR')) { |
452 | 452 | return $content; |
453 | 453 | } |
454 | - return '<span style="color:#999">' . $content . '</span>'; |
|
454 | + return '<span style="color:#999">'.$content.'</span>'; |
|
455 | 455 | } |
456 | 456 | |
457 | 457 | |
@@ -467,7 +467,7 @@ discard block |
||
467 | 467 | return ''; |
468 | 468 | } |
469 | 469 | if (defined('EE_TESTS_DIR')) { |
470 | - return "\n\t(" . $file . ' line no: ' . $line . ' ) '; |
|
470 | + return "\n\t(".$file.' line no: '.$line.' ) '; |
|
471 | 471 | } |
472 | 472 | return '<br /><span style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;">' |
473 | 473 | . $file |
@@ -487,7 +487,7 @@ discard block |
||
487 | 487 | if (defined('EE_TESTS_DIR')) { |
488 | 488 | return $content; |
489 | 489 | } |
490 | - return '<span style="color:#E76700">' . $content . '</span>'; |
|
490 | + return '<span style="color:#E76700">'.$content.'</span>'; |
|
491 | 491 | } |
492 | 492 | |
493 | 493 | |
@@ -502,9 +502,9 @@ discard block |
||
502 | 502 | var_dump($var); |
503 | 503 | $var = ob_get_clean(); |
504 | 504 | if (defined('EE_TESTS_DIR')) { |
505 | - return "\n" . $var; |
|
505 | + return "\n".$var; |
|
506 | 506 | } |
507 | - return '<pre style="color:#999; padding:1em; background: #fff">' . $var . '</pre>'; |
|
507 | + return '<pre style="color:#999; padding:1em; background: #fff">'.$var.'</pre>'; |
|
508 | 508 | } |
509 | 509 | |
510 | 510 | |
@@ -547,7 +547,7 @@ discard block |
||
547 | 547 | $var_name = ucwords(str_replace(array('$', '_'), array('', ' '), $var_name)); |
548 | 548 | $heading_tag = is_int($heading_tag) ? "h{$heading_tag}" : 'h5'; |
549 | 549 | $result = EEH_Debug_Tools::heading($var_name, $heading_tag, $margin); |
550 | - $result .= EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span( |
|
550 | + $result .= EEH_Debug_Tools::grey_span(' : ').EEH_Debug_Tools::orange_span( |
|
551 | 551 | EEH_Debug_Tools::pre_span($var) |
552 | 552 | ); |
553 | 553 | $result .= EEH_Debug_Tools::file_and_line($file, $line); |
@@ -17,303 +17,303 @@ |
||
17 | 17 | class Benchmark |
18 | 18 | { |
19 | 19 | |
20 | - /** |
|
21 | - * array containing the start time for the timers |
|
22 | - */ |
|
23 | - private static $start_times; |
|
24 | - |
|
25 | - /** |
|
26 | - * array containing all the timer'd times, which can be outputted via show_times() |
|
27 | - */ |
|
28 | - private static $times = array(); |
|
29 | - |
|
30 | - /** |
|
31 | - * @var array |
|
32 | - */ |
|
33 | - protected static $memory_usage = array(); |
|
34 | - |
|
35 | - |
|
36 | - |
|
37 | - /** |
|
38 | - * whether to benchmark code or not |
|
39 | - */ |
|
40 | - public static function doNotRun() |
|
41 | - { |
|
42 | - return ! WP_DEBUG || (defined('DOING_AJAX') && DOING_AJAX); |
|
43 | - } |
|
44 | - |
|
45 | - |
|
46 | - |
|
47 | - /** |
|
48 | - * resetTimes |
|
49 | - */ |
|
50 | - public static function resetTimes() |
|
51 | - { |
|
52 | - Benchmark::$times = array(); |
|
53 | - } |
|
54 | - |
|
55 | - |
|
56 | - |
|
57 | - /** |
|
58 | - * Add Benchmark::startTimer() before a block of code you want to measure the performance of |
|
59 | - * |
|
60 | - * @param null $timer_name |
|
61 | - */ |
|
62 | - public static function startTimer($timer_name = null) |
|
63 | - { |
|
64 | - if (Benchmark::doNotRun()) { |
|
65 | - return; |
|
66 | - } |
|
67 | - $timer_name = $timer_name !== '' ? $timer_name : get_called_class(); |
|
68 | - Benchmark::$start_times[$timer_name] = microtime(true); |
|
69 | - } |
|
70 | - |
|
71 | - |
|
72 | - |
|
73 | - /** |
|
74 | - * Add Benchmark::stopTimer() after a block of code you want to measure the performance of |
|
75 | - * |
|
76 | - * @param string $timer_name |
|
77 | - */ |
|
78 | - public static function stopTimer($timer_name = '') |
|
79 | - { |
|
80 | - if (Benchmark::doNotRun()) { |
|
81 | - return; |
|
82 | - } |
|
83 | - $timer_name = $timer_name !== '' ? $timer_name : get_called_class(); |
|
84 | - if (isset(Benchmark::$start_times[$timer_name])) { |
|
85 | - $start_time = Benchmark::$start_times[$timer_name]; |
|
86 | - unset(Benchmark::$start_times[$timer_name]); |
|
87 | - } else { |
|
88 | - $start_time = array_pop(Benchmark::$start_times); |
|
89 | - } |
|
90 | - Benchmark::$times[$timer_name] = number_format(microtime(true) - $start_time, 8); |
|
91 | - } |
|
92 | - |
|
93 | - |
|
94 | - |
|
95 | - /** |
|
96 | - * Measure the memory usage by PHP so far. |
|
97 | - * |
|
98 | - * @param string $label The label to show for this time eg "Start of calling Some_Class::some_function" |
|
99 | - * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called |
|
100 | - * @param bool $formatted |
|
101 | - * @return void |
|
102 | - */ |
|
103 | - public static function measureMemory($label = 'memory usage', $output_now = false, $formatted = true) |
|
104 | - { |
|
105 | - if (Benchmark::doNotRun()) { |
|
106 | - return; |
|
107 | - } |
|
108 | - $memory_used = Benchmark::convert(memory_get_usage(true)); |
|
109 | - Benchmark::$memory_usage[$label] = $memory_used; |
|
110 | - if ($output_now) { |
|
111 | - echo $formatted |
|
112 | - ? "<br>{$label} : {$memory_used}" |
|
113 | - : "\n {$label} : {$memory_used}"; |
|
114 | - } |
|
115 | - } |
|
116 | - |
|
117 | - |
|
118 | - |
|
119 | - /** |
|
120 | - * will display the benchmarking results at shutdown |
|
121 | - * |
|
122 | - * @param bool $formatted |
|
123 | - * @return void |
|
124 | - */ |
|
125 | - public static function displayResultsAtShutdown($formatted = true) |
|
126 | - { |
|
127 | - add_action( |
|
128 | - 'shutdown', |
|
129 | - function () use ($formatted) { |
|
130 | - Benchmark::displayResults(true, $formatted); |
|
131 | - } |
|
132 | - ); |
|
133 | - } |
|
134 | - |
|
135 | - |
|
136 | - |
|
137 | - /** |
|
138 | - * will display the benchmarking results at shutdown |
|
139 | - * |
|
140 | - * @param string $filepath |
|
141 | - * @param bool $formatted |
|
142 | - * @param bool $append |
|
143 | - * @return void |
|
144 | - */ |
|
145 | - public static function writeResultsAtShutdown($filepath = '', $formatted = true, $append = true) |
|
146 | - { |
|
147 | - add_action( |
|
148 | - 'shutdown', |
|
149 | - function () use ($filepath, $formatted, $append) { |
|
150 | - Benchmark::writeResultsToFile($filepath, $formatted, $append); |
|
151 | - } |
|
152 | - ); |
|
153 | - } |
|
154 | - |
|
155 | - |
|
156 | - |
|
157 | - /** |
|
158 | - * @param bool $formatted |
|
159 | - * @return string |
|
160 | - */ |
|
161 | - private static function generateResults($formatted = true) |
|
162 | - { |
|
163 | - if (Benchmark::doNotRun()) { |
|
164 | - return ''; |
|
165 | - } |
|
166 | - $output = ''; |
|
167 | - if (! empty(Benchmark::$times)) { |
|
168 | - $total = 0; |
|
169 | - $output .= $formatted |
|
170 | - ? '<span style="color:#999999; font-size:.8em;">( time in milliseconds )</span><br />' |
|
171 | - : ''; |
|
172 | - foreach (Benchmark::$times as $timer_name => $total_time) { |
|
173 | - $output .= Benchmark::formatTime($timer_name, $total_time, $formatted); |
|
174 | - $output .= $formatted ? '<br />' : "\n"; |
|
175 | - $total += $total_time; |
|
176 | - } |
|
177 | - if($formatted) { |
|
178 | - $output .= '<br />'; |
|
179 | - $output .= '<h4>TOTAL TIME</h4>'; |
|
180 | - $output .= Benchmark::formatTime('', $total, $formatted); |
|
181 | - $output .= '<span style="color:#999999; font-size:.8em;"> milliseconds</span><br />'; |
|
182 | - $output .= '<br />'; |
|
183 | - $output .= '<h5>Performance scale (from best to worse)</h5>'; |
|
184 | - $output .= '<span style="color:mediumpurple">Like wow! How about a Scooby snack?</span><br />'; |
|
185 | - $output .= '<span style="color:deepskyblue">Like...no way man!</span><br />'; |
|
186 | - $output .= '<span style="color:limegreen">Like...groovy!</span><br />'; |
|
187 | - $output .= '<span style="color:gold">Ruh Oh</span><br />'; |
|
188 | - $output .= '<span style="color:darkorange">Zoinks!</span><br />'; |
|
189 | - $output .= '<span style="color:red">Like...HEEELLLP</span><br />'; |
|
190 | - } |
|
191 | - } |
|
192 | - if (! empty(Benchmark::$memory_usage)) { |
|
193 | - $output .= $formatted |
|
194 | - ? '<h5>Memory</h5>' . implode('<br />', Benchmark::$memory_usage) |
|
195 | - : implode("\n", Benchmark::$memory_usage); |
|
196 | - } |
|
197 | - if (empty($output)) { |
|
198 | - return ''; |
|
199 | - } |
|
200 | - $output = $formatted |
|
201 | - ? '<div style="border:1px solid #dddddd; background-color:#ffffff;' |
|
202 | - . (is_admin() |
|
203 | - ? ' margin:2em 2em 2em 180px;' |
|
204 | - : ' margin:2em;') |
|
205 | - . ' padding:2em;">' |
|
206 | - . '<h4>BENCHMARKING</h4>' |
|
207 | - . $output |
|
208 | - . '</div>' |
|
209 | - : $output; |
|
210 | - return $output; |
|
211 | - } |
|
212 | - |
|
213 | - |
|
214 | - |
|
215 | - /** |
|
216 | - * @param bool $echo |
|
217 | - * @param bool $formatted |
|
218 | - * @return string |
|
219 | - */ |
|
220 | - public static function displayResults($echo = true, $formatted = true) |
|
221 | - { |
|
222 | - $results = Benchmark::generateResults($formatted); |
|
223 | - if ($echo) { |
|
224 | - echo $results; |
|
225 | - $results = ''; |
|
226 | - } |
|
227 | - return $results; |
|
228 | - } |
|
229 | - |
|
230 | - |
|
231 | - |
|
232 | - /** |
|
233 | - * @param string $filepath |
|
234 | - * @param bool $formatted |
|
235 | - * @param bool $append |
|
236 | - */ |
|
237 | - public static function writeResultsToFile($filepath = '', $formatted = true, $append = true) |
|
238 | - { |
|
239 | - $filepath = ! empty($filepath) && is_readable(dirname($filepath)) |
|
240 | - ? $filepath |
|
241 | - : ''; |
|
242 | - if( empty($filepath)) { |
|
243 | - $filepath = EVENT_ESPRESSO_UPLOAD_DIR . 'logs/benchmarking-' . date('Y-m-d') . '.html'; |
|
244 | - } |
|
245 | - file_put_contents( |
|
246 | - $filepath, |
|
247 | - "\n" . date('Y-m-d H:i:s') . Benchmark::generateResults($formatted), |
|
248 | - $append ? FILE_APPEND | LOCK_EX : LOCK_EX |
|
249 | - ); |
|
250 | - } |
|
251 | - |
|
252 | - |
|
253 | - |
|
254 | - /** |
|
255 | - * Converts a measure of memory bytes into the most logical units (eg kb, mb, etc) |
|
256 | - * |
|
257 | - * @param int $size |
|
258 | - * @return string |
|
259 | - */ |
|
260 | - public static function convert($size) |
|
261 | - { |
|
262 | - $unit = array('b', 'kb', 'mb', 'gb', 'tb', 'pb'); |
|
263 | - return round( |
|
264 | - $size / pow(1024, $i = floor(log($size, 1024))), |
|
265 | - 2 |
|
266 | - ) . ' ' . $unit[absint($i)]; |
|
267 | - } |
|
268 | - |
|
269 | - |
|
270 | - |
|
271 | - /** |
|
272 | - * @param string $timer_name |
|
273 | - * @param float $total_time |
|
274 | - * @param bool $formatted |
|
275 | - * @return string |
|
276 | - */ |
|
277 | - public static function formatTime($timer_name, $total_time, $formatted = true) |
|
278 | - { |
|
279 | - $total_time *= 1000; |
|
280 | - switch ($total_time) { |
|
281 | - case $total_time > 12500 : |
|
282 | - $color = 'red'; |
|
283 | - $bold = 'bold'; |
|
284 | - break; |
|
285 | - case $total_time > 2500 : |
|
286 | - $color = 'darkorange'; |
|
287 | - $bold = 'bold'; |
|
288 | - break; |
|
289 | - case $total_time > 500 : |
|
290 | - $color = 'gold'; |
|
291 | - $bold = 'bold'; |
|
292 | - break; |
|
293 | - case $total_time > 100 : |
|
294 | - $color = 'limegreen'; |
|
295 | - $bold = 'normal'; |
|
296 | - break; |
|
297 | - case $total_time > 20 : |
|
298 | - $color = 'deepskyblue'; |
|
299 | - $bold = 'normal'; |
|
300 | - break; |
|
301 | - default : |
|
302 | - $color = 'mediumpurple'; |
|
303 | - $bold = 'normal'; |
|
304 | - break; |
|
305 | - } |
|
306 | - return $formatted |
|
307 | - ? '<span style="min-width: 10px; margin:0 1em; color:' |
|
308 | - . $color |
|
309 | - . '; font-weight:' |
|
310 | - . $bold |
|
311 | - . '; font-size:1.2em;">' |
|
312 | - . str_pad(number_format($total_time, 3), 9, '0', STR_PAD_LEFT) |
|
313 | - . '</span> ' |
|
314 | - . $timer_name |
|
315 | - : str_pad(number_format($total_time, 3), 9, '0', STR_PAD_LEFT); |
|
316 | - } |
|
20 | + /** |
|
21 | + * array containing the start time for the timers |
|
22 | + */ |
|
23 | + private static $start_times; |
|
24 | + |
|
25 | + /** |
|
26 | + * array containing all the timer'd times, which can be outputted via show_times() |
|
27 | + */ |
|
28 | + private static $times = array(); |
|
29 | + |
|
30 | + /** |
|
31 | + * @var array |
|
32 | + */ |
|
33 | + protected static $memory_usage = array(); |
|
34 | + |
|
35 | + |
|
36 | + |
|
37 | + /** |
|
38 | + * whether to benchmark code or not |
|
39 | + */ |
|
40 | + public static function doNotRun() |
|
41 | + { |
|
42 | + return ! WP_DEBUG || (defined('DOING_AJAX') && DOING_AJAX); |
|
43 | + } |
|
44 | + |
|
45 | + |
|
46 | + |
|
47 | + /** |
|
48 | + * resetTimes |
|
49 | + */ |
|
50 | + public static function resetTimes() |
|
51 | + { |
|
52 | + Benchmark::$times = array(); |
|
53 | + } |
|
54 | + |
|
55 | + |
|
56 | + |
|
57 | + /** |
|
58 | + * Add Benchmark::startTimer() before a block of code you want to measure the performance of |
|
59 | + * |
|
60 | + * @param null $timer_name |
|
61 | + */ |
|
62 | + public static function startTimer($timer_name = null) |
|
63 | + { |
|
64 | + if (Benchmark::doNotRun()) { |
|
65 | + return; |
|
66 | + } |
|
67 | + $timer_name = $timer_name !== '' ? $timer_name : get_called_class(); |
|
68 | + Benchmark::$start_times[$timer_name] = microtime(true); |
|
69 | + } |
|
70 | + |
|
71 | + |
|
72 | + |
|
73 | + /** |
|
74 | + * Add Benchmark::stopTimer() after a block of code you want to measure the performance of |
|
75 | + * |
|
76 | + * @param string $timer_name |
|
77 | + */ |
|
78 | + public static function stopTimer($timer_name = '') |
|
79 | + { |
|
80 | + if (Benchmark::doNotRun()) { |
|
81 | + return; |
|
82 | + } |
|
83 | + $timer_name = $timer_name !== '' ? $timer_name : get_called_class(); |
|
84 | + if (isset(Benchmark::$start_times[$timer_name])) { |
|
85 | + $start_time = Benchmark::$start_times[$timer_name]; |
|
86 | + unset(Benchmark::$start_times[$timer_name]); |
|
87 | + } else { |
|
88 | + $start_time = array_pop(Benchmark::$start_times); |
|
89 | + } |
|
90 | + Benchmark::$times[$timer_name] = number_format(microtime(true) - $start_time, 8); |
|
91 | + } |
|
92 | + |
|
93 | + |
|
94 | + |
|
95 | + /** |
|
96 | + * Measure the memory usage by PHP so far. |
|
97 | + * |
|
98 | + * @param string $label The label to show for this time eg "Start of calling Some_Class::some_function" |
|
99 | + * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called |
|
100 | + * @param bool $formatted |
|
101 | + * @return void |
|
102 | + */ |
|
103 | + public static function measureMemory($label = 'memory usage', $output_now = false, $formatted = true) |
|
104 | + { |
|
105 | + if (Benchmark::doNotRun()) { |
|
106 | + return; |
|
107 | + } |
|
108 | + $memory_used = Benchmark::convert(memory_get_usage(true)); |
|
109 | + Benchmark::$memory_usage[$label] = $memory_used; |
|
110 | + if ($output_now) { |
|
111 | + echo $formatted |
|
112 | + ? "<br>{$label} : {$memory_used}" |
|
113 | + : "\n {$label} : {$memory_used}"; |
|
114 | + } |
|
115 | + } |
|
116 | + |
|
117 | + |
|
118 | + |
|
119 | + /** |
|
120 | + * will display the benchmarking results at shutdown |
|
121 | + * |
|
122 | + * @param bool $formatted |
|
123 | + * @return void |
|
124 | + */ |
|
125 | + public static function displayResultsAtShutdown($formatted = true) |
|
126 | + { |
|
127 | + add_action( |
|
128 | + 'shutdown', |
|
129 | + function () use ($formatted) { |
|
130 | + Benchmark::displayResults(true, $formatted); |
|
131 | + } |
|
132 | + ); |
|
133 | + } |
|
134 | + |
|
135 | + |
|
136 | + |
|
137 | + /** |
|
138 | + * will display the benchmarking results at shutdown |
|
139 | + * |
|
140 | + * @param string $filepath |
|
141 | + * @param bool $formatted |
|
142 | + * @param bool $append |
|
143 | + * @return void |
|
144 | + */ |
|
145 | + public static function writeResultsAtShutdown($filepath = '', $formatted = true, $append = true) |
|
146 | + { |
|
147 | + add_action( |
|
148 | + 'shutdown', |
|
149 | + function () use ($filepath, $formatted, $append) { |
|
150 | + Benchmark::writeResultsToFile($filepath, $formatted, $append); |
|
151 | + } |
|
152 | + ); |
|
153 | + } |
|
154 | + |
|
155 | + |
|
156 | + |
|
157 | + /** |
|
158 | + * @param bool $formatted |
|
159 | + * @return string |
|
160 | + */ |
|
161 | + private static function generateResults($formatted = true) |
|
162 | + { |
|
163 | + if (Benchmark::doNotRun()) { |
|
164 | + return ''; |
|
165 | + } |
|
166 | + $output = ''; |
|
167 | + if (! empty(Benchmark::$times)) { |
|
168 | + $total = 0; |
|
169 | + $output .= $formatted |
|
170 | + ? '<span style="color:#999999; font-size:.8em;">( time in milliseconds )</span><br />' |
|
171 | + : ''; |
|
172 | + foreach (Benchmark::$times as $timer_name => $total_time) { |
|
173 | + $output .= Benchmark::formatTime($timer_name, $total_time, $formatted); |
|
174 | + $output .= $formatted ? '<br />' : "\n"; |
|
175 | + $total += $total_time; |
|
176 | + } |
|
177 | + if($formatted) { |
|
178 | + $output .= '<br />'; |
|
179 | + $output .= '<h4>TOTAL TIME</h4>'; |
|
180 | + $output .= Benchmark::formatTime('', $total, $formatted); |
|
181 | + $output .= '<span style="color:#999999; font-size:.8em;"> milliseconds</span><br />'; |
|
182 | + $output .= '<br />'; |
|
183 | + $output .= '<h5>Performance scale (from best to worse)</h5>'; |
|
184 | + $output .= '<span style="color:mediumpurple">Like wow! How about a Scooby snack?</span><br />'; |
|
185 | + $output .= '<span style="color:deepskyblue">Like...no way man!</span><br />'; |
|
186 | + $output .= '<span style="color:limegreen">Like...groovy!</span><br />'; |
|
187 | + $output .= '<span style="color:gold">Ruh Oh</span><br />'; |
|
188 | + $output .= '<span style="color:darkorange">Zoinks!</span><br />'; |
|
189 | + $output .= '<span style="color:red">Like...HEEELLLP</span><br />'; |
|
190 | + } |
|
191 | + } |
|
192 | + if (! empty(Benchmark::$memory_usage)) { |
|
193 | + $output .= $formatted |
|
194 | + ? '<h5>Memory</h5>' . implode('<br />', Benchmark::$memory_usage) |
|
195 | + : implode("\n", Benchmark::$memory_usage); |
|
196 | + } |
|
197 | + if (empty($output)) { |
|
198 | + return ''; |
|
199 | + } |
|
200 | + $output = $formatted |
|
201 | + ? '<div style="border:1px solid #dddddd; background-color:#ffffff;' |
|
202 | + . (is_admin() |
|
203 | + ? ' margin:2em 2em 2em 180px;' |
|
204 | + : ' margin:2em;') |
|
205 | + . ' padding:2em;">' |
|
206 | + . '<h4>BENCHMARKING</h4>' |
|
207 | + . $output |
|
208 | + . '</div>' |
|
209 | + : $output; |
|
210 | + return $output; |
|
211 | + } |
|
212 | + |
|
213 | + |
|
214 | + |
|
215 | + /** |
|
216 | + * @param bool $echo |
|
217 | + * @param bool $formatted |
|
218 | + * @return string |
|
219 | + */ |
|
220 | + public static function displayResults($echo = true, $formatted = true) |
|
221 | + { |
|
222 | + $results = Benchmark::generateResults($formatted); |
|
223 | + if ($echo) { |
|
224 | + echo $results; |
|
225 | + $results = ''; |
|
226 | + } |
|
227 | + return $results; |
|
228 | + } |
|
229 | + |
|
230 | + |
|
231 | + |
|
232 | + /** |
|
233 | + * @param string $filepath |
|
234 | + * @param bool $formatted |
|
235 | + * @param bool $append |
|
236 | + */ |
|
237 | + public static function writeResultsToFile($filepath = '', $formatted = true, $append = true) |
|
238 | + { |
|
239 | + $filepath = ! empty($filepath) && is_readable(dirname($filepath)) |
|
240 | + ? $filepath |
|
241 | + : ''; |
|
242 | + if( empty($filepath)) { |
|
243 | + $filepath = EVENT_ESPRESSO_UPLOAD_DIR . 'logs/benchmarking-' . date('Y-m-d') . '.html'; |
|
244 | + } |
|
245 | + file_put_contents( |
|
246 | + $filepath, |
|
247 | + "\n" . date('Y-m-d H:i:s') . Benchmark::generateResults($formatted), |
|
248 | + $append ? FILE_APPEND | LOCK_EX : LOCK_EX |
|
249 | + ); |
|
250 | + } |
|
251 | + |
|
252 | + |
|
253 | + |
|
254 | + /** |
|
255 | + * Converts a measure of memory bytes into the most logical units (eg kb, mb, etc) |
|
256 | + * |
|
257 | + * @param int $size |
|
258 | + * @return string |
|
259 | + */ |
|
260 | + public static function convert($size) |
|
261 | + { |
|
262 | + $unit = array('b', 'kb', 'mb', 'gb', 'tb', 'pb'); |
|
263 | + return round( |
|
264 | + $size / pow(1024, $i = floor(log($size, 1024))), |
|
265 | + 2 |
|
266 | + ) . ' ' . $unit[absint($i)]; |
|
267 | + } |
|
268 | + |
|
269 | + |
|
270 | + |
|
271 | + /** |
|
272 | + * @param string $timer_name |
|
273 | + * @param float $total_time |
|
274 | + * @param bool $formatted |
|
275 | + * @return string |
|
276 | + */ |
|
277 | + public static function formatTime($timer_name, $total_time, $formatted = true) |
|
278 | + { |
|
279 | + $total_time *= 1000; |
|
280 | + switch ($total_time) { |
|
281 | + case $total_time > 12500 : |
|
282 | + $color = 'red'; |
|
283 | + $bold = 'bold'; |
|
284 | + break; |
|
285 | + case $total_time > 2500 : |
|
286 | + $color = 'darkorange'; |
|
287 | + $bold = 'bold'; |
|
288 | + break; |
|
289 | + case $total_time > 500 : |
|
290 | + $color = 'gold'; |
|
291 | + $bold = 'bold'; |
|
292 | + break; |
|
293 | + case $total_time > 100 : |
|
294 | + $color = 'limegreen'; |
|
295 | + $bold = 'normal'; |
|
296 | + break; |
|
297 | + case $total_time > 20 : |
|
298 | + $color = 'deepskyblue'; |
|
299 | + $bold = 'normal'; |
|
300 | + break; |
|
301 | + default : |
|
302 | + $color = 'mediumpurple'; |
|
303 | + $bold = 'normal'; |
|
304 | + break; |
|
305 | + } |
|
306 | + return $formatted |
|
307 | + ? '<span style="min-width: 10px; margin:0 1em; color:' |
|
308 | + . $color |
|
309 | + . '; font-weight:' |
|
310 | + . $bold |
|
311 | + . '; font-size:1.2em;">' |
|
312 | + . str_pad(number_format($total_time, 3), 9, '0', STR_PAD_LEFT) |
|
313 | + . '</span> ' |
|
314 | + . $timer_name |
|
315 | + : str_pad(number_format($total_time, 3), 9, '0', STR_PAD_LEFT); |
|
316 | + } |
|
317 | 317 | |
318 | 318 | |
319 | 319 |