@@ -20,139 +20,139 @@ |
||
20 | 20 | interface RequestInterface extends RequestTypeContextCheckerInterface |
21 | 21 | { |
22 | 22 | |
23 | - /** |
|
24 | - * @param RequestTypeContextCheckerInterface $type |
|
25 | - */ |
|
26 | - public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type); |
|
27 | - |
|
28 | - /** |
|
29 | - * @return array |
|
30 | - */ |
|
31 | - public function getParams(); |
|
32 | - |
|
33 | - |
|
34 | - /** |
|
35 | - * @return array |
|
36 | - */ |
|
37 | - public function postParams(); |
|
38 | - |
|
39 | - |
|
40 | - /** |
|
41 | - * @return array |
|
42 | - */ |
|
43 | - public function cookieParams(); |
|
44 | - |
|
45 | - |
|
46 | - /** |
|
47 | - * @return array |
|
48 | - */ |
|
49 | - public function serverParams(); |
|
50 | - |
|
51 | - |
|
52 | - /** |
|
53 | - * returns contents of $_REQUEST |
|
54 | - * |
|
55 | - * @return array |
|
56 | - */ |
|
57 | - public function requestParams(); |
|
23 | + /** |
|
24 | + * @param RequestTypeContextCheckerInterface $type |
|
25 | + */ |
|
26 | + public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type); |
|
27 | + |
|
28 | + /** |
|
29 | + * @return array |
|
30 | + */ |
|
31 | + public function getParams(); |
|
32 | + |
|
33 | + |
|
34 | + /** |
|
35 | + * @return array |
|
36 | + */ |
|
37 | + public function postParams(); |
|
38 | + |
|
39 | + |
|
40 | + /** |
|
41 | + * @return array |
|
42 | + */ |
|
43 | + public function cookieParams(); |
|
44 | + |
|
45 | + |
|
46 | + /** |
|
47 | + * @return array |
|
48 | + */ |
|
49 | + public function serverParams(); |
|
50 | + |
|
51 | + |
|
52 | + /** |
|
53 | + * returns contents of $_REQUEST |
|
54 | + * |
|
55 | + * @return array |
|
56 | + */ |
|
57 | + public function requestParams(); |
|
58 | 58 | |
59 | 59 | |
60 | - /** |
|
61 | - * @param string $key |
|
62 | - * @param string $value |
|
63 | - * @param bool $override_ee |
|
64 | - * @return void |
|
65 | - */ |
|
66 | - public function setRequestParam($key, $value, $override_ee = false); |
|
60 | + /** |
|
61 | + * @param string $key |
|
62 | + * @param string $value |
|
63 | + * @param bool $override_ee |
|
64 | + * @return void |
|
65 | + */ |
|
66 | + public function setRequestParam($key, $value, $override_ee = false); |
|
67 | 67 | |
68 | 68 | |
69 | - /** |
|
70 | - * returns the value for a request param if the given key exists |
|
71 | - * |
|
72 | - * @param string $key |
|
73 | - * @param null $default |
|
74 | - * @return mixed |
|
75 | - */ |
|
76 | - public function getRequestParam($key, $default = null); |
|
69 | + /** |
|
70 | + * returns the value for a request param if the given key exists |
|
71 | + * |
|
72 | + * @param string $key |
|
73 | + * @param null $default |
|
74 | + * @return mixed |
|
75 | + */ |
|
76 | + public function getRequestParam($key, $default = null); |
|
77 | 77 | |
78 | 78 | |
79 | - /** |
|
80 | - * check if param exists |
|
81 | - * |
|
82 | - * @param string $key |
|
83 | - * @return bool |
|
84 | - */ |
|
85 | - public function requestParamIsSet($key); |
|
79 | + /** |
|
80 | + * check if param exists |
|
81 | + * |
|
82 | + * @param string $key |
|
83 | + * @return bool |
|
84 | + */ |
|
85 | + public function requestParamIsSet($key); |
|
86 | 86 | |
87 | 87 | |
88 | - /** |
|
89 | - * check if a request parameter exists whose key that matches the supplied wildcard pattern |
|
90 | - * and return the value for the first match found |
|
91 | - * wildcards can be either of the following: |
|
92 | - * ? to represent a single character of any type |
|
93 | - * * to represent one or more characters of any type |
|
94 | - * |
|
95 | - * @param string $pattern |
|
96 | - * @param null|mixed $default |
|
97 | - * @return false|int |
|
98 | - */ |
|
99 | - public function getMatch($pattern, $default = null); |
|
88 | + /** |
|
89 | + * check if a request parameter exists whose key that matches the supplied wildcard pattern |
|
90 | + * and return the value for the first match found |
|
91 | + * wildcards can be either of the following: |
|
92 | + * ? to represent a single character of any type |
|
93 | + * * to represent one or more characters of any type |
|
94 | + * |
|
95 | + * @param string $pattern |
|
96 | + * @param null|mixed $default |
|
97 | + * @return false|int |
|
98 | + */ |
|
99 | + public function getMatch($pattern, $default = null); |
|
100 | 100 | |
101 | 101 | |
102 | - /** |
|
103 | - * check if a request parameter exists whose key matches the supplied wildcard pattern |
|
104 | - * wildcards can be either of the following: |
|
105 | - * ? to represent a single character of any type |
|
106 | - * * to represent one or more characters of any type |
|
107 | - * returns true if a match is found or false if not |
|
108 | - * |
|
109 | - * @param string $pattern |
|
110 | - * @return false|int |
|
111 | - */ |
|
112 | - public function matches($pattern); |
|
102 | + /** |
|
103 | + * check if a request parameter exists whose key matches the supplied wildcard pattern |
|
104 | + * wildcards can be either of the following: |
|
105 | + * ? to represent a single character of any type |
|
106 | + * * to represent one or more characters of any type |
|
107 | + * returns true if a match is found or false if not |
|
108 | + * |
|
109 | + * @param string $pattern |
|
110 | + * @return false|int |
|
111 | + */ |
|
112 | + public function matches($pattern); |
|
113 | 113 | |
114 | 114 | |
115 | - /** |
|
116 | - * remove param |
|
117 | - * |
|
118 | - * @param string $key |
|
119 | - * @param bool $unset_from_global_too |
|
120 | - */ |
|
121 | - public function unSetRequestParam($key, $unset_from_global_too = false); |
|
115 | + /** |
|
116 | + * remove param |
|
117 | + * |
|
118 | + * @param string $key |
|
119 | + * @param bool $unset_from_global_too |
|
120 | + */ |
|
121 | + public function unSetRequestParam($key, $unset_from_global_too = false); |
|
122 | 122 | |
123 | 123 | |
124 | - /** |
|
125 | - * @return string |
|
126 | - */ |
|
127 | - public function ipAddress(); |
|
124 | + /** |
|
125 | + * @return string |
|
126 | + */ |
|
127 | + public function ipAddress(); |
|
128 | 128 | |
129 | 129 | |
130 | - /** |
|
131 | - * @return string |
|
132 | - */ |
|
133 | - public function requestUri(); |
|
134 | - |
|
130 | + /** |
|
131 | + * @return string |
|
132 | + */ |
|
133 | + public function requestUri(); |
|
134 | + |
|
135 | 135 | |
136 | - /** |
|
137 | - * @return string |
|
138 | - */ |
|
139 | - public function userAgent(); |
|
140 | - |
|
141 | - |
|
142 | - /** |
|
143 | - * @param string $user_agent |
|
144 | - */ |
|
145 | - public function setUserAgent($user_agent = ''); |
|
146 | - |
|
147 | - |
|
148 | - /** |
|
149 | - * @return bool |
|
150 | - */ |
|
151 | - public function isBot(); |
|
152 | - |
|
153 | - |
|
154 | - /** |
|
155 | - * @param bool $is_bot |
|
156 | - */ |
|
157 | - public function setIsBot($is_bot); |
|
136 | + /** |
|
137 | + * @return string |
|
138 | + */ |
|
139 | + public function userAgent(); |
|
140 | + |
|
141 | + |
|
142 | + /** |
|
143 | + * @param string $user_agent |
|
144 | + */ |
|
145 | + public function setUserAgent($user_agent = ''); |
|
146 | + |
|
147 | + |
|
148 | + /** |
|
149 | + * @return bool |
|
150 | + */ |
|
151 | + public function isBot(); |
|
152 | + |
|
153 | + |
|
154 | + /** |
|
155 | + * @param bool $is_bot |
|
156 | + */ |
|
157 | + public function setIsBot($is_bot); |
|
158 | 158 | } |
@@ -14,28 +14,28 @@ |
||
14 | 14 | class EE_Detect_File_Editor_Request extends EE_Middleware |
15 | 15 | { |
16 | 16 | |
17 | - /** |
|
18 | - * @deprecated |
|
19 | - * @param EE_Request $request |
|
20 | - * @param EE_Response $response |
|
21 | - * @return EE_Response |
|
22 | - */ |
|
23 | - public function handle_request(EE_Request $request, EE_Response $response) |
|
24 | - { |
|
25 | - EE_Error::doing_it_wrong( |
|
26 | - __METHOD__, |
|
27 | - sprintf( |
|
28 | - esc_html__( |
|
29 | - 'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace', |
|
30 | - 'event_espresso' |
|
31 | - ), |
|
32 | - 'EventEspresso\core\services\request\middleware\DetectFileEditorRequest', |
|
33 | - '\core\services\request', |
|
34 | - 'EventEspresso\core\services\request' |
|
35 | - ), |
|
36 | - '4.9.52' |
|
37 | - ); |
|
38 | - return $response; |
|
39 | - } |
|
17 | + /** |
|
18 | + * @deprecated |
|
19 | + * @param EE_Request $request |
|
20 | + * @param EE_Response $response |
|
21 | + * @return EE_Response |
|
22 | + */ |
|
23 | + public function handle_request(EE_Request $request, EE_Response $response) |
|
24 | + { |
|
25 | + EE_Error::doing_it_wrong( |
|
26 | + __METHOD__, |
|
27 | + sprintf( |
|
28 | + esc_html__( |
|
29 | + 'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace', |
|
30 | + 'event_espresso' |
|
31 | + ), |
|
32 | + 'EventEspresso\core\services\request\middleware\DetectFileEditorRequest', |
|
33 | + '\core\services\request', |
|
34 | + 'EventEspresso\core\services\request' |
|
35 | + ), |
|
36 | + '4.9.52' |
|
37 | + ); |
|
38 | + return $response; |
|
39 | + } |
|
40 | 40 | |
41 | 41 | } |
@@ -83,12 +83,12 @@ |
||
83 | 83 | <div class="notice inline notice-alt"> |
84 | 84 | <div class="ee-upsell-container"> |
85 | 85 | <div class="ee-upsell-inner-container"> |
86 | - <a href="' . $button_url . '"> |
|
87 | - ' . $button_text . ' |
|
86 | + <a href="' . $button_url.'"> |
|
87 | + ' . $button_text.' |
|
88 | 88 | </a> |
89 | 89 | </div> |
90 | 90 | <div class="ee-upsell-inner-container"> |
91 | - <p>' . $upsell_text . '</p> |
|
91 | + <p>' . $upsell_text.'</p> |
|
92 | 92 | </div> |
93 | 93 | <div style="clear:both"></div> |
94 | 94 | </div> |
@@ -17,47 +17,47 @@ discard block |
||
17 | 17 | class PluginUpsells |
18 | 18 | { |
19 | 19 | |
20 | - /** |
|
21 | - * @var DomainInterface |
|
22 | - */ |
|
23 | - private $domain; |
|
20 | + /** |
|
21 | + * @var DomainInterface |
|
22 | + */ |
|
23 | + private $domain; |
|
24 | 24 | |
25 | 25 | |
26 | - /** |
|
27 | - * PluginUpsells constructor. |
|
28 | - * |
|
29 | - * @param DomainInterface $domain |
|
30 | - */ |
|
31 | - public function __construct(DomainInterface $domain) |
|
32 | - { |
|
33 | - $this->domain = $domain; |
|
34 | - } |
|
26 | + /** |
|
27 | + * PluginUpsells constructor. |
|
28 | + * |
|
29 | + * @param DomainInterface $domain |
|
30 | + */ |
|
31 | + public function __construct(DomainInterface $domain) |
|
32 | + { |
|
33 | + $this->domain = $domain; |
|
34 | + } |
|
35 | 35 | |
36 | 36 | |
37 | - /** |
|
38 | - * Hook in various upsells for the decaf version of EE. |
|
39 | - */ |
|
40 | - public function decafUpsells() |
|
41 | - { |
|
42 | - if ($this->domain instanceof CaffeinatedInterface && ! $this->domain->isCaffeinated()) { |
|
43 | - add_action('after_plugin_row', array($this, 'doPremiumUpsell'), 10, 3); |
|
44 | - } |
|
45 | - } |
|
37 | + /** |
|
38 | + * Hook in various upsells for the decaf version of EE. |
|
39 | + */ |
|
40 | + public function decafUpsells() |
|
41 | + { |
|
42 | + if ($this->domain instanceof CaffeinatedInterface && ! $this->domain->isCaffeinated()) { |
|
43 | + add_action('after_plugin_row', array($this, 'doPremiumUpsell'), 10, 3); |
|
44 | + } |
|
45 | + } |
|
46 | 46 | |
47 | 47 | |
48 | - /** |
|
49 | - * Callback for `after_plugin_row` to add upsell info |
|
50 | - * |
|
51 | - * @param string $plugin_file |
|
52 | - * @param array $plugin_data |
|
53 | - * @param string $status |
|
54 | - * @throws DomainException |
|
55 | - */ |
|
56 | - public function doPremiumUpsell($plugin_file, $plugin_data, $status) |
|
57 | - { |
|
58 | - if ($plugin_file === $this->domain->pluginBasename()) { |
|
59 | - list($button_text, $button_url, $upsell_text) = $this->getAfterPluginRowDetails(); |
|
60 | - echo '<tr class="plugin-update-tr ee-upsell-plugin-list-table active"> |
|
48 | + /** |
|
49 | + * Callback for `after_plugin_row` to add upsell info |
|
50 | + * |
|
51 | + * @param string $plugin_file |
|
52 | + * @param array $plugin_data |
|
53 | + * @param string $status |
|
54 | + * @throws DomainException |
|
55 | + */ |
|
56 | + public function doPremiumUpsell($plugin_file, $plugin_data, $status) |
|
57 | + { |
|
58 | + if ($plugin_file === $this->domain->pluginBasename()) { |
|
59 | + list($button_text, $button_url, $upsell_text) = $this->getAfterPluginRowDetails(); |
|
60 | + echo '<tr class="plugin-update-tr ee-upsell-plugin-list-table active"> |
|
61 | 61 | <td colspan="3" class="plugin-update colspanchange"> |
62 | 62 | <div class="notice inline notice-alt"> |
63 | 63 | <div class="ee-upsell-container"> |
@@ -74,27 +74,27 @@ discard block |
||
74 | 74 | </div> |
75 | 75 | </td> |
76 | 76 | </tr>'; |
77 | - } |
|
78 | - } |
|
77 | + } |
|
78 | + } |
|
79 | 79 | |
80 | - /** |
|
81 | - * Provide the details used for the upsell container. |
|
82 | - * |
|
83 | - * @return array |
|
84 | - */ |
|
85 | - protected function getAfterPluginRowDetails() |
|
86 | - { |
|
87 | - return array( |
|
88 | - esc_html__('Upgrade for Support', 'event_espresso'), |
|
89 | - 'https://eventespresso.com/purchase/?slug=ee4-license-personal&utm_source=wp_admin_plugins_screen&utm_medium=link&utm_campaign=plugins_screen_upgrade_link" class="button button-primary', |
|
90 | - sprintf( |
|
91 | - esc_html__( |
|
92 | - 'You\'re missing out on %1$sexpert support%2$s and %1$sone-click updates%2$s! Don\'t have an Event Espresso support license key? Support the project and buy one today!', |
|
93 | - 'event_espresso' |
|
94 | - ), |
|
95 | - '<strong>', |
|
96 | - '</strong>' |
|
97 | - ), |
|
98 | - ); |
|
99 | - } |
|
80 | + /** |
|
81 | + * Provide the details used for the upsell container. |
|
82 | + * |
|
83 | + * @return array |
|
84 | + */ |
|
85 | + protected function getAfterPluginRowDetails() |
|
86 | + { |
|
87 | + return array( |
|
88 | + esc_html__('Upgrade for Support', 'event_espresso'), |
|
89 | + 'https://eventespresso.com/purchase/?slug=ee4-license-personal&utm_source=wp_admin_plugins_screen&utm_medium=link&utm_campaign=plugins_screen_upgrade_link" class="button button-primary', |
|
90 | + sprintf( |
|
91 | + esc_html__( |
|
92 | + 'You\'re missing out on %1$sexpert support%2$s and %1$sone-click updates%2$s! Don\'t have an Event Espresso support license key? Support the project and buy one today!', |
|
93 | + 'event_espresso' |
|
94 | + ), |
|
95 | + '<strong>', |
|
96 | + '</strong>' |
|
97 | + ), |
|
98 | + ); |
|
99 | + } |
|
100 | 100 | } |
@@ -66,7 +66,7 @@ |
||
66 | 66 | */ |
67 | 67 | private function setCaffeinated() |
68 | 68 | { |
69 | - $this->caffeinated = (! defined('EE_DECAF') || EE_DECAF !== true) |
|
70 | - && is_readable($this->pluginPath() . 'caffeinated/brewing_regular.php'); |
|
69 | + $this->caffeinated = ( ! defined('EE_DECAF') || EE_DECAF !== true) |
|
70 | + && is_readable($this->pluginPath().'caffeinated/brewing_regular.php'); |
|
71 | 71 | } |
72 | 72 | } |
@@ -19,54 +19,54 @@ |
||
19 | 19 | class Domain extends DomainBase implements CaffeinatedInterface |
20 | 20 | { |
21 | 21 | |
22 | - /** |
|
23 | - * URL path component used to denote an API request |
|
24 | - */ |
|
25 | - const API_NAMESPACE = 'ee/v'; |
|
22 | + /** |
|
23 | + * URL path component used to denote an API request |
|
24 | + */ |
|
25 | + const API_NAMESPACE = 'ee/v'; |
|
26 | 26 | |
27 | - /** |
|
28 | - * Slug used for the context where a registration status is changed from a manual trigger in the Registration Admin |
|
29 | - * Page ui. |
|
30 | - */ |
|
31 | - const CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN |
|
32 | - = 'manual_registration_status_change_from_registration_admin'; |
|
27 | + /** |
|
28 | + * Slug used for the context where a registration status is changed from a manual trigger in the Registration Admin |
|
29 | + * Page ui. |
|
30 | + */ |
|
31 | + const CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN |
|
32 | + = 'manual_registration_status_change_from_registration_admin'; |
|
33 | 33 | |
34 | - const CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN_NOTIFY |
|
35 | - = 'manual_registration_status_change_from_registration_admin_and_notify'; |
|
34 | + const CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN_NOTIFY |
|
35 | + = 'manual_registration_status_change_from_registration_admin_and_notify'; |
|
36 | 36 | |
37 | 37 | |
38 | - /** |
|
39 | - * Whether or not EE core is the full premium version. |
|
40 | - * @since 4.9.59.p |
|
41 | - * @var bool |
|
42 | - */ |
|
43 | - private $caffeinated; |
|
38 | + /** |
|
39 | + * Whether or not EE core is the full premium version. |
|
40 | + * @since 4.9.59.p |
|
41 | + * @var bool |
|
42 | + */ |
|
43 | + private $caffeinated; |
|
44 | 44 | |
45 | 45 | |
46 | - public function __construct(FilePath $plugin_file, Version $version) |
|
47 | - { |
|
48 | - parent::__construct($plugin_file, $version); |
|
49 | - $this->setCaffeinated(); |
|
50 | - } |
|
46 | + public function __construct(FilePath $plugin_file, Version $version) |
|
47 | + { |
|
48 | + parent::__construct($plugin_file, $version); |
|
49 | + $this->setCaffeinated(); |
|
50 | + } |
|
51 | 51 | |
52 | - /** |
|
53 | - * Whether or not EE core is the full premium version. |
|
54 | - * @since 4.9.59.p |
|
55 | - * @return bool |
|
56 | - */ |
|
57 | - public function isCaffeinated() |
|
58 | - { |
|
59 | - return $this->caffeinated; |
|
60 | - } |
|
52 | + /** |
|
53 | + * Whether or not EE core is the full premium version. |
|
54 | + * @since 4.9.59.p |
|
55 | + * @return bool |
|
56 | + */ |
|
57 | + public function isCaffeinated() |
|
58 | + { |
|
59 | + return $this->caffeinated; |
|
60 | + } |
|
61 | 61 | |
62 | 62 | |
63 | - /** |
|
64 | - * Setter for $is_caffeinated property. |
|
65 | - * @since 4.9.59.p |
|
66 | - */ |
|
67 | - private function setCaffeinated() |
|
68 | - { |
|
69 | - $this->caffeinated = (! defined('EE_DECAF') || EE_DECAF !== true) |
|
70 | - && is_readable($this->pluginPath() . 'caffeinated/brewing_regular.php'); |
|
71 | - } |
|
63 | + /** |
|
64 | + * Setter for $is_caffeinated property. |
|
65 | + * @since 4.9.59.p |
|
66 | + */ |
|
67 | + private function setCaffeinated() |
|
68 | + { |
|
69 | + $this->caffeinated = (! defined('EE_DECAF') || EE_DECAF !== true) |
|
70 | + && is_readable($this->pluginPath() . 'caffeinated/brewing_regular.php'); |
|
71 | + } |
|
72 | 72 | } |
@@ -101,7 +101,7 @@ |
||
101 | 101 | |
102 | 102 | |
103 | 103 | /** |
104 | - * @param FullyQualifiedName|string $fqcn |
|
104 | + * @param string $fqcn |
|
105 | 105 | * @param array $arguments |
106 | 106 | * @return mixed |
107 | 107 | */ |
@@ -15,115 +15,115 @@ |
||
15 | 15 | class Loader implements LoaderInterface |
16 | 16 | { |
17 | 17 | |
18 | - /** |
|
19 | - * @var LoaderDecoratorInterface $new_loader |
|
20 | - */ |
|
21 | - private $new_loader; |
|
22 | - |
|
23 | - /** |
|
24 | - * @var LoaderDecoratorInterface $shared_loader |
|
25 | - */ |
|
26 | - private $shared_loader; |
|
27 | - |
|
28 | - /** |
|
29 | - * @var ClassInterfaceCache $class_cache |
|
30 | - */ |
|
31 | - private $class_cache; |
|
32 | - |
|
33 | - /** |
|
34 | - * Loader constructor. |
|
35 | - * |
|
36 | - * @param LoaderDecoratorInterface $new_loader |
|
37 | - * @param CachingLoaderDecoratorInterface $shared_loader |
|
38 | - * @param ClassInterfaceCache $class_cache |
|
39 | - */ |
|
40 | - public function __construct( |
|
41 | - LoaderDecoratorInterface $new_loader, |
|
42 | - CachingLoaderDecoratorInterface $shared_loader, |
|
43 | - ClassInterfaceCache $class_cache |
|
44 | - ) { |
|
45 | - $this->new_loader = $new_loader; |
|
46 | - $this->shared_loader = $shared_loader; |
|
47 | - $this->class_cache = $class_cache; |
|
48 | - } |
|
49 | - |
|
50 | - |
|
51 | - /** |
|
52 | - * @return LoaderDecoratorInterface |
|
53 | - */ |
|
54 | - public function getNewLoader() |
|
55 | - { |
|
56 | - return $this->new_loader; |
|
57 | - } |
|
58 | - |
|
59 | - |
|
60 | - /** |
|
61 | - * @return CachingLoaderDecoratorInterface |
|
62 | - */ |
|
63 | - public function getSharedLoader() |
|
64 | - { |
|
65 | - return $this->shared_loader; |
|
66 | - } |
|
67 | - |
|
68 | - |
|
69 | - /** |
|
70 | - * @param FullyQualifiedName|string $fqcn |
|
71 | - * @param array $arguments |
|
72 | - * @param bool $shared |
|
73 | - * @return mixed |
|
74 | - */ |
|
75 | - public function load($fqcn, array $arguments = array(), $shared = true) |
|
76 | - { |
|
77 | - $fqcn = $this->class_cache->getFqn($fqcn); |
|
78 | - if ($this->class_cache->hasInterface($fqcn, 'EventEspresso\core\interfaces\ReservedInstanceInterface')) { |
|
79 | - $shared = true; |
|
80 | - } |
|
81 | - return $shared |
|
82 | - ? $this->getSharedLoader()->load($fqcn, $arguments, $shared) |
|
83 | - : $this->getNewLoader()->load($fqcn, $arguments, $shared); |
|
84 | - } |
|
85 | - |
|
86 | - |
|
87 | - /** |
|
88 | - * @param FullyQualifiedName|string $fqcn |
|
89 | - * @param array $arguments |
|
90 | - * @return mixed |
|
91 | - */ |
|
92 | - public function getNew($fqcn, array $arguments = array()) |
|
93 | - { |
|
94 | - return $this->load($fqcn, $arguments, false); |
|
95 | - } |
|
96 | - |
|
97 | - |
|
98 | - /** |
|
99 | - * @param FullyQualifiedName|string $fqcn |
|
100 | - * @param array $arguments |
|
101 | - * @return mixed |
|
102 | - */ |
|
103 | - public function getShared($fqcn, array $arguments = array()) |
|
104 | - { |
|
105 | - return $this->load($fqcn, $arguments); |
|
106 | - } |
|
107 | - |
|
108 | - |
|
109 | - /** |
|
110 | - * @param FullyQualifiedName|string $fqcn |
|
111 | - * @param mixed $object |
|
112 | - * @return bool |
|
113 | - * @throws InvalidArgumentException |
|
114 | - */ |
|
115 | - public function share($fqcn, $object) |
|
116 | - { |
|
117 | - $fqcn = $this->class_cache->getFqn($fqcn); |
|
118 | - return $this->getSharedLoader()->share($fqcn, $object); |
|
119 | - } |
|
120 | - |
|
121 | - |
|
122 | - /** |
|
123 | - * calls reset() on loaders if that method exists |
|
124 | - */ |
|
125 | - public function reset() |
|
126 | - { |
|
127 | - $this->shared_loader->reset(); |
|
128 | - } |
|
18 | + /** |
|
19 | + * @var LoaderDecoratorInterface $new_loader |
|
20 | + */ |
|
21 | + private $new_loader; |
|
22 | + |
|
23 | + /** |
|
24 | + * @var LoaderDecoratorInterface $shared_loader |
|
25 | + */ |
|
26 | + private $shared_loader; |
|
27 | + |
|
28 | + /** |
|
29 | + * @var ClassInterfaceCache $class_cache |
|
30 | + */ |
|
31 | + private $class_cache; |
|
32 | + |
|
33 | + /** |
|
34 | + * Loader constructor. |
|
35 | + * |
|
36 | + * @param LoaderDecoratorInterface $new_loader |
|
37 | + * @param CachingLoaderDecoratorInterface $shared_loader |
|
38 | + * @param ClassInterfaceCache $class_cache |
|
39 | + */ |
|
40 | + public function __construct( |
|
41 | + LoaderDecoratorInterface $new_loader, |
|
42 | + CachingLoaderDecoratorInterface $shared_loader, |
|
43 | + ClassInterfaceCache $class_cache |
|
44 | + ) { |
|
45 | + $this->new_loader = $new_loader; |
|
46 | + $this->shared_loader = $shared_loader; |
|
47 | + $this->class_cache = $class_cache; |
|
48 | + } |
|
49 | + |
|
50 | + |
|
51 | + /** |
|
52 | + * @return LoaderDecoratorInterface |
|
53 | + */ |
|
54 | + public function getNewLoader() |
|
55 | + { |
|
56 | + return $this->new_loader; |
|
57 | + } |
|
58 | + |
|
59 | + |
|
60 | + /** |
|
61 | + * @return CachingLoaderDecoratorInterface |
|
62 | + */ |
|
63 | + public function getSharedLoader() |
|
64 | + { |
|
65 | + return $this->shared_loader; |
|
66 | + } |
|
67 | + |
|
68 | + |
|
69 | + /** |
|
70 | + * @param FullyQualifiedName|string $fqcn |
|
71 | + * @param array $arguments |
|
72 | + * @param bool $shared |
|
73 | + * @return mixed |
|
74 | + */ |
|
75 | + public function load($fqcn, array $arguments = array(), $shared = true) |
|
76 | + { |
|
77 | + $fqcn = $this->class_cache->getFqn($fqcn); |
|
78 | + if ($this->class_cache->hasInterface($fqcn, 'EventEspresso\core\interfaces\ReservedInstanceInterface')) { |
|
79 | + $shared = true; |
|
80 | + } |
|
81 | + return $shared |
|
82 | + ? $this->getSharedLoader()->load($fqcn, $arguments, $shared) |
|
83 | + : $this->getNewLoader()->load($fqcn, $arguments, $shared); |
|
84 | + } |
|
85 | + |
|
86 | + |
|
87 | + /** |
|
88 | + * @param FullyQualifiedName|string $fqcn |
|
89 | + * @param array $arguments |
|
90 | + * @return mixed |
|
91 | + */ |
|
92 | + public function getNew($fqcn, array $arguments = array()) |
|
93 | + { |
|
94 | + return $this->load($fqcn, $arguments, false); |
|
95 | + } |
|
96 | + |
|
97 | + |
|
98 | + /** |
|
99 | + * @param FullyQualifiedName|string $fqcn |
|
100 | + * @param array $arguments |
|
101 | + * @return mixed |
|
102 | + */ |
|
103 | + public function getShared($fqcn, array $arguments = array()) |
|
104 | + { |
|
105 | + return $this->load($fqcn, $arguments); |
|
106 | + } |
|
107 | + |
|
108 | + |
|
109 | + /** |
|
110 | + * @param FullyQualifiedName|string $fqcn |
|
111 | + * @param mixed $object |
|
112 | + * @return bool |
|
113 | + * @throws InvalidArgumentException |
|
114 | + */ |
|
115 | + public function share($fqcn, $object) |
|
116 | + { |
|
117 | + $fqcn = $this->class_cache->getFqn($fqcn); |
|
118 | + return $this->getSharedLoader()->share($fqcn, $object); |
|
119 | + } |
|
120 | + |
|
121 | + |
|
122 | + /** |
|
123 | + * calls reset() on loaders if that method exists |
|
124 | + */ |
|
125 | + public function reset() |
|
126 | + { |
|
127 | + $this->shared_loader->reset(); |
|
128 | + } |
|
129 | 129 | } |
@@ -78,13 +78,13 @@ |
||
78 | 78 | // EE_Dependency_Map: info about how to load classes required by other classes |
79 | 79 | espresso_load_required( |
80 | 80 | 'EE_Dependency_Map', |
81 | - EE_CORE . 'EE_Dependency_Map.core.php' |
|
81 | + EE_CORE.'EE_Dependency_Map.core.php' |
|
82 | 82 | ); |
83 | 83 | $this->dependency_map = EE_Dependency_Map::instance($this->class_cache); |
84 | 84 | // EE_Registry: central repository for classes (legacy) |
85 | 85 | espresso_load_required( |
86 | 86 | 'EE_Registry', |
87 | - EE_CORE . 'EE_Registry.core.php' |
|
87 | + EE_CORE.'EE_Registry.core.php' |
|
88 | 88 | ); |
89 | 89 | $this->registry = EE_Registry::instance( |
90 | 90 | $this->dependency_map, |
@@ -25,123 +25,123 @@ |
||
25 | 25 | class BootstrapDependencyInjectionContainer |
26 | 26 | { |
27 | 27 | |
28 | - /** |
|
29 | - * @var EE_Dependency_Map $dependency_map |
|
30 | - */ |
|
31 | - protected $dependency_map; |
|
32 | - |
|
33 | - /** |
|
34 | - * @type LoaderInterface $loader |
|
35 | - */ |
|
36 | - protected $loader; |
|
37 | - |
|
38 | - /** |
|
39 | - * @var EE_Registry $registry |
|
40 | - */ |
|
41 | - protected $registry; |
|
42 | - |
|
43 | - /** |
|
44 | - * @var ClassInterfaceCache $class_cache |
|
45 | - */ |
|
46 | - private $class_cache; |
|
47 | - |
|
48 | - /** |
|
49 | - * @var Mirror |
|
50 | - */ |
|
51 | - private $mirror; |
|
52 | - |
|
53 | - /** |
|
54 | - * @var ObjectIdentifier |
|
55 | - */ |
|
56 | - private $object_identifier; |
|
57 | - |
|
58 | - |
|
59 | - /** |
|
60 | - * Can't use this just yet until we exorcise some more of our singleton usage from core |
|
61 | - */ |
|
62 | - public function buildDependencyInjectionContainer() |
|
63 | - { |
|
64 | - // build DI container |
|
65 | - // $OpenCoffeeShop = new EventEspresso\core\services\container\OpenCoffeeShop(); |
|
66 | - // $OpenCoffeeShop->addRecipes(); |
|
67 | - // $CoffeeShop = $OpenCoffeeShop->CoffeeShop(); |
|
68 | - } |
|
69 | - |
|
70 | - |
|
71 | - /** |
|
72 | - * Setups EE_Registry and EE_Dependency_Map |
|
73 | - * |
|
74 | - * @throws EE_Error |
|
75 | - */ |
|
76 | - public function buildLegacyDependencyInjectionContainer() |
|
77 | - { |
|
78 | - $this->class_cache = new ClassInterfaceCache(); |
|
79 | - $this->object_identifier = new ObjectIdentifier($this->class_cache); |
|
80 | - $this->mirror = new Mirror(); |
|
81 | - // EE_Dependency_Map: info about how to load classes required by other classes |
|
82 | - espresso_load_required( |
|
83 | - 'EE_Dependency_Map', |
|
84 | - EE_CORE . 'EE_Dependency_Map.core.php' |
|
85 | - ); |
|
86 | - $this->dependency_map = EE_Dependency_Map::instance($this->class_cache); |
|
87 | - // EE_Registry: central repository for classes (legacy) |
|
88 | - espresso_load_required( |
|
89 | - 'EE_Registry', |
|
90 | - EE_CORE . 'EE_Registry.core.php' |
|
91 | - ); |
|
92 | - $this->registry = EE_Registry::instance( |
|
93 | - $this->dependency_map, |
|
94 | - $this->mirror, |
|
95 | - $this->class_cache, |
|
96 | - $this->object_identifier |
|
97 | - ); |
|
98 | - } |
|
99 | - |
|
100 | - |
|
101 | - /** |
|
102 | - * Performs initial setup for the generic Loader |
|
103 | - * |
|
104 | - * @throws InvalidDataTypeException |
|
105 | - * @throws InvalidInterfaceException |
|
106 | - * @throws InvalidArgumentException |
|
107 | - */ |
|
108 | - public function buildLoader() |
|
109 | - { |
|
110 | - $this->loader = LoaderFactory::getLoader( |
|
111 | - $this->registry, |
|
112 | - $this->class_cache, |
|
113 | - $this->object_identifier |
|
114 | - ); |
|
115 | - $this->loader->share('EventEspresso\core\services\loaders\ClassInterfaceCache', $this->class_cache); |
|
116 | - $this->loader->share('EventEspresso\core\services\loaders\ObjectIdentifier', $this->object_identifier); |
|
117 | - $this->loader->share('EventEspresso\core\services\container\Mirror', $this->mirror); |
|
118 | - $this->dependency_map->setLoader($this->loader); |
|
119 | - } |
|
120 | - |
|
121 | - |
|
122 | - /** |
|
123 | - * @return EE_Dependency_Map |
|
124 | - */ |
|
125 | - public function getDependencyMap() |
|
126 | - { |
|
127 | - return $this->dependency_map; |
|
128 | - } |
|
129 | - |
|
130 | - |
|
131 | - /** |
|
132 | - * @return EE_Registry |
|
133 | - */ |
|
134 | - public function getRegistry() |
|
135 | - { |
|
136 | - return $this->registry; |
|
137 | - } |
|
138 | - |
|
139 | - |
|
140 | - /** |
|
141 | - * @return LoaderInterface |
|
142 | - */ |
|
143 | - public function getLoader() |
|
144 | - { |
|
145 | - return $this->loader; |
|
146 | - } |
|
28 | + /** |
|
29 | + * @var EE_Dependency_Map $dependency_map |
|
30 | + */ |
|
31 | + protected $dependency_map; |
|
32 | + |
|
33 | + /** |
|
34 | + * @type LoaderInterface $loader |
|
35 | + */ |
|
36 | + protected $loader; |
|
37 | + |
|
38 | + /** |
|
39 | + * @var EE_Registry $registry |
|
40 | + */ |
|
41 | + protected $registry; |
|
42 | + |
|
43 | + /** |
|
44 | + * @var ClassInterfaceCache $class_cache |
|
45 | + */ |
|
46 | + private $class_cache; |
|
47 | + |
|
48 | + /** |
|
49 | + * @var Mirror |
|
50 | + */ |
|
51 | + private $mirror; |
|
52 | + |
|
53 | + /** |
|
54 | + * @var ObjectIdentifier |
|
55 | + */ |
|
56 | + private $object_identifier; |
|
57 | + |
|
58 | + |
|
59 | + /** |
|
60 | + * Can't use this just yet until we exorcise some more of our singleton usage from core |
|
61 | + */ |
|
62 | + public function buildDependencyInjectionContainer() |
|
63 | + { |
|
64 | + // build DI container |
|
65 | + // $OpenCoffeeShop = new EventEspresso\core\services\container\OpenCoffeeShop(); |
|
66 | + // $OpenCoffeeShop->addRecipes(); |
|
67 | + // $CoffeeShop = $OpenCoffeeShop->CoffeeShop(); |
|
68 | + } |
|
69 | + |
|
70 | + |
|
71 | + /** |
|
72 | + * Setups EE_Registry and EE_Dependency_Map |
|
73 | + * |
|
74 | + * @throws EE_Error |
|
75 | + */ |
|
76 | + public function buildLegacyDependencyInjectionContainer() |
|
77 | + { |
|
78 | + $this->class_cache = new ClassInterfaceCache(); |
|
79 | + $this->object_identifier = new ObjectIdentifier($this->class_cache); |
|
80 | + $this->mirror = new Mirror(); |
|
81 | + // EE_Dependency_Map: info about how to load classes required by other classes |
|
82 | + espresso_load_required( |
|
83 | + 'EE_Dependency_Map', |
|
84 | + EE_CORE . 'EE_Dependency_Map.core.php' |
|
85 | + ); |
|
86 | + $this->dependency_map = EE_Dependency_Map::instance($this->class_cache); |
|
87 | + // EE_Registry: central repository for classes (legacy) |
|
88 | + espresso_load_required( |
|
89 | + 'EE_Registry', |
|
90 | + EE_CORE . 'EE_Registry.core.php' |
|
91 | + ); |
|
92 | + $this->registry = EE_Registry::instance( |
|
93 | + $this->dependency_map, |
|
94 | + $this->mirror, |
|
95 | + $this->class_cache, |
|
96 | + $this->object_identifier |
|
97 | + ); |
|
98 | + } |
|
99 | + |
|
100 | + |
|
101 | + /** |
|
102 | + * Performs initial setup for the generic Loader |
|
103 | + * |
|
104 | + * @throws InvalidDataTypeException |
|
105 | + * @throws InvalidInterfaceException |
|
106 | + * @throws InvalidArgumentException |
|
107 | + */ |
|
108 | + public function buildLoader() |
|
109 | + { |
|
110 | + $this->loader = LoaderFactory::getLoader( |
|
111 | + $this->registry, |
|
112 | + $this->class_cache, |
|
113 | + $this->object_identifier |
|
114 | + ); |
|
115 | + $this->loader->share('EventEspresso\core\services\loaders\ClassInterfaceCache', $this->class_cache); |
|
116 | + $this->loader->share('EventEspresso\core\services\loaders\ObjectIdentifier', $this->object_identifier); |
|
117 | + $this->loader->share('EventEspresso\core\services\container\Mirror', $this->mirror); |
|
118 | + $this->dependency_map->setLoader($this->loader); |
|
119 | + } |
|
120 | + |
|
121 | + |
|
122 | + /** |
|
123 | + * @return EE_Dependency_Map |
|
124 | + */ |
|
125 | + public function getDependencyMap() |
|
126 | + { |
|
127 | + return $this->dependency_map; |
|
128 | + } |
|
129 | + |
|
130 | + |
|
131 | + /** |
|
132 | + * @return EE_Registry |
|
133 | + */ |
|
134 | + public function getRegistry() |
|
135 | + { |
|
136 | + return $this->registry; |
|
137 | + } |
|
138 | + |
|
139 | + |
|
140 | + /** |
|
141 | + * @return LoaderInterface |
|
142 | + */ |
|
143 | + public function getLoader() |
|
144 | + { |
|
145 | + return $this->loader; |
|
146 | + } |
|
147 | 147 | } |
@@ -25,226 +25,226 @@ |
||
25 | 25 | class Mirror |
26 | 26 | { |
27 | 27 | |
28 | - /** |
|
29 | - * @var ReflectionClass[] $classes |
|
30 | - */ |
|
31 | - private $classes = array(); |
|
32 | - |
|
33 | - /** |
|
34 | - * @var ReflectionMethod[] $constructors |
|
35 | - */ |
|
36 | - private $constructors = array(); |
|
37 | - |
|
38 | - /** |
|
39 | - * @var ReflectionParameter[][] $parameters |
|
40 | - */ |
|
41 | - private $parameters = array(); |
|
42 | - |
|
43 | - /** |
|
44 | - * @var ReflectionParameter[][] $parameters |
|
45 | - */ |
|
46 | - private $parameter_classes = array(); |
|
47 | - |
|
48 | - /** |
|
49 | - * @var ReflectionProperty[][] $properties |
|
50 | - */ |
|
51 | - private $properties = array(); |
|
52 | - |
|
53 | - /** |
|
54 | - * @var ReflectionMethod[][] $methods |
|
55 | - */ |
|
56 | - private $methods = array(); |
|
57 | - |
|
58 | - |
|
59 | - /** |
|
60 | - * @param string $class_name |
|
61 | - * @return ReflectionClass |
|
62 | - * @throws ReflectionException |
|
63 | - * @throws InvalidDataTypeException |
|
64 | - */ |
|
65 | - public function getReflectionClass($class_name) |
|
66 | - { |
|
67 | - if (! is_string($class_name)) { |
|
68 | - throw new InvalidDataTypeException($class_name, '$class_name', 'string (fully qualified class name)'); |
|
69 | - } |
|
70 | - if (! isset($this->classes[ $class_name ])) { |
|
71 | - $this->classes[ $class_name ] = new ReflectionClass($class_name); |
|
72 | - } |
|
73 | - return $this->classes[ $class_name ]; |
|
74 | - } |
|
75 | - |
|
76 | - |
|
77 | - /** |
|
78 | - * @param string $class_name |
|
79 | - * @return ReflectionMethod |
|
80 | - * @throws InvalidDataTypeException |
|
81 | - * @throws ReflectionException |
|
82 | - */ |
|
83 | - public function getConstructor($class_name) |
|
84 | - { |
|
85 | - if (! is_string($class_name)) { |
|
86 | - throw new InvalidDataTypeException($class_name, '$class_name', 'string (fully qualified class name)'); |
|
87 | - } |
|
88 | - if (! isset($this->constructors[ $class_name ])) { |
|
89 | - $reflection_class = $this->getReflectionClass($class_name); |
|
90 | - $this->constructors[ $class_name ] = $reflection_class->getConstructor(); |
|
91 | - } |
|
92 | - return $this->constructors[ $class_name ]; |
|
93 | - } |
|
94 | - |
|
95 | - |
|
96 | - /** |
|
97 | - * @param ReflectionClass $reflection_class |
|
98 | - * @return ReflectionMethod |
|
99 | - * @throws InvalidDataTypeException |
|
100 | - * @throws ReflectionException |
|
101 | - */ |
|
102 | - public function getConstructorFromReflection(ReflectionClass $reflection_class) |
|
103 | - { |
|
104 | - return $this->getConstructor($reflection_class->getName()); |
|
105 | - } |
|
106 | - |
|
107 | - |
|
108 | - /** |
|
109 | - * @param string $class_name |
|
110 | - * @return ReflectionParameter[] |
|
111 | - * @throws InvalidDataTypeException |
|
112 | - * @throws ReflectionException |
|
113 | - */ |
|
114 | - public function getParameters($class_name) |
|
115 | - { |
|
116 | - if (! isset($this->parameters[ $class_name ])) { |
|
117 | - $constructor = $this->getConstructor($class_name); |
|
118 | - $this->parameters[ $class_name ] = $constructor->getParameters(); |
|
119 | - } |
|
120 | - return $this->parameters[ $class_name ]; |
|
121 | - } |
|
122 | - |
|
123 | - |
|
124 | - /** |
|
125 | - * @param ReflectionClass $reflection_class |
|
126 | - * @return ReflectionParameter[] |
|
127 | - * @throws InvalidDataTypeException |
|
128 | - * @throws ReflectionException |
|
129 | - */ |
|
130 | - public function getParametersFromReflection(ReflectionClass $reflection_class) |
|
131 | - { |
|
132 | - return $this->getParameters($reflection_class->getName()); |
|
133 | - } |
|
134 | - |
|
135 | - |
|
136 | - /** |
|
137 | - * @param ReflectionMethod $constructor |
|
138 | - * @return ReflectionParameter[] |
|
139 | - * @throws InvalidDataTypeException |
|
140 | - * @throws ReflectionException |
|
141 | - */ |
|
142 | - public function getParametersFromReflectionConstructor(ReflectionMethod $constructor) |
|
143 | - { |
|
144 | - return $this->getParameters($constructor->getDeclaringClass()); |
|
145 | - } |
|
146 | - |
|
147 | - |
|
148 | - /** |
|
149 | - * @param ReflectionParameter $param |
|
150 | - * @param string $class_name |
|
151 | - * @param string $index |
|
152 | - * @return string|null |
|
153 | - */ |
|
154 | - public function getParameterClassName(ReflectionParameter $param, $class_name, $index) |
|
155 | - { |
|
156 | - if (isset($this->parameter_classes[ $class_name ][ $index ]['param_class_name'])) { |
|
157 | - return $this->parameter_classes[ $class_name ][ $index ]['param_class_name']; |
|
158 | - } |
|
159 | - if (! isset($this->parameter_classes[ $class_name ])) { |
|
160 | - $this->parameter_classes[ $class_name ] = array(); |
|
161 | - } |
|
162 | - if (! isset($this->parameter_classes[ $class_name ][ $index ])) { |
|
163 | - $this->parameter_classes[ $class_name ][ $index ] = array(); |
|
164 | - } |
|
165 | - $this->parameter_classes[ $class_name ][ $index ]['param_class_name'] = $param->getClass() |
|
166 | - ? $param->getClass()->name |
|
167 | - : null; |
|
168 | - return $this->parameter_classes[ $class_name ][ $index ]['param_class_name']; |
|
169 | - } |
|
170 | - |
|
171 | - |
|
172 | - /** |
|
173 | - * @param ReflectionParameter $param |
|
174 | - * @param string $class_name |
|
175 | - * @param string $index |
|
176 | - * @return string|null |
|
177 | - */ |
|
178 | - public function getParameterDefaultValue(ReflectionParameter $param, $class_name, $index) |
|
179 | - { |
|
180 | - if (isset($this->parameter_classes[ $class_name ][ $index ]['param_class_default'])) { |
|
181 | - return $this->parameter_classes[ $class_name ][ $index ]['param_class_default']; |
|
182 | - } |
|
183 | - if (! isset($this->parameter_classes[ $class_name ])) { |
|
184 | - $this->parameter_classes[ $class_name ] = array(); |
|
185 | - } |
|
186 | - if (! isset($this->parameter_classes[ $class_name ][ $index ])) { |
|
187 | - $this->parameter_classes[ $class_name ][ $index ] = array(); |
|
188 | - } |
|
189 | - $this->parameter_classes[ $class_name ][ $index ]['param_class_default'] = $param->isDefaultValueAvailable() |
|
190 | - ? $param->getDefaultValue() |
|
191 | - : null; |
|
192 | - return $this->parameter_classes[ $class_name ][ $index ]['param_class_default']; |
|
193 | - } |
|
194 | - |
|
195 | - |
|
196 | - /** |
|
197 | - * @param string $class_name |
|
198 | - * @return ReflectionProperty[] |
|
199 | - * @throws InvalidDataTypeException |
|
200 | - * @throws ReflectionException |
|
201 | - */ |
|
202 | - public function getProperties($class_name) |
|
203 | - { |
|
204 | - if (! isset($this->properties[ $class_name ])) { |
|
205 | - $reflection_class = $this->getReflectionClass($class_name); |
|
206 | - $this->properties[ $class_name ] = $reflection_class->getProperties(); |
|
207 | - } |
|
208 | - return $this->properties[ $class_name ]; |
|
209 | - } |
|
210 | - |
|
211 | - |
|
212 | - /** |
|
213 | - * @param ReflectionClass $reflection_class |
|
214 | - * @return ReflectionProperty[] |
|
215 | - * @throws InvalidDataTypeException |
|
216 | - * @throws ReflectionException |
|
217 | - */ |
|
218 | - public function getPropertiesFromReflection(ReflectionClass $reflection_class) |
|
219 | - { |
|
220 | - return $this->getProperties($reflection_class->getName()); |
|
221 | - } |
|
222 | - |
|
223 | - |
|
224 | - /** |
|
225 | - * @param string $class_name |
|
226 | - * @return ReflectionMethod[] |
|
227 | - * @throws InvalidDataTypeException |
|
228 | - * @throws ReflectionException |
|
229 | - */ |
|
230 | - public function getMethods($class_name) |
|
231 | - { |
|
232 | - if (! isset($this->methods[ $class_name ])) { |
|
233 | - $reflection_class = $this->getReflectionClass($class_name); |
|
234 | - $this->methods[ $class_name ] = $reflection_class->getMethods(); |
|
235 | - } |
|
236 | - return $this->methods[ $class_name ]; |
|
237 | - } |
|
238 | - |
|
239 | - |
|
240 | - /** |
|
241 | - * @param ReflectionClass $reflection_class ) |
|
242 | - * @return ReflectionMethod[] |
|
243 | - * @throws InvalidDataTypeException |
|
244 | - * @throws ReflectionException |
|
245 | - */ |
|
246 | - public function getMethodsFromReflection(ReflectionClass $reflection_class) |
|
247 | - { |
|
248 | - return $this->getMethods($reflection_class->getName()); |
|
249 | - } |
|
28 | + /** |
|
29 | + * @var ReflectionClass[] $classes |
|
30 | + */ |
|
31 | + private $classes = array(); |
|
32 | + |
|
33 | + /** |
|
34 | + * @var ReflectionMethod[] $constructors |
|
35 | + */ |
|
36 | + private $constructors = array(); |
|
37 | + |
|
38 | + /** |
|
39 | + * @var ReflectionParameter[][] $parameters |
|
40 | + */ |
|
41 | + private $parameters = array(); |
|
42 | + |
|
43 | + /** |
|
44 | + * @var ReflectionParameter[][] $parameters |
|
45 | + */ |
|
46 | + private $parameter_classes = array(); |
|
47 | + |
|
48 | + /** |
|
49 | + * @var ReflectionProperty[][] $properties |
|
50 | + */ |
|
51 | + private $properties = array(); |
|
52 | + |
|
53 | + /** |
|
54 | + * @var ReflectionMethod[][] $methods |
|
55 | + */ |
|
56 | + private $methods = array(); |
|
57 | + |
|
58 | + |
|
59 | + /** |
|
60 | + * @param string $class_name |
|
61 | + * @return ReflectionClass |
|
62 | + * @throws ReflectionException |
|
63 | + * @throws InvalidDataTypeException |
|
64 | + */ |
|
65 | + public function getReflectionClass($class_name) |
|
66 | + { |
|
67 | + if (! is_string($class_name)) { |
|
68 | + throw new InvalidDataTypeException($class_name, '$class_name', 'string (fully qualified class name)'); |
|
69 | + } |
|
70 | + if (! isset($this->classes[ $class_name ])) { |
|
71 | + $this->classes[ $class_name ] = new ReflectionClass($class_name); |
|
72 | + } |
|
73 | + return $this->classes[ $class_name ]; |
|
74 | + } |
|
75 | + |
|
76 | + |
|
77 | + /** |
|
78 | + * @param string $class_name |
|
79 | + * @return ReflectionMethod |
|
80 | + * @throws InvalidDataTypeException |
|
81 | + * @throws ReflectionException |
|
82 | + */ |
|
83 | + public function getConstructor($class_name) |
|
84 | + { |
|
85 | + if (! is_string($class_name)) { |
|
86 | + throw new InvalidDataTypeException($class_name, '$class_name', 'string (fully qualified class name)'); |
|
87 | + } |
|
88 | + if (! isset($this->constructors[ $class_name ])) { |
|
89 | + $reflection_class = $this->getReflectionClass($class_name); |
|
90 | + $this->constructors[ $class_name ] = $reflection_class->getConstructor(); |
|
91 | + } |
|
92 | + return $this->constructors[ $class_name ]; |
|
93 | + } |
|
94 | + |
|
95 | + |
|
96 | + /** |
|
97 | + * @param ReflectionClass $reflection_class |
|
98 | + * @return ReflectionMethod |
|
99 | + * @throws InvalidDataTypeException |
|
100 | + * @throws ReflectionException |
|
101 | + */ |
|
102 | + public function getConstructorFromReflection(ReflectionClass $reflection_class) |
|
103 | + { |
|
104 | + return $this->getConstructor($reflection_class->getName()); |
|
105 | + } |
|
106 | + |
|
107 | + |
|
108 | + /** |
|
109 | + * @param string $class_name |
|
110 | + * @return ReflectionParameter[] |
|
111 | + * @throws InvalidDataTypeException |
|
112 | + * @throws ReflectionException |
|
113 | + */ |
|
114 | + public function getParameters($class_name) |
|
115 | + { |
|
116 | + if (! isset($this->parameters[ $class_name ])) { |
|
117 | + $constructor = $this->getConstructor($class_name); |
|
118 | + $this->parameters[ $class_name ] = $constructor->getParameters(); |
|
119 | + } |
|
120 | + return $this->parameters[ $class_name ]; |
|
121 | + } |
|
122 | + |
|
123 | + |
|
124 | + /** |
|
125 | + * @param ReflectionClass $reflection_class |
|
126 | + * @return ReflectionParameter[] |
|
127 | + * @throws InvalidDataTypeException |
|
128 | + * @throws ReflectionException |
|
129 | + */ |
|
130 | + public function getParametersFromReflection(ReflectionClass $reflection_class) |
|
131 | + { |
|
132 | + return $this->getParameters($reflection_class->getName()); |
|
133 | + } |
|
134 | + |
|
135 | + |
|
136 | + /** |
|
137 | + * @param ReflectionMethod $constructor |
|
138 | + * @return ReflectionParameter[] |
|
139 | + * @throws InvalidDataTypeException |
|
140 | + * @throws ReflectionException |
|
141 | + */ |
|
142 | + public function getParametersFromReflectionConstructor(ReflectionMethod $constructor) |
|
143 | + { |
|
144 | + return $this->getParameters($constructor->getDeclaringClass()); |
|
145 | + } |
|
146 | + |
|
147 | + |
|
148 | + /** |
|
149 | + * @param ReflectionParameter $param |
|
150 | + * @param string $class_name |
|
151 | + * @param string $index |
|
152 | + * @return string|null |
|
153 | + */ |
|
154 | + public function getParameterClassName(ReflectionParameter $param, $class_name, $index) |
|
155 | + { |
|
156 | + if (isset($this->parameter_classes[ $class_name ][ $index ]['param_class_name'])) { |
|
157 | + return $this->parameter_classes[ $class_name ][ $index ]['param_class_name']; |
|
158 | + } |
|
159 | + if (! isset($this->parameter_classes[ $class_name ])) { |
|
160 | + $this->parameter_classes[ $class_name ] = array(); |
|
161 | + } |
|
162 | + if (! isset($this->parameter_classes[ $class_name ][ $index ])) { |
|
163 | + $this->parameter_classes[ $class_name ][ $index ] = array(); |
|
164 | + } |
|
165 | + $this->parameter_classes[ $class_name ][ $index ]['param_class_name'] = $param->getClass() |
|
166 | + ? $param->getClass()->name |
|
167 | + : null; |
|
168 | + return $this->parameter_classes[ $class_name ][ $index ]['param_class_name']; |
|
169 | + } |
|
170 | + |
|
171 | + |
|
172 | + /** |
|
173 | + * @param ReflectionParameter $param |
|
174 | + * @param string $class_name |
|
175 | + * @param string $index |
|
176 | + * @return string|null |
|
177 | + */ |
|
178 | + public function getParameterDefaultValue(ReflectionParameter $param, $class_name, $index) |
|
179 | + { |
|
180 | + if (isset($this->parameter_classes[ $class_name ][ $index ]['param_class_default'])) { |
|
181 | + return $this->parameter_classes[ $class_name ][ $index ]['param_class_default']; |
|
182 | + } |
|
183 | + if (! isset($this->parameter_classes[ $class_name ])) { |
|
184 | + $this->parameter_classes[ $class_name ] = array(); |
|
185 | + } |
|
186 | + if (! isset($this->parameter_classes[ $class_name ][ $index ])) { |
|
187 | + $this->parameter_classes[ $class_name ][ $index ] = array(); |
|
188 | + } |
|
189 | + $this->parameter_classes[ $class_name ][ $index ]['param_class_default'] = $param->isDefaultValueAvailable() |
|
190 | + ? $param->getDefaultValue() |
|
191 | + : null; |
|
192 | + return $this->parameter_classes[ $class_name ][ $index ]['param_class_default']; |
|
193 | + } |
|
194 | + |
|
195 | + |
|
196 | + /** |
|
197 | + * @param string $class_name |
|
198 | + * @return ReflectionProperty[] |
|
199 | + * @throws InvalidDataTypeException |
|
200 | + * @throws ReflectionException |
|
201 | + */ |
|
202 | + public function getProperties($class_name) |
|
203 | + { |
|
204 | + if (! isset($this->properties[ $class_name ])) { |
|
205 | + $reflection_class = $this->getReflectionClass($class_name); |
|
206 | + $this->properties[ $class_name ] = $reflection_class->getProperties(); |
|
207 | + } |
|
208 | + return $this->properties[ $class_name ]; |
|
209 | + } |
|
210 | + |
|
211 | + |
|
212 | + /** |
|
213 | + * @param ReflectionClass $reflection_class |
|
214 | + * @return ReflectionProperty[] |
|
215 | + * @throws InvalidDataTypeException |
|
216 | + * @throws ReflectionException |
|
217 | + */ |
|
218 | + public function getPropertiesFromReflection(ReflectionClass $reflection_class) |
|
219 | + { |
|
220 | + return $this->getProperties($reflection_class->getName()); |
|
221 | + } |
|
222 | + |
|
223 | + |
|
224 | + /** |
|
225 | + * @param string $class_name |
|
226 | + * @return ReflectionMethod[] |
|
227 | + * @throws InvalidDataTypeException |
|
228 | + * @throws ReflectionException |
|
229 | + */ |
|
230 | + public function getMethods($class_name) |
|
231 | + { |
|
232 | + if (! isset($this->methods[ $class_name ])) { |
|
233 | + $reflection_class = $this->getReflectionClass($class_name); |
|
234 | + $this->methods[ $class_name ] = $reflection_class->getMethods(); |
|
235 | + } |
|
236 | + return $this->methods[ $class_name ]; |
|
237 | + } |
|
238 | + |
|
239 | + |
|
240 | + /** |
|
241 | + * @param ReflectionClass $reflection_class ) |
|
242 | + * @return ReflectionMethod[] |
|
243 | + * @throws InvalidDataTypeException |
|
244 | + * @throws ReflectionException |
|
245 | + */ |
|
246 | + public function getMethodsFromReflection(ReflectionClass $reflection_class) |
|
247 | + { |
|
248 | + return $this->getMethods($reflection_class->getName()); |
|
249 | + } |
|
250 | 250 | } |
@@ -64,13 +64,13 @@ discard block |
||
64 | 64 | */ |
65 | 65 | public function getReflectionClass($class_name) |
66 | 66 | { |
67 | - if (! is_string($class_name)) { |
|
67 | + if ( ! is_string($class_name)) { |
|
68 | 68 | throw new InvalidDataTypeException($class_name, '$class_name', 'string (fully qualified class name)'); |
69 | 69 | } |
70 | - if (! isset($this->classes[ $class_name ])) { |
|
71 | - $this->classes[ $class_name ] = new ReflectionClass($class_name); |
|
70 | + if ( ! isset($this->classes[$class_name])) { |
|
71 | + $this->classes[$class_name] = new ReflectionClass($class_name); |
|
72 | 72 | } |
73 | - return $this->classes[ $class_name ]; |
|
73 | + return $this->classes[$class_name]; |
|
74 | 74 | } |
75 | 75 | |
76 | 76 | |
@@ -82,14 +82,14 @@ discard block |
||
82 | 82 | */ |
83 | 83 | public function getConstructor($class_name) |
84 | 84 | { |
85 | - if (! is_string($class_name)) { |
|
85 | + if ( ! is_string($class_name)) { |
|
86 | 86 | throw new InvalidDataTypeException($class_name, '$class_name', 'string (fully qualified class name)'); |
87 | 87 | } |
88 | - if (! isset($this->constructors[ $class_name ])) { |
|
88 | + if ( ! isset($this->constructors[$class_name])) { |
|
89 | 89 | $reflection_class = $this->getReflectionClass($class_name); |
90 | - $this->constructors[ $class_name ] = $reflection_class->getConstructor(); |
|
90 | + $this->constructors[$class_name] = $reflection_class->getConstructor(); |
|
91 | 91 | } |
92 | - return $this->constructors[ $class_name ]; |
|
92 | + return $this->constructors[$class_name]; |
|
93 | 93 | } |
94 | 94 | |
95 | 95 | |
@@ -113,11 +113,11 @@ discard block |
||
113 | 113 | */ |
114 | 114 | public function getParameters($class_name) |
115 | 115 | { |
116 | - if (! isset($this->parameters[ $class_name ])) { |
|
116 | + if ( ! isset($this->parameters[$class_name])) { |
|
117 | 117 | $constructor = $this->getConstructor($class_name); |
118 | - $this->parameters[ $class_name ] = $constructor->getParameters(); |
|
118 | + $this->parameters[$class_name] = $constructor->getParameters(); |
|
119 | 119 | } |
120 | - return $this->parameters[ $class_name ]; |
|
120 | + return $this->parameters[$class_name]; |
|
121 | 121 | } |
122 | 122 | |
123 | 123 | |
@@ -153,19 +153,19 @@ discard block |
||
153 | 153 | */ |
154 | 154 | public function getParameterClassName(ReflectionParameter $param, $class_name, $index) |
155 | 155 | { |
156 | - if (isset($this->parameter_classes[ $class_name ][ $index ]['param_class_name'])) { |
|
157 | - return $this->parameter_classes[ $class_name ][ $index ]['param_class_name']; |
|
156 | + if (isset($this->parameter_classes[$class_name][$index]['param_class_name'])) { |
|
157 | + return $this->parameter_classes[$class_name][$index]['param_class_name']; |
|
158 | 158 | } |
159 | - if (! isset($this->parameter_classes[ $class_name ])) { |
|
160 | - $this->parameter_classes[ $class_name ] = array(); |
|
159 | + if ( ! isset($this->parameter_classes[$class_name])) { |
|
160 | + $this->parameter_classes[$class_name] = array(); |
|
161 | 161 | } |
162 | - if (! isset($this->parameter_classes[ $class_name ][ $index ])) { |
|
163 | - $this->parameter_classes[ $class_name ][ $index ] = array(); |
|
162 | + if ( ! isset($this->parameter_classes[$class_name][$index])) { |
|
163 | + $this->parameter_classes[$class_name][$index] = array(); |
|
164 | 164 | } |
165 | - $this->parameter_classes[ $class_name ][ $index ]['param_class_name'] = $param->getClass() |
|
165 | + $this->parameter_classes[$class_name][$index]['param_class_name'] = $param->getClass() |
|
166 | 166 | ? $param->getClass()->name |
167 | 167 | : null; |
168 | - return $this->parameter_classes[ $class_name ][ $index ]['param_class_name']; |
|
168 | + return $this->parameter_classes[$class_name][$index]['param_class_name']; |
|
169 | 169 | } |
170 | 170 | |
171 | 171 | |
@@ -177,19 +177,19 @@ discard block |
||
177 | 177 | */ |
178 | 178 | public function getParameterDefaultValue(ReflectionParameter $param, $class_name, $index) |
179 | 179 | { |
180 | - if (isset($this->parameter_classes[ $class_name ][ $index ]['param_class_default'])) { |
|
181 | - return $this->parameter_classes[ $class_name ][ $index ]['param_class_default']; |
|
180 | + if (isset($this->parameter_classes[$class_name][$index]['param_class_default'])) { |
|
181 | + return $this->parameter_classes[$class_name][$index]['param_class_default']; |
|
182 | 182 | } |
183 | - if (! isset($this->parameter_classes[ $class_name ])) { |
|
184 | - $this->parameter_classes[ $class_name ] = array(); |
|
183 | + if ( ! isset($this->parameter_classes[$class_name])) { |
|
184 | + $this->parameter_classes[$class_name] = array(); |
|
185 | 185 | } |
186 | - if (! isset($this->parameter_classes[ $class_name ][ $index ])) { |
|
187 | - $this->parameter_classes[ $class_name ][ $index ] = array(); |
|
186 | + if ( ! isset($this->parameter_classes[$class_name][$index])) { |
|
187 | + $this->parameter_classes[$class_name][$index] = array(); |
|
188 | 188 | } |
189 | - $this->parameter_classes[ $class_name ][ $index ]['param_class_default'] = $param->isDefaultValueAvailable() |
|
189 | + $this->parameter_classes[$class_name][$index]['param_class_default'] = $param->isDefaultValueAvailable() |
|
190 | 190 | ? $param->getDefaultValue() |
191 | 191 | : null; |
192 | - return $this->parameter_classes[ $class_name ][ $index ]['param_class_default']; |
|
192 | + return $this->parameter_classes[$class_name][$index]['param_class_default']; |
|
193 | 193 | } |
194 | 194 | |
195 | 195 | |
@@ -201,11 +201,11 @@ discard block |
||
201 | 201 | */ |
202 | 202 | public function getProperties($class_name) |
203 | 203 | { |
204 | - if (! isset($this->properties[ $class_name ])) { |
|
204 | + if ( ! isset($this->properties[$class_name])) { |
|
205 | 205 | $reflection_class = $this->getReflectionClass($class_name); |
206 | - $this->properties[ $class_name ] = $reflection_class->getProperties(); |
|
206 | + $this->properties[$class_name] = $reflection_class->getProperties(); |
|
207 | 207 | } |
208 | - return $this->properties[ $class_name ]; |
|
208 | + return $this->properties[$class_name]; |
|
209 | 209 | } |
210 | 210 | |
211 | 211 | |
@@ -229,11 +229,11 @@ discard block |
||
229 | 229 | */ |
230 | 230 | public function getMethods($class_name) |
231 | 231 | { |
232 | - if (! isset($this->methods[ $class_name ])) { |
|
232 | + if ( ! isset($this->methods[$class_name])) { |
|
233 | 233 | $reflection_class = $this->getReflectionClass($class_name); |
234 | - $this->methods[ $class_name ] = $reflection_class->getMethods(); |
|
234 | + $this->methods[$class_name] = $reflection_class->getMethods(); |
|
235 | 235 | } |
236 | - return $this->methods[ $class_name ]; |
|
236 | + return $this->methods[$class_name]; |
|
237 | 237 | } |
238 | 238 | |
239 | 239 |
@@ -416,7 +416,7 @@ |
||
416 | 416 | * If $expired is set to true, then only line items for expired sessions will be returned. |
417 | 417 | * If $expired is set to false, then only line items for active sessions will be returned. |
418 | 418 | * |
419 | - * @param null $expired |
|
419 | + * @param boolean $expired |
|
420 | 420 | * @return EE_Base_Class[]|EE_Line_Item[] |
421 | 421 | * @throws EE_Error |
422 | 422 | * @throws InvalidArgumentException |
@@ -324,8 +324,8 @@ discard block |
||
324 | 324 | ); |
325 | 325 | $query = $wpdb->prepare( |
326 | 326 | 'DELETE li |
327 | - FROM ' . $this->table() . ' li |
|
328 | - LEFT JOIN ' . EEM_Transaction::instance()->table() . ' t ON li.TXN_ID = t.TXN_ID |
|
327 | + FROM ' . $this->table().' li |
|
328 | + LEFT JOIN ' . EEM_Transaction::instance()->table().' t ON li.TXN_ID = t.TXN_ID |
|
329 | 329 | WHERE t.TXN_ID IS NULL AND li.LIN_timestamp < %s', |
330 | 330 | // use GMT time because that's what TXN_timestamps are in |
331 | 331 | date('Y-m-d H:i:s', time() - $time_to_leave_alone) |
@@ -598,7 +598,7 @@ discard block |
||
598 | 598 | */ |
599 | 599 | public function getTicketLineItemsForExpiredCarts($timestamp = 0) |
600 | 600 | { |
601 | - if (! absint($timestamp)) { |
|
601 | + if ( ! absint($timestamp)) { |
|
602 | 602 | /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */ |
603 | 603 | $session_lifespan = LoaderFactory::getLoader()->getShared( |
604 | 604 | 'EventEspresso\core\domain\values\session\SessionLifespan' |
@@ -28,601 +28,601 @@ |
||
28 | 28 | class EEM_Line_Item extends EEM_Base |
29 | 29 | { |
30 | 30 | |
31 | - /** |
|
32 | - * Tax sub-total is just the total of all the taxes, which should be children |
|
33 | - * of this line item. There should only ever be one tax sub-total, and it should |
|
34 | - * be a direct child of. Its quantity and LIN_unit_price = 1. |
|
35 | - */ |
|
36 | - const type_tax_sub_total = 'tax-sub-total'; |
|
37 | - |
|
38 | - /** |
|
39 | - * Tax line items indicate a tax applied to all the taxable line items. |
|
40 | - * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal |
|
41 | - * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1. |
|
42 | - */ |
|
43 | - const type_tax = 'tax'; |
|
44 | - |
|
45 | - /** |
|
46 | - * Indicating individual items purchased, or discounts or surcharges. |
|
47 | - * The sum of all the regular line items plus the tax items should equal the grand total. |
|
48 | - * Possible children are sub-line-items and cancellations. |
|
49 | - * For flat items, LIN_unit_price * LIN_quantity = LIN_total. Its LIN_total is the sum of all the children |
|
50 | - * LIN_totals. Its LIN_percent = 0. |
|
51 | - * For percent items, its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal (eg 10% = 10, not 0.1). |
|
52 | - * Its LIN_total is LIN_percent / 100 * sum of lower-priority sibling line items. Quantity = 1. |
|
53 | - */ |
|
54 | - const type_line_item = 'line-item'; |
|
55 | - |
|
56 | - /** |
|
57 | - * Line item indicating all the factors that make a single line item. |
|
58 | - * Sub-line items should have NO children line items. |
|
59 | - * For flat sub-items, their quantity should match their parent item, their LIN_unit_price should be this sub-item's |
|
60 | - * contribution towards the price of ONE of their parent items, and its LIN_total should be |
|
61 | - * = LIN_quantity * LIN_unit_price. Its LIN_percent = 0. |
|
62 | - * For percent sub-items, the quantity should be 1, LIN_unit_price should be 0, and its LIN_total should |
|
63 | - * = LIN_percent / 100 * sum of lower-priority sibling line items.. |
|
64 | - */ |
|
65 | - const type_sub_line_item = 'sub-item'; |
|
66 | - |
|
67 | - /** |
|
68 | - * Line item indicating a sub-total (eg total for an event, or pre-tax subtotal). |
|
69 | - * Direct children should be event subtotals. |
|
70 | - * Should have quantity of 1, and a LIN_total and LIN_unit_price of the sum of all its sub-items' LIN_totals. |
|
71 | - */ |
|
72 | - const type_sub_total = 'sub-total'; |
|
73 | - |
|
74 | - /** |
|
75 | - * Line item for the grand total of an order. |
|
76 | - * Its direct children should be tax subtotals and (pre-tax) subtotals, |
|
77 | - * and possibly a regular line item indicating a transaction-wide discount/surcharge. |
|
78 | - * Should have a quantity of 1, a LIN_total and LIN_unit_price of the entire order's amount. |
|
79 | - */ |
|
80 | - const type_total = 'total'; |
|
81 | - |
|
82 | - /** |
|
83 | - * When a line item is cancelled, a sub-line-item of type 'cancellation' |
|
84 | - * should be created, indicating the quantity that were cancelled |
|
85 | - * (because a line item could have a quantity of 1, and its cancellation item |
|
86 | - * could be for 3, indicating that originally 4 were purchased, but 3 have been |
|
87 | - * cancelled, and only one remains). |
|
88 | - * When items are refunded, a cancellation line item should be made, which points |
|
89 | - * to teh payment model object which actually refunded the payment. |
|
90 | - * Cancellations should NOT have any children line items; the should NOT affect |
|
91 | - * any calculations, and are only meant as a record that cancellations have occurred. |
|
92 | - * Their LIN_percent should be 0. |
|
93 | - */ |
|
94 | - const type_cancellation = 'cancellation'; |
|
95 | - |
|
96 | - // various line item object types |
|
97 | - const OBJ_TYPE_EVENT = 'Event'; |
|
98 | - |
|
99 | - const OBJ_TYPE_PRICE = 'Price'; |
|
100 | - |
|
101 | - const OBJ_TYPE_PROMOTION = 'Promotion'; |
|
102 | - |
|
103 | - const OBJ_TYPE_TICKET = 'Ticket'; |
|
104 | - |
|
105 | - const OBJ_TYPE_TRANSACTION = 'Transaction'; |
|
106 | - |
|
107 | - /** |
|
108 | - * @var EEM_Line_Item $_instance |
|
109 | - */ |
|
110 | - protected static $_instance; |
|
111 | - |
|
112 | - |
|
113 | - /** |
|
114 | - * private constructor to prevent direct creation |
|
115 | - * |
|
116 | - * @Constructor |
|
117 | - * @param string $timezone string representing the timezone we want to set for returned Date Time Strings |
|
118 | - * (and any incoming timezone data that gets saved). |
|
119 | - * Note this just sends the timezone info to the date time model field objects. |
|
120 | - * Default is NULL |
|
121 | - * (and will be assumed using the set timezone in the 'timezone_string' wp option) |
|
122 | - * @throws EE_Error |
|
123 | - * @throws InvalidArgumentException |
|
124 | - */ |
|
125 | - protected function __construct($timezone) |
|
126 | - { |
|
127 | - $this->singular_item = esc_html__('Line Item', 'event_espresso'); |
|
128 | - $this->plural_item = esc_html__('Line Items', 'event_espresso'); |
|
129 | - |
|
130 | - $this->_tables = array( |
|
131 | - 'Line_Item' => new EE_Primary_Table('esp_line_item', 'LIN_ID'), |
|
132 | - ); |
|
133 | - $line_items_can_be_for = apply_filters( |
|
134 | - 'FHEE__EEM_Line_Item__line_items_can_be_for', |
|
135 | - array('Ticket', 'Price', 'Event') |
|
136 | - ); |
|
137 | - $this->_fields = array( |
|
138 | - 'Line_Item' => array( |
|
139 | - 'LIN_ID' => new EE_Primary_Key_Int_Field( |
|
140 | - 'LIN_ID', |
|
141 | - esc_html__('ID', 'event_espresso') |
|
142 | - ), |
|
143 | - 'LIN_code' => new EE_Slug_Field( |
|
144 | - 'LIN_code', |
|
145 | - esc_html__('Code for index into Cart', 'event_espresso'), |
|
146 | - true |
|
147 | - ), |
|
148 | - 'TXN_ID' => new EE_Foreign_Key_Int_Field( |
|
149 | - 'TXN_ID', |
|
150 | - esc_html__('Transaction ID', 'event_espresso'), |
|
151 | - true, |
|
152 | - null, |
|
153 | - 'Transaction' |
|
154 | - ), |
|
155 | - 'LIN_name' => new EE_Full_HTML_Field( |
|
156 | - 'LIN_name', |
|
157 | - esc_html__('Line Item Name', 'event_espresso'), |
|
158 | - false, |
|
159 | - '' |
|
160 | - ), |
|
161 | - 'LIN_desc' => new EE_Full_HTML_Field( |
|
162 | - 'LIN_desc', |
|
163 | - esc_html__('Line Item Description', 'event_espresso'), |
|
164 | - true |
|
165 | - ), |
|
166 | - 'LIN_unit_price' => new EE_Money_Field( |
|
167 | - 'LIN_unit_price', |
|
168 | - esc_html__('Unit Price', 'event_espresso'), |
|
169 | - false, |
|
170 | - 0 |
|
171 | - ), |
|
172 | - 'LIN_percent' => new EE_Float_Field( |
|
173 | - 'LIN_percent', |
|
174 | - esc_html__('Percent', 'event_espresso'), |
|
175 | - false, |
|
176 | - 0 |
|
177 | - ), |
|
178 | - 'LIN_is_taxable' => new EE_Boolean_Field( |
|
179 | - 'LIN_is_taxable', |
|
180 | - esc_html__('Taxable', 'event_espresso'), |
|
181 | - false, |
|
182 | - false |
|
183 | - ), |
|
184 | - 'LIN_order' => new EE_Integer_Field( |
|
185 | - 'LIN_order', |
|
186 | - esc_html__('Order of Application towards total of parent', 'event_espresso'), |
|
187 | - false, |
|
188 | - 1 |
|
189 | - ), |
|
190 | - 'LIN_total' => new EE_Money_Field( |
|
191 | - 'LIN_total', |
|
192 | - esc_html__('Total (unit price x quantity)', 'event_espresso'), |
|
193 | - false, |
|
194 | - 0 |
|
195 | - ), |
|
196 | - 'LIN_quantity' => new EE_Integer_Field( |
|
197 | - 'LIN_quantity', |
|
198 | - esc_html__('Quantity', 'event_espresso'), |
|
199 | - true, |
|
200 | - 1 |
|
201 | - ), |
|
202 | - 'LIN_parent' => new EE_Integer_Field( |
|
203 | - 'LIN_parent', |
|
204 | - esc_html__("Parent ID (this item goes towards that Line Item's total)", 'event_espresso'), |
|
205 | - true, |
|
206 | - null |
|
207 | - ), |
|
208 | - 'LIN_type' => new EE_Enum_Text_Field( |
|
209 | - 'LIN_type', |
|
210 | - esc_html__('Type', 'event_espresso'), |
|
211 | - false, |
|
212 | - 'line-item', |
|
213 | - array( |
|
214 | - self::type_line_item => esc_html__('Line Item', 'event_espresso'), |
|
215 | - self::type_sub_line_item => esc_html__('Sub-Item', 'event_espresso'), |
|
216 | - self::type_sub_total => esc_html__('Subtotal', 'event_espresso'), |
|
217 | - self::type_tax_sub_total => esc_html__('Tax Subtotal', 'event_espresso'), |
|
218 | - self::type_tax => esc_html__('Tax', 'event_espresso'), |
|
219 | - self::type_total => esc_html__('Total', 'event_espresso'), |
|
220 | - self::type_cancellation => esc_html__('Cancellation', 'event_espresso'), |
|
221 | - ) |
|
222 | - ), |
|
223 | - 'OBJ_ID' => new EE_Foreign_Key_Int_Field( |
|
224 | - 'OBJ_ID', |
|
225 | - esc_html__('ID of Item purchased.', 'event_espresso'), |
|
226 | - true, |
|
227 | - null, |
|
228 | - $line_items_can_be_for |
|
229 | - ), |
|
230 | - 'OBJ_type' => new EE_Any_Foreign_Model_Name_Field( |
|
231 | - 'OBJ_type', |
|
232 | - esc_html__('Model Name this Line Item is for', 'event_espresso'), |
|
233 | - true, |
|
234 | - null, |
|
235 | - $line_items_can_be_for |
|
236 | - ), |
|
237 | - 'LIN_timestamp' => new EE_Datetime_Field( |
|
238 | - 'LIN_timestamp', |
|
239 | - esc_html__('When the line item was created', 'event_espresso'), |
|
240 | - false, |
|
241 | - EE_Datetime_Field::now, |
|
242 | - $timezone |
|
243 | - ), |
|
244 | - ), |
|
245 | - ); |
|
246 | - $this->_model_relations = array( |
|
247 | - 'Transaction' => new EE_Belongs_To_Relation(), |
|
248 | - 'Ticket' => new EE_Belongs_To_Any_Relation(), |
|
249 | - 'Price' => new EE_Belongs_To_Any_Relation(), |
|
250 | - 'Event' => new EE_Belongs_To_Any_Relation(), |
|
251 | - ); |
|
252 | - $this->_model_chain_to_wp_user = 'Transaction.Registration.Event'; |
|
253 | - $this->_caps_slug = 'transactions'; |
|
254 | - parent::__construct($timezone); |
|
255 | - } |
|
256 | - |
|
257 | - |
|
258 | - /** |
|
259 | - * Gets all the line items for this transaction of the given type |
|
260 | - * |
|
261 | - * @param string $line_item_type like one of EEM_Line_Item::type_* |
|
262 | - * @param EE_Transaction|int $transaction |
|
263 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
264 | - * @throws EE_Error |
|
265 | - * @throws InvalidArgumentException |
|
266 | - * @throws InvalidDataTypeException |
|
267 | - * @throws InvalidInterfaceException |
|
268 | - */ |
|
269 | - public function get_all_of_type_for_transaction($line_item_type, $transaction) |
|
270 | - { |
|
271 | - $transaction = EEM_Transaction::instance()->ensure_is_ID($transaction); |
|
272 | - return $this->get_all(array( |
|
273 | - array( |
|
274 | - 'LIN_type' => $line_item_type, |
|
275 | - 'TXN_ID' => $transaction, |
|
276 | - ), |
|
277 | - )); |
|
278 | - } |
|
279 | - |
|
280 | - |
|
281 | - /** |
|
282 | - * Gets all line items unrelated to tickets that are normal line items |
|
283 | - * (eg shipping, promotions, and miscellaneous other stuff should probably fit in this category) |
|
284 | - * |
|
285 | - * @param EE_Transaction|int $transaction |
|
286 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
287 | - * @throws EE_Error |
|
288 | - * @throws InvalidArgumentException |
|
289 | - * @throws InvalidDataTypeException |
|
290 | - * @throws InvalidInterfaceException |
|
291 | - */ |
|
292 | - public function get_all_non_ticket_line_items_for_transaction($transaction) |
|
293 | - { |
|
294 | - $transaction = EEM_Transaction::instance()->ensure_is_ID($transaction); |
|
295 | - return $this->get_all(array( |
|
296 | - array( |
|
297 | - 'LIN_type' => self::type_line_item, |
|
298 | - 'TXN_ID' => $transaction, |
|
299 | - 'OR' => array( |
|
300 | - 'OBJ_type*notticket' => array('!=', EEM_Line_Item::OBJ_TYPE_TICKET), |
|
301 | - 'OBJ_type*null' => array('IS_NULL'), |
|
302 | - ), |
|
303 | - ), |
|
304 | - )); |
|
305 | - } |
|
306 | - |
|
307 | - |
|
308 | - /** |
|
309 | - * Deletes line items with no transaction who have passed the transaction cutoff time. |
|
310 | - * This needs to be very efficient |
|
311 | - * because if there are spam bots afoot there will be LOTS of line items |
|
312 | - * |
|
313 | - * @return int count of how many deleted |
|
314 | - * @throws EE_Error |
|
315 | - * @throws InvalidArgumentException |
|
316 | - * @throws InvalidDataTypeException |
|
317 | - * @throws InvalidInterfaceException |
|
318 | - */ |
|
319 | - public function delete_line_items_with_no_transaction() |
|
320 | - { |
|
321 | - /** @type WPDB $wpdb */ |
|
322 | - global $wpdb; |
|
323 | - $time_to_leave_alone = apply_filters( |
|
324 | - 'FHEE__EEM_Line_Item__delete_line_items_with_no_transaction__time_to_leave_alone', |
|
325 | - WEEK_IN_SECONDS |
|
326 | - ); |
|
327 | - $query = $wpdb->prepare( |
|
328 | - 'DELETE li |
|
31 | + /** |
|
32 | + * Tax sub-total is just the total of all the taxes, which should be children |
|
33 | + * of this line item. There should only ever be one tax sub-total, and it should |
|
34 | + * be a direct child of. Its quantity and LIN_unit_price = 1. |
|
35 | + */ |
|
36 | + const type_tax_sub_total = 'tax-sub-total'; |
|
37 | + |
|
38 | + /** |
|
39 | + * Tax line items indicate a tax applied to all the taxable line items. |
|
40 | + * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal |
|
41 | + * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1. |
|
42 | + */ |
|
43 | + const type_tax = 'tax'; |
|
44 | + |
|
45 | + /** |
|
46 | + * Indicating individual items purchased, or discounts or surcharges. |
|
47 | + * The sum of all the regular line items plus the tax items should equal the grand total. |
|
48 | + * Possible children are sub-line-items and cancellations. |
|
49 | + * For flat items, LIN_unit_price * LIN_quantity = LIN_total. Its LIN_total is the sum of all the children |
|
50 | + * LIN_totals. Its LIN_percent = 0. |
|
51 | + * For percent items, its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal (eg 10% = 10, not 0.1). |
|
52 | + * Its LIN_total is LIN_percent / 100 * sum of lower-priority sibling line items. Quantity = 1. |
|
53 | + */ |
|
54 | + const type_line_item = 'line-item'; |
|
55 | + |
|
56 | + /** |
|
57 | + * Line item indicating all the factors that make a single line item. |
|
58 | + * Sub-line items should have NO children line items. |
|
59 | + * For flat sub-items, their quantity should match their parent item, their LIN_unit_price should be this sub-item's |
|
60 | + * contribution towards the price of ONE of their parent items, and its LIN_total should be |
|
61 | + * = LIN_quantity * LIN_unit_price. Its LIN_percent = 0. |
|
62 | + * For percent sub-items, the quantity should be 1, LIN_unit_price should be 0, and its LIN_total should |
|
63 | + * = LIN_percent / 100 * sum of lower-priority sibling line items.. |
|
64 | + */ |
|
65 | + const type_sub_line_item = 'sub-item'; |
|
66 | + |
|
67 | + /** |
|
68 | + * Line item indicating a sub-total (eg total for an event, or pre-tax subtotal). |
|
69 | + * Direct children should be event subtotals. |
|
70 | + * Should have quantity of 1, and a LIN_total and LIN_unit_price of the sum of all its sub-items' LIN_totals. |
|
71 | + */ |
|
72 | + const type_sub_total = 'sub-total'; |
|
73 | + |
|
74 | + /** |
|
75 | + * Line item for the grand total of an order. |
|
76 | + * Its direct children should be tax subtotals and (pre-tax) subtotals, |
|
77 | + * and possibly a regular line item indicating a transaction-wide discount/surcharge. |
|
78 | + * Should have a quantity of 1, a LIN_total and LIN_unit_price of the entire order's amount. |
|
79 | + */ |
|
80 | + const type_total = 'total'; |
|
81 | + |
|
82 | + /** |
|
83 | + * When a line item is cancelled, a sub-line-item of type 'cancellation' |
|
84 | + * should be created, indicating the quantity that were cancelled |
|
85 | + * (because a line item could have a quantity of 1, and its cancellation item |
|
86 | + * could be for 3, indicating that originally 4 were purchased, but 3 have been |
|
87 | + * cancelled, and only one remains). |
|
88 | + * When items are refunded, a cancellation line item should be made, which points |
|
89 | + * to teh payment model object which actually refunded the payment. |
|
90 | + * Cancellations should NOT have any children line items; the should NOT affect |
|
91 | + * any calculations, and are only meant as a record that cancellations have occurred. |
|
92 | + * Their LIN_percent should be 0. |
|
93 | + */ |
|
94 | + const type_cancellation = 'cancellation'; |
|
95 | + |
|
96 | + // various line item object types |
|
97 | + const OBJ_TYPE_EVENT = 'Event'; |
|
98 | + |
|
99 | + const OBJ_TYPE_PRICE = 'Price'; |
|
100 | + |
|
101 | + const OBJ_TYPE_PROMOTION = 'Promotion'; |
|
102 | + |
|
103 | + const OBJ_TYPE_TICKET = 'Ticket'; |
|
104 | + |
|
105 | + const OBJ_TYPE_TRANSACTION = 'Transaction'; |
|
106 | + |
|
107 | + /** |
|
108 | + * @var EEM_Line_Item $_instance |
|
109 | + */ |
|
110 | + protected static $_instance; |
|
111 | + |
|
112 | + |
|
113 | + /** |
|
114 | + * private constructor to prevent direct creation |
|
115 | + * |
|
116 | + * @Constructor |
|
117 | + * @param string $timezone string representing the timezone we want to set for returned Date Time Strings |
|
118 | + * (and any incoming timezone data that gets saved). |
|
119 | + * Note this just sends the timezone info to the date time model field objects. |
|
120 | + * Default is NULL |
|
121 | + * (and will be assumed using the set timezone in the 'timezone_string' wp option) |
|
122 | + * @throws EE_Error |
|
123 | + * @throws InvalidArgumentException |
|
124 | + */ |
|
125 | + protected function __construct($timezone) |
|
126 | + { |
|
127 | + $this->singular_item = esc_html__('Line Item', 'event_espresso'); |
|
128 | + $this->plural_item = esc_html__('Line Items', 'event_espresso'); |
|
129 | + |
|
130 | + $this->_tables = array( |
|
131 | + 'Line_Item' => new EE_Primary_Table('esp_line_item', 'LIN_ID'), |
|
132 | + ); |
|
133 | + $line_items_can_be_for = apply_filters( |
|
134 | + 'FHEE__EEM_Line_Item__line_items_can_be_for', |
|
135 | + array('Ticket', 'Price', 'Event') |
|
136 | + ); |
|
137 | + $this->_fields = array( |
|
138 | + 'Line_Item' => array( |
|
139 | + 'LIN_ID' => new EE_Primary_Key_Int_Field( |
|
140 | + 'LIN_ID', |
|
141 | + esc_html__('ID', 'event_espresso') |
|
142 | + ), |
|
143 | + 'LIN_code' => new EE_Slug_Field( |
|
144 | + 'LIN_code', |
|
145 | + esc_html__('Code for index into Cart', 'event_espresso'), |
|
146 | + true |
|
147 | + ), |
|
148 | + 'TXN_ID' => new EE_Foreign_Key_Int_Field( |
|
149 | + 'TXN_ID', |
|
150 | + esc_html__('Transaction ID', 'event_espresso'), |
|
151 | + true, |
|
152 | + null, |
|
153 | + 'Transaction' |
|
154 | + ), |
|
155 | + 'LIN_name' => new EE_Full_HTML_Field( |
|
156 | + 'LIN_name', |
|
157 | + esc_html__('Line Item Name', 'event_espresso'), |
|
158 | + false, |
|
159 | + '' |
|
160 | + ), |
|
161 | + 'LIN_desc' => new EE_Full_HTML_Field( |
|
162 | + 'LIN_desc', |
|
163 | + esc_html__('Line Item Description', 'event_espresso'), |
|
164 | + true |
|
165 | + ), |
|
166 | + 'LIN_unit_price' => new EE_Money_Field( |
|
167 | + 'LIN_unit_price', |
|
168 | + esc_html__('Unit Price', 'event_espresso'), |
|
169 | + false, |
|
170 | + 0 |
|
171 | + ), |
|
172 | + 'LIN_percent' => new EE_Float_Field( |
|
173 | + 'LIN_percent', |
|
174 | + esc_html__('Percent', 'event_espresso'), |
|
175 | + false, |
|
176 | + 0 |
|
177 | + ), |
|
178 | + 'LIN_is_taxable' => new EE_Boolean_Field( |
|
179 | + 'LIN_is_taxable', |
|
180 | + esc_html__('Taxable', 'event_espresso'), |
|
181 | + false, |
|
182 | + false |
|
183 | + ), |
|
184 | + 'LIN_order' => new EE_Integer_Field( |
|
185 | + 'LIN_order', |
|
186 | + esc_html__('Order of Application towards total of parent', 'event_espresso'), |
|
187 | + false, |
|
188 | + 1 |
|
189 | + ), |
|
190 | + 'LIN_total' => new EE_Money_Field( |
|
191 | + 'LIN_total', |
|
192 | + esc_html__('Total (unit price x quantity)', 'event_espresso'), |
|
193 | + false, |
|
194 | + 0 |
|
195 | + ), |
|
196 | + 'LIN_quantity' => new EE_Integer_Field( |
|
197 | + 'LIN_quantity', |
|
198 | + esc_html__('Quantity', 'event_espresso'), |
|
199 | + true, |
|
200 | + 1 |
|
201 | + ), |
|
202 | + 'LIN_parent' => new EE_Integer_Field( |
|
203 | + 'LIN_parent', |
|
204 | + esc_html__("Parent ID (this item goes towards that Line Item's total)", 'event_espresso'), |
|
205 | + true, |
|
206 | + null |
|
207 | + ), |
|
208 | + 'LIN_type' => new EE_Enum_Text_Field( |
|
209 | + 'LIN_type', |
|
210 | + esc_html__('Type', 'event_espresso'), |
|
211 | + false, |
|
212 | + 'line-item', |
|
213 | + array( |
|
214 | + self::type_line_item => esc_html__('Line Item', 'event_espresso'), |
|
215 | + self::type_sub_line_item => esc_html__('Sub-Item', 'event_espresso'), |
|
216 | + self::type_sub_total => esc_html__('Subtotal', 'event_espresso'), |
|
217 | + self::type_tax_sub_total => esc_html__('Tax Subtotal', 'event_espresso'), |
|
218 | + self::type_tax => esc_html__('Tax', 'event_espresso'), |
|
219 | + self::type_total => esc_html__('Total', 'event_espresso'), |
|
220 | + self::type_cancellation => esc_html__('Cancellation', 'event_espresso'), |
|
221 | + ) |
|
222 | + ), |
|
223 | + 'OBJ_ID' => new EE_Foreign_Key_Int_Field( |
|
224 | + 'OBJ_ID', |
|
225 | + esc_html__('ID of Item purchased.', 'event_espresso'), |
|
226 | + true, |
|
227 | + null, |
|
228 | + $line_items_can_be_for |
|
229 | + ), |
|
230 | + 'OBJ_type' => new EE_Any_Foreign_Model_Name_Field( |
|
231 | + 'OBJ_type', |
|
232 | + esc_html__('Model Name this Line Item is for', 'event_espresso'), |
|
233 | + true, |
|
234 | + null, |
|
235 | + $line_items_can_be_for |
|
236 | + ), |
|
237 | + 'LIN_timestamp' => new EE_Datetime_Field( |
|
238 | + 'LIN_timestamp', |
|
239 | + esc_html__('When the line item was created', 'event_espresso'), |
|
240 | + false, |
|
241 | + EE_Datetime_Field::now, |
|
242 | + $timezone |
|
243 | + ), |
|
244 | + ), |
|
245 | + ); |
|
246 | + $this->_model_relations = array( |
|
247 | + 'Transaction' => new EE_Belongs_To_Relation(), |
|
248 | + 'Ticket' => new EE_Belongs_To_Any_Relation(), |
|
249 | + 'Price' => new EE_Belongs_To_Any_Relation(), |
|
250 | + 'Event' => new EE_Belongs_To_Any_Relation(), |
|
251 | + ); |
|
252 | + $this->_model_chain_to_wp_user = 'Transaction.Registration.Event'; |
|
253 | + $this->_caps_slug = 'transactions'; |
|
254 | + parent::__construct($timezone); |
|
255 | + } |
|
256 | + |
|
257 | + |
|
258 | + /** |
|
259 | + * Gets all the line items for this transaction of the given type |
|
260 | + * |
|
261 | + * @param string $line_item_type like one of EEM_Line_Item::type_* |
|
262 | + * @param EE_Transaction|int $transaction |
|
263 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
264 | + * @throws EE_Error |
|
265 | + * @throws InvalidArgumentException |
|
266 | + * @throws InvalidDataTypeException |
|
267 | + * @throws InvalidInterfaceException |
|
268 | + */ |
|
269 | + public function get_all_of_type_for_transaction($line_item_type, $transaction) |
|
270 | + { |
|
271 | + $transaction = EEM_Transaction::instance()->ensure_is_ID($transaction); |
|
272 | + return $this->get_all(array( |
|
273 | + array( |
|
274 | + 'LIN_type' => $line_item_type, |
|
275 | + 'TXN_ID' => $transaction, |
|
276 | + ), |
|
277 | + )); |
|
278 | + } |
|
279 | + |
|
280 | + |
|
281 | + /** |
|
282 | + * Gets all line items unrelated to tickets that are normal line items |
|
283 | + * (eg shipping, promotions, and miscellaneous other stuff should probably fit in this category) |
|
284 | + * |
|
285 | + * @param EE_Transaction|int $transaction |
|
286 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
287 | + * @throws EE_Error |
|
288 | + * @throws InvalidArgumentException |
|
289 | + * @throws InvalidDataTypeException |
|
290 | + * @throws InvalidInterfaceException |
|
291 | + */ |
|
292 | + public function get_all_non_ticket_line_items_for_transaction($transaction) |
|
293 | + { |
|
294 | + $transaction = EEM_Transaction::instance()->ensure_is_ID($transaction); |
|
295 | + return $this->get_all(array( |
|
296 | + array( |
|
297 | + 'LIN_type' => self::type_line_item, |
|
298 | + 'TXN_ID' => $transaction, |
|
299 | + 'OR' => array( |
|
300 | + 'OBJ_type*notticket' => array('!=', EEM_Line_Item::OBJ_TYPE_TICKET), |
|
301 | + 'OBJ_type*null' => array('IS_NULL'), |
|
302 | + ), |
|
303 | + ), |
|
304 | + )); |
|
305 | + } |
|
306 | + |
|
307 | + |
|
308 | + /** |
|
309 | + * Deletes line items with no transaction who have passed the transaction cutoff time. |
|
310 | + * This needs to be very efficient |
|
311 | + * because if there are spam bots afoot there will be LOTS of line items |
|
312 | + * |
|
313 | + * @return int count of how many deleted |
|
314 | + * @throws EE_Error |
|
315 | + * @throws InvalidArgumentException |
|
316 | + * @throws InvalidDataTypeException |
|
317 | + * @throws InvalidInterfaceException |
|
318 | + */ |
|
319 | + public function delete_line_items_with_no_transaction() |
|
320 | + { |
|
321 | + /** @type WPDB $wpdb */ |
|
322 | + global $wpdb; |
|
323 | + $time_to_leave_alone = apply_filters( |
|
324 | + 'FHEE__EEM_Line_Item__delete_line_items_with_no_transaction__time_to_leave_alone', |
|
325 | + WEEK_IN_SECONDS |
|
326 | + ); |
|
327 | + $query = $wpdb->prepare( |
|
328 | + 'DELETE li |
|
329 | 329 | FROM ' . $this->table() . ' li |
330 | 330 | LEFT JOIN ' . EEM_Transaction::instance()->table() . ' t ON li.TXN_ID = t.TXN_ID |
331 | 331 | WHERE t.TXN_ID IS NULL AND li.LIN_timestamp < %s', |
332 | - // use GMT time because that's what TXN_timestamps are in |
|
333 | - date('Y-m-d H:i:s', time() - $time_to_leave_alone) |
|
334 | - ); |
|
335 | - return $wpdb->query($query); |
|
336 | - } |
|
337 | - |
|
338 | - |
|
339 | - /** |
|
340 | - * get_line_item_for_transaction_object |
|
341 | - * Gets a transaction's line item record for a specific object such as a EE_Event or EE_Ticket |
|
342 | - * |
|
343 | - * @param int $TXN_ID |
|
344 | - * @param EE_Base_Class $object |
|
345 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
346 | - * @throws EE_Error |
|
347 | - * @throws InvalidArgumentException |
|
348 | - * @throws InvalidDataTypeException |
|
349 | - * @throws InvalidInterfaceException |
|
350 | - * @throws ReflectionException |
|
351 | - */ |
|
352 | - public function get_line_item_for_transaction_object($TXN_ID, EE_Base_Class $object) |
|
353 | - { |
|
354 | - return $this->get_all(array( |
|
355 | - array( |
|
356 | - 'TXN_ID' => $TXN_ID, |
|
357 | - 'OBJ_type' => str_replace('EE_', '', get_class($object)), |
|
358 | - 'OBJ_ID' => $object->ID(), |
|
359 | - ), |
|
360 | - )); |
|
361 | - } |
|
362 | - |
|
363 | - |
|
364 | - /** |
|
365 | - * get_object_line_items_for_transaction |
|
366 | - * Gets all of the the object line items for a transaction, based on an object type plus an array of object IDs |
|
367 | - * |
|
368 | - * @param int $TXN_ID |
|
369 | - * @param string $OBJ_type |
|
370 | - * @param array $OBJ_IDs |
|
371 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
372 | - * @throws EE_Error |
|
373 | - */ |
|
374 | - public function get_object_line_items_for_transaction( |
|
375 | - $TXN_ID, |
|
376 | - $OBJ_type = EEM_Line_Item::OBJ_TYPE_EVENT, |
|
377 | - $OBJ_IDs = array() |
|
378 | - ) { |
|
379 | - $query_params = array( |
|
380 | - 'OBJ_type' => $OBJ_type, |
|
381 | - // if incoming $OBJ_IDs is an array, then make sure it is formatted correctly for the query |
|
382 | - 'OBJ_ID' => is_array($OBJ_IDs) && ! isset($OBJ_IDs['IN']) ? array('IN', $OBJ_IDs) : $OBJ_IDs, |
|
383 | - ); |
|
384 | - if ($TXN_ID) { |
|
385 | - $query_params['TXN_ID'] = $TXN_ID; |
|
386 | - } |
|
387 | - return $this->get_all(array($query_params)); |
|
388 | - } |
|
389 | - |
|
390 | - |
|
391 | - /** |
|
392 | - * get_all_ticket_line_items_for_transaction |
|
393 | - * |
|
394 | - * @param EE_Transaction $transaction |
|
395 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
396 | - * @throws EE_Error |
|
397 | - * @throws InvalidArgumentException |
|
398 | - * @throws InvalidDataTypeException |
|
399 | - * @throws InvalidInterfaceException |
|
400 | - * @throws ReflectionException |
|
401 | - */ |
|
402 | - public function get_all_ticket_line_items_for_transaction(EE_Transaction $transaction) |
|
403 | - { |
|
404 | - return $this->get_all(array( |
|
405 | - array( |
|
406 | - 'TXN_ID' => $transaction->ID(), |
|
407 | - 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET, |
|
408 | - ), |
|
409 | - )); |
|
410 | - } |
|
411 | - |
|
412 | - |
|
413 | - /** |
|
414 | - * get_ticket_line_item_for_transaction |
|
415 | - * |
|
416 | - * @param int $TXN_ID |
|
417 | - * @param int $TKT_ID |
|
418 | - * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL |
|
419 | - * @throws EE_Error |
|
420 | - * @throws InvalidArgumentException |
|
421 | - * @throws InvalidDataTypeException |
|
422 | - * @throws InvalidInterfaceException |
|
423 | - */ |
|
424 | - public function get_ticket_line_item_for_transaction($TXN_ID, $TKT_ID) |
|
425 | - { |
|
426 | - return $this->get_one(array( |
|
427 | - array( |
|
428 | - 'TXN_ID' => EEM_Transaction::instance()->ensure_is_ID($TXN_ID), |
|
429 | - 'OBJ_ID' => $TKT_ID, |
|
430 | - 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET, |
|
431 | - ), |
|
432 | - )); |
|
433 | - } |
|
434 | - |
|
435 | - |
|
436 | - /** |
|
437 | - * get_existing_promotion_line_item |
|
438 | - * searches the cart for existing line items for the specified promotion |
|
439 | - * |
|
440 | - * @since 1.0.0 |
|
441 | - * @param EE_Line_Item $parent_line_item |
|
442 | - * @param EE_Promotion $promotion |
|
443 | - * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL |
|
444 | - * @throws EE_Error |
|
445 | - * @throws InvalidArgumentException |
|
446 | - * @throws InvalidDataTypeException |
|
447 | - * @throws InvalidInterfaceException |
|
448 | - * @throws ReflectionException |
|
449 | - */ |
|
450 | - public function get_existing_promotion_line_item(EE_Line_Item $parent_line_item, EE_Promotion $promotion) |
|
451 | - { |
|
452 | - return $this->get_one(array( |
|
453 | - array( |
|
454 | - 'TXN_ID' => $parent_line_item->TXN_ID(), |
|
455 | - 'LIN_parent' => $parent_line_item->ID(), |
|
456 | - 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_PROMOTION, |
|
457 | - 'OBJ_ID' => $promotion->ID(), |
|
458 | - ), |
|
459 | - )); |
|
460 | - } |
|
461 | - |
|
462 | - |
|
463 | - /** |
|
464 | - * get_all_promotion_line_items |
|
465 | - * searches the cart for any and all existing promotion line items |
|
466 | - * |
|
467 | - * @since 1.0.0 |
|
468 | - * @param EE_Line_Item $parent_line_item |
|
469 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
470 | - * @throws EE_Error |
|
471 | - * @throws InvalidArgumentException |
|
472 | - * @throws InvalidDataTypeException |
|
473 | - * @throws InvalidInterfaceException |
|
474 | - * @throws ReflectionException |
|
475 | - */ |
|
476 | - public function get_all_promotion_line_items(EE_Line_Item $parent_line_item) |
|
477 | - { |
|
478 | - return $this->get_all(array( |
|
479 | - array( |
|
480 | - 'TXN_ID' => $parent_line_item->TXN_ID(), |
|
481 | - 'LIN_parent' => $parent_line_item->ID(), |
|
482 | - 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_PROMOTION, |
|
483 | - ), |
|
484 | - )); |
|
485 | - } |
|
486 | - |
|
487 | - |
|
488 | - /** |
|
489 | - * Gets the registration's corresponding line item. |
|
490 | - * Note: basically does NOT support having multiple line items for a single ticket, |
|
491 | - * which would happen if some of the registrations had a price modifier while others didn't. |
|
492 | - * In order to support that, we'd probably need a LIN_ID on registrations or something. |
|
493 | - * |
|
494 | - * @param EE_Registration $registration |
|
495 | - * @return EE_Base_Class|EE_Line_ITem|EE_Soft_Delete_Base_Class|NULL |
|
496 | - * @throws EE_Error |
|
497 | - */ |
|
498 | - public function get_line_item_for_registration(EE_Registration $registration) |
|
499 | - { |
|
500 | - return $this->get_one($this->line_item_for_registration_query_params($registration)); |
|
501 | - } |
|
502 | - |
|
503 | - |
|
504 | - /** |
|
505 | - * Gets the query params used to retrieve a specific line item for the given registration |
|
506 | - * |
|
507 | - * @param EE_Registration $registration |
|
508 | - * @param array $original_query_params any extra query params you'd like to be merged with |
|
509 | - * @return array @see |
|
510 | - * https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
511 | - * @throws EE_Error |
|
512 | - */ |
|
513 | - public function line_item_for_registration_query_params( |
|
514 | - EE_Registration $registration, |
|
515 | - $original_query_params = array() |
|
516 | - ) { |
|
517 | - return array_replace_recursive($original_query_params, array( |
|
518 | - array( |
|
519 | - 'OBJ_ID' => $registration->ticket_ID(), |
|
520 | - 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET, |
|
521 | - 'TXN_ID' => $registration->transaction_ID(), |
|
522 | - ), |
|
523 | - )); |
|
524 | - } |
|
525 | - |
|
526 | - |
|
527 | - /** |
|
528 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
529 | - * @throws InvalidInterfaceException |
|
530 | - * @throws InvalidDataTypeException |
|
531 | - * @throws EE_Error |
|
532 | - * @throws InvalidArgumentException |
|
533 | - */ |
|
534 | - public function get_total_line_items_with_no_transaction() |
|
535 | - { |
|
536 | - return $this->get_total_line_items_for_carts(); |
|
537 | - } |
|
538 | - |
|
539 | - |
|
540 | - /** |
|
541 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
542 | - * @throws InvalidInterfaceException |
|
543 | - * @throws InvalidDataTypeException |
|
544 | - * @throws EE_Error |
|
545 | - * @throws InvalidArgumentException |
|
546 | - */ |
|
547 | - public function get_total_line_items_for_active_carts() |
|
548 | - { |
|
549 | - return $this->get_total_line_items_for_carts(false); |
|
550 | - } |
|
551 | - |
|
552 | - |
|
553 | - /** |
|
554 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
555 | - * @throws InvalidInterfaceException |
|
556 | - * @throws InvalidDataTypeException |
|
557 | - * @throws EE_Error |
|
558 | - * @throws InvalidArgumentException |
|
559 | - */ |
|
560 | - public function get_total_line_items_for_expired_carts() |
|
561 | - { |
|
562 | - return $this->get_total_line_items_for_carts(true); |
|
563 | - } |
|
564 | - |
|
565 | - |
|
566 | - /** |
|
567 | - * Returns an array of grand total line items where the TXN_ID is 0. |
|
568 | - * If $expired is set to true, then only line items for expired sessions will be returned. |
|
569 | - * If $expired is set to false, then only line items for active sessions will be returned. |
|
570 | - * |
|
571 | - * @param null $expired |
|
572 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
573 | - * @throws EE_Error |
|
574 | - * @throws InvalidArgumentException |
|
575 | - * @throws InvalidDataTypeException |
|
576 | - * @throws InvalidInterfaceException |
|
577 | - */ |
|
578 | - private function get_total_line_items_for_carts($expired = null) |
|
579 | - { |
|
580 | - $where_params = array( |
|
581 | - 'TXN_ID' => 0, |
|
582 | - 'LIN_type' => 'total', |
|
583 | - ); |
|
584 | - if ($expired !== null) { |
|
585 | - /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */ |
|
586 | - $session_lifespan = LoaderFactory::getLoader()->getShared( |
|
587 | - 'EventEspresso\core\domain\values\session\SessionLifespan' |
|
588 | - ); |
|
589 | - $where_params['LIN_timestamp'] = array( |
|
590 | - $expired ? '<=' : '>', |
|
591 | - $session_lifespan->expiration(), |
|
592 | - ); |
|
593 | - } |
|
594 | - return $this->get_all(array($where_params)); |
|
595 | - } |
|
596 | - |
|
597 | - |
|
598 | - /** |
|
599 | - * Returns an array of ticket total line items where the TXN_ID is 0 |
|
600 | - * AND the timestamp is older than the session lifespan. |
|
601 | - * |
|
602 | - * @param int $timestamp |
|
603 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
604 | - * @throws EE_Error |
|
605 | - * @throws InvalidArgumentException |
|
606 | - * @throws InvalidDataTypeException |
|
607 | - * @throws InvalidInterfaceException |
|
608 | - */ |
|
609 | - public function getTicketLineItemsForExpiredCarts($timestamp = 0) |
|
610 | - { |
|
611 | - if (! absint($timestamp)) { |
|
612 | - /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */ |
|
613 | - $session_lifespan = LoaderFactory::getLoader()->getShared( |
|
614 | - 'EventEspresso\core\domain\values\session\SessionLifespan' |
|
615 | - ); |
|
616 | - $timestamp = $session_lifespan->expiration(); |
|
617 | - } |
|
618 | - return $this->get_all( |
|
619 | - array( |
|
620 | - array( |
|
621 | - 'TXN_ID' => 0, |
|
622 | - 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET, |
|
623 | - 'LIN_timestamp' => array('<=', $timestamp), |
|
624 | - ), |
|
625 | - ) |
|
626 | - ); |
|
627 | - } |
|
332 | + // use GMT time because that's what TXN_timestamps are in |
|
333 | + date('Y-m-d H:i:s', time() - $time_to_leave_alone) |
|
334 | + ); |
|
335 | + return $wpdb->query($query); |
|
336 | + } |
|
337 | + |
|
338 | + |
|
339 | + /** |
|
340 | + * get_line_item_for_transaction_object |
|
341 | + * Gets a transaction's line item record for a specific object such as a EE_Event or EE_Ticket |
|
342 | + * |
|
343 | + * @param int $TXN_ID |
|
344 | + * @param EE_Base_Class $object |
|
345 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
346 | + * @throws EE_Error |
|
347 | + * @throws InvalidArgumentException |
|
348 | + * @throws InvalidDataTypeException |
|
349 | + * @throws InvalidInterfaceException |
|
350 | + * @throws ReflectionException |
|
351 | + */ |
|
352 | + public function get_line_item_for_transaction_object($TXN_ID, EE_Base_Class $object) |
|
353 | + { |
|
354 | + return $this->get_all(array( |
|
355 | + array( |
|
356 | + 'TXN_ID' => $TXN_ID, |
|
357 | + 'OBJ_type' => str_replace('EE_', '', get_class($object)), |
|
358 | + 'OBJ_ID' => $object->ID(), |
|
359 | + ), |
|
360 | + )); |
|
361 | + } |
|
362 | + |
|
363 | + |
|
364 | + /** |
|
365 | + * get_object_line_items_for_transaction |
|
366 | + * Gets all of the the object line items for a transaction, based on an object type plus an array of object IDs |
|
367 | + * |
|
368 | + * @param int $TXN_ID |
|
369 | + * @param string $OBJ_type |
|
370 | + * @param array $OBJ_IDs |
|
371 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
372 | + * @throws EE_Error |
|
373 | + */ |
|
374 | + public function get_object_line_items_for_transaction( |
|
375 | + $TXN_ID, |
|
376 | + $OBJ_type = EEM_Line_Item::OBJ_TYPE_EVENT, |
|
377 | + $OBJ_IDs = array() |
|
378 | + ) { |
|
379 | + $query_params = array( |
|
380 | + 'OBJ_type' => $OBJ_type, |
|
381 | + // if incoming $OBJ_IDs is an array, then make sure it is formatted correctly for the query |
|
382 | + 'OBJ_ID' => is_array($OBJ_IDs) && ! isset($OBJ_IDs['IN']) ? array('IN', $OBJ_IDs) : $OBJ_IDs, |
|
383 | + ); |
|
384 | + if ($TXN_ID) { |
|
385 | + $query_params['TXN_ID'] = $TXN_ID; |
|
386 | + } |
|
387 | + return $this->get_all(array($query_params)); |
|
388 | + } |
|
389 | + |
|
390 | + |
|
391 | + /** |
|
392 | + * get_all_ticket_line_items_for_transaction |
|
393 | + * |
|
394 | + * @param EE_Transaction $transaction |
|
395 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
396 | + * @throws EE_Error |
|
397 | + * @throws InvalidArgumentException |
|
398 | + * @throws InvalidDataTypeException |
|
399 | + * @throws InvalidInterfaceException |
|
400 | + * @throws ReflectionException |
|
401 | + */ |
|
402 | + public function get_all_ticket_line_items_for_transaction(EE_Transaction $transaction) |
|
403 | + { |
|
404 | + return $this->get_all(array( |
|
405 | + array( |
|
406 | + 'TXN_ID' => $transaction->ID(), |
|
407 | + 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET, |
|
408 | + ), |
|
409 | + )); |
|
410 | + } |
|
411 | + |
|
412 | + |
|
413 | + /** |
|
414 | + * get_ticket_line_item_for_transaction |
|
415 | + * |
|
416 | + * @param int $TXN_ID |
|
417 | + * @param int $TKT_ID |
|
418 | + * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL |
|
419 | + * @throws EE_Error |
|
420 | + * @throws InvalidArgumentException |
|
421 | + * @throws InvalidDataTypeException |
|
422 | + * @throws InvalidInterfaceException |
|
423 | + */ |
|
424 | + public function get_ticket_line_item_for_transaction($TXN_ID, $TKT_ID) |
|
425 | + { |
|
426 | + return $this->get_one(array( |
|
427 | + array( |
|
428 | + 'TXN_ID' => EEM_Transaction::instance()->ensure_is_ID($TXN_ID), |
|
429 | + 'OBJ_ID' => $TKT_ID, |
|
430 | + 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET, |
|
431 | + ), |
|
432 | + )); |
|
433 | + } |
|
434 | + |
|
435 | + |
|
436 | + /** |
|
437 | + * get_existing_promotion_line_item |
|
438 | + * searches the cart for existing line items for the specified promotion |
|
439 | + * |
|
440 | + * @since 1.0.0 |
|
441 | + * @param EE_Line_Item $parent_line_item |
|
442 | + * @param EE_Promotion $promotion |
|
443 | + * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL |
|
444 | + * @throws EE_Error |
|
445 | + * @throws InvalidArgumentException |
|
446 | + * @throws InvalidDataTypeException |
|
447 | + * @throws InvalidInterfaceException |
|
448 | + * @throws ReflectionException |
|
449 | + */ |
|
450 | + public function get_existing_promotion_line_item(EE_Line_Item $parent_line_item, EE_Promotion $promotion) |
|
451 | + { |
|
452 | + return $this->get_one(array( |
|
453 | + array( |
|
454 | + 'TXN_ID' => $parent_line_item->TXN_ID(), |
|
455 | + 'LIN_parent' => $parent_line_item->ID(), |
|
456 | + 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_PROMOTION, |
|
457 | + 'OBJ_ID' => $promotion->ID(), |
|
458 | + ), |
|
459 | + )); |
|
460 | + } |
|
461 | + |
|
462 | + |
|
463 | + /** |
|
464 | + * get_all_promotion_line_items |
|
465 | + * searches the cart for any and all existing promotion line items |
|
466 | + * |
|
467 | + * @since 1.0.0 |
|
468 | + * @param EE_Line_Item $parent_line_item |
|
469 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
470 | + * @throws EE_Error |
|
471 | + * @throws InvalidArgumentException |
|
472 | + * @throws InvalidDataTypeException |
|
473 | + * @throws InvalidInterfaceException |
|
474 | + * @throws ReflectionException |
|
475 | + */ |
|
476 | + public function get_all_promotion_line_items(EE_Line_Item $parent_line_item) |
|
477 | + { |
|
478 | + return $this->get_all(array( |
|
479 | + array( |
|
480 | + 'TXN_ID' => $parent_line_item->TXN_ID(), |
|
481 | + 'LIN_parent' => $parent_line_item->ID(), |
|
482 | + 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_PROMOTION, |
|
483 | + ), |
|
484 | + )); |
|
485 | + } |
|
486 | + |
|
487 | + |
|
488 | + /** |
|
489 | + * Gets the registration's corresponding line item. |
|
490 | + * Note: basically does NOT support having multiple line items for a single ticket, |
|
491 | + * which would happen if some of the registrations had a price modifier while others didn't. |
|
492 | + * In order to support that, we'd probably need a LIN_ID on registrations or something. |
|
493 | + * |
|
494 | + * @param EE_Registration $registration |
|
495 | + * @return EE_Base_Class|EE_Line_ITem|EE_Soft_Delete_Base_Class|NULL |
|
496 | + * @throws EE_Error |
|
497 | + */ |
|
498 | + public function get_line_item_for_registration(EE_Registration $registration) |
|
499 | + { |
|
500 | + return $this->get_one($this->line_item_for_registration_query_params($registration)); |
|
501 | + } |
|
502 | + |
|
503 | + |
|
504 | + /** |
|
505 | + * Gets the query params used to retrieve a specific line item for the given registration |
|
506 | + * |
|
507 | + * @param EE_Registration $registration |
|
508 | + * @param array $original_query_params any extra query params you'd like to be merged with |
|
509 | + * @return array @see |
|
510 | + * https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
511 | + * @throws EE_Error |
|
512 | + */ |
|
513 | + public function line_item_for_registration_query_params( |
|
514 | + EE_Registration $registration, |
|
515 | + $original_query_params = array() |
|
516 | + ) { |
|
517 | + return array_replace_recursive($original_query_params, array( |
|
518 | + array( |
|
519 | + 'OBJ_ID' => $registration->ticket_ID(), |
|
520 | + 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET, |
|
521 | + 'TXN_ID' => $registration->transaction_ID(), |
|
522 | + ), |
|
523 | + )); |
|
524 | + } |
|
525 | + |
|
526 | + |
|
527 | + /** |
|
528 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
529 | + * @throws InvalidInterfaceException |
|
530 | + * @throws InvalidDataTypeException |
|
531 | + * @throws EE_Error |
|
532 | + * @throws InvalidArgumentException |
|
533 | + */ |
|
534 | + public function get_total_line_items_with_no_transaction() |
|
535 | + { |
|
536 | + return $this->get_total_line_items_for_carts(); |
|
537 | + } |
|
538 | + |
|
539 | + |
|
540 | + /** |
|
541 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
542 | + * @throws InvalidInterfaceException |
|
543 | + * @throws InvalidDataTypeException |
|
544 | + * @throws EE_Error |
|
545 | + * @throws InvalidArgumentException |
|
546 | + */ |
|
547 | + public function get_total_line_items_for_active_carts() |
|
548 | + { |
|
549 | + return $this->get_total_line_items_for_carts(false); |
|
550 | + } |
|
551 | + |
|
552 | + |
|
553 | + /** |
|
554 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
555 | + * @throws InvalidInterfaceException |
|
556 | + * @throws InvalidDataTypeException |
|
557 | + * @throws EE_Error |
|
558 | + * @throws InvalidArgumentException |
|
559 | + */ |
|
560 | + public function get_total_line_items_for_expired_carts() |
|
561 | + { |
|
562 | + return $this->get_total_line_items_for_carts(true); |
|
563 | + } |
|
564 | + |
|
565 | + |
|
566 | + /** |
|
567 | + * Returns an array of grand total line items where the TXN_ID is 0. |
|
568 | + * If $expired is set to true, then only line items for expired sessions will be returned. |
|
569 | + * If $expired is set to false, then only line items for active sessions will be returned. |
|
570 | + * |
|
571 | + * @param null $expired |
|
572 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
573 | + * @throws EE_Error |
|
574 | + * @throws InvalidArgumentException |
|
575 | + * @throws InvalidDataTypeException |
|
576 | + * @throws InvalidInterfaceException |
|
577 | + */ |
|
578 | + private function get_total_line_items_for_carts($expired = null) |
|
579 | + { |
|
580 | + $where_params = array( |
|
581 | + 'TXN_ID' => 0, |
|
582 | + 'LIN_type' => 'total', |
|
583 | + ); |
|
584 | + if ($expired !== null) { |
|
585 | + /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */ |
|
586 | + $session_lifespan = LoaderFactory::getLoader()->getShared( |
|
587 | + 'EventEspresso\core\domain\values\session\SessionLifespan' |
|
588 | + ); |
|
589 | + $where_params['LIN_timestamp'] = array( |
|
590 | + $expired ? '<=' : '>', |
|
591 | + $session_lifespan->expiration(), |
|
592 | + ); |
|
593 | + } |
|
594 | + return $this->get_all(array($where_params)); |
|
595 | + } |
|
596 | + |
|
597 | + |
|
598 | + /** |
|
599 | + * Returns an array of ticket total line items where the TXN_ID is 0 |
|
600 | + * AND the timestamp is older than the session lifespan. |
|
601 | + * |
|
602 | + * @param int $timestamp |
|
603 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
604 | + * @throws EE_Error |
|
605 | + * @throws InvalidArgumentException |
|
606 | + * @throws InvalidDataTypeException |
|
607 | + * @throws InvalidInterfaceException |
|
608 | + */ |
|
609 | + public function getTicketLineItemsForExpiredCarts($timestamp = 0) |
|
610 | + { |
|
611 | + if (! absint($timestamp)) { |
|
612 | + /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */ |
|
613 | + $session_lifespan = LoaderFactory::getLoader()->getShared( |
|
614 | + 'EventEspresso\core\domain\values\session\SessionLifespan' |
|
615 | + ); |
|
616 | + $timestamp = $session_lifespan->expiration(); |
|
617 | + } |
|
618 | + return $this->get_all( |
|
619 | + array( |
|
620 | + array( |
|
621 | + 'TXN_ID' => 0, |
|
622 | + 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET, |
|
623 | + 'LIN_timestamp' => array('<=', $timestamp), |
|
624 | + ), |
|
625 | + ) |
|
626 | + ); |
|
627 | + } |
|
628 | 628 | } |
@@ -241,7 +241,7 @@ |
||
241 | 241 | |
242 | 242 | |
243 | 243 | /** |
244 | - * @return string |
|
244 | + * @return boolean |
|
245 | 245 | * @throws InvalidArgumentException |
246 | 246 | * @throws InvalidInterfaceException |
247 | 247 | * @throws InvalidDataTypeException |
@@ -17,442 +17,442 @@ |
||
17 | 17 | class EED_Ticket_Selector extends EED_Module |
18 | 18 | { |
19 | 19 | |
20 | - /** |
|
21 | - * @var DisplayTicketSelector $ticket_selector |
|
22 | - */ |
|
23 | - private static $ticket_selector; |
|
24 | - |
|
25 | - /** |
|
26 | - * @var TicketSelectorIframeEmbedButton $iframe_embed_button |
|
27 | - */ |
|
28 | - private static $iframe_embed_button; |
|
29 | - |
|
30 | - |
|
31 | - /** |
|
32 | - * @return EED_Module|EED_Ticket_Selector |
|
33 | - */ |
|
34 | - public static function instance() |
|
35 | - { |
|
36 | - return parent::get_instance(__CLASS__); |
|
37 | - } |
|
38 | - |
|
39 | - |
|
40 | - /** |
|
41 | - * @return void |
|
42 | - */ |
|
43 | - protected function set_config() |
|
44 | - { |
|
45 | - $this->set_config_section('template_settings'); |
|
46 | - $this->set_config_class('EE_Ticket_Selector_Config'); |
|
47 | - $this->set_config_name('EED_Ticket_Selector'); |
|
48 | - } |
|
49 | - |
|
50 | - |
|
51 | - /** |
|
52 | - * set_hooks - for hooking into EE Core, other modules, etc |
|
53 | - * |
|
54 | - * @return void |
|
55 | - */ |
|
56 | - public static function set_hooks() |
|
57 | - { |
|
58 | - // routing |
|
59 | - EE_Config::register_route( |
|
60 | - 'iframe', |
|
61 | - 'EED_Ticket_Selector', |
|
62 | - 'ticket_selector_iframe', |
|
63 | - 'ticket_selector' |
|
64 | - ); |
|
65 | - EE_Config::register_route( |
|
66 | - 'process_ticket_selections', |
|
67 | - 'EED_Ticket_Selector', |
|
68 | - 'process_ticket_selections' |
|
69 | - ); |
|
70 | - EE_Config::register_route( |
|
71 | - 'cancel_ticket_selections', |
|
72 | - 'EED_Ticket_Selector', |
|
73 | - 'cancel_ticket_selections' |
|
74 | - ); |
|
75 | - add_action('wp_loaded', array('EED_Ticket_Selector', 'set_definitions'), 2); |
|
76 | - add_action('AHEE_event_details_header_bottom', array('EED_Ticket_Selector', 'display_ticket_selector'), 10, 1); |
|
77 | - add_action('wp_enqueue_scripts', array('EED_Ticket_Selector', 'translate_js_strings'), 0); |
|
78 | - add_action('wp_enqueue_scripts', array('EED_Ticket_Selector', 'load_tckt_slctr_assets'), 10); |
|
79 | - EED_Ticket_Selector::loadIframeAssets(); |
|
80 | - } |
|
81 | - |
|
82 | - |
|
83 | - /** |
|
84 | - * set_hooks_admin - for hooking into EE Admin Core, other modules, etc |
|
85 | - * |
|
86 | - * @return void |
|
87 | - */ |
|
88 | - public static function set_hooks_admin() |
|
89 | - { |
|
90 | - // hook into the end of the \EE_Admin_Page::_load_page_dependencies() |
|
91 | - // to load assets for "espresso_events" page on the "edit" route (action) |
|
92 | - add_action( |
|
93 | - 'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__edit', |
|
94 | - array('EED_Ticket_Selector', 'ticket_selector_iframe_embed_button'), |
|
95 | - 10 |
|
96 | - ); |
|
97 | - /** |
|
98 | - * Make sure assets for the ticket selector are loaded on the espresso registrations route so admin side |
|
99 | - * registrations work. |
|
100 | - */ |
|
101 | - add_action( |
|
102 | - 'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_registrations__new_registration', |
|
103 | - array('EED_Ticket_Selector', 'set_definitions'), |
|
104 | - 10 |
|
105 | - ); |
|
106 | - } |
|
107 | - |
|
108 | - |
|
109 | - /** |
|
110 | - * set_definitions |
|
111 | - * |
|
112 | - * @return void |
|
113 | - * @throws InvalidArgumentException |
|
114 | - * @throws InvalidDataTypeException |
|
115 | - * @throws InvalidInterfaceException |
|
116 | - */ |
|
117 | - public static function set_definitions() |
|
118 | - { |
|
119 | - // don't do this twice |
|
120 | - if (defined('TICKET_SELECTOR_ASSETS_URL')) { |
|
121 | - return; |
|
122 | - } |
|
123 | - define('TICKET_SELECTOR_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets' . DS); |
|
124 | - define( |
|
125 | - 'TICKET_SELECTOR_TEMPLATES_PATH', |
|
126 | - str_replace('\\', DS, plugin_dir_path(__FILE__)) . 'templates' . DS |
|
127 | - ); |
|
128 | - // if config is not set, initialize |
|
129 | - if (! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config |
|
130 | - ) { |
|
131 | - EED_Ticket_Selector::instance()->set_config(); |
|
132 | - EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector = EED_Ticket_Selector::instance( |
|
133 | - )->config(); |
|
134 | - } |
|
135 | - } |
|
136 | - |
|
137 | - |
|
138 | - /** |
|
139 | - * @return DisplayTicketSelector |
|
140 | - */ |
|
141 | - public static function ticketSelector() |
|
142 | - { |
|
143 | - if (! EED_Ticket_Selector::$ticket_selector instanceof DisplayTicketSelector) { |
|
144 | - EED_Ticket_Selector::$ticket_selector = new DisplayTicketSelector(EED_Events_Archive::is_iframe()); |
|
145 | - } |
|
146 | - return EED_Ticket_Selector::$ticket_selector; |
|
147 | - } |
|
148 | - |
|
149 | - |
|
150 | - /** |
|
151 | - * gets the ball rolling |
|
152 | - * |
|
153 | - * @param WP $WP |
|
154 | - * @return void |
|
155 | - */ |
|
156 | - public function run($WP) |
|
157 | - { |
|
158 | - } |
|
159 | - |
|
160 | - |
|
161 | - /** |
|
162 | - * @return TicketSelectorIframeEmbedButton |
|
163 | - */ |
|
164 | - public static function getIframeEmbedButton() |
|
165 | - { |
|
166 | - if (! self::$iframe_embed_button instanceof TicketSelectorIframeEmbedButton) { |
|
167 | - self::$iframe_embed_button = new TicketSelectorIframeEmbedButton(); |
|
168 | - } |
|
169 | - return self::$iframe_embed_button; |
|
170 | - } |
|
171 | - |
|
172 | - |
|
173 | - /** |
|
174 | - * ticket_selector_iframe_embed_button |
|
175 | - * |
|
176 | - * @return void |
|
177 | - * @throws EE_Error |
|
178 | - */ |
|
179 | - public static function ticket_selector_iframe_embed_button() |
|
180 | - { |
|
181 | - $iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton(); |
|
182 | - $iframe_embed_button->addEventEditorIframeEmbedButton(); |
|
183 | - } |
|
184 | - |
|
185 | - |
|
186 | - /** |
|
187 | - * ticket_selector_iframe |
|
188 | - * |
|
189 | - * @return void |
|
190 | - * @throws DomainException |
|
191 | - * @throws EE_Error |
|
192 | - */ |
|
193 | - public function ticket_selector_iframe() |
|
194 | - { |
|
195 | - $ticket_selector_iframe = new TicketSelectorIframe(); |
|
196 | - $ticket_selector_iframe->display(); |
|
197 | - } |
|
198 | - |
|
199 | - |
|
200 | - /** |
|
201 | - * creates buttons for selecting number of attendees for an event |
|
202 | - * |
|
203 | - * @param WP_Post|int $event |
|
204 | - * @param bool $view_details |
|
205 | - * @return string |
|
206 | - * @throws EE_Error |
|
207 | - */ |
|
208 | - public static function display_ticket_selector($event = null, $view_details = false) |
|
209 | - { |
|
210 | - return EED_Ticket_Selector::ticketSelector()->display($event, $view_details); |
|
211 | - } |
|
212 | - |
|
213 | - |
|
214 | - /** |
|
215 | - * @return array or FALSE |
|
216 | - * @throws \ReflectionException |
|
217 | - * @throws \EE_Error |
|
218 | - * @throws InvalidArgumentException |
|
219 | - * @throws InvalidInterfaceException |
|
220 | - * @throws InvalidDataTypeException |
|
221 | - */ |
|
222 | - public function process_ticket_selections() |
|
223 | - { |
|
224 | - /** @var EventEspresso\modules\ticket_selector\ProcessTicketSelector $form */ |
|
225 | - $form = LoaderFactory::getLoader()->getShared('EventEspresso\modules\ticket_selector\ProcessTicketSelector'); |
|
226 | - return $form->processTicketSelections(); |
|
227 | - } |
|
228 | - |
|
229 | - |
|
230 | - /** |
|
231 | - * @return string |
|
232 | - * @throws InvalidArgumentException |
|
233 | - * @throws InvalidInterfaceException |
|
234 | - * @throws InvalidDataTypeException |
|
235 | - * @throws EE_Error |
|
236 | - */ |
|
237 | - public static function cancel_ticket_selections() |
|
238 | - { |
|
239 | - /** @var EventEspresso\modules\ticket_selector\ProcessTicketSelector $form */ |
|
240 | - $form = LoaderFactory::getLoader()->getShared('EventEspresso\modules\ticket_selector\ProcessTicketSelector'); |
|
241 | - return $form->cancelTicketSelections(); |
|
242 | - } |
|
243 | - |
|
244 | - |
|
245 | - /** |
|
246 | - * @return void |
|
247 | - */ |
|
248 | - public static function translate_js_strings() |
|
249 | - { |
|
250 | - EE_Registry::$i18n_js_strings['please_select_date_filter_notice'] = esc_html__( |
|
251 | - 'please select a datetime', |
|
252 | - 'event_espresso' |
|
253 | - ); |
|
254 | - } |
|
255 | - |
|
256 | - |
|
257 | - /** |
|
258 | - * @return void |
|
259 | - */ |
|
260 | - public static function load_tckt_slctr_assets() |
|
261 | - { |
|
262 | - if (apply_filters('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', false)) { |
|
263 | - // add some style |
|
264 | - wp_register_style( |
|
265 | - 'ticket_selector', |
|
266 | - TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css', |
|
267 | - array(), |
|
268 | - EVENT_ESPRESSO_VERSION |
|
269 | - ); |
|
270 | - wp_enqueue_style('ticket_selector'); |
|
271 | - // make it dance |
|
272 | - wp_register_script( |
|
273 | - 'ticket_selector', |
|
274 | - TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js', |
|
275 | - array('espresso_core'), |
|
276 | - EVENT_ESPRESSO_VERSION, |
|
277 | - true |
|
278 | - ); |
|
279 | - wp_enqueue_script('ticket_selector'); |
|
280 | - require_once EE_LIBRARIES |
|
281 | - . 'form_sections/strategies/display/EE_Checkbox_Dropdown_Selector_Display_Strategy.strategy.php'; |
|
282 | - \EE_Checkbox_Dropdown_Selector_Display_Strategy::enqueue_styles_and_scripts(); |
|
283 | - } |
|
284 | - } |
|
285 | - |
|
286 | - |
|
287 | - /** |
|
288 | - * @return void |
|
289 | - */ |
|
290 | - public static function loadIframeAssets() |
|
291 | - { |
|
292 | - // for event lists |
|
293 | - add_filter( |
|
294 | - 'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css', |
|
295 | - array('EED_Ticket_Selector', 'iframeCss') |
|
296 | - ); |
|
297 | - add_filter( |
|
298 | - 'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js', |
|
299 | - array('EED_Ticket_Selector', 'iframeJs') |
|
300 | - ); |
|
301 | - // for ticket selectors |
|
302 | - add_filter( |
|
303 | - 'FHEE__EED_Ticket_Selector__ticket_selector_iframe__css', |
|
304 | - array('EED_Ticket_Selector', 'iframeCss') |
|
305 | - ); |
|
306 | - add_filter( |
|
307 | - 'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js', |
|
308 | - array('EED_Ticket_Selector', 'iframeJs') |
|
309 | - ); |
|
310 | - } |
|
311 | - |
|
312 | - |
|
313 | - /** |
|
314 | - * Informs the rest of the forms system what CSS and JS is needed to display the input |
|
315 | - * |
|
316 | - * @param array $iframe_css |
|
317 | - * @return array |
|
318 | - */ |
|
319 | - public static function iframeCss(array $iframe_css) |
|
320 | - { |
|
321 | - $iframe_css['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css'; |
|
322 | - return $iframe_css; |
|
323 | - } |
|
324 | - |
|
325 | - |
|
326 | - /** |
|
327 | - * Informs the rest of the forms system what CSS and JS is needed to display the input |
|
328 | - * |
|
329 | - * @param array $iframe_js |
|
330 | - * @return array |
|
331 | - */ |
|
332 | - public static function iframeJs(array $iframe_js) |
|
333 | - { |
|
334 | - $iframe_js['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js'; |
|
335 | - return $iframe_js; |
|
336 | - } |
|
337 | - |
|
338 | - |
|
339 | - /****************************** DEPRECATED ******************************/ |
|
340 | - |
|
341 | - |
|
342 | - /** |
|
343 | - * @deprecated |
|
344 | - * @return string |
|
345 | - * @throws EE_Error |
|
346 | - */ |
|
347 | - public static function display_view_details_btn() |
|
348 | - { |
|
349 | - // todo add doing_it_wrong() notice during next major version |
|
350 | - return EED_Ticket_Selector::ticketSelector()->displayViewDetailsButton(); |
|
351 | - } |
|
352 | - |
|
353 | - |
|
354 | - /** |
|
355 | - * @deprecated |
|
356 | - * @return string |
|
357 | - * @throws EE_Error |
|
358 | - */ |
|
359 | - public static function display_ticket_selector_submit() |
|
360 | - { |
|
361 | - // todo add doing_it_wrong() notice during next major version |
|
362 | - return EED_Ticket_Selector::ticketSelector()->displaySubmitButton(); |
|
363 | - } |
|
364 | - |
|
365 | - |
|
366 | - /** |
|
367 | - * @deprecated |
|
368 | - * @param string $permalink_string |
|
369 | - * @param int $id |
|
370 | - * @param string $new_title |
|
371 | - * @param string $new_slug |
|
372 | - * @return string |
|
373 | - * @throws InvalidArgumentException |
|
374 | - * @throws InvalidDataTypeException |
|
375 | - * @throws InvalidInterfaceException |
|
376 | - */ |
|
377 | - public static function iframe_code_button($permalink_string, $id, $new_title = '', $new_slug = '') |
|
378 | - { |
|
379 | - // todo add doing_it_wrong() notice during next major version |
|
380 | - if (EE_Registry::instance()->REQ->get('page') === 'espresso_events' |
|
381 | - && EE_Registry::instance()->REQ->get('action') === 'edit' |
|
382 | - ) { |
|
383 | - $iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton(); |
|
384 | - $iframe_embed_button->addEventEditorIframeEmbedButton(); |
|
385 | - } |
|
386 | - return ''; |
|
387 | - } |
|
388 | - |
|
389 | - |
|
390 | - /** |
|
391 | - * @deprecated |
|
392 | - * @param int $ID |
|
393 | - * @param string $external_url |
|
394 | - * @return string |
|
395 | - */ |
|
396 | - public static function ticket_selector_form_open($ID = 0, $external_url = '') |
|
397 | - { |
|
398 | - // todo add doing_it_wrong() notice during next major version |
|
399 | - return EED_Ticket_Selector::ticketSelector()->formOpen($ID, $external_url); |
|
400 | - } |
|
401 | - |
|
402 | - |
|
403 | - /** |
|
404 | - * @deprecated |
|
405 | - * @return string |
|
406 | - */ |
|
407 | - public static function ticket_selector_form_close() |
|
408 | - { |
|
409 | - // todo add doing_it_wrong() notice during next major version |
|
410 | - return EED_Ticket_Selector::ticketSelector()->formClose(); |
|
411 | - } |
|
412 | - |
|
413 | - |
|
414 | - /** |
|
415 | - * @deprecated |
|
416 | - * @return string |
|
417 | - */ |
|
418 | - public static function no_tkt_slctr_end_dv() |
|
419 | - { |
|
420 | - // todo add doing_it_wrong() notice during next major version |
|
421 | - return EED_Ticket_Selector::ticketSelector()->ticketSelectorEndDiv(); |
|
422 | - } |
|
423 | - |
|
424 | - |
|
425 | - /** |
|
426 | - * @deprecated 4.9.13 |
|
427 | - * @return string |
|
428 | - */ |
|
429 | - public static function tkt_slctr_end_dv() |
|
430 | - { |
|
431 | - return EED_Ticket_Selector::ticketSelector()->clearTicketSelector(); |
|
432 | - } |
|
433 | - |
|
434 | - |
|
435 | - /** |
|
436 | - * @deprecated |
|
437 | - * @return string |
|
438 | - */ |
|
439 | - public static function clear_tkt_slctr() |
|
440 | - { |
|
441 | - return EED_Ticket_Selector::ticketSelector()->clearTicketSelector(); |
|
442 | - } |
|
443 | - |
|
444 | - |
|
445 | - /** |
|
446 | - * @deprecated |
|
447 | - */ |
|
448 | - public static function load_tckt_slctr_assets_admin() |
|
449 | - { |
|
450 | - // todo add doing_it_wrong() notice during next major version |
|
451 | - if (EE_Registry::instance()->REQ->get('page') === 'espresso_events' |
|
452 | - && EE_Registry::instance()->REQ->get('action') === 'edit' |
|
453 | - ) { |
|
454 | - $iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton(); |
|
455 | - $iframe_embed_button->embedButtonAssets(); |
|
456 | - } |
|
457 | - } |
|
20 | + /** |
|
21 | + * @var DisplayTicketSelector $ticket_selector |
|
22 | + */ |
|
23 | + private static $ticket_selector; |
|
24 | + |
|
25 | + /** |
|
26 | + * @var TicketSelectorIframeEmbedButton $iframe_embed_button |
|
27 | + */ |
|
28 | + private static $iframe_embed_button; |
|
29 | + |
|
30 | + |
|
31 | + /** |
|
32 | + * @return EED_Module|EED_Ticket_Selector |
|
33 | + */ |
|
34 | + public static function instance() |
|
35 | + { |
|
36 | + return parent::get_instance(__CLASS__); |
|
37 | + } |
|
38 | + |
|
39 | + |
|
40 | + /** |
|
41 | + * @return void |
|
42 | + */ |
|
43 | + protected function set_config() |
|
44 | + { |
|
45 | + $this->set_config_section('template_settings'); |
|
46 | + $this->set_config_class('EE_Ticket_Selector_Config'); |
|
47 | + $this->set_config_name('EED_Ticket_Selector'); |
|
48 | + } |
|
49 | + |
|
50 | + |
|
51 | + /** |
|
52 | + * set_hooks - for hooking into EE Core, other modules, etc |
|
53 | + * |
|
54 | + * @return void |
|
55 | + */ |
|
56 | + public static function set_hooks() |
|
57 | + { |
|
58 | + // routing |
|
59 | + EE_Config::register_route( |
|
60 | + 'iframe', |
|
61 | + 'EED_Ticket_Selector', |
|
62 | + 'ticket_selector_iframe', |
|
63 | + 'ticket_selector' |
|
64 | + ); |
|
65 | + EE_Config::register_route( |
|
66 | + 'process_ticket_selections', |
|
67 | + 'EED_Ticket_Selector', |
|
68 | + 'process_ticket_selections' |
|
69 | + ); |
|
70 | + EE_Config::register_route( |
|
71 | + 'cancel_ticket_selections', |
|
72 | + 'EED_Ticket_Selector', |
|
73 | + 'cancel_ticket_selections' |
|
74 | + ); |
|
75 | + add_action('wp_loaded', array('EED_Ticket_Selector', 'set_definitions'), 2); |
|
76 | + add_action('AHEE_event_details_header_bottom', array('EED_Ticket_Selector', 'display_ticket_selector'), 10, 1); |
|
77 | + add_action('wp_enqueue_scripts', array('EED_Ticket_Selector', 'translate_js_strings'), 0); |
|
78 | + add_action('wp_enqueue_scripts', array('EED_Ticket_Selector', 'load_tckt_slctr_assets'), 10); |
|
79 | + EED_Ticket_Selector::loadIframeAssets(); |
|
80 | + } |
|
81 | + |
|
82 | + |
|
83 | + /** |
|
84 | + * set_hooks_admin - for hooking into EE Admin Core, other modules, etc |
|
85 | + * |
|
86 | + * @return void |
|
87 | + */ |
|
88 | + public static function set_hooks_admin() |
|
89 | + { |
|
90 | + // hook into the end of the \EE_Admin_Page::_load_page_dependencies() |
|
91 | + // to load assets for "espresso_events" page on the "edit" route (action) |
|
92 | + add_action( |
|
93 | + 'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__edit', |
|
94 | + array('EED_Ticket_Selector', 'ticket_selector_iframe_embed_button'), |
|
95 | + 10 |
|
96 | + ); |
|
97 | + /** |
|
98 | + * Make sure assets for the ticket selector are loaded on the espresso registrations route so admin side |
|
99 | + * registrations work. |
|
100 | + */ |
|
101 | + add_action( |
|
102 | + 'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_registrations__new_registration', |
|
103 | + array('EED_Ticket_Selector', 'set_definitions'), |
|
104 | + 10 |
|
105 | + ); |
|
106 | + } |
|
107 | + |
|
108 | + |
|
109 | + /** |
|
110 | + * set_definitions |
|
111 | + * |
|
112 | + * @return void |
|
113 | + * @throws InvalidArgumentException |
|
114 | + * @throws InvalidDataTypeException |
|
115 | + * @throws InvalidInterfaceException |
|
116 | + */ |
|
117 | + public static function set_definitions() |
|
118 | + { |
|
119 | + // don't do this twice |
|
120 | + if (defined('TICKET_SELECTOR_ASSETS_URL')) { |
|
121 | + return; |
|
122 | + } |
|
123 | + define('TICKET_SELECTOR_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets' . DS); |
|
124 | + define( |
|
125 | + 'TICKET_SELECTOR_TEMPLATES_PATH', |
|
126 | + str_replace('\\', DS, plugin_dir_path(__FILE__)) . 'templates' . DS |
|
127 | + ); |
|
128 | + // if config is not set, initialize |
|
129 | + if (! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config |
|
130 | + ) { |
|
131 | + EED_Ticket_Selector::instance()->set_config(); |
|
132 | + EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector = EED_Ticket_Selector::instance( |
|
133 | + )->config(); |
|
134 | + } |
|
135 | + } |
|
136 | + |
|
137 | + |
|
138 | + /** |
|
139 | + * @return DisplayTicketSelector |
|
140 | + */ |
|
141 | + public static function ticketSelector() |
|
142 | + { |
|
143 | + if (! EED_Ticket_Selector::$ticket_selector instanceof DisplayTicketSelector) { |
|
144 | + EED_Ticket_Selector::$ticket_selector = new DisplayTicketSelector(EED_Events_Archive::is_iframe()); |
|
145 | + } |
|
146 | + return EED_Ticket_Selector::$ticket_selector; |
|
147 | + } |
|
148 | + |
|
149 | + |
|
150 | + /** |
|
151 | + * gets the ball rolling |
|
152 | + * |
|
153 | + * @param WP $WP |
|
154 | + * @return void |
|
155 | + */ |
|
156 | + public function run($WP) |
|
157 | + { |
|
158 | + } |
|
159 | + |
|
160 | + |
|
161 | + /** |
|
162 | + * @return TicketSelectorIframeEmbedButton |
|
163 | + */ |
|
164 | + public static function getIframeEmbedButton() |
|
165 | + { |
|
166 | + if (! self::$iframe_embed_button instanceof TicketSelectorIframeEmbedButton) { |
|
167 | + self::$iframe_embed_button = new TicketSelectorIframeEmbedButton(); |
|
168 | + } |
|
169 | + return self::$iframe_embed_button; |
|
170 | + } |
|
171 | + |
|
172 | + |
|
173 | + /** |
|
174 | + * ticket_selector_iframe_embed_button |
|
175 | + * |
|
176 | + * @return void |
|
177 | + * @throws EE_Error |
|
178 | + */ |
|
179 | + public static function ticket_selector_iframe_embed_button() |
|
180 | + { |
|
181 | + $iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton(); |
|
182 | + $iframe_embed_button->addEventEditorIframeEmbedButton(); |
|
183 | + } |
|
184 | + |
|
185 | + |
|
186 | + /** |
|
187 | + * ticket_selector_iframe |
|
188 | + * |
|
189 | + * @return void |
|
190 | + * @throws DomainException |
|
191 | + * @throws EE_Error |
|
192 | + */ |
|
193 | + public function ticket_selector_iframe() |
|
194 | + { |
|
195 | + $ticket_selector_iframe = new TicketSelectorIframe(); |
|
196 | + $ticket_selector_iframe->display(); |
|
197 | + } |
|
198 | + |
|
199 | + |
|
200 | + /** |
|
201 | + * creates buttons for selecting number of attendees for an event |
|
202 | + * |
|
203 | + * @param WP_Post|int $event |
|
204 | + * @param bool $view_details |
|
205 | + * @return string |
|
206 | + * @throws EE_Error |
|
207 | + */ |
|
208 | + public static function display_ticket_selector($event = null, $view_details = false) |
|
209 | + { |
|
210 | + return EED_Ticket_Selector::ticketSelector()->display($event, $view_details); |
|
211 | + } |
|
212 | + |
|
213 | + |
|
214 | + /** |
|
215 | + * @return array or FALSE |
|
216 | + * @throws \ReflectionException |
|
217 | + * @throws \EE_Error |
|
218 | + * @throws InvalidArgumentException |
|
219 | + * @throws InvalidInterfaceException |
|
220 | + * @throws InvalidDataTypeException |
|
221 | + */ |
|
222 | + public function process_ticket_selections() |
|
223 | + { |
|
224 | + /** @var EventEspresso\modules\ticket_selector\ProcessTicketSelector $form */ |
|
225 | + $form = LoaderFactory::getLoader()->getShared('EventEspresso\modules\ticket_selector\ProcessTicketSelector'); |
|
226 | + return $form->processTicketSelections(); |
|
227 | + } |
|
228 | + |
|
229 | + |
|
230 | + /** |
|
231 | + * @return string |
|
232 | + * @throws InvalidArgumentException |
|
233 | + * @throws InvalidInterfaceException |
|
234 | + * @throws InvalidDataTypeException |
|
235 | + * @throws EE_Error |
|
236 | + */ |
|
237 | + public static function cancel_ticket_selections() |
|
238 | + { |
|
239 | + /** @var EventEspresso\modules\ticket_selector\ProcessTicketSelector $form */ |
|
240 | + $form = LoaderFactory::getLoader()->getShared('EventEspresso\modules\ticket_selector\ProcessTicketSelector'); |
|
241 | + return $form->cancelTicketSelections(); |
|
242 | + } |
|
243 | + |
|
244 | + |
|
245 | + /** |
|
246 | + * @return void |
|
247 | + */ |
|
248 | + public static function translate_js_strings() |
|
249 | + { |
|
250 | + EE_Registry::$i18n_js_strings['please_select_date_filter_notice'] = esc_html__( |
|
251 | + 'please select a datetime', |
|
252 | + 'event_espresso' |
|
253 | + ); |
|
254 | + } |
|
255 | + |
|
256 | + |
|
257 | + /** |
|
258 | + * @return void |
|
259 | + */ |
|
260 | + public static function load_tckt_slctr_assets() |
|
261 | + { |
|
262 | + if (apply_filters('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', false)) { |
|
263 | + // add some style |
|
264 | + wp_register_style( |
|
265 | + 'ticket_selector', |
|
266 | + TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css', |
|
267 | + array(), |
|
268 | + EVENT_ESPRESSO_VERSION |
|
269 | + ); |
|
270 | + wp_enqueue_style('ticket_selector'); |
|
271 | + // make it dance |
|
272 | + wp_register_script( |
|
273 | + 'ticket_selector', |
|
274 | + TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js', |
|
275 | + array('espresso_core'), |
|
276 | + EVENT_ESPRESSO_VERSION, |
|
277 | + true |
|
278 | + ); |
|
279 | + wp_enqueue_script('ticket_selector'); |
|
280 | + require_once EE_LIBRARIES |
|
281 | + . 'form_sections/strategies/display/EE_Checkbox_Dropdown_Selector_Display_Strategy.strategy.php'; |
|
282 | + \EE_Checkbox_Dropdown_Selector_Display_Strategy::enqueue_styles_and_scripts(); |
|
283 | + } |
|
284 | + } |
|
285 | + |
|
286 | + |
|
287 | + /** |
|
288 | + * @return void |
|
289 | + */ |
|
290 | + public static function loadIframeAssets() |
|
291 | + { |
|
292 | + // for event lists |
|
293 | + add_filter( |
|
294 | + 'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css', |
|
295 | + array('EED_Ticket_Selector', 'iframeCss') |
|
296 | + ); |
|
297 | + add_filter( |
|
298 | + 'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js', |
|
299 | + array('EED_Ticket_Selector', 'iframeJs') |
|
300 | + ); |
|
301 | + // for ticket selectors |
|
302 | + add_filter( |
|
303 | + 'FHEE__EED_Ticket_Selector__ticket_selector_iframe__css', |
|
304 | + array('EED_Ticket_Selector', 'iframeCss') |
|
305 | + ); |
|
306 | + add_filter( |
|
307 | + 'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js', |
|
308 | + array('EED_Ticket_Selector', 'iframeJs') |
|
309 | + ); |
|
310 | + } |
|
311 | + |
|
312 | + |
|
313 | + /** |
|
314 | + * Informs the rest of the forms system what CSS and JS is needed to display the input |
|
315 | + * |
|
316 | + * @param array $iframe_css |
|
317 | + * @return array |
|
318 | + */ |
|
319 | + public static function iframeCss(array $iframe_css) |
|
320 | + { |
|
321 | + $iframe_css['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css'; |
|
322 | + return $iframe_css; |
|
323 | + } |
|
324 | + |
|
325 | + |
|
326 | + /** |
|
327 | + * Informs the rest of the forms system what CSS and JS is needed to display the input |
|
328 | + * |
|
329 | + * @param array $iframe_js |
|
330 | + * @return array |
|
331 | + */ |
|
332 | + public static function iframeJs(array $iframe_js) |
|
333 | + { |
|
334 | + $iframe_js['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js'; |
|
335 | + return $iframe_js; |
|
336 | + } |
|
337 | + |
|
338 | + |
|
339 | + /****************************** DEPRECATED ******************************/ |
|
340 | + |
|
341 | + |
|
342 | + /** |
|
343 | + * @deprecated |
|
344 | + * @return string |
|
345 | + * @throws EE_Error |
|
346 | + */ |
|
347 | + public static function display_view_details_btn() |
|
348 | + { |
|
349 | + // todo add doing_it_wrong() notice during next major version |
|
350 | + return EED_Ticket_Selector::ticketSelector()->displayViewDetailsButton(); |
|
351 | + } |
|
352 | + |
|
353 | + |
|
354 | + /** |
|
355 | + * @deprecated |
|
356 | + * @return string |
|
357 | + * @throws EE_Error |
|
358 | + */ |
|
359 | + public static function display_ticket_selector_submit() |
|
360 | + { |
|
361 | + // todo add doing_it_wrong() notice during next major version |
|
362 | + return EED_Ticket_Selector::ticketSelector()->displaySubmitButton(); |
|
363 | + } |
|
364 | + |
|
365 | + |
|
366 | + /** |
|
367 | + * @deprecated |
|
368 | + * @param string $permalink_string |
|
369 | + * @param int $id |
|
370 | + * @param string $new_title |
|
371 | + * @param string $new_slug |
|
372 | + * @return string |
|
373 | + * @throws InvalidArgumentException |
|
374 | + * @throws InvalidDataTypeException |
|
375 | + * @throws InvalidInterfaceException |
|
376 | + */ |
|
377 | + public static function iframe_code_button($permalink_string, $id, $new_title = '', $new_slug = '') |
|
378 | + { |
|
379 | + // todo add doing_it_wrong() notice during next major version |
|
380 | + if (EE_Registry::instance()->REQ->get('page') === 'espresso_events' |
|
381 | + && EE_Registry::instance()->REQ->get('action') === 'edit' |
|
382 | + ) { |
|
383 | + $iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton(); |
|
384 | + $iframe_embed_button->addEventEditorIframeEmbedButton(); |
|
385 | + } |
|
386 | + return ''; |
|
387 | + } |
|
388 | + |
|
389 | + |
|
390 | + /** |
|
391 | + * @deprecated |
|
392 | + * @param int $ID |
|
393 | + * @param string $external_url |
|
394 | + * @return string |
|
395 | + */ |
|
396 | + public static function ticket_selector_form_open($ID = 0, $external_url = '') |
|
397 | + { |
|
398 | + // todo add doing_it_wrong() notice during next major version |
|
399 | + return EED_Ticket_Selector::ticketSelector()->formOpen($ID, $external_url); |
|
400 | + } |
|
401 | + |
|
402 | + |
|
403 | + /** |
|
404 | + * @deprecated |
|
405 | + * @return string |
|
406 | + */ |
|
407 | + public static function ticket_selector_form_close() |
|
408 | + { |
|
409 | + // todo add doing_it_wrong() notice during next major version |
|
410 | + return EED_Ticket_Selector::ticketSelector()->formClose(); |
|
411 | + } |
|
412 | + |
|
413 | + |
|
414 | + /** |
|
415 | + * @deprecated |
|
416 | + * @return string |
|
417 | + */ |
|
418 | + public static function no_tkt_slctr_end_dv() |
|
419 | + { |
|
420 | + // todo add doing_it_wrong() notice during next major version |
|
421 | + return EED_Ticket_Selector::ticketSelector()->ticketSelectorEndDiv(); |
|
422 | + } |
|
423 | + |
|
424 | + |
|
425 | + /** |
|
426 | + * @deprecated 4.9.13 |
|
427 | + * @return string |
|
428 | + */ |
|
429 | + public static function tkt_slctr_end_dv() |
|
430 | + { |
|
431 | + return EED_Ticket_Selector::ticketSelector()->clearTicketSelector(); |
|
432 | + } |
|
433 | + |
|
434 | + |
|
435 | + /** |
|
436 | + * @deprecated |
|
437 | + * @return string |
|
438 | + */ |
|
439 | + public static function clear_tkt_slctr() |
|
440 | + { |
|
441 | + return EED_Ticket_Selector::ticketSelector()->clearTicketSelector(); |
|
442 | + } |
|
443 | + |
|
444 | + |
|
445 | + /** |
|
446 | + * @deprecated |
|
447 | + */ |
|
448 | + public static function load_tckt_slctr_assets_admin() |
|
449 | + { |
|
450 | + // todo add doing_it_wrong() notice during next major version |
|
451 | + if (EE_Registry::instance()->REQ->get('page') === 'espresso_events' |
|
452 | + && EE_Registry::instance()->REQ->get('action') === 'edit' |
|
453 | + ) { |
|
454 | + $iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton(); |
|
455 | + $iframe_embed_button->embedButtonAssets(); |
|
456 | + } |
|
457 | + } |
|
458 | 458 | } |
@@ -120,13 +120,13 @@ discard block |
||
120 | 120 | if (defined('TICKET_SELECTOR_ASSETS_URL')) { |
121 | 121 | return; |
122 | 122 | } |
123 | - define('TICKET_SELECTOR_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets' . DS); |
|
123 | + define('TICKET_SELECTOR_ASSETS_URL', plugin_dir_url(__FILE__).'assets'.DS); |
|
124 | 124 | define( |
125 | 125 | 'TICKET_SELECTOR_TEMPLATES_PATH', |
126 | - str_replace('\\', DS, plugin_dir_path(__FILE__)) . 'templates' . DS |
|
126 | + str_replace('\\', DS, plugin_dir_path(__FILE__)).'templates'.DS |
|
127 | 127 | ); |
128 | 128 | // if config is not set, initialize |
129 | - if (! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config |
|
129 | + if ( ! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config |
|
130 | 130 | ) { |
131 | 131 | EED_Ticket_Selector::instance()->set_config(); |
132 | 132 | EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector = EED_Ticket_Selector::instance( |
@@ -140,7 +140,7 @@ discard block |
||
140 | 140 | */ |
141 | 141 | public static function ticketSelector() |
142 | 142 | { |
143 | - if (! EED_Ticket_Selector::$ticket_selector instanceof DisplayTicketSelector) { |
|
143 | + if ( ! EED_Ticket_Selector::$ticket_selector instanceof DisplayTicketSelector) { |
|
144 | 144 | EED_Ticket_Selector::$ticket_selector = new DisplayTicketSelector(EED_Events_Archive::is_iframe()); |
145 | 145 | } |
146 | 146 | return EED_Ticket_Selector::$ticket_selector; |
@@ -163,7 +163,7 @@ discard block |
||
163 | 163 | */ |
164 | 164 | public static function getIframeEmbedButton() |
165 | 165 | { |
166 | - if (! self::$iframe_embed_button instanceof TicketSelectorIframeEmbedButton) { |
|
166 | + if ( ! self::$iframe_embed_button instanceof TicketSelectorIframeEmbedButton) { |
|
167 | 167 | self::$iframe_embed_button = new TicketSelectorIframeEmbedButton(); |
168 | 168 | } |
169 | 169 | return self::$iframe_embed_button; |
@@ -263,7 +263,7 @@ discard block |
||
263 | 263 | // add some style |
264 | 264 | wp_register_style( |
265 | 265 | 'ticket_selector', |
266 | - TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css', |
|
266 | + TICKET_SELECTOR_ASSETS_URL.'ticket_selector.css', |
|
267 | 267 | array(), |
268 | 268 | EVENT_ESPRESSO_VERSION |
269 | 269 | ); |
@@ -271,7 +271,7 @@ discard block |
||
271 | 271 | // make it dance |
272 | 272 | wp_register_script( |
273 | 273 | 'ticket_selector', |
274 | - TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js', |
|
274 | + TICKET_SELECTOR_ASSETS_URL.'ticket_selector.js', |
|
275 | 275 | array('espresso_core'), |
276 | 276 | EVENT_ESPRESSO_VERSION, |
277 | 277 | true |
@@ -318,7 +318,7 @@ discard block |
||
318 | 318 | */ |
319 | 319 | public static function iframeCss(array $iframe_css) |
320 | 320 | { |
321 | - $iframe_css['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css'; |
|
321 | + $iframe_css['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL.'ticket_selector.css'; |
|
322 | 322 | return $iframe_css; |
323 | 323 | } |
324 | 324 | |
@@ -331,7 +331,7 @@ discard block |
||
331 | 331 | */ |
332 | 332 | public static function iframeJs(array $iframe_js) |
333 | 333 | { |
334 | - $iframe_js['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js'; |
|
334 | + $iframe_js['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL.'ticket_selector.js'; |
|
335 | 335 | return $iframe_js; |
336 | 336 | } |
337 | 337 |