@@ -12,131 +12,131 @@ |
||
12 | 12 | class EE_Enum_Text_Field extends EE_Text_Field_Base |
13 | 13 | { |
14 | 14 | |
15 | - /** |
|
16 | - * @var array $_allowed_enum_values |
|
17 | - */ |
|
18 | - public $_allowed_enum_values; |
|
19 | - |
|
20 | - /** |
|
21 | - * @param string $table_column |
|
22 | - * @param string $nice_name |
|
23 | - * @param boolean $nullable |
|
24 | - * @param mixed $default_value |
|
25 | - * @param array $allowed_enum_values keys are values to be used in the DB, values are how they should be displayed |
|
26 | - */ |
|
27 | - function __construct($table_column, $nice_name, $nullable, $default_value, $allowed_enum_values) |
|
28 | - { |
|
29 | - $this->_allowed_enum_values = $allowed_enum_values; |
|
30 | - parent::__construct($table_column, $nice_name, $nullable, $default_value); |
|
31 | - $this->setSchemaType('object'); |
|
32 | - } |
|
33 | - |
|
34 | - |
|
35 | - |
|
36 | - /** |
|
37 | - * Returns the list of allowed enum options, but filterable. |
|
38 | - * This is used internally |
|
39 | - * |
|
40 | - * @return array |
|
41 | - */ |
|
42 | - protected function _allowed_enum_values() |
|
43 | - { |
|
44 | - return apply_filters( |
|
45 | - 'FHEE__EE_Enum_Text_Field___allowed_enum_options', |
|
46 | - $this->_allowed_enum_values, |
|
47 | - $this |
|
48 | - ); |
|
49 | - } |
|
50 | - |
|
51 | - |
|
52 | - |
|
53 | - /** |
|
54 | - * When setting, just verify that the value being used matches what we've defined as allowable enum values. |
|
55 | - * If not, throw an error (but if WP_DEBUG is false, just set the value to default). |
|
56 | - * |
|
57 | - * @param string $value_inputted_for_field_on_model_object |
|
58 | - * @return string |
|
59 | - * @throws EE_Error |
|
60 | - */ |
|
61 | - public function prepare_for_set($value_inputted_for_field_on_model_object) |
|
62 | - { |
|
63 | - if ( |
|
64 | - $value_inputted_for_field_on_model_object !== null |
|
65 | - && ! array_key_exists($value_inputted_for_field_on_model_object, $this->_allowed_enum_values()) |
|
66 | - ) { |
|
67 | - if (defined('WP_DEBUG') && WP_DEBUG) { |
|
68 | - $msg = sprintf( |
|
69 | - __('System is assigning incompatible value "%1$s" to field "%2$s"', 'event_espresso'), |
|
70 | - $value_inputted_for_field_on_model_object, |
|
71 | - $this->_name |
|
72 | - ); |
|
73 | - $msg2 = sprintf( |
|
74 | - __('Allowed values for "%1$s" are "%2$s". You provided: "%3$s"', 'event_espresso'), |
|
75 | - $this->_name, |
|
76 | - implode(', ', array_keys($this->_allowed_enum_values())), |
|
77 | - $value_inputted_for_field_on_model_object |
|
78 | - ); |
|
79 | - EE_Error::add_error("{$msg}||{$msg2}", __FILE__, __FUNCTION__, __LINE__); |
|
80 | - } |
|
81 | - return $this->get_default_value(); |
|
82 | - } |
|
83 | - return $value_inputted_for_field_on_model_object; |
|
84 | - } |
|
85 | - |
|
86 | - |
|
87 | - /** |
|
88 | - * Gets the pretty version of the enum's value. |
|
89 | - * |
|
90 | - * @param int |string $value_on_field_to_be_outputted |
|
91 | - * @param null $schema |
|
92 | - * @return string |
|
93 | - */ |
|
94 | - public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null) |
|
95 | - { |
|
96 | - $options = $this->_allowed_enum_values(); |
|
97 | - if (isset($options[$value_on_field_to_be_outputted])) { |
|
98 | - return $options[$value_on_field_to_be_outputted]; |
|
99 | - } else { |
|
100 | - return $value_on_field_to_be_outputted; |
|
101 | - } |
|
102 | - } |
|
103 | - |
|
104 | - |
|
105 | - |
|
106 | - /** |
|
107 | - * When retrieving something from the DB, don't enforce the enum's options. If it's in the DB, we just have to live |
|
108 | - * with that. Note also: when we're saving to the DB again, we also don't enforce the enum options. It's ONLY |
|
109 | - * when we're receiving USER input from prepare_for_set() that we enforce the enum options. |
|
110 | - * |
|
111 | - * @param mixed $value_in_db |
|
112 | - * @return mixed |
|
113 | - */ |
|
114 | - public function prepare_for_set_from_db($value_in_db) |
|
115 | - { |
|
116 | - return $value_in_db; |
|
117 | - } |
|
118 | - |
|
119 | - |
|
120 | - public function getSchemaProperties() |
|
121 | - { |
|
122 | - return array( |
|
123 | - 'raw' => array( |
|
124 | - 'description' => sprintf( |
|
125 | - __('%s - the value in the database.', 'event_espresso'), |
|
126 | - $this->get_nicename() |
|
127 | - ), |
|
128 | - 'type' => 'string', |
|
129 | - 'enum' => array_keys($this->_allowed_enum_values) |
|
130 | - ), |
|
131 | - 'pretty' => array( |
|
132 | - 'description' => sprintf( |
|
133 | - __('%s - the value for display.', 'event_espresso'), |
|
134 | - $this->get_nicename() |
|
135 | - ), |
|
136 | - 'type' => 'string', |
|
137 | - 'enum' => array_values($this->_allowed_enum_values), |
|
138 | - 'read_only' => true |
|
139 | - ) |
|
140 | - ); |
|
141 | - } |
|
15 | + /** |
|
16 | + * @var array $_allowed_enum_values |
|
17 | + */ |
|
18 | + public $_allowed_enum_values; |
|
19 | + |
|
20 | + /** |
|
21 | + * @param string $table_column |
|
22 | + * @param string $nice_name |
|
23 | + * @param boolean $nullable |
|
24 | + * @param mixed $default_value |
|
25 | + * @param array $allowed_enum_values keys are values to be used in the DB, values are how they should be displayed |
|
26 | + */ |
|
27 | + function __construct($table_column, $nice_name, $nullable, $default_value, $allowed_enum_values) |
|
28 | + { |
|
29 | + $this->_allowed_enum_values = $allowed_enum_values; |
|
30 | + parent::__construct($table_column, $nice_name, $nullable, $default_value); |
|
31 | + $this->setSchemaType('object'); |
|
32 | + } |
|
33 | + |
|
34 | + |
|
35 | + |
|
36 | + /** |
|
37 | + * Returns the list of allowed enum options, but filterable. |
|
38 | + * This is used internally |
|
39 | + * |
|
40 | + * @return array |
|
41 | + */ |
|
42 | + protected function _allowed_enum_values() |
|
43 | + { |
|
44 | + return apply_filters( |
|
45 | + 'FHEE__EE_Enum_Text_Field___allowed_enum_options', |
|
46 | + $this->_allowed_enum_values, |
|
47 | + $this |
|
48 | + ); |
|
49 | + } |
|
50 | + |
|
51 | + |
|
52 | + |
|
53 | + /** |
|
54 | + * When setting, just verify that the value being used matches what we've defined as allowable enum values. |
|
55 | + * If not, throw an error (but if WP_DEBUG is false, just set the value to default). |
|
56 | + * |
|
57 | + * @param string $value_inputted_for_field_on_model_object |
|
58 | + * @return string |
|
59 | + * @throws EE_Error |
|
60 | + */ |
|
61 | + public function prepare_for_set($value_inputted_for_field_on_model_object) |
|
62 | + { |
|
63 | + if ( |
|
64 | + $value_inputted_for_field_on_model_object !== null |
|
65 | + && ! array_key_exists($value_inputted_for_field_on_model_object, $this->_allowed_enum_values()) |
|
66 | + ) { |
|
67 | + if (defined('WP_DEBUG') && WP_DEBUG) { |
|
68 | + $msg = sprintf( |
|
69 | + __('System is assigning incompatible value "%1$s" to field "%2$s"', 'event_espresso'), |
|
70 | + $value_inputted_for_field_on_model_object, |
|
71 | + $this->_name |
|
72 | + ); |
|
73 | + $msg2 = sprintf( |
|
74 | + __('Allowed values for "%1$s" are "%2$s". You provided: "%3$s"', 'event_espresso'), |
|
75 | + $this->_name, |
|
76 | + implode(', ', array_keys($this->_allowed_enum_values())), |
|
77 | + $value_inputted_for_field_on_model_object |
|
78 | + ); |
|
79 | + EE_Error::add_error("{$msg}||{$msg2}", __FILE__, __FUNCTION__, __LINE__); |
|
80 | + } |
|
81 | + return $this->get_default_value(); |
|
82 | + } |
|
83 | + return $value_inputted_for_field_on_model_object; |
|
84 | + } |
|
85 | + |
|
86 | + |
|
87 | + /** |
|
88 | + * Gets the pretty version of the enum's value. |
|
89 | + * |
|
90 | + * @param int |string $value_on_field_to_be_outputted |
|
91 | + * @param null $schema |
|
92 | + * @return string |
|
93 | + */ |
|
94 | + public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null) |
|
95 | + { |
|
96 | + $options = $this->_allowed_enum_values(); |
|
97 | + if (isset($options[$value_on_field_to_be_outputted])) { |
|
98 | + return $options[$value_on_field_to_be_outputted]; |
|
99 | + } else { |
|
100 | + return $value_on_field_to_be_outputted; |
|
101 | + } |
|
102 | + } |
|
103 | + |
|
104 | + |
|
105 | + |
|
106 | + /** |
|
107 | + * When retrieving something from the DB, don't enforce the enum's options. If it's in the DB, we just have to live |
|
108 | + * with that. Note also: when we're saving to the DB again, we also don't enforce the enum options. It's ONLY |
|
109 | + * when we're receiving USER input from prepare_for_set() that we enforce the enum options. |
|
110 | + * |
|
111 | + * @param mixed $value_in_db |
|
112 | + * @return mixed |
|
113 | + */ |
|
114 | + public function prepare_for_set_from_db($value_in_db) |
|
115 | + { |
|
116 | + return $value_in_db; |
|
117 | + } |
|
118 | + |
|
119 | + |
|
120 | + public function getSchemaProperties() |
|
121 | + { |
|
122 | + return array( |
|
123 | + 'raw' => array( |
|
124 | + 'description' => sprintf( |
|
125 | + __('%s - the value in the database.', 'event_espresso'), |
|
126 | + $this->get_nicename() |
|
127 | + ), |
|
128 | + 'type' => 'string', |
|
129 | + 'enum' => array_keys($this->_allowed_enum_values) |
|
130 | + ), |
|
131 | + 'pretty' => array( |
|
132 | + 'description' => sprintf( |
|
133 | + __('%s - the value for display.', 'event_espresso'), |
|
134 | + $this->get_nicename() |
|
135 | + ), |
|
136 | + 'type' => 'string', |
|
137 | + 'enum' => array_values($this->_allowed_enum_values), |
|
138 | + 'read_only' => true |
|
139 | + ) |
|
140 | + ); |
|
141 | + } |
|
142 | 142 | } |
@@ -15,57 +15,57 @@ |
||
15 | 15 | class EE_Full_HTML_Field extends EE_Text_Field_Base |
16 | 16 | { |
17 | 17 | |
18 | - /** |
|
19 | - * @param string $table_column |
|
20 | - * @param string $nicename |
|
21 | - * @param bool $nullable |
|
22 | - * @param null $default_value |
|
23 | - */ |
|
24 | - public function __construct($table_column, $nicename, $nullable, $default_value = null) |
|
25 | - { |
|
26 | - parent::__construct($table_column, $nicename, $nullable, $default_value); |
|
27 | - $this->setSchemaType('object'); |
|
28 | - } |
|
18 | + /** |
|
19 | + * @param string $table_column |
|
20 | + * @param string $nicename |
|
21 | + * @param bool $nullable |
|
22 | + * @param null $default_value |
|
23 | + */ |
|
24 | + public function __construct($table_column, $nicename, $nullable, $default_value = null) |
|
25 | + { |
|
26 | + parent::__construct($table_column, $nicename, $nullable, $default_value); |
|
27 | + $this->setSchemaType('object'); |
|
28 | + } |
|
29 | 29 | |
30 | 30 | |
31 | - /** |
|
32 | - * Does shortcodes and auto-paragraphs the content (unless schema is 'no_wpautop') |
|
33 | - * |
|
34 | - * @param type $value_on_field_to_be_outputted |
|
35 | - * @param type $schema |
|
36 | - * @return string |
|
37 | - */ |
|
38 | - function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null) |
|
39 | - { |
|
40 | - if ($schema == 'form_input') { |
|
41 | - return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema); |
|
42 | - } elseif ($schema == 'no_wpautop') { |
|
43 | - return do_shortcode(parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema)); |
|
44 | - } else { |
|
45 | - return wpautop(do_shortcode(parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema))); |
|
46 | - } |
|
47 | - } |
|
31 | + /** |
|
32 | + * Does shortcodes and auto-paragraphs the content (unless schema is 'no_wpautop') |
|
33 | + * |
|
34 | + * @param type $value_on_field_to_be_outputted |
|
35 | + * @param type $schema |
|
36 | + * @return string |
|
37 | + */ |
|
38 | + function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null) |
|
39 | + { |
|
40 | + if ($schema == 'form_input') { |
|
41 | + return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema); |
|
42 | + } elseif ($schema == 'no_wpautop') { |
|
43 | + return do_shortcode(parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema)); |
|
44 | + } else { |
|
45 | + return wpautop(do_shortcode(parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema))); |
|
46 | + } |
|
47 | + } |
|
48 | 48 | |
49 | 49 | |
50 | 50 | |
51 | - public function getSchemaProperties() |
|
52 | - { |
|
53 | - return array( |
|
54 | - 'raw' => array( |
|
55 | - 'description' => sprintf( |
|
56 | - __('%s - the value in the database.', 'event_espresso'), |
|
57 | - $this->get_nicename() |
|
58 | - ), |
|
59 | - 'type' => 'string' |
|
60 | - ), |
|
61 | - 'rendered' => array( |
|
62 | - 'description' => sprintf( |
|
63 | - __('%s - transformed for display.', 'event_espresso'), |
|
64 | - $this->get_nicename() |
|
65 | - ), |
|
66 | - 'type' => 'string', |
|
67 | - 'readonly' => true |
|
68 | - ) |
|
69 | - ); |
|
70 | - } |
|
51 | + public function getSchemaProperties() |
|
52 | + { |
|
53 | + return array( |
|
54 | + 'raw' => array( |
|
55 | + 'description' => sprintf( |
|
56 | + __('%s - the value in the database.', 'event_espresso'), |
|
57 | + $this->get_nicename() |
|
58 | + ), |
|
59 | + 'type' => 'string' |
|
60 | + ), |
|
61 | + 'rendered' => array( |
|
62 | + 'description' => sprintf( |
|
63 | + __('%s - transformed for display.', 'event_espresso'), |
|
64 | + $this->get_nicename() |
|
65 | + ), |
|
66 | + 'type' => 'string', |
|
67 | + 'readonly' => true |
|
68 | + ) |
|
69 | + ); |
|
70 | + } |
|
71 | 71 | } |
72 | 72 | \ No newline at end of file |
@@ -13,7 +13,7 @@ |
||
13 | 13 | * @param string $table_column |
14 | 14 | * @param string $nicename |
15 | 15 | * @param bool $nullable |
16 | - * @param null $default_value |
|
16 | + * @param string $default_value |
|
17 | 17 | */ |
18 | 18 | public function __construct($table_column, $nicename, $nullable, $default_value = null) |
19 | 19 | { |
@@ -18,31 +18,31 @@ |
||
18 | 18 | |
19 | 19 | |
20 | 20 | |
21 | - /** |
|
22 | - * @param string $name |
|
23 | - * @param array $widget_options |
|
24 | - * @param array $control_options |
|
25 | - */ |
|
26 | - public function __construct($name = '', array $widget_options = array(), array $control_options = array()) |
|
27 | - { |
|
28 | - $id_base = EspressoWidget::getIdBase(get_class($this)); |
|
29 | - $control_options['id_base'] = $id_base; |
|
30 | - $control_options['height'] = isset($control_options['height']) ? $control_options['height'] : 300; |
|
31 | - $control_options['width'] = isset($control_options['width']) ? $control_options['width'] : 350; |
|
32 | - // Register widget with WordPress |
|
33 | - parent::__construct($id_base, $name, $widget_options, $control_options); |
|
34 | - } |
|
35 | - |
|
36 | - |
|
37 | - |
|
38 | - /** |
|
39 | - * @param string $widget_class |
|
40 | - * @return string |
|
41 | - */ |
|
42 | - public static function getIdBase($widget_class) |
|
43 | - { |
|
44 | - return sanitize_title(str_replace(array('EEW_', '_'), array('EE_', '-'), $widget_class)) . '-widget'; |
|
45 | - } |
|
21 | + /** |
|
22 | + * @param string $name |
|
23 | + * @param array $widget_options |
|
24 | + * @param array $control_options |
|
25 | + */ |
|
26 | + public function __construct($name = '', array $widget_options = array(), array $control_options = array()) |
|
27 | + { |
|
28 | + $id_base = EspressoWidget::getIdBase(get_class($this)); |
|
29 | + $control_options['id_base'] = $id_base; |
|
30 | + $control_options['height'] = isset($control_options['height']) ? $control_options['height'] : 300; |
|
31 | + $control_options['width'] = isset($control_options['width']) ? $control_options['width'] : 350; |
|
32 | + // Register widget with WordPress |
|
33 | + parent::__construct($id_base, $name, $widget_options, $control_options); |
|
34 | + } |
|
35 | + |
|
36 | + |
|
37 | + |
|
38 | + /** |
|
39 | + * @param string $widget_class |
|
40 | + * @return string |
|
41 | + */ |
|
42 | + public static function getIdBase($widget_class) |
|
43 | + { |
|
44 | + return sanitize_title(str_replace(array('EEW_', '_'), array('EE_', '-'), $widget_class)) . '-widget'; |
|
45 | + } |
|
46 | 46 | |
47 | 47 | |
48 | 48 | } |
@@ -41,7 +41,7 @@ |
||
41 | 41 | */ |
42 | 42 | public static function getIdBase($widget_class) |
43 | 43 | { |
44 | - return sanitize_title(str_replace(array('EEW_', '_'), array('EE_', '-'), $widget_class)) . '-widget'; |
|
44 | + return sanitize_title(str_replace(array('EEW_', '_'), array('EE_', '-'), $widget_class)).'-widget'; |
|
45 | 45 | } |
46 | 46 | |
47 | 47 |
@@ -2,8 +2,7 @@ |
||
2 | 2 | |
3 | 3 | /** |
4 | 4 | * Goes through all the posts and pages, and converts old shortcodes to new ones |
5 | - |
|
6 | -*/ |
|
5 | + */ |
|
7 | 6 | |
8 | 7 | class EE_DMS_4_1_0_shortcodes extends EE_Data_Migration_Script_Stage{ |
9 | 8 | function __construct() { |
@@ -5,7 +5,7 @@ discard block |
||
5 | 5 | |
6 | 6 | */ |
7 | 7 | |
8 | -class EE_DMS_4_1_0_shortcodes extends EE_Data_Migration_Script_Stage{ |
|
8 | +class EE_DMS_4_1_0_shortcodes extends EE_Data_Migration_Script_Stage { |
|
9 | 9 | function __construct() { |
10 | 10 | global $wpdb; |
11 | 11 | $this->_pretty_name = __("Shortcodes", "event_espresso"); |
@@ -15,27 +15,27 @@ discard block |
||
15 | 15 | protected function _migrate_old_row($old_row) { |
16 | 16 | $new_post_content = $this->_change_event_list_shortcode($old_row['post_content']); |
17 | 17 | global $wpdb; |
18 | - $wpdb->query($wpdb->prepare("UPDATE ".$this->_old_table." SET post_content=%s WHERE ID=%d",$new_post_content,$old_row['ID'])); |
|
18 | + $wpdb->query($wpdb->prepare("UPDATE ".$this->_old_table." SET post_content=%s WHERE ID=%d", $new_post_content, $old_row['ID'])); |
|
19 | 19 | } |
20 | 20 | |
21 | 21 | /** |
22 | 22 | * replaces [EVENT_LIST... with [ESPRESSO_EVENTS...] |
23 | 23 | * @param string $old_content |
24 | 24 | */ |
25 | - private function _change_event_list_shortcode($old_content){ |
|
26 | - return str_replace("[EVENT_LIST","[ESPRESSO_EVENTS",$old_content); |
|
25 | + private function _change_event_list_shortcode($old_content) { |
|
26 | + return str_replace("[EVENT_LIST", "[ESPRESSO_EVENTS", $old_content); |
|
27 | 27 | } |
28 | 28 | |
29 | - function _migration_step($num_items=50){ |
|
29 | + function _migration_step($num_items = 50) { |
|
30 | 30 | global $wpdb; |
31 | 31 | $start_at_record = $this->count_records_migrated(); |
32 | - $rows = $wpdb->get_results($wpdb->prepare("SELECT * FROM $this->_old_table {$this->_sql_to_only_select_non_drafts()} LIMIT %d,%d",$start_at_record,$num_items),ARRAY_A); |
|
32 | + $rows = $wpdb->get_results($wpdb->prepare("SELECT * FROM $this->_old_table {$this->_sql_to_only_select_non_drafts()} LIMIT %d,%d", $start_at_record, $num_items), ARRAY_A); |
|
33 | 33 | $items_actually_migrated = 0; |
34 | - foreach($rows as $old_row){ |
|
34 | + foreach ($rows as $old_row) { |
|
35 | 35 | $this->_migrate_old_row($old_row); |
36 | 36 | $items_actually_migrated++; |
37 | 37 | } |
38 | - if($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()){ |
|
38 | + if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) { |
|
39 | 39 | $this->set_completed(); |
40 | 40 | } |
41 | 41 | return $items_actually_migrated; |
@@ -46,7 +46,7 @@ discard block |
||
46 | 46 | return $count; |
47 | 47 | } |
48 | 48 | |
49 | - private function _sql_to_only_select_non_drafts(){ |
|
49 | + private function _sql_to_only_select_non_drafts() { |
|
50 | 50 | return " WHERE post_type NOT IN ('revision','auto-draft') "; |
51 | 51 | } |
52 | 52 |
@@ -13,150 +13,150 @@ |
||
13 | 13 | class PostShortcodeTracking |
14 | 14 | { |
15 | 15 | |
16 | - /** |
|
17 | - * @deprecated 4.9.26 |
|
18 | - * @return void |
|
19 | - */ |
|
20 | - public static function set_hooks_admin() |
|
21 | - { |
|
22 | - \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
|
23 | - } |
|
24 | - |
|
25 | - |
|
26 | - |
|
27 | - /** |
|
28 | - * @deprecated 4.9.26 |
|
29 | - * @param $post_ID |
|
30 | - * @param $post |
|
31 | - * @return void |
|
32 | - */ |
|
33 | - public static function parse_post_content_on_save( $post_ID, $post ) |
|
34 | - { |
|
35 | - \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
|
36 | - } |
|
37 | - |
|
38 | - |
|
39 | - |
|
40 | - /** |
|
41 | - * @deprecated 4.9.26 |
|
42 | - * @param $page_for_posts |
|
43 | - * @return void |
|
44 | - */ |
|
45 | - protected static function set_post_shortcodes_for_posts_page( $page_for_posts ) |
|
46 | - { |
|
47 | - \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
|
48 | - } |
|
49 | - |
|
50 | - |
|
51 | - |
|
52 | - /** |
|
53 | - * @deprecated 4.9.26 |
|
54 | - * @param $page_for_posts |
|
55 | - * @param $EES_Shortcode |
|
56 | - * @param $post_ID |
|
57 | - * @return void |
|
58 | - */ |
|
59 | - protected static function set_post_shortcode_for_posts_page( $page_for_posts, $EES_Shortcode, $post_ID ) |
|
60 | - { |
|
61 | - \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
|
62 | - } |
|
63 | - |
|
64 | - |
|
65 | - |
|
66 | - /** |
|
67 | - * @deprecated 4.9.26 |
|
68 | - * @param $ID |
|
69 | - * @return void |
|
70 | - */ |
|
71 | - public static function unset_post_shortcodes_on_delete( $ID ) |
|
72 | - { |
|
73 | - \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
|
74 | - } |
|
75 | - |
|
76 | - |
|
77 | - |
|
78 | - /** |
|
79 | - * @deprecated 4.9.26 |
|
80 | - * @param $ID |
|
81 | - * @param $shortcode_class |
|
82 | - * @param $shortcode_posts |
|
83 | - * @param $page_for_posts |
|
84 | - * @param bool $update_post_shortcodes |
|
85 | - * @return void |
|
86 | - */ |
|
87 | - protected static function unset_posts_page_shortcode_for_post( |
|
88 | - $ID, |
|
89 | - $shortcode_class, |
|
90 | - $shortcode_posts, |
|
91 | - $page_for_posts, |
|
92 | - $update_post_shortcodes = false |
|
93 | - ) { |
|
94 | - \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
|
95 | - } |
|
96 | - |
|
97 | - |
|
98 | - |
|
99 | - /** |
|
100 | - * @deprecated 4.9.26 |
|
101 | - * @param string $page_for_posts |
|
102 | - * @return void |
|
103 | - */ |
|
104 | - public static function update_post_shortcodes( $page_for_posts = '' ) |
|
105 | - { |
|
106 | - \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
|
107 | - } |
|
108 | - |
|
109 | - |
|
110 | - |
|
111 | - /** |
|
112 | - * @deprecated 4.9.26 |
|
113 | - * @param $option |
|
114 | - * @param $value |
|
115 | - * @return void |
|
116 | - */ |
|
117 | - public static function reset_page_for_posts_on_initial_set( $option, $value ) |
|
118 | - { |
|
119 | - \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
|
120 | - } |
|
121 | - |
|
122 | - |
|
123 | - |
|
124 | - /** |
|
125 | - * @deprecated 4.9.26 |
|
126 | - * @param $option |
|
127 | - * @param string $old_value |
|
128 | - * @param string $value |
|
129 | - * @return void |
|
130 | - */ |
|
131 | - public static function reset_page_for_posts_on_change( $option, $old_value = '', $value = '' ) |
|
132 | - { |
|
133 | - \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
|
134 | - } |
|
135 | - |
|
136 | - |
|
137 | - |
|
138 | - /** |
|
139 | - * @deprecated 4.9.26 |
|
140 | - * @param $option |
|
141 | - * @return void |
|
142 | - */ |
|
143 | - public static function reset_page_for_posts_on_delete( $option ) |
|
144 | - { |
|
145 | - \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
|
146 | - } |
|
147 | - |
|
148 | - |
|
149 | - |
|
150 | - /** |
|
151 | - * @deprecated 4.9.26 |
|
152 | - * @param $shortcodes |
|
153 | - * @param bool $index_results |
|
154 | - * @return void |
|
155 | - */ |
|
156 | - public static function get_post_ids_for_shortcode( $shortcodes, $index_results = true ) |
|
157 | - { |
|
158 | - \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
|
159 | - } |
|
16 | + /** |
|
17 | + * @deprecated 4.9.26 |
|
18 | + * @return void |
|
19 | + */ |
|
20 | + public static function set_hooks_admin() |
|
21 | + { |
|
22 | + \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
|
23 | + } |
|
24 | + |
|
25 | + |
|
26 | + |
|
27 | + /** |
|
28 | + * @deprecated 4.9.26 |
|
29 | + * @param $post_ID |
|
30 | + * @param $post |
|
31 | + * @return void |
|
32 | + */ |
|
33 | + public static function parse_post_content_on_save( $post_ID, $post ) |
|
34 | + { |
|
35 | + \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
|
36 | + } |
|
37 | + |
|
38 | + |
|
39 | + |
|
40 | + /** |
|
41 | + * @deprecated 4.9.26 |
|
42 | + * @param $page_for_posts |
|
43 | + * @return void |
|
44 | + */ |
|
45 | + protected static function set_post_shortcodes_for_posts_page( $page_for_posts ) |
|
46 | + { |
|
47 | + \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
|
48 | + } |
|
49 | + |
|
50 | + |
|
51 | + |
|
52 | + /** |
|
53 | + * @deprecated 4.9.26 |
|
54 | + * @param $page_for_posts |
|
55 | + * @param $EES_Shortcode |
|
56 | + * @param $post_ID |
|
57 | + * @return void |
|
58 | + */ |
|
59 | + protected static function set_post_shortcode_for_posts_page( $page_for_posts, $EES_Shortcode, $post_ID ) |
|
60 | + { |
|
61 | + \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
|
62 | + } |
|
63 | + |
|
64 | + |
|
65 | + |
|
66 | + /** |
|
67 | + * @deprecated 4.9.26 |
|
68 | + * @param $ID |
|
69 | + * @return void |
|
70 | + */ |
|
71 | + public static function unset_post_shortcodes_on_delete( $ID ) |
|
72 | + { |
|
73 | + \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
|
74 | + } |
|
75 | + |
|
76 | + |
|
77 | + |
|
78 | + /** |
|
79 | + * @deprecated 4.9.26 |
|
80 | + * @param $ID |
|
81 | + * @param $shortcode_class |
|
82 | + * @param $shortcode_posts |
|
83 | + * @param $page_for_posts |
|
84 | + * @param bool $update_post_shortcodes |
|
85 | + * @return void |
|
86 | + */ |
|
87 | + protected static function unset_posts_page_shortcode_for_post( |
|
88 | + $ID, |
|
89 | + $shortcode_class, |
|
90 | + $shortcode_posts, |
|
91 | + $page_for_posts, |
|
92 | + $update_post_shortcodes = false |
|
93 | + ) { |
|
94 | + \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
|
95 | + } |
|
96 | + |
|
97 | + |
|
98 | + |
|
99 | + /** |
|
100 | + * @deprecated 4.9.26 |
|
101 | + * @param string $page_for_posts |
|
102 | + * @return void |
|
103 | + */ |
|
104 | + public static function update_post_shortcodes( $page_for_posts = '' ) |
|
105 | + { |
|
106 | + \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
|
107 | + } |
|
108 | + |
|
109 | + |
|
110 | + |
|
111 | + /** |
|
112 | + * @deprecated 4.9.26 |
|
113 | + * @param $option |
|
114 | + * @param $value |
|
115 | + * @return void |
|
116 | + */ |
|
117 | + public static function reset_page_for_posts_on_initial_set( $option, $value ) |
|
118 | + { |
|
119 | + \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
|
120 | + } |
|
121 | + |
|
122 | + |
|
123 | + |
|
124 | + /** |
|
125 | + * @deprecated 4.9.26 |
|
126 | + * @param $option |
|
127 | + * @param string $old_value |
|
128 | + * @param string $value |
|
129 | + * @return void |
|
130 | + */ |
|
131 | + public static function reset_page_for_posts_on_change( $option, $old_value = '', $value = '' ) |
|
132 | + { |
|
133 | + \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
|
134 | + } |
|
135 | + |
|
136 | + |
|
137 | + |
|
138 | + /** |
|
139 | + * @deprecated 4.9.26 |
|
140 | + * @param $option |
|
141 | + * @return void |
|
142 | + */ |
|
143 | + public static function reset_page_for_posts_on_delete( $option ) |
|
144 | + { |
|
145 | + \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
|
146 | + } |
|
147 | + |
|
148 | + |
|
149 | + |
|
150 | + /** |
|
151 | + * @deprecated 4.9.26 |
|
152 | + * @param $shortcodes |
|
153 | + * @param bool $index_results |
|
154 | + * @return void |
|
155 | + */ |
|
156 | + public static function get_post_ids_for_shortcode( $shortcodes, $index_results = true ) |
|
157 | + { |
|
158 | + \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
|
159 | + } |
|
160 | 160 | |
161 | 161 | |
162 | 162 |
@@ -1,7 +1,7 @@ discard block |
||
1 | 1 | <?php |
2 | 2 | namespace EventEspresso\core\admin; |
3 | 3 | |
4 | -defined( 'EVENT_ESPRESSO_VERSION' ) || exit(); |
|
4 | +defined('EVENT_ESPRESSO_VERSION') || exit(); |
|
5 | 5 | |
6 | 6 | |
7 | 7 | |
@@ -30,7 +30,7 @@ discard block |
||
30 | 30 | * @param $post |
31 | 31 | * @return void |
32 | 32 | */ |
33 | - public static function parse_post_content_on_save( $post_ID, $post ) |
|
33 | + public static function parse_post_content_on_save($post_ID, $post) |
|
34 | 34 | { |
35 | 35 | \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
36 | 36 | } |
@@ -42,7 +42,7 @@ discard block |
||
42 | 42 | * @param $page_for_posts |
43 | 43 | * @return void |
44 | 44 | */ |
45 | - protected static function set_post_shortcodes_for_posts_page( $page_for_posts ) |
|
45 | + protected static function set_post_shortcodes_for_posts_page($page_for_posts) |
|
46 | 46 | { |
47 | 47 | \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
48 | 48 | } |
@@ -56,7 +56,7 @@ discard block |
||
56 | 56 | * @param $post_ID |
57 | 57 | * @return void |
58 | 58 | */ |
59 | - protected static function set_post_shortcode_for_posts_page( $page_for_posts, $EES_Shortcode, $post_ID ) |
|
59 | + protected static function set_post_shortcode_for_posts_page($page_for_posts, $EES_Shortcode, $post_ID) |
|
60 | 60 | { |
61 | 61 | \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
62 | 62 | } |
@@ -68,7 +68,7 @@ discard block |
||
68 | 68 | * @param $ID |
69 | 69 | * @return void |
70 | 70 | */ |
71 | - public static function unset_post_shortcodes_on_delete( $ID ) |
|
71 | + public static function unset_post_shortcodes_on_delete($ID) |
|
72 | 72 | { |
73 | 73 | \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
74 | 74 | } |
@@ -101,7 +101,7 @@ discard block |
||
101 | 101 | * @param string $page_for_posts |
102 | 102 | * @return void |
103 | 103 | */ |
104 | - public static function update_post_shortcodes( $page_for_posts = '' ) |
|
104 | + public static function update_post_shortcodes($page_for_posts = '') |
|
105 | 105 | { |
106 | 106 | \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
107 | 107 | } |
@@ -114,7 +114,7 @@ discard block |
||
114 | 114 | * @param $value |
115 | 115 | * @return void |
116 | 116 | */ |
117 | - public static function reset_page_for_posts_on_initial_set( $option, $value ) |
|
117 | + public static function reset_page_for_posts_on_initial_set($option, $value) |
|
118 | 118 | { |
119 | 119 | \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
120 | 120 | } |
@@ -128,7 +128,7 @@ discard block |
||
128 | 128 | * @param string $value |
129 | 129 | * @return void |
130 | 130 | */ |
131 | - public static function reset_page_for_posts_on_change( $option, $old_value = '', $value = '' ) |
|
131 | + public static function reset_page_for_posts_on_change($option, $old_value = '', $value = '') |
|
132 | 132 | { |
133 | 133 | \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
134 | 134 | } |
@@ -140,7 +140,7 @@ discard block |
||
140 | 140 | * @param $option |
141 | 141 | * @return void |
142 | 142 | */ |
143 | - public static function reset_page_for_posts_on_delete( $option ) |
|
143 | + public static function reset_page_for_posts_on_delete($option) |
|
144 | 144 | { |
145 | 145 | \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
146 | 146 | } |
@@ -153,7 +153,7 @@ discard block |
||
153 | 153 | * @param bool $index_results |
154 | 154 | * @return void |
155 | 155 | */ |
156 | - public static function get_post_ids_for_shortcode( $shortcodes, $index_results = true ) |
|
156 | + public static function get_post_ids_for_shortcode($shortcodes, $index_results = true) |
|
157 | 157 | { |
158 | 158 | \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26'); |
159 | 159 | } |
@@ -555,7 +555,7 @@ discard block |
||
555 | 555 | */ |
556 | 556 | public function set_must_use_terms($taxonomy, $term_details) |
557 | 557 | { |
558 | - $term_details = (array)$term_details; |
|
558 | + $term_details = (array) $term_details; |
|
559 | 559 | foreach ($term_details as $slug => $details) { |
560 | 560 | if ( ! term_exists($slug, $taxonomy)) { |
561 | 561 | $insert_arr = array( |
@@ -600,7 +600,7 @@ discard block |
||
600 | 600 | if ($post->post_status === 'publish' && in_array($post->post_type, $default_obj->cpt_slugs, true)) { |
601 | 601 | //note some error proofing going on here to save unnecessary db queries |
602 | 602 | $taxonomies = get_object_taxonomies($post->post_type); |
603 | - foreach ((array)$taxonomies as $taxonomy) { |
|
603 | + foreach ((array) $taxonomies as $taxonomy) { |
|
604 | 604 | $terms = wp_get_post_terms($post_id, $taxonomy); |
605 | 605 | if (empty($terms) && $taxonomy === $default_obj->taxonomy) { |
606 | 606 | wp_set_object_terms($post_id, array($default_obj->term_slug), $taxonomy); |
@@ -642,7 +642,7 @@ discard block |
||
642 | 642 | public function __construct($taxonomy, $term_slug, $cpt_slugs = array()) |
643 | 643 | { |
644 | 644 | $this->taxonomy = $taxonomy; |
645 | - $this->cpt_slugs = (array)$cpt_slugs; |
|
645 | + $this->cpt_slugs = (array) $cpt_slugs; |
|
646 | 646 | $this->term_slug = $term_slug; |
647 | 647 | } |
648 | 648 |
@@ -1,5 +1,5 @@ discard block |
||
1 | 1 | <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
2 | - exit('No direct script access allowed'); |
|
2 | + exit('No direct script access allowed'); |
|
3 | 3 | } |
4 | 4 | |
5 | 5 | |
@@ -14,604 +14,604 @@ discard block |
||
14 | 14 | class EE_Register_CPTs |
15 | 15 | { |
16 | 16 | |
17 | - /** |
|
18 | - * This property is used to hold an array of EE_default_term objects assigned to a custom post type when the post |
|
19 | - * for that post type is published with no terms set for the taxonomy. |
|
20 | - * |
|
21 | - * @var array of EE_Default_Term objects |
|
22 | - */ |
|
23 | - protected $_default_terms = array(); |
|
24 | - |
|
25 | - |
|
26 | - |
|
27 | - /** |
|
28 | - * constructor |
|
29 | - * instantiated at init priority 5 |
|
30 | - */ |
|
31 | - public function __construct() |
|
32 | - { |
|
33 | - // register taxonomies |
|
34 | - $taxonomies = self::get_taxonomies(); |
|
35 | - foreach ($taxonomies as $taxonomy => $tax) { |
|
36 | - $this->register_taxonomy($taxonomy, $tax['singular_name'], $tax['plural_name'], $tax['args']); |
|
37 | - } |
|
38 | - // register CPTs |
|
39 | - $CPTs = self::get_CPTs(); |
|
40 | - foreach ($CPTs as $CPT_name => $CPT) { |
|
41 | - $this->register_CPT($CPT_name, $CPT['singular_name'], $CPT['plural_name'], $CPT['args'], |
|
42 | - $CPT['singular_slug'], $CPT['plural_slug']); |
|
43 | - } |
|
44 | - // setup default terms in any of our taxonomies (but only if we're in admin). |
|
45 | - // Why not added via register_activation_hook? |
|
46 | - // Because it's possible that in future iterations of EE we may add new defaults for specialized taxonomies |
|
47 | - // (think event_types) and register_activation_hook only reliably runs when a user manually activates the plugin. |
|
48 | - // Keep in mind that this will READ these terms if they are deleted by the user. Hence MUST use terms. |
|
49 | - // if ( is_admin() ) { |
|
50 | - // $this->set_must_use_event_types(); |
|
51 | - // } |
|
52 | - //set default terms |
|
53 | - $this->set_default_term('espresso_event_type', 'single-event', array('espresso_events')); |
|
54 | - add_action('AHEE__EE_System__initialize_last', array(__CLASS__, 'maybe_flush_rewrite_rules'), 10); |
|
55 | - // hook into save_post so that we can make sure that the default terms get saved on publish of registered cpts |
|
56 | - // IF they don't have a term for that taxonomy set. |
|
57 | - add_action('save_post', array($this, 'save_default_term'), 100, 2); |
|
58 | - // remove no html restrictions from core wp saving of term descriptions. |
|
59 | - // Note. this will affect only registered EE taxonomies. |
|
60 | - $this->_allow_html_descriptions_for_ee_taxonomies(); |
|
61 | - do_action('AHEE__EE_Register_CPTs__construct_end', $this); |
|
62 | - } |
|
63 | - |
|
64 | - |
|
65 | - |
|
66 | - /** |
|
67 | - * This will flush rewrite rules on demand. This actually gets called around wp init priority level 100. |
|
68 | - * |
|
69 | - * @since 4.5.0 |
|
70 | - * @return void |
|
71 | - */ |
|
72 | - public static function maybe_flush_rewrite_rules() |
|
73 | - { |
|
74 | - if (get_option('ee_flush_rewrite_rules', true)) { |
|
75 | - flush_rewrite_rules(); |
|
76 | - update_option('ee_flush_rewrite_rules', false); |
|
77 | - } |
|
78 | - } |
|
79 | - |
|
80 | - |
|
81 | - |
|
82 | - /** |
|
83 | - * By default, WordPress strips all html from term taxonomy description content. The purpose of this method is to |
|
84 | - * remove that restriction and ensure that we still run ee term taxonomy descriptions through some full html |
|
85 | - * sanitization equivalent to the post content field. |
|
86 | - * |
|
87 | - * @since 4.7.8 |
|
88 | - */ |
|
89 | - protected function _allow_html_descriptions_for_ee_taxonomies() |
|
90 | - { |
|
91 | - // first remove default filter for term description but we have to do this earlier |
|
92 | - // before wp sets their own filter |
|
93 | - // because they just set a global filter on all term descriptions before the custom term description filter. |
|
94 | - // Really sux. |
|
95 | - add_filter('pre_term_description', array($this, 'ee_filter_ee_term_description_not_wp'), 1, 2); |
|
96 | - } |
|
97 | - |
|
98 | - |
|
99 | - |
|
100 | - /** |
|
101 | - * Callback for pre_term_description hook. |
|
102 | - * |
|
103 | - * @param string $description The description content. |
|
104 | - * @param string $taxonomy The taxonomy name for the taxonomy being filtered. |
|
105 | - * @return string |
|
106 | - */ |
|
107 | - public function ee_filter_ee_term_description_not_wp($description, $taxonomy) |
|
108 | - { |
|
109 | - //get a list of EE taxonomies |
|
110 | - $ee_taxonomies = array_keys(self::get_taxonomies()); |
|
111 | - //only do our own thing if the taxonomy listed is an ee taxonomy. |
|
112 | - if (in_array($taxonomy, $ee_taxonomies, true)) { |
|
113 | - //remove default wp filter |
|
114 | - remove_filter('pre_term_description', 'wp_filter_kses'); |
|
115 | - //sanitize THIS content. |
|
116 | - $description = wp_kses($description, wp_kses_allowed_html('post')); |
|
117 | - } |
|
118 | - return $description; |
|
119 | - } |
|
120 | - |
|
121 | - |
|
122 | - |
|
123 | - /** |
|
124 | - * get_taxonomies |
|
125 | - * |
|
126 | - * @access public |
|
127 | - * @return array |
|
128 | - */ |
|
129 | - public static function get_taxonomies() |
|
130 | - { |
|
131 | - // define taxonomies |
|
132 | - return apply_filters('FHEE__EE_Register_CPTs__get_taxonomies__taxonomies', array( |
|
133 | - 'espresso_event_categories' => array( |
|
134 | - 'singular_name' => __("Event Category", "event_espresso"), |
|
135 | - 'plural_name' => __("Event Categories", "event_espresso"), |
|
136 | - 'args' => array( |
|
137 | - 'public' => true, |
|
138 | - 'show_in_nav_menus' => true, |
|
139 | - 'show_in_rest' => true, |
|
140 | - 'capabilities' => array( |
|
141 | - 'manage_terms' => 'ee_manage_event_categories', |
|
142 | - 'edit_terms' => 'ee_edit_event_category', |
|
143 | - 'delete_terms' => 'ee_delete_event_category', |
|
144 | - 'assign_terms' => 'ee_assign_event_category', |
|
145 | - ), |
|
146 | - 'rewrite' => array('slug' => __('event-category', 'event_espresso')), |
|
147 | - ), |
|
148 | - ), |
|
149 | - 'espresso_venue_categories' => array( |
|
150 | - 'singular_name' => __("Venue Category", "event_espresso"), |
|
151 | - 'plural_name' => __("Venue Categories", "event_espresso"), |
|
152 | - 'args' => array( |
|
153 | - 'public' => true, |
|
154 | - 'show_in_nav_menus' => false, //by default this doesn't show for decaf |
|
155 | - 'show_in_rest' => true, |
|
156 | - 'capabilities' => array( |
|
157 | - 'manage_terms' => 'ee_manage_venue_categories', |
|
158 | - 'edit_terms' => 'ee_edit_venue_category', |
|
159 | - 'delete_terms' => 'ee_delete_venue_category', |
|
160 | - 'assign_terms' => 'ee_assign_venue_category', |
|
161 | - ), |
|
162 | - 'rewrite' => array('slug' => __('venue-category', 'event_espresso')), |
|
163 | - ), |
|
164 | - ), |
|
165 | - 'espresso_event_type' => array( |
|
166 | - 'singular_name' => __("Event Type", "event_espresso"), |
|
167 | - 'plural_name' => __("Event Types", "event_espresso"), |
|
168 | - 'args' => array( |
|
169 | - 'public' => true, |
|
170 | - 'show_ui' => false, |
|
171 | - 'show_in_rest' => true, |
|
172 | - 'capabilities' => array( |
|
173 | - 'manage_terms' => 'ee_read_event_type', |
|
174 | - 'edit_terms' => 'ee_edit_event_type', |
|
175 | - 'delete_terms' => 'ee_delete_event_type', |
|
176 | - 'assign_terms' => 'ee_assign_event_type', |
|
177 | - ), |
|
178 | - 'rewrite' => array('slug' => __('event-type', 'event_espresso')), |
|
179 | - 'hierarchical' => true, |
|
180 | - ), |
|
181 | - ), |
|
182 | - )); |
|
183 | - } |
|
184 | - |
|
185 | - |
|
186 | - |
|
187 | - /** |
|
188 | - * This returns the corresponding model name for cpts registered by EE. |
|
189 | - * |
|
190 | - * @since 4.6.16.rc.000 |
|
191 | - * @param string $post_type_slug If a slug is included, then attempt to retrieve the model name for |
|
192 | - * the given cpt slug. Otherwise if empty, then we'll return all cpt |
|
193 | - * model names for cpts registered in EE. |
|
194 | - * @return array Empty array if no matching model names for the given slug or an array of model |
|
195 | - * names indexed by post type slug. |
|
196 | - */ |
|
197 | - public static function get_cpt_model_names($post_type_slug = '') |
|
198 | - { |
|
199 | - $cpts = self::get_CPTs(); |
|
200 | - //first if slug passed in... |
|
201 | - if ( ! empty($post_type_slug)) { |
|
202 | - //match? |
|
203 | - if ( |
|
204 | - ! isset($cpts[$post_type_slug]) |
|
205 | - || (isset($cpts[$post_type_slug]) && empty($cpts[$post_type_slug]['class_name'])) |
|
206 | - ) { |
|
207 | - return array(); |
|
208 | - } |
|
209 | - //k let's get the model name for this cpt. |
|
210 | - return array($post_type_slug => str_replace('EE', 'EEM', $cpts[$post_type_slug]['class_name'])); |
|
211 | - } |
|
212 | - //if we made it here then we're returning an array of cpt model names indexed by post_type_slug. |
|
213 | - $cpt_models = array(); |
|
214 | - foreach ($cpts as $slug => $args) { |
|
215 | - if ( ! empty($args['class_name'])) { |
|
216 | - $cpt_models[$slug] = str_replace('EE', 'EEM', $args['class_name']); |
|
217 | - } |
|
218 | - } |
|
219 | - return $cpt_models; |
|
220 | - } |
|
221 | - |
|
222 | - |
|
223 | - |
|
224 | - /** |
|
225 | - * This instantiates cpt models related to the cpts registered via EE. |
|
226 | - * |
|
227 | - * @since 4.6.16.rc.000 |
|
228 | - * @param string $post_type_slug If valid slug is provided, then will instantiate the model only for |
|
229 | - * the cpt matching the given slug. Otherwise all cpt models will be |
|
230 | - * instantiated (if possible). |
|
231 | - * @return EEM_CPT_Base[] successful instantiation will return an array of successfully instantiated |
|
232 | - * EEM models indexed by post slug. |
|
233 | - */ |
|
234 | - public static function instantiate_cpt_models($post_type_slug = '') |
|
235 | - { |
|
236 | - $cpt_model_names = self::get_cpt_model_names($post_type_slug); |
|
237 | - $instantiated = array(); |
|
238 | - foreach ($cpt_model_names as $slug => $model_name) { |
|
239 | - $instance = EE_Registry::instance()->load_model(str_replace('EEM_', '', $model_name)); |
|
240 | - if ($instance instanceof EEM_CPT_Base) { |
|
241 | - $instantiated[$slug] = $instance; |
|
242 | - } |
|
243 | - } |
|
244 | - return $instantiated; |
|
245 | - } |
|
246 | - |
|
247 | - |
|
248 | - |
|
249 | - /** |
|
250 | - * get_CPTs |
|
251 | - * |
|
252 | - * @access public |
|
253 | - * @return array |
|
254 | - */ |
|
255 | - public static function get_CPTs() |
|
256 | - { |
|
257 | - // define CPTs |
|
258 | - // NOTE the ['args']['page_templates'] array index is something specific to our CPTs |
|
259 | - // and not part of the WP custom post type api. |
|
260 | - return apply_filters('FHEE__EE_Register_CPTs__get_CPTs__cpts', array( |
|
261 | - 'espresso_events' => array( |
|
262 | - 'singular_name' => __("Event", "event_espresso"), |
|
263 | - 'plural_name' => __("Events", "event_espresso"), |
|
264 | - 'singular_slug' => __("event", "event_espresso"), |
|
265 | - 'plural_slug' => EE_Registry::instance()->CFG->core->event_cpt_slug, |
|
266 | - 'class_name' => 'EE_Event', |
|
267 | - 'args' => array( |
|
268 | - 'public' => true, |
|
269 | - 'show_in_nav_menus' => true, |
|
270 | - 'capability_type' => 'event', |
|
271 | - 'capabilities' => array( |
|
272 | - 'edit_post' => 'ee_edit_event', |
|
273 | - 'read_post' => 'ee_read_event', |
|
274 | - 'delete_post' => 'ee_delete_event', |
|
275 | - 'edit_posts' => 'ee_edit_events', |
|
276 | - 'edit_others_posts' => 'ee_edit_others_events', |
|
277 | - 'publish_posts' => 'ee_publish_events', |
|
278 | - 'read_private_posts' => 'ee_read_private_events', |
|
279 | - 'delete_posts' => 'ee_delete_events', |
|
280 | - 'delete_private_posts' => 'ee_delete_private_events', |
|
281 | - 'delete_published_posts' => 'ee_delete_published_events', |
|
282 | - 'delete_others_posts' => 'ee_delete_others_events', |
|
283 | - 'edit_private_posts' => 'ee_edit_private_events', |
|
284 | - 'edit_published_posts' => 'ee_edit_published_events', |
|
285 | - ), |
|
286 | - 'taxonomies' => array( |
|
287 | - 'espresso_event_categories', |
|
288 | - 'espresso_event_type', |
|
289 | - 'post_tag', |
|
290 | - ), |
|
291 | - 'page_templates' => true, |
|
292 | - ), |
|
293 | - ), |
|
294 | - 'espresso_venues' => array( |
|
295 | - 'singular_name' => __("Venue", "event_espresso"), |
|
296 | - 'plural_name' => __("Venues", "event_espresso"), |
|
297 | - 'singular_slug' => __("venue", "event_espresso"), |
|
298 | - 'plural_slug' => __("venues", "event_espresso"), |
|
299 | - 'class_name' => 'EE_Venue', |
|
300 | - 'args' => array( |
|
301 | - 'public' => true, |
|
302 | - 'show_in_nav_menus' => false, //by default this doesn't show for decaf, |
|
303 | - 'capability_type' => 'venue', |
|
304 | - 'capabilities' => array( |
|
305 | - 'edit_post' => 'ee_edit_venue', |
|
306 | - 'read_post' => 'ee_read_venue', |
|
307 | - 'delete_post' => 'ee_delete_venue', |
|
308 | - 'edit_posts' => 'ee_edit_venues', |
|
309 | - 'edit_others_posts' => 'ee_edit_others_venues', |
|
310 | - 'publish_posts' => 'ee_publish_venues', |
|
311 | - 'read_private_posts' => 'ee_read_private_venues', |
|
312 | - 'delete_posts' => 'ee_delete_venues', |
|
313 | - 'delete_private_posts' => 'ee_delete_private_venues', |
|
314 | - 'delete_published_posts' => 'ee_delete_published_venues', |
|
315 | - 'delete_others_posts' => 'ee_edit_others_venues', |
|
316 | - 'edit_private_posts' => 'ee_edit_private_venues', |
|
317 | - 'edit_published_posts' => 'ee_edit_published_venues', |
|
318 | - ), |
|
319 | - 'taxonomies' => array( |
|
320 | - 'espresso_venue_categories', |
|
321 | - 'post_tag', |
|
322 | - ), |
|
323 | - 'page_templates' => true, |
|
324 | - ), |
|
325 | - ), |
|
326 | - 'espresso_attendees' => array( |
|
327 | - 'singular_name' => __("Contact", "event_espresso"), |
|
328 | - 'plural_name' => __("Contacts", "event_espresso"), |
|
329 | - 'singular_slug' => __("contact", "event_espresso"), |
|
330 | - 'plural_slug' => __("contacts", "event_espresso"), |
|
331 | - 'class_name' => 'EE_Attendee', |
|
332 | - 'args' => array( |
|
333 | - 'public' => false, |
|
334 | - 'publicly_queryable' => false, |
|
335 | - 'hierarchical' => false, |
|
336 | - 'has_archive' => false, |
|
337 | - 'taxonomies' => array('post_tag'), |
|
338 | - 'capability_type' => 'contact', |
|
339 | - 'capabilities' => array( |
|
340 | - 'edit_post' => 'ee_edit_contact', |
|
341 | - 'read_post' => 'ee_read_contact', |
|
342 | - 'delete_post' => 'ee_delete_contact', |
|
343 | - 'edit_posts' => 'ee_edit_contacts', |
|
344 | - 'edit_others_posts' => 'ee_edit_contacts', |
|
345 | - 'publish_posts' => 'ee_edit_contacts', |
|
346 | - 'read_private_posts' => 'ee_edit_contacts', |
|
347 | - 'delete_posts' => 'ee_delete_contacts', |
|
348 | - 'delete_private_posts' => 'ee_delete_contacts', |
|
349 | - 'delete_published_posts' => 'ee_delete_contacts', |
|
350 | - 'delete_others_posts' => 'ee_delete_contacts', |
|
351 | - 'edit_private_posts' => 'ee_edit_contacts', |
|
352 | - 'edit_published_posts' => 'ee_edit_contacts', |
|
353 | - ), |
|
354 | - 'supports' => array('editor', 'thumbnail', 'excerpt', 'custom-fields', 'comments'), |
|
355 | - ), |
|
356 | - ), |
|
357 | - )); |
|
358 | - } |
|
359 | - |
|
360 | - |
|
361 | - |
|
362 | - /** |
|
363 | - * This basically goes through the CPT array and returns only CPT's |
|
364 | - * that have the ['args']['public'] option set as false |
|
365 | - * |
|
366 | - * @return array |
|
367 | - */ |
|
368 | - public static function get_private_CPTs() |
|
369 | - { |
|
370 | - $CPTs = self::get_CPTs(); |
|
371 | - $private_CPTs = array(); |
|
372 | - foreach ($CPTs as $CPT => $details) { |
|
373 | - if (empty($details['args']['public'])) { |
|
374 | - $private_CPTs[$CPT] = $details; |
|
375 | - } |
|
376 | - } |
|
377 | - return $private_CPTs; |
|
378 | - } |
|
379 | - |
|
380 | - |
|
381 | - |
|
382 | - /** |
|
383 | - * Registers a custom taxonomy. Should be called before registering custom post types, |
|
384 | - * otherwise you should link the taxonomy to the custom post type using 'register_taxonomy_for_object_type'. |
|
385 | - * |
|
386 | - * @param string $taxonomy_name , eg 'books' |
|
387 | - * @param string $singular_name internationalized singular name |
|
388 | - * @param string $plural_name internationalized plural name |
|
389 | - * @param array $override_args like $args on http://codex.wordpress.org/Function_Reference/register_taxonomy |
|
390 | - */ |
|
391 | - public function register_taxonomy($taxonomy_name, $singular_name, $plural_name, $override_args = array()) |
|
392 | - { |
|
393 | - $args = array( |
|
394 | - 'hierarchical' => true, |
|
395 | - 'labels' => array( |
|
396 | - 'name' => $plural_name, |
|
397 | - 'singular_name' => $singular_name, |
|
398 | - ), |
|
399 | - 'show_ui' => true, |
|
400 | - 'show_ee_ui' => true, |
|
401 | - 'show_admin_column' => true, |
|
402 | - 'query_var' => true, |
|
403 | - 'show_in_nav_menus' => false, |
|
404 | - 'map_meta_cap' => true |
|
405 | - //'rewrite' => array( 'slug' => 'genre' ), |
|
406 | - ); |
|
407 | - if ($override_args) { |
|
408 | - if (isset($override_args['labels'])) { |
|
409 | - $labels = array_merge($args['labels'], $override_args['labels']); |
|
410 | - $args['labels'] = $labels; |
|
411 | - } |
|
412 | - $args = array_merge($args, $override_args); |
|
413 | - } |
|
414 | - register_taxonomy($taxonomy_name, null, $args); |
|
415 | - } |
|
416 | - |
|
417 | - |
|
418 | - |
|
419 | - /** |
|
420 | - * Registers a new custom post type. Sets default settings given only the following params. |
|
421 | - * |
|
422 | - * @param string $post_type the actual post type name |
|
423 | - * (VERY IMPORTANT: this much match what the slug is for admin pages related to this |
|
424 | - * cpt Also any models must use this slug as well) |
|
425 | - * @param string $singular_name a pre-internationalized string for the singular name of the objects |
|
426 | - * @param string $plural_name a pre-internalized string for the plural name of the objects |
|
427 | - * @param array $override_args exactly like $args as described in |
|
428 | - * http://codex.wordpress.org/Function_Reference/register_post_type The default values |
|
429 | - * set in this function will be overridden by whatever you set in $override_args |
|
430 | - * @param string $singular_slug |
|
431 | - * @param string $plural_slug |
|
432 | - * @return void , but registers the custom post type |
|
433 | - */ |
|
434 | - public function register_CPT( |
|
435 | - $post_type, |
|
436 | - $singular_name, |
|
437 | - $plural_name, |
|
438 | - $override_args = array(), |
|
439 | - $singular_slug = '', |
|
440 | - $plural_slug = '' |
|
441 | - ) { |
|
442 | - $labels = array( |
|
443 | - 'name' => $plural_name, |
|
444 | - 'singular_name' => $singular_name, |
|
445 | - 'singular_slug' => $singular_slug, |
|
446 | - 'plural_slug' => $plural_slug, |
|
447 | - 'add_new' => sprintf(__("Add %s", "event_espresso"), $singular_name), |
|
448 | - 'add_new_item' => sprintf(__("Add New %s", "event_espresso"), $singular_name), |
|
449 | - 'edit_item' => sprintf(__("Edit %s", "event_espresso"), $singular_name), |
|
450 | - 'new_item' => sprintf(__("New %s", "event_espresso"), $singular_name), |
|
451 | - 'all_items' => sprintf(__("All %s", "event_espresso"), $plural_name), |
|
452 | - 'view_item' => sprintf(__("View %s", "event_espresso"), $singular_name), |
|
453 | - 'search_items' => sprintf(__("Search %s", "event_espresso"), $plural_name), |
|
454 | - 'not_found' => sprintf(__("No %s found", "event_espresso"), $plural_name), |
|
455 | - 'not_found_in_trash' => sprintf(__("No %s found in Trash", "event_espresso"), $plural_name), |
|
456 | - 'parent_item_colon' => '', |
|
457 | - 'menu_name' => sprintf(__("%s", "event_espresso"), $plural_name), |
|
458 | - ); |
|
459 | - //verify plural slug and singular slug, if they aren't we'll use $singular_name and $plural_name |
|
460 | - // $singular_slug = ! empty($singular_slug) ? $singular_slug : $singular_name; |
|
461 | - $plural_slug = ! empty($plural_slug) ? $plural_slug : $plural_name; |
|
462 | - //note the page_templates arg in the supports index is something specific to EE. |
|
463 | - // WordPress doesn't actually have that in their register_post_type api. |
|
464 | - $args = array( |
|
465 | - 'labels' => $labels, |
|
466 | - 'public' => true, |
|
467 | - 'publicly_queryable' => true, |
|
468 | - 'show_ui' => false, |
|
469 | - 'show_ee_ui' => true, |
|
470 | - 'show_in_menu' => false, |
|
471 | - 'show_in_nav_menus' => false, |
|
472 | - 'query_var' => true, |
|
473 | - 'rewrite' => apply_filters( |
|
474 | - 'FHEE__EE_Register_CPTs__register_CPT__rewrite', |
|
475 | - array('slug' => $plural_slug), |
|
476 | - $post_type |
|
477 | - ), |
|
478 | - 'capability_type' => 'post', |
|
479 | - 'map_meta_cap' => true, |
|
480 | - 'has_archive' => true, |
|
481 | - 'hierarchical' => false, |
|
482 | - 'menu_position' => null, |
|
483 | - 'supports' => array( |
|
484 | - 'title', |
|
485 | - 'editor', |
|
486 | - 'author', |
|
487 | - 'thumbnail', |
|
488 | - 'excerpt', |
|
489 | - 'custom-fields', |
|
490 | - 'comments', |
|
491 | - ), |
|
492 | - ); |
|
493 | - if ($override_args) { |
|
494 | - if (isset($override_args['labels'])) { |
|
495 | - $labels = array_merge($args['labels'], $override_args['labels']); |
|
496 | - } |
|
497 | - $args = array_merge($args, $override_args); |
|
498 | - $args['labels'] = $labels; |
|
499 | - } |
|
500 | - register_post_type($post_type, $args); |
|
501 | - } |
|
502 | - |
|
503 | - |
|
504 | - |
|
505 | - public function set_must_use_event_types() |
|
506 | - { |
|
507 | - $term_details = array( |
|
508 | - //Attendee's register for the first date-time only |
|
509 | - 'single-event' => array( |
|
510 | - __('Single Event', 'event_espresso'), |
|
511 | - __('A single event that spans one or more consecutive days.', 'event_espresso'), |
|
512 | - ), |
|
513 | - //example: a party or two-day long workshop |
|
514 | - //Attendee's can register for any of the date-times |
|
515 | - 'multi-event' => array( |
|
516 | - __('Multi Event', 'event_espresso'), |
|
517 | - __('Multiple, separate, but related events that occur on consecutive days.', 'event_espresso'), |
|
518 | - ), |
|
519 | - //example: a three day music festival or week long conference |
|
520 | - //Attendee's register for the first date-time only |
|
521 | - 'event-series' => array( |
|
522 | - __('Event Series', 'event_espresso'), |
|
523 | - __(' Multiple events that occur over multiple non-consecutive days.', 'event_espresso'), |
|
524 | - ), |
|
525 | - //example: an 8 week introduction to basket weaving course |
|
526 | - //Attendee's can register for any of the date-times. |
|
527 | - 'recurring-event' => array( |
|
528 | - __('Recurring Event', 'event_espresso'), |
|
529 | - __('Multiple events that occur over multiple non-consecutive days.', 'event_espresso'), |
|
530 | - ), |
|
531 | - //example: a yoga class |
|
532 | - 'ongoing' => array( |
|
533 | - __('Ongoing Event', 'event_espresso'), |
|
534 | - __('An "event" that people can purchase tickets to gain access for anytime for this event regardless of date times on the event', |
|
535 | - 'event_espresso'), |
|
536 | - ) |
|
537 | - //example: access to a museum |
|
538 | - //'walk-in' => array( __('Walk In', 'event_espresso'), __('Single datetime and single entry recurring events. Attendees register for one or multiple datetimes individually.', 'event_espresso') ), |
|
539 | - //'reservation' => array( __('Reservation', 'event_espresso'), __('Reservations are created by specifying available datetimes and quantities. Attendees choose from the available datetimes and specify the quantity available (if the maximum is greater than 1)') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1 |
|
540 | - // 'multiple-session' => array( __('Multiple Session', 'event_espresso'), __('Multiple event, multiple datetime, hierarchically organized, custom entry events. Attendees may be required to register for a parent event before being allowed to register for child events. Attendees can register for any combination of child events as long as the datetimes do not conflict. Parent and child events may have additional fees or registration questions.') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1 |
|
541 | - //'appointment' => array( __('Appointments', 'event_espresso'), __('Time slotted events where datetimes are generally in hours or minutes. For example, attendees can register for a single 15 minute or 1 hour time slot and this type of availability frequently reoccurs.', 'event_espresso') ) |
|
542 | - ); |
|
543 | - $this->set_must_use_terms('espresso_event_type', $term_details); |
|
544 | - } |
|
545 | - |
|
546 | - |
|
547 | - |
|
548 | - /** |
|
549 | - * wrapper method for handling the setting up of initial terms in the db (if they don't already exist). |
|
550 | - * Note this should ONLY be used for terms that always must be present. Be aware that if an initial term is |
|
551 | - * deleted then it WILL be recreated. |
|
552 | - * |
|
553 | - * @param string $taxonomy The name of the taxonomy |
|
554 | - * @param array $term_details An array of term details indexed by slug and containing Name of term, and |
|
555 | - * description as the elements in the array |
|
556 | - * @return void |
|
557 | - */ |
|
558 | - public function set_must_use_terms($taxonomy, $term_details) |
|
559 | - { |
|
560 | - $term_details = (array)$term_details; |
|
561 | - foreach ($term_details as $slug => $details) { |
|
562 | - if ( ! term_exists($slug, $taxonomy)) { |
|
563 | - $insert_arr = array( |
|
564 | - 'slug' => $slug, |
|
565 | - 'description' => $details[1], |
|
566 | - ); |
|
567 | - wp_insert_term($details[0], $taxonomy, $insert_arr); |
|
568 | - } |
|
569 | - } |
|
570 | - } |
|
571 | - |
|
572 | - |
|
573 | - |
|
574 | - /** |
|
575 | - * Allows us to set what the default will be for terms when a cpt is PUBLISHED. |
|
576 | - * |
|
577 | - * @param string $taxonomy The taxonomy we're using for the default term |
|
578 | - * @param string $term_slug The slug of the term that will be the default. |
|
579 | - * @param array $cpt_slugs An array of custom post types we want the default assigned to |
|
580 | - */ |
|
581 | - public function set_default_term($taxonomy, $term_slug, $cpt_slugs = array()) |
|
582 | - { |
|
583 | - $this->_default_terms[][$term_slug] = new EE_Default_Term($taxonomy, $term_slug, $cpt_slugs); |
|
584 | - } |
|
585 | - |
|
586 | - |
|
587 | - |
|
588 | - /** |
|
589 | - * hooked into the wp 'save_post' action hook for setting our default terms found in the $_default_terms property |
|
590 | - * |
|
591 | - * @param int $post_id ID of CPT being saved |
|
592 | - * @param object $post Post object |
|
593 | - * @return void |
|
594 | - */ |
|
595 | - public function save_default_term($post_id, $post) |
|
596 | - { |
|
597 | - if (empty($this->_default_terms)) { |
|
598 | - return; |
|
599 | - } //no default terms set so lets just exit. |
|
600 | - foreach ($this->_default_terms as $defaults) { |
|
601 | - foreach ($defaults as $default_obj) { |
|
602 | - if ($post->post_status === 'publish' && in_array($post->post_type, $default_obj->cpt_slugs, true)) { |
|
603 | - //note some error proofing going on here to save unnecessary db queries |
|
604 | - $taxonomies = get_object_taxonomies($post->post_type); |
|
605 | - foreach ((array)$taxonomies as $taxonomy) { |
|
606 | - $terms = wp_get_post_terms($post_id, $taxonomy); |
|
607 | - if (empty($terms) && $taxonomy === $default_obj->taxonomy) { |
|
608 | - wp_set_object_terms($post_id, array($default_obj->term_slug), $taxonomy); |
|
609 | - } |
|
610 | - } |
|
611 | - } |
|
612 | - } |
|
613 | - } |
|
614 | - } |
|
17 | + /** |
|
18 | + * This property is used to hold an array of EE_default_term objects assigned to a custom post type when the post |
|
19 | + * for that post type is published with no terms set for the taxonomy. |
|
20 | + * |
|
21 | + * @var array of EE_Default_Term objects |
|
22 | + */ |
|
23 | + protected $_default_terms = array(); |
|
24 | + |
|
25 | + |
|
26 | + |
|
27 | + /** |
|
28 | + * constructor |
|
29 | + * instantiated at init priority 5 |
|
30 | + */ |
|
31 | + public function __construct() |
|
32 | + { |
|
33 | + // register taxonomies |
|
34 | + $taxonomies = self::get_taxonomies(); |
|
35 | + foreach ($taxonomies as $taxonomy => $tax) { |
|
36 | + $this->register_taxonomy($taxonomy, $tax['singular_name'], $tax['plural_name'], $tax['args']); |
|
37 | + } |
|
38 | + // register CPTs |
|
39 | + $CPTs = self::get_CPTs(); |
|
40 | + foreach ($CPTs as $CPT_name => $CPT) { |
|
41 | + $this->register_CPT($CPT_name, $CPT['singular_name'], $CPT['plural_name'], $CPT['args'], |
|
42 | + $CPT['singular_slug'], $CPT['plural_slug']); |
|
43 | + } |
|
44 | + // setup default terms in any of our taxonomies (but only if we're in admin). |
|
45 | + // Why not added via register_activation_hook? |
|
46 | + // Because it's possible that in future iterations of EE we may add new defaults for specialized taxonomies |
|
47 | + // (think event_types) and register_activation_hook only reliably runs when a user manually activates the plugin. |
|
48 | + // Keep in mind that this will READ these terms if they are deleted by the user. Hence MUST use terms. |
|
49 | + // if ( is_admin() ) { |
|
50 | + // $this->set_must_use_event_types(); |
|
51 | + // } |
|
52 | + //set default terms |
|
53 | + $this->set_default_term('espresso_event_type', 'single-event', array('espresso_events')); |
|
54 | + add_action('AHEE__EE_System__initialize_last', array(__CLASS__, 'maybe_flush_rewrite_rules'), 10); |
|
55 | + // hook into save_post so that we can make sure that the default terms get saved on publish of registered cpts |
|
56 | + // IF they don't have a term for that taxonomy set. |
|
57 | + add_action('save_post', array($this, 'save_default_term'), 100, 2); |
|
58 | + // remove no html restrictions from core wp saving of term descriptions. |
|
59 | + // Note. this will affect only registered EE taxonomies. |
|
60 | + $this->_allow_html_descriptions_for_ee_taxonomies(); |
|
61 | + do_action('AHEE__EE_Register_CPTs__construct_end', $this); |
|
62 | + } |
|
63 | + |
|
64 | + |
|
65 | + |
|
66 | + /** |
|
67 | + * This will flush rewrite rules on demand. This actually gets called around wp init priority level 100. |
|
68 | + * |
|
69 | + * @since 4.5.0 |
|
70 | + * @return void |
|
71 | + */ |
|
72 | + public static function maybe_flush_rewrite_rules() |
|
73 | + { |
|
74 | + if (get_option('ee_flush_rewrite_rules', true)) { |
|
75 | + flush_rewrite_rules(); |
|
76 | + update_option('ee_flush_rewrite_rules', false); |
|
77 | + } |
|
78 | + } |
|
79 | + |
|
80 | + |
|
81 | + |
|
82 | + /** |
|
83 | + * By default, WordPress strips all html from term taxonomy description content. The purpose of this method is to |
|
84 | + * remove that restriction and ensure that we still run ee term taxonomy descriptions through some full html |
|
85 | + * sanitization equivalent to the post content field. |
|
86 | + * |
|
87 | + * @since 4.7.8 |
|
88 | + */ |
|
89 | + protected function _allow_html_descriptions_for_ee_taxonomies() |
|
90 | + { |
|
91 | + // first remove default filter for term description but we have to do this earlier |
|
92 | + // before wp sets their own filter |
|
93 | + // because they just set a global filter on all term descriptions before the custom term description filter. |
|
94 | + // Really sux. |
|
95 | + add_filter('pre_term_description', array($this, 'ee_filter_ee_term_description_not_wp'), 1, 2); |
|
96 | + } |
|
97 | + |
|
98 | + |
|
99 | + |
|
100 | + /** |
|
101 | + * Callback for pre_term_description hook. |
|
102 | + * |
|
103 | + * @param string $description The description content. |
|
104 | + * @param string $taxonomy The taxonomy name for the taxonomy being filtered. |
|
105 | + * @return string |
|
106 | + */ |
|
107 | + public function ee_filter_ee_term_description_not_wp($description, $taxonomy) |
|
108 | + { |
|
109 | + //get a list of EE taxonomies |
|
110 | + $ee_taxonomies = array_keys(self::get_taxonomies()); |
|
111 | + //only do our own thing if the taxonomy listed is an ee taxonomy. |
|
112 | + if (in_array($taxonomy, $ee_taxonomies, true)) { |
|
113 | + //remove default wp filter |
|
114 | + remove_filter('pre_term_description', 'wp_filter_kses'); |
|
115 | + //sanitize THIS content. |
|
116 | + $description = wp_kses($description, wp_kses_allowed_html('post')); |
|
117 | + } |
|
118 | + return $description; |
|
119 | + } |
|
120 | + |
|
121 | + |
|
122 | + |
|
123 | + /** |
|
124 | + * get_taxonomies |
|
125 | + * |
|
126 | + * @access public |
|
127 | + * @return array |
|
128 | + */ |
|
129 | + public static function get_taxonomies() |
|
130 | + { |
|
131 | + // define taxonomies |
|
132 | + return apply_filters('FHEE__EE_Register_CPTs__get_taxonomies__taxonomies', array( |
|
133 | + 'espresso_event_categories' => array( |
|
134 | + 'singular_name' => __("Event Category", "event_espresso"), |
|
135 | + 'plural_name' => __("Event Categories", "event_espresso"), |
|
136 | + 'args' => array( |
|
137 | + 'public' => true, |
|
138 | + 'show_in_nav_menus' => true, |
|
139 | + 'show_in_rest' => true, |
|
140 | + 'capabilities' => array( |
|
141 | + 'manage_terms' => 'ee_manage_event_categories', |
|
142 | + 'edit_terms' => 'ee_edit_event_category', |
|
143 | + 'delete_terms' => 'ee_delete_event_category', |
|
144 | + 'assign_terms' => 'ee_assign_event_category', |
|
145 | + ), |
|
146 | + 'rewrite' => array('slug' => __('event-category', 'event_espresso')), |
|
147 | + ), |
|
148 | + ), |
|
149 | + 'espresso_venue_categories' => array( |
|
150 | + 'singular_name' => __("Venue Category", "event_espresso"), |
|
151 | + 'plural_name' => __("Venue Categories", "event_espresso"), |
|
152 | + 'args' => array( |
|
153 | + 'public' => true, |
|
154 | + 'show_in_nav_menus' => false, //by default this doesn't show for decaf |
|
155 | + 'show_in_rest' => true, |
|
156 | + 'capabilities' => array( |
|
157 | + 'manage_terms' => 'ee_manage_venue_categories', |
|
158 | + 'edit_terms' => 'ee_edit_venue_category', |
|
159 | + 'delete_terms' => 'ee_delete_venue_category', |
|
160 | + 'assign_terms' => 'ee_assign_venue_category', |
|
161 | + ), |
|
162 | + 'rewrite' => array('slug' => __('venue-category', 'event_espresso')), |
|
163 | + ), |
|
164 | + ), |
|
165 | + 'espresso_event_type' => array( |
|
166 | + 'singular_name' => __("Event Type", "event_espresso"), |
|
167 | + 'plural_name' => __("Event Types", "event_espresso"), |
|
168 | + 'args' => array( |
|
169 | + 'public' => true, |
|
170 | + 'show_ui' => false, |
|
171 | + 'show_in_rest' => true, |
|
172 | + 'capabilities' => array( |
|
173 | + 'manage_terms' => 'ee_read_event_type', |
|
174 | + 'edit_terms' => 'ee_edit_event_type', |
|
175 | + 'delete_terms' => 'ee_delete_event_type', |
|
176 | + 'assign_terms' => 'ee_assign_event_type', |
|
177 | + ), |
|
178 | + 'rewrite' => array('slug' => __('event-type', 'event_espresso')), |
|
179 | + 'hierarchical' => true, |
|
180 | + ), |
|
181 | + ), |
|
182 | + )); |
|
183 | + } |
|
184 | + |
|
185 | + |
|
186 | + |
|
187 | + /** |
|
188 | + * This returns the corresponding model name for cpts registered by EE. |
|
189 | + * |
|
190 | + * @since 4.6.16.rc.000 |
|
191 | + * @param string $post_type_slug If a slug is included, then attempt to retrieve the model name for |
|
192 | + * the given cpt slug. Otherwise if empty, then we'll return all cpt |
|
193 | + * model names for cpts registered in EE. |
|
194 | + * @return array Empty array if no matching model names for the given slug or an array of model |
|
195 | + * names indexed by post type slug. |
|
196 | + */ |
|
197 | + public static function get_cpt_model_names($post_type_slug = '') |
|
198 | + { |
|
199 | + $cpts = self::get_CPTs(); |
|
200 | + //first if slug passed in... |
|
201 | + if ( ! empty($post_type_slug)) { |
|
202 | + //match? |
|
203 | + if ( |
|
204 | + ! isset($cpts[$post_type_slug]) |
|
205 | + || (isset($cpts[$post_type_slug]) && empty($cpts[$post_type_slug]['class_name'])) |
|
206 | + ) { |
|
207 | + return array(); |
|
208 | + } |
|
209 | + //k let's get the model name for this cpt. |
|
210 | + return array($post_type_slug => str_replace('EE', 'EEM', $cpts[$post_type_slug]['class_name'])); |
|
211 | + } |
|
212 | + //if we made it here then we're returning an array of cpt model names indexed by post_type_slug. |
|
213 | + $cpt_models = array(); |
|
214 | + foreach ($cpts as $slug => $args) { |
|
215 | + if ( ! empty($args['class_name'])) { |
|
216 | + $cpt_models[$slug] = str_replace('EE', 'EEM', $args['class_name']); |
|
217 | + } |
|
218 | + } |
|
219 | + return $cpt_models; |
|
220 | + } |
|
221 | + |
|
222 | + |
|
223 | + |
|
224 | + /** |
|
225 | + * This instantiates cpt models related to the cpts registered via EE. |
|
226 | + * |
|
227 | + * @since 4.6.16.rc.000 |
|
228 | + * @param string $post_type_slug If valid slug is provided, then will instantiate the model only for |
|
229 | + * the cpt matching the given slug. Otherwise all cpt models will be |
|
230 | + * instantiated (if possible). |
|
231 | + * @return EEM_CPT_Base[] successful instantiation will return an array of successfully instantiated |
|
232 | + * EEM models indexed by post slug. |
|
233 | + */ |
|
234 | + public static function instantiate_cpt_models($post_type_slug = '') |
|
235 | + { |
|
236 | + $cpt_model_names = self::get_cpt_model_names($post_type_slug); |
|
237 | + $instantiated = array(); |
|
238 | + foreach ($cpt_model_names as $slug => $model_name) { |
|
239 | + $instance = EE_Registry::instance()->load_model(str_replace('EEM_', '', $model_name)); |
|
240 | + if ($instance instanceof EEM_CPT_Base) { |
|
241 | + $instantiated[$slug] = $instance; |
|
242 | + } |
|
243 | + } |
|
244 | + return $instantiated; |
|
245 | + } |
|
246 | + |
|
247 | + |
|
248 | + |
|
249 | + /** |
|
250 | + * get_CPTs |
|
251 | + * |
|
252 | + * @access public |
|
253 | + * @return array |
|
254 | + */ |
|
255 | + public static function get_CPTs() |
|
256 | + { |
|
257 | + // define CPTs |
|
258 | + // NOTE the ['args']['page_templates'] array index is something specific to our CPTs |
|
259 | + // and not part of the WP custom post type api. |
|
260 | + return apply_filters('FHEE__EE_Register_CPTs__get_CPTs__cpts', array( |
|
261 | + 'espresso_events' => array( |
|
262 | + 'singular_name' => __("Event", "event_espresso"), |
|
263 | + 'plural_name' => __("Events", "event_espresso"), |
|
264 | + 'singular_slug' => __("event", "event_espresso"), |
|
265 | + 'plural_slug' => EE_Registry::instance()->CFG->core->event_cpt_slug, |
|
266 | + 'class_name' => 'EE_Event', |
|
267 | + 'args' => array( |
|
268 | + 'public' => true, |
|
269 | + 'show_in_nav_menus' => true, |
|
270 | + 'capability_type' => 'event', |
|
271 | + 'capabilities' => array( |
|
272 | + 'edit_post' => 'ee_edit_event', |
|
273 | + 'read_post' => 'ee_read_event', |
|
274 | + 'delete_post' => 'ee_delete_event', |
|
275 | + 'edit_posts' => 'ee_edit_events', |
|
276 | + 'edit_others_posts' => 'ee_edit_others_events', |
|
277 | + 'publish_posts' => 'ee_publish_events', |
|
278 | + 'read_private_posts' => 'ee_read_private_events', |
|
279 | + 'delete_posts' => 'ee_delete_events', |
|
280 | + 'delete_private_posts' => 'ee_delete_private_events', |
|
281 | + 'delete_published_posts' => 'ee_delete_published_events', |
|
282 | + 'delete_others_posts' => 'ee_delete_others_events', |
|
283 | + 'edit_private_posts' => 'ee_edit_private_events', |
|
284 | + 'edit_published_posts' => 'ee_edit_published_events', |
|
285 | + ), |
|
286 | + 'taxonomies' => array( |
|
287 | + 'espresso_event_categories', |
|
288 | + 'espresso_event_type', |
|
289 | + 'post_tag', |
|
290 | + ), |
|
291 | + 'page_templates' => true, |
|
292 | + ), |
|
293 | + ), |
|
294 | + 'espresso_venues' => array( |
|
295 | + 'singular_name' => __("Venue", "event_espresso"), |
|
296 | + 'plural_name' => __("Venues", "event_espresso"), |
|
297 | + 'singular_slug' => __("venue", "event_espresso"), |
|
298 | + 'plural_slug' => __("venues", "event_espresso"), |
|
299 | + 'class_name' => 'EE_Venue', |
|
300 | + 'args' => array( |
|
301 | + 'public' => true, |
|
302 | + 'show_in_nav_menus' => false, //by default this doesn't show for decaf, |
|
303 | + 'capability_type' => 'venue', |
|
304 | + 'capabilities' => array( |
|
305 | + 'edit_post' => 'ee_edit_venue', |
|
306 | + 'read_post' => 'ee_read_venue', |
|
307 | + 'delete_post' => 'ee_delete_venue', |
|
308 | + 'edit_posts' => 'ee_edit_venues', |
|
309 | + 'edit_others_posts' => 'ee_edit_others_venues', |
|
310 | + 'publish_posts' => 'ee_publish_venues', |
|
311 | + 'read_private_posts' => 'ee_read_private_venues', |
|
312 | + 'delete_posts' => 'ee_delete_venues', |
|
313 | + 'delete_private_posts' => 'ee_delete_private_venues', |
|
314 | + 'delete_published_posts' => 'ee_delete_published_venues', |
|
315 | + 'delete_others_posts' => 'ee_edit_others_venues', |
|
316 | + 'edit_private_posts' => 'ee_edit_private_venues', |
|
317 | + 'edit_published_posts' => 'ee_edit_published_venues', |
|
318 | + ), |
|
319 | + 'taxonomies' => array( |
|
320 | + 'espresso_venue_categories', |
|
321 | + 'post_tag', |
|
322 | + ), |
|
323 | + 'page_templates' => true, |
|
324 | + ), |
|
325 | + ), |
|
326 | + 'espresso_attendees' => array( |
|
327 | + 'singular_name' => __("Contact", "event_espresso"), |
|
328 | + 'plural_name' => __("Contacts", "event_espresso"), |
|
329 | + 'singular_slug' => __("contact", "event_espresso"), |
|
330 | + 'plural_slug' => __("contacts", "event_espresso"), |
|
331 | + 'class_name' => 'EE_Attendee', |
|
332 | + 'args' => array( |
|
333 | + 'public' => false, |
|
334 | + 'publicly_queryable' => false, |
|
335 | + 'hierarchical' => false, |
|
336 | + 'has_archive' => false, |
|
337 | + 'taxonomies' => array('post_tag'), |
|
338 | + 'capability_type' => 'contact', |
|
339 | + 'capabilities' => array( |
|
340 | + 'edit_post' => 'ee_edit_contact', |
|
341 | + 'read_post' => 'ee_read_contact', |
|
342 | + 'delete_post' => 'ee_delete_contact', |
|
343 | + 'edit_posts' => 'ee_edit_contacts', |
|
344 | + 'edit_others_posts' => 'ee_edit_contacts', |
|
345 | + 'publish_posts' => 'ee_edit_contacts', |
|
346 | + 'read_private_posts' => 'ee_edit_contacts', |
|
347 | + 'delete_posts' => 'ee_delete_contacts', |
|
348 | + 'delete_private_posts' => 'ee_delete_contacts', |
|
349 | + 'delete_published_posts' => 'ee_delete_contacts', |
|
350 | + 'delete_others_posts' => 'ee_delete_contacts', |
|
351 | + 'edit_private_posts' => 'ee_edit_contacts', |
|
352 | + 'edit_published_posts' => 'ee_edit_contacts', |
|
353 | + ), |
|
354 | + 'supports' => array('editor', 'thumbnail', 'excerpt', 'custom-fields', 'comments'), |
|
355 | + ), |
|
356 | + ), |
|
357 | + )); |
|
358 | + } |
|
359 | + |
|
360 | + |
|
361 | + |
|
362 | + /** |
|
363 | + * This basically goes through the CPT array and returns only CPT's |
|
364 | + * that have the ['args']['public'] option set as false |
|
365 | + * |
|
366 | + * @return array |
|
367 | + */ |
|
368 | + public static function get_private_CPTs() |
|
369 | + { |
|
370 | + $CPTs = self::get_CPTs(); |
|
371 | + $private_CPTs = array(); |
|
372 | + foreach ($CPTs as $CPT => $details) { |
|
373 | + if (empty($details['args']['public'])) { |
|
374 | + $private_CPTs[$CPT] = $details; |
|
375 | + } |
|
376 | + } |
|
377 | + return $private_CPTs; |
|
378 | + } |
|
379 | + |
|
380 | + |
|
381 | + |
|
382 | + /** |
|
383 | + * Registers a custom taxonomy. Should be called before registering custom post types, |
|
384 | + * otherwise you should link the taxonomy to the custom post type using 'register_taxonomy_for_object_type'. |
|
385 | + * |
|
386 | + * @param string $taxonomy_name , eg 'books' |
|
387 | + * @param string $singular_name internationalized singular name |
|
388 | + * @param string $plural_name internationalized plural name |
|
389 | + * @param array $override_args like $args on http://codex.wordpress.org/Function_Reference/register_taxonomy |
|
390 | + */ |
|
391 | + public function register_taxonomy($taxonomy_name, $singular_name, $plural_name, $override_args = array()) |
|
392 | + { |
|
393 | + $args = array( |
|
394 | + 'hierarchical' => true, |
|
395 | + 'labels' => array( |
|
396 | + 'name' => $plural_name, |
|
397 | + 'singular_name' => $singular_name, |
|
398 | + ), |
|
399 | + 'show_ui' => true, |
|
400 | + 'show_ee_ui' => true, |
|
401 | + 'show_admin_column' => true, |
|
402 | + 'query_var' => true, |
|
403 | + 'show_in_nav_menus' => false, |
|
404 | + 'map_meta_cap' => true |
|
405 | + //'rewrite' => array( 'slug' => 'genre' ), |
|
406 | + ); |
|
407 | + if ($override_args) { |
|
408 | + if (isset($override_args['labels'])) { |
|
409 | + $labels = array_merge($args['labels'], $override_args['labels']); |
|
410 | + $args['labels'] = $labels; |
|
411 | + } |
|
412 | + $args = array_merge($args, $override_args); |
|
413 | + } |
|
414 | + register_taxonomy($taxonomy_name, null, $args); |
|
415 | + } |
|
416 | + |
|
417 | + |
|
418 | + |
|
419 | + /** |
|
420 | + * Registers a new custom post type. Sets default settings given only the following params. |
|
421 | + * |
|
422 | + * @param string $post_type the actual post type name |
|
423 | + * (VERY IMPORTANT: this much match what the slug is for admin pages related to this |
|
424 | + * cpt Also any models must use this slug as well) |
|
425 | + * @param string $singular_name a pre-internationalized string for the singular name of the objects |
|
426 | + * @param string $plural_name a pre-internalized string for the plural name of the objects |
|
427 | + * @param array $override_args exactly like $args as described in |
|
428 | + * http://codex.wordpress.org/Function_Reference/register_post_type The default values |
|
429 | + * set in this function will be overridden by whatever you set in $override_args |
|
430 | + * @param string $singular_slug |
|
431 | + * @param string $plural_slug |
|
432 | + * @return void , but registers the custom post type |
|
433 | + */ |
|
434 | + public function register_CPT( |
|
435 | + $post_type, |
|
436 | + $singular_name, |
|
437 | + $plural_name, |
|
438 | + $override_args = array(), |
|
439 | + $singular_slug = '', |
|
440 | + $plural_slug = '' |
|
441 | + ) { |
|
442 | + $labels = array( |
|
443 | + 'name' => $plural_name, |
|
444 | + 'singular_name' => $singular_name, |
|
445 | + 'singular_slug' => $singular_slug, |
|
446 | + 'plural_slug' => $plural_slug, |
|
447 | + 'add_new' => sprintf(__("Add %s", "event_espresso"), $singular_name), |
|
448 | + 'add_new_item' => sprintf(__("Add New %s", "event_espresso"), $singular_name), |
|
449 | + 'edit_item' => sprintf(__("Edit %s", "event_espresso"), $singular_name), |
|
450 | + 'new_item' => sprintf(__("New %s", "event_espresso"), $singular_name), |
|
451 | + 'all_items' => sprintf(__("All %s", "event_espresso"), $plural_name), |
|
452 | + 'view_item' => sprintf(__("View %s", "event_espresso"), $singular_name), |
|
453 | + 'search_items' => sprintf(__("Search %s", "event_espresso"), $plural_name), |
|
454 | + 'not_found' => sprintf(__("No %s found", "event_espresso"), $plural_name), |
|
455 | + 'not_found_in_trash' => sprintf(__("No %s found in Trash", "event_espresso"), $plural_name), |
|
456 | + 'parent_item_colon' => '', |
|
457 | + 'menu_name' => sprintf(__("%s", "event_espresso"), $plural_name), |
|
458 | + ); |
|
459 | + //verify plural slug and singular slug, if they aren't we'll use $singular_name and $plural_name |
|
460 | + // $singular_slug = ! empty($singular_slug) ? $singular_slug : $singular_name; |
|
461 | + $plural_slug = ! empty($plural_slug) ? $plural_slug : $plural_name; |
|
462 | + //note the page_templates arg in the supports index is something specific to EE. |
|
463 | + // WordPress doesn't actually have that in their register_post_type api. |
|
464 | + $args = array( |
|
465 | + 'labels' => $labels, |
|
466 | + 'public' => true, |
|
467 | + 'publicly_queryable' => true, |
|
468 | + 'show_ui' => false, |
|
469 | + 'show_ee_ui' => true, |
|
470 | + 'show_in_menu' => false, |
|
471 | + 'show_in_nav_menus' => false, |
|
472 | + 'query_var' => true, |
|
473 | + 'rewrite' => apply_filters( |
|
474 | + 'FHEE__EE_Register_CPTs__register_CPT__rewrite', |
|
475 | + array('slug' => $plural_slug), |
|
476 | + $post_type |
|
477 | + ), |
|
478 | + 'capability_type' => 'post', |
|
479 | + 'map_meta_cap' => true, |
|
480 | + 'has_archive' => true, |
|
481 | + 'hierarchical' => false, |
|
482 | + 'menu_position' => null, |
|
483 | + 'supports' => array( |
|
484 | + 'title', |
|
485 | + 'editor', |
|
486 | + 'author', |
|
487 | + 'thumbnail', |
|
488 | + 'excerpt', |
|
489 | + 'custom-fields', |
|
490 | + 'comments', |
|
491 | + ), |
|
492 | + ); |
|
493 | + if ($override_args) { |
|
494 | + if (isset($override_args['labels'])) { |
|
495 | + $labels = array_merge($args['labels'], $override_args['labels']); |
|
496 | + } |
|
497 | + $args = array_merge($args, $override_args); |
|
498 | + $args['labels'] = $labels; |
|
499 | + } |
|
500 | + register_post_type($post_type, $args); |
|
501 | + } |
|
502 | + |
|
503 | + |
|
504 | + |
|
505 | + public function set_must_use_event_types() |
|
506 | + { |
|
507 | + $term_details = array( |
|
508 | + //Attendee's register for the first date-time only |
|
509 | + 'single-event' => array( |
|
510 | + __('Single Event', 'event_espresso'), |
|
511 | + __('A single event that spans one or more consecutive days.', 'event_espresso'), |
|
512 | + ), |
|
513 | + //example: a party or two-day long workshop |
|
514 | + //Attendee's can register for any of the date-times |
|
515 | + 'multi-event' => array( |
|
516 | + __('Multi Event', 'event_espresso'), |
|
517 | + __('Multiple, separate, but related events that occur on consecutive days.', 'event_espresso'), |
|
518 | + ), |
|
519 | + //example: a three day music festival or week long conference |
|
520 | + //Attendee's register for the first date-time only |
|
521 | + 'event-series' => array( |
|
522 | + __('Event Series', 'event_espresso'), |
|
523 | + __(' Multiple events that occur over multiple non-consecutive days.', 'event_espresso'), |
|
524 | + ), |
|
525 | + //example: an 8 week introduction to basket weaving course |
|
526 | + //Attendee's can register for any of the date-times. |
|
527 | + 'recurring-event' => array( |
|
528 | + __('Recurring Event', 'event_espresso'), |
|
529 | + __('Multiple events that occur over multiple non-consecutive days.', 'event_espresso'), |
|
530 | + ), |
|
531 | + //example: a yoga class |
|
532 | + 'ongoing' => array( |
|
533 | + __('Ongoing Event', 'event_espresso'), |
|
534 | + __('An "event" that people can purchase tickets to gain access for anytime for this event regardless of date times on the event', |
|
535 | + 'event_espresso'), |
|
536 | + ) |
|
537 | + //example: access to a museum |
|
538 | + //'walk-in' => array( __('Walk In', 'event_espresso'), __('Single datetime and single entry recurring events. Attendees register for one or multiple datetimes individually.', 'event_espresso') ), |
|
539 | + //'reservation' => array( __('Reservation', 'event_espresso'), __('Reservations are created by specifying available datetimes and quantities. Attendees choose from the available datetimes and specify the quantity available (if the maximum is greater than 1)') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1 |
|
540 | + // 'multiple-session' => array( __('Multiple Session', 'event_espresso'), __('Multiple event, multiple datetime, hierarchically organized, custom entry events. Attendees may be required to register for a parent event before being allowed to register for child events. Attendees can register for any combination of child events as long as the datetimes do not conflict. Parent and child events may have additional fees or registration questions.') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1 |
|
541 | + //'appointment' => array( __('Appointments', 'event_espresso'), __('Time slotted events where datetimes are generally in hours or minutes. For example, attendees can register for a single 15 minute or 1 hour time slot and this type of availability frequently reoccurs.', 'event_espresso') ) |
|
542 | + ); |
|
543 | + $this->set_must_use_terms('espresso_event_type', $term_details); |
|
544 | + } |
|
545 | + |
|
546 | + |
|
547 | + |
|
548 | + /** |
|
549 | + * wrapper method for handling the setting up of initial terms in the db (if they don't already exist). |
|
550 | + * Note this should ONLY be used for terms that always must be present. Be aware that if an initial term is |
|
551 | + * deleted then it WILL be recreated. |
|
552 | + * |
|
553 | + * @param string $taxonomy The name of the taxonomy |
|
554 | + * @param array $term_details An array of term details indexed by slug and containing Name of term, and |
|
555 | + * description as the elements in the array |
|
556 | + * @return void |
|
557 | + */ |
|
558 | + public function set_must_use_terms($taxonomy, $term_details) |
|
559 | + { |
|
560 | + $term_details = (array)$term_details; |
|
561 | + foreach ($term_details as $slug => $details) { |
|
562 | + if ( ! term_exists($slug, $taxonomy)) { |
|
563 | + $insert_arr = array( |
|
564 | + 'slug' => $slug, |
|
565 | + 'description' => $details[1], |
|
566 | + ); |
|
567 | + wp_insert_term($details[0], $taxonomy, $insert_arr); |
|
568 | + } |
|
569 | + } |
|
570 | + } |
|
571 | + |
|
572 | + |
|
573 | + |
|
574 | + /** |
|
575 | + * Allows us to set what the default will be for terms when a cpt is PUBLISHED. |
|
576 | + * |
|
577 | + * @param string $taxonomy The taxonomy we're using for the default term |
|
578 | + * @param string $term_slug The slug of the term that will be the default. |
|
579 | + * @param array $cpt_slugs An array of custom post types we want the default assigned to |
|
580 | + */ |
|
581 | + public function set_default_term($taxonomy, $term_slug, $cpt_slugs = array()) |
|
582 | + { |
|
583 | + $this->_default_terms[][$term_slug] = new EE_Default_Term($taxonomy, $term_slug, $cpt_slugs); |
|
584 | + } |
|
585 | + |
|
586 | + |
|
587 | + |
|
588 | + /** |
|
589 | + * hooked into the wp 'save_post' action hook for setting our default terms found in the $_default_terms property |
|
590 | + * |
|
591 | + * @param int $post_id ID of CPT being saved |
|
592 | + * @param object $post Post object |
|
593 | + * @return void |
|
594 | + */ |
|
595 | + public function save_default_term($post_id, $post) |
|
596 | + { |
|
597 | + if (empty($this->_default_terms)) { |
|
598 | + return; |
|
599 | + } //no default terms set so lets just exit. |
|
600 | + foreach ($this->_default_terms as $defaults) { |
|
601 | + foreach ($defaults as $default_obj) { |
|
602 | + if ($post->post_status === 'publish' && in_array($post->post_type, $default_obj->cpt_slugs, true)) { |
|
603 | + //note some error proofing going on here to save unnecessary db queries |
|
604 | + $taxonomies = get_object_taxonomies($post->post_type); |
|
605 | + foreach ((array)$taxonomies as $taxonomy) { |
|
606 | + $terms = wp_get_post_terms($post_id, $taxonomy); |
|
607 | + if (empty($terms) && $taxonomy === $default_obj->taxonomy) { |
|
608 | + wp_set_object_terms($post_id, array($default_obj->term_slug), $taxonomy); |
|
609 | + } |
|
610 | + } |
|
611 | + } |
|
612 | + } |
|
613 | + } |
|
614 | + } |
|
615 | 615 | |
616 | 616 | } |
617 | 617 | |
@@ -625,27 +625,27 @@ discard block |
||
625 | 625 | { |
626 | 626 | |
627 | 627 | |
628 | - //props holding the items |
|
629 | - public $taxonomy = ''; |
|
628 | + //props holding the items |
|
629 | + public $taxonomy = ''; |
|
630 | 630 | |
631 | - public $cpt_slugs = array(); |
|
631 | + public $cpt_slugs = array(); |
|
632 | 632 | |
633 | - public $term_slug = ''; |
|
633 | + public $term_slug = ''; |
|
634 | 634 | |
635 | 635 | |
636 | 636 | |
637 | - /** |
|
638 | - * constructor |
|
639 | - * |
|
640 | - * @param string $taxonomy The taxonomy the default term belongs to |
|
641 | - * @param string $term_slug The slug of the term that will be the default. |
|
642 | - * @param array $cpt_slugs The custom post type the default term gets saved with |
|
643 | - */ |
|
644 | - public function __construct($taxonomy, $term_slug, $cpt_slugs = array()) |
|
645 | - { |
|
646 | - $this->taxonomy = $taxonomy; |
|
647 | - $this->cpt_slugs = (array)$cpt_slugs; |
|
648 | - $this->term_slug = $term_slug; |
|
649 | - } |
|
637 | + /** |
|
638 | + * constructor |
|
639 | + * |
|
640 | + * @param string $taxonomy The taxonomy the default term belongs to |
|
641 | + * @param string $term_slug The slug of the term that will be the default. |
|
642 | + * @param array $cpt_slugs The custom post type the default term gets saved with |
|
643 | + */ |
|
644 | + public function __construct($taxonomy, $term_slug, $cpt_slugs = array()) |
|
645 | + { |
|
646 | + $this->taxonomy = $taxonomy; |
|
647 | + $this->cpt_slugs = (array)$cpt_slugs; |
|
648 | + $this->term_slug = $term_slug; |
|
649 | + } |
|
650 | 650 | |
651 | 651 | } |
@@ -32,7 +32,7 @@ discard block |
||
32 | 32 | /** |
33 | 33 | * cancelTicketSelections |
34 | 34 | * |
35 | - * @return string |
|
35 | + * @return false|null |
|
36 | 36 | */ |
37 | 37 | public function cancelTicketSelections() |
38 | 38 | { |
@@ -99,7 +99,7 @@ discard block |
||
99 | 99 | /** |
100 | 100 | * process_ticket_selections |
101 | 101 | * |
102 | - * @return array|bool |
|
102 | + * @return boolean|null |
|
103 | 103 | * @throws \EE_Error |
104 | 104 | */ |
105 | 105 | public function processTicketSelections() |
@@ -273,7 +273,7 @@ discard block |
||
273 | 273 | * validate_post_data |
274 | 274 | * |
275 | 275 | * @param int $id |
276 | - * @return array|FALSE |
|
276 | + * @return string |
|
277 | 277 | */ |
278 | 278 | private function validatePostData($id = 0) |
279 | 279 | { |
@@ -390,7 +390,7 @@ discard block |
||
390 | 390 | * |
391 | 391 | * @param \EE_Ticket $ticket |
392 | 392 | * @param int $qty |
393 | - * @return TRUE on success, FALSE on fail |
|
393 | + * @return boolean on success, FALSE on fail |
|
394 | 394 | * @throws \EE_Error |
395 | 395 | */ |
396 | 396 | private function addTicketToCart(\EE_Ticket $ticket = null, $qty = 1) |
@@ -49,7 +49,7 @@ discard block |
||
49 | 49 | ); |
50 | 50 | } else { |
51 | 51 | wp_safe_redirect( |
52 | - site_url('/' . \EE_Registry::instance()->CFG->core->event_cpt_slug . '/') |
|
52 | + site_url('/'.\EE_Registry::instance()->CFG->core->event_cpt_slug.'/') |
|
53 | 53 | ); |
54 | 54 | } |
55 | 55 | exit(); |
@@ -165,7 +165,7 @@ discard block |
||
165 | 165 | 'event_espresso' |
166 | 166 | ); |
167 | 167 | $limit_error_2 = sprintf($max_atndz_string, $valid['max_atndz'], $valid['max_atndz']); |
168 | - \EE_Error::add_error($limit_error_1 . '<br/>' . $limit_error_2, __FILE__, __FUNCTION__, __LINE__); |
|
168 | + \EE_Error::add_error($limit_error_1.'<br/>'.$limit_error_2, __FILE__, __FUNCTION__, __LINE__); |
|
169 | 169 | } else { |
170 | 170 | // all data appears to be valid |
171 | 171 | $tckts_slctd = false; |
@@ -305,9 +305,9 @@ discard block |
||
305 | 305 | // cycle through $inputs_to_clean array |
306 | 306 | foreach ($inputs_to_clean as $what => $input_to_clean) { |
307 | 307 | // check for POST data |
308 | - if (\EE_Registry::instance()->REQ->is_set($input_to_clean . $id)) { |
|
308 | + if (\EE_Registry::instance()->REQ->is_set($input_to_clean.$id)) { |
|
309 | 309 | // grab value |
310 | - $input_value = \EE_Registry::instance()->REQ->get($input_to_clean . $id); |
|
310 | + $input_value = \EE_Registry::instance()->REQ->get($input_to_clean.$id); |
|
311 | 311 | switch ($what) { |
312 | 312 | // integers |
313 | 313 | case 'event_id': |
@@ -328,8 +328,8 @@ discard block |
||
328 | 328 | // if qty is coming from a radio button input, then we need to assemble an array of rows |
329 | 329 | if ( ! is_array($row_qty)) { |
330 | 330 | // get number of rows |
331 | - $rows = \EE_Registry::instance()->REQ->is_set('tkt-slctr-rows-' . $id) |
|
332 | - ? absint(\EE_Registry::instance()->REQ->get('tkt-slctr-rows-' . $id)) |
|
331 | + $rows = \EE_Registry::instance()->REQ->is_set('tkt-slctr-rows-'.$id) |
|
332 | + ? absint(\EE_Registry::instance()->REQ->get('tkt-slctr-rows-'.$id)) |
|
333 | 333 | : 1; |
334 | 334 | // explode ints by the dash |
335 | 335 | $row_qty = explode('-', $row_qty); |
@@ -355,7 +355,7 @@ discard block |
||
355 | 355 | case 'ticket_id': |
356 | 356 | $value_array = array(); |
357 | 357 | // cycle thru values |
358 | - foreach ((array)$input_value as $key => $value) { |
|
358 | + foreach ((array) $input_value as $key => $value) { |
|
359 | 359 | // allow only numbers, letters, spaces, commas and dashes |
360 | 360 | $value_array[$key] = wp_strip_all_tags($value); |
361 | 361 | // get ticket via the ticket id we put in the form |
@@ -373,7 +373,7 @@ discard block |
||
373 | 373 | $input_value = explode('#', $input_value); |
374 | 374 | $input_value = end($input_value); |
375 | 375 | // use event list url instead, but append anchor |
376 | - $input_value = \EEH_Event_View::event_archive_url() . '#' . $input_value; |
|
376 | + $input_value = \EEH_Event_View::event_archive_url().'#'.$input_value; |
|
377 | 377 | } |
378 | 378 | $valid_data[$what] = $input_value; |
379 | 379 | break; |
@@ -2,7 +2,7 @@ discard block |
||
2 | 2 | namespace EventEspresso\modules\ticket_selector; |
3 | 3 | |
4 | 4 | if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
5 | - exit('No direct script access allowed'); |
|
5 | + exit('No direct script access allowed'); |
|
6 | 6 | } |
7 | 7 | |
8 | 8 | |
@@ -19,570 +19,570 @@ discard block |
||
19 | 19 | class ProcessTicketSelector |
20 | 20 | { |
21 | 21 | |
22 | - /** |
|
23 | - * array of datetimes and the spaces available for them |
|
24 | - * |
|
25 | - * @access private |
|
26 | - * @var array |
|
27 | - */ |
|
28 | - private static $_available_spaces = array(); |
|
29 | - |
|
30 | - |
|
31 | - |
|
32 | - /** |
|
33 | - * cancelTicketSelections |
|
34 | - * |
|
35 | - * @return string |
|
36 | - */ |
|
37 | - public function cancelTicketSelections() |
|
38 | - { |
|
39 | - // check nonce |
|
40 | - if ( ! $this->processTicketSelectorNonce('cancel_ticket_selections')) { |
|
41 | - return false; |
|
42 | - } |
|
43 | - \EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
44 | - if (\EE_Registry::instance()->REQ->is_set('event_id')) { |
|
45 | - wp_safe_redirect( |
|
46 | - \EEH_Event_View::event_link_url( |
|
47 | - \EE_Registry::instance()->REQ->get('event_id') |
|
48 | - ) |
|
49 | - ); |
|
50 | - } else { |
|
51 | - wp_safe_redirect( |
|
52 | - site_url('/' . \EE_Registry::instance()->CFG->core->event_cpt_slug . '/') |
|
53 | - ); |
|
54 | - } |
|
55 | - exit(); |
|
56 | - } |
|
57 | - |
|
58 | - |
|
59 | - |
|
60 | - /** |
|
61 | - * processTicketSelectorNonce |
|
62 | - * |
|
63 | - * @param string $nonce_name |
|
64 | - * @param string $id |
|
65 | - * @return bool |
|
66 | - */ |
|
67 | - private function processTicketSelectorNonce($nonce_name, $id = '') |
|
68 | - { |
|
69 | - $nonce_name_with_id = ! empty($id) ? "{$nonce_name}_nonce_{$id}" : "{$nonce_name}_nonce"; |
|
70 | - if ( |
|
71 | - ! is_admin() |
|
72 | - && ( |
|
73 | - ! \EE_Registry::instance()->REQ->is_set($nonce_name_with_id) |
|
74 | - || ! wp_verify_nonce( |
|
75 | - \EE_Registry::instance()->REQ->get($nonce_name_with_id), |
|
76 | - $nonce_name |
|
77 | - ) |
|
78 | - ) |
|
79 | - ) { |
|
80 | - \EE_Error::add_error( |
|
81 | - sprintf( |
|
82 | - __( |
|
83 | - 'We\'re sorry but your request failed to pass a security check.%sPlease click the back button on your browser and try again.', |
|
84 | - 'event_espresso' |
|
85 | - ), |
|
86 | - '<br/>' |
|
87 | - ), |
|
88 | - __FILE__, |
|
89 | - __FUNCTION__, |
|
90 | - __LINE__ |
|
91 | - ); |
|
92 | - return false; |
|
93 | - } |
|
94 | - return true; |
|
95 | - } |
|
96 | - |
|
97 | - |
|
98 | - |
|
99 | - /** |
|
100 | - * process_ticket_selections |
|
101 | - * |
|
102 | - * @return array|bool |
|
103 | - * @throws \EE_Error |
|
104 | - */ |
|
105 | - public function processTicketSelections() |
|
106 | - { |
|
107 | - do_action('EED_Ticket_Selector__process_ticket_selections__before'); |
|
108 | - // do we have an event id? |
|
109 | - if ( ! \EE_Registry::instance()->REQ->is_set('tkt-slctr-event-id')) { |
|
110 | - // $_POST['tkt-slctr-event-id'] was not set ?!?!?!? |
|
111 | - \EE_Error::add_error( |
|
112 | - sprintf( |
|
113 | - __( |
|
114 | - 'An event id was not provided or was not received.%sPlease click the back button on your browser and try again.', |
|
115 | - 'event_espresso' |
|
116 | - ), |
|
117 | - '<br/>' |
|
118 | - ), |
|
119 | - __FILE__, |
|
120 | - __FUNCTION__, |
|
121 | - __LINE__ |
|
122 | - ); |
|
123 | - } |
|
124 | - //if event id is valid |
|
125 | - $id = absint(\EE_Registry::instance()->REQ->get('tkt-slctr-event-id')); |
|
126 | - // d( \EE_Registry::instance()->REQ ); |
|
127 | - self::$_available_spaces = array( |
|
128 | - 'tickets' => array(), |
|
129 | - 'datetimes' => array(), |
|
130 | - ); |
|
131 | - //we should really only have 1 registration in the works now (ie, no MER) so clear any previous items in the cart. |
|
132 | - // When MER happens this will probably need to be tweaked, possibly wrapped in a conditional checking for some constant defined in MER etc. |
|
133 | - \EE_Registry::instance()->load_core('Session'); |
|
134 | - // unless otherwise requested, clear the session |
|
135 | - if (apply_filters('FHEE__EE_Ticket_Selector__process_ticket_selections__clear_session', true)) { |
|
136 | - \EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
137 | - } |
|
138 | - //d( \EE_Registry::instance()->SSN ); |
|
139 | - do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
140 | - // validate/sanitize data |
|
141 | - $valid = $this->validatePostData($id); |
|
142 | - //EEH_Debug_Tools::printr( $_REQUEST, '$_REQUEST', __FILE__, __LINE__ ); |
|
143 | - //EEH_Debug_Tools::printr( $valid, '$valid', __FILE__, __LINE__ ); |
|
144 | - //EEH_Debug_Tools::printr( $valid[ 'total_tickets' ], 'total_tickets', __FILE__, __LINE__ ); |
|
145 | - //EEH_Debug_Tools::printr( $valid[ 'max_atndz' ], 'max_atndz', __FILE__, __LINE__ ); |
|
146 | - //check total tickets ordered vs max number of attendees that can register |
|
147 | - if ($valid['total_tickets'] > $valid['max_atndz']) { |
|
148 | - // ordering too many tickets !!! |
|
149 | - $total_tickets_string = _n( |
|
150 | - 'You have attempted to purchase %s ticket.', |
|
151 | - 'You have attempted to purchase %s tickets.', |
|
152 | - $valid['total_tickets'], |
|
153 | - 'event_espresso' |
|
154 | - ); |
|
155 | - $limit_error_1 = sprintf($total_tickets_string, $valid['total_tickets']); |
|
156 | - // dev only message |
|
157 | - $max_atndz_string = _n( |
|
158 | - 'The registration limit for this event is %s ticket per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.', |
|
159 | - 'The registration limit for this event is %s tickets per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.', |
|
160 | - $valid['max_atndz'], |
|
161 | - 'event_espresso' |
|
162 | - ); |
|
163 | - $limit_error_2 = sprintf($max_atndz_string, $valid['max_atndz'], $valid['max_atndz']); |
|
164 | - \EE_Error::add_error($limit_error_1 . '<br/>' . $limit_error_2, __FILE__, __FUNCTION__, __LINE__); |
|
165 | - } else { |
|
166 | - // all data appears to be valid |
|
167 | - $tckts_slctd = false; |
|
168 | - $tickets_added = 0; |
|
169 | - $valid = apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data', $valid); |
|
170 | - if ($valid['total_tickets'] > 0) { |
|
171 | - // load cart |
|
172 | - \EE_Registry::instance()->load_core('Cart'); |
|
173 | - // cycle thru the number of data rows sent from the event listing |
|
174 | - for ($x = 0; $x < $valid['rows']; $x++) { |
|
175 | - // does this row actually contain a ticket quantity? |
|
176 | - if (isset($valid['qty'][$x]) && $valid['qty'][$x] > 0) { |
|
177 | - // YES we have a ticket quantity |
|
178 | - $tckts_slctd = true; |
|
179 | - // d( $valid['ticket_obj'][$x] ); |
|
180 | - if ($valid['ticket_obj'][$x] instanceof \EE_Ticket) { |
|
181 | - // then add ticket to cart |
|
182 | - $tickets_added += $this->addTicketToCart( |
|
183 | - $valid['ticket_obj'][$x], |
|
184 | - $valid['qty'][$x] |
|
185 | - ); |
|
186 | - if (\EE_Error::has_error()) { |
|
187 | - break; |
|
188 | - } |
|
189 | - } else { |
|
190 | - // nothing added to cart retrieved |
|
191 | - \EE_Error::add_error( |
|
192 | - sprintf( |
|
193 | - __( |
|
194 | - 'A valid ticket could not be retrieved for the event.%sPlease click the back button on your browser and try again.', |
|
195 | - 'event_espresso' |
|
196 | - ), |
|
197 | - '<br/>' |
|
198 | - ), |
|
199 | - __FILE__, __FUNCTION__, __LINE__ |
|
200 | - ); |
|
201 | - } |
|
202 | - } |
|
203 | - } |
|
204 | - } |
|
205 | - do_action( |
|
206 | - 'AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart', |
|
207 | - \EE_Registry::instance()->CART, |
|
208 | - $this |
|
209 | - ); |
|
210 | - //d( \EE_Registry::instance()->CART ); |
|
211 | - //die(); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< KILL REDIRECT HERE BEFORE CART UPDATE |
|
212 | - if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', $tckts_slctd)) { |
|
213 | - if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__success', $tickets_added)) { |
|
214 | - do_action( |
|
215 | - 'FHEE__EE_Ticket_Selector__process_ticket_selections__before_redirecting_to_checkout', |
|
216 | - \EE_Registry::instance()->CART, |
|
217 | - $this |
|
218 | - ); |
|
219 | - \EE_Registry::instance()->CART->recalculate_all_cart_totals(); |
|
220 | - \EE_Registry::instance()->CART->save_cart(false); |
|
221 | - // exit('KILL REDIRECT AFTER CART UPDATE'); // <<<<<<<< OR HERE TO KILL REDIRECT AFTER CART UPDATE |
|
222 | - // just return TRUE for registrations being made from admin |
|
223 | - if (is_admin()) { |
|
224 | - return true; |
|
225 | - } |
|
226 | - \EE_Error::get_notices(false, true); |
|
227 | - wp_safe_redirect( |
|
228 | - apply_filters( |
|
229 | - 'FHEE__EE_Ticket_Selector__process_ticket_selections__success_redirect_url', |
|
230 | - \EE_Registry::instance()->CFG->core->reg_page_url() |
|
231 | - ) |
|
232 | - ); |
|
233 | - exit(); |
|
234 | - } else { |
|
235 | - if ( ! \EE_Error::has_error() && ! \EE_Error::has_error(true, 'attention')) { |
|
236 | - // nothing added to cart |
|
237 | - \EE_Error::add_attention(__('No tickets were added for the event', 'event_espresso'), |
|
238 | - __FILE__, __FUNCTION__, __LINE__); |
|
239 | - } |
|
240 | - } |
|
241 | - } else { |
|
242 | - // no ticket quantities were selected |
|
243 | - \EE_Error::add_error(__('You need to select a ticket quantity before you can proceed.', |
|
244 | - 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
245 | - } |
|
246 | - } |
|
247 | - //die(); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< KILL BEFORE REDIRECT |
|
248 | - // at this point, just return if registration is being made from admin |
|
249 | - if (is_admin()) { |
|
250 | - return false; |
|
251 | - } |
|
252 | - if ($valid['return_url']) { |
|
253 | - \EE_Error::get_notices(false, true); |
|
254 | - wp_safe_redirect($valid['return_url']); |
|
255 | - exit(); |
|
256 | - } elseif (isset($event_to_add['id'])) { |
|
257 | - \EE_Error::get_notices(false, true); |
|
258 | - wp_safe_redirect(get_permalink($event_to_add['id'])); |
|
259 | - exit(); |
|
260 | - } else { |
|
261 | - echo \EE_Error::get_notices(); |
|
262 | - } |
|
263 | - return false; |
|
264 | - } |
|
265 | - |
|
266 | - |
|
267 | - |
|
268 | - /** |
|
269 | - * validate_post_data |
|
270 | - * |
|
271 | - * @param int $id |
|
272 | - * @return array|FALSE |
|
273 | - */ |
|
274 | - private function validatePostData($id = 0) |
|
275 | - { |
|
276 | - do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
277 | - if ( ! $id) { |
|
278 | - \EE_Error::add_error( |
|
279 | - __('The event id provided was not valid.', 'event_espresso'), |
|
280 | - __FILE__, |
|
281 | - __FUNCTION__, |
|
282 | - __LINE__ |
|
283 | - ); |
|
284 | - return false; |
|
285 | - } |
|
286 | - // start with an empty array() |
|
287 | - $valid_data = array(); |
|
288 | - // grab valid id |
|
289 | - $valid_data['id'] = $id; |
|
290 | - // array of other form names |
|
291 | - $inputs_to_clean = array( |
|
292 | - 'event_id' => 'tkt-slctr-event-id', |
|
293 | - 'max_atndz' => 'tkt-slctr-max-atndz-', |
|
294 | - 'rows' => 'tkt-slctr-rows-', |
|
295 | - 'qty' => 'tkt-slctr-qty-', |
|
296 | - 'ticket_id' => 'tkt-slctr-ticket-id-', |
|
297 | - 'return_url' => 'tkt-slctr-return-url-', |
|
298 | - ); |
|
299 | - // let's track the total number of tickets ordered.' |
|
300 | - $valid_data['total_tickets'] = 0; |
|
301 | - // cycle through $inputs_to_clean array |
|
302 | - foreach ($inputs_to_clean as $what => $input_to_clean) { |
|
303 | - // check for POST data |
|
304 | - if (\EE_Registry::instance()->REQ->is_set($input_to_clean . $id)) { |
|
305 | - // grab value |
|
306 | - $input_value = \EE_Registry::instance()->REQ->get($input_to_clean . $id); |
|
307 | - switch ($what) { |
|
308 | - // integers |
|
309 | - case 'event_id': |
|
310 | - $valid_data[$what] = absint($input_value); |
|
311 | - // get event via the event id we put in the form |
|
312 | - $valid_data['event'] = \EE_Registry::instance() |
|
313 | - ->load_model('Event') |
|
314 | - ->get_one_by_ID($valid_data['event_id']); |
|
315 | - break; |
|
316 | - case 'rows': |
|
317 | - case 'max_atndz': |
|
318 | - $valid_data[$what] = absint($input_value); |
|
319 | - break; |
|
320 | - // arrays of integers |
|
321 | - case 'qty': |
|
322 | - /** @var array $row_qty */ |
|
323 | - $row_qty = $input_value; |
|
324 | - // if qty is coming from a radio button input, then we need to assemble an array of rows |
|
325 | - if ( ! is_array($row_qty)) { |
|
326 | - // get number of rows |
|
327 | - $rows = \EE_Registry::instance()->REQ->is_set('tkt-slctr-rows-' . $id) |
|
328 | - ? absint(\EE_Registry::instance()->REQ->get('tkt-slctr-rows-' . $id)) |
|
329 | - : 1; |
|
330 | - // explode ints by the dash |
|
331 | - $row_qty = explode('-', $row_qty); |
|
332 | - $row = isset($row_qty[0]) ? absint($row_qty[0]) : 1; |
|
333 | - $qty = isset($row_qty[1]) ? absint($row_qty[1]) : 0; |
|
334 | - $row_qty = array($row => $qty); |
|
335 | - for ($x = 1; $x <= $rows; $x++) { |
|
336 | - if ( ! isset($row_qty[$x])) { |
|
337 | - $row_qty[$x] = 0; |
|
338 | - } |
|
339 | - } |
|
340 | - } |
|
341 | - ksort($row_qty); |
|
342 | - // cycle thru values |
|
343 | - foreach ($row_qty as $qty) { |
|
344 | - $qty = absint($qty); |
|
345 | - // sanitize as integers |
|
346 | - $valid_data[$what][] = $qty; |
|
347 | - $valid_data['total_tickets'] += $qty; |
|
348 | - } |
|
349 | - break; |
|
350 | - // array of integers |
|
351 | - case 'ticket_id': |
|
352 | - $value_array = array(); |
|
353 | - // cycle thru values |
|
354 | - foreach ((array)$input_value as $key => $value) { |
|
355 | - // allow only numbers, letters, spaces, commas and dashes |
|
356 | - $value_array[$key] = wp_strip_all_tags($value); |
|
357 | - // get ticket via the ticket id we put in the form |
|
358 | - $ticket_obj = \EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($value); |
|
359 | - $valid_data['ticket_obj'][$key] = $ticket_obj; |
|
360 | - } |
|
361 | - $valid_data[$what] = $value_array; |
|
362 | - break; |
|
363 | - case 'return_url' : |
|
364 | - // grab and sanitize return-url |
|
365 | - $input_value = esc_url_raw($input_value); |
|
366 | - // was the request coming from an iframe ? if so, then: |
|
367 | - if (strpos($input_value, 'event_list=iframe')) { |
|
368 | - // get anchor fragment |
|
369 | - $input_value = explode('#', $input_value); |
|
370 | - $input_value = end($input_value); |
|
371 | - // use event list url instead, but append anchor |
|
372 | - $input_value = \EEH_Event_View::event_archive_url() . '#' . $input_value; |
|
373 | - } |
|
374 | - $valid_data[$what] = $input_value; |
|
375 | - break; |
|
376 | - } // end switch $what |
|
377 | - } |
|
378 | - } // end foreach $inputs_to_clean |
|
379 | - return $valid_data; |
|
380 | - } |
|
381 | - |
|
382 | - |
|
383 | - |
|
384 | - /** |
|
385 | - * adds a ticket to the cart |
|
386 | - * |
|
387 | - * @param \EE_Ticket $ticket |
|
388 | - * @param int $qty |
|
389 | - * @return TRUE on success, FALSE on fail |
|
390 | - * @throws \EE_Error |
|
391 | - */ |
|
392 | - private function addTicketToCart(\EE_Ticket $ticket = null, $qty = 1) |
|
393 | - { |
|
394 | - do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
395 | - // get the number of spaces left for this datetime ticket |
|
396 | - $available_spaces = $this->ticketDatetimeAvailability($ticket); |
|
397 | - // compare available spaces against the number of tickets being purchased |
|
398 | - if ($available_spaces >= $qty) { |
|
399 | - // allow addons to prevent a ticket from being added to cart |
|
400 | - if ( |
|
401 | - ! apply_filters( |
|
402 | - 'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_add_to_cart', |
|
403 | - true, |
|
404 | - $ticket, |
|
405 | - $qty, |
|
406 | - $available_spaces |
|
407 | - ) |
|
408 | - ) { |
|
409 | - return false; |
|
410 | - } |
|
411 | - $qty = absint(apply_filters('FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty', $qty, $ticket)); |
|
412 | - // add event to cart |
|
413 | - if (\EE_Registry::instance()->CART->add_ticket_to_cart($ticket, $qty)) { |
|
414 | - $this->recalculateTicketDatetimeAvailability($ticket, $qty); |
|
415 | - return true; |
|
416 | - } |
|
417 | - return false; |
|
418 | - } |
|
419 | - // tickets can not be purchased but let's find the exact number left |
|
420 | - // for the last ticket selected PRIOR to subtracting tickets |
|
421 | - $available_spaces = $this->ticketDatetimeAvailability($ticket, true); |
|
422 | - // greedy greedy greedy eh? |
|
423 | - if ($available_spaces > 0) { |
|
424 | - if ( |
|
425 | - apply_filters( |
|
426 | - 'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_display_availability_error', |
|
427 | - true, |
|
428 | - $ticket, |
|
429 | - $qty, |
|
430 | - $available_spaces |
|
431 | - ) |
|
432 | - ) { |
|
433 | - $this->displayAvailabilityError($available_spaces); |
|
434 | - } |
|
435 | - } else { |
|
436 | - \EE_Error::add_error( |
|
437 | - __( |
|
438 | - 'We\'re sorry, but there are no available spaces left for this event at this particular date and time.', |
|
439 | - 'event_espresso' |
|
440 | - ), |
|
441 | - __FILE__, __FUNCTION__, __LINE__ |
|
442 | - ); |
|
443 | - } |
|
444 | - return false; |
|
445 | - } |
|
446 | - |
|
447 | - |
|
448 | - |
|
449 | - /** |
|
450 | - * @param int $available_spaces |
|
451 | - * @throws \EE_Error |
|
452 | - */ |
|
453 | - private function displayAvailabilityError($available_spaces = 1) |
|
454 | - { |
|
455 | - // add error messaging - we're using the _n function that will generate |
|
456 | - // the appropriate singular or plural message based on the number of $available_spaces |
|
457 | - if (\EE_Registry::instance()->CART->all_ticket_quantity_count()) { |
|
458 | - $msg = sprintf( |
|
459 | - _n( |
|
460 | - 'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.', |
|
461 | - 'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.', |
|
462 | - $available_spaces, |
|
463 | - 'event_espresso' |
|
464 | - ), |
|
465 | - $available_spaces, |
|
466 | - '<br />' |
|
467 | - ); |
|
468 | - } else { |
|
469 | - $msg = sprintf( |
|
470 | - _n( |
|
471 | - 'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets.', |
|
472 | - 'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets.', |
|
473 | - $available_spaces, |
|
474 | - 'event_espresso' |
|
475 | - ), |
|
476 | - $available_spaces, |
|
477 | - '<br />' |
|
478 | - ); |
|
479 | - } |
|
480 | - \EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
481 | - } |
|
482 | - |
|
483 | - |
|
484 | - |
|
485 | - /** |
|
486 | - * ticketDatetimeAvailability |
|
487 | - * creates an array of tickets plus all of the datetimes available to each ticket |
|
488 | - * and tracks the spaces remaining for each of those datetimes |
|
489 | - * |
|
490 | - * @param \EE_Ticket $ticket - selected ticket |
|
491 | - * @param bool $get_original_ticket_spaces |
|
492 | - * @return int |
|
493 | - * @throws \EE_Error |
|
494 | - */ |
|
495 | - private function ticketDatetimeAvailability(\EE_Ticket $ticket, $get_original_ticket_spaces = false) |
|
496 | - { |
|
497 | - // if the $_available_spaces array has not been set up yet... |
|
498 | - if ( ! isset(self::$_available_spaces['tickets'][$ticket->ID()])) { |
|
499 | - $this->setInitialTicketDatetimeAvailability($ticket); |
|
500 | - } |
|
501 | - $available_spaces = $ticket->qty() - $ticket->sold(); |
|
502 | - if (isset(self::$_available_spaces['tickets'][$ticket->ID()])) { |
|
503 | - // loop thru tickets, which will ALSO include individual ticket records AND a total |
|
504 | - foreach (self::$_available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) { |
|
505 | - // if we want the original datetime availability BEFORE we started subtracting tickets ? |
|
506 | - if ($get_original_ticket_spaces) { |
|
507 | - // then grab the available spaces from the "tickets" array |
|
508 | - // and compare with the above to get the lowest number |
|
509 | - $available_spaces = min( |
|
510 | - $available_spaces, |
|
511 | - self::$_available_spaces['tickets'][$ticket->ID()][$DTD_ID] |
|
512 | - ); |
|
513 | - } else { |
|
514 | - // we want the updated ticket availability as stored in the "datetimes" array |
|
515 | - $available_spaces = min($available_spaces, self::$_available_spaces['datetimes'][$DTD_ID]); |
|
516 | - } |
|
517 | - } |
|
518 | - } |
|
519 | - return $available_spaces; |
|
520 | - } |
|
521 | - |
|
522 | - |
|
523 | - |
|
524 | - /** |
|
525 | - * @param \EE_Ticket $ticket |
|
526 | - * @return void |
|
527 | - * @throws \EE_Error |
|
528 | - */ |
|
529 | - private function setInitialTicketDatetimeAvailability(\EE_Ticket $ticket) |
|
530 | - { |
|
531 | - // first, get all of the datetimes that are available to this ticket |
|
532 | - $datetimes = $ticket->get_many_related( |
|
533 | - 'Datetime', |
|
534 | - array( |
|
535 | - array( |
|
536 | - 'DTT_EVT_end' => array( |
|
537 | - '>=', |
|
538 | - \EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
539 | - ), |
|
540 | - ), |
|
541 | - 'order_by' => array('DTT_EVT_start' => 'ASC'), |
|
542 | - ) |
|
543 | - ); |
|
544 | - if ( ! empty($datetimes)) { |
|
545 | - // now loop thru all of the datetimes |
|
546 | - foreach ($datetimes as $datetime) { |
|
547 | - if ($datetime instanceof \EE_Datetime) { |
|
548 | - // the number of spaces available for the datetime without considering individual ticket quantities |
|
549 | - $spaces_remaining = $datetime->spaces_remaining(); |
|
550 | - // save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold |
|
551 | - // or the datetime spaces remaining) to this ticket using the datetime ID as the key |
|
552 | - self::$_available_spaces['tickets'][$ticket->ID()][$datetime->ID()] = min( |
|
553 | - $ticket->qty() - $ticket->sold(), |
|
554 | - $spaces_remaining |
|
555 | - ); |
|
556 | - // if the remaining spaces for this datetime is already set, |
|
557 | - // then compare that against the datetime spaces remaining, and take the lowest number, |
|
558 | - // else just take the datetime spaces remaining, and assign to the datetimes array |
|
559 | - self::$_available_spaces['datetimes'][$datetime->ID()] = isset( |
|
560 | - self::$_available_spaces['datetimes'][$datetime->ID()] |
|
561 | - ) |
|
562 | - ? min(self::$_available_spaces['datetimes'][$datetime->ID()], $spaces_remaining) |
|
563 | - : $spaces_remaining; |
|
564 | - } |
|
565 | - } |
|
566 | - } |
|
567 | - } |
|
568 | - |
|
569 | - |
|
570 | - |
|
571 | - /** |
|
572 | - * @param \EE_Ticket $ticket |
|
573 | - * @param int $qty |
|
574 | - * @return void |
|
575 | - */ |
|
576 | - private function recalculateTicketDatetimeAvailability(\EE_Ticket $ticket, $qty = 0) |
|
577 | - { |
|
578 | - if (isset(self::$_available_spaces['tickets'][$ticket->ID()])) { |
|
579 | - // loop thru tickets, which will ALSO include individual ticket records AND a total |
|
580 | - foreach (self::$_available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) { |
|
581 | - // subtract the qty of selected tickets from each datetime's available spaces this ticket has access to, |
|
582 | - self::$_available_spaces['datetimes'][$DTD_ID] -= $qty; |
|
583 | - } |
|
584 | - } |
|
585 | - } |
|
22 | + /** |
|
23 | + * array of datetimes and the spaces available for them |
|
24 | + * |
|
25 | + * @access private |
|
26 | + * @var array |
|
27 | + */ |
|
28 | + private static $_available_spaces = array(); |
|
29 | + |
|
30 | + |
|
31 | + |
|
32 | + /** |
|
33 | + * cancelTicketSelections |
|
34 | + * |
|
35 | + * @return string |
|
36 | + */ |
|
37 | + public function cancelTicketSelections() |
|
38 | + { |
|
39 | + // check nonce |
|
40 | + if ( ! $this->processTicketSelectorNonce('cancel_ticket_selections')) { |
|
41 | + return false; |
|
42 | + } |
|
43 | + \EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
44 | + if (\EE_Registry::instance()->REQ->is_set('event_id')) { |
|
45 | + wp_safe_redirect( |
|
46 | + \EEH_Event_View::event_link_url( |
|
47 | + \EE_Registry::instance()->REQ->get('event_id') |
|
48 | + ) |
|
49 | + ); |
|
50 | + } else { |
|
51 | + wp_safe_redirect( |
|
52 | + site_url('/' . \EE_Registry::instance()->CFG->core->event_cpt_slug . '/') |
|
53 | + ); |
|
54 | + } |
|
55 | + exit(); |
|
56 | + } |
|
57 | + |
|
58 | + |
|
59 | + |
|
60 | + /** |
|
61 | + * processTicketSelectorNonce |
|
62 | + * |
|
63 | + * @param string $nonce_name |
|
64 | + * @param string $id |
|
65 | + * @return bool |
|
66 | + */ |
|
67 | + private function processTicketSelectorNonce($nonce_name, $id = '') |
|
68 | + { |
|
69 | + $nonce_name_with_id = ! empty($id) ? "{$nonce_name}_nonce_{$id}" : "{$nonce_name}_nonce"; |
|
70 | + if ( |
|
71 | + ! is_admin() |
|
72 | + && ( |
|
73 | + ! \EE_Registry::instance()->REQ->is_set($nonce_name_with_id) |
|
74 | + || ! wp_verify_nonce( |
|
75 | + \EE_Registry::instance()->REQ->get($nonce_name_with_id), |
|
76 | + $nonce_name |
|
77 | + ) |
|
78 | + ) |
|
79 | + ) { |
|
80 | + \EE_Error::add_error( |
|
81 | + sprintf( |
|
82 | + __( |
|
83 | + 'We\'re sorry but your request failed to pass a security check.%sPlease click the back button on your browser and try again.', |
|
84 | + 'event_espresso' |
|
85 | + ), |
|
86 | + '<br/>' |
|
87 | + ), |
|
88 | + __FILE__, |
|
89 | + __FUNCTION__, |
|
90 | + __LINE__ |
|
91 | + ); |
|
92 | + return false; |
|
93 | + } |
|
94 | + return true; |
|
95 | + } |
|
96 | + |
|
97 | + |
|
98 | + |
|
99 | + /** |
|
100 | + * process_ticket_selections |
|
101 | + * |
|
102 | + * @return array|bool |
|
103 | + * @throws \EE_Error |
|
104 | + */ |
|
105 | + public function processTicketSelections() |
|
106 | + { |
|
107 | + do_action('EED_Ticket_Selector__process_ticket_selections__before'); |
|
108 | + // do we have an event id? |
|
109 | + if ( ! \EE_Registry::instance()->REQ->is_set('tkt-slctr-event-id')) { |
|
110 | + // $_POST['tkt-slctr-event-id'] was not set ?!?!?!? |
|
111 | + \EE_Error::add_error( |
|
112 | + sprintf( |
|
113 | + __( |
|
114 | + 'An event id was not provided or was not received.%sPlease click the back button on your browser and try again.', |
|
115 | + 'event_espresso' |
|
116 | + ), |
|
117 | + '<br/>' |
|
118 | + ), |
|
119 | + __FILE__, |
|
120 | + __FUNCTION__, |
|
121 | + __LINE__ |
|
122 | + ); |
|
123 | + } |
|
124 | + //if event id is valid |
|
125 | + $id = absint(\EE_Registry::instance()->REQ->get('tkt-slctr-event-id')); |
|
126 | + // d( \EE_Registry::instance()->REQ ); |
|
127 | + self::$_available_spaces = array( |
|
128 | + 'tickets' => array(), |
|
129 | + 'datetimes' => array(), |
|
130 | + ); |
|
131 | + //we should really only have 1 registration in the works now (ie, no MER) so clear any previous items in the cart. |
|
132 | + // When MER happens this will probably need to be tweaked, possibly wrapped in a conditional checking for some constant defined in MER etc. |
|
133 | + \EE_Registry::instance()->load_core('Session'); |
|
134 | + // unless otherwise requested, clear the session |
|
135 | + if (apply_filters('FHEE__EE_Ticket_Selector__process_ticket_selections__clear_session', true)) { |
|
136 | + \EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
137 | + } |
|
138 | + //d( \EE_Registry::instance()->SSN ); |
|
139 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
140 | + // validate/sanitize data |
|
141 | + $valid = $this->validatePostData($id); |
|
142 | + //EEH_Debug_Tools::printr( $_REQUEST, '$_REQUEST', __FILE__, __LINE__ ); |
|
143 | + //EEH_Debug_Tools::printr( $valid, '$valid', __FILE__, __LINE__ ); |
|
144 | + //EEH_Debug_Tools::printr( $valid[ 'total_tickets' ], 'total_tickets', __FILE__, __LINE__ ); |
|
145 | + //EEH_Debug_Tools::printr( $valid[ 'max_atndz' ], 'max_atndz', __FILE__, __LINE__ ); |
|
146 | + //check total tickets ordered vs max number of attendees that can register |
|
147 | + if ($valid['total_tickets'] > $valid['max_atndz']) { |
|
148 | + // ordering too many tickets !!! |
|
149 | + $total_tickets_string = _n( |
|
150 | + 'You have attempted to purchase %s ticket.', |
|
151 | + 'You have attempted to purchase %s tickets.', |
|
152 | + $valid['total_tickets'], |
|
153 | + 'event_espresso' |
|
154 | + ); |
|
155 | + $limit_error_1 = sprintf($total_tickets_string, $valid['total_tickets']); |
|
156 | + // dev only message |
|
157 | + $max_atndz_string = _n( |
|
158 | + 'The registration limit for this event is %s ticket per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.', |
|
159 | + 'The registration limit for this event is %s tickets per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.', |
|
160 | + $valid['max_atndz'], |
|
161 | + 'event_espresso' |
|
162 | + ); |
|
163 | + $limit_error_2 = sprintf($max_atndz_string, $valid['max_atndz'], $valid['max_atndz']); |
|
164 | + \EE_Error::add_error($limit_error_1 . '<br/>' . $limit_error_2, __FILE__, __FUNCTION__, __LINE__); |
|
165 | + } else { |
|
166 | + // all data appears to be valid |
|
167 | + $tckts_slctd = false; |
|
168 | + $tickets_added = 0; |
|
169 | + $valid = apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data', $valid); |
|
170 | + if ($valid['total_tickets'] > 0) { |
|
171 | + // load cart |
|
172 | + \EE_Registry::instance()->load_core('Cart'); |
|
173 | + // cycle thru the number of data rows sent from the event listing |
|
174 | + for ($x = 0; $x < $valid['rows']; $x++) { |
|
175 | + // does this row actually contain a ticket quantity? |
|
176 | + if (isset($valid['qty'][$x]) && $valid['qty'][$x] > 0) { |
|
177 | + // YES we have a ticket quantity |
|
178 | + $tckts_slctd = true; |
|
179 | + // d( $valid['ticket_obj'][$x] ); |
|
180 | + if ($valid['ticket_obj'][$x] instanceof \EE_Ticket) { |
|
181 | + // then add ticket to cart |
|
182 | + $tickets_added += $this->addTicketToCart( |
|
183 | + $valid['ticket_obj'][$x], |
|
184 | + $valid['qty'][$x] |
|
185 | + ); |
|
186 | + if (\EE_Error::has_error()) { |
|
187 | + break; |
|
188 | + } |
|
189 | + } else { |
|
190 | + // nothing added to cart retrieved |
|
191 | + \EE_Error::add_error( |
|
192 | + sprintf( |
|
193 | + __( |
|
194 | + 'A valid ticket could not be retrieved for the event.%sPlease click the back button on your browser and try again.', |
|
195 | + 'event_espresso' |
|
196 | + ), |
|
197 | + '<br/>' |
|
198 | + ), |
|
199 | + __FILE__, __FUNCTION__, __LINE__ |
|
200 | + ); |
|
201 | + } |
|
202 | + } |
|
203 | + } |
|
204 | + } |
|
205 | + do_action( |
|
206 | + 'AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart', |
|
207 | + \EE_Registry::instance()->CART, |
|
208 | + $this |
|
209 | + ); |
|
210 | + //d( \EE_Registry::instance()->CART ); |
|
211 | + //die(); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< KILL REDIRECT HERE BEFORE CART UPDATE |
|
212 | + if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', $tckts_slctd)) { |
|
213 | + if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__success', $tickets_added)) { |
|
214 | + do_action( |
|
215 | + 'FHEE__EE_Ticket_Selector__process_ticket_selections__before_redirecting_to_checkout', |
|
216 | + \EE_Registry::instance()->CART, |
|
217 | + $this |
|
218 | + ); |
|
219 | + \EE_Registry::instance()->CART->recalculate_all_cart_totals(); |
|
220 | + \EE_Registry::instance()->CART->save_cart(false); |
|
221 | + // exit('KILL REDIRECT AFTER CART UPDATE'); // <<<<<<<< OR HERE TO KILL REDIRECT AFTER CART UPDATE |
|
222 | + // just return TRUE for registrations being made from admin |
|
223 | + if (is_admin()) { |
|
224 | + return true; |
|
225 | + } |
|
226 | + \EE_Error::get_notices(false, true); |
|
227 | + wp_safe_redirect( |
|
228 | + apply_filters( |
|
229 | + 'FHEE__EE_Ticket_Selector__process_ticket_selections__success_redirect_url', |
|
230 | + \EE_Registry::instance()->CFG->core->reg_page_url() |
|
231 | + ) |
|
232 | + ); |
|
233 | + exit(); |
|
234 | + } else { |
|
235 | + if ( ! \EE_Error::has_error() && ! \EE_Error::has_error(true, 'attention')) { |
|
236 | + // nothing added to cart |
|
237 | + \EE_Error::add_attention(__('No tickets were added for the event', 'event_espresso'), |
|
238 | + __FILE__, __FUNCTION__, __LINE__); |
|
239 | + } |
|
240 | + } |
|
241 | + } else { |
|
242 | + // no ticket quantities were selected |
|
243 | + \EE_Error::add_error(__('You need to select a ticket quantity before you can proceed.', |
|
244 | + 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
245 | + } |
|
246 | + } |
|
247 | + //die(); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< KILL BEFORE REDIRECT |
|
248 | + // at this point, just return if registration is being made from admin |
|
249 | + if (is_admin()) { |
|
250 | + return false; |
|
251 | + } |
|
252 | + if ($valid['return_url']) { |
|
253 | + \EE_Error::get_notices(false, true); |
|
254 | + wp_safe_redirect($valid['return_url']); |
|
255 | + exit(); |
|
256 | + } elseif (isset($event_to_add['id'])) { |
|
257 | + \EE_Error::get_notices(false, true); |
|
258 | + wp_safe_redirect(get_permalink($event_to_add['id'])); |
|
259 | + exit(); |
|
260 | + } else { |
|
261 | + echo \EE_Error::get_notices(); |
|
262 | + } |
|
263 | + return false; |
|
264 | + } |
|
265 | + |
|
266 | + |
|
267 | + |
|
268 | + /** |
|
269 | + * validate_post_data |
|
270 | + * |
|
271 | + * @param int $id |
|
272 | + * @return array|FALSE |
|
273 | + */ |
|
274 | + private function validatePostData($id = 0) |
|
275 | + { |
|
276 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
277 | + if ( ! $id) { |
|
278 | + \EE_Error::add_error( |
|
279 | + __('The event id provided was not valid.', 'event_espresso'), |
|
280 | + __FILE__, |
|
281 | + __FUNCTION__, |
|
282 | + __LINE__ |
|
283 | + ); |
|
284 | + return false; |
|
285 | + } |
|
286 | + // start with an empty array() |
|
287 | + $valid_data = array(); |
|
288 | + // grab valid id |
|
289 | + $valid_data['id'] = $id; |
|
290 | + // array of other form names |
|
291 | + $inputs_to_clean = array( |
|
292 | + 'event_id' => 'tkt-slctr-event-id', |
|
293 | + 'max_atndz' => 'tkt-slctr-max-atndz-', |
|
294 | + 'rows' => 'tkt-slctr-rows-', |
|
295 | + 'qty' => 'tkt-slctr-qty-', |
|
296 | + 'ticket_id' => 'tkt-slctr-ticket-id-', |
|
297 | + 'return_url' => 'tkt-slctr-return-url-', |
|
298 | + ); |
|
299 | + // let's track the total number of tickets ordered.' |
|
300 | + $valid_data['total_tickets'] = 0; |
|
301 | + // cycle through $inputs_to_clean array |
|
302 | + foreach ($inputs_to_clean as $what => $input_to_clean) { |
|
303 | + // check for POST data |
|
304 | + if (\EE_Registry::instance()->REQ->is_set($input_to_clean . $id)) { |
|
305 | + // grab value |
|
306 | + $input_value = \EE_Registry::instance()->REQ->get($input_to_clean . $id); |
|
307 | + switch ($what) { |
|
308 | + // integers |
|
309 | + case 'event_id': |
|
310 | + $valid_data[$what] = absint($input_value); |
|
311 | + // get event via the event id we put in the form |
|
312 | + $valid_data['event'] = \EE_Registry::instance() |
|
313 | + ->load_model('Event') |
|
314 | + ->get_one_by_ID($valid_data['event_id']); |
|
315 | + break; |
|
316 | + case 'rows': |
|
317 | + case 'max_atndz': |
|
318 | + $valid_data[$what] = absint($input_value); |
|
319 | + break; |
|
320 | + // arrays of integers |
|
321 | + case 'qty': |
|
322 | + /** @var array $row_qty */ |
|
323 | + $row_qty = $input_value; |
|
324 | + // if qty is coming from a radio button input, then we need to assemble an array of rows |
|
325 | + if ( ! is_array($row_qty)) { |
|
326 | + // get number of rows |
|
327 | + $rows = \EE_Registry::instance()->REQ->is_set('tkt-slctr-rows-' . $id) |
|
328 | + ? absint(\EE_Registry::instance()->REQ->get('tkt-slctr-rows-' . $id)) |
|
329 | + : 1; |
|
330 | + // explode ints by the dash |
|
331 | + $row_qty = explode('-', $row_qty); |
|
332 | + $row = isset($row_qty[0]) ? absint($row_qty[0]) : 1; |
|
333 | + $qty = isset($row_qty[1]) ? absint($row_qty[1]) : 0; |
|
334 | + $row_qty = array($row => $qty); |
|
335 | + for ($x = 1; $x <= $rows; $x++) { |
|
336 | + if ( ! isset($row_qty[$x])) { |
|
337 | + $row_qty[$x] = 0; |
|
338 | + } |
|
339 | + } |
|
340 | + } |
|
341 | + ksort($row_qty); |
|
342 | + // cycle thru values |
|
343 | + foreach ($row_qty as $qty) { |
|
344 | + $qty = absint($qty); |
|
345 | + // sanitize as integers |
|
346 | + $valid_data[$what][] = $qty; |
|
347 | + $valid_data['total_tickets'] += $qty; |
|
348 | + } |
|
349 | + break; |
|
350 | + // array of integers |
|
351 | + case 'ticket_id': |
|
352 | + $value_array = array(); |
|
353 | + // cycle thru values |
|
354 | + foreach ((array)$input_value as $key => $value) { |
|
355 | + // allow only numbers, letters, spaces, commas and dashes |
|
356 | + $value_array[$key] = wp_strip_all_tags($value); |
|
357 | + // get ticket via the ticket id we put in the form |
|
358 | + $ticket_obj = \EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($value); |
|
359 | + $valid_data['ticket_obj'][$key] = $ticket_obj; |
|
360 | + } |
|
361 | + $valid_data[$what] = $value_array; |
|
362 | + break; |
|
363 | + case 'return_url' : |
|
364 | + // grab and sanitize return-url |
|
365 | + $input_value = esc_url_raw($input_value); |
|
366 | + // was the request coming from an iframe ? if so, then: |
|
367 | + if (strpos($input_value, 'event_list=iframe')) { |
|
368 | + // get anchor fragment |
|
369 | + $input_value = explode('#', $input_value); |
|
370 | + $input_value = end($input_value); |
|
371 | + // use event list url instead, but append anchor |
|
372 | + $input_value = \EEH_Event_View::event_archive_url() . '#' . $input_value; |
|
373 | + } |
|
374 | + $valid_data[$what] = $input_value; |
|
375 | + break; |
|
376 | + } // end switch $what |
|
377 | + } |
|
378 | + } // end foreach $inputs_to_clean |
|
379 | + return $valid_data; |
|
380 | + } |
|
381 | + |
|
382 | + |
|
383 | + |
|
384 | + /** |
|
385 | + * adds a ticket to the cart |
|
386 | + * |
|
387 | + * @param \EE_Ticket $ticket |
|
388 | + * @param int $qty |
|
389 | + * @return TRUE on success, FALSE on fail |
|
390 | + * @throws \EE_Error |
|
391 | + */ |
|
392 | + private function addTicketToCart(\EE_Ticket $ticket = null, $qty = 1) |
|
393 | + { |
|
394 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
395 | + // get the number of spaces left for this datetime ticket |
|
396 | + $available_spaces = $this->ticketDatetimeAvailability($ticket); |
|
397 | + // compare available spaces against the number of tickets being purchased |
|
398 | + if ($available_spaces >= $qty) { |
|
399 | + // allow addons to prevent a ticket from being added to cart |
|
400 | + if ( |
|
401 | + ! apply_filters( |
|
402 | + 'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_add_to_cart', |
|
403 | + true, |
|
404 | + $ticket, |
|
405 | + $qty, |
|
406 | + $available_spaces |
|
407 | + ) |
|
408 | + ) { |
|
409 | + return false; |
|
410 | + } |
|
411 | + $qty = absint(apply_filters('FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty', $qty, $ticket)); |
|
412 | + // add event to cart |
|
413 | + if (\EE_Registry::instance()->CART->add_ticket_to_cart($ticket, $qty)) { |
|
414 | + $this->recalculateTicketDatetimeAvailability($ticket, $qty); |
|
415 | + return true; |
|
416 | + } |
|
417 | + return false; |
|
418 | + } |
|
419 | + // tickets can not be purchased but let's find the exact number left |
|
420 | + // for the last ticket selected PRIOR to subtracting tickets |
|
421 | + $available_spaces = $this->ticketDatetimeAvailability($ticket, true); |
|
422 | + // greedy greedy greedy eh? |
|
423 | + if ($available_spaces > 0) { |
|
424 | + if ( |
|
425 | + apply_filters( |
|
426 | + 'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_display_availability_error', |
|
427 | + true, |
|
428 | + $ticket, |
|
429 | + $qty, |
|
430 | + $available_spaces |
|
431 | + ) |
|
432 | + ) { |
|
433 | + $this->displayAvailabilityError($available_spaces); |
|
434 | + } |
|
435 | + } else { |
|
436 | + \EE_Error::add_error( |
|
437 | + __( |
|
438 | + 'We\'re sorry, but there are no available spaces left for this event at this particular date and time.', |
|
439 | + 'event_espresso' |
|
440 | + ), |
|
441 | + __FILE__, __FUNCTION__, __LINE__ |
|
442 | + ); |
|
443 | + } |
|
444 | + return false; |
|
445 | + } |
|
446 | + |
|
447 | + |
|
448 | + |
|
449 | + /** |
|
450 | + * @param int $available_spaces |
|
451 | + * @throws \EE_Error |
|
452 | + */ |
|
453 | + private function displayAvailabilityError($available_spaces = 1) |
|
454 | + { |
|
455 | + // add error messaging - we're using the _n function that will generate |
|
456 | + // the appropriate singular or plural message based on the number of $available_spaces |
|
457 | + if (\EE_Registry::instance()->CART->all_ticket_quantity_count()) { |
|
458 | + $msg = sprintf( |
|
459 | + _n( |
|
460 | + 'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.', |
|
461 | + 'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.', |
|
462 | + $available_spaces, |
|
463 | + 'event_espresso' |
|
464 | + ), |
|
465 | + $available_spaces, |
|
466 | + '<br />' |
|
467 | + ); |
|
468 | + } else { |
|
469 | + $msg = sprintf( |
|
470 | + _n( |
|
471 | + 'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets.', |
|
472 | + 'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets.', |
|
473 | + $available_spaces, |
|
474 | + 'event_espresso' |
|
475 | + ), |
|
476 | + $available_spaces, |
|
477 | + '<br />' |
|
478 | + ); |
|
479 | + } |
|
480 | + \EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
481 | + } |
|
482 | + |
|
483 | + |
|
484 | + |
|
485 | + /** |
|
486 | + * ticketDatetimeAvailability |
|
487 | + * creates an array of tickets plus all of the datetimes available to each ticket |
|
488 | + * and tracks the spaces remaining for each of those datetimes |
|
489 | + * |
|
490 | + * @param \EE_Ticket $ticket - selected ticket |
|
491 | + * @param bool $get_original_ticket_spaces |
|
492 | + * @return int |
|
493 | + * @throws \EE_Error |
|
494 | + */ |
|
495 | + private function ticketDatetimeAvailability(\EE_Ticket $ticket, $get_original_ticket_spaces = false) |
|
496 | + { |
|
497 | + // if the $_available_spaces array has not been set up yet... |
|
498 | + if ( ! isset(self::$_available_spaces['tickets'][$ticket->ID()])) { |
|
499 | + $this->setInitialTicketDatetimeAvailability($ticket); |
|
500 | + } |
|
501 | + $available_spaces = $ticket->qty() - $ticket->sold(); |
|
502 | + if (isset(self::$_available_spaces['tickets'][$ticket->ID()])) { |
|
503 | + // loop thru tickets, which will ALSO include individual ticket records AND a total |
|
504 | + foreach (self::$_available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) { |
|
505 | + // if we want the original datetime availability BEFORE we started subtracting tickets ? |
|
506 | + if ($get_original_ticket_spaces) { |
|
507 | + // then grab the available spaces from the "tickets" array |
|
508 | + // and compare with the above to get the lowest number |
|
509 | + $available_spaces = min( |
|
510 | + $available_spaces, |
|
511 | + self::$_available_spaces['tickets'][$ticket->ID()][$DTD_ID] |
|
512 | + ); |
|
513 | + } else { |
|
514 | + // we want the updated ticket availability as stored in the "datetimes" array |
|
515 | + $available_spaces = min($available_spaces, self::$_available_spaces['datetimes'][$DTD_ID]); |
|
516 | + } |
|
517 | + } |
|
518 | + } |
|
519 | + return $available_spaces; |
|
520 | + } |
|
521 | + |
|
522 | + |
|
523 | + |
|
524 | + /** |
|
525 | + * @param \EE_Ticket $ticket |
|
526 | + * @return void |
|
527 | + * @throws \EE_Error |
|
528 | + */ |
|
529 | + private function setInitialTicketDatetimeAvailability(\EE_Ticket $ticket) |
|
530 | + { |
|
531 | + // first, get all of the datetimes that are available to this ticket |
|
532 | + $datetimes = $ticket->get_many_related( |
|
533 | + 'Datetime', |
|
534 | + array( |
|
535 | + array( |
|
536 | + 'DTT_EVT_end' => array( |
|
537 | + '>=', |
|
538 | + \EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
539 | + ), |
|
540 | + ), |
|
541 | + 'order_by' => array('DTT_EVT_start' => 'ASC'), |
|
542 | + ) |
|
543 | + ); |
|
544 | + if ( ! empty($datetimes)) { |
|
545 | + // now loop thru all of the datetimes |
|
546 | + foreach ($datetimes as $datetime) { |
|
547 | + if ($datetime instanceof \EE_Datetime) { |
|
548 | + // the number of spaces available for the datetime without considering individual ticket quantities |
|
549 | + $spaces_remaining = $datetime->spaces_remaining(); |
|
550 | + // save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold |
|
551 | + // or the datetime spaces remaining) to this ticket using the datetime ID as the key |
|
552 | + self::$_available_spaces['tickets'][$ticket->ID()][$datetime->ID()] = min( |
|
553 | + $ticket->qty() - $ticket->sold(), |
|
554 | + $spaces_remaining |
|
555 | + ); |
|
556 | + // if the remaining spaces for this datetime is already set, |
|
557 | + // then compare that against the datetime spaces remaining, and take the lowest number, |
|
558 | + // else just take the datetime spaces remaining, and assign to the datetimes array |
|
559 | + self::$_available_spaces['datetimes'][$datetime->ID()] = isset( |
|
560 | + self::$_available_spaces['datetimes'][$datetime->ID()] |
|
561 | + ) |
|
562 | + ? min(self::$_available_spaces['datetimes'][$datetime->ID()], $spaces_remaining) |
|
563 | + : $spaces_remaining; |
|
564 | + } |
|
565 | + } |
|
566 | + } |
|
567 | + } |
|
568 | + |
|
569 | + |
|
570 | + |
|
571 | + /** |
|
572 | + * @param \EE_Ticket $ticket |
|
573 | + * @param int $qty |
|
574 | + * @return void |
|
575 | + */ |
|
576 | + private function recalculateTicketDatetimeAvailability(\EE_Ticket $ticket, $qty = 0) |
|
577 | + { |
|
578 | + if (isset(self::$_available_spaces['tickets'][$ticket->ID()])) { |
|
579 | + // loop thru tickets, which will ALSO include individual ticket records AND a total |
|
580 | + foreach (self::$_available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) { |
|
581 | + // subtract the qty of selected tickets from each datetime's available spaces this ticket has access to, |
|
582 | + self::$_available_spaces['datetimes'][$DTD_ID] -= $qty; |
|
583 | + } |
|
584 | + } |
|
585 | + } |
|
586 | 586 | |
587 | 587 | |
588 | 588 | } |
@@ -33,11 +33,11 @@ discard block |
||
33 | 33 | public static function set_hooks() { |
34 | 34 | // create download buttons |
35 | 35 | add_filter( |
36 | - 'FHEE__espresso_list_of_event_dates__datetime_html', |
|
37 | - array( 'EED_Ical', 'generate_add_to_iCal_button' ), |
|
38 | - 10, |
|
39 | - 2 |
|
40 | - ); |
|
36 | + 'FHEE__espresso_list_of_event_dates__datetime_html', |
|
37 | + array( 'EED_Ical', 'generate_add_to_iCal_button' ), |
|
38 | + 10, |
|
39 | + 2 |
|
40 | + ); |
|
41 | 41 | // process ics download request |
42 | 42 | EE_Config::register_route( 'download_ics_file', 'EED_Ical', 'download_ics_file' ); |
43 | 43 | } |
@@ -66,15 +66,15 @@ discard block |
||
66 | 66 | |
67 | 67 | |
68 | 68 | |
69 | - /** |
|
70 | - * generate_add_to_iCal_button |
|
71 | - * |
|
72 | - * @access public |
|
73 | - * @param $html |
|
74 | - * @param $datetime |
|
75 | - * @return string |
|
76 | - * @throws \EE_Error |
|
77 | - */ |
|
69 | + /** |
|
70 | + * generate_add_to_iCal_button |
|
71 | + * |
|
72 | + * @access public |
|
73 | + * @param $html |
|
74 | + * @param $datetime |
|
75 | + * @return string |
|
76 | + * @throws \EE_Error |
|
77 | + */ |
|
78 | 78 | public static function generate_add_to_iCal_button( $html, $datetime ) { |
79 | 79 | // first verify a proper datetime object has been received |
80 | 80 | if ( $datetime instanceof EE_Datetime ) { |
@@ -93,7 +93,7 @@ discard block |
||
93 | 93 | $html .= '</form>'; |
94 | 94 | break; |
95 | 95 | // buttons are just links that have been styled to appear as buttons, |
96 | - // but may not be blend with a theme as well as submit buttons |
|
96 | + // but may not be blend with a theme as well as submit buttons |
|
97 | 97 | case 'button' : |
98 | 98 | $html .= '<a class="ee-ical-btn small ee-button ee-roundish" href="' . $URL; |
99 | 99 | $html .= '" title="' . __( 'Add to iCal Calendar', 'event_espresso' ) . '">'; |
@@ -114,13 +114,13 @@ discard block |
||
114 | 114 | |
115 | 115 | |
116 | 116 | |
117 | - /** |
|
118 | - * download_ics_file |
|
119 | - * |
|
120 | - * @access public |
|
121 | - * @return void |
|
122 | - * @throws \EE_Error |
|
123 | - */ |
|
117 | + /** |
|
118 | + * download_ics_file |
|
119 | + * |
|
120 | + * @access public |
|
121 | + * @return void |
|
122 | + * @throws \EE_Error |
|
123 | + */ |
|
124 | 124 | public static function download_ics_file() { |
125 | 125 | if ( EE_Registry::instance()->REQ->is_set( 'ics_id' )) { |
126 | 126 | $DTT_ID = absint( EE_Registry::instance()->REQ->get( 'ics_id' )); |
@@ -228,8 +228,8 @@ discard block |
||
228 | 228 | //Escape special chars within the description |
229 | 229 | $description = EED_Ical::_escape_ICal_data( $description ); |
230 | 230 | |
231 | - //Remove line breaks and output in iCal format |
|
232 | - $description = str_replace( array( "\r\n", "\n"), '\n', $description ); |
|
231 | + //Remove line breaks and output in iCal format |
|
232 | + $description = str_replace( array( "\r\n", "\n"), '\n', $description ); |
|
233 | 233 | |
234 | 234 | return $description; |
235 | 235 | } |
@@ -1,4 +1,6 @@ |
||
1 | -<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed'); |
|
1 | +<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
2 | + exit('No direct script access allowed'); |
|
3 | +} |
|
2 | 4 | |
3 | 5 | /** |
4 | 6 | * EED_Ical Class |
@@ -19,7 +19,7 @@ discard block |
||
19 | 19 | * @return EED_Ical|EED_Module |
20 | 20 | */ |
21 | 21 | public static function instance() { |
22 | - return parent::get_instance( __CLASS__ ); |
|
22 | + return parent::get_instance(__CLASS__); |
|
23 | 23 | } |
24 | 24 | |
25 | 25 | |
@@ -34,12 +34,12 @@ discard block |
||
34 | 34 | // create download buttons |
35 | 35 | add_filter( |
36 | 36 | 'FHEE__espresso_list_of_event_dates__datetime_html', |
37 | - array( 'EED_Ical', 'generate_add_to_iCal_button' ), |
|
37 | + array('EED_Ical', 'generate_add_to_iCal_button'), |
|
38 | 38 | 10, |
39 | 39 | 2 |
40 | 40 | ); |
41 | 41 | // process ics download request |
42 | - EE_Config::register_route( 'download_ics_file', 'EED_Ical', 'download_ics_file' ); |
|
42 | + EE_Config::register_route('download_ics_file', 'EED_Ical', 'download_ics_file'); |
|
43 | 43 | } |
44 | 44 | |
45 | 45 | |
@@ -62,7 +62,7 @@ discard block |
||
62 | 62 | * @param WP $WP |
63 | 63 | * @return void |
64 | 64 | */ |
65 | - public function run( $WP ) {} |
|
65 | + public function run($WP) {} |
|
66 | 66 | |
67 | 67 | |
68 | 68 | |
@@ -75,35 +75,35 @@ discard block |
||
75 | 75 | * @return string |
76 | 76 | * @throws \EE_Error |
77 | 77 | */ |
78 | - public static function generate_add_to_iCal_button( $html, $datetime ) { |
|
78 | + public static function generate_add_to_iCal_button($html, $datetime) { |
|
79 | 79 | // first verify a proper datetime object has been received |
80 | - if ( $datetime instanceof EE_Datetime ) { |
|
80 | + if ($datetime instanceof EE_Datetime) { |
|
81 | 81 | // set whether a link or submit button is shown |
82 | - $iCal_type = apply_filters( 'FHEE__EED_Ical__generate_add_to_iCal_button__iCal_type', 'submit' ); |
|
82 | + $iCal_type = apply_filters('FHEE__EED_Ical__generate_add_to_iCal_button__iCal_type', 'submit'); |
|
83 | 83 | // generate a link to the route we registered in set_hooks() |
84 | - $URL = add_query_arg( array( 'ee' => 'download_ics_file', 'ics_id' => $datetime->ID() ), site_url() ); |
|
84 | + $URL = add_query_arg(array('ee' => 'download_ics_file', 'ics_id' => $datetime->ID()), site_url()); |
|
85 | 85 | // what type ? |
86 | - switch ( $iCal_type ) { |
|
86 | + switch ($iCal_type) { |
|
87 | 87 | // submit buttons appear as buttons and are very compatible with a theme's style |
88 | 88 | case 'submit' : |
89 | - $html .= '<form id="download-iCal-frm-' . $datetime->ID(); |
|
90 | - $html .= '" class="download-iCal-frm" action="' . $URL . '" method="post" >'; |
|
89 | + $html .= '<form id="download-iCal-frm-'.$datetime->ID(); |
|
90 | + $html .= '" class="download-iCal-frm" action="'.$URL.'" method="post" >'; |
|
91 | 91 | $html .= '<input type="submit" class="ee-ical-sbmt" value="" title="'; |
92 | - $html .= __( 'Add to iCal Calendar', 'event_espresso' ) . '"/>'; |
|
92 | + $html .= __('Add to iCal Calendar', 'event_espresso').'"/>'; |
|
93 | 93 | $html .= '</form>'; |
94 | 94 | break; |
95 | 95 | // buttons are just links that have been styled to appear as buttons, |
96 | 96 | // but may not be blend with a theme as well as submit buttons |
97 | 97 | case 'button' : |
98 | - $html .= '<a class="ee-ical-btn small ee-button ee-roundish" href="' . $URL; |
|
99 | - $html .= '" title="' . __( 'Add to iCal Calendar', 'event_espresso' ) . '">'; |
|
98 | + $html .= '<a class="ee-ical-btn small ee-button ee-roundish" href="'.$URL; |
|
99 | + $html .= '" title="'.__('Add to iCal Calendar', 'event_espresso').'">'; |
|
100 | 100 | $html .= ' <span class="dashicons dashicons-calendar"></span>'; |
101 | 101 | $html .= '</a>'; |
102 | 102 | break; |
103 | 103 | // links are just links that use the calendar dashicon |
104 | 104 | case 'icon' : |
105 | - $html .= '<a class="ee-ical-lnk" href="' . $URL . '" title="'; |
|
106 | - $html .= __( 'Add to iCal Calendar', 'event_espresso' ) . '">'; |
|
105 | + $html .= '<a class="ee-ical-lnk" href="'.$URL.'" title="'; |
|
106 | + $html .= __('Add to iCal Calendar', 'event_espresso').'">'; |
|
107 | 107 | $html .= ' <span class="dashicons dashicons-calendar"></span>'; |
108 | 108 | $html .= '</a>'; |
109 | 109 | break; |
@@ -122,29 +122,29 @@ discard block |
||
122 | 122 | * @throws \EE_Error |
123 | 123 | */ |
124 | 124 | public static function download_ics_file() { |
125 | - if ( EE_Registry::instance()->REQ->is_set( 'ics_id' )) { |
|
126 | - $DTT_ID = absint( EE_Registry::instance()->REQ->get( 'ics_id' )); |
|
127 | - $datetime = EE_Registry::instance()->load_model( 'Datetime' )->get_one_by_ID( $DTT_ID ); |
|
128 | - if ( $datetime instanceof EE_Datetime ) { |
|
125 | + if (EE_Registry::instance()->REQ->is_set('ics_id')) { |
|
126 | + $DTT_ID = absint(EE_Registry::instance()->REQ->get('ics_id')); |
|
127 | + $datetime = EE_Registry::instance()->load_model('Datetime')->get_one_by_ID($DTT_ID); |
|
128 | + if ($datetime instanceof EE_Datetime) { |
|
129 | 129 | // get related event, venues, and event categories |
130 | 130 | $event = $datetime->event(); |
131 | 131 | // get related category Term object and it's name |
132 | 132 | $category = $event->first_event_category(); |
133 | - if ( $category instanceof EE_Term ) { |
|
133 | + if ($category instanceof EE_Term) { |
|
134 | 134 | $category = $category->name(); |
135 | 135 | } |
136 | 136 | $location = ''; |
137 | 137 | // get first related venue and convert to CSV string |
138 | - $venue = $event->venues(array( 'limit'=>1 )); |
|
139 | - if ( is_array( $venue ) && ! empty( $venue )) { |
|
140 | - $venue = array_shift( $venue ); |
|
141 | - if ( $venue instanceof EE_Venue ) { |
|
142 | - $location = espresso_venue_raw_address( 'inline', $venue->ID(), FALSE ); |
|
138 | + $venue = $event->venues(array('limit'=>1)); |
|
139 | + if (is_array($venue) && ! empty($venue)) { |
|
140 | + $venue = array_shift($venue); |
|
141 | + if ($venue instanceof EE_Venue) { |
|
142 | + $location = espresso_venue_raw_address('inline', $venue->ID(), FALSE); |
|
143 | 143 | } |
144 | 144 | } |
145 | 145 | |
146 | 146 | //Generate filename |
147 | - $filename = $event->slug() . '-' . $datetime->start_date( 'Y-m-d' ) . '.ics'; |
|
147 | + $filename = $event->slug().'-'.$datetime->start_date('Y-m-d').'.ics'; |
|
148 | 148 | |
149 | 149 | //Check the datetime status has not been cancelled and set the ics value accordingly |
150 | 150 | $status = $datetime->get_active_status(); |
@@ -153,62 +153,62 @@ discard block |
||
153 | 153 | // Create array of ics details, escape strings, convert timestamps to ics format, etc |
154 | 154 | $ics_data = array( |
155 | 155 | 'ORGANIZER_NAME' => EE_Registry::instance()->CFG->organization->name, |
156 | - 'UID' => md5( $event->name() . $event->ID() . $datetime->ID() ), |
|
156 | + 'UID' => md5($event->name().$event->ID().$datetime->ID()), |
|
157 | 157 | 'ORGANIZER' => EE_Registry::instance()->CFG->organization->email, |
158 | - 'DTSTAMP' => date( EED_Ical::iCal_datetime_format ), |
|
158 | + 'DTSTAMP' => date(EED_Ical::iCal_datetime_format), |
|
159 | 159 | 'LOCATION' => $location, |
160 | 160 | 'SUMMARY' => $event->name(), |
161 | - 'DESCRIPTION' => wp_strip_all_tags( $event->description() ), |
|
161 | + 'DESCRIPTION' => wp_strip_all_tags($event->description()), |
|
162 | 162 | 'STATUS' => $status, |
163 | 163 | 'CATEGORIES' => $category, |
164 | - 'URL;VALUE=URI' => get_permalink( $event->ID() ), |
|
165 | - 'DTSTART' => date( EED_Ical::iCal_datetime_format, $datetime->start() ), |
|
166 | - 'DTEND' => date( EED_Ical::iCal_datetime_format, $datetime->end() ), |
|
164 | + 'URL;VALUE=URI' => get_permalink($event->ID()), |
|
165 | + 'DTSTART' => date(EED_Ical::iCal_datetime_format, $datetime->start()), |
|
166 | + 'DTEND' => date(EED_Ical::iCal_datetime_format, $datetime->end()), |
|
167 | 167 | ); |
168 | 168 | |
169 | 169 | //Filter the values used within the ics output. |
170 | 170 | //NOTE - all values within ics_data will be escaped automatically. |
171 | - $ics_data = apply_filters( 'FHEE__EED_Ical__download_ics_file_ics_data', $ics_data, $datetime ); |
|
171 | + $ics_data = apply_filters('FHEE__EED_Ical__download_ics_file_ics_data', $ics_data, $datetime); |
|
172 | 172 | |
173 | 173 | //Escape all ics data |
174 | - foreach( $ics_data as $key => $value ) { |
|
174 | + foreach ($ics_data as $key => $value) { |
|
175 | 175 | //Description is escaped differently from all all values |
176 | - if( $key === 'DESCRIPTION' ) { |
|
177 | - $ics_data[$key] = EED_Ical::_escape_ICal_description( wp_strip_all_tags( $value ) ); |
|
176 | + if ($key === 'DESCRIPTION') { |
|
177 | + $ics_data[$key] = EED_Ical::_escape_ICal_description(wp_strip_all_tags($value)); |
|
178 | 178 | } else { |
179 | - $ics_data[$key] = EED_Ical::_escape_ICal_data( $value ); |
|
179 | + $ics_data[$key] = EED_Ical::_escape_ICal_data($value); |
|
180 | 180 | } |
181 | 181 | } |
182 | 182 | |
183 | 183 | //Pull the organizer name from ics_data and remove it from the array. |
184 | - $organizer_name = isset( $ics_data['ORGANIZER_NAME'] ) ? $ics_data['ORGANIZER_NAME'] : ''; |
|
185 | - unset( $ics_data['ORGANIZER_NAME'] ); |
|
184 | + $organizer_name = isset($ics_data['ORGANIZER_NAME']) ? $ics_data['ORGANIZER_NAME'] : ''; |
|
185 | + unset($ics_data['ORGANIZER_NAME']); |
|
186 | 186 | |
187 | 187 | // set headers |
188 | - header( 'Content-type: text/calendar; charset=utf-8' ); |
|
189 | - header( 'Content-Disposition: attachment; filename="' . $filename . '"' ); |
|
190 | - header( 'Cache-Control: private, max-age=0, must-revalidate' ); |
|
191 | - header( 'Pragma: public' ); |
|
192 | - header( 'Content-Type: application/octet-stream' ); |
|
193 | - header( 'Content-Type: application/force-download' ); |
|
194 | - header( 'Cache-Control: no-cache, must-revalidate' ); |
|
195 | - header( 'Content-Transfer-Encoding: binary' ); |
|
196 | - header( 'Expires: Sat, 26 Jul 1997 05:00:00 GMT' ); // past date |
|
197 | - ini_set( 'zlib.output_compression', '0' ); |
|
188 | + header('Content-type: text/calendar; charset=utf-8'); |
|
189 | + header('Content-Disposition: attachment; filename="'.$filename.'"'); |
|
190 | + header('Cache-Control: private, max-age=0, must-revalidate'); |
|
191 | + header('Pragma: public'); |
|
192 | + header('Content-Type: application/octet-stream'); |
|
193 | + header('Content-Type: application/force-download'); |
|
194 | + header('Cache-Control: no-cache, must-revalidate'); |
|
195 | + header('Content-Transfer-Encoding: binary'); |
|
196 | + header('Expires: Sat, 26 Jul 1997 05:00:00 GMT'); // past date |
|
197 | + ini_set('zlib.output_compression', '0'); |
|
198 | 198 | // echo the output |
199 | - echo "BEGIN:VCALENDAR" . PHP_EOL; |
|
200 | - echo "VERSION:2.0" . PHP_EOL; |
|
201 | - echo "PRODID:-//{$organizer_name}//NONSGML PDA Calendar Version 1.0//EN" . PHP_EOL; |
|
202 | - echo "CALSCALE:GREGORIAN" . PHP_EOL; |
|
203 | - echo "BEGIN:VEVENT" . PHP_EOL; |
|
199 | + echo "BEGIN:VCALENDAR".PHP_EOL; |
|
200 | + echo "VERSION:2.0".PHP_EOL; |
|
201 | + echo "PRODID:-//{$organizer_name}//NONSGML PDA Calendar Version 1.0//EN".PHP_EOL; |
|
202 | + echo "CALSCALE:GREGORIAN".PHP_EOL; |
|
203 | + echo "BEGIN:VEVENT".PHP_EOL; |
|
204 | 204 | |
205 | 205 | //Output all remaining values from ics_data. |
206 | - foreach( $ics_data as $key => $value ) { |
|
207 | - echo $key . ':' . $value . PHP_EOL; |
|
206 | + foreach ($ics_data as $key => $value) { |
|
207 | + echo $key.':'.$value.PHP_EOL; |
|
208 | 208 | } |
209 | 209 | |
210 | - echo "END:VEVENT" . PHP_EOL; |
|
211 | - echo "END:VCALENDAR" . PHP_EOL; |
|
210 | + echo "END:VEVENT".PHP_EOL; |
|
211 | + echo "END:VCALENDAR".PHP_EOL; |
|
212 | 212 | } |
213 | 213 | } |
214 | 214 | die(); |
@@ -223,8 +223,8 @@ discard block |
||
223 | 223 | * @param string $string |
224 | 224 | * @return string |
225 | 225 | */ |
226 | - private static function _escape_ICal_data( $string = '' ) { |
|
227 | - return preg_replace( '/([\,;])/', '\\\$1', $string ); |
|
226 | + private static function _escape_ICal_data($string = '') { |
|
227 | + return preg_replace('/([\,;])/', '\\\$1', $string); |
|
228 | 228 | } |
229 | 229 | |
230 | 230 | /** |
@@ -234,13 +234,13 @@ discard block |
||
234 | 234 | * @param string $description |
235 | 235 | * @return string |
236 | 236 | */ |
237 | - private static function _escape_ICal_description( $description = '' ) { |
|
237 | + private static function _escape_ICal_description($description = '') { |
|
238 | 238 | |
239 | 239 | //Escape special chars within the description |
240 | - $description = EED_Ical::_escape_ICal_data( $description ); |
|
240 | + $description = EED_Ical::_escape_ICal_data($description); |
|
241 | 241 | |
242 | 242 | //Remove line breaks and output in iCal format |
243 | - $description = str_replace( array( "\r\n", "\n"), '\n', $description ); |
|
243 | + $description = str_replace(array("\r\n", "\n"), '\n', $description); |
|
244 | 244 | |
245 | 245 | return $description; |
246 | 246 | } |
@@ -27,7 +27,7 @@ discard block |
||
27 | 27 | /** |
28 | 28 | * @var integer $limit |
29 | 29 | */ |
30 | - private $limit = 10; |
|
30 | + private $limit = 10; |
|
31 | 31 | |
32 | 32 | /** |
33 | 33 | * @var string $css_class |
@@ -68,7 +68,7 @@ discard block |
||
68 | 68 | */ |
69 | 69 | public function __construct($args = array()) |
70 | 70 | { |
71 | - $args = $this->parseArgs((array)$args); |
|
71 | + $args = $this->parseArgs((array) $args); |
|
72 | 72 | $this->setupEventQueryHelper(); |
73 | 73 | $this->setupFilters(); |
74 | 74 | $args = $this->getQueryArgs($args); |
@@ -19,206 +19,206 @@ |
||
19 | 19 | class EventListQuery extends WP_Query |
20 | 20 | { |
21 | 21 | |
22 | - /** |
|
23 | - * @var string $title |
|
24 | - */ |
|
25 | - private $title; |
|
26 | - |
|
27 | - /** |
|
28 | - * @var integer $limit |
|
29 | - */ |
|
30 | - private $limit = 10; |
|
31 | - |
|
32 | - /** |
|
33 | - * @var string $css_class |
|
34 | - */ |
|
35 | - private $css_class; |
|
36 | - |
|
37 | - /** |
|
38 | - * @var boolean $show_expired |
|
39 | - */ |
|
40 | - private $show_expired = false; |
|
41 | - |
|
42 | - /** |
|
43 | - * @var string $month |
|
44 | - */ |
|
45 | - private $month; |
|
46 | - |
|
47 | - /** |
|
48 | - * @var string $category_slug |
|
49 | - */ |
|
50 | - private $category_slug; |
|
51 | - |
|
52 | - /** |
|
53 | - * @var string $order_by |
|
54 | - */ |
|
55 | - private $order_by; |
|
56 | - |
|
57 | - /** |
|
58 | - * @var string $sort |
|
59 | - */ |
|
60 | - private $sort; |
|
61 | - |
|
62 | - /** |
|
63 | - * @var boolean $show_title |
|
64 | - */ |
|
65 | - private $show_title = true; |
|
66 | - |
|
67 | - |
|
68 | - |
|
69 | - /** |
|
70 | - * EE_Event_List_Query Constructor * |
|
71 | - * |
|
72 | - * @param array $args |
|
73 | - */ |
|
74 | - public function __construct($args = array()) |
|
75 | - { |
|
76 | - $args = $this->parseArgs((array)$args); |
|
77 | - $this->setupEventQueryHelper(); |
|
78 | - $this->setupFilters(); |
|
79 | - $args = $this->getQueryArgs($args); |
|
80 | - // run the query |
|
81 | - parent::__construct($args); |
|
82 | - } |
|
83 | - |
|
84 | - |
|
85 | - |
|
86 | - /** |
|
87 | - * @param array $args |
|
88 | - * @return array |
|
89 | - */ |
|
90 | - private function parseArgs(array $args) |
|
91 | - { |
|
92 | - // incoming args could be a mix of WP query args + EE shortcode args |
|
93 | - foreach ($args as $property => $value) { |
|
94 | - // if the arg is a property of this class, then it's an EE shortcode arg |
|
95 | - if (property_exists($this, $property) && ! property_exists('WP_Query', $property)) { |
|
96 | - // set the property value |
|
97 | - $this->{$property} = $value; |
|
98 | - // then remove it from the array of args that will later be passed to WP_Query() |
|
99 | - unset($args[$property]); |
|
100 | - } |
|
101 | - } |
|
102 | - return $args; |
|
103 | - } |
|
104 | - |
|
105 | - |
|
106 | - |
|
107 | - private function setupEventQueryHelper() |
|
108 | - { |
|
109 | - //add query filters |
|
110 | - EEH_Event_Query::add_query_filters(); |
|
111 | - // set params that will get used by the filters |
|
112 | - EEH_Event_Query::set_query_params( |
|
113 | - $this->month, |
|
114 | - $this->category_slug, |
|
115 | - $this->show_expired, |
|
116 | - $this->order_by, |
|
117 | - $this->sort |
|
118 | - ); |
|
119 | - } |
|
120 | - |
|
121 | - |
|
122 | - |
|
123 | - private function setupFilters() |
|
124 | - { |
|
125 | - // first off, let's remove any filters from previous queries |
|
126 | - remove_filter( |
|
127 | - 'FHEE__archive_espresso_events_template__show_header', |
|
128 | - array($this, 'show_event_list_title') |
|
129 | - ); |
|
130 | - remove_filter( |
|
131 | - 'FHEE__archive_espresso_events_template__upcoming_events_h1', |
|
132 | - array($this, 'event_list_title') |
|
133 | - ); |
|
134 | - remove_all_filters('FHEE__content_espresso_events__event_class'); |
|
135 | - // Event List Title ? |
|
136 | - add_filter( |
|
137 | - 'FHEE__archive_espresso_events_template__show_header', |
|
138 | - array($this, 'show_event_list_title') |
|
139 | - ); |
|
140 | - add_filter( |
|
141 | - 'FHEE__archive_espresso_events_template__upcoming_events_h1', |
|
142 | - array($this, 'event_list_title'), |
|
143 | - 10, |
|
144 | - 1 |
|
145 | - ); |
|
146 | - // add the css class |
|
147 | - add_filter( |
|
148 | - 'FHEE__content_espresso_events__event_class', |
|
149 | - array($this, 'event_list_css'), |
|
150 | - 10, |
|
151 | - 1 |
|
152 | - ); |
|
153 | - } |
|
154 | - |
|
155 | - |
|
156 | - |
|
157 | - private function getQueryArgs(array $args) |
|
158 | - { |
|
159 | - // the current "page" we are viewing |
|
160 | - $paged = max(1, get_query_var('paged')); |
|
161 | - // Force these args |
|
162 | - return array_merge( |
|
163 | - $args, |
|
164 | - array( |
|
165 | - 'post_type' => 'espresso_events', |
|
166 | - 'posts_per_page' => $this->limit, |
|
167 | - 'update_post_term_cache' => false, |
|
168 | - 'update_post_meta_cache' => false, |
|
169 | - 'paged' => $paged, |
|
170 | - 'offset' => ($paged - 1) * $this->limit, |
|
171 | - ) |
|
172 | - ); |
|
173 | - } |
|
174 | - |
|
175 | - |
|
176 | - |
|
177 | - /** |
|
178 | - * show_event_list_title |
|
179 | - * |
|
180 | - * @return boolean |
|
181 | - */ |
|
182 | - public function show_event_list_title() |
|
183 | - { |
|
184 | - return filter_var( |
|
185 | - $this->show_title, |
|
186 | - FILTER_VALIDATE_BOOLEAN |
|
187 | - ); |
|
188 | - } |
|
189 | - |
|
190 | - |
|
191 | - |
|
192 | - /** |
|
193 | - * callback for FHEE__archive_espresso_events_template__upcoming_events_h1 filter |
|
194 | - * |
|
195 | - * @param string $event_list_title |
|
196 | - * @return string |
|
197 | - */ |
|
198 | - public function event_list_title($event_list_title = '') |
|
199 | - { |
|
200 | - if ( ! empty($this->title)) { |
|
201 | - return $this->title; |
|
202 | - } |
|
203 | - return $event_list_title; |
|
204 | - } |
|
205 | - |
|
206 | - |
|
207 | - |
|
208 | - /** |
|
209 | - * callback for FHEE__content_espresso_events__event_class filter |
|
210 | - * |
|
211 | - * @param string $event_list_css |
|
212 | - * @return string |
|
213 | - */ |
|
214 | - public function event_list_css($event_list_css = '') |
|
215 | - { |
|
216 | - $event_list_css .= ! empty($event_list_css) ? ' ' : ''; |
|
217 | - $event_list_css .= ! empty($this->css_class) ? $this->css_class : ''; |
|
218 | - $event_list_css .= ! empty($event_list_css) ? ' ' : ''; |
|
219 | - $event_list_css .= ! empty($this->category_slug) ? $this->category_slug : ''; |
|
220 | - return $event_list_css; |
|
221 | - } |
|
22 | + /** |
|
23 | + * @var string $title |
|
24 | + */ |
|
25 | + private $title; |
|
26 | + |
|
27 | + /** |
|
28 | + * @var integer $limit |
|
29 | + */ |
|
30 | + private $limit = 10; |
|
31 | + |
|
32 | + /** |
|
33 | + * @var string $css_class |
|
34 | + */ |
|
35 | + private $css_class; |
|
36 | + |
|
37 | + /** |
|
38 | + * @var boolean $show_expired |
|
39 | + */ |
|
40 | + private $show_expired = false; |
|
41 | + |
|
42 | + /** |
|
43 | + * @var string $month |
|
44 | + */ |
|
45 | + private $month; |
|
46 | + |
|
47 | + /** |
|
48 | + * @var string $category_slug |
|
49 | + */ |
|
50 | + private $category_slug; |
|
51 | + |
|
52 | + /** |
|
53 | + * @var string $order_by |
|
54 | + */ |
|
55 | + private $order_by; |
|
56 | + |
|
57 | + /** |
|
58 | + * @var string $sort |
|
59 | + */ |
|
60 | + private $sort; |
|
61 | + |
|
62 | + /** |
|
63 | + * @var boolean $show_title |
|
64 | + */ |
|
65 | + private $show_title = true; |
|
66 | + |
|
67 | + |
|
68 | + |
|
69 | + /** |
|
70 | + * EE_Event_List_Query Constructor * |
|
71 | + * |
|
72 | + * @param array $args |
|
73 | + */ |
|
74 | + public function __construct($args = array()) |
|
75 | + { |
|
76 | + $args = $this->parseArgs((array)$args); |
|
77 | + $this->setupEventQueryHelper(); |
|
78 | + $this->setupFilters(); |
|
79 | + $args = $this->getQueryArgs($args); |
|
80 | + // run the query |
|
81 | + parent::__construct($args); |
|
82 | + } |
|
83 | + |
|
84 | + |
|
85 | + |
|
86 | + /** |
|
87 | + * @param array $args |
|
88 | + * @return array |
|
89 | + */ |
|
90 | + private function parseArgs(array $args) |
|
91 | + { |
|
92 | + // incoming args could be a mix of WP query args + EE shortcode args |
|
93 | + foreach ($args as $property => $value) { |
|
94 | + // if the arg is a property of this class, then it's an EE shortcode arg |
|
95 | + if (property_exists($this, $property) && ! property_exists('WP_Query', $property)) { |
|
96 | + // set the property value |
|
97 | + $this->{$property} = $value; |
|
98 | + // then remove it from the array of args that will later be passed to WP_Query() |
|
99 | + unset($args[$property]); |
|
100 | + } |
|
101 | + } |
|
102 | + return $args; |
|
103 | + } |
|
104 | + |
|
105 | + |
|
106 | + |
|
107 | + private function setupEventQueryHelper() |
|
108 | + { |
|
109 | + //add query filters |
|
110 | + EEH_Event_Query::add_query_filters(); |
|
111 | + // set params that will get used by the filters |
|
112 | + EEH_Event_Query::set_query_params( |
|
113 | + $this->month, |
|
114 | + $this->category_slug, |
|
115 | + $this->show_expired, |
|
116 | + $this->order_by, |
|
117 | + $this->sort |
|
118 | + ); |
|
119 | + } |
|
120 | + |
|
121 | + |
|
122 | + |
|
123 | + private function setupFilters() |
|
124 | + { |
|
125 | + // first off, let's remove any filters from previous queries |
|
126 | + remove_filter( |
|
127 | + 'FHEE__archive_espresso_events_template__show_header', |
|
128 | + array($this, 'show_event_list_title') |
|
129 | + ); |
|
130 | + remove_filter( |
|
131 | + 'FHEE__archive_espresso_events_template__upcoming_events_h1', |
|
132 | + array($this, 'event_list_title') |
|
133 | + ); |
|
134 | + remove_all_filters('FHEE__content_espresso_events__event_class'); |
|
135 | + // Event List Title ? |
|
136 | + add_filter( |
|
137 | + 'FHEE__archive_espresso_events_template__show_header', |
|
138 | + array($this, 'show_event_list_title') |
|
139 | + ); |
|
140 | + add_filter( |
|
141 | + 'FHEE__archive_espresso_events_template__upcoming_events_h1', |
|
142 | + array($this, 'event_list_title'), |
|
143 | + 10, |
|
144 | + 1 |
|
145 | + ); |
|
146 | + // add the css class |
|
147 | + add_filter( |
|
148 | + 'FHEE__content_espresso_events__event_class', |
|
149 | + array($this, 'event_list_css'), |
|
150 | + 10, |
|
151 | + 1 |
|
152 | + ); |
|
153 | + } |
|
154 | + |
|
155 | + |
|
156 | + |
|
157 | + private function getQueryArgs(array $args) |
|
158 | + { |
|
159 | + // the current "page" we are viewing |
|
160 | + $paged = max(1, get_query_var('paged')); |
|
161 | + // Force these args |
|
162 | + return array_merge( |
|
163 | + $args, |
|
164 | + array( |
|
165 | + 'post_type' => 'espresso_events', |
|
166 | + 'posts_per_page' => $this->limit, |
|
167 | + 'update_post_term_cache' => false, |
|
168 | + 'update_post_meta_cache' => false, |
|
169 | + 'paged' => $paged, |
|
170 | + 'offset' => ($paged - 1) * $this->limit, |
|
171 | + ) |
|
172 | + ); |
|
173 | + } |
|
174 | + |
|
175 | + |
|
176 | + |
|
177 | + /** |
|
178 | + * show_event_list_title |
|
179 | + * |
|
180 | + * @return boolean |
|
181 | + */ |
|
182 | + public function show_event_list_title() |
|
183 | + { |
|
184 | + return filter_var( |
|
185 | + $this->show_title, |
|
186 | + FILTER_VALIDATE_BOOLEAN |
|
187 | + ); |
|
188 | + } |
|
189 | + |
|
190 | + |
|
191 | + |
|
192 | + /** |
|
193 | + * callback for FHEE__archive_espresso_events_template__upcoming_events_h1 filter |
|
194 | + * |
|
195 | + * @param string $event_list_title |
|
196 | + * @return string |
|
197 | + */ |
|
198 | + public function event_list_title($event_list_title = '') |
|
199 | + { |
|
200 | + if ( ! empty($this->title)) { |
|
201 | + return $this->title; |
|
202 | + } |
|
203 | + return $event_list_title; |
|
204 | + } |
|
205 | + |
|
206 | + |
|
207 | + |
|
208 | + /** |
|
209 | + * callback for FHEE__content_espresso_events__event_class filter |
|
210 | + * |
|
211 | + * @param string $event_list_css |
|
212 | + * @return string |
|
213 | + */ |
|
214 | + public function event_list_css($event_list_css = '') |
|
215 | + { |
|
216 | + $event_list_css .= ! empty($event_list_css) ? ' ' : ''; |
|
217 | + $event_list_css .= ! empty($this->css_class) ? $this->css_class : ''; |
|
218 | + $event_list_css .= ! empty($event_list_css) ? ' ' : ''; |
|
219 | + $event_list_css .= ! empty($this->category_slug) ? $this->category_slug : ''; |
|
220 | + return $event_list_css; |
|
221 | + } |
|
222 | 222 | |
223 | 223 | } |
224 | 224 | // End of file EventListQuery.php |