@@ -57,7 +57,7 @@ |
||
57 | 57 | * check whether count of tickets is approaching the potential |
58 | 58 | * limits for the server. |
59 | 59 | */ |
60 | - if (! empty($data['input_count'])) { |
|
60 | + if ( ! empty($data['input_count'])) { |
|
61 | 61 | $response['max_input_vars_check'] = $this->environment->max_input_vars_limit_check( |
62 | 62 | $data['input_count'] |
63 | 63 | ); |
@@ -15,52 +15,52 @@ |
||
15 | 15 | */ |
16 | 16 | class EventEditorHeartbeat |
17 | 17 | { |
18 | - /** |
|
19 | - * @var Domain $domain |
|
20 | - */ |
|
21 | - protected $domain; |
|
18 | + /** |
|
19 | + * @var Domain $domain |
|
20 | + */ |
|
21 | + protected $domain; |
|
22 | 22 | |
23 | - /** |
|
24 | - * @var EE_Environment_Config $environment |
|
25 | - */ |
|
26 | - protected $environment; |
|
23 | + /** |
|
24 | + * @var EE_Environment_Config $environment |
|
25 | + */ |
|
26 | + protected $environment; |
|
27 | 27 | |
28 | 28 | |
29 | - /** |
|
30 | - * EventEditorHeartbeat constructor. |
|
31 | - * |
|
32 | - * @param Domain $domain |
|
33 | - * @param EE_Environment_Config $environment |
|
34 | - */ |
|
35 | - public function __construct(Domain $domain, EE_Environment_Config $environment) |
|
36 | - { |
|
37 | - $this->domain = $domain; |
|
38 | - $this->environment = $environment; |
|
39 | - if ($this->domain->isCaffeinated()) { |
|
40 | - add_filter('heartbeat_received', array($this, 'heartbeatResponse'), 10, 2); |
|
41 | - } |
|
42 | - } |
|
29 | + /** |
|
30 | + * EventEditorHeartbeat constructor. |
|
31 | + * |
|
32 | + * @param Domain $domain |
|
33 | + * @param EE_Environment_Config $environment |
|
34 | + */ |
|
35 | + public function __construct(Domain $domain, EE_Environment_Config $environment) |
|
36 | + { |
|
37 | + $this->domain = $domain; |
|
38 | + $this->environment = $environment; |
|
39 | + if ($this->domain->isCaffeinated()) { |
|
40 | + add_filter('heartbeat_received', array($this, 'heartbeatResponse'), 10, 2); |
|
41 | + } |
|
42 | + } |
|
43 | 43 | |
44 | 44 | |
45 | - /** |
|
46 | - * This will be used to listen for any heartbeat data packages coming via the WordPress heartbeat API and handle |
|
47 | - * accordingly. |
|
48 | - * |
|
49 | - * @param array $response The existing heartbeat response array. |
|
50 | - * @param array $data The incoming data package. |
|
51 | - * @return array possibly appended response. |
|
52 | - */ |
|
53 | - public function heartbeatResponse($response, $data) |
|
54 | - { |
|
55 | - /** |
|
56 | - * check whether count of tickets is approaching the potential |
|
57 | - * limits for the server. |
|
58 | - */ |
|
59 | - if (! empty($data['input_count'])) { |
|
60 | - $response['max_input_vars_check'] = $this->environment->max_input_vars_limit_check( |
|
61 | - $data['input_count'] |
|
62 | - ); |
|
63 | - } |
|
64 | - return $response; |
|
65 | - } |
|
45 | + /** |
|
46 | + * This will be used to listen for any heartbeat data packages coming via the WordPress heartbeat API and handle |
|
47 | + * accordingly. |
|
48 | + * |
|
49 | + * @param array $response The existing heartbeat response array. |
|
50 | + * @param array $data The incoming data package. |
|
51 | + * @return array possibly appended response. |
|
52 | + */ |
|
53 | + public function heartbeatResponse($response, $data) |
|
54 | + { |
|
55 | + /** |
|
56 | + * check whether count of tickets is approaching the potential |
|
57 | + * limits for the server. |
|
58 | + */ |
|
59 | + if (! empty($data['input_count'])) { |
|
60 | + $response['max_input_vars_check'] = $this->environment->max_input_vars_limit_check( |
|
61 | + $data['input_count'] |
|
62 | + ); |
|
63 | + } |
|
64 | + return $response; |
|
65 | + } |
|
66 | 66 | } |
@@ -19,53 +19,53 @@ |
||
19 | 19 | */ |
20 | 20 | class SettingsForm extends PayPalSettingsForm |
21 | 21 | { |
22 | - /** |
|
23 | - * SettingsForm constructor. |
|
24 | - * |
|
25 | - * @param array $options_array |
|
26 | - * @param string $help_tab_link |
|
27 | - * @throws InvalidDataTypeException |
|
28 | - * @throws InvalidInterfaceException |
|
29 | - * @throws InvalidArgumentException |
|
30 | - */ |
|
31 | - public function __construct(array $options_array = array(), $help_tab_link = '') |
|
32 | - { |
|
33 | - $options_array = array_replace_recursive( |
|
34 | - array( |
|
35 | - 'extra_meta_inputs' => array( |
|
36 | - 'request_shipping_addr' => new EE_Yes_No_Input( |
|
37 | - array( |
|
38 | - 'html_label_text' => sprintf( |
|
39 | - esc_html__('Request Shipping Address %s', 'event_espresso'), |
|
40 | - $help_tab_link |
|
41 | - ), |
|
42 | - 'html_help_text' => esc_html__( |
|
43 | - // @codingStandardsIgnoreStart |
|
44 | - 'If set to "Yes", then a shipping address will be requested on the PayPal checkout page.', |
|
45 | - // @codingStandardsIgnoreEnd |
|
46 | - 'event_espresso' |
|
47 | - ), |
|
48 | - 'required' => true, |
|
49 | - 'default' => false, |
|
50 | - ) |
|
51 | - ), |
|
52 | - 'image_url' => new EE_Admin_File_Uploader_Input( |
|
53 | - array( |
|
54 | - 'html_label_text' => sprintf( |
|
55 | - esc_html__('Image URL %s', 'event_espresso'), |
|
56 | - $help_tab_link |
|
57 | - ), |
|
58 | - 'html_help_text' => esc_html__( |
|
59 | - 'Used for your business/personal logo on the PayPal page', |
|
60 | - 'event_espresso' |
|
61 | - ), |
|
62 | - 'required' => false, |
|
63 | - ) |
|
64 | - ), |
|
65 | - ) |
|
66 | - ), |
|
67 | - $options_array |
|
68 | - ); |
|
69 | - parent::__construct($options_array, $help_tab_link); |
|
70 | - } |
|
22 | + /** |
|
23 | + * SettingsForm constructor. |
|
24 | + * |
|
25 | + * @param array $options_array |
|
26 | + * @param string $help_tab_link |
|
27 | + * @throws InvalidDataTypeException |
|
28 | + * @throws InvalidInterfaceException |
|
29 | + * @throws InvalidArgumentException |
|
30 | + */ |
|
31 | + public function __construct(array $options_array = array(), $help_tab_link = '') |
|
32 | + { |
|
33 | + $options_array = array_replace_recursive( |
|
34 | + array( |
|
35 | + 'extra_meta_inputs' => array( |
|
36 | + 'request_shipping_addr' => new EE_Yes_No_Input( |
|
37 | + array( |
|
38 | + 'html_label_text' => sprintf( |
|
39 | + esc_html__('Request Shipping Address %s', 'event_espresso'), |
|
40 | + $help_tab_link |
|
41 | + ), |
|
42 | + 'html_help_text' => esc_html__( |
|
43 | + // @codingStandardsIgnoreStart |
|
44 | + 'If set to "Yes", then a shipping address will be requested on the PayPal checkout page.', |
|
45 | + // @codingStandardsIgnoreEnd |
|
46 | + 'event_espresso' |
|
47 | + ), |
|
48 | + 'required' => true, |
|
49 | + 'default' => false, |
|
50 | + ) |
|
51 | + ), |
|
52 | + 'image_url' => new EE_Admin_File_Uploader_Input( |
|
53 | + array( |
|
54 | + 'html_label_text' => sprintf( |
|
55 | + esc_html__('Image URL %s', 'event_espresso'), |
|
56 | + $help_tab_link |
|
57 | + ), |
|
58 | + 'html_help_text' => esc_html__( |
|
59 | + 'Used for your business/personal logo on the PayPal page', |
|
60 | + 'event_espresso' |
|
61 | + ), |
|
62 | + 'required' => false, |
|
63 | + ) |
|
64 | + ), |
|
65 | + ) |
|
66 | + ), |
|
67 | + $options_array |
|
68 | + ); |
|
69 | + parent::__construct($options_array, $help_tab_link); |
|
70 | + } |
|
71 | 71 | } |
@@ -1,8 +1,8 @@ |
||
1 | 1 | <div class="padding"> |
2 | 2 | <p><?php |
3 | - printf( |
|
4 | - esc_html__('Check out the %1$sroadmap for Event Espresso%2$s.', 'event_espresso'), |
|
5 | - '<a href="https://trello.com/b/zg9DCIpe/event-espresso-public-roadmap" target="_blank" rel="noopener noreferrer">', |
|
6 | - '</a>' |
|
7 | - ); ?></p> |
|
3 | + printf( |
|
4 | + esc_html__('Check out the %1$sroadmap for Event Espresso%2$s.', 'event_espresso'), |
|
5 | + '<a href="https://trello.com/b/zg9DCIpe/event-espresso-public-roadmap" target="_blank" rel="noopener noreferrer">', |
|
6 | + '</a>' |
|
7 | + ); ?></p> |
|
8 | 8 | </div> |
9 | 9 | \ No newline at end of file |
@@ -1,93 +1,93 @@ |
||
1 | 1 | <div class="padding"> |
2 | 2 | <?php esc_html_e( |
3 | - 'If you want to integrate with Event Espresso or participate in building code, then you are in the right place. The following resources can help you get started.', |
|
4 | - 'event_espresso' |
|
5 | - ); ?> |
|
3 | + 'If you want to integrate with Event Espresso or participate in building code, then you are in the right place. The following resources can help you get started.', |
|
4 | + 'event_espresso' |
|
5 | + ); ?> |
|
6 | 6 | <h2><?php esc_html_e('Developer Resources', 'event_espresso'); ?></h2> |
7 | 7 | <ul> |
8 | 8 | <li> |
9 | 9 | <?php printf( |
10 | - esc_html__('%1$sEvent Espresso 4 Developer Documentation%2$s', 'event_espresso'), |
|
11 | - '<a href="https://github.com/eventespresso/event-espresso-core/tree/master/docs#getting-started-with-the-ee-developer-docs" target="_blank" rel="noopener noreferrer">', |
|
12 | - '</a>' |
|
13 | - ); ?></li> |
|
10 | + esc_html__('%1$sEvent Espresso 4 Developer Documentation%2$s', 'event_espresso'), |
|
11 | + '<a href="https://github.com/eventespresso/event-espresso-core/tree/master/docs#getting-started-with-the-ee-developer-docs" target="_blank" rel="noopener noreferrer">', |
|
12 | + '</a>' |
|
13 | + ); ?></li> |
|
14 | 14 | <li> |
15 | 15 | <?php printf( |
16 | - esc_html__('%1$sEvent Espresso 4 Developer News%2$s', 'event_espresso'), |
|
17 | - '<a href="http://developer.eventespresso.com/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">', |
|
18 | - '</a>' |
|
19 | - ); ?></li> |
|
16 | + esc_html__('%1$sEvent Espresso 4 Developer News%2$s', 'event_espresso'), |
|
17 | + '<a href="http://developer.eventespresso.com/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">', |
|
18 | + '</a>' |
|
19 | + ); ?></li> |
|
20 | 20 | <li> |
21 | 21 | <?php printf( |
22 | - esc_html__('%1$sApply%2$s to be listed as an %3$sEvent Espresso Professional%2$s', 'event_espresso'), |
|
23 | - '<a href="https://eventespresso.com/developers/event-espresso-pros-application/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">', |
|
24 | - '</a>', |
|
25 | - '<a href="https://eventespresso.com/developers/event-espresso-pros/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">' |
|
26 | - ); ?></li> |
|
22 | + esc_html__('%1$sApply%2$s to be listed as an %3$sEvent Espresso Professional%2$s', 'event_espresso'), |
|
23 | + '<a href="https://eventespresso.com/developers/event-espresso-pros-application/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">', |
|
24 | + '</a>', |
|
25 | + '<a href="https://eventespresso.com/developers/event-espresso-pros/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">' |
|
26 | + ); ?></li> |
|
27 | 27 | </ul> |
28 | 28 | |
29 | 29 | <h2><?php esc_html_e('Event Espresso 4 Articles for Developers', 'event_espresso'); ?></h2> |
30 | 30 | <ul> |
31 | 31 | <li> |
32 | 32 | <?php printf( |
33 | - esc_html__('%1$sCustom Post Types Usage%2$s', 'event_espresso'), |
|
34 | - '<a href="https://eventespresso.com/2014/02/epsresso-brewery-custom-post-types-event-espresso/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">', |
|
35 | - '</a>' |
|
36 | - ); ?></li> |
|
33 | + esc_html__('%1$sCustom Post Types Usage%2$s', 'event_espresso'), |
|
34 | + '<a href="https://eventespresso.com/2014/02/epsresso-brewery-custom-post-types-event-espresso/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">', |
|
35 | + '</a>' |
|
36 | + ); ?></li> |
|
37 | 37 | <li> |
38 | 38 | <?php printf( |
39 | - esc_html__('%1$sTheme Development%2$s', 'event_espresso'), |
|
40 | - '<a href="https://eventespresso.com/2014/02/developers-corner-theming-event-espresso-4/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">', |
|
41 | - '</a>' |
|
42 | - ); ?></li> |
|
39 | + esc_html__('%1$sTheme Development%2$s', 'event_espresso'), |
|
40 | + '<a href="https://eventespresso.com/2014/02/developers-corner-theming-event-espresso-4/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">', |
|
41 | + '</a>' |
|
42 | + ); ?></li> |
|
43 | 43 | <li> |
44 | 44 | <?php printf( |
45 | - esc_html__('%1$sCapability System%2$s', 'event_espresso'), |
|
46 | - '<a href="http://developer.eventespresso.com/docs/ee-capability-system-overview/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">', |
|
47 | - '</a>' |
|
48 | - ); ?></li> |
|
45 | + esc_html__('%1$sCapability System%2$s', 'event_espresso'), |
|
46 | + '<a href="http://developer.eventespresso.com/docs/ee-capability-system-overview/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">', |
|
47 | + '</a>' |
|
48 | + ); ?></li> |
|
49 | 49 | <li> |
50 | 50 | <?php printf( |
51 | - esc_html__('%1$sPayment Method Development%2$s', 'event_espresso'), |
|
52 | - '<a href="https://github.com/eventespresso/event-espresso-core/blob/master/docs/L--Payment-Methods-and-Gateways/creating-a-payment-method.md" target="_blank" rel="noopener noreferrer">', |
|
53 | - '</a>' |
|
54 | - ); ?></li> |
|
51 | + esc_html__('%1$sPayment Method Development%2$s', 'event_espresso'), |
|
52 | + '<a href="https://github.com/eventespresso/event-espresso-core/blob/master/docs/L--Payment-Methods-and-Gateways/creating-a-payment-method.md" target="_blank" rel="noopener noreferrer">', |
|
53 | + '</a>' |
|
54 | + ); ?></li> |
|
55 | 55 | <li> |
56 | 56 | <?php printf( |
57 | - esc_html__('%1$sMessages System in Event Espresso 4%2$s', 'event_espresso'), |
|
58 | - '<a href="https://eventespresso.com/2014/03/messages-systemyour-tool-getting-word/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">', |
|
59 | - '</a>' |
|
60 | - ); ?></li> |
|
57 | + esc_html__('%1$sMessages System in Event Espresso 4%2$s', 'event_espresso'), |
|
58 | + '<a href="https://eventespresso.com/2014/03/messages-systemyour-tool-getting-word/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">', |
|
59 | + '</a>' |
|
60 | + ); ?></li> |
|
61 | 61 | <li> |
62 | 62 | <?php printf( |
63 | - esc_html__( |
|
64 | - '%1$sDatabase Model System%2$s (used for interfacing with EE4 data via WordPress plugins and server side querying)', |
|
65 | - 'event_espresso' |
|
66 | - ), |
|
67 | - '<a href="http://developer.eventespresso.com/docs/using-ee4-model-objects/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">', |
|
68 | - '</a>' |
|
69 | - ); ?></li> |
|
63 | + esc_html__( |
|
64 | + '%1$sDatabase Model System%2$s (used for interfacing with EE4 data via WordPress plugins and server side querying)', |
|
65 | + 'event_espresso' |
|
66 | + ), |
|
67 | + '<a href="http://developer.eventespresso.com/docs/using-ee4-model-objects/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">', |
|
68 | + '</a>' |
|
69 | + ); ?></li> |
|
70 | 70 | </ul> |
71 | 71 | |
72 | 72 | <h2><?php esc_html_e('REST API Resources', 'event_espresso'); ?></h2> |
73 | 73 | <ul> |
74 | 74 | <li> |
75 | 75 | <?php printf( |
76 | - esc_html__('%1$sREST API: Introduction%2$s', 'event_espresso'), |
|
77 | - '<a href="https://github.com/eventespresso/event-espresso-core/blob/master/docs/C--REST-API/ee4-rest-api-introduction.md" target="_blank" rel="noopener noreferrer">', |
|
78 | - '</a>' |
|
79 | - ); ?></li> |
|
76 | + esc_html__('%1$sREST API: Introduction%2$s', 'event_espresso'), |
|
77 | + '<a href="https://github.com/eventespresso/event-espresso-core/blob/master/docs/C--REST-API/ee4-rest-api-introduction.md" target="_blank" rel="noopener noreferrer">', |
|
78 | + '</a>' |
|
79 | + ); ?></li> |
|
80 | 80 | <li> |
81 | 81 | <?php printf( |
82 | - esc_html__('%1$sREST API: Reading Data%2$s', 'event_espresso'), |
|
83 | - '<a href="https://github.com/eventespresso/event-espresso-core/blob/master/docs/C--REST-API/ee4-rest-api-reading-data.md" target="_blank" rel="noopener noreferrer">', |
|
84 | - '</a>' |
|
85 | - ); ?></li> |
|
82 | + esc_html__('%1$sREST API: Reading Data%2$s', 'event_espresso'), |
|
83 | + '<a href="https://github.com/eventespresso/event-espresso-core/blob/master/docs/C--REST-API/ee4-rest-api-reading-data.md" target="_blank" rel="noopener noreferrer">', |
|
84 | + '</a>' |
|
85 | + ); ?></li> |
|
86 | 86 | <li> |
87 | 87 | <?php printf( |
88 | - esc_html__('%1$sBuilding an EE4 Add-on Using the REST API%2$s', 'event_espresso'), |
|
89 | - '<a href="https://github.com/eventespresso/event-espresso-core/blob/master/docs/T--Tutorials/building-an-ee4-addon-that-uses-angular-js-and-the-ee4-json-rest-api.md" target="_blank" rel="noopener noreferrer">', |
|
90 | - '</a>' |
|
91 | - ); ?></li> |
|
88 | + esc_html__('%1$sBuilding an EE4 Add-on Using the REST API%2$s', 'event_espresso'), |
|
89 | + '<a href="https://github.com/eventespresso/event-espresso-core/blob/master/docs/T--Tutorials/building-an-ee4-addon-that-uses-angular-js-and-the-ee4-json-rest-api.md" target="_blank" rel="noopener noreferrer">', |
|
90 | + '</a>' |
|
91 | + ); ?></li> |
|
92 | 92 | </ul> |
93 | 93 | </div> |
94 | 94 | \ No newline at end of file |
@@ -93,7 +93,7 @@ discard block |
||
93 | 93 | */ |
94 | 94 | public function getType() |
95 | 95 | { |
96 | - if (!$this->type) { |
|
96 | + if ( ! $this->type) { |
|
97 | 97 | $this->type = $this->determineType(); |
98 | 98 | } |
99 | 99 | return $this->type; |
@@ -105,7 +105,7 @@ discard block |
||
105 | 105 | */ |
106 | 106 | protected function determineType() |
107 | 107 | { |
108 | - if (!$this->getTmpFile()) { |
|
108 | + if ( ! $this->getTmpFile()) { |
|
109 | 109 | return ''; |
110 | 110 | } |
111 | 111 | $finfo = new finfo(FILEINFO_MIME_TYPE); |
@@ -119,7 +119,7 @@ discard block |
||
119 | 119 | */ |
120 | 120 | public function getExtension() |
121 | 121 | { |
122 | - if (!$this->extension) { |
|
122 | + if ( ! $this->extension) { |
|
123 | 123 | $this->extension = $this->determineExtension(); |
124 | 124 | } |
125 | 125 | return $this->extension; |
@@ -19,164 +19,164 @@ |
||
19 | 19 | */ |
20 | 20 | class FileSubmission implements FileSubmissionInterface |
21 | 21 | { |
22 | - /** |
|
23 | - * @var string original name on the client machine |
|
24 | - */ |
|
25 | - protected $name; |
|
26 | - |
|
27 | - /** |
|
28 | - * @var string mime type |
|
29 | - */ |
|
30 | - protected $type; |
|
31 | - |
|
32 | - /** |
|
33 | - * @var string file extension |
|
34 | - */ |
|
35 | - protected $extension; |
|
36 | - |
|
37 | - /** |
|
38 | - * @var int in bytes |
|
39 | - */ |
|
40 | - protected $size; |
|
41 | - |
|
42 | - /** |
|
43 | - * @var string local filepath to the temporary file |
|
44 | - */ |
|
45 | - protected $tmp_file; |
|
46 | - |
|
47 | - /** |
|
48 | - * @var int one of UPLOAD_ERR_OK, UPLOAD_ERR_NO_FILE, UPLOAD_ERR_INI_SIZE, UPLOAD_ERR_FORM_SIZE or other values |
|
49 | - * although those aren't expected. |
|
50 | - */ |
|
51 | - protected $error_code; |
|
52 | - |
|
53 | - /** |
|
54 | - * FileSubmission constructor. |
|
55 | - * @param $name |
|
56 | - * @param $tmp_file |
|
57 | - * @param $size |
|
58 | - * @param null $error_code |
|
59 | - * @throws InvalidArgumentException |
|
60 | - */ |
|
61 | - public function __construct($name, $tmp_file, $size, $error_code = null) |
|
62 | - { |
|
63 | - $this->name = basename($name); |
|
64 | - $scheme = parse_url($tmp_file, PHP_URL_SCHEME); |
|
65 | - if (in_array($scheme, ['http', 'https'])) { |
|
66 | - // Wait a minute- just local filepaths please, no URL schemes allowed! |
|
67 | - throw new InvalidArgumentException( |
|
68 | - sprintf( |
|
69 | - // @codingStandardsIgnoreStart |
|
70 | - esc_html__('The scheme ("%1$s") on the temporary file ("%2$s") indicates is located elsewhere, that’s not ok!', 'event_espresso'), |
|
71 | - // @codingStandardsIgnoreEnd |
|
72 | - $scheme, |
|
73 | - $tmp_file |
|
74 | - ) |
|
75 | - ); |
|
76 | - } |
|
77 | - $this->tmp_file = (string) $tmp_file; |
|
78 | - $this->size = (int) $size; |
|
79 | - $this->error_code = (int) $error_code; |
|
80 | - } |
|
81 | - |
|
82 | - /** |
|
83 | - * @return string |
|
84 | - */ |
|
85 | - public function getName() |
|
86 | - { |
|
87 | - return $this->name; |
|
88 | - } |
|
89 | - |
|
90 | - /** |
|
91 | - * Gets the file's mime type |
|
92 | - * @return string |
|
93 | - */ |
|
94 | - public function getType() |
|
95 | - { |
|
96 | - if (!$this->type) { |
|
97 | - $this->type = $this->determineType(); |
|
98 | - } |
|
99 | - return $this->type; |
|
100 | - } |
|
101 | - |
|
102 | - /** |
|
103 | - * @since 4.9.80.p |
|
104 | - * @return string |
|
105 | - */ |
|
106 | - protected function determineType() |
|
107 | - { |
|
108 | - if (!$this->getTmpFile()) { |
|
109 | - return ''; |
|
110 | - } |
|
111 | - $finfo = new finfo(FILEINFO_MIME_TYPE); |
|
112 | - return $finfo->file($this->getTmpFile()); |
|
113 | - } |
|
114 | - |
|
115 | - /** |
|
116 | - * Gets the file's extension. |
|
117 | - * @since 4.9.80.p |
|
118 | - * @return string |
|
119 | - */ |
|
120 | - public function getExtension() |
|
121 | - { |
|
122 | - if (!$this->extension) { |
|
123 | - $this->extension = $this->determineExtension(); |
|
124 | - } |
|
125 | - return $this->extension; |
|
126 | - } |
|
127 | - |
|
128 | - /** |
|
129 | - * Determine's the file's extension given the temporary file. |
|
130 | - * @since 4.9.80.p |
|
131 | - * @return string |
|
132 | - */ |
|
133 | - protected function determineExtension() |
|
134 | - { |
|
135 | - $position_of_period = strrpos($this->getName(), '.'); |
|
136 | - if ($position_of_period === false) { |
|
137 | - return ''; |
|
138 | - } |
|
139 | - return mb_substr( |
|
140 | - $this->getName(), |
|
141 | - $position_of_period + 1 |
|
142 | - ); |
|
143 | - } |
|
144 | - |
|
145 | - /** |
|
146 | - * Gets the size of the file |
|
147 | - * @return int |
|
148 | - */ |
|
149 | - public function getSize() |
|
150 | - { |
|
151 | - return $this->size; |
|
152 | - } |
|
153 | - |
|
154 | - /** |
|
155 | - * Gets the path to the temporary file which was uploaded. |
|
156 | - * @return string |
|
157 | - */ |
|
158 | - public function getTmpFile() |
|
159 | - { |
|
160 | - return $this->tmp_file; |
|
161 | - } |
|
162 | - |
|
163 | - /** |
|
164 | - * @since 4.9.80.p |
|
165 | - * @return string |
|
166 | - */ |
|
167 | - public function __toString() |
|
168 | - { |
|
169 | - return $this->getName(); |
|
170 | - } |
|
171 | - |
|
172 | - /** |
|
173 | - * Gets the error code PHP reported for the file upload. |
|
174 | - * @return string |
|
175 | - */ |
|
176 | - public function getErrorCode() |
|
177 | - { |
|
178 | - return $this->error_code; |
|
179 | - } |
|
22 | + /** |
|
23 | + * @var string original name on the client machine |
|
24 | + */ |
|
25 | + protected $name; |
|
26 | + |
|
27 | + /** |
|
28 | + * @var string mime type |
|
29 | + */ |
|
30 | + protected $type; |
|
31 | + |
|
32 | + /** |
|
33 | + * @var string file extension |
|
34 | + */ |
|
35 | + protected $extension; |
|
36 | + |
|
37 | + /** |
|
38 | + * @var int in bytes |
|
39 | + */ |
|
40 | + protected $size; |
|
41 | + |
|
42 | + /** |
|
43 | + * @var string local filepath to the temporary file |
|
44 | + */ |
|
45 | + protected $tmp_file; |
|
46 | + |
|
47 | + /** |
|
48 | + * @var int one of UPLOAD_ERR_OK, UPLOAD_ERR_NO_FILE, UPLOAD_ERR_INI_SIZE, UPLOAD_ERR_FORM_SIZE or other values |
|
49 | + * although those aren't expected. |
|
50 | + */ |
|
51 | + protected $error_code; |
|
52 | + |
|
53 | + /** |
|
54 | + * FileSubmission constructor. |
|
55 | + * @param $name |
|
56 | + * @param $tmp_file |
|
57 | + * @param $size |
|
58 | + * @param null $error_code |
|
59 | + * @throws InvalidArgumentException |
|
60 | + */ |
|
61 | + public function __construct($name, $tmp_file, $size, $error_code = null) |
|
62 | + { |
|
63 | + $this->name = basename($name); |
|
64 | + $scheme = parse_url($tmp_file, PHP_URL_SCHEME); |
|
65 | + if (in_array($scheme, ['http', 'https'])) { |
|
66 | + // Wait a minute- just local filepaths please, no URL schemes allowed! |
|
67 | + throw new InvalidArgumentException( |
|
68 | + sprintf( |
|
69 | + // @codingStandardsIgnoreStart |
|
70 | + esc_html__('The scheme ("%1$s") on the temporary file ("%2$s") indicates is located elsewhere, that’s not ok!', 'event_espresso'), |
|
71 | + // @codingStandardsIgnoreEnd |
|
72 | + $scheme, |
|
73 | + $tmp_file |
|
74 | + ) |
|
75 | + ); |
|
76 | + } |
|
77 | + $this->tmp_file = (string) $tmp_file; |
|
78 | + $this->size = (int) $size; |
|
79 | + $this->error_code = (int) $error_code; |
|
80 | + } |
|
81 | + |
|
82 | + /** |
|
83 | + * @return string |
|
84 | + */ |
|
85 | + public function getName() |
|
86 | + { |
|
87 | + return $this->name; |
|
88 | + } |
|
89 | + |
|
90 | + /** |
|
91 | + * Gets the file's mime type |
|
92 | + * @return string |
|
93 | + */ |
|
94 | + public function getType() |
|
95 | + { |
|
96 | + if (!$this->type) { |
|
97 | + $this->type = $this->determineType(); |
|
98 | + } |
|
99 | + return $this->type; |
|
100 | + } |
|
101 | + |
|
102 | + /** |
|
103 | + * @since 4.9.80.p |
|
104 | + * @return string |
|
105 | + */ |
|
106 | + protected function determineType() |
|
107 | + { |
|
108 | + if (!$this->getTmpFile()) { |
|
109 | + return ''; |
|
110 | + } |
|
111 | + $finfo = new finfo(FILEINFO_MIME_TYPE); |
|
112 | + return $finfo->file($this->getTmpFile()); |
|
113 | + } |
|
114 | + |
|
115 | + /** |
|
116 | + * Gets the file's extension. |
|
117 | + * @since 4.9.80.p |
|
118 | + * @return string |
|
119 | + */ |
|
120 | + public function getExtension() |
|
121 | + { |
|
122 | + if (!$this->extension) { |
|
123 | + $this->extension = $this->determineExtension(); |
|
124 | + } |
|
125 | + return $this->extension; |
|
126 | + } |
|
127 | + |
|
128 | + /** |
|
129 | + * Determine's the file's extension given the temporary file. |
|
130 | + * @since 4.9.80.p |
|
131 | + * @return string |
|
132 | + */ |
|
133 | + protected function determineExtension() |
|
134 | + { |
|
135 | + $position_of_period = strrpos($this->getName(), '.'); |
|
136 | + if ($position_of_period === false) { |
|
137 | + return ''; |
|
138 | + } |
|
139 | + return mb_substr( |
|
140 | + $this->getName(), |
|
141 | + $position_of_period + 1 |
|
142 | + ); |
|
143 | + } |
|
144 | + |
|
145 | + /** |
|
146 | + * Gets the size of the file |
|
147 | + * @return int |
|
148 | + */ |
|
149 | + public function getSize() |
|
150 | + { |
|
151 | + return $this->size; |
|
152 | + } |
|
153 | + |
|
154 | + /** |
|
155 | + * Gets the path to the temporary file which was uploaded. |
|
156 | + * @return string |
|
157 | + */ |
|
158 | + public function getTmpFile() |
|
159 | + { |
|
160 | + return $this->tmp_file; |
|
161 | + } |
|
162 | + |
|
163 | + /** |
|
164 | + * @since 4.9.80.p |
|
165 | + * @return string |
|
166 | + */ |
|
167 | + public function __toString() |
|
168 | + { |
|
169 | + return $this->getName(); |
|
170 | + } |
|
171 | + |
|
172 | + /** |
|
173 | + * Gets the error code PHP reported for the file upload. |
|
174 | + * @return string |
|
175 | + */ |
|
176 | + public function getErrorCode() |
|
177 | + { |
|
178 | + return $this->error_code; |
|
179 | + } |
|
180 | 180 | } |
181 | 181 | // End of file FileSubmission.php |
182 | 182 | // Location: EventEspresso\core\services\request\files/FileSubmission.php |
@@ -10,11 +10,11 @@ |
||
10 | 10 | */ |
11 | 11 | class EE_File_Input_Display_Strategy extends EE_Text_Input_Display_Strategy |
12 | 12 | { |
13 | - /** |
|
14 | - * Override's parent to just set the type. May someday support other arguments. |
|
15 | - */ |
|
16 | - public function __construct() |
|
17 | - { |
|
18 | - parent::__construct('file'); |
|
19 | - } |
|
13 | + /** |
|
14 | + * Override's parent to just set the type. May someday support other arguments. |
|
15 | + */ |
|
16 | + public function __construct() |
|
17 | + { |
|
18 | + parent::__construct('file'); |
|
19 | + } |
|
20 | 20 | } |
@@ -55,7 +55,7 @@ |
||
55 | 55 | esc_html__('Please provide a file of the requested filetype: %1$s', 'event_espresso'), |
56 | 56 | implode(', ', $this->allowed_file_extensions) |
57 | 57 | ), |
58 | - '~.*\.(' . implode('|', $this->allowed_file_extensions) . ')$~' |
|
58 | + '~.*\.('.implode('|', $this->allowed_file_extensions).')$~' |
|
59 | 59 | ) |
60 | 60 | ); |
61 | 61 | parent::__construct($options); |
@@ -19,86 +19,86 @@ |
||
19 | 19 | */ |
20 | 20 | class EE_File_Input extends EE_Form_Input_Base |
21 | 21 | { |
22 | - /** |
|
23 | - * @var array |
|
24 | - */ |
|
25 | - protected $allowed_file_extensions; |
|
22 | + /** |
|
23 | + * @var array |
|
24 | + */ |
|
25 | + protected $allowed_file_extensions; |
|
26 | 26 | |
27 | - /** |
|
28 | - * @var array |
|
29 | - */ |
|
30 | - protected $allowed_mime_types; |
|
27 | + /** |
|
28 | + * @var array |
|
29 | + */ |
|
30 | + protected $allowed_mime_types; |
|
31 | 31 | |
32 | - /** |
|
33 | - * @param array $options |
|
34 | - * @throws InvalidArgumentException |
|
35 | - */ |
|
36 | - public function __construct($options = array()) |
|
37 | - { |
|
38 | - if (isset($options['allowed_file_extensions'])) { |
|
39 | - $this->allowed_file_extensions = (array) $options['allowed_file_extensions']; |
|
40 | - } else { |
|
41 | - $this->allowed_file_extensions = ['csv']; |
|
42 | - } |
|
43 | - if (isset($options['allowed_mime_types'])) { |
|
44 | - $this->allowed_mime_types = (array) $options['allowed_file_extensions']; |
|
45 | - } else { |
|
46 | - $this->allowed_mime_types = ['text/csv']; |
|
47 | - } |
|
32 | + /** |
|
33 | + * @param array $options |
|
34 | + * @throws InvalidArgumentException |
|
35 | + */ |
|
36 | + public function __construct($options = array()) |
|
37 | + { |
|
38 | + if (isset($options['allowed_file_extensions'])) { |
|
39 | + $this->allowed_file_extensions = (array) $options['allowed_file_extensions']; |
|
40 | + } else { |
|
41 | + $this->allowed_file_extensions = ['csv']; |
|
42 | + } |
|
43 | + if (isset($options['allowed_mime_types'])) { |
|
44 | + $this->allowed_mime_types = (array) $options['allowed_file_extensions']; |
|
45 | + } else { |
|
46 | + $this->allowed_mime_types = ['text/csv']; |
|
47 | + } |
|
48 | 48 | |
49 | - $this->_set_display_strategy(new EE_File_Input_Display_Strategy()); |
|
50 | - $this->_set_normalization_strategy(new EE_File_Normalization()); |
|
51 | - $this->add_validation_strategy( |
|
52 | - new EE_Text_Validation_Strategy( |
|
53 | - sprintf( |
|
54 | - // translators: %1$s is a list of allowed file extensions. |
|
55 | - esc_html__('Please provide a file of the requested filetype: %1$s', 'event_espresso'), |
|
56 | - implode(', ', $this->allowed_file_extensions) |
|
57 | - ), |
|
58 | - '~.*\.(' . implode('|', $this->allowed_file_extensions) . ')$~' |
|
59 | - ) |
|
60 | - ); |
|
61 | - parent::__construct($options); |
|
49 | + $this->_set_display_strategy(new EE_File_Input_Display_Strategy()); |
|
50 | + $this->_set_normalization_strategy(new EE_File_Normalization()); |
|
51 | + $this->add_validation_strategy( |
|
52 | + new EE_Text_Validation_Strategy( |
|
53 | + sprintf( |
|
54 | + // translators: %1$s is a list of allowed file extensions. |
|
55 | + esc_html__('Please provide a file of the requested filetype: %1$s', 'event_espresso'), |
|
56 | + implode(', ', $this->allowed_file_extensions) |
|
57 | + ), |
|
58 | + '~.*\.(' . implode('|', $this->allowed_file_extensions) . ')$~' |
|
59 | + ) |
|
60 | + ); |
|
61 | + parent::__construct($options); |
|
62 | 62 | |
63 | 63 | // It would be great to add this HTML attribute, but jQuery validate chokes on it. |
64 | - $this->set_other_html_attributes( |
|
65 | - $this->other_html_attributes() |
|
66 | - . ' extension="' |
|
67 | - . implode( |
|
68 | - ',', |
|
69 | - $this->allowed_file_extensions |
|
70 | - ) |
|
71 | - . '"' |
|
72 | - ); |
|
73 | - } |
|
64 | + $this->set_other_html_attributes( |
|
65 | + $this->other_html_attributes() |
|
66 | + . ' extension="' |
|
67 | + . implode( |
|
68 | + ',', |
|
69 | + $this->allowed_file_extensions |
|
70 | + ) |
|
71 | + . '"' |
|
72 | + ); |
|
73 | + } |
|
74 | 74 | |
75 | - /** |
|
76 | - * $_FILES has a really weird structure. So we let `FilesDataHandler` take care of finding the file info for |
|
77 | - * this input. |
|
78 | - * @since 4.9.80.p |
|
79 | - * @param array $req_data |
|
80 | - * @return FileSubmissionInterface |
|
81 | - * @throws InvalidArgumentException |
|
82 | - * @throws InvalidDataTypeException |
|
83 | - * @throws InvalidInterfaceException |
|
84 | - */ |
|
85 | - public function find_form_data_for_this_section($req_data) |
|
86 | - { |
|
87 | - // ignore $req_data. Files are in the files data handler. |
|
88 | - $fileDataHandler = LoaderFactory::getLoader()->getShared( |
|
89 | - 'EventEspresso\core\services\request\files\FilesDataHandler' |
|
90 | - ); |
|
91 | - return $fileDataHandler->getFileObject($this->html_name()); |
|
92 | - } |
|
75 | + /** |
|
76 | + * $_FILES has a really weird structure. So we let `FilesDataHandler` take care of finding the file info for |
|
77 | + * this input. |
|
78 | + * @since 4.9.80.p |
|
79 | + * @param array $req_data |
|
80 | + * @return FileSubmissionInterface |
|
81 | + * @throws InvalidArgumentException |
|
82 | + * @throws InvalidDataTypeException |
|
83 | + * @throws InvalidInterfaceException |
|
84 | + */ |
|
85 | + public function find_form_data_for_this_section($req_data) |
|
86 | + { |
|
87 | + // ignore $req_data. Files are in the files data handler. |
|
88 | + $fileDataHandler = LoaderFactory::getLoader()->getShared( |
|
89 | + 'EventEspresso\core\services\request\files\FilesDataHandler' |
|
90 | + ); |
|
91 | + return $fileDataHandler->getFileObject($this->html_name()); |
|
92 | + } |
|
93 | 93 | |
94 | - /** |
|
95 | - * Don't transform the file submission object into a string, thanks. |
|
96 | - * |
|
97 | - * @param string $value |
|
98 | - * @return null|string |
|
99 | - */ |
|
100 | - protected function _sanitize($value) |
|
101 | - { |
|
102 | - return $value; |
|
103 | - } |
|
94 | + /** |
|
95 | + * Don't transform the file submission object into a string, thanks. |
|
96 | + * |
|
97 | + * @param string $value |
|
98 | + * @return null|string |
|
99 | + */ |
|
100 | + protected function _sanitize($value) |
|
101 | + { |
|
102 | + return $value; |
|
103 | + } |
|
104 | 104 | } |
@@ -70,7 +70,7 @@ |
||
70 | 70 | { |
71 | 71 | global $wpdb; |
72 | 72 | $start_at_record = $this->count_records_migrated(); |
73 | - $query = "SELECT {$this->select_expression} FROM {$this->_old_table} {$this->_extra_where_sql} " . $wpdb->prepare( |
|
73 | + $query = "SELECT {$this->select_expression} FROM {$this->_old_table} {$this->_extra_where_sql} ".$wpdb->prepare( |
|
74 | 74 | "LIMIT %d, %d", |
75 | 75 | $start_at_record, |
76 | 76 | $limit |
@@ -15,89 +15,89 @@ |
||
15 | 15 | */ |
16 | 16 | abstract class EE_Data_Migration_Script_Stage_Table extends EE_Data_Migration_Script_Stage |
17 | 17 | { |
18 | - protected $_old_table; |
|
18 | + protected $_old_table; |
|
19 | 19 | |
20 | - /** |
|
21 | - * @var string The columns to select. May be overridden for children. |
|
22 | - */ |
|
23 | - protected $select_expression = '*'; |
|
20 | + /** |
|
21 | + * @var string The columns to select. May be overridden for children. |
|
22 | + */ |
|
23 | + protected $select_expression = '*'; |
|
24 | 24 | |
25 | - /** |
|
26 | - * Set in the constructor to add this sql to both the counting query in |
|
27 | - * EE_Data_Migration_Script_Stage_Table::_count_records_to_migrate() and |
|
28 | - * EE_Data_Migration_Script_Stage_Table::_get_rows(). |
|
29 | - * Eg "where column_name like '%some_value%'" |
|
30 | - * |
|
31 | - * @var string |
|
32 | - */ |
|
33 | - protected $_extra_where_sql; |
|
25 | + /** |
|
26 | + * Set in the constructor to add this sql to both the counting query in |
|
27 | + * EE_Data_Migration_Script_Stage_Table::_count_records_to_migrate() and |
|
28 | + * EE_Data_Migration_Script_Stage_Table::_get_rows(). |
|
29 | + * Eg "where column_name like '%some_value%'" |
|
30 | + * |
|
31 | + * @var string |
|
32 | + */ |
|
33 | + protected $_extra_where_sql; |
|
34 | 34 | |
35 | 35 | |
36 | - /** |
|
37 | - * IMPORTANT: if an error is encountered, or everything is finished, this stage should update its status property |
|
38 | - * accordingly. Note: it should not alter the count of items migrated. That is done in the public function that |
|
39 | - * calls this. IMPORTANT: The count of items migrated should ONLY be less than $num_items_to_migrate when it's the |
|
40 | - * last migration step, otherwise it should always return $num_items_to_migrate. (Eg, if we're migrating attendees |
|
41 | - * rows from the database, and $num_items_to_migrate is set to 50, then we SHOULD actually migrate 50 rows,but at |
|
42 | - * very least we MUST report/return 50 items migrated) |
|
43 | - * |
|
44 | - * @param int $num_items |
|
45 | - * @return int number of items ACTUALLY migrated |
|
46 | - */ |
|
47 | - public function _migration_step($num_items = 50) |
|
48 | - { |
|
49 | - $rows = $this->_get_rows($num_items); |
|
50 | - $items_actually_migrated = 0; |
|
51 | - foreach ($rows as $old_row) { |
|
52 | - $this->_migrate_old_row($old_row); |
|
53 | - $items_actually_migrated++; |
|
54 | - } |
|
55 | - if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) { |
|
56 | - $this->set_completed(); |
|
57 | - } |
|
58 | - return $items_actually_migrated; |
|
59 | - } |
|
36 | + /** |
|
37 | + * IMPORTANT: if an error is encountered, or everything is finished, this stage should update its status property |
|
38 | + * accordingly. Note: it should not alter the count of items migrated. That is done in the public function that |
|
39 | + * calls this. IMPORTANT: The count of items migrated should ONLY be less than $num_items_to_migrate when it's the |
|
40 | + * last migration step, otherwise it should always return $num_items_to_migrate. (Eg, if we're migrating attendees |
|
41 | + * rows from the database, and $num_items_to_migrate is set to 50, then we SHOULD actually migrate 50 rows,but at |
|
42 | + * very least we MUST report/return 50 items migrated) |
|
43 | + * |
|
44 | + * @param int $num_items |
|
45 | + * @return int number of items ACTUALLY migrated |
|
46 | + */ |
|
47 | + public function _migration_step($num_items = 50) |
|
48 | + { |
|
49 | + $rows = $this->_get_rows($num_items); |
|
50 | + $items_actually_migrated = 0; |
|
51 | + foreach ($rows as $old_row) { |
|
52 | + $this->_migrate_old_row($old_row); |
|
53 | + $items_actually_migrated++; |
|
54 | + } |
|
55 | + if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) { |
|
56 | + $this->set_completed(); |
|
57 | + } |
|
58 | + return $items_actually_migrated; |
|
59 | + } |
|
60 | 60 | |
61 | - /** |
|
62 | - * Gets the rows for each migration stage from the old table |
|
63 | - * |
|
64 | - * @global wpdb $wpdb |
|
65 | - * @param int $limit |
|
66 | - * @return array of arrays like $wpdb->get_results($sql, ARRAY_A) |
|
67 | - */ |
|
68 | - protected function _get_rows($limit) |
|
69 | - { |
|
70 | - global $wpdb; |
|
71 | - $start_at_record = $this->count_records_migrated(); |
|
72 | - $query = "SELECT {$this->select_expression} FROM {$this->_old_table} {$this->_extra_where_sql} " . $wpdb->prepare( |
|
73 | - "LIMIT %d, %d", |
|
74 | - $start_at_record, |
|
75 | - $limit |
|
76 | - ); |
|
77 | - return $wpdb->get_results($query, ARRAY_A); |
|
78 | - } |
|
61 | + /** |
|
62 | + * Gets the rows for each migration stage from the old table |
|
63 | + * |
|
64 | + * @global wpdb $wpdb |
|
65 | + * @param int $limit |
|
66 | + * @return array of arrays like $wpdb->get_results($sql, ARRAY_A) |
|
67 | + */ |
|
68 | + protected function _get_rows($limit) |
|
69 | + { |
|
70 | + global $wpdb; |
|
71 | + $start_at_record = $this->count_records_migrated(); |
|
72 | + $query = "SELECT {$this->select_expression} FROM {$this->_old_table} {$this->_extra_where_sql} " . $wpdb->prepare( |
|
73 | + "LIMIT %d, %d", |
|
74 | + $start_at_record, |
|
75 | + $limit |
|
76 | + ); |
|
77 | + return $wpdb->get_results($query, ARRAY_A); |
|
78 | + } |
|
79 | 79 | |
80 | 80 | |
81 | - /** |
|
82 | - * Counts the records to migrate; the public version may cache it |
|
83 | - * |
|
84 | - * @return int |
|
85 | - */ |
|
86 | - public function _count_records_to_migrate() |
|
87 | - { |
|
88 | - global $wpdb; |
|
89 | - $query = "SELECT COUNT(*) FROM {$this->_old_table} {$this->_extra_where_sql}"; |
|
90 | - $count = $wpdb->get_var($query); |
|
91 | - return $count; |
|
92 | - } |
|
81 | + /** |
|
82 | + * Counts the records to migrate; the public version may cache it |
|
83 | + * |
|
84 | + * @return int |
|
85 | + */ |
|
86 | + public function _count_records_to_migrate() |
|
87 | + { |
|
88 | + global $wpdb; |
|
89 | + $query = "SELECT COUNT(*) FROM {$this->_old_table} {$this->_extra_where_sql}"; |
|
90 | + $count = $wpdb->get_var($query); |
|
91 | + return $count; |
|
92 | + } |
|
93 | 93 | |
94 | - /** |
|
95 | - * takes care of migrating this particular row from the OLD table to whatever its |
|
96 | - * representation is in the new database. If there are errors, use $this->add_error to log them. If there is a |
|
97 | - * fatal error which prevents all future migrations, throw an exception describing it |
|
98 | - * |
|
99 | - * @param array $old_row an associative array where keys are column names and values are their values. |
|
100 | - * @return null |
|
101 | - */ |
|
102 | - abstract protected function _migrate_old_row($old_row); |
|
94 | + /** |
|
95 | + * takes care of migrating this particular row from the OLD table to whatever its |
|
96 | + * representation is in the new database. If there are errors, use $this->add_error to log them. If there is a |
|
97 | + * fatal error which prevents all future migrations, throw an exception describing it |
|
98 | + * |
|
99 | + * @param array $old_row an associative array where keys are column names and values are their values. |
|
100 | + * @return null |
|
101 | + */ |
|
102 | + abstract protected function _migrate_old_row($old_row); |
|
103 | 103 | } |
@@ -67,19 +67,19 @@ discard block |
||
67 | 67 | $html = ''; |
68 | 68 | // layout_form_begin |
69 | 69 | $html .= apply_filters( |
70 | - 'FHEE__EE_Form_Section_Layout_Base__layout_form__start__for_' . $this->_form_section->name(), |
|
70 | + 'FHEE__EE_Form_Section_Layout_Base__layout_form__start__for_'.$this->_form_section->name(), |
|
71 | 71 | $this->layout_form_begin(), |
72 | 72 | $this->_form_section |
73 | 73 | ); |
74 | 74 | // layout_form_loop |
75 | 75 | $html .= apply_filters( |
76 | - 'FHEE__EE_Form_Section_Layout_Base__layout_form__loop__for_' . $this->_form_section->name(), |
|
76 | + 'FHEE__EE_Form_Section_Layout_Base__layout_form__loop__for_'.$this->_form_section->name(), |
|
77 | 77 | $this->layout_form_loop(), |
78 | 78 | $this->_form_section |
79 | 79 | ); |
80 | 80 | // layout_form_end |
81 | 81 | $html .= apply_filters( |
82 | - 'FHEE__EE_Form_Section_Layout_Base__layout_form__end__for_' . $this->_form_section->name(), |
|
82 | + 'FHEE__EE_Form_Section_Layout_Base__layout_form__end__for_'.$this->_form_section->name(), |
|
83 | 83 | $this->layout_form_end(), |
84 | 84 | $this->_form_section |
85 | 85 | ); |
@@ -100,7 +100,7 @@ discard block |
||
100 | 100 | if ($subsection instanceof EE_Form_Input_Base) { |
101 | 101 | $html .= apply_filters( |
102 | 102 | 'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_input_' |
103 | - . $name . '__in_' . $this->_form_section->name(), |
|
103 | + . $name.'__in_'.$this->_form_section->name(), |
|
104 | 104 | $this->layout_input($subsection), |
105 | 105 | $this->_form_section, |
106 | 106 | $subsection |
@@ -108,7 +108,7 @@ discard block |
||
108 | 108 | } elseif ($subsection instanceof EE_Form_Section_Base) { |
109 | 109 | $html .= apply_filters( |
110 | 110 | 'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_non_input_' |
111 | - . $name . '__in_' . $this->_form_section->name(), |
|
111 | + . $name.'__in_'.$this->_form_section->name(), |
|
112 | 112 | $this->layout_subsection($subsection), |
113 | 113 | $this->_form_section, |
114 | 114 | $subsection |
@@ -177,10 +177,10 @@ discard block |
||
177 | 177 | return ''; |
178 | 178 | } |
179 | 179 | $class = $input->required() |
180 | - ? 'ee-required-label ' . $input->html_label_class() |
|
180 | + ? 'ee-required-label '.$input->html_label_class() |
|
181 | 181 | : $input->html_label_class(); |
182 | 182 | $label_text = $input->required() |
183 | - ? $input->html_label_text() . '<span class="ee-asterisk">*</span>' |
|
183 | + ? $input->html_label_text().'<span class="ee-asterisk">*</span>' |
|
184 | 184 | : $input->html_label_text(); |
185 | 185 | return '<label id="' |
186 | 186 | . $input->html_label_id() |
@@ -188,7 +188,7 @@ discard block |
||
188 | 188 | . $class |
189 | 189 | . '" style="' |
190 | 190 | . $input->html_label_style() |
191 | - . '" for="' . $input->html_id() |
|
191 | + . '" for="'.$input->html_id() |
|
192 | 192 | . '">' |
193 | 193 | . $label_text |
194 | 194 | . '</label>'; |
@@ -210,7 +210,7 @@ discard block |
||
210 | 210 | // get all the errors on THIS form section (errors which aren't |
211 | 211 | // for specific inputs, but instead for the entire form section) |
212 | 212 | foreach ($this->_form_section->get_validation_errors() as $error) { |
213 | - $html .= $error->getMessage() . '<br>'; |
|
213 | + $html .= $error->getMessage().'<br>'; |
|
214 | 214 | } |
215 | 215 | $html .= '</div>'; |
216 | 216 | } |
@@ -254,7 +254,7 @@ discard block |
||
254 | 254 | */ |
255 | 255 | public function display_help_text($input) |
256 | 256 | { |
257 | - $help_text = $input->html_help_text(); |
|
257 | + $help_text = $input->html_help_text(); |
|
258 | 258 | if ($help_text !== '' && $help_text !== null) { |
259 | 259 | $tag = is_admin() ? 'p' : 'span'; |
260 | 260 | return '<' |
@@ -286,14 +286,14 @@ discard block |
||
286 | 286 | { |
287 | 287 | // replace dashes and spaces with underscores |
288 | 288 | $hook_name = str_replace(array('-', ' '), '_', $this->_form_section->html_id()); |
289 | - do_action('AHEE__Form_Section_Layout__' . $hook_name, $this->_form_section); |
|
289 | + do_action('AHEE__Form_Section_Layout__'.$hook_name, $this->_form_section); |
|
290 | 290 | $html = (string) apply_filters( |
291 | - 'AFEE__Form_Section_Layout__' . $hook_name . '__html', |
|
291 | + 'AFEE__Form_Section_Layout__'.$hook_name.'__html', |
|
292 | 292 | $html, |
293 | 293 | $this->_form_section |
294 | 294 | ); |
295 | - $html .= EEH_HTML::nl() . '<!-- AHEE__Form_Section_Layout__' . $hook_name . '__html -->'; |
|
296 | - $html .= EEH_HTML::nl() . '<!-- AFEE__Form_Section_Layout__' . $hook_name . ' -->'; |
|
295 | + $html .= EEH_HTML::nl().'<!-- AHEE__Form_Section_Layout__'.$hook_name.'__html -->'; |
|
296 | + $html .= EEH_HTML::nl().'<!-- AFEE__Form_Section_Layout__'.$hook_name.' -->'; |
|
297 | 297 | return $html; |
298 | 298 | } |
299 | 299 | } |
@@ -11,287 +11,287 @@ |
||
11 | 11 | */ |
12 | 12 | abstract class EE_Form_Section_Layout_Base |
13 | 13 | { |
14 | - /** |
|
15 | - * Form section to lay out |
|
16 | - * |
|
17 | - * @var EE_Form_Section_Proper |
|
18 | - */ |
|
19 | - protected $_form_section; |
|
20 | - |
|
21 | - |
|
22 | - |
|
23 | - /** |
|
24 | - * __construct |
|
25 | - */ |
|
26 | - public function __construct() |
|
27 | - { |
|
28 | - } |
|
29 | - |
|
30 | - |
|
31 | - |
|
32 | - /** |
|
33 | - * The form section on which this strategy is to perform |
|
34 | - * |
|
35 | - * @param EE_Form_Section_Proper $form |
|
36 | - */ |
|
37 | - public function _construct_finalize(EE_Form_Section_Proper $form) |
|
38 | - { |
|
39 | - $this->_form_section = $form; |
|
40 | - } |
|
41 | - |
|
42 | - |
|
43 | - |
|
44 | - /** |
|
45 | - * @return EE_Form_Section_Proper |
|
46 | - */ |
|
47 | - public function form_section() |
|
48 | - { |
|
49 | - return $this->_form_section; |
|
50 | - } |
|
51 | - |
|
52 | - |
|
53 | - |
|
54 | - /** |
|
55 | - * Also has teh side effect of enqueuing any needed JS and CSS for |
|
56 | - * this form. |
|
57 | - * Creates all the HTML necessary for displaying this form, its inputs, and |
|
58 | - * proper subsections. |
|
59 | - * Returns the HTML |
|
60 | - * |
|
61 | - * @return string HTML for displaying |
|
62 | - * @throws EE_Error |
|
63 | - */ |
|
64 | - public function layout_form() |
|
65 | - { |
|
66 | - $html = ''; |
|
67 | - // layout_form_begin |
|
68 | - $html .= apply_filters( |
|
69 | - 'FHEE__EE_Form_Section_Layout_Base__layout_form__start__for_' . $this->_form_section->name(), |
|
70 | - $this->layout_form_begin(), |
|
71 | - $this->_form_section |
|
72 | - ); |
|
73 | - // layout_form_loop |
|
74 | - $html .= apply_filters( |
|
75 | - 'FHEE__EE_Form_Section_Layout_Base__layout_form__loop__for_' . $this->_form_section->name(), |
|
76 | - $this->layout_form_loop(), |
|
77 | - $this->_form_section |
|
78 | - ); |
|
79 | - // layout_form_end |
|
80 | - $html .= apply_filters( |
|
81 | - 'FHEE__EE_Form_Section_Layout_Base__layout_form__end__for_' . $this->_form_section->name(), |
|
82 | - $this->layout_form_end(), |
|
83 | - $this->_form_section |
|
84 | - ); |
|
85 | - return $this->add_form_section_hooks_and_filters($html); |
|
86 | - } |
|
87 | - |
|
88 | - |
|
89 | - |
|
90 | - /** |
|
91 | - * @return string |
|
92 | - * @throws EE_Error |
|
93 | - */ |
|
94 | - public function layout_form_loop() |
|
95 | - { |
|
96 | - $html = ''; |
|
97 | - foreach ($this->_form_section->subsections() as $name => $subsection) { |
|
98 | - if ($subsection instanceof EE_Form_Input_Base) { |
|
99 | - $html .= apply_filters( |
|
100 | - 'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_input_' |
|
101 | - . $name . '__in_' . $this->_form_section->name(), |
|
102 | - $this->layout_input($subsection), |
|
103 | - $this->_form_section, |
|
104 | - $subsection |
|
105 | - ); |
|
106 | - } elseif ($subsection instanceof EE_Form_Section_Base) { |
|
107 | - $html .= apply_filters( |
|
108 | - 'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_non_input_' |
|
109 | - . $name . '__in_' . $this->_form_section->name(), |
|
110 | - $this->layout_subsection($subsection), |
|
111 | - $this->_form_section, |
|
112 | - $subsection |
|
113 | - ); |
|
114 | - } |
|
115 | - } |
|
116 | - return $html; |
|
117 | - } |
|
118 | - |
|
119 | - |
|
120 | - |
|
121 | - /** |
|
122 | - * Should be used to start teh form section (Eg a table tag, or a div tag, etc.) |
|
123 | - * |
|
124 | - * @return string |
|
125 | - */ |
|
126 | - abstract public function layout_form_begin(); |
|
127 | - |
|
128 | - |
|
129 | - |
|
130 | - /** |
|
131 | - * Should be used to end the form section (eg a /table tag, or a /div tag, etc.) |
|
132 | - * |
|
133 | - * @return string |
|
134 | - */ |
|
135 | - abstract public function layout_form_end(); |
|
136 | - |
|
137 | - |
|
138 | - |
|
139 | - /** |
|
140 | - * Should be used internally by layout_form() to lay out each input (eg, if this layout |
|
141 | - * is putting each input in a row of its own, this should probably be called by a |
|
142 | - * foreach loop in layout_form() (WITHOUT adding any content directly within layout_form()'s foreach loop. |
|
143 | - * Eg, this method should add the tr and td tags). This method is exposed in case you want to completely |
|
144 | - * customize the form's layout, but would like to make use of it for laying out |
|
145 | - * 'easy-to-layout' inputs |
|
146 | - * |
|
147 | - * @param EE_Form_Input_Base $input |
|
148 | - * @return string html |
|
149 | - */ |
|
150 | - abstract public function layout_input($input); |
|
151 | - |
|
152 | - |
|
153 | - |
|
154 | - /** |
|
155 | - * Similar to layout_input(), should be used internally by layout_form() within a |
|
156 | - * loop to lay out each proper subsection. Unlike layout_input(), however, it is assumed |
|
157 | - * that the proper subsection will lay out its container, label, etc on its own. |
|
158 | - * |
|
159 | - * @param EE_Form_Section_Base $subsection |
|
160 | - * @return string html |
|
161 | - */ |
|
162 | - abstract public function layout_subsection($subsection); |
|
163 | - |
|
164 | - |
|
165 | - /** |
|
166 | - * Gets the HTML for the label tag and its contents for the input |
|
167 | - * |
|
168 | - * @param EE_Form_Input_Base $input |
|
169 | - * @return string |
|
170 | - * @throws EE_Error |
|
171 | - */ |
|
172 | - public function display_label($input) |
|
173 | - { |
|
174 | - if ($input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) { |
|
175 | - return ''; |
|
176 | - } |
|
177 | - $class = $input->required() |
|
178 | - ? 'ee-required-label ' . $input->html_label_class() |
|
179 | - : $input->html_label_class(); |
|
180 | - $label_text = $input->required() |
|
181 | - ? $input->html_label_text() . '<span class="ee-asterisk">*</span>' |
|
182 | - : $input->html_label_text(); |
|
183 | - return '<label id="' |
|
184 | - . $input->html_label_id() |
|
185 | - . '" class="' |
|
186 | - . $class |
|
187 | - . '" style="' |
|
188 | - . $input->html_label_style() |
|
189 | - . '" for="' . $input->html_id() |
|
190 | - . '">' |
|
191 | - . $label_text |
|
192 | - . '</label>'; |
|
193 | - } |
|
194 | - |
|
195 | - |
|
196 | - |
|
197 | - /** |
|
198 | - * Gets the HTML for all the form's form-wide errors (ie, errors which |
|
199 | - * are not for specific inputs. E.g., if two inputs somehow disagree, |
|
200 | - * those errors would probably be on the form section, not one of its inputs) |
|
201 | - * @return string |
|
202 | - */ |
|
203 | - public function display_form_wide_errors() |
|
204 | - { |
|
205 | - $html = ''; |
|
206 | - if ($this->_form_section->get_validation_errors()) { |
|
207 | - $html .= "<div class='ee-form-wide-errors'>"; |
|
208 | - // get all the errors on THIS form section (errors which aren't |
|
209 | - // for specific inputs, but instead for the entire form section) |
|
210 | - foreach ($this->_form_section->get_validation_errors() as $error) { |
|
211 | - $html .= $error->getMessage() . '<br>'; |
|
212 | - } |
|
213 | - $html .= '</div>'; |
|
214 | - } |
|
215 | - return apply_filters( |
|
216 | - 'FHEE__EE_Form_Section_Layout_Base__display_form_wide_errors', |
|
217 | - $html, |
|
218 | - $this |
|
219 | - ); |
|
220 | - } |
|
221 | - |
|
222 | - |
|
223 | - /** |
|
224 | - * returns the HTML for the server-side validation errors for the specified input |
|
225 | - * Note that if JS is enabled, it should remove these and instead |
|
226 | - * populate the form's errors in the jquery validate fashion |
|
227 | - * using the localized data provided to the JS |
|
228 | - * |
|
229 | - * @param EE_Form_Input_Base $input |
|
230 | - * @return string |
|
231 | - * @throws EE_Error |
|
232 | - */ |
|
233 | - public function display_errors($input) |
|
234 | - { |
|
235 | - if ($input->get_validation_errors()) { |
|
236 | - return "<label id='" |
|
237 | - . $input->html_id() |
|
238 | - . "-error' class='error' for='{$input->html_name()}'>" |
|
239 | - . $input->get_validation_error_string() |
|
240 | - . '</label>'; |
|
241 | - } |
|
242 | - return ''; |
|
243 | - } |
|
244 | - |
|
245 | - |
|
246 | - /** |
|
247 | - * Displays the help span for the specified input |
|
248 | - * |
|
249 | - * @param EE_Form_Input_Base $input |
|
250 | - * @return string |
|
251 | - * @throws EE_Error |
|
252 | - */ |
|
253 | - public function display_help_text($input) |
|
254 | - { |
|
255 | - $help_text = $input->html_help_text(); |
|
256 | - if ($help_text !== '' && $help_text !== null) { |
|
257 | - $tag = is_admin() ? 'p' : 'span'; |
|
258 | - return '<' |
|
259 | - . $tag |
|
260 | - . ' id="' |
|
261 | - . $input->html_id() |
|
262 | - . '-help" class="' |
|
263 | - . $input->html_help_class() |
|
264 | - . '" style="' |
|
265 | - . $input->html_help_style() |
|
266 | - . '">' |
|
267 | - . $help_text |
|
268 | - . '</' |
|
269 | - . $tag |
|
270 | - . '>'; |
|
271 | - } |
|
272 | - return ''; |
|
273 | - } |
|
274 | - |
|
275 | - |
|
276 | - /** |
|
277 | - * Does an action and hook onto the end of teh form |
|
278 | - * |
|
279 | - * @param string $html |
|
280 | - * @return string |
|
281 | - * @throws EE_Error |
|
282 | - */ |
|
283 | - public function add_form_section_hooks_and_filters($html) |
|
284 | - { |
|
285 | - // replace dashes and spaces with underscores |
|
286 | - $hook_name = str_replace(array('-', ' '), '_', $this->_form_section->html_id()); |
|
287 | - do_action('AHEE__Form_Section_Layout__' . $hook_name, $this->_form_section); |
|
288 | - $html = (string) apply_filters( |
|
289 | - 'AFEE__Form_Section_Layout__' . $hook_name . '__html', |
|
290 | - $html, |
|
291 | - $this->_form_section |
|
292 | - ); |
|
293 | - $html .= EEH_HTML::nl() . '<!-- AHEE__Form_Section_Layout__' . $hook_name . '__html -->'; |
|
294 | - $html .= EEH_HTML::nl() . '<!-- AFEE__Form_Section_Layout__' . $hook_name . ' -->'; |
|
295 | - return $html; |
|
296 | - } |
|
14 | + /** |
|
15 | + * Form section to lay out |
|
16 | + * |
|
17 | + * @var EE_Form_Section_Proper |
|
18 | + */ |
|
19 | + protected $_form_section; |
|
20 | + |
|
21 | + |
|
22 | + |
|
23 | + /** |
|
24 | + * __construct |
|
25 | + */ |
|
26 | + public function __construct() |
|
27 | + { |
|
28 | + } |
|
29 | + |
|
30 | + |
|
31 | + |
|
32 | + /** |
|
33 | + * The form section on which this strategy is to perform |
|
34 | + * |
|
35 | + * @param EE_Form_Section_Proper $form |
|
36 | + */ |
|
37 | + public function _construct_finalize(EE_Form_Section_Proper $form) |
|
38 | + { |
|
39 | + $this->_form_section = $form; |
|
40 | + } |
|
41 | + |
|
42 | + |
|
43 | + |
|
44 | + /** |
|
45 | + * @return EE_Form_Section_Proper |
|
46 | + */ |
|
47 | + public function form_section() |
|
48 | + { |
|
49 | + return $this->_form_section; |
|
50 | + } |
|
51 | + |
|
52 | + |
|
53 | + |
|
54 | + /** |
|
55 | + * Also has teh side effect of enqueuing any needed JS and CSS for |
|
56 | + * this form. |
|
57 | + * Creates all the HTML necessary for displaying this form, its inputs, and |
|
58 | + * proper subsections. |
|
59 | + * Returns the HTML |
|
60 | + * |
|
61 | + * @return string HTML for displaying |
|
62 | + * @throws EE_Error |
|
63 | + */ |
|
64 | + public function layout_form() |
|
65 | + { |
|
66 | + $html = ''; |
|
67 | + // layout_form_begin |
|
68 | + $html .= apply_filters( |
|
69 | + 'FHEE__EE_Form_Section_Layout_Base__layout_form__start__for_' . $this->_form_section->name(), |
|
70 | + $this->layout_form_begin(), |
|
71 | + $this->_form_section |
|
72 | + ); |
|
73 | + // layout_form_loop |
|
74 | + $html .= apply_filters( |
|
75 | + 'FHEE__EE_Form_Section_Layout_Base__layout_form__loop__for_' . $this->_form_section->name(), |
|
76 | + $this->layout_form_loop(), |
|
77 | + $this->_form_section |
|
78 | + ); |
|
79 | + // layout_form_end |
|
80 | + $html .= apply_filters( |
|
81 | + 'FHEE__EE_Form_Section_Layout_Base__layout_form__end__for_' . $this->_form_section->name(), |
|
82 | + $this->layout_form_end(), |
|
83 | + $this->_form_section |
|
84 | + ); |
|
85 | + return $this->add_form_section_hooks_and_filters($html); |
|
86 | + } |
|
87 | + |
|
88 | + |
|
89 | + |
|
90 | + /** |
|
91 | + * @return string |
|
92 | + * @throws EE_Error |
|
93 | + */ |
|
94 | + public function layout_form_loop() |
|
95 | + { |
|
96 | + $html = ''; |
|
97 | + foreach ($this->_form_section->subsections() as $name => $subsection) { |
|
98 | + if ($subsection instanceof EE_Form_Input_Base) { |
|
99 | + $html .= apply_filters( |
|
100 | + 'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_input_' |
|
101 | + . $name . '__in_' . $this->_form_section->name(), |
|
102 | + $this->layout_input($subsection), |
|
103 | + $this->_form_section, |
|
104 | + $subsection |
|
105 | + ); |
|
106 | + } elseif ($subsection instanceof EE_Form_Section_Base) { |
|
107 | + $html .= apply_filters( |
|
108 | + 'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_non_input_' |
|
109 | + . $name . '__in_' . $this->_form_section->name(), |
|
110 | + $this->layout_subsection($subsection), |
|
111 | + $this->_form_section, |
|
112 | + $subsection |
|
113 | + ); |
|
114 | + } |
|
115 | + } |
|
116 | + return $html; |
|
117 | + } |
|
118 | + |
|
119 | + |
|
120 | + |
|
121 | + /** |
|
122 | + * Should be used to start teh form section (Eg a table tag, or a div tag, etc.) |
|
123 | + * |
|
124 | + * @return string |
|
125 | + */ |
|
126 | + abstract public function layout_form_begin(); |
|
127 | + |
|
128 | + |
|
129 | + |
|
130 | + /** |
|
131 | + * Should be used to end the form section (eg a /table tag, or a /div tag, etc.) |
|
132 | + * |
|
133 | + * @return string |
|
134 | + */ |
|
135 | + abstract public function layout_form_end(); |
|
136 | + |
|
137 | + |
|
138 | + |
|
139 | + /** |
|
140 | + * Should be used internally by layout_form() to lay out each input (eg, if this layout |
|
141 | + * is putting each input in a row of its own, this should probably be called by a |
|
142 | + * foreach loop in layout_form() (WITHOUT adding any content directly within layout_form()'s foreach loop. |
|
143 | + * Eg, this method should add the tr and td tags). This method is exposed in case you want to completely |
|
144 | + * customize the form's layout, but would like to make use of it for laying out |
|
145 | + * 'easy-to-layout' inputs |
|
146 | + * |
|
147 | + * @param EE_Form_Input_Base $input |
|
148 | + * @return string html |
|
149 | + */ |
|
150 | + abstract public function layout_input($input); |
|
151 | + |
|
152 | + |
|
153 | + |
|
154 | + /** |
|
155 | + * Similar to layout_input(), should be used internally by layout_form() within a |
|
156 | + * loop to lay out each proper subsection. Unlike layout_input(), however, it is assumed |
|
157 | + * that the proper subsection will lay out its container, label, etc on its own. |
|
158 | + * |
|
159 | + * @param EE_Form_Section_Base $subsection |
|
160 | + * @return string html |
|
161 | + */ |
|
162 | + abstract public function layout_subsection($subsection); |
|
163 | + |
|
164 | + |
|
165 | + /** |
|
166 | + * Gets the HTML for the label tag and its contents for the input |
|
167 | + * |
|
168 | + * @param EE_Form_Input_Base $input |
|
169 | + * @return string |
|
170 | + * @throws EE_Error |
|
171 | + */ |
|
172 | + public function display_label($input) |
|
173 | + { |
|
174 | + if ($input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) { |
|
175 | + return ''; |
|
176 | + } |
|
177 | + $class = $input->required() |
|
178 | + ? 'ee-required-label ' . $input->html_label_class() |
|
179 | + : $input->html_label_class(); |
|
180 | + $label_text = $input->required() |
|
181 | + ? $input->html_label_text() . '<span class="ee-asterisk">*</span>' |
|
182 | + : $input->html_label_text(); |
|
183 | + return '<label id="' |
|
184 | + . $input->html_label_id() |
|
185 | + . '" class="' |
|
186 | + . $class |
|
187 | + . '" style="' |
|
188 | + . $input->html_label_style() |
|
189 | + . '" for="' . $input->html_id() |
|
190 | + . '">' |
|
191 | + . $label_text |
|
192 | + . '</label>'; |
|
193 | + } |
|
194 | + |
|
195 | + |
|
196 | + |
|
197 | + /** |
|
198 | + * Gets the HTML for all the form's form-wide errors (ie, errors which |
|
199 | + * are not for specific inputs. E.g., if two inputs somehow disagree, |
|
200 | + * those errors would probably be on the form section, not one of its inputs) |
|
201 | + * @return string |
|
202 | + */ |
|
203 | + public function display_form_wide_errors() |
|
204 | + { |
|
205 | + $html = ''; |
|
206 | + if ($this->_form_section->get_validation_errors()) { |
|
207 | + $html .= "<div class='ee-form-wide-errors'>"; |
|
208 | + // get all the errors on THIS form section (errors which aren't |
|
209 | + // for specific inputs, but instead for the entire form section) |
|
210 | + foreach ($this->_form_section->get_validation_errors() as $error) { |
|
211 | + $html .= $error->getMessage() . '<br>'; |
|
212 | + } |
|
213 | + $html .= '</div>'; |
|
214 | + } |
|
215 | + return apply_filters( |
|
216 | + 'FHEE__EE_Form_Section_Layout_Base__display_form_wide_errors', |
|
217 | + $html, |
|
218 | + $this |
|
219 | + ); |
|
220 | + } |
|
221 | + |
|
222 | + |
|
223 | + /** |
|
224 | + * returns the HTML for the server-side validation errors for the specified input |
|
225 | + * Note that if JS is enabled, it should remove these and instead |
|
226 | + * populate the form's errors in the jquery validate fashion |
|
227 | + * using the localized data provided to the JS |
|
228 | + * |
|
229 | + * @param EE_Form_Input_Base $input |
|
230 | + * @return string |
|
231 | + * @throws EE_Error |
|
232 | + */ |
|
233 | + public function display_errors($input) |
|
234 | + { |
|
235 | + if ($input->get_validation_errors()) { |
|
236 | + return "<label id='" |
|
237 | + . $input->html_id() |
|
238 | + . "-error' class='error' for='{$input->html_name()}'>" |
|
239 | + . $input->get_validation_error_string() |
|
240 | + . '</label>'; |
|
241 | + } |
|
242 | + return ''; |
|
243 | + } |
|
244 | + |
|
245 | + |
|
246 | + /** |
|
247 | + * Displays the help span for the specified input |
|
248 | + * |
|
249 | + * @param EE_Form_Input_Base $input |
|
250 | + * @return string |
|
251 | + * @throws EE_Error |
|
252 | + */ |
|
253 | + public function display_help_text($input) |
|
254 | + { |
|
255 | + $help_text = $input->html_help_text(); |
|
256 | + if ($help_text !== '' && $help_text !== null) { |
|
257 | + $tag = is_admin() ? 'p' : 'span'; |
|
258 | + return '<' |
|
259 | + . $tag |
|
260 | + . ' id="' |
|
261 | + . $input->html_id() |
|
262 | + . '-help" class="' |
|
263 | + . $input->html_help_class() |
|
264 | + . '" style="' |
|
265 | + . $input->html_help_style() |
|
266 | + . '">' |
|
267 | + . $help_text |
|
268 | + . '</' |
|
269 | + . $tag |
|
270 | + . '>'; |
|
271 | + } |
|
272 | + return ''; |
|
273 | + } |
|
274 | + |
|
275 | + |
|
276 | + /** |
|
277 | + * Does an action and hook onto the end of teh form |
|
278 | + * |
|
279 | + * @param string $html |
|
280 | + * @return string |
|
281 | + * @throws EE_Error |
|
282 | + */ |
|
283 | + public function add_form_section_hooks_and_filters($html) |
|
284 | + { |
|
285 | + // replace dashes and spaces with underscores |
|
286 | + $hook_name = str_replace(array('-', ' '), '_', $this->_form_section->html_id()); |
|
287 | + do_action('AHEE__Form_Section_Layout__' . $hook_name, $this->_form_section); |
|
288 | + $html = (string) apply_filters( |
|
289 | + 'AFEE__Form_Section_Layout__' . $hook_name . '__html', |
|
290 | + $html, |
|
291 | + $this->_form_section |
|
292 | + ); |
|
293 | + $html .= EEH_HTML::nl() . '<!-- AHEE__Form_Section_Layout__' . $hook_name . '__html -->'; |
|
294 | + $html .= EEH_HTML::nl() . '<!-- AFEE__Form_Section_Layout__' . $hook_name . ' -->'; |
|
295 | + return $html; |
|
296 | + } |
|
297 | 297 | } |