@@ -102,10 +102,10 @@ discard block |
||
| 102 | 102 | ) |
| 103 | 103 | ); |
| 104 | 104 | foreach ($ticket_datetimes as $ticket_datetime) { |
| 105 | - if (! $ticket_datetime instanceof \EE_Datetime) { |
|
| 105 | + if ( ! $ticket_datetime instanceof \EE_Datetime) { |
|
| 106 | 106 | continue; |
| 107 | 107 | } |
| 108 | - $datetimes[ $ticket_datetime->ID() ] = $ticket_datetime; |
|
| 108 | + $datetimes[$ticket_datetime->ID()] = $ticket_datetime; |
|
| 109 | 109 | } |
| 110 | 110 | return $datetimes; |
| 111 | 111 | } |
@@ -118,16 +118,16 @@ discard block |
||
| 118 | 118 | */ |
| 119 | 119 | public function getTicketDatetimeClasses(\EE_Ticket $ticket) |
| 120 | 120 | { |
| 121 | - if (! $this->active) { |
|
| 121 | + if ( ! $this->active) { |
|
| 122 | 122 | return ''; |
| 123 | 123 | } |
| 124 | 124 | $ticket_datetimes = $this->getTicketDatetimes($ticket); |
| 125 | 125 | $classes = ''; |
| 126 | 126 | foreach ($this->datetimes as $datetime) { |
| 127 | - if (! $datetime instanceof \EE_Datetime || ! in_array($datetime, $ticket_datetimes, true)) { |
|
| 127 | + if ( ! $datetime instanceof \EE_Datetime || ! in_array($datetime, $ticket_datetimes, true)) { |
|
| 128 | 128 | continue; |
| 129 | 129 | } |
| 130 | - $classes .= ' ee-ticket-datetimes-' . $datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_'); |
|
| 130 | + $classes .= ' ee-ticket-datetimes-'.$datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_'); |
|
| 131 | 131 | } |
| 132 | 132 | return $classes; |
| 133 | 133 | } |
@@ -143,10 +143,10 @@ discard block |
||
| 143 | 143 | { |
| 144 | 144 | $datetime_options = array(); |
| 145 | 145 | foreach ($this->datetimes as $datetime) { |
| 146 | - if (! $datetime instanceof \EE_Datetime) { |
|
| 146 | + if ( ! $datetime instanceof \EE_Datetime) { |
|
| 147 | 147 | continue; |
| 148 | 148 | } |
| 149 | - $datetime_options[ $datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_') ] = |
|
| 149 | + $datetime_options[$datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_')] = |
|
| 150 | 150 | $datetime->date_and_time_range($date_format, $time_format, ' - '); |
| 151 | 151 | } |
| 152 | 152 | return $datetime_options; |
@@ -159,18 +159,18 @@ discard block |
||
| 159 | 159 | */ |
| 160 | 160 | public function getDatetimeSelector() |
| 161 | 161 | { |
| 162 | - if (! $this->active) { |
|
| 162 | + if ( ! $this->active) { |
|
| 163 | 163 | return ''; |
| 164 | 164 | } |
| 165 | 165 | $dropdown_selector = new \EE_Checkbox_Dropdown_Selector_Input( |
| 166 | 166 | $this->unique_dates, |
| 167 | 167 | array( |
| 168 | - 'html_id' => 'datetime-selector-' . $this->event->ID(), |
|
| 169 | - 'html_name' => 'datetime_selector_' . $this->event->ID(), |
|
| 168 | + 'html_id' => 'datetime-selector-'.$this->event->ID(), |
|
| 169 | + 'html_name' => 'datetime_selector_'.$this->event->ID(), |
|
| 170 | 170 | 'html_class' => 'datetime-selector', |
| 171 | 171 | 'select_button_text' => '<span class="dashicons dashicons-calendar-alt"></span> ' |
| 172 | 172 | . esc_html__('Filter by Date', 'event_espresso'), |
| 173 | - 'other_html_attributes' => ' data-tkt_slctr_evt="' . $this->event->ID() . '"', |
|
| 173 | + 'other_html_attributes' => ' data-tkt_slctr_evt="'.$this->event->ID().'"', |
|
| 174 | 174 | ) |
| 175 | 175 | ); |
| 176 | 176 | return \EEH_HTML::div( |
@@ -11,171 +11,171 @@ |
||
| 11 | 11 | */ |
| 12 | 12 | class DatetimeSelector |
| 13 | 13 | { |
| 14 | - /** |
|
| 15 | - * @var \EE_Event $event |
|
| 16 | - */ |
|
| 17 | - protected $event; |
|
| 18 | - |
|
| 19 | - /** |
|
| 20 | - * @var \EE_Ticket[] $tickets |
|
| 21 | - */ |
|
| 22 | - protected $tickets; |
|
| 23 | - |
|
| 24 | - /** |
|
| 25 | - * @var \EE_Datetime[] $datetimes |
|
| 26 | - */ |
|
| 27 | - protected $datetimes; |
|
| 28 | - |
|
| 29 | - /** |
|
| 30 | - * @var \EE_Datetime[] $unique_dates |
|
| 31 | - */ |
|
| 32 | - protected $unique_dates; |
|
| 33 | - |
|
| 34 | - /** |
|
| 35 | - * @var \EE_Ticket_Selector_Config $template_settings |
|
| 36 | - */ |
|
| 37 | - protected $template_settings; |
|
| 38 | - |
|
| 39 | - /** |
|
| 40 | - * @var boolean $active |
|
| 41 | - */ |
|
| 42 | - protected $active = false; |
|
| 43 | - |
|
| 44 | - |
|
| 45 | - /** |
|
| 46 | - * DatetimeSelector constructor. |
|
| 47 | - * |
|
| 48 | - * @param \EE_Event $event |
|
| 49 | - * @param \EE_Ticket[] $tickets |
|
| 50 | - * @param \EE_Ticket_Selector_Config $template_settings |
|
| 51 | - * @param string $date_format |
|
| 52 | - * @param string $time_format |
|
| 53 | - * @throws \EE_Error |
|
| 54 | - */ |
|
| 55 | - public function __construct( |
|
| 56 | - \EE_Event $event, |
|
| 57 | - array $tickets, |
|
| 58 | - \EE_Ticket_Selector_Config $template_settings, |
|
| 59 | - $date_format = 'Y-m-d', |
|
| 60 | - $time_format = 'g:i a' |
|
| 61 | - ) { |
|
| 62 | - $this->event = $event; |
|
| 63 | - $this->tickets = $tickets; |
|
| 64 | - $this->template_settings = $template_settings; |
|
| 65 | - $this->datetimes = $this->getAllDatetimesForAllTicket($tickets); |
|
| 66 | - $this->unique_dates = $this->getUniqueDatetimeOptions($date_format, $time_format); |
|
| 67 | - $this->active = $this->template_settings->showDatetimeSelector($this->unique_dates); |
|
| 68 | - } |
|
| 69 | - |
|
| 70 | - |
|
| 71 | - /** |
|
| 72 | - * @param \EE_Ticket[] $tickets |
|
| 73 | - * @return array |
|
| 74 | - * @throws \EE_Error |
|
| 75 | - */ |
|
| 76 | - protected function getAllDatetimesForAllTicket($tickets = array()) |
|
| 77 | - { |
|
| 78 | - $datetimes = array(); |
|
| 79 | - foreach ($tickets as $ticket) { |
|
| 80 | - $datetimes = $this->getTicketDatetimes($ticket, $datetimes); |
|
| 81 | - } |
|
| 82 | - return $datetimes; |
|
| 83 | - } |
|
| 84 | - |
|
| 85 | - |
|
| 86 | - /** |
|
| 87 | - * @param \EE_Ticket $ticket |
|
| 88 | - * @param \EE_Datetime[] $datetimes |
|
| 89 | - * @return \EE_Datetime[] |
|
| 90 | - * @throws \EE_Error |
|
| 91 | - */ |
|
| 92 | - protected function getTicketDatetimes(\EE_Ticket $ticket, $datetimes = array()) |
|
| 93 | - { |
|
| 94 | - $ticket_datetimes = $ticket->datetimes( |
|
| 95 | - array( |
|
| 96 | - 'order_by' => array( |
|
| 97 | - 'DTT_order' => 'ASC', |
|
| 98 | - 'DTT_EVT_start' => 'ASC', |
|
| 99 | - ), |
|
| 100 | - 'default_where_conditions' => 'none', |
|
| 101 | - ) |
|
| 102 | - ); |
|
| 103 | - foreach ($ticket_datetimes as $ticket_datetime) { |
|
| 104 | - if (! $ticket_datetime instanceof \EE_Datetime) { |
|
| 105 | - continue; |
|
| 106 | - } |
|
| 107 | - $datetimes[ $ticket_datetime->ID() ] = $ticket_datetime; |
|
| 108 | - } |
|
| 109 | - return $datetimes; |
|
| 110 | - } |
|
| 111 | - |
|
| 112 | - |
|
| 113 | - /** |
|
| 114 | - * @param \EE_Ticket $ticket |
|
| 115 | - * @return string |
|
| 116 | - * @throws \EE_Error |
|
| 117 | - */ |
|
| 118 | - public function getTicketDatetimeClasses(\EE_Ticket $ticket) |
|
| 119 | - { |
|
| 120 | - if (! $this->active) { |
|
| 121 | - return ''; |
|
| 122 | - } |
|
| 123 | - $ticket_datetimes = $this->getTicketDatetimes($ticket); |
|
| 124 | - $classes = ''; |
|
| 125 | - foreach ($this->datetimes as $datetime) { |
|
| 126 | - if (! $datetime instanceof \EE_Datetime || ! in_array($datetime, $ticket_datetimes, true)) { |
|
| 127 | - continue; |
|
| 128 | - } |
|
| 129 | - $classes .= ' ee-ticket-datetimes-' . $datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_'); |
|
| 130 | - } |
|
| 131 | - return $classes; |
|
| 132 | - } |
|
| 133 | - |
|
| 134 | - |
|
| 135 | - /** |
|
| 136 | - * @param string $date_format |
|
| 137 | - * @param string $time_format |
|
| 138 | - * @return array |
|
| 139 | - * @throws \EE_Error |
|
| 140 | - */ |
|
| 141 | - public function getUniqueDatetimeOptions($date_format = 'Y-m-d', $time_format = 'g:i a') |
|
| 142 | - { |
|
| 143 | - $datetime_options = array(); |
|
| 144 | - foreach ($this->datetimes as $datetime) { |
|
| 145 | - if (! $datetime instanceof \EE_Datetime) { |
|
| 146 | - continue; |
|
| 147 | - } |
|
| 148 | - $datetime_options[ $datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_') ] = |
|
| 149 | - $datetime->date_and_time_range($date_format, $time_format, ' - '); |
|
| 150 | - } |
|
| 151 | - return $datetime_options; |
|
| 152 | - } |
|
| 153 | - |
|
| 154 | - |
|
| 155 | - /** |
|
| 156 | - * @return string |
|
| 157 | - * @throws \EE_Error |
|
| 158 | - */ |
|
| 159 | - public function getDatetimeSelector() |
|
| 160 | - { |
|
| 161 | - if (! $this->active) { |
|
| 162 | - return ''; |
|
| 163 | - } |
|
| 164 | - $dropdown_selector = new \EE_Checkbox_Dropdown_Selector_Input( |
|
| 165 | - $this->unique_dates, |
|
| 166 | - array( |
|
| 167 | - 'html_id' => 'datetime-selector-' . $this->event->ID(), |
|
| 168 | - 'html_name' => 'datetime_selector_' . $this->event->ID(), |
|
| 169 | - 'html_class' => 'datetime-selector', |
|
| 170 | - 'select_button_text' => '<span class="dashicons dashicons-calendar-alt"></span> ' |
|
| 171 | - . esc_html__('Filter by Date', 'event_espresso'), |
|
| 172 | - 'other_html_attributes' => ' data-tkt_slctr_evt="' . $this->event->ID() . '"', |
|
| 173 | - ) |
|
| 174 | - ); |
|
| 175 | - return \EEH_HTML::div( |
|
| 176 | - $dropdown_selector->get_html_for_input(), |
|
| 177 | - '', |
|
| 178 | - 'datetime_selector-dv' |
|
| 179 | - ); |
|
| 180 | - } |
|
| 14 | + /** |
|
| 15 | + * @var \EE_Event $event |
|
| 16 | + */ |
|
| 17 | + protected $event; |
|
| 18 | + |
|
| 19 | + /** |
|
| 20 | + * @var \EE_Ticket[] $tickets |
|
| 21 | + */ |
|
| 22 | + protected $tickets; |
|
| 23 | + |
|
| 24 | + /** |
|
| 25 | + * @var \EE_Datetime[] $datetimes |
|
| 26 | + */ |
|
| 27 | + protected $datetimes; |
|
| 28 | + |
|
| 29 | + /** |
|
| 30 | + * @var \EE_Datetime[] $unique_dates |
|
| 31 | + */ |
|
| 32 | + protected $unique_dates; |
|
| 33 | + |
|
| 34 | + /** |
|
| 35 | + * @var \EE_Ticket_Selector_Config $template_settings |
|
| 36 | + */ |
|
| 37 | + protected $template_settings; |
|
| 38 | + |
|
| 39 | + /** |
|
| 40 | + * @var boolean $active |
|
| 41 | + */ |
|
| 42 | + protected $active = false; |
|
| 43 | + |
|
| 44 | + |
|
| 45 | + /** |
|
| 46 | + * DatetimeSelector constructor. |
|
| 47 | + * |
|
| 48 | + * @param \EE_Event $event |
|
| 49 | + * @param \EE_Ticket[] $tickets |
|
| 50 | + * @param \EE_Ticket_Selector_Config $template_settings |
|
| 51 | + * @param string $date_format |
|
| 52 | + * @param string $time_format |
|
| 53 | + * @throws \EE_Error |
|
| 54 | + */ |
|
| 55 | + public function __construct( |
|
| 56 | + \EE_Event $event, |
|
| 57 | + array $tickets, |
|
| 58 | + \EE_Ticket_Selector_Config $template_settings, |
|
| 59 | + $date_format = 'Y-m-d', |
|
| 60 | + $time_format = 'g:i a' |
|
| 61 | + ) { |
|
| 62 | + $this->event = $event; |
|
| 63 | + $this->tickets = $tickets; |
|
| 64 | + $this->template_settings = $template_settings; |
|
| 65 | + $this->datetimes = $this->getAllDatetimesForAllTicket($tickets); |
|
| 66 | + $this->unique_dates = $this->getUniqueDatetimeOptions($date_format, $time_format); |
|
| 67 | + $this->active = $this->template_settings->showDatetimeSelector($this->unique_dates); |
|
| 68 | + } |
|
| 69 | + |
|
| 70 | + |
|
| 71 | + /** |
|
| 72 | + * @param \EE_Ticket[] $tickets |
|
| 73 | + * @return array |
|
| 74 | + * @throws \EE_Error |
|
| 75 | + */ |
|
| 76 | + protected function getAllDatetimesForAllTicket($tickets = array()) |
|
| 77 | + { |
|
| 78 | + $datetimes = array(); |
|
| 79 | + foreach ($tickets as $ticket) { |
|
| 80 | + $datetimes = $this->getTicketDatetimes($ticket, $datetimes); |
|
| 81 | + } |
|
| 82 | + return $datetimes; |
|
| 83 | + } |
|
| 84 | + |
|
| 85 | + |
|
| 86 | + /** |
|
| 87 | + * @param \EE_Ticket $ticket |
|
| 88 | + * @param \EE_Datetime[] $datetimes |
|
| 89 | + * @return \EE_Datetime[] |
|
| 90 | + * @throws \EE_Error |
|
| 91 | + */ |
|
| 92 | + protected function getTicketDatetimes(\EE_Ticket $ticket, $datetimes = array()) |
|
| 93 | + { |
|
| 94 | + $ticket_datetimes = $ticket->datetimes( |
|
| 95 | + array( |
|
| 96 | + 'order_by' => array( |
|
| 97 | + 'DTT_order' => 'ASC', |
|
| 98 | + 'DTT_EVT_start' => 'ASC', |
|
| 99 | + ), |
|
| 100 | + 'default_where_conditions' => 'none', |
|
| 101 | + ) |
|
| 102 | + ); |
|
| 103 | + foreach ($ticket_datetimes as $ticket_datetime) { |
|
| 104 | + if (! $ticket_datetime instanceof \EE_Datetime) { |
|
| 105 | + continue; |
|
| 106 | + } |
|
| 107 | + $datetimes[ $ticket_datetime->ID() ] = $ticket_datetime; |
|
| 108 | + } |
|
| 109 | + return $datetimes; |
|
| 110 | + } |
|
| 111 | + |
|
| 112 | + |
|
| 113 | + /** |
|
| 114 | + * @param \EE_Ticket $ticket |
|
| 115 | + * @return string |
|
| 116 | + * @throws \EE_Error |
|
| 117 | + */ |
|
| 118 | + public function getTicketDatetimeClasses(\EE_Ticket $ticket) |
|
| 119 | + { |
|
| 120 | + if (! $this->active) { |
|
| 121 | + return ''; |
|
| 122 | + } |
|
| 123 | + $ticket_datetimes = $this->getTicketDatetimes($ticket); |
|
| 124 | + $classes = ''; |
|
| 125 | + foreach ($this->datetimes as $datetime) { |
|
| 126 | + if (! $datetime instanceof \EE_Datetime || ! in_array($datetime, $ticket_datetimes, true)) { |
|
| 127 | + continue; |
|
| 128 | + } |
|
| 129 | + $classes .= ' ee-ticket-datetimes-' . $datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_'); |
|
| 130 | + } |
|
| 131 | + return $classes; |
|
| 132 | + } |
|
| 133 | + |
|
| 134 | + |
|
| 135 | + /** |
|
| 136 | + * @param string $date_format |
|
| 137 | + * @param string $time_format |
|
| 138 | + * @return array |
|
| 139 | + * @throws \EE_Error |
|
| 140 | + */ |
|
| 141 | + public function getUniqueDatetimeOptions($date_format = 'Y-m-d', $time_format = 'g:i a') |
|
| 142 | + { |
|
| 143 | + $datetime_options = array(); |
|
| 144 | + foreach ($this->datetimes as $datetime) { |
|
| 145 | + if (! $datetime instanceof \EE_Datetime) { |
|
| 146 | + continue; |
|
| 147 | + } |
|
| 148 | + $datetime_options[ $datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_') ] = |
|
| 149 | + $datetime->date_and_time_range($date_format, $time_format, ' - '); |
|
| 150 | + } |
|
| 151 | + return $datetime_options; |
|
| 152 | + } |
|
| 153 | + |
|
| 154 | + |
|
| 155 | + /** |
|
| 156 | + * @return string |
|
| 157 | + * @throws \EE_Error |
|
| 158 | + */ |
|
| 159 | + public function getDatetimeSelector() |
|
| 160 | + { |
|
| 161 | + if (! $this->active) { |
|
| 162 | + return ''; |
|
| 163 | + } |
|
| 164 | + $dropdown_selector = new \EE_Checkbox_Dropdown_Selector_Input( |
|
| 165 | + $this->unique_dates, |
|
| 166 | + array( |
|
| 167 | + 'html_id' => 'datetime-selector-' . $this->event->ID(), |
|
| 168 | + 'html_name' => 'datetime_selector_' . $this->event->ID(), |
|
| 169 | + 'html_class' => 'datetime-selector', |
|
| 170 | + 'select_button_text' => '<span class="dashicons dashicons-calendar-alt"></span> ' |
|
| 171 | + . esc_html__('Filter by Date', 'event_espresso'), |
|
| 172 | + 'other_html_attributes' => ' data-tkt_slctr_evt="' . $this->event->ID() . '"', |
|
| 173 | + ) |
|
| 174 | + ); |
|
| 175 | + return \EEH_HTML::div( |
|
| 176 | + $dropdown_selector->get_html_for_input(), |
|
| 177 | + '', |
|
| 178 | + 'datetime_selector-dv' |
|
| 179 | + ); |
|
| 180 | + } |
|
| 181 | 181 | } |
@@ -28,74 +28,74 @@ |
||
| 28 | 28 | */ |
| 29 | 29 | class Response |
| 30 | 30 | { |
| 31 | - /** |
|
| 32 | - * Succes or failure. |
|
| 33 | - * |
|
| 34 | - * @var boolean |
|
| 35 | - */ |
|
| 36 | - private $success = false; |
|
| 31 | + /** |
|
| 32 | + * Succes or failure. |
|
| 33 | + * |
|
| 34 | + * @var boolean |
|
| 35 | + */ |
|
| 36 | + private $success = false; |
|
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * Error code strings. |
|
| 40 | - * |
|
| 41 | - * @var array |
|
| 42 | - */ |
|
| 43 | - private $errorCodes = array(); |
|
| 38 | + /** |
|
| 39 | + * Error code strings. |
|
| 40 | + * |
|
| 41 | + * @var array |
|
| 42 | + */ |
|
| 43 | + private $errorCodes = array(); |
|
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * Build the response from the expected JSON returned by the service. |
|
| 47 | - * |
|
| 48 | - * @param string $json |
|
| 49 | - * @return \ReCaptcha\Response |
|
| 50 | - */ |
|
| 51 | - public static function fromJson($json) |
|
| 52 | - { |
|
| 53 | - $responseData = json_decode($json, true); |
|
| 45 | + /** |
|
| 46 | + * Build the response from the expected JSON returned by the service. |
|
| 47 | + * |
|
| 48 | + * @param string $json |
|
| 49 | + * @return \ReCaptcha\Response |
|
| 50 | + */ |
|
| 51 | + public static function fromJson($json) |
|
| 52 | + { |
|
| 53 | + $responseData = json_decode($json, true); |
|
| 54 | 54 | |
| 55 | - if (! $responseData) { |
|
| 56 | - return new Response(false, array('invalid-json')); |
|
| 57 | - } |
|
| 55 | + if (! $responseData) { |
|
| 56 | + return new Response(false, array('invalid-json')); |
|
| 57 | + } |
|
| 58 | 58 | |
| 59 | - if (isset($responseData['success']) && $responseData['success'] == true) { |
|
| 60 | - return new Response(true); |
|
| 61 | - } |
|
| 59 | + if (isset($responseData['success']) && $responseData['success'] == true) { |
|
| 60 | + return new Response(true); |
|
| 61 | + } |
|
| 62 | 62 | |
| 63 | - if (isset($responseData['error-codes']) && is_array($responseData['error-codes'])) { |
|
| 64 | - return new Response(false, $responseData['error-codes']); |
|
| 65 | - } |
|
| 63 | + if (isset($responseData['error-codes']) && is_array($responseData['error-codes'])) { |
|
| 64 | + return new Response(false, $responseData['error-codes']); |
|
| 65 | + } |
|
| 66 | 66 | |
| 67 | - return new Response(false); |
|
| 68 | - } |
|
| 67 | + return new Response(false); |
|
| 68 | + } |
|
| 69 | 69 | |
| 70 | - /** |
|
| 71 | - * Constructor. |
|
| 72 | - * |
|
| 73 | - * @param boolean $success |
|
| 74 | - * @param array $errorCodes |
|
| 75 | - */ |
|
| 76 | - public function __construct($success, array $errorCodes = array()) |
|
| 77 | - { |
|
| 78 | - $this->success = $success; |
|
| 79 | - $this->errorCodes = $errorCodes; |
|
| 80 | - } |
|
| 70 | + /** |
|
| 71 | + * Constructor. |
|
| 72 | + * |
|
| 73 | + * @param boolean $success |
|
| 74 | + * @param array $errorCodes |
|
| 75 | + */ |
|
| 76 | + public function __construct($success, array $errorCodes = array()) |
|
| 77 | + { |
|
| 78 | + $this->success = $success; |
|
| 79 | + $this->errorCodes = $errorCodes; |
|
| 80 | + } |
|
| 81 | 81 | |
| 82 | - /** |
|
| 83 | - * Is success? |
|
| 84 | - * |
|
| 85 | - * @return boolean |
|
| 86 | - */ |
|
| 87 | - public function isSuccess() |
|
| 88 | - { |
|
| 89 | - return $this->success; |
|
| 90 | - } |
|
| 82 | + /** |
|
| 83 | + * Is success? |
|
| 84 | + * |
|
| 85 | + * @return boolean |
|
| 86 | + */ |
|
| 87 | + public function isSuccess() |
|
| 88 | + { |
|
| 89 | + return $this->success; |
|
| 90 | + } |
|
| 91 | 91 | |
| 92 | - /** |
|
| 93 | - * Get error codes. |
|
| 94 | - * |
|
| 95 | - * @return array |
|
| 96 | - */ |
|
| 97 | - public function getErrorCodes() |
|
| 98 | - { |
|
| 99 | - return $this->errorCodes; |
|
| 100 | - } |
|
| 92 | + /** |
|
| 93 | + * Get error codes. |
|
| 94 | + * |
|
| 95 | + * @return array |
|
| 96 | + */ |
|
| 97 | + public function getErrorCodes() |
|
| 98 | + { |
|
| 99 | + return $this->errorCodes; |
|
| 100 | + } |
|
| 101 | 101 | } |
@@ -52,7 +52,7 @@ |
||
| 52 | 52 | { |
| 53 | 53 | $responseData = json_decode($json, true); |
| 54 | 54 | |
| 55 | - if (! $responseData) { |
|
| 55 | + if ( ! $responseData) { |
|
| 56 | 56 | return new Response(false, array('invalid-json')); |
| 57 | 57 | } |
| 58 | 58 | |
@@ -56,7 +56,7 @@ discard block |
||
| 56 | 56 | { |
| 57 | 57 | $post_related_cache = get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array()); |
| 58 | 58 | // verify that cached data was not truncated or corrupted and no longer an array |
| 59 | - if (! is_array($post_related_cache)) { |
|
| 59 | + if ( ! is_array($post_related_cache)) { |
|
| 60 | 60 | // uh-oh... let's get rid of any transients using our cache prefix |
| 61 | 61 | $this->clear(PostRelatedCacheManager::CACHE_PREFIX); |
| 62 | 62 | // then update the post related cache tracking option |
@@ -94,13 +94,13 @@ discard block |
||
| 94 | 94 | { |
| 95 | 95 | $post_related_cache = $this->getPostRelatedCache(); |
| 96 | 96 | // if post is not already being tracked |
| 97 | - if (! isset($post_related_cache[ $post_ID ])) { |
|
| 97 | + if ( ! isset($post_related_cache[$post_ID])) { |
|
| 98 | 98 | // add array to add cache ids to |
| 99 | - $post_related_cache[ $post_ID ] = array(); |
|
| 99 | + $post_related_cache[$post_ID] = array(); |
|
| 100 | 100 | } |
| 101 | - if (! in_array($id_prefix, $post_related_cache[ $post_ID ], true)) { |
|
| 101 | + if ( ! in_array($id_prefix, $post_related_cache[$post_ID], true)) { |
|
| 102 | 102 | // add cache id to be tracked |
| 103 | - $post_related_cache[ $post_ID ][] = $id_prefix; |
|
| 103 | + $post_related_cache[$post_ID][] = $id_prefix; |
|
| 104 | 104 | $this->updatePostRelatedCache($post_related_cache); |
| 105 | 105 | } |
| 106 | 106 | } |
@@ -116,18 +116,18 @@ discard block |
||
| 116 | 116 | { |
| 117 | 117 | $post_related_cache = $this->getPostRelatedCache(); |
| 118 | 118 | // if post is not being tracked |
| 119 | - if (! isset($post_related_cache[ $post_ID ])) { |
|
| 119 | + if ( ! isset($post_related_cache[$post_ID])) { |
|
| 120 | 120 | // let's clean up some of the duplicate IDs that were getting added |
| 121 | 121 | foreach ($post_related_cache as $other_post_ID => $cache_IDs) { |
| 122 | 122 | // remove duplicates |
| 123 | - $post_related_cache[ $other_post_ID ] = array_unique($post_related_cache[ $other_post_ID ]); |
|
| 123 | + $post_related_cache[$other_post_ID] = array_unique($post_related_cache[$other_post_ID]); |
|
| 124 | 124 | } |
| 125 | 125 | $this->updatePostRelatedCache($post_related_cache); |
| 126 | 126 | return; |
| 127 | 127 | } |
| 128 | 128 | // get cache id prefixes for post, and delete their corresponding transients |
| 129 | - $this->clear($post_related_cache[ $post_ID ]); |
|
| 130 | - unset($post_related_cache[ $post_ID ]); |
|
| 129 | + $this->clear($post_related_cache[$post_ID]); |
|
| 130 | + unset($post_related_cache[$post_ID]); |
|
| 131 | 131 | $this->updatePostRelatedCache($post_related_cache); |
| 132 | 132 | } |
| 133 | 133 | } |
@@ -12,121 +12,121 @@ |
||
| 12 | 12 | */ |
| 13 | 13 | class PostRelatedCacheManager extends BasicCacheManager |
| 14 | 14 | { |
| 15 | - /** |
|
| 16 | - * @type string |
|
| 17 | - */ |
|
| 18 | - const POST_CACHE_PREFIX = 'ee_cache_post_'; |
|
| 15 | + /** |
|
| 16 | + * @type string |
|
| 17 | + */ |
|
| 18 | + const POST_CACHE_PREFIX = 'ee_cache_post_'; |
|
| 19 | 19 | |
| 20 | - /** |
|
| 21 | - * wp-option option_name for tracking post related cache |
|
| 22 | - * |
|
| 23 | - * @type string |
|
| 24 | - */ |
|
| 25 | - const POST_CACHE_OPTIONS_KEY = 'ee_post_cache'; |
|
| 20 | + /** |
|
| 21 | + * wp-option option_name for tracking post related cache |
|
| 22 | + * |
|
| 23 | + * @type string |
|
| 24 | + */ |
|
| 25 | + const POST_CACHE_OPTIONS_KEY = 'ee_post_cache'; |
|
| 26 | 26 | |
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * PostRelatedCacheManager constructor. |
|
| 30 | - * |
|
| 31 | - * @param CacheStorageInterface $cache_storage |
|
| 32 | - */ |
|
| 33 | - public function __construct(CacheStorageInterface $cache_storage) |
|
| 34 | - { |
|
| 35 | - parent::__construct($cache_storage); |
|
| 36 | - add_action('save_post', array($this, 'clearPostRelatedCache')); |
|
| 37 | - } |
|
| 28 | + /** |
|
| 29 | + * PostRelatedCacheManager constructor. |
|
| 30 | + * |
|
| 31 | + * @param CacheStorageInterface $cache_storage |
|
| 32 | + */ |
|
| 33 | + public function __construct(CacheStorageInterface $cache_storage) |
|
| 34 | + { |
|
| 35 | + parent::__construct($cache_storage); |
|
| 36 | + add_action('save_post', array($this, 'clearPostRelatedCache')); |
|
| 37 | + } |
|
| 38 | 38 | |
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * returns a string that will be prepended to all cache identifiers |
|
| 42 | - * |
|
| 43 | - * @return string |
|
| 44 | - */ |
|
| 45 | - public function cachePrefix() |
|
| 46 | - { |
|
| 47 | - return PostRelatedCacheManager::POST_CACHE_PREFIX; |
|
| 48 | - } |
|
| 40 | + /** |
|
| 41 | + * returns a string that will be prepended to all cache identifiers |
|
| 42 | + * |
|
| 43 | + * @return string |
|
| 44 | + */ |
|
| 45 | + public function cachePrefix() |
|
| 46 | + { |
|
| 47 | + return PostRelatedCacheManager::POST_CACHE_PREFIX; |
|
| 48 | + } |
|
| 49 | 49 | |
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * @return array |
|
| 53 | - */ |
|
| 54 | - protected function getPostRelatedCache() |
|
| 55 | - { |
|
| 56 | - $post_related_cache = get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array()); |
|
| 57 | - // verify that cached data was not truncated or corrupted and no longer an array |
|
| 58 | - if (! is_array($post_related_cache)) { |
|
| 59 | - // uh-oh... let's get rid of any transients using our cache prefix |
|
| 60 | - $this->clear(PostRelatedCacheManager::CACHE_PREFIX); |
|
| 61 | - // then update the post related cache tracking option |
|
| 62 | - $post_related_cache = array(); |
|
| 63 | - $this->updatePostRelatedCache($post_related_cache); |
|
| 64 | - } |
|
| 65 | - return $post_related_cache; |
|
| 66 | - } |
|
| 51 | + /** |
|
| 52 | + * @return array |
|
| 53 | + */ |
|
| 54 | + protected function getPostRelatedCache() |
|
| 55 | + { |
|
| 56 | + $post_related_cache = get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array()); |
|
| 57 | + // verify that cached data was not truncated or corrupted and no longer an array |
|
| 58 | + if (! is_array($post_related_cache)) { |
|
| 59 | + // uh-oh... let's get rid of any transients using our cache prefix |
|
| 60 | + $this->clear(PostRelatedCacheManager::CACHE_PREFIX); |
|
| 61 | + // then update the post related cache tracking option |
|
| 62 | + $post_related_cache = array(); |
|
| 63 | + $this->updatePostRelatedCache($post_related_cache); |
|
| 64 | + } |
|
| 65 | + return $post_related_cache; |
|
| 66 | + } |
|
| 67 | 67 | |
| 68 | 68 | |
| 69 | - /** |
|
| 70 | - * @param array $post_related_cache |
|
| 71 | - */ |
|
| 72 | - protected function updatePostRelatedCache(array $post_related_cache = array()) |
|
| 73 | - { |
|
| 74 | - update_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, $post_related_cache); |
|
| 75 | - } |
|
| 69 | + /** |
|
| 70 | + * @param array $post_related_cache |
|
| 71 | + */ |
|
| 72 | + protected function updatePostRelatedCache(array $post_related_cache = array()) |
|
| 73 | + { |
|
| 74 | + update_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, $post_related_cache); |
|
| 75 | + } |
|
| 76 | 76 | |
| 77 | 77 | |
| 78 | - /** |
|
| 79 | - * If you are caching content that pertains to a Post of any type, |
|
| 80 | - * then it is recommended to pass the post id and cache id prefix to this method |
|
| 81 | - * so that it can be added to the post related cache tracking. |
|
| 82 | - * Then, whenever that post is updated, the cache will automatically be deleted, |
|
| 83 | - * which helps to ensure that outdated cache content will not be served |
|
| 84 | - * |
|
| 85 | - * @param int $post_ID [required] |
|
| 86 | - * @param string $id_prefix [required] Appended to all cache IDs. Can be helpful in finding specific cache types. |
|
| 87 | - * May also be helpful to include an additional specific identifier, |
|
| 88 | - * such as a post ID as part of the $id_prefix so that individual caches |
|
| 89 | - * can be found and/or cleared. ex: "venue-28", or "shortcode-156". |
|
| 90 | - * BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id. |
|
| 91 | - */ |
|
| 92 | - public function clearPostRelatedCacheOnUpdate($post_ID, $id_prefix) |
|
| 93 | - { |
|
| 94 | - $post_related_cache = $this->getPostRelatedCache(); |
|
| 95 | - // if post is not already being tracked |
|
| 96 | - if (! isset($post_related_cache[ $post_ID ])) { |
|
| 97 | - // add array to add cache ids to |
|
| 98 | - $post_related_cache[ $post_ID ] = array(); |
|
| 99 | - } |
|
| 100 | - if (! in_array($id_prefix, $post_related_cache[ $post_ID ], true)) { |
|
| 101 | - // add cache id to be tracked |
|
| 102 | - $post_related_cache[ $post_ID ][] = $id_prefix; |
|
| 103 | - $this->updatePostRelatedCache($post_related_cache); |
|
| 104 | - } |
|
| 105 | - } |
|
| 78 | + /** |
|
| 79 | + * If you are caching content that pertains to a Post of any type, |
|
| 80 | + * then it is recommended to pass the post id and cache id prefix to this method |
|
| 81 | + * so that it can be added to the post related cache tracking. |
|
| 82 | + * Then, whenever that post is updated, the cache will automatically be deleted, |
|
| 83 | + * which helps to ensure that outdated cache content will not be served |
|
| 84 | + * |
|
| 85 | + * @param int $post_ID [required] |
|
| 86 | + * @param string $id_prefix [required] Appended to all cache IDs. Can be helpful in finding specific cache types. |
|
| 87 | + * May also be helpful to include an additional specific identifier, |
|
| 88 | + * such as a post ID as part of the $id_prefix so that individual caches |
|
| 89 | + * can be found and/or cleared. ex: "venue-28", or "shortcode-156". |
|
| 90 | + * BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id. |
|
| 91 | + */ |
|
| 92 | + public function clearPostRelatedCacheOnUpdate($post_ID, $id_prefix) |
|
| 93 | + { |
|
| 94 | + $post_related_cache = $this->getPostRelatedCache(); |
|
| 95 | + // if post is not already being tracked |
|
| 96 | + if (! isset($post_related_cache[ $post_ID ])) { |
|
| 97 | + // add array to add cache ids to |
|
| 98 | + $post_related_cache[ $post_ID ] = array(); |
|
| 99 | + } |
|
| 100 | + if (! in_array($id_prefix, $post_related_cache[ $post_ID ], true)) { |
|
| 101 | + // add cache id to be tracked |
|
| 102 | + $post_related_cache[ $post_ID ][] = $id_prefix; |
|
| 103 | + $this->updatePostRelatedCache($post_related_cache); |
|
| 104 | + } |
|
| 105 | + } |
|
| 106 | 106 | |
| 107 | 107 | |
| 108 | - /** |
|
| 109 | - * callback hooked into the WordPress "save_post" action |
|
| 110 | - * deletes any cache content associated with the post |
|
| 111 | - * |
|
| 112 | - * @param int $post_ID [required] |
|
| 113 | - */ |
|
| 114 | - public function clearPostRelatedCache($post_ID) |
|
| 115 | - { |
|
| 116 | - $post_related_cache = $this->getPostRelatedCache(); |
|
| 117 | - // if post is not being tracked |
|
| 118 | - if (! isset($post_related_cache[ $post_ID ])) { |
|
| 119 | - // let's clean up some of the duplicate IDs that were getting added |
|
| 120 | - foreach ($post_related_cache as $other_post_ID => $cache_IDs) { |
|
| 121 | - // remove duplicates |
|
| 122 | - $post_related_cache[ $other_post_ID ] = array_unique($post_related_cache[ $other_post_ID ]); |
|
| 123 | - } |
|
| 124 | - $this->updatePostRelatedCache($post_related_cache); |
|
| 125 | - return; |
|
| 126 | - } |
|
| 127 | - // get cache id prefixes for post, and delete their corresponding transients |
|
| 128 | - $this->clear($post_related_cache[ $post_ID ]); |
|
| 129 | - unset($post_related_cache[ $post_ID ]); |
|
| 130 | - $this->updatePostRelatedCache($post_related_cache); |
|
| 131 | - } |
|
| 108 | + /** |
|
| 109 | + * callback hooked into the WordPress "save_post" action |
|
| 110 | + * deletes any cache content associated with the post |
|
| 111 | + * |
|
| 112 | + * @param int $post_ID [required] |
|
| 113 | + */ |
|
| 114 | + public function clearPostRelatedCache($post_ID) |
|
| 115 | + { |
|
| 116 | + $post_related_cache = $this->getPostRelatedCache(); |
|
| 117 | + // if post is not being tracked |
|
| 118 | + if (! isset($post_related_cache[ $post_ID ])) { |
|
| 119 | + // let's clean up some of the duplicate IDs that were getting added |
|
| 120 | + foreach ($post_related_cache as $other_post_ID => $cache_IDs) { |
|
| 121 | + // remove duplicates |
|
| 122 | + $post_related_cache[ $other_post_ID ] = array_unique($post_related_cache[ $other_post_ID ]); |
|
| 123 | + } |
|
| 124 | + $this->updatePostRelatedCache($post_related_cache); |
|
| 125 | + return; |
|
| 126 | + } |
|
| 127 | + // get cache id prefixes for post, and delete their corresponding transients |
|
| 128 | + $this->clear($post_related_cache[ $post_ID ]); |
|
| 129 | + unset($post_related_cache[ $post_ID ]); |
|
| 130 | + $this->updatePostRelatedCache($post_related_cache); |
|
| 131 | + } |
|
| 132 | 132 | } |
@@ -39,29 +39,29 @@ |
||
| 39 | 39 | protected function convertAscii($string) |
| 40 | 40 | { |
| 41 | 41 | // Replace Single Curly Quotes |
| 42 | - $search[] = chr(226) . chr(128) . chr(152); |
|
| 42 | + $search[] = chr(226).chr(128).chr(152); |
|
| 43 | 43 | $replace[] = "'"; |
| 44 | - $search[] = chr(226) . chr(128) . chr(153); |
|
| 44 | + $search[] = chr(226).chr(128).chr(153); |
|
| 45 | 45 | $replace[] = "'"; |
| 46 | 46 | // Replace Smart Double Curly Quotes |
| 47 | - $search[] = chr(226) . chr(128) . chr(156); |
|
| 47 | + $search[] = chr(226).chr(128).chr(156); |
|
| 48 | 48 | $replace[] = '"'; |
| 49 | - $search[] = chr(226) . chr(128) . chr(157); |
|
| 49 | + $search[] = chr(226).chr(128).chr(157); |
|
| 50 | 50 | $replace[] = '"'; |
| 51 | 51 | // Replace En Dash |
| 52 | - $search[] = chr(226) . chr(128) . chr(147); |
|
| 52 | + $search[] = chr(226).chr(128).chr(147); |
|
| 53 | 53 | $replace[] = '--'; |
| 54 | 54 | // Replace Em Dash |
| 55 | - $search[] = chr(226) . chr(128) . chr(148); |
|
| 55 | + $search[] = chr(226).chr(128).chr(148); |
|
| 56 | 56 | $replace[] = '---'; |
| 57 | 57 | // Replace Bullet |
| 58 | - $search[] = chr(226) . chr(128) . chr(162); |
|
| 58 | + $search[] = chr(226).chr(128).chr(162); |
|
| 59 | 59 | $replace[] = '*'; |
| 60 | 60 | // Replace Middle Dot |
| 61 | - $search[] = chr(194) . chr(183); |
|
| 61 | + $search[] = chr(194).chr(183); |
|
| 62 | 62 | $replace[] = '*'; |
| 63 | 63 | // Replace Ellipsis with three consecutive dots |
| 64 | - $search[] = chr(226) . chr(128) . chr(166); |
|
| 64 | + $search[] = chr(226).chr(128).chr(166); |
|
| 65 | 65 | $replace[] = '...'; |
| 66 | 66 | // Apply Replacements |
| 67 | 67 | $string = str_replace($search, $replace, $string); |
@@ -14,58 +14,58 @@ |
||
| 14 | 14 | */ |
| 15 | 15 | class AsciiOnly extends FormatterBase |
| 16 | 16 | { |
| 17 | - /** |
|
| 18 | - * Removes all non Ascii characters from string |
|
| 19 | - * |
|
| 20 | - * @param string|int|float $input anything easily cast into a string |
|
| 21 | - * @return string |
|
| 22 | - */ |
|
| 23 | - public function format($input) |
|
| 24 | - { |
|
| 25 | - // in case an int or float etc was passed in |
|
| 26 | - $input = (string) $input; |
|
| 27 | - $input = $this->convertAscii($input); |
|
| 28 | - return $input; |
|
| 29 | - } |
|
| 17 | + /** |
|
| 18 | + * Removes all non Ascii characters from string |
|
| 19 | + * |
|
| 20 | + * @param string|int|float $input anything easily cast into a string |
|
| 21 | + * @return string |
|
| 22 | + */ |
|
| 23 | + public function format($input) |
|
| 24 | + { |
|
| 25 | + // in case an int or float etc was passed in |
|
| 26 | + $input = (string) $input; |
|
| 27 | + $input = $this->convertAscii($input); |
|
| 28 | + return $input; |
|
| 29 | + } |
|
| 30 | 30 | |
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * Taken from https://gist.github.com/jaywilliams/119517 |
|
| 34 | - * |
|
| 35 | - * @param $string |
|
| 36 | - * @return string |
|
| 37 | - */ |
|
| 38 | - protected function convertAscii($string) |
|
| 39 | - { |
|
| 40 | - // Replace Single Curly Quotes |
|
| 41 | - $search[] = chr(226) . chr(128) . chr(152); |
|
| 42 | - $replace[] = "'"; |
|
| 43 | - $search[] = chr(226) . chr(128) . chr(153); |
|
| 44 | - $replace[] = "'"; |
|
| 45 | - // Replace Smart Double Curly Quotes |
|
| 46 | - $search[] = chr(226) . chr(128) . chr(156); |
|
| 47 | - $replace[] = '"'; |
|
| 48 | - $search[] = chr(226) . chr(128) . chr(157); |
|
| 49 | - $replace[] = '"'; |
|
| 50 | - // Replace En Dash |
|
| 51 | - $search[] = chr(226) . chr(128) . chr(147); |
|
| 52 | - $replace[] = '--'; |
|
| 53 | - // Replace Em Dash |
|
| 54 | - $search[] = chr(226) . chr(128) . chr(148); |
|
| 55 | - $replace[] = '---'; |
|
| 56 | - // Replace Bullet |
|
| 57 | - $search[] = chr(226) . chr(128) . chr(162); |
|
| 58 | - $replace[] = '*'; |
|
| 59 | - // Replace Middle Dot |
|
| 60 | - $search[] = chr(194) . chr(183); |
|
| 61 | - $replace[] = '*'; |
|
| 62 | - // Replace Ellipsis with three consecutive dots |
|
| 63 | - $search[] = chr(226) . chr(128) . chr(166); |
|
| 64 | - $replace[] = '...'; |
|
| 65 | - // Apply Replacements |
|
| 66 | - $string = str_replace($search, $replace, $string); |
|
| 67 | - // Remove any non-ASCII Characters |
|
| 68 | - $string = preg_replace("/[^\x01-\x7F]/", "", $string); |
|
| 69 | - return $string; |
|
| 70 | - } |
|
| 32 | + /** |
|
| 33 | + * Taken from https://gist.github.com/jaywilliams/119517 |
|
| 34 | + * |
|
| 35 | + * @param $string |
|
| 36 | + * @return string |
|
| 37 | + */ |
|
| 38 | + protected function convertAscii($string) |
|
| 39 | + { |
|
| 40 | + // Replace Single Curly Quotes |
|
| 41 | + $search[] = chr(226) . chr(128) . chr(152); |
|
| 42 | + $replace[] = "'"; |
|
| 43 | + $search[] = chr(226) . chr(128) . chr(153); |
|
| 44 | + $replace[] = "'"; |
|
| 45 | + // Replace Smart Double Curly Quotes |
|
| 46 | + $search[] = chr(226) . chr(128) . chr(156); |
|
| 47 | + $replace[] = '"'; |
|
| 48 | + $search[] = chr(226) . chr(128) . chr(157); |
|
| 49 | + $replace[] = '"'; |
|
| 50 | + // Replace En Dash |
|
| 51 | + $search[] = chr(226) . chr(128) . chr(147); |
|
| 52 | + $replace[] = '--'; |
|
| 53 | + // Replace Em Dash |
|
| 54 | + $search[] = chr(226) . chr(128) . chr(148); |
|
| 55 | + $replace[] = '---'; |
|
| 56 | + // Replace Bullet |
|
| 57 | + $search[] = chr(226) . chr(128) . chr(162); |
|
| 58 | + $replace[] = '*'; |
|
| 59 | + // Replace Middle Dot |
|
| 60 | + $search[] = chr(194) . chr(183); |
|
| 61 | + $replace[] = '*'; |
|
| 62 | + // Replace Ellipsis with three consecutive dots |
|
| 63 | + $search[] = chr(226) . chr(128) . chr(166); |
|
| 64 | + $replace[] = '...'; |
|
| 65 | + // Apply Replacements |
|
| 66 | + $string = str_replace($search, $replace, $string); |
|
| 67 | + // Remove any non-ASCII Characters |
|
| 68 | + $string = preg_replace("/[^\x01-\x7F]/", "", $string); |
|
| 69 | + return $string; |
|
| 70 | + } |
|
| 71 | 71 | } |
@@ -37,7 +37,7 @@ |
||
| 37 | 37 | ) |
| 38 | 38 | ); |
| 39 | 39 | // if the incoming country has a set format, use that, else use the default |
| 40 | - $formatted_address = isset($address_formats[ $CNT_ISO ]) ? $address_formats[ $CNT_ISO ] |
|
| 40 | + $formatted_address = isset($address_formats[$CNT_ISO]) ? $address_formats[$CNT_ISO] |
|
| 41 | 41 | : $address_formats['ZZ']; |
| 42 | 42 | return $this->parse_formatted_address( |
| 43 | 43 | $address, |
@@ -13,39 +13,39 @@ |
||
| 13 | 13 | */ |
| 14 | 14 | class MultiLineAddressFormatter extends AddressFormatter implements \EEI_Address_Formatter |
| 15 | 15 | { |
| 16 | - /** |
|
| 17 | - * @param string $address |
|
| 18 | - * @param string $address2 |
|
| 19 | - * @param string $city |
|
| 20 | - * @param string $state |
|
| 21 | - * @param string $zip |
|
| 22 | - * @param string $country |
|
| 23 | - * @param string $CNT_ISO |
|
| 24 | - * @return string |
|
| 25 | - */ |
|
| 26 | - public function format($address, $address2, $city, $state, $zip, $country, $CNT_ISO) |
|
| 27 | - { |
|
| 28 | - $address_formats = apply_filters( |
|
| 29 | - 'FHEE__EE_MultiLine_Address_Formatter__address_formats', |
|
| 30 | - array( |
|
| 31 | - 'CA' => "{address}%{address2}%{city}%{state}%{country}%{zip}", |
|
| 32 | - 'GB' => "{address}%{address2}%{city}%{state}%{zip}%{country}", |
|
| 33 | - 'US' => "{address}%{address2}%{city}%{state}%{zip}%{country}", |
|
| 34 | - 'ZZ' => "{address}%{address2}%{city}%{state}%{zip}%{country}", |
|
| 35 | - ) |
|
| 36 | - ); |
|
| 37 | - // if the incoming country has a set format, use that, else use the default |
|
| 38 | - $formatted_address = isset($address_formats[ $CNT_ISO ]) ? $address_formats[ $CNT_ISO ] |
|
| 39 | - : $address_formats['ZZ']; |
|
| 40 | - return $this->parse_formatted_address( |
|
| 41 | - $address, |
|
| 42 | - $address2, |
|
| 43 | - $city, |
|
| 44 | - $state, |
|
| 45 | - $zip, |
|
| 46 | - $country, |
|
| 47 | - $formatted_address, |
|
| 48 | - '<br />' |
|
| 49 | - ); |
|
| 50 | - } |
|
| 16 | + /** |
|
| 17 | + * @param string $address |
|
| 18 | + * @param string $address2 |
|
| 19 | + * @param string $city |
|
| 20 | + * @param string $state |
|
| 21 | + * @param string $zip |
|
| 22 | + * @param string $country |
|
| 23 | + * @param string $CNT_ISO |
|
| 24 | + * @return string |
|
| 25 | + */ |
|
| 26 | + public function format($address, $address2, $city, $state, $zip, $country, $CNT_ISO) |
|
| 27 | + { |
|
| 28 | + $address_formats = apply_filters( |
|
| 29 | + 'FHEE__EE_MultiLine_Address_Formatter__address_formats', |
|
| 30 | + array( |
|
| 31 | + 'CA' => "{address}%{address2}%{city}%{state}%{country}%{zip}", |
|
| 32 | + 'GB' => "{address}%{address2}%{city}%{state}%{zip}%{country}", |
|
| 33 | + 'US' => "{address}%{address2}%{city}%{state}%{zip}%{country}", |
|
| 34 | + 'ZZ' => "{address}%{address2}%{city}%{state}%{zip}%{country}", |
|
| 35 | + ) |
|
| 36 | + ); |
|
| 37 | + // if the incoming country has a set format, use that, else use the default |
|
| 38 | + $formatted_address = isset($address_formats[ $CNT_ISO ]) ? $address_formats[ $CNT_ISO ] |
|
| 39 | + : $address_formats['ZZ']; |
|
| 40 | + return $this->parse_formatted_address( |
|
| 41 | + $address, |
|
| 42 | + $address2, |
|
| 43 | + $city, |
|
| 44 | + $state, |
|
| 45 | + $zip, |
|
| 46 | + $country, |
|
| 47 | + $formatted_address, |
|
| 48 | + '<br />' |
|
| 49 | + ); |
|
| 50 | + } |
|
| 51 | 51 | } |
@@ -36,7 +36,7 @@ |
||
| 36 | 36 | ) |
| 37 | 37 | ); |
| 38 | 38 | // if the incoming country has a set format, use that, else use the default |
| 39 | - $formatted_address = isset($address_formats[ $CNT_ISO ]) ? $address_formats[ $CNT_ISO ] |
|
| 39 | + $formatted_address = isset($address_formats[$CNT_ISO]) ? $address_formats[$CNT_ISO] |
|
| 40 | 40 | : $address_formats['ZZZ']; |
| 41 | 41 | return $this->parse_formatted_address( |
| 42 | 42 | $address, |
@@ -13,39 +13,39 @@ |
||
| 13 | 13 | */ |
| 14 | 14 | class InlineAddressFormatter extends AddressFormatter implements \EEI_Address_Formatter |
| 15 | 15 | { |
| 16 | - /** |
|
| 17 | - * @param string $address |
|
| 18 | - * @param string $address2 |
|
| 19 | - * @param string $city |
|
| 20 | - * @param string $state |
|
| 21 | - * @param string $zip |
|
| 22 | - * @param string $country |
|
| 23 | - * @param string $CNT_ISO |
|
| 24 | - * @return string |
|
| 25 | - */ |
|
| 26 | - public function format($address, $address2, $city, $state, $zip, $country, $CNT_ISO) |
|
| 27 | - { |
|
| 28 | - $address_formats = apply_filters( |
|
| 29 | - 'FHEE__EE_Inline_Address_Formatter__address_formats', |
|
| 30 | - array( |
|
| 31 | - 'CA' => "{address}%{address2}%{city}%{state}%{country}%{zip}", |
|
| 32 | - 'GB' => "{address}%{address2}%{city}%{state}%{zip}%{country}", |
|
| 33 | - 'US' => "{address}%{address2}%{city}%{state}%{zip}%{country}", |
|
| 34 | - 'ZZZ' => "{address}%{address2}%{city}%{state}%{zip}%{country}", |
|
| 35 | - ) |
|
| 36 | - ); |
|
| 37 | - // if the incoming country has a set format, use that, else use the default |
|
| 38 | - $formatted_address = isset($address_formats[ $CNT_ISO ]) ? $address_formats[ $CNT_ISO ] |
|
| 39 | - : $address_formats['ZZZ']; |
|
| 40 | - return $this->parse_formatted_address( |
|
| 41 | - $address, |
|
| 42 | - $address2, |
|
| 43 | - $city, |
|
| 44 | - $state, |
|
| 45 | - $zip, |
|
| 46 | - $country, |
|
| 47 | - $formatted_address, |
|
| 48 | - ', ' |
|
| 49 | - ); |
|
| 50 | - } |
|
| 16 | + /** |
|
| 17 | + * @param string $address |
|
| 18 | + * @param string $address2 |
|
| 19 | + * @param string $city |
|
| 20 | + * @param string $state |
|
| 21 | + * @param string $zip |
|
| 22 | + * @param string $country |
|
| 23 | + * @param string $CNT_ISO |
|
| 24 | + * @return string |
|
| 25 | + */ |
|
| 26 | + public function format($address, $address2, $city, $state, $zip, $country, $CNT_ISO) |
|
| 27 | + { |
|
| 28 | + $address_formats = apply_filters( |
|
| 29 | + 'FHEE__EE_Inline_Address_Formatter__address_formats', |
|
| 30 | + array( |
|
| 31 | + 'CA' => "{address}%{address2}%{city}%{state}%{country}%{zip}", |
|
| 32 | + 'GB' => "{address}%{address2}%{city}%{state}%{zip}%{country}", |
|
| 33 | + 'US' => "{address}%{address2}%{city}%{state}%{zip}%{country}", |
|
| 34 | + 'ZZZ' => "{address}%{address2}%{city}%{state}%{zip}%{country}", |
|
| 35 | + ) |
|
| 36 | + ); |
|
| 37 | + // if the incoming country has a set format, use that, else use the default |
|
| 38 | + $formatted_address = isset($address_formats[ $CNT_ISO ]) ? $address_formats[ $CNT_ISO ] |
|
| 39 | + : $address_formats['ZZZ']; |
|
| 40 | + return $this->parse_formatted_address( |
|
| 41 | + $address, |
|
| 42 | + $address2, |
|
| 43 | + $city, |
|
| 44 | + $state, |
|
| 45 | + $zip, |
|
| 46 | + $country, |
|
| 47 | + $formatted_address, |
|
| 48 | + ', ' |
|
| 49 | + ); |
|
| 50 | + } |
|
| 51 | 51 | } |
@@ -65,7 +65,7 @@ discard block |
||
| 65 | 65 | global $wpdb; |
| 66 | 66 | $full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
| 67 | 67 | $columns = $this->getTableColumns($table_name); |
| 68 | - if (! in_array($column_name, $columns)) { |
|
| 68 | + if ( ! in_array($column_name, $columns)) { |
|
| 69 | 69 | $alter_query = "ALTER TABLE {$full_table_name} ADD {$column_name} {$column_info}"; |
| 70 | 70 | return $wpdb->query($alter_query); |
| 71 | 71 | } |
@@ -86,7 +86,7 @@ discard block |
||
| 86 | 86 | global $wpdb; |
| 87 | 87 | $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
| 88 | 88 | $field_array = array(); |
| 89 | - if (! empty($table_name)) { |
|
| 89 | + if ( ! empty($table_name)) { |
|
| 90 | 90 | $columns = $wpdb->get_results("SHOW COLUMNS FROM {$table_name} "); |
| 91 | 91 | if ($columns !== false) { |
| 92 | 92 | foreach ($columns as $column) { |
@@ -132,14 +132,14 @@ discard block |
||
| 132 | 132 | foreach ($table_names as $table_name) { |
| 133 | 133 | $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
| 134 | 134 | if ($this->getTableAnalysis()->tableExists($table_name)) { |
| 135 | - $tables_to_delete[ $table_name ] = $table_name; |
|
| 135 | + $tables_to_delete[$table_name] = $table_name; |
|
| 136 | 136 | } |
| 137 | 137 | } |
| 138 | - if (! empty($tables_to_delete)) { |
|
| 138 | + if ( ! empty($tables_to_delete)) { |
|
| 139 | 139 | global $wpdb; |
| 140 | 140 | // make sure we only have a unique strings in the array. |
| 141 | 141 | $tables_to_delete = array_unique($tables_to_delete); |
| 142 | - $wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete)); |
|
| 142 | + $wpdb->query('DROP TABLE '.implode(', ', $tables_to_delete)); |
|
| 143 | 143 | } |
| 144 | 144 | return $tables_to_delete; |
| 145 | 145 | } |
@@ -189,7 +189,7 @@ discard block |
||
| 189 | 189 | $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
| 190 | 190 | /** @var \wpdb $wpdb */ |
| 191 | 191 | global $wpdb; |
| 192 | - $SQL = "CREATE TABLE {$table_name} ( {$create_sql} ) ENGINE={$engine} " . $wpdb->get_charset_collate(); |
|
| 192 | + $SQL = "CREATE TABLE {$table_name} ( {$create_sql} ) ENGINE={$engine} ".$wpdb->get_charset_collate(); |
|
| 193 | 193 | |
| 194 | 194 | // get $wpdb to echo errors, but buffer them. This way at least WE know an error |
| 195 | 195 | // happened. And then we can choose to tell the end user |
@@ -201,7 +201,7 @@ discard block |
||
| 201 | 201 | ob_end_clean(); |
| 202 | 202 | $wpdb->show_errors($old_show_errors_policy); |
| 203 | 203 | $wpdb->suppress_errors($old_error_suppression_policy); |
| 204 | - if (! empty($output)) { |
|
| 204 | + if ( ! empty($output)) { |
|
| 205 | 205 | throw new \EE_Error($output); |
| 206 | 206 | } |
| 207 | 207 | } else { |
@@ -242,7 +242,7 @@ discard block |
||
| 242 | 242 | if ($column_name === null) { |
| 243 | 243 | $column_name = $index_name; |
| 244 | 244 | } |
| 245 | - if (! $this->getTableAnalysis()->tableExists($table_name)) { |
|
| 245 | + if ( ! $this->getTableAnalysis()->tableExists($table_name)) { |
|
| 246 | 246 | return false; |
| 247 | 247 | } |
| 248 | 248 | $index_entries = $this->getTableAnalysis()->showIndexes($table_name, $index_name); |
@@ -12,257 +12,257 @@ |
||
| 12 | 12 | */ |
| 13 | 13 | class TableManager extends \EE_Base |
| 14 | 14 | { |
| 15 | - /** |
|
| 16 | - * @var TableAnalysis $table_analysis |
|
| 17 | - */ |
|
| 18 | - private $table_analysis; |
|
| 15 | + /** |
|
| 16 | + * @var TableAnalysis $table_analysis |
|
| 17 | + */ |
|
| 18 | + private $table_analysis; |
|
| 19 | 19 | |
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * TableManager constructor. |
|
| 23 | - * |
|
| 24 | - * @param TableAnalysis $TableAnalysis |
|
| 25 | - */ |
|
| 26 | - public function __construct(TableAnalysis $TableAnalysis) |
|
| 27 | - { |
|
| 28 | - $this->table_analysis = $TableAnalysis; |
|
| 29 | - } |
|
| 21 | + /** |
|
| 22 | + * TableManager constructor. |
|
| 23 | + * |
|
| 24 | + * @param TableAnalysis $TableAnalysis |
|
| 25 | + */ |
|
| 26 | + public function __construct(TableAnalysis $TableAnalysis) |
|
| 27 | + { |
|
| 28 | + $this->table_analysis = $TableAnalysis; |
|
| 29 | + } |
|
| 30 | 30 | |
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * Gets the injected table analyzer, or throws an exception |
|
| 34 | - * |
|
| 35 | - * @return TableAnalysis |
|
| 36 | - * @throws \EE_Error |
|
| 37 | - */ |
|
| 38 | - protected function getTableAnalysis() |
|
| 39 | - { |
|
| 40 | - if ($this->table_analysis instanceof TableAnalysis) { |
|
| 41 | - return $this->table_analysis; |
|
| 42 | - } else { |
|
| 43 | - throw new \EE_Error( |
|
| 44 | - sprintf( |
|
| 45 | - esc_html__('Table analysis class on class %1$s is not set properly.', 'event_espresso'), |
|
| 46 | - get_class($this) |
|
| 47 | - ) |
|
| 48 | - ); |
|
| 49 | - } |
|
| 50 | - } |
|
| 32 | + /** |
|
| 33 | + * Gets the injected table analyzer, or throws an exception |
|
| 34 | + * |
|
| 35 | + * @return TableAnalysis |
|
| 36 | + * @throws \EE_Error |
|
| 37 | + */ |
|
| 38 | + protected function getTableAnalysis() |
|
| 39 | + { |
|
| 40 | + if ($this->table_analysis instanceof TableAnalysis) { |
|
| 41 | + return $this->table_analysis; |
|
| 42 | + } else { |
|
| 43 | + throw new \EE_Error( |
|
| 44 | + sprintf( |
|
| 45 | + esc_html__('Table analysis class on class %1$s is not set properly.', 'event_espresso'), |
|
| 46 | + get_class($this) |
|
| 47 | + ) |
|
| 48 | + ); |
|
| 49 | + } |
|
| 50 | + } |
|
| 51 | 51 | |
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * @param string $table_name which can optionally start with $wpdb->prefix or not |
|
| 55 | - * @param string $column_name |
|
| 56 | - * @param string $column_info |
|
| 57 | - * @return bool|false|int |
|
| 58 | - */ |
|
| 59 | - public function addColumn($table_name, $column_name, $column_info = 'INT UNSIGNED NOT NULL') |
|
| 60 | - { |
|
| 61 | - if (apply_filters('FHEE__EEH_Activation__add_column_if_it_doesnt_exist__short_circuit', false)) { |
|
| 62 | - return false; |
|
| 63 | - } |
|
| 64 | - global $wpdb; |
|
| 65 | - $full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
|
| 66 | - $columns = $this->getTableColumns($table_name); |
|
| 67 | - if (! in_array($column_name, $columns)) { |
|
| 68 | - $alter_query = "ALTER TABLE {$full_table_name} ADD {$column_name} {$column_info}"; |
|
| 69 | - return $wpdb->query($alter_query); |
|
| 70 | - } |
|
| 71 | - return true; |
|
| 72 | - } |
|
| 53 | + /** |
|
| 54 | + * @param string $table_name which can optionally start with $wpdb->prefix or not |
|
| 55 | + * @param string $column_name |
|
| 56 | + * @param string $column_info |
|
| 57 | + * @return bool|false|int |
|
| 58 | + */ |
|
| 59 | + public function addColumn($table_name, $column_name, $column_info = 'INT UNSIGNED NOT NULL') |
|
| 60 | + { |
|
| 61 | + if (apply_filters('FHEE__EEH_Activation__add_column_if_it_doesnt_exist__short_circuit', false)) { |
|
| 62 | + return false; |
|
| 63 | + } |
|
| 64 | + global $wpdb; |
|
| 65 | + $full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
|
| 66 | + $columns = $this->getTableColumns($table_name); |
|
| 67 | + if (! in_array($column_name, $columns)) { |
|
| 68 | + $alter_query = "ALTER TABLE {$full_table_name} ADD {$column_name} {$column_info}"; |
|
| 69 | + return $wpdb->query($alter_query); |
|
| 70 | + } |
|
| 71 | + return true; |
|
| 72 | + } |
|
| 73 | 73 | |
| 74 | 74 | |
| 75 | - /** |
|
| 76 | - * Gets the name of all columns on the table. $table_name can |
|
| 77 | - * optionally start with $wpdb->prefix or not |
|
| 78 | - * |
|
| 79 | - * @global \wpdb $wpdb |
|
| 80 | - * @param string $table_name |
|
| 81 | - * @return array |
|
| 82 | - */ |
|
| 83 | - public function getTableColumns($table_name) |
|
| 84 | - { |
|
| 85 | - global $wpdb; |
|
| 86 | - $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
|
| 87 | - $field_array = array(); |
|
| 88 | - if (! empty($table_name)) { |
|
| 89 | - $columns = $wpdb->get_results("SHOW COLUMNS FROM {$table_name} "); |
|
| 90 | - if ($columns !== false) { |
|
| 91 | - foreach ($columns as $column) { |
|
| 92 | - $field_array[] = $column->Field; |
|
| 93 | - } |
|
| 94 | - } |
|
| 95 | - } |
|
| 96 | - return $field_array; |
|
| 97 | - } |
|
| 75 | + /** |
|
| 76 | + * Gets the name of all columns on the table. $table_name can |
|
| 77 | + * optionally start with $wpdb->prefix or not |
|
| 78 | + * |
|
| 79 | + * @global \wpdb $wpdb |
|
| 80 | + * @param string $table_name |
|
| 81 | + * @return array |
|
| 82 | + */ |
|
| 83 | + public function getTableColumns($table_name) |
|
| 84 | + { |
|
| 85 | + global $wpdb; |
|
| 86 | + $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
|
| 87 | + $field_array = array(); |
|
| 88 | + if (! empty($table_name)) { |
|
| 89 | + $columns = $wpdb->get_results("SHOW COLUMNS FROM {$table_name} "); |
|
| 90 | + if ($columns !== false) { |
|
| 91 | + foreach ($columns as $column) { |
|
| 92 | + $field_array[] = $column->Field; |
|
| 93 | + } |
|
| 94 | + } |
|
| 95 | + } |
|
| 96 | + return $field_array; |
|
| 97 | + } |
|
| 98 | 98 | |
| 99 | 99 | |
| 100 | - /** |
|
| 101 | - * Drops the specified table from the database. $table_name can |
|
| 102 | - * optionally start with $wpdb->prefix or not |
|
| 103 | - * |
|
| 104 | - * @global \wpdb $wpdb |
|
| 105 | - * @param string $table_name |
|
| 106 | - * @return int |
|
| 107 | - */ |
|
| 108 | - public function dropTable($table_name) |
|
| 109 | - { |
|
| 110 | - global $wpdb; |
|
| 111 | - if ($this->getTableAnalysis()->tableExists($table_name)) { |
|
| 112 | - $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
|
| 113 | - return $wpdb->query("DROP TABLE IF EXISTS {$table_name}"); |
|
| 114 | - } |
|
| 115 | - return 0; |
|
| 116 | - } |
|
| 100 | + /** |
|
| 101 | + * Drops the specified table from the database. $table_name can |
|
| 102 | + * optionally start with $wpdb->prefix or not |
|
| 103 | + * |
|
| 104 | + * @global \wpdb $wpdb |
|
| 105 | + * @param string $table_name |
|
| 106 | + * @return int |
|
| 107 | + */ |
|
| 108 | + public function dropTable($table_name) |
|
| 109 | + { |
|
| 110 | + global $wpdb; |
|
| 111 | + if ($this->getTableAnalysis()->tableExists($table_name)) { |
|
| 112 | + $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
|
| 113 | + return $wpdb->query("DROP TABLE IF EXISTS {$table_name}"); |
|
| 114 | + } |
|
| 115 | + return 0; |
|
| 116 | + } |
|
| 117 | 117 | |
| 118 | 118 | |
| 119 | - /** |
|
| 120 | - * Drops all the tables mentioned in a single MYSQL query. Double-checks |
|
| 121 | - * each table name provided has a wpdb prefix attached, and that it exists. |
|
| 122 | - * Returns the list actually deleted |
|
| 123 | - * |
|
| 124 | - * @global WPDB $wpdb |
|
| 125 | - * @param array $table_names |
|
| 126 | - * @return array of table names which we deleted |
|
| 127 | - */ |
|
| 128 | - public function dropTables($table_names) |
|
| 129 | - { |
|
| 130 | - $tables_to_delete = array(); |
|
| 131 | - foreach ($table_names as $table_name) { |
|
| 132 | - $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
|
| 133 | - if ($this->getTableAnalysis()->tableExists($table_name)) { |
|
| 134 | - $tables_to_delete[ $table_name ] = $table_name; |
|
| 135 | - } |
|
| 136 | - } |
|
| 137 | - if (! empty($tables_to_delete)) { |
|
| 138 | - global $wpdb; |
|
| 139 | - // make sure we only have a unique strings in the array. |
|
| 140 | - $tables_to_delete = array_unique($tables_to_delete); |
|
| 141 | - $wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete)); |
|
| 142 | - } |
|
| 143 | - return $tables_to_delete; |
|
| 144 | - } |
|
| 119 | + /** |
|
| 120 | + * Drops all the tables mentioned in a single MYSQL query. Double-checks |
|
| 121 | + * each table name provided has a wpdb prefix attached, and that it exists. |
|
| 122 | + * Returns the list actually deleted |
|
| 123 | + * |
|
| 124 | + * @global WPDB $wpdb |
|
| 125 | + * @param array $table_names |
|
| 126 | + * @return array of table names which we deleted |
|
| 127 | + */ |
|
| 128 | + public function dropTables($table_names) |
|
| 129 | + { |
|
| 130 | + $tables_to_delete = array(); |
|
| 131 | + foreach ($table_names as $table_name) { |
|
| 132 | + $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
|
| 133 | + if ($this->getTableAnalysis()->tableExists($table_name)) { |
|
| 134 | + $tables_to_delete[ $table_name ] = $table_name; |
|
| 135 | + } |
|
| 136 | + } |
|
| 137 | + if (! empty($tables_to_delete)) { |
|
| 138 | + global $wpdb; |
|
| 139 | + // make sure we only have a unique strings in the array. |
|
| 140 | + $tables_to_delete = array_unique($tables_to_delete); |
|
| 141 | + $wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete)); |
|
| 142 | + } |
|
| 143 | + return $tables_to_delete; |
|
| 144 | + } |
|
| 145 | 145 | |
| 146 | 146 | |
| 147 | - /** |
|
| 148 | - * Drops the specified index from the specified table. $table_name can |
|
| 149 | - * optionally start with $wpdb->prefix or not |
|
| 150 | - * |
|
| 151 | - * @global \wpdb $wpdb |
|
| 152 | - * @param string $table_name |
|
| 153 | - * @param string $index_name |
|
| 154 | - * @return int the number of indexes dropped. False if there was a datbase error |
|
| 155 | - */ |
|
| 156 | - public function dropIndex($table_name, $index_name) |
|
| 157 | - { |
|
| 158 | - if (apply_filters('FHEE__EEH_Activation__drop_index__short_circuit', false)) { |
|
| 159 | - return 0; |
|
| 160 | - } |
|
| 161 | - global $wpdb; |
|
| 162 | - $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
|
| 163 | - $index_exists_query = "SHOW INDEX FROM {$table_name} WHERE key_name = '{$index_name}'"; |
|
| 164 | - if ( |
|
| 165 | - $this->getTableAnalysis()->tableExists($table_name) |
|
| 166 | - && $wpdb->get_var($index_exists_query) |
|
| 167 | - === $table_name // using get_var with the $index_exists_query returns the table's name |
|
| 168 | - ) { |
|
| 169 | - return $wpdb->query("ALTER TABLE {$table_name} DROP INDEX {$index_name}"); |
|
| 170 | - } |
|
| 171 | - return 0; |
|
| 172 | - } |
|
| 147 | + /** |
|
| 148 | + * Drops the specified index from the specified table. $table_name can |
|
| 149 | + * optionally start with $wpdb->prefix or not |
|
| 150 | + * |
|
| 151 | + * @global \wpdb $wpdb |
|
| 152 | + * @param string $table_name |
|
| 153 | + * @param string $index_name |
|
| 154 | + * @return int the number of indexes dropped. False if there was a datbase error |
|
| 155 | + */ |
|
| 156 | + public function dropIndex($table_name, $index_name) |
|
| 157 | + { |
|
| 158 | + if (apply_filters('FHEE__EEH_Activation__drop_index__short_circuit', false)) { |
|
| 159 | + return 0; |
|
| 160 | + } |
|
| 161 | + global $wpdb; |
|
| 162 | + $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
|
| 163 | + $index_exists_query = "SHOW INDEX FROM {$table_name} WHERE key_name = '{$index_name}'"; |
|
| 164 | + if ( |
|
| 165 | + $this->getTableAnalysis()->tableExists($table_name) |
|
| 166 | + && $wpdb->get_var($index_exists_query) |
|
| 167 | + === $table_name // using get_var with the $index_exists_query returns the table's name |
|
| 168 | + ) { |
|
| 169 | + return $wpdb->query("ALTER TABLE {$table_name} DROP INDEX {$index_name}"); |
|
| 170 | + } |
|
| 171 | + return 0; |
|
| 172 | + } |
|
| 173 | 173 | |
| 174 | 174 | |
| 175 | - /** |
|
| 176 | - * Just creates the requested table. $table_name can |
|
| 177 | - * optionally start with $wpdb->prefix or not |
|
| 178 | - * |
|
| 179 | - * @param string $table_name |
|
| 180 | - * @param string $create_sql defining the table's columns and indexes |
|
| 181 | - * @param string $engine (no need to specify "ENGINE=", that's implied) |
|
| 182 | - * @return void |
|
| 183 | - * @throws \EE_Error |
|
| 184 | - */ |
|
| 185 | - public function createTable($table_name, $create_sql, $engine = 'MyISAM') |
|
| 186 | - { |
|
| 187 | - $engine = apply_filters( |
|
| 188 | - 'FHEE__EventEspresso_core_services_database_TableManager__createTable__engine', |
|
| 189 | - $engine, |
|
| 190 | - $table_name, |
|
| 191 | - $create_sql |
|
| 192 | - ); |
|
| 193 | - // does $sql contain valid column information? ( LPT: https://regex101.com/ is great for working out regex patterns ) |
|
| 194 | - if (preg_match('((((.*?))(,\s))+)', $create_sql, $valid_column_data)) { |
|
| 195 | - $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
|
| 196 | - /** @var \wpdb $wpdb */ |
|
| 197 | - global $wpdb; |
|
| 198 | - $SQL = "CREATE TABLE {$table_name} ( {$create_sql} ) ENGINE={$engine} " . $wpdb->get_charset_collate(); |
|
| 175 | + /** |
|
| 176 | + * Just creates the requested table. $table_name can |
|
| 177 | + * optionally start with $wpdb->prefix or not |
|
| 178 | + * |
|
| 179 | + * @param string $table_name |
|
| 180 | + * @param string $create_sql defining the table's columns and indexes |
|
| 181 | + * @param string $engine (no need to specify "ENGINE=", that's implied) |
|
| 182 | + * @return void |
|
| 183 | + * @throws \EE_Error |
|
| 184 | + */ |
|
| 185 | + public function createTable($table_name, $create_sql, $engine = 'MyISAM') |
|
| 186 | + { |
|
| 187 | + $engine = apply_filters( |
|
| 188 | + 'FHEE__EventEspresso_core_services_database_TableManager__createTable__engine', |
|
| 189 | + $engine, |
|
| 190 | + $table_name, |
|
| 191 | + $create_sql |
|
| 192 | + ); |
|
| 193 | + // does $sql contain valid column information? ( LPT: https://regex101.com/ is great for working out regex patterns ) |
|
| 194 | + if (preg_match('((((.*?))(,\s))+)', $create_sql, $valid_column_data)) { |
|
| 195 | + $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
|
| 196 | + /** @var \wpdb $wpdb */ |
|
| 197 | + global $wpdb; |
|
| 198 | + $SQL = "CREATE TABLE {$table_name} ( {$create_sql} ) ENGINE={$engine} " . $wpdb->get_charset_collate(); |
|
| 199 | 199 | |
| 200 | - // get $wpdb to echo errors, but buffer them. This way at least WE know an error |
|
| 201 | - // happened. And then we can choose to tell the end user |
|
| 202 | - $old_show_errors_policy = $wpdb->show_errors(true); |
|
| 203 | - $old_error_suppression_policy = $wpdb->suppress_errors(false); |
|
| 204 | - ob_start(); |
|
| 205 | - dbDelta($SQL); |
|
| 206 | - $output = ob_get_contents(); |
|
| 207 | - ob_end_clean(); |
|
| 208 | - $wpdb->show_errors($old_show_errors_policy); |
|
| 209 | - $wpdb->suppress_errors($old_error_suppression_policy); |
|
| 210 | - if (! empty($output)) { |
|
| 211 | - throw new \EE_Error($output); |
|
| 212 | - } |
|
| 213 | - } else { |
|
| 214 | - throw new \EE_Error( |
|
| 215 | - sprintf( |
|
| 216 | - esc_html__( |
|
| 217 | - 'The following table creation SQL does not contain valid information about the table columns: %1$s %2$s', |
|
| 218 | - 'event_espresso' |
|
| 219 | - ), |
|
| 220 | - '<br />', |
|
| 221 | - $create_sql |
|
| 222 | - ) |
|
| 223 | - ); |
|
| 224 | - } |
|
| 225 | - } |
|
| 200 | + // get $wpdb to echo errors, but buffer them. This way at least WE know an error |
|
| 201 | + // happened. And then we can choose to tell the end user |
|
| 202 | + $old_show_errors_policy = $wpdb->show_errors(true); |
|
| 203 | + $old_error_suppression_policy = $wpdb->suppress_errors(false); |
|
| 204 | + ob_start(); |
|
| 205 | + dbDelta($SQL); |
|
| 206 | + $output = ob_get_contents(); |
|
| 207 | + ob_end_clean(); |
|
| 208 | + $wpdb->show_errors($old_show_errors_policy); |
|
| 209 | + $wpdb->suppress_errors($old_error_suppression_policy); |
|
| 210 | + if (! empty($output)) { |
|
| 211 | + throw new \EE_Error($output); |
|
| 212 | + } |
|
| 213 | + } else { |
|
| 214 | + throw new \EE_Error( |
|
| 215 | + sprintf( |
|
| 216 | + esc_html__( |
|
| 217 | + 'The following table creation SQL does not contain valid information about the table columns: %1$s %2$s', |
|
| 218 | + 'event_espresso' |
|
| 219 | + ), |
|
| 220 | + '<br />', |
|
| 221 | + $create_sql |
|
| 222 | + ) |
|
| 223 | + ); |
|
| 224 | + } |
|
| 225 | + } |
|
| 226 | 226 | |
| 227 | 227 | |
| 228 | - /** |
|
| 229 | - * Drops the specified index if it's size differs from $desired_index_size. |
|
| 230 | - * WordPress' dbdelta method doesn't automatically change index sizes, so this |
|
| 231 | - * method can be used to only drop the index if needed, and afterwards dbdelta can be used as normal. |
|
| 232 | - * If the table doesn't exist, or it exists but the index does not, or returns false |
|
| 233 | - * |
|
| 234 | - * @param string $table_name |
|
| 235 | - * @param string $index_name |
|
| 236 | - * @param string $column_name if none is provided, we assume the column name matches the index (often |
|
| 237 | - * true in EE) |
|
| 238 | - * @param string|int $desired_index_size defaults to TableAnalysis::index_col_size, the max for utf8mb4. |
|
| 239 | - * @return bool whether an index was dropped or not |
|
| 240 | - * @throws /EE_Error if table analysis object isn't defined |
|
| 241 | - */ |
|
| 242 | - public function dropIndexIfSizeNot( |
|
| 243 | - $table_name, |
|
| 244 | - $index_name, |
|
| 245 | - $column_name = null, |
|
| 246 | - $desired_index_size = TableAnalysis::INDEX_COLUMN_SIZE |
|
| 247 | - ) { |
|
| 248 | - if ($column_name === null) { |
|
| 249 | - $column_name = $index_name; |
|
| 250 | - } |
|
| 251 | - if (! $this->getTableAnalysis()->tableExists($table_name)) { |
|
| 252 | - return false; |
|
| 253 | - } |
|
| 254 | - $index_entries = $this->getTableAnalysis()->showIndexes($table_name, $index_name); |
|
| 255 | - if (empty($index_entries)) { |
|
| 256 | - return false; |
|
| 257 | - } |
|
| 258 | - foreach ($index_entries as $index_entry) { |
|
| 259 | - if ( |
|
| 260 | - $column_name === $index_entry->Column_name |
|
| 261 | - && (string) $desired_index_size !== $index_entry->Sub_part |
|
| 262 | - ) { |
|
| 263 | - return $this->dropIndex($table_name, $index_name); |
|
| 264 | - } |
|
| 265 | - } |
|
| 266 | - return false; |
|
| 267 | - } |
|
| 228 | + /** |
|
| 229 | + * Drops the specified index if it's size differs from $desired_index_size. |
|
| 230 | + * WordPress' dbdelta method doesn't automatically change index sizes, so this |
|
| 231 | + * method can be used to only drop the index if needed, and afterwards dbdelta can be used as normal. |
|
| 232 | + * If the table doesn't exist, or it exists but the index does not, or returns false |
|
| 233 | + * |
|
| 234 | + * @param string $table_name |
|
| 235 | + * @param string $index_name |
|
| 236 | + * @param string $column_name if none is provided, we assume the column name matches the index (often |
|
| 237 | + * true in EE) |
|
| 238 | + * @param string|int $desired_index_size defaults to TableAnalysis::index_col_size, the max for utf8mb4. |
|
| 239 | + * @return bool whether an index was dropped or not |
|
| 240 | + * @throws /EE_Error if table analysis object isn't defined |
|
| 241 | + */ |
|
| 242 | + public function dropIndexIfSizeNot( |
|
| 243 | + $table_name, |
|
| 244 | + $index_name, |
|
| 245 | + $column_name = null, |
|
| 246 | + $desired_index_size = TableAnalysis::INDEX_COLUMN_SIZE |
|
| 247 | + ) { |
|
| 248 | + if ($column_name === null) { |
|
| 249 | + $column_name = $index_name; |
|
| 250 | + } |
|
| 251 | + if (! $this->getTableAnalysis()->tableExists($table_name)) { |
|
| 252 | + return false; |
|
| 253 | + } |
|
| 254 | + $index_entries = $this->getTableAnalysis()->showIndexes($table_name, $index_name); |
|
| 255 | + if (empty($index_entries)) { |
|
| 256 | + return false; |
|
| 257 | + } |
|
| 258 | + foreach ($index_entries as $index_entry) { |
|
| 259 | + if ( |
|
| 260 | + $column_name === $index_entry->Column_name |
|
| 261 | + && (string) $desired_index_size !== $index_entry->Sub_part |
|
| 262 | + ) { |
|
| 263 | + return $this->dropIndex($table_name, $index_name); |
|
| 264 | + } |
|
| 265 | + } |
|
| 266 | + return false; |
|
| 267 | + } |
|
| 268 | 268 | } |
@@ -157,7 +157,7 @@ |
||
| 157 | 157 | */ |
| 158 | 158 | private function setType($type) |
| 159 | 159 | { |
| 160 | - if (! in_array($type, $this->types(), true)) { |
|
| 160 | + if ( ! in_array($type, $this->types(), true)) { |
|
| 161 | 161 | throw new InvalidDataTypeException( |
| 162 | 162 | '$type', |
| 163 | 163 | $type, |
@@ -13,253 +13,253 @@ |
||
| 13 | 13 | */ |
| 14 | 14 | class Notice implements NoticeInterface |
| 15 | 15 | { |
| 16 | - const ERROR = 'error'; |
|
| 17 | - |
|
| 18 | - const SUCCESS = 'success'; |
|
| 19 | - |
|
| 20 | - const ATTENTION = 'attention'; // alias for warning |
|
| 21 | - |
|
| 22 | - const INFORMATION = 'information'; |
|
| 23 | - |
|
| 24 | - /** |
|
| 25 | - * @var string $type |
|
| 26 | - */ |
|
| 27 | - private $type; |
|
| 28 | - |
|
| 29 | - |
|
| 30 | - /** |
|
| 31 | - * @var string $message |
|
| 32 | - */ |
|
| 33 | - private $message; |
|
| 34 | - |
|
| 35 | - |
|
| 36 | - /** |
|
| 37 | - * @var string $file |
|
| 38 | - */ |
|
| 39 | - private $file; |
|
| 40 | - |
|
| 41 | - |
|
| 42 | - /** |
|
| 43 | - * @var string $func |
|
| 44 | - */ |
|
| 45 | - private $func; |
|
| 46 | - |
|
| 47 | - |
|
| 48 | - /** |
|
| 49 | - * @var string $line |
|
| 50 | - */ |
|
| 51 | - private $line; |
|
| 52 | - |
|
| 53 | - |
|
| 54 | - /** |
|
| 55 | - * @var boolean $dismissible |
|
| 56 | - */ |
|
| 57 | - private $dismissible; |
|
| 58 | - |
|
| 59 | - |
|
| 60 | - /** |
|
| 61 | - * Notice constructor. |
|
| 62 | - * |
|
| 63 | - * @param string $type |
|
| 64 | - * @param string $message |
|
| 65 | - * @param bool $dismissible |
|
| 66 | - * @param string $file |
|
| 67 | - * @param string $func |
|
| 68 | - * @param string $line |
|
| 69 | - * @throws InvalidDataTypeException |
|
| 70 | - */ |
|
| 71 | - public function __construct($type, $message, $dismissible = true, $file = '', $func = '', $line = '') |
|
| 72 | - { |
|
| 73 | - $this->setType($type); |
|
| 74 | - $this->setMessage($message); |
|
| 75 | - $this->setDismissible($dismissible); |
|
| 76 | - $this->setFile($file); |
|
| 77 | - $this->setFunc($func); |
|
| 78 | - $this->setLine($line); |
|
| 79 | - } |
|
| 80 | - |
|
| 81 | - |
|
| 82 | - /** |
|
| 83 | - * @return array |
|
| 84 | - */ |
|
| 85 | - private function types() |
|
| 86 | - { |
|
| 87 | - return (array) apply_filters( |
|
| 88 | - 'FHEE__EventEspresso_core_services_notices_Notice__types', |
|
| 89 | - array( |
|
| 90 | - Notice::ERROR, |
|
| 91 | - Notice::SUCCESS, |
|
| 92 | - Notice::ATTENTION, |
|
| 93 | - Notice::INFORMATION, |
|
| 94 | - ) |
|
| 95 | - ); |
|
| 96 | - } |
|
| 97 | - |
|
| 98 | - |
|
| 99 | - /** |
|
| 100 | - * @return string |
|
| 101 | - */ |
|
| 102 | - public function type() |
|
| 103 | - { |
|
| 104 | - return $this->type; |
|
| 105 | - } |
|
| 106 | - |
|
| 107 | - |
|
| 108 | - /** |
|
| 109 | - * @return string |
|
| 110 | - */ |
|
| 111 | - public function message() |
|
| 112 | - { |
|
| 113 | - return $this->message; |
|
| 114 | - } |
|
| 115 | - |
|
| 116 | - |
|
| 117 | - /** |
|
| 118 | - * @return string |
|
| 119 | - */ |
|
| 120 | - public function file() |
|
| 121 | - { |
|
| 122 | - return $this->file; |
|
| 123 | - } |
|
| 124 | - |
|
| 125 | - |
|
| 126 | - /** |
|
| 127 | - * @return string |
|
| 128 | - */ |
|
| 129 | - public function func() |
|
| 130 | - { |
|
| 131 | - return $this->func; |
|
| 132 | - } |
|
| 133 | - |
|
| 134 | - |
|
| 135 | - /** |
|
| 136 | - * @return string |
|
| 137 | - */ |
|
| 138 | - public function line() |
|
| 139 | - { |
|
| 140 | - return $this->line; |
|
| 141 | - } |
|
| 142 | - |
|
| 143 | - |
|
| 144 | - /** |
|
| 145 | - * @return bool |
|
| 146 | - */ |
|
| 147 | - public function isDismissible() |
|
| 148 | - { |
|
| 149 | - return $this->dismissible; |
|
| 150 | - } |
|
| 151 | - |
|
| 152 | - |
|
| 153 | - /** |
|
| 154 | - * @param string $type |
|
| 155 | - * @throws InvalidDataTypeException |
|
| 156 | - */ |
|
| 157 | - private function setType($type) |
|
| 158 | - { |
|
| 159 | - if (! in_array($type, $this->types(), true)) { |
|
| 160 | - throw new InvalidDataTypeException( |
|
| 161 | - '$type', |
|
| 162 | - $type, |
|
| 163 | - $this->invalidTypeMessage() |
|
| 164 | - ); |
|
| 165 | - } |
|
| 166 | - $this->type = $type; |
|
| 167 | - } |
|
| 168 | - |
|
| 169 | - |
|
| 170 | - /** |
|
| 171 | - * gets the $invalid_type_message string |
|
| 172 | - */ |
|
| 173 | - private function invalidTypeMessage() |
|
| 174 | - { |
|
| 175 | - return apply_filters( |
|
| 176 | - 'FHEE__EventEspresso_core_services_notices_Notice__invalidTypeMessage', |
|
| 177 | - sprintf( |
|
| 178 | - esc_html__( |
|
| 179 | - ' one of the following notice types was expected: %1$s %2$s', |
|
| 180 | - 'event_espresso' |
|
| 181 | - ), |
|
| 182 | - '<br />', |
|
| 183 | - var_export($this->types(), true) |
|
| 184 | - ) |
|
| 185 | - ); |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - |
|
| 189 | - /** |
|
| 190 | - * @param string $message |
|
| 191 | - * @throws InvalidDataTypeException |
|
| 192 | - */ |
|
| 193 | - private function setMessage($message) |
|
| 194 | - { |
|
| 195 | - if (empty($message) || ! is_string($message)) { |
|
| 196 | - throw new InvalidDataTypeException( |
|
| 197 | - '$message', |
|
| 198 | - $message, |
|
| 199 | - esc_html__('non empty string', 'event_espresso') |
|
| 200 | - ); |
|
| 201 | - } |
|
| 202 | - $this->message = sanitize_text_field($message); |
|
| 203 | - } |
|
| 204 | - |
|
| 205 | - |
|
| 206 | - /** |
|
| 207 | - * @param string $file |
|
| 208 | - * @throws InvalidDataTypeException |
|
| 209 | - */ |
|
| 210 | - private function setFile($file) |
|
| 211 | - { |
|
| 212 | - if ($this->type === Notice::ERROR && (empty($file) || ! is_string($file))) { |
|
| 213 | - throw new InvalidDataTypeException( |
|
| 214 | - '$file', |
|
| 215 | - $file, |
|
| 216 | - esc_html__('non empty string', 'event_espresso') |
|
| 217 | - ); |
|
| 218 | - } |
|
| 219 | - $this->file = sanitize_text_field($file); |
|
| 220 | - } |
|
| 221 | - |
|
| 222 | - |
|
| 223 | - /** |
|
| 224 | - * @param string $func |
|
| 225 | - * @throws InvalidDataTypeException |
|
| 226 | - */ |
|
| 227 | - private function setFunc($func) |
|
| 228 | - { |
|
| 229 | - if ($this->type === Notice::ERROR && (empty($func) || ! is_string($func))) { |
|
| 230 | - throw new InvalidDataTypeException( |
|
| 231 | - '$func', |
|
| 232 | - $func, |
|
| 233 | - esc_html__('non empty string', 'event_espresso') |
|
| 234 | - ); |
|
| 235 | - } |
|
| 236 | - $this->func = sanitize_text_field($func); |
|
| 237 | - } |
|
| 238 | - |
|
| 239 | - |
|
| 240 | - /** |
|
| 241 | - * @param int $line |
|
| 242 | - * @throws InvalidDataTypeException |
|
| 243 | - */ |
|
| 244 | - private function setLine($line) |
|
| 245 | - { |
|
| 246 | - $line = absint($line); |
|
| 247 | - if ($this->type === Notice::ERROR && $line === 0) { |
|
| 248 | - throw new InvalidDataTypeException( |
|
| 249 | - '$line', |
|
| 250 | - $line, |
|
| 251 | - esc_html__('integer', 'event_espresso') |
|
| 252 | - ); |
|
| 253 | - } |
|
| 254 | - $this->line = sanitize_text_field($line); |
|
| 255 | - } |
|
| 256 | - |
|
| 257 | - |
|
| 258 | - /** |
|
| 259 | - * @param boolean $dismissible |
|
| 260 | - */ |
|
| 261 | - private function setDismissible($dismissible = true) |
|
| 262 | - { |
|
| 263 | - $this->dismissible = filter_var($dismissible, FILTER_VALIDATE_BOOLEAN); |
|
| 264 | - } |
|
| 16 | + const ERROR = 'error'; |
|
| 17 | + |
|
| 18 | + const SUCCESS = 'success'; |
|
| 19 | + |
|
| 20 | + const ATTENTION = 'attention'; // alias for warning |
|
| 21 | + |
|
| 22 | + const INFORMATION = 'information'; |
|
| 23 | + |
|
| 24 | + /** |
|
| 25 | + * @var string $type |
|
| 26 | + */ |
|
| 27 | + private $type; |
|
| 28 | + |
|
| 29 | + |
|
| 30 | + /** |
|
| 31 | + * @var string $message |
|
| 32 | + */ |
|
| 33 | + private $message; |
|
| 34 | + |
|
| 35 | + |
|
| 36 | + /** |
|
| 37 | + * @var string $file |
|
| 38 | + */ |
|
| 39 | + private $file; |
|
| 40 | + |
|
| 41 | + |
|
| 42 | + /** |
|
| 43 | + * @var string $func |
|
| 44 | + */ |
|
| 45 | + private $func; |
|
| 46 | + |
|
| 47 | + |
|
| 48 | + /** |
|
| 49 | + * @var string $line |
|
| 50 | + */ |
|
| 51 | + private $line; |
|
| 52 | + |
|
| 53 | + |
|
| 54 | + /** |
|
| 55 | + * @var boolean $dismissible |
|
| 56 | + */ |
|
| 57 | + private $dismissible; |
|
| 58 | + |
|
| 59 | + |
|
| 60 | + /** |
|
| 61 | + * Notice constructor. |
|
| 62 | + * |
|
| 63 | + * @param string $type |
|
| 64 | + * @param string $message |
|
| 65 | + * @param bool $dismissible |
|
| 66 | + * @param string $file |
|
| 67 | + * @param string $func |
|
| 68 | + * @param string $line |
|
| 69 | + * @throws InvalidDataTypeException |
|
| 70 | + */ |
|
| 71 | + public function __construct($type, $message, $dismissible = true, $file = '', $func = '', $line = '') |
|
| 72 | + { |
|
| 73 | + $this->setType($type); |
|
| 74 | + $this->setMessage($message); |
|
| 75 | + $this->setDismissible($dismissible); |
|
| 76 | + $this->setFile($file); |
|
| 77 | + $this->setFunc($func); |
|
| 78 | + $this->setLine($line); |
|
| 79 | + } |
|
| 80 | + |
|
| 81 | + |
|
| 82 | + /** |
|
| 83 | + * @return array |
|
| 84 | + */ |
|
| 85 | + private function types() |
|
| 86 | + { |
|
| 87 | + return (array) apply_filters( |
|
| 88 | + 'FHEE__EventEspresso_core_services_notices_Notice__types', |
|
| 89 | + array( |
|
| 90 | + Notice::ERROR, |
|
| 91 | + Notice::SUCCESS, |
|
| 92 | + Notice::ATTENTION, |
|
| 93 | + Notice::INFORMATION, |
|
| 94 | + ) |
|
| 95 | + ); |
|
| 96 | + } |
|
| 97 | + |
|
| 98 | + |
|
| 99 | + /** |
|
| 100 | + * @return string |
|
| 101 | + */ |
|
| 102 | + public function type() |
|
| 103 | + { |
|
| 104 | + return $this->type; |
|
| 105 | + } |
|
| 106 | + |
|
| 107 | + |
|
| 108 | + /** |
|
| 109 | + * @return string |
|
| 110 | + */ |
|
| 111 | + public function message() |
|
| 112 | + { |
|
| 113 | + return $this->message; |
|
| 114 | + } |
|
| 115 | + |
|
| 116 | + |
|
| 117 | + /** |
|
| 118 | + * @return string |
|
| 119 | + */ |
|
| 120 | + public function file() |
|
| 121 | + { |
|
| 122 | + return $this->file; |
|
| 123 | + } |
|
| 124 | + |
|
| 125 | + |
|
| 126 | + /** |
|
| 127 | + * @return string |
|
| 128 | + */ |
|
| 129 | + public function func() |
|
| 130 | + { |
|
| 131 | + return $this->func; |
|
| 132 | + } |
|
| 133 | + |
|
| 134 | + |
|
| 135 | + /** |
|
| 136 | + * @return string |
|
| 137 | + */ |
|
| 138 | + public function line() |
|
| 139 | + { |
|
| 140 | + return $this->line; |
|
| 141 | + } |
|
| 142 | + |
|
| 143 | + |
|
| 144 | + /** |
|
| 145 | + * @return bool |
|
| 146 | + */ |
|
| 147 | + public function isDismissible() |
|
| 148 | + { |
|
| 149 | + return $this->dismissible; |
|
| 150 | + } |
|
| 151 | + |
|
| 152 | + |
|
| 153 | + /** |
|
| 154 | + * @param string $type |
|
| 155 | + * @throws InvalidDataTypeException |
|
| 156 | + */ |
|
| 157 | + private function setType($type) |
|
| 158 | + { |
|
| 159 | + if (! in_array($type, $this->types(), true)) { |
|
| 160 | + throw new InvalidDataTypeException( |
|
| 161 | + '$type', |
|
| 162 | + $type, |
|
| 163 | + $this->invalidTypeMessage() |
|
| 164 | + ); |
|
| 165 | + } |
|
| 166 | + $this->type = $type; |
|
| 167 | + } |
|
| 168 | + |
|
| 169 | + |
|
| 170 | + /** |
|
| 171 | + * gets the $invalid_type_message string |
|
| 172 | + */ |
|
| 173 | + private function invalidTypeMessage() |
|
| 174 | + { |
|
| 175 | + return apply_filters( |
|
| 176 | + 'FHEE__EventEspresso_core_services_notices_Notice__invalidTypeMessage', |
|
| 177 | + sprintf( |
|
| 178 | + esc_html__( |
|
| 179 | + ' one of the following notice types was expected: %1$s %2$s', |
|
| 180 | + 'event_espresso' |
|
| 181 | + ), |
|
| 182 | + '<br />', |
|
| 183 | + var_export($this->types(), true) |
|
| 184 | + ) |
|
| 185 | + ); |
|
| 186 | + } |
|
| 187 | + |
|
| 188 | + |
|
| 189 | + /** |
|
| 190 | + * @param string $message |
|
| 191 | + * @throws InvalidDataTypeException |
|
| 192 | + */ |
|
| 193 | + private function setMessage($message) |
|
| 194 | + { |
|
| 195 | + if (empty($message) || ! is_string($message)) { |
|
| 196 | + throw new InvalidDataTypeException( |
|
| 197 | + '$message', |
|
| 198 | + $message, |
|
| 199 | + esc_html__('non empty string', 'event_espresso') |
|
| 200 | + ); |
|
| 201 | + } |
|
| 202 | + $this->message = sanitize_text_field($message); |
|
| 203 | + } |
|
| 204 | + |
|
| 205 | + |
|
| 206 | + /** |
|
| 207 | + * @param string $file |
|
| 208 | + * @throws InvalidDataTypeException |
|
| 209 | + */ |
|
| 210 | + private function setFile($file) |
|
| 211 | + { |
|
| 212 | + if ($this->type === Notice::ERROR && (empty($file) || ! is_string($file))) { |
|
| 213 | + throw new InvalidDataTypeException( |
|
| 214 | + '$file', |
|
| 215 | + $file, |
|
| 216 | + esc_html__('non empty string', 'event_espresso') |
|
| 217 | + ); |
|
| 218 | + } |
|
| 219 | + $this->file = sanitize_text_field($file); |
|
| 220 | + } |
|
| 221 | + |
|
| 222 | + |
|
| 223 | + /** |
|
| 224 | + * @param string $func |
|
| 225 | + * @throws InvalidDataTypeException |
|
| 226 | + */ |
|
| 227 | + private function setFunc($func) |
|
| 228 | + { |
|
| 229 | + if ($this->type === Notice::ERROR && (empty($func) || ! is_string($func))) { |
|
| 230 | + throw new InvalidDataTypeException( |
|
| 231 | + '$func', |
|
| 232 | + $func, |
|
| 233 | + esc_html__('non empty string', 'event_espresso') |
|
| 234 | + ); |
|
| 235 | + } |
|
| 236 | + $this->func = sanitize_text_field($func); |
|
| 237 | + } |
|
| 238 | + |
|
| 239 | + |
|
| 240 | + /** |
|
| 241 | + * @param int $line |
|
| 242 | + * @throws InvalidDataTypeException |
|
| 243 | + */ |
|
| 244 | + private function setLine($line) |
|
| 245 | + { |
|
| 246 | + $line = absint($line); |
|
| 247 | + if ($this->type === Notice::ERROR && $line === 0) { |
|
| 248 | + throw new InvalidDataTypeException( |
|
| 249 | + '$line', |
|
| 250 | + $line, |
|
| 251 | + esc_html__('integer', 'event_espresso') |
|
| 252 | + ); |
|
| 253 | + } |
|
| 254 | + $this->line = sanitize_text_field($line); |
|
| 255 | + } |
|
| 256 | + |
|
| 257 | + |
|
| 258 | + /** |
|
| 259 | + * @param boolean $dismissible |
|
| 260 | + */ |
|
| 261 | + private function setDismissible($dismissible = true) |
|
| 262 | + { |
|
| 263 | + $this->dismissible = filter_var($dismissible, FILTER_VALIDATE_BOOLEAN); |
|
| 264 | + } |
|
| 265 | 265 | } |
@@ -119,9 +119,9 @@ discard block |
||
| 119 | 119 | $headers, |
| 120 | 120 | array_flip( |
| 121 | 121 | array( |
| 122 | - Base::HEADER_PREFIX_FOR_WP . 'Total', |
|
| 123 | - Base::HEADER_PREFIX_FOR_WP . 'TotalPages', |
|
| 124 | - Base::HEADER_PREFIX_FOR_WP . 'PageSize', |
|
| 122 | + Base::HEADER_PREFIX_FOR_WP.'Total', |
|
| 123 | + Base::HEADER_PREFIX_FOR_WP.'TotalPages', |
|
| 124 | + Base::HEADER_PREFIX_FOR_WP.'PageSize', |
|
| 125 | 125 | ) |
| 126 | 126 | ) |
| 127 | 127 | ); |
@@ -151,7 +151,7 @@ discard block |
||
| 151 | 151 | && $model instanceof \EEM_CPT_Base |
| 152 | 152 | ) { |
| 153 | 153 | $attachment = wp_get_attachment_image_src( |
| 154 | - get_post_thumbnail_id($entity_response_array[ $model->primary_key_name() ]), |
|
| 154 | + get_post_thumbnail_id($entity_response_array[$model->primary_key_name()]), |
|
| 155 | 155 | 'full' |
| 156 | 156 | ); |
| 157 | 157 | $entity_response_array['featured_image_url'] = ! empty($attachment) ? $attachment[0] : null; |
@@ -16,176 +16,176 @@ |
||
| 16 | 16 | class ChangesIn40836 extends ChangesInBase |
| 17 | 17 | { |
| 18 | 18 | |
| 19 | - /** |
|
| 20 | - * Adds hooks so requests to 4.8.29 don't have the checkin endpoints |
|
| 21 | - */ |
|
| 22 | - public function setHooks() |
|
| 23 | - { |
|
| 24 | - // set a hook to remove the "calculate" query param |
|
| 25 | - add_filter( |
|
| 26 | - 'FHEE__EED_Core_Rest_Api___get_response_selection_query_params', |
|
| 27 | - array($this, 'removeCalculateQueryParam'), |
|
| 28 | - 10, |
|
| 29 | - 3 |
|
| 30 | - ); |
|
| 31 | - // don't add the _calculated_fields either |
|
| 32 | - add_filter( |
|
| 33 | - 'FHEE__Read__create_entity_from_wpdb_results__entity_before_inaccessible_field_removal', |
|
| 34 | - array($this, 'removeCalculatedFieldsFromResponse'), |
|
| 35 | - 10, |
|
| 36 | - 5 |
|
| 37 | - ); |
|
| 38 | - // and also don't add the count headers |
|
| 39 | - add_filter( |
|
| 40 | - 'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers', |
|
| 41 | - array($this, 'removeHeadersNewInThisVersion'), |
|
| 42 | - 10, |
|
| 43 | - 3 |
|
| 44 | - ); |
|
| 45 | - // remove the old featured_image part of the response... |
|
| 46 | - add_filter( |
|
| 47 | - 'FHEE__Read__create_entity_from_wpdb_results__entity_before_including_requested_models', |
|
| 48 | - array($this, 'addOldFeaturedImagePartOfCptEntities'), |
|
| 49 | - 10, |
|
| 50 | - 5 |
|
| 51 | - ); |
|
| 52 | - // assuming ticket 9425's change gets pushed with 9406, we don't need to |
|
| 53 | - // remove it from the calculated fields on older requests (because this will |
|
| 54 | - // be the first version with calculated fields) |
|
| 55 | - // before this, infinity was -1, now it's null |
|
| 56 | - add_filter( |
|
| 57 | - 'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api', |
|
| 58 | - array($this, 'useNegativeOneForInfinityBeforeThisVersion'), |
|
| 59 | - 10, |
|
| 60 | - 4 |
|
| 61 | - ); |
|
| 62 | - } |
|
| 19 | + /** |
|
| 20 | + * Adds hooks so requests to 4.8.29 don't have the checkin endpoints |
|
| 21 | + */ |
|
| 22 | + public function setHooks() |
|
| 23 | + { |
|
| 24 | + // set a hook to remove the "calculate" query param |
|
| 25 | + add_filter( |
|
| 26 | + 'FHEE__EED_Core_Rest_Api___get_response_selection_query_params', |
|
| 27 | + array($this, 'removeCalculateQueryParam'), |
|
| 28 | + 10, |
|
| 29 | + 3 |
|
| 30 | + ); |
|
| 31 | + // don't add the _calculated_fields either |
|
| 32 | + add_filter( |
|
| 33 | + 'FHEE__Read__create_entity_from_wpdb_results__entity_before_inaccessible_field_removal', |
|
| 34 | + array($this, 'removeCalculatedFieldsFromResponse'), |
|
| 35 | + 10, |
|
| 36 | + 5 |
|
| 37 | + ); |
|
| 38 | + // and also don't add the count headers |
|
| 39 | + add_filter( |
|
| 40 | + 'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers', |
|
| 41 | + array($this, 'removeHeadersNewInThisVersion'), |
|
| 42 | + 10, |
|
| 43 | + 3 |
|
| 44 | + ); |
|
| 45 | + // remove the old featured_image part of the response... |
|
| 46 | + add_filter( |
|
| 47 | + 'FHEE__Read__create_entity_from_wpdb_results__entity_before_including_requested_models', |
|
| 48 | + array($this, 'addOldFeaturedImagePartOfCptEntities'), |
|
| 49 | + 10, |
|
| 50 | + 5 |
|
| 51 | + ); |
|
| 52 | + // assuming ticket 9425's change gets pushed with 9406, we don't need to |
|
| 53 | + // remove it from the calculated fields on older requests (because this will |
|
| 54 | + // be the first version with calculated fields) |
|
| 55 | + // before this, infinity was -1, now it's null |
|
| 56 | + add_filter( |
|
| 57 | + 'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api', |
|
| 58 | + array($this, 'useNegativeOneForInfinityBeforeThisVersion'), |
|
| 59 | + 10, |
|
| 60 | + 4 |
|
| 61 | + ); |
|
| 62 | + } |
|
| 63 | 63 | |
| 64 | 64 | |
| 65 | - /** |
|
| 66 | - * Don't show "calculate" as an query param option in the index |
|
| 67 | - * |
|
| 68 | - * @param array $query_params |
|
| 69 | - * @param EEM_Base $model |
|
| 70 | - * @param string $version |
|
| 71 | - * @return array |
|
| 72 | - */ |
|
| 73 | - public function removeCalculateQueryParam($query_params, EEM_Base $model, $version) |
|
| 74 | - { |
|
| 75 | - if ($this->appliesToVersion($version)) { |
|
| 76 | - unset($query_params['calculate']); |
|
| 77 | - } |
|
| 78 | - return $query_params; |
|
| 79 | - } |
|
| 65 | + /** |
|
| 66 | + * Don't show "calculate" as an query param option in the index |
|
| 67 | + * |
|
| 68 | + * @param array $query_params |
|
| 69 | + * @param EEM_Base $model |
|
| 70 | + * @param string $version |
|
| 71 | + * @return array |
|
| 72 | + */ |
|
| 73 | + public function removeCalculateQueryParam($query_params, EEM_Base $model, $version) |
|
| 74 | + { |
|
| 75 | + if ($this->appliesToVersion($version)) { |
|
| 76 | + unset($query_params['calculate']); |
|
| 77 | + } |
|
| 78 | + return $query_params; |
|
| 79 | + } |
|
| 80 | 80 | |
| 81 | 81 | |
| 82 | - /** |
|
| 83 | - * Removes the "_calculate_fields" part of entity responses before 4.8.36 |
|
| 84 | - * |
|
| 85 | - * @param array $entity_response_array |
|
| 86 | - * @param EEM_Base $model |
|
| 87 | - * @param string $request_context |
|
| 88 | - * @param WP_REST_Request $request |
|
| 89 | - * @param Read $controller |
|
| 90 | - * @return array |
|
| 91 | - */ |
|
| 92 | - public function removeCalculatedFieldsFromResponse( |
|
| 93 | - $entity_response_array, |
|
| 94 | - EEM_Base $model, |
|
| 95 | - $request_context, |
|
| 96 | - WP_REST_Request $request, |
|
| 97 | - Read $controller |
|
| 98 | - ) { |
|
| 99 | - if ($this->appliesToVersion($controller->getModelVersionInfo()->requestedVersion())) { |
|
| 100 | - unset($entity_response_array['_calculated_fields']); |
|
| 101 | - } |
|
| 102 | - return $entity_response_array; |
|
| 103 | - } |
|
| 82 | + /** |
|
| 83 | + * Removes the "_calculate_fields" part of entity responses before 4.8.36 |
|
| 84 | + * |
|
| 85 | + * @param array $entity_response_array |
|
| 86 | + * @param EEM_Base $model |
|
| 87 | + * @param string $request_context |
|
| 88 | + * @param WP_REST_Request $request |
|
| 89 | + * @param Read $controller |
|
| 90 | + * @return array |
|
| 91 | + */ |
|
| 92 | + public function removeCalculatedFieldsFromResponse( |
|
| 93 | + $entity_response_array, |
|
| 94 | + EEM_Base $model, |
|
| 95 | + $request_context, |
|
| 96 | + WP_REST_Request $request, |
|
| 97 | + Read $controller |
|
| 98 | + ) { |
|
| 99 | + if ($this->appliesToVersion($controller->getModelVersionInfo()->requestedVersion())) { |
|
| 100 | + unset($entity_response_array['_calculated_fields']); |
|
| 101 | + } |
|
| 102 | + return $entity_response_array; |
|
| 103 | + } |
|
| 104 | 104 | |
| 105 | 105 | |
| 106 | - /** |
|
| 107 | - * Removes the new headers for requests before 4.8.36 |
|
| 108 | - * |
|
| 109 | - * @param array $headers |
|
| 110 | - * @param Controller_Base $controller |
|
| 111 | - * @param string $version |
|
| 112 | - * @return array |
|
| 113 | - */ |
|
| 114 | - public function removeHeadersNewInThisVersion( |
|
| 115 | - $headers, |
|
| 116 | - Controller_Base $controller, |
|
| 117 | - $version |
|
| 118 | - ) { |
|
| 119 | - if ($this->appliesToVersion($version)) { |
|
| 120 | - $headers = array_diff_key( |
|
| 121 | - $headers, |
|
| 122 | - array_flip( |
|
| 123 | - array( |
|
| 124 | - Base::HEADER_PREFIX_FOR_WP . 'Total', |
|
| 125 | - Base::HEADER_PREFIX_FOR_WP . 'TotalPages', |
|
| 126 | - Base::HEADER_PREFIX_FOR_WP . 'PageSize', |
|
| 127 | - ) |
|
| 128 | - ) |
|
| 129 | - ); |
|
| 130 | - } |
|
| 131 | - return $headers; |
|
| 132 | - } |
|
| 106 | + /** |
|
| 107 | + * Removes the new headers for requests before 4.8.36 |
|
| 108 | + * |
|
| 109 | + * @param array $headers |
|
| 110 | + * @param Controller_Base $controller |
|
| 111 | + * @param string $version |
|
| 112 | + * @return array |
|
| 113 | + */ |
|
| 114 | + public function removeHeadersNewInThisVersion( |
|
| 115 | + $headers, |
|
| 116 | + Controller_Base $controller, |
|
| 117 | + $version |
|
| 118 | + ) { |
|
| 119 | + if ($this->appliesToVersion($version)) { |
|
| 120 | + $headers = array_diff_key( |
|
| 121 | + $headers, |
|
| 122 | + array_flip( |
|
| 123 | + array( |
|
| 124 | + Base::HEADER_PREFIX_FOR_WP . 'Total', |
|
| 125 | + Base::HEADER_PREFIX_FOR_WP . 'TotalPages', |
|
| 126 | + Base::HEADER_PREFIX_FOR_WP . 'PageSize', |
|
| 127 | + ) |
|
| 128 | + ) |
|
| 129 | + ); |
|
| 130 | + } |
|
| 131 | + return $headers; |
|
| 132 | + } |
|
| 133 | 133 | |
| 134 | 134 | |
| 135 | - /** |
|
| 136 | - * Puts the 'featured_image_url' back in for responses before 4.8.36. |
|
| 137 | - * |
|
| 138 | - * @param array $entity_response_array |
|
| 139 | - * @param EEM_Base $model |
|
| 140 | - * @param string $request_context |
|
| 141 | - * @param WP_REST_Request $request |
|
| 142 | - * @param Read $controller |
|
| 143 | - * @return array |
|
| 144 | - */ |
|
| 145 | - public function addOldFeaturedImagePartOfCptEntities( |
|
| 146 | - $entity_response_array, |
|
| 147 | - EEM_Base $model, |
|
| 148 | - $request_context, |
|
| 149 | - WP_REST_Request $request, |
|
| 150 | - Read $controller |
|
| 151 | - ) { |
|
| 152 | - if ( |
|
| 153 | - $this->appliesToVersion($controller->getModelVersionInfo()->requestedVersion()) |
|
| 154 | - && $model instanceof \EEM_CPT_Base |
|
| 155 | - ) { |
|
| 156 | - $attachment = wp_get_attachment_image_src( |
|
| 157 | - get_post_thumbnail_id($entity_response_array[ $model->primary_key_name() ]), |
|
| 158 | - 'full' |
|
| 159 | - ); |
|
| 160 | - $entity_response_array['featured_image_url'] = ! empty($attachment) ? $attachment[0] : null; |
|
| 161 | - } |
|
| 162 | - return $entity_response_array; |
|
| 163 | - } |
|
| 135 | + /** |
|
| 136 | + * Puts the 'featured_image_url' back in for responses before 4.8.36. |
|
| 137 | + * |
|
| 138 | + * @param array $entity_response_array |
|
| 139 | + * @param EEM_Base $model |
|
| 140 | + * @param string $request_context |
|
| 141 | + * @param WP_REST_Request $request |
|
| 142 | + * @param Read $controller |
|
| 143 | + * @return array |
|
| 144 | + */ |
|
| 145 | + public function addOldFeaturedImagePartOfCptEntities( |
|
| 146 | + $entity_response_array, |
|
| 147 | + EEM_Base $model, |
|
| 148 | + $request_context, |
|
| 149 | + WP_REST_Request $request, |
|
| 150 | + Read $controller |
|
| 151 | + ) { |
|
| 152 | + if ( |
|
| 153 | + $this->appliesToVersion($controller->getModelVersionInfo()->requestedVersion()) |
|
| 154 | + && $model instanceof \EEM_CPT_Base |
|
| 155 | + ) { |
|
| 156 | + $attachment = wp_get_attachment_image_src( |
|
| 157 | + get_post_thumbnail_id($entity_response_array[ $model->primary_key_name() ]), |
|
| 158 | + 'full' |
|
| 159 | + ); |
|
| 160 | + $entity_response_array['featured_image_url'] = ! empty($attachment) ? $attachment[0] : null; |
|
| 161 | + } |
|
| 162 | + return $entity_response_array; |
|
| 163 | + } |
|
| 164 | 164 | |
| 165 | 165 | |
| 166 | - /** |
|
| 167 | - * If the value was infinity, we now use null in our JSON responses, |
|
| 168 | - * but before this version we used -1. |
|
| 169 | - * |
|
| 170 | - * @param mixed $new_value |
|
| 171 | - * @param \EE_Model_Field_Base $field_obj |
|
| 172 | - * @param mixed $original_value |
|
| 173 | - * @param string $requested_value |
|
| 174 | - * @return mixed |
|
| 175 | - */ |
|
| 176 | - public function useNegativeOneForInfinityBeforeThisVersion( |
|
| 177 | - $new_value, |
|
| 178 | - $field_obj, |
|
| 179 | - $original_value, |
|
| 180 | - $requested_value |
|
| 181 | - ) { |
|
| 182 | - if ( |
|
| 183 | - $this->appliesToVersion($requested_value) |
|
| 184 | - && $original_value === EE_INF |
|
| 185 | - ) { |
|
| 186 | - // return the old representation of infinity in the JSON |
|
| 187 | - return -1; |
|
| 188 | - } |
|
| 189 | - return $new_value; |
|
| 190 | - } |
|
| 166 | + /** |
|
| 167 | + * If the value was infinity, we now use null in our JSON responses, |
|
| 168 | + * but before this version we used -1. |
|
| 169 | + * |
|
| 170 | + * @param mixed $new_value |
|
| 171 | + * @param \EE_Model_Field_Base $field_obj |
|
| 172 | + * @param mixed $original_value |
|
| 173 | + * @param string $requested_value |
|
| 174 | + * @return mixed |
|
| 175 | + */ |
|
| 176 | + public function useNegativeOneForInfinityBeforeThisVersion( |
|
| 177 | + $new_value, |
|
| 178 | + $field_obj, |
|
| 179 | + $original_value, |
|
| 180 | + $requested_value |
|
| 181 | + ) { |
|
| 182 | + if ( |
|
| 183 | + $this->appliesToVersion($requested_value) |
|
| 184 | + && $original_value === EE_INF |
|
| 185 | + ) { |
|
| 186 | + // return the old representation of infinity in the JSON |
|
| 187 | + return -1; |
|
| 188 | + } |
|
| 189 | + return $new_value; |
|
| 190 | + } |
|
| 191 | 191 | } |