@@ -15,39 +15,39 @@ |
||
| 15 | 15 | { |
| 16 | 16 | |
| 17 | 17 | |
| 18 | - /** |
|
| 19 | - * @param string $address |
|
| 20 | - * @param string $address2 |
|
| 21 | - * @param string $city |
|
| 22 | - * @param string $state |
|
| 23 | - * @param string $zip |
|
| 24 | - * @param string $country |
|
| 25 | - * @param string $CNT_ISO |
|
| 26 | - * @return string |
|
| 27 | - */ |
|
| 28 | - public function format($address, $address2, $city, $state, $zip, $country, $CNT_ISO) |
|
| 29 | - { |
|
| 30 | - $address_formats = apply_filters( |
|
| 31 | - 'FHEE__EE_MultiLine_Address_Formatter__address_formats', |
|
| 32 | - array( |
|
| 33 | - 'CA' => "{address}%{address2}%{city}%{state}%{country}%{zip}", |
|
| 34 | - 'GB' => "{address}%{address2}%{city}%{state}%{zip}%{country}", |
|
| 35 | - 'US' => "{address}%{address2}%{city}%{state}%{zip}%{country}", |
|
| 36 | - 'ZZ' => "{address}%{address2}%{city}%{state}%{zip}%{country}", |
|
| 37 | - ) |
|
| 38 | - ); |
|
| 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 ] |
|
| 41 | - : $address_formats['ZZ']; |
|
| 42 | - return $this->parse_formatted_address( |
|
| 43 | - $address, |
|
| 44 | - $address2, |
|
| 45 | - $city, |
|
| 46 | - $state, |
|
| 47 | - $zip, |
|
| 48 | - $country, |
|
| 49 | - $formatted_address, |
|
| 50 | - '<br />' |
|
| 51 | - ); |
|
| 52 | - } |
|
| 18 | + /** |
|
| 19 | + * @param string $address |
|
| 20 | + * @param string $address2 |
|
| 21 | + * @param string $city |
|
| 22 | + * @param string $state |
|
| 23 | + * @param string $zip |
|
| 24 | + * @param string $country |
|
| 25 | + * @param string $CNT_ISO |
|
| 26 | + * @return string |
|
| 27 | + */ |
|
| 28 | + public function format($address, $address2, $city, $state, $zip, $country, $CNT_ISO) |
|
| 29 | + { |
|
| 30 | + $address_formats = apply_filters( |
|
| 31 | + 'FHEE__EE_MultiLine_Address_Formatter__address_formats', |
|
| 32 | + array( |
|
| 33 | + 'CA' => "{address}%{address2}%{city}%{state}%{country}%{zip}", |
|
| 34 | + 'GB' => "{address}%{address2}%{city}%{state}%{zip}%{country}", |
|
| 35 | + 'US' => "{address}%{address2}%{city}%{state}%{zip}%{country}", |
|
| 36 | + 'ZZ' => "{address}%{address2}%{city}%{state}%{zip}%{country}", |
|
| 37 | + ) |
|
| 38 | + ); |
|
| 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 ] |
|
| 41 | + : $address_formats['ZZ']; |
|
| 42 | + return $this->parse_formatted_address( |
|
| 43 | + $address, |
|
| 44 | + $address2, |
|
| 45 | + $city, |
|
| 46 | + $state, |
|
| 47 | + $zip, |
|
| 48 | + $country, |
|
| 49 | + $formatted_address, |
|
| 50 | + '<br />' |
|
| 51 | + ); |
|
| 52 | + } |
|
| 53 | 53 | } |
@@ -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, |
@@ -14,39 +14,39 @@ |
||
| 14 | 14 | class InlineAddressFormatter extends AddressFormatter implements \EEI_Address_Formatter |
| 15 | 15 | { |
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * @param string $address |
|
| 19 | - * @param string $address2 |
|
| 20 | - * @param string $city |
|
| 21 | - * @param string $state |
|
| 22 | - * @param string $zip |
|
| 23 | - * @param string $country |
|
| 24 | - * @param string $CNT_ISO |
|
| 25 | - * @return string |
|
| 26 | - */ |
|
| 27 | - public function format($address, $address2, $city, $state, $zip, $country, $CNT_ISO) |
|
| 28 | - { |
|
| 29 | - $address_formats = apply_filters( |
|
| 30 | - 'FHEE__EE_Inline_Address_Formatter__address_formats', |
|
| 31 | - array( |
|
| 32 | - 'CA' => "{address}%{address2}%{city}%{state}%{country}%{zip}", |
|
| 33 | - 'GB' => "{address}%{address2}%{city}%{state}%{zip}%{country}", |
|
| 34 | - 'US' => "{address}%{address2}%{city}%{state}%{zip}%{country}", |
|
| 35 | - 'ZZZ' => "{address}%{address2}%{city}%{state}%{zip}%{country}", |
|
| 36 | - ) |
|
| 37 | - ); |
|
| 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 ] |
|
| 40 | - : $address_formats['ZZZ']; |
|
| 41 | - return $this->parse_formatted_address( |
|
| 42 | - $address, |
|
| 43 | - $address2, |
|
| 44 | - $city, |
|
| 45 | - $state, |
|
| 46 | - $zip, |
|
| 47 | - $country, |
|
| 48 | - $formatted_address, |
|
| 49 | - ', ' |
|
| 50 | - ); |
|
| 51 | - } |
|
| 17 | + /** |
|
| 18 | + * @param string $address |
|
| 19 | + * @param string $address2 |
|
| 20 | + * @param string $city |
|
| 21 | + * @param string $state |
|
| 22 | + * @param string $zip |
|
| 23 | + * @param string $country |
|
| 24 | + * @param string $CNT_ISO |
|
| 25 | + * @return string |
|
| 26 | + */ |
|
| 27 | + public function format($address, $address2, $city, $state, $zip, $country, $CNT_ISO) |
|
| 28 | + { |
|
| 29 | + $address_formats = apply_filters( |
|
| 30 | + 'FHEE__EE_Inline_Address_Formatter__address_formats', |
|
| 31 | + array( |
|
| 32 | + 'CA' => "{address}%{address2}%{city}%{state}%{country}%{zip}", |
|
| 33 | + 'GB' => "{address}%{address2}%{city}%{state}%{zip}%{country}", |
|
| 34 | + 'US' => "{address}%{address2}%{city}%{state}%{zip}%{country}", |
|
| 35 | + 'ZZZ' => "{address}%{address2}%{city}%{state}%{zip}%{country}", |
|
| 36 | + ) |
|
| 37 | + ); |
|
| 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 ] |
|
| 40 | + : $address_formats['ZZZ']; |
|
| 41 | + return $this->parse_formatted_address( |
|
| 42 | + $address, |
|
| 43 | + $address2, |
|
| 44 | + $city, |
|
| 45 | + $state, |
|
| 46 | + $zip, |
|
| 47 | + $country, |
|
| 48 | + $formatted_address, |
|
| 49 | + ', ' |
|
| 50 | + ); |
|
| 51 | + } |
|
| 52 | 52 | } |
@@ -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, |
@@ -17,88 +17,88 @@ |
||
| 17 | 17 | class FileLocator extends Locator |
| 18 | 18 | { |
| 19 | 19 | |
| 20 | - /** |
|
| 21 | - * @var string $file_mask |
|
| 22 | - */ |
|
| 23 | - protected $file_mask = '*.php'; |
|
| 20 | + /** |
|
| 21 | + * @var string $file_mask |
|
| 22 | + */ |
|
| 23 | + protected $file_mask = '*.php'; |
|
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * @var array $filepaths |
|
| 27 | - */ |
|
| 28 | - protected $filepaths = array(); |
|
| 25 | + /** |
|
| 26 | + * @var array $filepaths |
|
| 27 | + */ |
|
| 28 | + protected $filepaths = array(); |
|
| 29 | 29 | |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * @param string $file_mask |
|
| 33 | - * @throws \EventEspresso\core\exceptions\InvalidDataTypeException |
|
| 34 | - */ |
|
| 35 | - public function setFileMask($file_mask) |
|
| 36 | - { |
|
| 37 | - if (! is_string($file_mask)) { |
|
| 38 | - throw new InvalidDataTypeException('$file_mask', $file_mask, 'string'); |
|
| 39 | - } |
|
| 40 | - $this->file_mask = $file_mask; |
|
| 41 | - } |
|
| 31 | + /** |
|
| 32 | + * @param string $file_mask |
|
| 33 | + * @throws \EventEspresso\core\exceptions\InvalidDataTypeException |
|
| 34 | + */ |
|
| 35 | + public function setFileMask($file_mask) |
|
| 36 | + { |
|
| 37 | + if (! is_string($file_mask)) { |
|
| 38 | + throw new InvalidDataTypeException('$file_mask', $file_mask, 'string'); |
|
| 39 | + } |
|
| 40 | + $this->file_mask = $file_mask; |
|
| 41 | + } |
|
| 42 | 42 | |
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * @access public |
|
| 46 | - * @return array |
|
| 47 | - */ |
|
| 48 | - public function getFilePaths() |
|
| 49 | - { |
|
| 50 | - return $this->filepaths; |
|
| 51 | - } |
|
| 44 | + /** |
|
| 45 | + * @access public |
|
| 46 | + * @return array |
|
| 47 | + */ |
|
| 48 | + public function getFilePaths() |
|
| 49 | + { |
|
| 50 | + return $this->filepaths; |
|
| 51 | + } |
|
| 52 | 52 | |
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * @access public |
|
| 56 | - * @return int |
|
| 57 | - */ |
|
| 58 | - public function count() |
|
| 59 | - { |
|
| 60 | - return count($this->filepaths); |
|
| 61 | - } |
|
| 54 | + /** |
|
| 55 | + * @access public |
|
| 56 | + * @return int |
|
| 57 | + */ |
|
| 58 | + public function count() |
|
| 59 | + { |
|
| 60 | + return count($this->filepaths); |
|
| 61 | + } |
|
| 62 | 62 | |
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * given a path to a valid directory, or an array of valid paths, |
|
| 66 | - * will find all files that match the provided mask |
|
| 67 | - * |
|
| 68 | - * @access public |
|
| 69 | - * @param array|string $directory_paths |
|
| 70 | - * @return \FilesystemIterator |
|
| 71 | - * @throws \EventEspresso\core\exceptions\InvalidDataTypeException |
|
| 72 | - */ |
|
| 73 | - public function locate($directory_paths) |
|
| 74 | - { |
|
| 75 | - if (! (is_string($directory_paths) || is_array($directory_paths))) { |
|
| 76 | - throw new InvalidDataTypeException('$directory_paths', $directory_paths, 'string or array'); |
|
| 77 | - } |
|
| 78 | - foreach ((array) $directory_paths as $directory_path) { |
|
| 79 | - foreach ($this->findFilesByPath($directory_path) as $key => $file) { |
|
| 80 | - $this->filepaths[ $key ] = \EEH_File::standardise_directory_separators($file); |
|
| 81 | - } |
|
| 82 | - } |
|
| 83 | - return $this->filepaths; |
|
| 84 | - } |
|
| 64 | + /** |
|
| 65 | + * given a path to a valid directory, or an array of valid paths, |
|
| 66 | + * will find all files that match the provided mask |
|
| 67 | + * |
|
| 68 | + * @access public |
|
| 69 | + * @param array|string $directory_paths |
|
| 70 | + * @return \FilesystemIterator |
|
| 71 | + * @throws \EventEspresso\core\exceptions\InvalidDataTypeException |
|
| 72 | + */ |
|
| 73 | + public function locate($directory_paths) |
|
| 74 | + { |
|
| 75 | + if (! (is_string($directory_paths) || is_array($directory_paths))) { |
|
| 76 | + throw new InvalidDataTypeException('$directory_paths', $directory_paths, 'string or array'); |
|
| 77 | + } |
|
| 78 | + foreach ((array) $directory_paths as $directory_path) { |
|
| 79 | + foreach ($this->findFilesByPath($directory_path) as $key => $file) { |
|
| 80 | + $this->filepaths[ $key ] = \EEH_File::standardise_directory_separators($file); |
|
| 81 | + } |
|
| 82 | + } |
|
| 83 | + return $this->filepaths; |
|
| 84 | + } |
|
| 85 | 85 | |
| 86 | 86 | |
| 87 | - /** |
|
| 88 | - * given a path to a valid directory, will find all files that match the provided mask |
|
| 89 | - * |
|
| 90 | - * @access protected |
|
| 91 | - * @param string $directory_path |
|
| 92 | - * @return \FilesystemIterator |
|
| 93 | - */ |
|
| 94 | - protected function findFilesByPath($directory_path = '') |
|
| 95 | - { |
|
| 96 | - $iterator = new GlobIterator( |
|
| 97 | - \EEH_File::end_with_directory_separator($directory_path) . $this->file_mask |
|
| 98 | - ); |
|
| 99 | - foreach ($this->flags as $flag) { |
|
| 100 | - $iterator->setFlags($flag); |
|
| 101 | - } |
|
| 102 | - return $iterator; |
|
| 103 | - } |
|
| 87 | + /** |
|
| 88 | + * given a path to a valid directory, will find all files that match the provided mask |
|
| 89 | + * |
|
| 90 | + * @access protected |
|
| 91 | + * @param string $directory_path |
|
| 92 | + * @return \FilesystemIterator |
|
| 93 | + */ |
|
| 94 | + protected function findFilesByPath($directory_path = '') |
|
| 95 | + { |
|
| 96 | + $iterator = new GlobIterator( |
|
| 97 | + \EEH_File::end_with_directory_separator($directory_path) . $this->file_mask |
|
| 98 | + ); |
|
| 99 | + foreach ($this->flags as $flag) { |
|
| 100 | + $iterator->setFlags($flag); |
|
| 101 | + } |
|
| 102 | + return $iterator; |
|
| 103 | + } |
|
| 104 | 104 | } |
@@ -34,7 +34,7 @@ discard block |
||
| 34 | 34 | */ |
| 35 | 35 | public function setFileMask($file_mask) |
| 36 | 36 | { |
| 37 | - if (! is_string($file_mask)) { |
|
| 37 | + if ( ! is_string($file_mask)) { |
|
| 38 | 38 | throw new InvalidDataTypeException('$file_mask', $file_mask, 'string'); |
| 39 | 39 | } |
| 40 | 40 | $this->file_mask = $file_mask; |
@@ -72,12 +72,12 @@ discard block |
||
| 72 | 72 | */ |
| 73 | 73 | public function locate($directory_paths) |
| 74 | 74 | { |
| 75 | - if (! (is_string($directory_paths) || is_array($directory_paths))) { |
|
| 75 | + if ( ! (is_string($directory_paths) || is_array($directory_paths))) { |
|
| 76 | 76 | throw new InvalidDataTypeException('$directory_paths', $directory_paths, 'string or array'); |
| 77 | 77 | } |
| 78 | 78 | foreach ((array) $directory_paths as $directory_path) { |
| 79 | 79 | foreach ($this->findFilesByPath($directory_path) as $key => $file) { |
| 80 | - $this->filepaths[ $key ] = \EEH_File::standardise_directory_separators($file); |
|
| 80 | + $this->filepaths[$key] = \EEH_File::standardise_directory_separators($file); |
|
| 81 | 81 | } |
| 82 | 82 | } |
| 83 | 83 | return $this->filepaths; |
@@ -94,7 +94,7 @@ discard block |
||
| 94 | 94 | protected function findFilesByPath($directory_path = '') |
| 95 | 95 | { |
| 96 | 96 | $iterator = new GlobIterator( |
| 97 | - \EEH_File::end_with_directory_separator($directory_path) . $this->file_mask |
|
| 97 | + \EEH_File::end_with_directory_separator($directory_path).$this->file_mask |
|
| 98 | 98 | ); |
| 99 | 99 | foreach ($this->flags as $flag) { |
| 100 | 100 | $iterator->setFlags($flag); |
@@ -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); |
@@ -13,254 +13,254 @@ |
||
| 13 | 13 | class TableManager extends \EE_Base |
| 14 | 14 | { |
| 15 | 15 | |
| 16 | - /** |
|
| 17 | - * @var TableAnalysis $table_analysis |
|
| 18 | - */ |
|
| 19 | - private $table_analysis; |
|
| 16 | + /** |
|
| 17 | + * @var TableAnalysis $table_analysis |
|
| 18 | + */ |
|
| 19 | + private $table_analysis; |
|
| 20 | 20 | |
| 21 | 21 | |
| 22 | - /** |
|
| 23 | - * TableManager constructor. |
|
| 24 | - * |
|
| 25 | - * @param TableAnalysis $TableAnalysis |
|
| 26 | - */ |
|
| 27 | - public function __construct(TableAnalysis $TableAnalysis) |
|
| 28 | - { |
|
| 29 | - $this->table_analysis = $TableAnalysis; |
|
| 30 | - } |
|
| 22 | + /** |
|
| 23 | + * TableManager constructor. |
|
| 24 | + * |
|
| 25 | + * @param TableAnalysis $TableAnalysis |
|
| 26 | + */ |
|
| 27 | + public function __construct(TableAnalysis $TableAnalysis) |
|
| 28 | + { |
|
| 29 | + $this->table_analysis = $TableAnalysis; |
|
| 30 | + } |
|
| 31 | 31 | |
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * Gets the injected table analyzer, or throws an exception |
|
| 35 | - * |
|
| 36 | - * @return TableAnalysis |
|
| 37 | - * @throws \EE_Error |
|
| 38 | - */ |
|
| 39 | - protected function getTableAnalysis() |
|
| 40 | - { |
|
| 41 | - if ($this->table_analysis instanceof TableAnalysis) { |
|
| 42 | - return $this->table_analysis; |
|
| 43 | - } else { |
|
| 44 | - throw new \EE_Error( |
|
| 45 | - sprintf( |
|
| 46 | - __('Table analysis class on class %1$s is not set properly.', 'event_espresso'), |
|
| 47 | - get_class($this) |
|
| 48 | - ) |
|
| 49 | - ); |
|
| 50 | - } |
|
| 51 | - } |
|
| 33 | + /** |
|
| 34 | + * Gets the injected table analyzer, or throws an exception |
|
| 35 | + * |
|
| 36 | + * @return TableAnalysis |
|
| 37 | + * @throws \EE_Error |
|
| 38 | + */ |
|
| 39 | + protected function getTableAnalysis() |
|
| 40 | + { |
|
| 41 | + if ($this->table_analysis instanceof TableAnalysis) { |
|
| 42 | + return $this->table_analysis; |
|
| 43 | + } else { |
|
| 44 | + throw new \EE_Error( |
|
| 45 | + sprintf( |
|
| 46 | + __('Table analysis class on class %1$s is not set properly.', 'event_espresso'), |
|
| 47 | + get_class($this) |
|
| 48 | + ) |
|
| 49 | + ); |
|
| 50 | + } |
|
| 51 | + } |
|
| 52 | 52 | |
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * @param string $table_name which can optionally start with $wpdb->prefix or not |
|
| 56 | - * @param string $column_name |
|
| 57 | - * @param string $column_info |
|
| 58 | - * @return bool|false|int |
|
| 59 | - */ |
|
| 60 | - public function addColumn($table_name, $column_name, $column_info = 'INT UNSIGNED NOT NULL') |
|
| 61 | - { |
|
| 62 | - if (apply_filters('FHEE__EEH_Activation__add_column_if_it_doesnt_exist__short_circuit', false)) { |
|
| 63 | - return false; |
|
| 64 | - } |
|
| 65 | - global $wpdb; |
|
| 66 | - $full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
|
| 67 | - $columns = $this->getTableColumns($table_name); |
|
| 68 | - if (! in_array($column_name, $columns)) { |
|
| 69 | - $alter_query = "ALTER TABLE {$full_table_name} ADD {$column_name} {$column_info}"; |
|
| 70 | - return $wpdb->query($alter_query); |
|
| 71 | - } |
|
| 72 | - return true; |
|
| 73 | - } |
|
| 54 | + /** |
|
| 55 | + * @param string $table_name which can optionally start with $wpdb->prefix or not |
|
| 56 | + * @param string $column_name |
|
| 57 | + * @param string $column_info |
|
| 58 | + * @return bool|false|int |
|
| 59 | + */ |
|
| 60 | + public function addColumn($table_name, $column_name, $column_info = 'INT UNSIGNED NOT NULL') |
|
| 61 | + { |
|
| 62 | + if (apply_filters('FHEE__EEH_Activation__add_column_if_it_doesnt_exist__short_circuit', false)) { |
|
| 63 | + return false; |
|
| 64 | + } |
|
| 65 | + global $wpdb; |
|
| 66 | + $full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
|
| 67 | + $columns = $this->getTableColumns($table_name); |
|
| 68 | + if (! in_array($column_name, $columns)) { |
|
| 69 | + $alter_query = "ALTER TABLE {$full_table_name} ADD {$column_name} {$column_info}"; |
|
| 70 | + return $wpdb->query($alter_query); |
|
| 71 | + } |
|
| 72 | + return true; |
|
| 73 | + } |
|
| 74 | 74 | |
| 75 | 75 | |
| 76 | - /** |
|
| 77 | - * Gets the name of all columns on the table. $table_name can |
|
| 78 | - * optionally start with $wpdb->prefix or not |
|
| 79 | - * |
|
| 80 | - * @global \wpdb $wpdb |
|
| 81 | - * @param string $table_name |
|
| 82 | - * @return array |
|
| 83 | - */ |
|
| 84 | - public function getTableColumns($table_name) |
|
| 85 | - { |
|
| 86 | - global $wpdb; |
|
| 87 | - $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
|
| 88 | - $field_array = array(); |
|
| 89 | - if (! empty($table_name)) { |
|
| 90 | - $columns = $wpdb->get_results("SHOW COLUMNS FROM {$table_name} "); |
|
| 91 | - if ($columns !== false) { |
|
| 92 | - foreach ($columns as $column) { |
|
| 93 | - $field_array[] = $column->Field; |
|
| 94 | - } |
|
| 95 | - } |
|
| 96 | - } |
|
| 97 | - return $field_array; |
|
| 98 | - } |
|
| 76 | + /** |
|
| 77 | + * Gets the name of all columns on the table. $table_name can |
|
| 78 | + * optionally start with $wpdb->prefix or not |
|
| 79 | + * |
|
| 80 | + * @global \wpdb $wpdb |
|
| 81 | + * @param string $table_name |
|
| 82 | + * @return array |
|
| 83 | + */ |
|
| 84 | + public function getTableColumns($table_name) |
|
| 85 | + { |
|
| 86 | + global $wpdb; |
|
| 87 | + $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
|
| 88 | + $field_array = array(); |
|
| 89 | + if (! empty($table_name)) { |
|
| 90 | + $columns = $wpdb->get_results("SHOW COLUMNS FROM {$table_name} "); |
|
| 91 | + if ($columns !== false) { |
|
| 92 | + foreach ($columns as $column) { |
|
| 93 | + $field_array[] = $column->Field; |
|
| 94 | + } |
|
| 95 | + } |
|
| 96 | + } |
|
| 97 | + return $field_array; |
|
| 98 | + } |
|
| 99 | 99 | |
| 100 | 100 | |
| 101 | - /** |
|
| 102 | - * Drops the specified table from the database. $table_name can |
|
| 103 | - * optionally start with $wpdb->prefix or not |
|
| 104 | - * |
|
| 105 | - * @global \wpdb $wpdb |
|
| 106 | - * @param string $table_name |
|
| 107 | - * @return int |
|
| 108 | - */ |
|
| 109 | - public function dropTable($table_name) |
|
| 110 | - { |
|
| 111 | - global $wpdb; |
|
| 112 | - if ($this->getTableAnalysis()->tableExists($table_name)) { |
|
| 113 | - $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
|
| 114 | - return $wpdb->query("DROP TABLE IF EXISTS {$table_name}"); |
|
| 115 | - } |
|
| 116 | - return 0; |
|
| 117 | - } |
|
| 101 | + /** |
|
| 102 | + * Drops the specified table from the database. $table_name can |
|
| 103 | + * optionally start with $wpdb->prefix or not |
|
| 104 | + * |
|
| 105 | + * @global \wpdb $wpdb |
|
| 106 | + * @param string $table_name |
|
| 107 | + * @return int |
|
| 108 | + */ |
|
| 109 | + public function dropTable($table_name) |
|
| 110 | + { |
|
| 111 | + global $wpdb; |
|
| 112 | + if ($this->getTableAnalysis()->tableExists($table_name)) { |
|
| 113 | + $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
|
| 114 | + return $wpdb->query("DROP TABLE IF EXISTS {$table_name}"); |
|
| 115 | + } |
|
| 116 | + return 0; |
|
| 117 | + } |
|
| 118 | 118 | |
| 119 | 119 | |
| 120 | - /** |
|
| 121 | - * Drops all the tables mentioned in a single MYSQL query. Double-checks |
|
| 122 | - * each table name provided has a wpdb prefix attached, and that it exists. |
|
| 123 | - * Returns the list actually deleted |
|
| 124 | - * |
|
| 125 | - * @global WPDB $wpdb |
|
| 126 | - * @param array $table_names |
|
| 127 | - * @return array of table names which we deleted |
|
| 128 | - */ |
|
| 129 | - public function dropTables($table_names) |
|
| 130 | - { |
|
| 131 | - $tables_to_delete = array(); |
|
| 132 | - foreach ($table_names as $table_name) { |
|
| 133 | - $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
|
| 134 | - if ($this->getTableAnalysis()->tableExists($table_name)) { |
|
| 135 | - $tables_to_delete[ $table_name ] = $table_name; |
|
| 136 | - } |
|
| 137 | - } |
|
| 138 | - if (! empty($tables_to_delete)) { |
|
| 139 | - global $wpdb; |
|
| 140 | - // make sure we only have a unique strings in the array. |
|
| 141 | - $tables_to_delete = array_unique($tables_to_delete); |
|
| 142 | - $wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete)); |
|
| 143 | - } |
|
| 144 | - return $tables_to_delete; |
|
| 145 | - } |
|
| 120 | + /** |
|
| 121 | + * Drops all the tables mentioned in a single MYSQL query. Double-checks |
|
| 122 | + * each table name provided has a wpdb prefix attached, and that it exists. |
|
| 123 | + * Returns the list actually deleted |
|
| 124 | + * |
|
| 125 | + * @global WPDB $wpdb |
|
| 126 | + * @param array $table_names |
|
| 127 | + * @return array of table names which we deleted |
|
| 128 | + */ |
|
| 129 | + public function dropTables($table_names) |
|
| 130 | + { |
|
| 131 | + $tables_to_delete = array(); |
|
| 132 | + foreach ($table_names as $table_name) { |
|
| 133 | + $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
|
| 134 | + if ($this->getTableAnalysis()->tableExists($table_name)) { |
|
| 135 | + $tables_to_delete[ $table_name ] = $table_name; |
|
| 136 | + } |
|
| 137 | + } |
|
| 138 | + if (! empty($tables_to_delete)) { |
|
| 139 | + global $wpdb; |
|
| 140 | + // make sure we only have a unique strings in the array. |
|
| 141 | + $tables_to_delete = array_unique($tables_to_delete); |
|
| 142 | + $wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete)); |
|
| 143 | + } |
|
| 144 | + return $tables_to_delete; |
|
| 145 | + } |
|
| 146 | 146 | |
| 147 | 147 | |
| 148 | - /** |
|
| 149 | - * Drops the specified index from the specified table. $table_name can |
|
| 150 | - * optionally start with $wpdb->prefix or not |
|
| 151 | - * |
|
| 152 | - * @global \wpdb $wpdb |
|
| 153 | - * @param string $table_name |
|
| 154 | - * @param string $index_name |
|
| 155 | - * @return int the number of indexes dropped. False if there was a datbase error |
|
| 156 | - */ |
|
| 157 | - public function dropIndex($table_name, $index_name) |
|
| 158 | - { |
|
| 159 | - if (apply_filters('FHEE__EEH_Activation__drop_index__short_circuit', false)) { |
|
| 160 | - return 0; |
|
| 161 | - } |
|
| 162 | - global $wpdb; |
|
| 163 | - $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
|
| 164 | - $index_exists_query = "SHOW INDEX FROM {$table_name} WHERE key_name = '{$index_name}'"; |
|
| 165 | - if ($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 | - } |
|
| 148 | + /** |
|
| 149 | + * Drops the specified index from the specified table. $table_name can |
|
| 150 | + * optionally start with $wpdb->prefix or not |
|
| 151 | + * |
|
| 152 | + * @global \wpdb $wpdb |
|
| 153 | + * @param string $table_name |
|
| 154 | + * @param string $index_name |
|
| 155 | + * @return int the number of indexes dropped. False if there was a datbase error |
|
| 156 | + */ |
|
| 157 | + public function dropIndex($table_name, $index_name) |
|
| 158 | + { |
|
| 159 | + if (apply_filters('FHEE__EEH_Activation__drop_index__short_circuit', false)) { |
|
| 160 | + return 0; |
|
| 161 | + } |
|
| 162 | + global $wpdb; |
|
| 163 | + $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name); |
|
| 164 | + $index_exists_query = "SHOW INDEX FROM {$table_name} WHERE key_name = '{$index_name}'"; |
|
| 165 | + if ($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 | - __( |
|
| 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 | + __( |
|
| 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 ($column_name === $index_entry->Column_name |
|
| 260 | - && (string) $desired_index_size !== $index_entry->Sub_part) { |
|
| 261 | - return $this->dropIndex($table_name, $index_name); |
|
| 262 | - } |
|
| 263 | - } |
|
| 264 | - return false; |
|
| 265 | - } |
|
| 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 ($column_name === $index_entry->Column_name |
|
| 260 | + && (string) $desired_index_size !== $index_entry->Sub_part) { |
|
| 261 | + return $this->dropIndex($table_name, $index_name); |
|
| 262 | + } |
|
| 263 | + } |
|
| 264 | + return false; |
|
| 265 | + } |
|
| 266 | 266 | } |
@@ -18,104 +18,104 @@ |
||
| 18 | 18 | class CommandHandlerManager implements CommandHandlerManagerInterface |
| 19 | 19 | { |
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * @var CommandHandlerInterface[] $command_handlers |
|
| 23 | - */ |
|
| 24 | - protected $command_handlers; |
|
| 21 | + /** |
|
| 22 | + * @var CommandHandlerInterface[] $command_handlers |
|
| 23 | + */ |
|
| 24 | + protected $command_handlers; |
|
| 25 | 25 | |
| 26 | - /** |
|
| 27 | - * @type LoaderInterface $loader |
|
| 28 | - */ |
|
| 29 | - private $loader; |
|
| 26 | + /** |
|
| 27 | + * @type LoaderInterface $loader |
|
| 28 | + */ |
|
| 29 | + private $loader; |
|
| 30 | 30 | |
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * CommandHandlerManager constructor |
|
| 34 | - * |
|
| 35 | - * @param LoaderInterface $loader |
|
| 36 | - */ |
|
| 37 | - public function __construct(LoaderInterface $loader) |
|
| 38 | - { |
|
| 39 | - $this->loader = $loader; |
|
| 40 | - } |
|
| 32 | + /** |
|
| 33 | + * CommandHandlerManager constructor |
|
| 34 | + * |
|
| 35 | + * @param LoaderInterface $loader |
|
| 36 | + */ |
|
| 37 | + public function __construct(LoaderInterface $loader) |
|
| 38 | + { |
|
| 39 | + $this->loader = $loader; |
|
| 40 | + } |
|
| 41 | 41 | |
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * By default, Commands and CommandHandlers would normally |
|
| 45 | - * reside in the same folder under the same namespace, |
|
| 46 | - * and the names of the two classes would only differ in that |
|
| 47 | - * one ends in "Command" and the other ends in "CommandHandler". |
|
| 48 | - * However, if you wanted to utilize a CommandHandler from somewhere else, |
|
| 49 | - * then this method allows you to add that CommandHandler and specify the FQCN |
|
| 50 | - * (Fully Qualified ClassName) for the Command class that it should be used for. |
|
| 51 | - * For example: |
|
| 52 | - * by default the "Vendor\some\namespace\DoSomethingCommand" |
|
| 53 | - * would resolve to using "Vendor\some\namespace\DoSomethingCommandHandler" |
|
| 54 | - * but if you wanted to instead process that commend using: |
|
| 55 | - * "Vendor\a\totally\different\namespace\for\DoSomethingCommandHandler" |
|
| 56 | - * then the following code: |
|
| 57 | - * $CommandHandlerManager = $this->loader->getShared( 'CommandHandlerManagerInterface' ); |
|
| 58 | - * $CommandHandlerManager->addCommandHandler( |
|
| 59 | - * new Vendor\a\totally\different\namespace\for\DoSomethingCommandHandler(), |
|
| 60 | - * 'Vendor\some\namespace\DoSomethingCommand' |
|
| 61 | - * ); |
|
| 62 | - * would result in the alternate CommandHandler being used to process that Command |
|
| 63 | - * |
|
| 64 | - * @param CommandHandlerInterface $command_handler |
|
| 65 | - * @param string $fqcn_for_command Fully Qualified ClassName for Command |
|
| 66 | - * @return void |
|
| 67 | - * @throws InvalidCommandHandlerException |
|
| 68 | - */ |
|
| 69 | - public function addCommandHandler(CommandHandlerInterface $command_handler, $fqcn_for_command = '') |
|
| 70 | - { |
|
| 71 | - $command = ! empty($fqcn_for_command) |
|
| 72 | - ? $fqcn_for_command |
|
| 73 | - : str_replace('CommandHandler', 'Command', get_class($command_handler)); |
|
| 74 | - if (empty($command)) { |
|
| 75 | - throw new InvalidCommandHandlerException($command); |
|
| 76 | - } |
|
| 77 | - $this->command_handlers[ $command ] = $command_handler; |
|
| 78 | - } |
|
| 43 | + /** |
|
| 44 | + * By default, Commands and CommandHandlers would normally |
|
| 45 | + * reside in the same folder under the same namespace, |
|
| 46 | + * and the names of the two classes would only differ in that |
|
| 47 | + * one ends in "Command" and the other ends in "CommandHandler". |
|
| 48 | + * However, if you wanted to utilize a CommandHandler from somewhere else, |
|
| 49 | + * then this method allows you to add that CommandHandler and specify the FQCN |
|
| 50 | + * (Fully Qualified ClassName) for the Command class that it should be used for. |
|
| 51 | + * For example: |
|
| 52 | + * by default the "Vendor\some\namespace\DoSomethingCommand" |
|
| 53 | + * would resolve to using "Vendor\some\namespace\DoSomethingCommandHandler" |
|
| 54 | + * but if you wanted to instead process that commend using: |
|
| 55 | + * "Vendor\a\totally\different\namespace\for\DoSomethingCommandHandler" |
|
| 56 | + * then the following code: |
|
| 57 | + * $CommandHandlerManager = $this->loader->getShared( 'CommandHandlerManagerInterface' ); |
|
| 58 | + * $CommandHandlerManager->addCommandHandler( |
|
| 59 | + * new Vendor\a\totally\different\namespace\for\DoSomethingCommandHandler(), |
|
| 60 | + * 'Vendor\some\namespace\DoSomethingCommand' |
|
| 61 | + * ); |
|
| 62 | + * would result in the alternate CommandHandler being used to process that Command |
|
| 63 | + * |
|
| 64 | + * @param CommandHandlerInterface $command_handler |
|
| 65 | + * @param string $fqcn_for_command Fully Qualified ClassName for Command |
|
| 66 | + * @return void |
|
| 67 | + * @throws InvalidCommandHandlerException |
|
| 68 | + */ |
|
| 69 | + public function addCommandHandler(CommandHandlerInterface $command_handler, $fqcn_for_command = '') |
|
| 70 | + { |
|
| 71 | + $command = ! empty($fqcn_for_command) |
|
| 72 | + ? $fqcn_for_command |
|
| 73 | + : str_replace('CommandHandler', 'Command', get_class($command_handler)); |
|
| 74 | + if (empty($command)) { |
|
| 75 | + throw new InvalidCommandHandlerException($command); |
|
| 76 | + } |
|
| 77 | + $this->command_handlers[ $command ] = $command_handler; |
|
| 78 | + } |
|
| 79 | 79 | |
| 80 | 80 | |
| 81 | - /** |
|
| 82 | - * @param CommandInterface $command |
|
| 83 | - * @param CommandBusInterface $command_bus |
|
| 84 | - * @return mixed |
|
| 85 | - * @throws DomainException |
|
| 86 | - * @throws CommandHandlerNotFoundException |
|
| 87 | - */ |
|
| 88 | - public function getCommandHandler(CommandInterface $command, CommandBusInterface $command_bus = null) |
|
| 89 | - { |
|
| 90 | - $command_name = get_class($command); |
|
| 91 | - $command_handler = apply_filters( |
|
| 92 | - 'FHEE__EventEspresso_core_services_commands_CommandHandlerManager__getCommandHandler__command_handler', |
|
| 93 | - str_replace('Command', 'CommandHandler', $command_name), |
|
| 94 | - $command |
|
| 95 | - ); |
|
| 96 | - $handler = null; |
|
| 97 | - // has a command handler already been set for this class ? |
|
| 98 | - // if not, can we find one via the FQCN ? |
|
| 99 | - if (isset($this->command_handlers[ $command_name ])) { |
|
| 100 | - $handler = $this->command_handlers[ $command_name ]; |
|
| 101 | - } elseif (class_exists($command_handler)) { |
|
| 102 | - $handler = $this->loader->getShared($command_handler); |
|
| 103 | - } |
|
| 104 | - // if Handler requires an instance of the CommandBus, but that has not yet been set |
|
| 105 | - if ($handler instanceof CompositeCommandHandler && ! $handler->commandBus() instanceof CommandBusInterface) { |
|
| 106 | - if (! $command_bus instanceof CommandBusInterface) { |
|
| 107 | - throw new DomainException( |
|
| 108 | - esc_html__( |
|
| 109 | - 'CompositeCommandHandler classes require an instance of the CommandBus.', |
|
| 110 | - 'event_espresso' |
|
| 111 | - ) |
|
| 112 | - ); |
|
| 113 | - } |
|
| 114 | - $handler->setCommandBus($command_bus); |
|
| 115 | - } |
|
| 116 | - if ($handler instanceof CommandHandlerInterface) { |
|
| 117 | - return $handler; |
|
| 118 | - } |
|
| 119 | - throw new CommandHandlerNotFoundException($command_handler); |
|
| 120 | - } |
|
| 81 | + /** |
|
| 82 | + * @param CommandInterface $command |
|
| 83 | + * @param CommandBusInterface $command_bus |
|
| 84 | + * @return mixed |
|
| 85 | + * @throws DomainException |
|
| 86 | + * @throws CommandHandlerNotFoundException |
|
| 87 | + */ |
|
| 88 | + public function getCommandHandler(CommandInterface $command, CommandBusInterface $command_bus = null) |
|
| 89 | + { |
|
| 90 | + $command_name = get_class($command); |
|
| 91 | + $command_handler = apply_filters( |
|
| 92 | + 'FHEE__EventEspresso_core_services_commands_CommandHandlerManager__getCommandHandler__command_handler', |
|
| 93 | + str_replace('Command', 'CommandHandler', $command_name), |
|
| 94 | + $command |
|
| 95 | + ); |
|
| 96 | + $handler = null; |
|
| 97 | + // has a command handler already been set for this class ? |
|
| 98 | + // if not, can we find one via the FQCN ? |
|
| 99 | + if (isset($this->command_handlers[ $command_name ])) { |
|
| 100 | + $handler = $this->command_handlers[ $command_name ]; |
|
| 101 | + } elseif (class_exists($command_handler)) { |
|
| 102 | + $handler = $this->loader->getShared($command_handler); |
|
| 103 | + } |
|
| 104 | + // if Handler requires an instance of the CommandBus, but that has not yet been set |
|
| 105 | + if ($handler instanceof CompositeCommandHandler && ! $handler->commandBus() instanceof CommandBusInterface) { |
|
| 106 | + if (! $command_bus instanceof CommandBusInterface) { |
|
| 107 | + throw new DomainException( |
|
| 108 | + esc_html__( |
|
| 109 | + 'CompositeCommandHandler classes require an instance of the CommandBus.', |
|
| 110 | + 'event_espresso' |
|
| 111 | + ) |
|
| 112 | + ); |
|
| 113 | + } |
|
| 114 | + $handler->setCommandBus($command_bus); |
|
| 115 | + } |
|
| 116 | + if ($handler instanceof CommandHandlerInterface) { |
|
| 117 | + return $handler; |
|
| 118 | + } |
|
| 119 | + throw new CommandHandlerNotFoundException($command_handler); |
|
| 120 | + } |
|
| 121 | 121 | } |
@@ -74,7 +74,7 @@ discard block |
||
| 74 | 74 | if (empty($command)) { |
| 75 | 75 | throw new InvalidCommandHandlerException($command); |
| 76 | 76 | } |
| 77 | - $this->command_handlers[ $command ] = $command_handler; |
|
| 77 | + $this->command_handlers[$command] = $command_handler; |
|
| 78 | 78 | } |
| 79 | 79 | |
| 80 | 80 | |
@@ -96,14 +96,14 @@ discard block |
||
| 96 | 96 | $handler = null; |
| 97 | 97 | // has a command handler already been set for this class ? |
| 98 | 98 | // if not, can we find one via the FQCN ? |
| 99 | - if (isset($this->command_handlers[ $command_name ])) { |
|
| 100 | - $handler = $this->command_handlers[ $command_name ]; |
|
| 99 | + if (isset($this->command_handlers[$command_name])) { |
|
| 100 | + $handler = $this->command_handlers[$command_name]; |
|
| 101 | 101 | } elseif (class_exists($command_handler)) { |
| 102 | 102 | $handler = $this->loader->getShared($command_handler); |
| 103 | 103 | } |
| 104 | 104 | // if Handler requires an instance of the CommandBus, but that has not yet been set |
| 105 | 105 | if ($handler instanceof CompositeCommandHandler && ! $handler->commandBus() instanceof CommandBusInterface) { |
| 106 | - if (! $command_bus instanceof CommandBusInterface) { |
|
| 106 | + if ( ! $command_bus instanceof CommandBusInterface) { |
|
| 107 | 107 | throw new DomainException( |
| 108 | 108 | esc_html__( |
| 109 | 109 | 'CompositeCommandHandler classes require an instance of the CommandBus.', |
@@ -14,253 +14,253 @@ |
||
| 14 | 14 | class Notice implements NoticeInterface |
| 15 | 15 | { |
| 16 | 16 | |
| 17 | - const ERROR = 'error'; |
|
| 18 | - |
|
| 19 | - const SUCCESS = 'success'; |
|
| 20 | - |
|
| 21 | - const ATTENTION = 'attention'; // alias for warning |
|
| 22 | - |
|
| 23 | - const INFORMATION = 'information'; |
|
| 24 | - |
|
| 25 | - /** |
|
| 26 | - * @var string $type |
|
| 27 | - */ |
|
| 28 | - private $type; |
|
| 29 | - |
|
| 30 | - |
|
| 31 | - /** |
|
| 32 | - * @var string $message |
|
| 33 | - */ |
|
| 34 | - private $message; |
|
| 35 | - |
|
| 36 | - |
|
| 37 | - /** |
|
| 38 | - * @var string $file |
|
| 39 | - */ |
|
| 40 | - private $file; |
|
| 41 | - |
|
| 42 | - |
|
| 43 | - /** |
|
| 44 | - * @var string $func |
|
| 45 | - */ |
|
| 46 | - private $func; |
|
| 47 | - |
|
| 48 | - |
|
| 49 | - /** |
|
| 50 | - * @var string $line |
|
| 51 | - */ |
|
| 52 | - private $line; |
|
| 53 | - |
|
| 54 | - |
|
| 55 | - /** |
|
| 56 | - * @var boolean $dismissible |
|
| 57 | - */ |
|
| 58 | - private $dismissible; |
|
| 59 | - |
|
| 60 | - |
|
| 61 | - /** |
|
| 62 | - * Notice constructor. |
|
| 63 | - * |
|
| 64 | - * @param string $type |
|
| 65 | - * @param string $message |
|
| 66 | - * @param bool $dismissible |
|
| 67 | - * @param string $file |
|
| 68 | - * @param string $func |
|
| 69 | - * @param string $line |
|
| 70 | - * @throws InvalidDataTypeException |
|
| 71 | - */ |
|
| 72 | - public function __construct($type, $message, $dismissible = true, $file = '', $func = '', $line = '') |
|
| 73 | - { |
|
| 74 | - $this->setType($type); |
|
| 75 | - $this->setMessage($message); |
|
| 76 | - $this->setDismissible($dismissible); |
|
| 77 | - $this->setFile($file); |
|
| 78 | - $this->setFunc($func); |
|
| 79 | - $this->setLine($line); |
|
| 80 | - } |
|
| 81 | - |
|
| 82 | - |
|
| 83 | - /** |
|
| 84 | - * @return array |
|
| 85 | - */ |
|
| 86 | - private function types() |
|
| 87 | - { |
|
| 88 | - return (array) apply_filters( |
|
| 89 | - 'FHEE__EventEspresso_core_services_notices_Notice__types', |
|
| 90 | - array( |
|
| 91 | - Notice::ERROR, |
|
| 92 | - Notice::SUCCESS, |
|
| 93 | - Notice::ATTENTION, |
|
| 94 | - Notice::INFORMATION, |
|
| 95 | - ) |
|
| 96 | - ); |
|
| 97 | - } |
|
| 98 | - |
|
| 99 | - |
|
| 100 | - /** |
|
| 101 | - * @return string |
|
| 102 | - */ |
|
| 103 | - public function type() |
|
| 104 | - { |
|
| 105 | - return $this->type; |
|
| 106 | - } |
|
| 107 | - |
|
| 108 | - |
|
| 109 | - /** |
|
| 110 | - * @return string |
|
| 111 | - */ |
|
| 112 | - public function message() |
|
| 113 | - { |
|
| 114 | - return $this->message; |
|
| 115 | - } |
|
| 116 | - |
|
| 117 | - |
|
| 118 | - /** |
|
| 119 | - * @return string |
|
| 120 | - */ |
|
| 121 | - public function file() |
|
| 122 | - { |
|
| 123 | - return $this->file; |
|
| 124 | - } |
|
| 125 | - |
|
| 126 | - |
|
| 127 | - /** |
|
| 128 | - * @return string |
|
| 129 | - */ |
|
| 130 | - public function func() |
|
| 131 | - { |
|
| 132 | - return $this->func; |
|
| 133 | - } |
|
| 134 | - |
|
| 135 | - |
|
| 136 | - /** |
|
| 137 | - * @return string |
|
| 138 | - */ |
|
| 139 | - public function line() |
|
| 140 | - { |
|
| 141 | - return $this->line; |
|
| 142 | - } |
|
| 143 | - |
|
| 144 | - |
|
| 145 | - /** |
|
| 146 | - * @return bool |
|
| 147 | - */ |
|
| 148 | - public function isDismissible() |
|
| 149 | - { |
|
| 150 | - return $this->dismissible; |
|
| 151 | - } |
|
| 152 | - |
|
| 153 | - |
|
| 154 | - /** |
|
| 155 | - * @param string $type |
|
| 156 | - * @throws InvalidDataTypeException |
|
| 157 | - */ |
|
| 158 | - private function setType($type) |
|
| 159 | - { |
|
| 160 | - if (! in_array($type, $this->types(), true)) { |
|
| 161 | - throw new InvalidDataTypeException( |
|
| 162 | - '$type', |
|
| 163 | - $type, |
|
| 164 | - $this->invalidTypeMessage() |
|
| 165 | - ); |
|
| 166 | - } |
|
| 167 | - $this->type = $type; |
|
| 168 | - } |
|
| 169 | - |
|
| 170 | - |
|
| 171 | - /** |
|
| 172 | - * gets the $invalid_type_message string |
|
| 173 | - */ |
|
| 174 | - private function invalidTypeMessage() |
|
| 175 | - { |
|
| 176 | - return apply_filters( |
|
| 177 | - 'FHEE__EventEspresso_core_services_notices_Notice__invalidTypeMessage', |
|
| 178 | - sprintf( |
|
| 179 | - esc_html__( |
|
| 180 | - ' one of the following notice types was expected: %1$s %2$s', |
|
| 181 | - 'event_espresso' |
|
| 182 | - ), |
|
| 183 | - '<br />', |
|
| 184 | - var_export($this->types(), true) |
|
| 185 | - ) |
|
| 186 | - ); |
|
| 187 | - } |
|
| 188 | - |
|
| 189 | - |
|
| 190 | - /** |
|
| 191 | - * @param string $message |
|
| 192 | - * @throws InvalidDataTypeException |
|
| 193 | - */ |
|
| 194 | - private function setMessage($message) |
|
| 195 | - { |
|
| 196 | - if (empty($message) || ! is_string($message)) { |
|
| 197 | - throw new InvalidDataTypeException( |
|
| 198 | - '$message', |
|
| 199 | - $message, |
|
| 200 | - esc_html__('non empty string', 'event_espresso') |
|
| 201 | - ); |
|
| 202 | - } |
|
| 203 | - $this->message = $message; |
|
| 204 | - } |
|
| 205 | - |
|
| 206 | - |
|
| 207 | - /** |
|
| 208 | - * @param string $file |
|
| 209 | - * @throws InvalidDataTypeException |
|
| 210 | - */ |
|
| 211 | - private function setFile($file) |
|
| 212 | - { |
|
| 213 | - if ($this->type === Notice::ERROR && (empty($file) || ! is_string($file))) { |
|
| 214 | - throw new InvalidDataTypeException( |
|
| 215 | - '$file', |
|
| 216 | - $file, |
|
| 217 | - esc_html__('non empty string', 'event_espresso') |
|
| 218 | - ); |
|
| 219 | - } |
|
| 220 | - $this->file = $file; |
|
| 221 | - } |
|
| 222 | - |
|
| 223 | - |
|
| 224 | - /** |
|
| 225 | - * @param string $func |
|
| 226 | - * @throws InvalidDataTypeException |
|
| 227 | - */ |
|
| 228 | - private function setFunc($func) |
|
| 229 | - { |
|
| 230 | - if ($this->type === Notice::ERROR && (empty($func) || ! is_string($func))) { |
|
| 231 | - throw new InvalidDataTypeException( |
|
| 232 | - '$func', |
|
| 233 | - $func, |
|
| 234 | - esc_html__('non empty string', 'event_espresso') |
|
| 235 | - ); |
|
| 236 | - } |
|
| 237 | - $this->func = $func; |
|
| 238 | - } |
|
| 239 | - |
|
| 240 | - |
|
| 241 | - /** |
|
| 242 | - * @param int $line |
|
| 243 | - * @throws InvalidDataTypeException |
|
| 244 | - */ |
|
| 245 | - private function setLine($line) |
|
| 246 | - { |
|
| 247 | - $line = absint($line); |
|
| 248 | - if ($this->type === Notice::ERROR && $line === 0) { |
|
| 249 | - throw new InvalidDataTypeException( |
|
| 250 | - '$line', |
|
| 251 | - $line, |
|
| 252 | - esc_html__('integer', 'event_espresso') |
|
| 253 | - ); |
|
| 254 | - } |
|
| 255 | - $this->line = $line; |
|
| 256 | - } |
|
| 257 | - |
|
| 258 | - |
|
| 259 | - /** |
|
| 260 | - * @param boolean $dismissible |
|
| 261 | - */ |
|
| 262 | - private function setDismissible($dismissible = true) |
|
| 263 | - { |
|
| 264 | - $this->dismissible = filter_var($dismissible, FILTER_VALIDATE_BOOLEAN); |
|
| 265 | - } |
|
| 17 | + const ERROR = 'error'; |
|
| 18 | + |
|
| 19 | + const SUCCESS = 'success'; |
|
| 20 | + |
|
| 21 | + const ATTENTION = 'attention'; // alias for warning |
|
| 22 | + |
|
| 23 | + const INFORMATION = 'information'; |
|
| 24 | + |
|
| 25 | + /** |
|
| 26 | + * @var string $type |
|
| 27 | + */ |
|
| 28 | + private $type; |
|
| 29 | + |
|
| 30 | + |
|
| 31 | + /** |
|
| 32 | + * @var string $message |
|
| 33 | + */ |
|
| 34 | + private $message; |
|
| 35 | + |
|
| 36 | + |
|
| 37 | + /** |
|
| 38 | + * @var string $file |
|
| 39 | + */ |
|
| 40 | + private $file; |
|
| 41 | + |
|
| 42 | + |
|
| 43 | + /** |
|
| 44 | + * @var string $func |
|
| 45 | + */ |
|
| 46 | + private $func; |
|
| 47 | + |
|
| 48 | + |
|
| 49 | + /** |
|
| 50 | + * @var string $line |
|
| 51 | + */ |
|
| 52 | + private $line; |
|
| 53 | + |
|
| 54 | + |
|
| 55 | + /** |
|
| 56 | + * @var boolean $dismissible |
|
| 57 | + */ |
|
| 58 | + private $dismissible; |
|
| 59 | + |
|
| 60 | + |
|
| 61 | + /** |
|
| 62 | + * Notice constructor. |
|
| 63 | + * |
|
| 64 | + * @param string $type |
|
| 65 | + * @param string $message |
|
| 66 | + * @param bool $dismissible |
|
| 67 | + * @param string $file |
|
| 68 | + * @param string $func |
|
| 69 | + * @param string $line |
|
| 70 | + * @throws InvalidDataTypeException |
|
| 71 | + */ |
|
| 72 | + public function __construct($type, $message, $dismissible = true, $file = '', $func = '', $line = '') |
|
| 73 | + { |
|
| 74 | + $this->setType($type); |
|
| 75 | + $this->setMessage($message); |
|
| 76 | + $this->setDismissible($dismissible); |
|
| 77 | + $this->setFile($file); |
|
| 78 | + $this->setFunc($func); |
|
| 79 | + $this->setLine($line); |
|
| 80 | + } |
|
| 81 | + |
|
| 82 | + |
|
| 83 | + /** |
|
| 84 | + * @return array |
|
| 85 | + */ |
|
| 86 | + private function types() |
|
| 87 | + { |
|
| 88 | + return (array) apply_filters( |
|
| 89 | + 'FHEE__EventEspresso_core_services_notices_Notice__types', |
|
| 90 | + array( |
|
| 91 | + Notice::ERROR, |
|
| 92 | + Notice::SUCCESS, |
|
| 93 | + Notice::ATTENTION, |
|
| 94 | + Notice::INFORMATION, |
|
| 95 | + ) |
|
| 96 | + ); |
|
| 97 | + } |
|
| 98 | + |
|
| 99 | + |
|
| 100 | + /** |
|
| 101 | + * @return string |
|
| 102 | + */ |
|
| 103 | + public function type() |
|
| 104 | + { |
|
| 105 | + return $this->type; |
|
| 106 | + } |
|
| 107 | + |
|
| 108 | + |
|
| 109 | + /** |
|
| 110 | + * @return string |
|
| 111 | + */ |
|
| 112 | + public function message() |
|
| 113 | + { |
|
| 114 | + return $this->message; |
|
| 115 | + } |
|
| 116 | + |
|
| 117 | + |
|
| 118 | + /** |
|
| 119 | + * @return string |
|
| 120 | + */ |
|
| 121 | + public function file() |
|
| 122 | + { |
|
| 123 | + return $this->file; |
|
| 124 | + } |
|
| 125 | + |
|
| 126 | + |
|
| 127 | + /** |
|
| 128 | + * @return string |
|
| 129 | + */ |
|
| 130 | + public function func() |
|
| 131 | + { |
|
| 132 | + return $this->func; |
|
| 133 | + } |
|
| 134 | + |
|
| 135 | + |
|
| 136 | + /** |
|
| 137 | + * @return string |
|
| 138 | + */ |
|
| 139 | + public function line() |
|
| 140 | + { |
|
| 141 | + return $this->line; |
|
| 142 | + } |
|
| 143 | + |
|
| 144 | + |
|
| 145 | + /** |
|
| 146 | + * @return bool |
|
| 147 | + */ |
|
| 148 | + public function isDismissible() |
|
| 149 | + { |
|
| 150 | + return $this->dismissible; |
|
| 151 | + } |
|
| 152 | + |
|
| 153 | + |
|
| 154 | + /** |
|
| 155 | + * @param string $type |
|
| 156 | + * @throws InvalidDataTypeException |
|
| 157 | + */ |
|
| 158 | + private function setType($type) |
|
| 159 | + { |
|
| 160 | + if (! in_array($type, $this->types(), true)) { |
|
| 161 | + throw new InvalidDataTypeException( |
|
| 162 | + '$type', |
|
| 163 | + $type, |
|
| 164 | + $this->invalidTypeMessage() |
|
| 165 | + ); |
|
| 166 | + } |
|
| 167 | + $this->type = $type; |
|
| 168 | + } |
|
| 169 | + |
|
| 170 | + |
|
| 171 | + /** |
|
| 172 | + * gets the $invalid_type_message string |
|
| 173 | + */ |
|
| 174 | + private function invalidTypeMessage() |
|
| 175 | + { |
|
| 176 | + return apply_filters( |
|
| 177 | + 'FHEE__EventEspresso_core_services_notices_Notice__invalidTypeMessage', |
|
| 178 | + sprintf( |
|
| 179 | + esc_html__( |
|
| 180 | + ' one of the following notice types was expected: %1$s %2$s', |
|
| 181 | + 'event_espresso' |
|
| 182 | + ), |
|
| 183 | + '<br />', |
|
| 184 | + var_export($this->types(), true) |
|
| 185 | + ) |
|
| 186 | + ); |
|
| 187 | + } |
|
| 188 | + |
|
| 189 | + |
|
| 190 | + /** |
|
| 191 | + * @param string $message |
|
| 192 | + * @throws InvalidDataTypeException |
|
| 193 | + */ |
|
| 194 | + private function setMessage($message) |
|
| 195 | + { |
|
| 196 | + if (empty($message) || ! is_string($message)) { |
|
| 197 | + throw new InvalidDataTypeException( |
|
| 198 | + '$message', |
|
| 199 | + $message, |
|
| 200 | + esc_html__('non empty string', 'event_espresso') |
|
| 201 | + ); |
|
| 202 | + } |
|
| 203 | + $this->message = $message; |
|
| 204 | + } |
|
| 205 | + |
|
| 206 | + |
|
| 207 | + /** |
|
| 208 | + * @param string $file |
|
| 209 | + * @throws InvalidDataTypeException |
|
| 210 | + */ |
|
| 211 | + private function setFile($file) |
|
| 212 | + { |
|
| 213 | + if ($this->type === Notice::ERROR && (empty($file) || ! is_string($file))) { |
|
| 214 | + throw new InvalidDataTypeException( |
|
| 215 | + '$file', |
|
| 216 | + $file, |
|
| 217 | + esc_html__('non empty string', 'event_espresso') |
|
| 218 | + ); |
|
| 219 | + } |
|
| 220 | + $this->file = $file; |
|
| 221 | + } |
|
| 222 | + |
|
| 223 | + |
|
| 224 | + /** |
|
| 225 | + * @param string $func |
|
| 226 | + * @throws InvalidDataTypeException |
|
| 227 | + */ |
|
| 228 | + private function setFunc($func) |
|
| 229 | + { |
|
| 230 | + if ($this->type === Notice::ERROR && (empty($func) || ! is_string($func))) { |
|
| 231 | + throw new InvalidDataTypeException( |
|
| 232 | + '$func', |
|
| 233 | + $func, |
|
| 234 | + esc_html__('non empty string', 'event_espresso') |
|
| 235 | + ); |
|
| 236 | + } |
|
| 237 | + $this->func = $func; |
|
| 238 | + } |
|
| 239 | + |
|
| 240 | + |
|
| 241 | + /** |
|
| 242 | + * @param int $line |
|
| 243 | + * @throws InvalidDataTypeException |
|
| 244 | + */ |
|
| 245 | + private function setLine($line) |
|
| 246 | + { |
|
| 247 | + $line = absint($line); |
|
| 248 | + if ($this->type === Notice::ERROR && $line === 0) { |
|
| 249 | + throw new InvalidDataTypeException( |
|
| 250 | + '$line', |
|
| 251 | + $line, |
|
| 252 | + esc_html__('integer', 'event_espresso') |
|
| 253 | + ); |
|
| 254 | + } |
|
| 255 | + $this->line = $line; |
|
| 256 | + } |
|
| 257 | + |
|
| 258 | + |
|
| 259 | + /** |
|
| 260 | + * @param boolean $dismissible |
|
| 261 | + */ |
|
| 262 | + private function setDismissible($dismissible = true) |
|
| 263 | + { |
|
| 264 | + $this->dismissible = filter_var($dismissible, FILTER_VALIDATE_BOOLEAN); |
|
| 265 | + } |
|
| 266 | 266 | } |
@@ -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, |
@@ -18,371 +18,371 @@ |
||
| 18 | 18 | class Iframe |
| 19 | 19 | { |
| 20 | 20 | |
| 21 | - /* |
|
| 21 | + /* |
|
| 22 | 22 | * HTML for notices and ajax gif |
| 23 | 23 | * @var string $title |
| 24 | 24 | */ |
| 25 | - protected $title = ''; |
|
| 25 | + protected $title = ''; |
|
| 26 | 26 | |
| 27 | - /* |
|
| 27 | + /* |
|
| 28 | 28 | * HTML for the content being displayed |
| 29 | 29 | * @var string $content |
| 30 | 30 | */ |
| 31 | - protected $content = ''; |
|
| 31 | + protected $content = ''; |
|
| 32 | 32 | |
| 33 | - /* |
|
| 33 | + /* |
|
| 34 | 34 | * whether or not to call wp_head() and wp_footer() |
| 35 | 35 | * @var boolean $enqueue_wp_assets |
| 36 | 36 | */ |
| 37 | - protected $enqueue_wp_assets = false; |
|
| 37 | + protected $enqueue_wp_assets = false; |
|
| 38 | 38 | |
| 39 | - /* |
|
| 39 | + /* |
|
| 40 | 40 | * an array of CSS URLs |
| 41 | 41 | * @var array $css |
| 42 | 42 | */ |
| 43 | - protected $css = array(); |
|
| 43 | + protected $css = array(); |
|
| 44 | 44 | |
| 45 | - /* |
|
| 45 | + /* |
|
| 46 | 46 | * an array of JS URLs to be set in the HTML header. |
| 47 | 47 | * @var array $header_js |
| 48 | 48 | */ |
| 49 | - protected $header_js = array(); |
|
| 49 | + protected $header_js = array(); |
|
| 50 | 50 | |
| 51 | - /* |
|
| 51 | + /* |
|
| 52 | 52 | * an array of additional attributes to be added to <script> tags for header JS |
| 53 | 53 | * @var array $footer_js |
| 54 | 54 | */ |
| 55 | - protected $header_js_attributes = array(); |
|
| 55 | + protected $header_js_attributes = array(); |
|
| 56 | 56 | |
| 57 | - /* |
|
| 57 | + /* |
|
| 58 | 58 | * an array of JS URLs to be displayed before the HTML </body> tag |
| 59 | 59 | * @var array $footer_js |
| 60 | 60 | */ |
| 61 | - protected $footer_js = array(); |
|
| 61 | + protected $footer_js = array(); |
|
| 62 | 62 | |
| 63 | - /* |
|
| 63 | + /* |
|
| 64 | 64 | * an array of additional attributes to be added to <script> tags for footer JS |
| 65 | 65 | * @var array $footer_js_attributes |
| 66 | 66 | */ |
| 67 | - protected $footer_js_attributes = array(); |
|
| 67 | + protected $footer_js_attributes = array(); |
|
| 68 | 68 | |
| 69 | - /* |
|
| 69 | + /* |
|
| 70 | 70 | * an array of JSON vars to be set in the HTML header. |
| 71 | 71 | * @var array $localized_vars |
| 72 | 72 | */ |
| 73 | - protected $localized_vars = array(); |
|
| 74 | - |
|
| 75 | - |
|
| 76 | - /** |
|
| 77 | - * Iframe constructor |
|
| 78 | - * |
|
| 79 | - * @param string $title |
|
| 80 | - * @param string $content |
|
| 81 | - * @throws DomainException |
|
| 82 | - */ |
|
| 83 | - public function __construct($title, $content) |
|
| 84 | - { |
|
| 85 | - global $wp_version; |
|
| 86 | - if (! defined('EE_IFRAME_DIR_URL')) { |
|
| 87 | - define('EE_IFRAME_DIR_URL', plugin_dir_url(__FILE__)); |
|
| 88 | - } |
|
| 89 | - $this->setContent($content); |
|
| 90 | - $this->setTitle($title); |
|
| 91 | - $this->addStylesheets( |
|
| 92 | - apply_filters( |
|
| 93 | - 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_css', |
|
| 94 | - array( |
|
| 95 | - 'site_theme' => get_stylesheet_directory_uri() . DS |
|
| 96 | - . 'style.css?ver=' . EVENT_ESPRESSO_VERSION, |
|
| 97 | - 'dashicons' => includes_url('css/dashicons.min.css?ver=' . $wp_version), |
|
| 98 | - 'espresso_default' => EE_GLOBAL_ASSETS_URL |
|
| 99 | - . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION, |
|
| 100 | - ), |
|
| 101 | - $this |
|
| 102 | - ) |
|
| 103 | - ); |
|
| 104 | - $this->addScripts( |
|
| 105 | - apply_filters( |
|
| 106 | - 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_js', |
|
| 107 | - array( |
|
| 108 | - 'jquery' => includes_url('js/jquery/jquery.js?ver=' . $wp_version), |
|
| 109 | - 'espresso_core' => EE_GLOBAL_ASSETS_URL |
|
| 110 | - . 'scripts/espresso_core.js?ver=' . EVENT_ESPRESSO_VERSION, |
|
| 111 | - ), |
|
| 112 | - $this |
|
| 113 | - ) |
|
| 114 | - ); |
|
| 115 | - if (apply_filters( |
|
| 116 | - 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__load_default_theme_stylesheet', |
|
| 117 | - false |
|
| 118 | - )) { |
|
| 119 | - $this->addStylesheets( |
|
| 120 | - apply_filters( |
|
| 121 | - 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_theme_stylesheet', |
|
| 122 | - array('default_theme_stylesheet' => get_stylesheet_uri()), |
|
| 123 | - $this |
|
| 124 | - ) |
|
| 125 | - ); |
|
| 126 | - } |
|
| 127 | - } |
|
| 128 | - |
|
| 129 | - |
|
| 130 | - /** |
|
| 131 | - * @param string $title |
|
| 132 | - * @throws DomainException |
|
| 133 | - */ |
|
| 134 | - public function setTitle($title) |
|
| 135 | - { |
|
| 136 | - if (empty($title)) { |
|
| 137 | - throw new DomainException( |
|
| 138 | - esc_html__('You must provide a page title in order to create an iframe.', 'event_espresso') |
|
| 139 | - ); |
|
| 140 | - } |
|
| 141 | - $this->title = $title; |
|
| 142 | - } |
|
| 143 | - |
|
| 144 | - |
|
| 145 | - /** |
|
| 146 | - * @param string $content |
|
| 147 | - * @throws DomainException |
|
| 148 | - */ |
|
| 149 | - public function setContent($content) |
|
| 150 | - { |
|
| 151 | - if (empty($content)) { |
|
| 152 | - throw new DomainException( |
|
| 153 | - esc_html__('You must provide content in order to create an iframe.', 'event_espresso') |
|
| 154 | - ); |
|
| 155 | - } |
|
| 156 | - $this->content = $content; |
|
| 157 | - } |
|
| 158 | - |
|
| 159 | - |
|
| 160 | - /** |
|
| 161 | - * @param boolean $enqueue_wp_assets |
|
| 162 | - */ |
|
| 163 | - public function setEnqueueWpAssets($enqueue_wp_assets) |
|
| 164 | - { |
|
| 165 | - $this->enqueue_wp_assets = filter_var($enqueue_wp_assets, FILTER_VALIDATE_BOOLEAN); |
|
| 166 | - } |
|
| 167 | - |
|
| 168 | - |
|
| 169 | - /** |
|
| 170 | - * @param array $stylesheets |
|
| 171 | - * @throws DomainException |
|
| 172 | - */ |
|
| 173 | - public function addStylesheets(array $stylesheets) |
|
| 174 | - { |
|
| 175 | - if (empty($stylesheets)) { |
|
| 176 | - throw new DomainException( |
|
| 177 | - esc_html__( |
|
| 178 | - 'A non-empty array of URLs, is required to add a CSS stylesheet to an iframe.', |
|
| 179 | - 'event_espresso' |
|
| 180 | - ) |
|
| 181 | - ); |
|
| 182 | - } |
|
| 183 | - foreach ($stylesheets as $handle => $stylesheet) { |
|
| 184 | - $this->css[ $handle ] = $stylesheet; |
|
| 185 | - } |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - |
|
| 189 | - /** |
|
| 190 | - * @param array $scripts |
|
| 191 | - * @param bool $add_to_header |
|
| 192 | - * @throws DomainException |
|
| 193 | - */ |
|
| 194 | - public function addScripts(array $scripts, $add_to_header = false) |
|
| 195 | - { |
|
| 196 | - if (empty($scripts)) { |
|
| 197 | - throw new DomainException( |
|
| 198 | - esc_html__( |
|
| 199 | - 'A non-empty array of URLs, is required to add Javascript to an iframe.', |
|
| 200 | - 'event_espresso' |
|
| 201 | - ) |
|
| 202 | - ); |
|
| 203 | - } |
|
| 204 | - foreach ($scripts as $handle => $script) { |
|
| 205 | - if ($add_to_header) { |
|
| 206 | - $this->header_js[ $handle ] = $script; |
|
| 207 | - } else { |
|
| 208 | - $this->footer_js[ $handle ] = $script; |
|
| 209 | - } |
|
| 210 | - } |
|
| 211 | - } |
|
| 212 | - |
|
| 213 | - |
|
| 214 | - /** |
|
| 215 | - * @param array $script_attributes |
|
| 216 | - * @param bool $add_to_header |
|
| 217 | - * @throws DomainException |
|
| 218 | - */ |
|
| 219 | - public function addScriptAttributes(array $script_attributes, $add_to_header = false) |
|
| 220 | - { |
|
| 221 | - if (empty($script_attributes)) { |
|
| 222 | - throw new DomainException( |
|
| 223 | - esc_html__( |
|
| 224 | - 'A non-empty array of strings, is required to add attributes to iframe Javascript.', |
|
| 225 | - 'event_espresso' |
|
| 226 | - ) |
|
| 227 | - ); |
|
| 228 | - } |
|
| 229 | - foreach ($script_attributes as $handle => $script_attribute) { |
|
| 230 | - if ($add_to_header) { |
|
| 231 | - $this->header_js_attributes[ $handle ] = $script_attribute; |
|
| 232 | - } else { |
|
| 233 | - $this->footer_js_attributes[ $handle ] = $script_attribute; |
|
| 234 | - } |
|
| 235 | - } |
|
| 236 | - } |
|
| 237 | - |
|
| 238 | - |
|
| 239 | - /** |
|
| 240 | - * @param array $vars |
|
| 241 | - * @param string $var_name |
|
| 242 | - * @throws DomainException |
|
| 243 | - */ |
|
| 244 | - public function addLocalizedVars(array $vars, $var_name = 'eei18n') |
|
| 245 | - { |
|
| 246 | - if (empty($vars)) { |
|
| 247 | - throw new DomainException( |
|
| 248 | - esc_html__( |
|
| 249 | - 'A non-empty array of vars, is required to add localized Javascript vars to an iframe.', |
|
| 250 | - 'event_espresso' |
|
| 251 | - ) |
|
| 252 | - ); |
|
| 253 | - } |
|
| 254 | - foreach ($vars as $handle => $var) { |
|
| 255 | - if ($var_name === 'eei18n') { |
|
| 256 | - EE_Registry::$i18n_js_strings[ $handle ] = $var; |
|
| 257 | - } elseif ($var_name === 'eeCAL' && $handle === 'espresso_calendar') { |
|
| 258 | - $this->localized_vars[ $var_name ] = $var; |
|
| 259 | - } else { |
|
| 260 | - if (! isset($this->localized_vars[ $var_name ])) { |
|
| 261 | - $this->localized_vars[ $var_name ] = array(); |
|
| 262 | - } |
|
| 263 | - $this->localized_vars[ $var_name ][ $handle ] = $var; |
|
| 264 | - } |
|
| 265 | - } |
|
| 266 | - } |
|
| 267 | - |
|
| 268 | - |
|
| 269 | - /** |
|
| 270 | - * @param string $utm_content |
|
| 271 | - * @throws DomainException |
|
| 272 | - */ |
|
| 273 | - public function display($utm_content = '') |
|
| 274 | - { |
|
| 275 | - $this->content .= EEH_Template::powered_by_event_espresso( |
|
| 276 | - '', |
|
| 277 | - '', |
|
| 278 | - ! empty($utm_content) ? array('utm_content' => $utm_content) : array() |
|
| 279 | - ); |
|
| 280 | - EE_System::do_not_cache(); |
|
| 281 | - echo $this->getTemplate(); |
|
| 282 | - exit; |
|
| 283 | - } |
|
| 284 | - |
|
| 285 | - |
|
| 286 | - /** |
|
| 287 | - * @return string |
|
| 288 | - * @throws DomainException |
|
| 289 | - */ |
|
| 290 | - public function getTemplate() |
|
| 291 | - { |
|
| 292 | - return EEH_Template::display_template( |
|
| 293 | - __DIR__ . DIRECTORY_SEPARATOR . 'iframe_wrapper.template.php', |
|
| 294 | - array( |
|
| 295 | - 'title' => apply_filters( |
|
| 296 | - 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__title', |
|
| 297 | - $this->title, |
|
| 298 | - $this |
|
| 299 | - ), |
|
| 300 | - 'content' => apply_filters( |
|
| 301 | - 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__content', |
|
| 302 | - $this->content, |
|
| 303 | - $this |
|
| 304 | - ), |
|
| 305 | - 'enqueue_wp_assets' => apply_filters( |
|
| 306 | - 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__enqueue_wp_assets', |
|
| 307 | - $this->enqueue_wp_assets, |
|
| 308 | - $this |
|
| 309 | - ), |
|
| 310 | - 'css' => (array) apply_filters( |
|
| 311 | - 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__css_urls', |
|
| 312 | - $this->css, |
|
| 313 | - $this |
|
| 314 | - ), |
|
| 315 | - 'header_js' => (array) apply_filters( |
|
| 316 | - 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__header_js_urls', |
|
| 317 | - $this->header_js, |
|
| 318 | - $this |
|
| 319 | - ), |
|
| 320 | - 'header_js_attributes' => (array) apply_filters( |
|
| 321 | - 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__header_js_attributes', |
|
| 322 | - $this->header_js_attributes, |
|
| 323 | - $this |
|
| 324 | - ), |
|
| 325 | - 'footer_js' => (array) apply_filters( |
|
| 326 | - 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__footer_js_urls', |
|
| 327 | - $this->footer_js, |
|
| 328 | - $this |
|
| 329 | - ), |
|
| 330 | - 'footer_js_attributes' => (array) apply_filters( |
|
| 331 | - 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__footer_js_attributes', |
|
| 332 | - $this->footer_js_attributes, |
|
| 333 | - $this |
|
| 334 | - ), |
|
| 335 | - 'eei18n' => apply_filters( |
|
| 336 | - 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__eei18n_js_strings', |
|
| 337 | - EE_Registry::localize_i18n_js_strings() . $this->localizeJsonVars(), |
|
| 338 | - $this |
|
| 339 | - ), |
|
| 340 | - 'notices' => EEH_Template::display_template( |
|
| 341 | - EE_TEMPLATES . 'espresso-ajax-notices.template.php', |
|
| 342 | - array(), |
|
| 343 | - true |
|
| 344 | - ), |
|
| 345 | - ), |
|
| 346 | - true, |
|
| 347 | - true |
|
| 348 | - ); |
|
| 349 | - } |
|
| 350 | - |
|
| 351 | - |
|
| 352 | - /** |
|
| 353 | - * localizeJsonVars |
|
| 354 | - * |
|
| 355 | - * @return string |
|
| 356 | - */ |
|
| 357 | - public function localizeJsonVars() |
|
| 358 | - { |
|
| 359 | - $JSON = ''; |
|
| 360 | - foreach ((array) $this->localized_vars as $var_name => $vars) { |
|
| 361 | - $this->localized_vars[ $var_name ] = $this->encodeJsonVars($vars); |
|
| 362 | - $JSON .= "/* <![CDATA[ */ var {$var_name} = "; |
|
| 363 | - $JSON .= wp_json_encode($this->localized_vars[ $var_name ]); |
|
| 364 | - $JSON .= '; /* ]]> */'; |
|
| 365 | - } |
|
| 366 | - return $JSON; |
|
| 367 | - } |
|
| 368 | - |
|
| 369 | - |
|
| 370 | - /** |
|
| 371 | - * @param bool|int|float|string|array $var |
|
| 372 | - * @return array |
|
| 373 | - */ |
|
| 374 | - public function encodeJsonVars($var) |
|
| 375 | - { |
|
| 376 | - if (is_array($var)) { |
|
| 377 | - $localized_vars = array(); |
|
| 378 | - foreach ((array) $var as $key => $value) { |
|
| 379 | - $localized_vars[ $key ] = $this->encodeJsonVars($value); |
|
| 380 | - } |
|
| 381 | - return $localized_vars; |
|
| 382 | - } |
|
| 383 | - if (is_scalar($var)) { |
|
| 384 | - return html_entity_decode((string) $var, ENT_QUOTES, 'UTF-8'); |
|
| 385 | - } |
|
| 386 | - return null; |
|
| 387 | - } |
|
| 73 | + protected $localized_vars = array(); |
|
| 74 | + |
|
| 75 | + |
|
| 76 | + /** |
|
| 77 | + * Iframe constructor |
|
| 78 | + * |
|
| 79 | + * @param string $title |
|
| 80 | + * @param string $content |
|
| 81 | + * @throws DomainException |
|
| 82 | + */ |
|
| 83 | + public function __construct($title, $content) |
|
| 84 | + { |
|
| 85 | + global $wp_version; |
|
| 86 | + if (! defined('EE_IFRAME_DIR_URL')) { |
|
| 87 | + define('EE_IFRAME_DIR_URL', plugin_dir_url(__FILE__)); |
|
| 88 | + } |
|
| 89 | + $this->setContent($content); |
|
| 90 | + $this->setTitle($title); |
|
| 91 | + $this->addStylesheets( |
|
| 92 | + apply_filters( |
|
| 93 | + 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_css', |
|
| 94 | + array( |
|
| 95 | + 'site_theme' => get_stylesheet_directory_uri() . DS |
|
| 96 | + . 'style.css?ver=' . EVENT_ESPRESSO_VERSION, |
|
| 97 | + 'dashicons' => includes_url('css/dashicons.min.css?ver=' . $wp_version), |
|
| 98 | + 'espresso_default' => EE_GLOBAL_ASSETS_URL |
|
| 99 | + . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION, |
|
| 100 | + ), |
|
| 101 | + $this |
|
| 102 | + ) |
|
| 103 | + ); |
|
| 104 | + $this->addScripts( |
|
| 105 | + apply_filters( |
|
| 106 | + 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_js', |
|
| 107 | + array( |
|
| 108 | + 'jquery' => includes_url('js/jquery/jquery.js?ver=' . $wp_version), |
|
| 109 | + 'espresso_core' => EE_GLOBAL_ASSETS_URL |
|
| 110 | + . 'scripts/espresso_core.js?ver=' . EVENT_ESPRESSO_VERSION, |
|
| 111 | + ), |
|
| 112 | + $this |
|
| 113 | + ) |
|
| 114 | + ); |
|
| 115 | + if (apply_filters( |
|
| 116 | + 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__load_default_theme_stylesheet', |
|
| 117 | + false |
|
| 118 | + )) { |
|
| 119 | + $this->addStylesheets( |
|
| 120 | + apply_filters( |
|
| 121 | + 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_theme_stylesheet', |
|
| 122 | + array('default_theme_stylesheet' => get_stylesheet_uri()), |
|
| 123 | + $this |
|
| 124 | + ) |
|
| 125 | + ); |
|
| 126 | + } |
|
| 127 | + } |
|
| 128 | + |
|
| 129 | + |
|
| 130 | + /** |
|
| 131 | + * @param string $title |
|
| 132 | + * @throws DomainException |
|
| 133 | + */ |
|
| 134 | + public function setTitle($title) |
|
| 135 | + { |
|
| 136 | + if (empty($title)) { |
|
| 137 | + throw new DomainException( |
|
| 138 | + esc_html__('You must provide a page title in order to create an iframe.', 'event_espresso') |
|
| 139 | + ); |
|
| 140 | + } |
|
| 141 | + $this->title = $title; |
|
| 142 | + } |
|
| 143 | + |
|
| 144 | + |
|
| 145 | + /** |
|
| 146 | + * @param string $content |
|
| 147 | + * @throws DomainException |
|
| 148 | + */ |
|
| 149 | + public function setContent($content) |
|
| 150 | + { |
|
| 151 | + if (empty($content)) { |
|
| 152 | + throw new DomainException( |
|
| 153 | + esc_html__('You must provide content in order to create an iframe.', 'event_espresso') |
|
| 154 | + ); |
|
| 155 | + } |
|
| 156 | + $this->content = $content; |
|
| 157 | + } |
|
| 158 | + |
|
| 159 | + |
|
| 160 | + /** |
|
| 161 | + * @param boolean $enqueue_wp_assets |
|
| 162 | + */ |
|
| 163 | + public function setEnqueueWpAssets($enqueue_wp_assets) |
|
| 164 | + { |
|
| 165 | + $this->enqueue_wp_assets = filter_var($enqueue_wp_assets, FILTER_VALIDATE_BOOLEAN); |
|
| 166 | + } |
|
| 167 | + |
|
| 168 | + |
|
| 169 | + /** |
|
| 170 | + * @param array $stylesheets |
|
| 171 | + * @throws DomainException |
|
| 172 | + */ |
|
| 173 | + public function addStylesheets(array $stylesheets) |
|
| 174 | + { |
|
| 175 | + if (empty($stylesheets)) { |
|
| 176 | + throw new DomainException( |
|
| 177 | + esc_html__( |
|
| 178 | + 'A non-empty array of URLs, is required to add a CSS stylesheet to an iframe.', |
|
| 179 | + 'event_espresso' |
|
| 180 | + ) |
|
| 181 | + ); |
|
| 182 | + } |
|
| 183 | + foreach ($stylesheets as $handle => $stylesheet) { |
|
| 184 | + $this->css[ $handle ] = $stylesheet; |
|
| 185 | + } |
|
| 186 | + } |
|
| 187 | + |
|
| 188 | + |
|
| 189 | + /** |
|
| 190 | + * @param array $scripts |
|
| 191 | + * @param bool $add_to_header |
|
| 192 | + * @throws DomainException |
|
| 193 | + */ |
|
| 194 | + public function addScripts(array $scripts, $add_to_header = false) |
|
| 195 | + { |
|
| 196 | + if (empty($scripts)) { |
|
| 197 | + throw new DomainException( |
|
| 198 | + esc_html__( |
|
| 199 | + 'A non-empty array of URLs, is required to add Javascript to an iframe.', |
|
| 200 | + 'event_espresso' |
|
| 201 | + ) |
|
| 202 | + ); |
|
| 203 | + } |
|
| 204 | + foreach ($scripts as $handle => $script) { |
|
| 205 | + if ($add_to_header) { |
|
| 206 | + $this->header_js[ $handle ] = $script; |
|
| 207 | + } else { |
|
| 208 | + $this->footer_js[ $handle ] = $script; |
|
| 209 | + } |
|
| 210 | + } |
|
| 211 | + } |
|
| 212 | + |
|
| 213 | + |
|
| 214 | + /** |
|
| 215 | + * @param array $script_attributes |
|
| 216 | + * @param bool $add_to_header |
|
| 217 | + * @throws DomainException |
|
| 218 | + */ |
|
| 219 | + public function addScriptAttributes(array $script_attributes, $add_to_header = false) |
|
| 220 | + { |
|
| 221 | + if (empty($script_attributes)) { |
|
| 222 | + throw new DomainException( |
|
| 223 | + esc_html__( |
|
| 224 | + 'A non-empty array of strings, is required to add attributes to iframe Javascript.', |
|
| 225 | + 'event_espresso' |
|
| 226 | + ) |
|
| 227 | + ); |
|
| 228 | + } |
|
| 229 | + foreach ($script_attributes as $handle => $script_attribute) { |
|
| 230 | + if ($add_to_header) { |
|
| 231 | + $this->header_js_attributes[ $handle ] = $script_attribute; |
|
| 232 | + } else { |
|
| 233 | + $this->footer_js_attributes[ $handle ] = $script_attribute; |
|
| 234 | + } |
|
| 235 | + } |
|
| 236 | + } |
|
| 237 | + |
|
| 238 | + |
|
| 239 | + /** |
|
| 240 | + * @param array $vars |
|
| 241 | + * @param string $var_name |
|
| 242 | + * @throws DomainException |
|
| 243 | + */ |
|
| 244 | + public function addLocalizedVars(array $vars, $var_name = 'eei18n') |
|
| 245 | + { |
|
| 246 | + if (empty($vars)) { |
|
| 247 | + throw new DomainException( |
|
| 248 | + esc_html__( |
|
| 249 | + 'A non-empty array of vars, is required to add localized Javascript vars to an iframe.', |
|
| 250 | + 'event_espresso' |
|
| 251 | + ) |
|
| 252 | + ); |
|
| 253 | + } |
|
| 254 | + foreach ($vars as $handle => $var) { |
|
| 255 | + if ($var_name === 'eei18n') { |
|
| 256 | + EE_Registry::$i18n_js_strings[ $handle ] = $var; |
|
| 257 | + } elseif ($var_name === 'eeCAL' && $handle === 'espresso_calendar') { |
|
| 258 | + $this->localized_vars[ $var_name ] = $var; |
|
| 259 | + } else { |
|
| 260 | + if (! isset($this->localized_vars[ $var_name ])) { |
|
| 261 | + $this->localized_vars[ $var_name ] = array(); |
|
| 262 | + } |
|
| 263 | + $this->localized_vars[ $var_name ][ $handle ] = $var; |
|
| 264 | + } |
|
| 265 | + } |
|
| 266 | + } |
|
| 267 | + |
|
| 268 | + |
|
| 269 | + /** |
|
| 270 | + * @param string $utm_content |
|
| 271 | + * @throws DomainException |
|
| 272 | + */ |
|
| 273 | + public function display($utm_content = '') |
|
| 274 | + { |
|
| 275 | + $this->content .= EEH_Template::powered_by_event_espresso( |
|
| 276 | + '', |
|
| 277 | + '', |
|
| 278 | + ! empty($utm_content) ? array('utm_content' => $utm_content) : array() |
|
| 279 | + ); |
|
| 280 | + EE_System::do_not_cache(); |
|
| 281 | + echo $this->getTemplate(); |
|
| 282 | + exit; |
|
| 283 | + } |
|
| 284 | + |
|
| 285 | + |
|
| 286 | + /** |
|
| 287 | + * @return string |
|
| 288 | + * @throws DomainException |
|
| 289 | + */ |
|
| 290 | + public function getTemplate() |
|
| 291 | + { |
|
| 292 | + return EEH_Template::display_template( |
|
| 293 | + __DIR__ . DIRECTORY_SEPARATOR . 'iframe_wrapper.template.php', |
|
| 294 | + array( |
|
| 295 | + 'title' => apply_filters( |
|
| 296 | + 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__title', |
|
| 297 | + $this->title, |
|
| 298 | + $this |
|
| 299 | + ), |
|
| 300 | + 'content' => apply_filters( |
|
| 301 | + 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__content', |
|
| 302 | + $this->content, |
|
| 303 | + $this |
|
| 304 | + ), |
|
| 305 | + 'enqueue_wp_assets' => apply_filters( |
|
| 306 | + 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__enqueue_wp_assets', |
|
| 307 | + $this->enqueue_wp_assets, |
|
| 308 | + $this |
|
| 309 | + ), |
|
| 310 | + 'css' => (array) apply_filters( |
|
| 311 | + 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__css_urls', |
|
| 312 | + $this->css, |
|
| 313 | + $this |
|
| 314 | + ), |
|
| 315 | + 'header_js' => (array) apply_filters( |
|
| 316 | + 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__header_js_urls', |
|
| 317 | + $this->header_js, |
|
| 318 | + $this |
|
| 319 | + ), |
|
| 320 | + 'header_js_attributes' => (array) apply_filters( |
|
| 321 | + 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__header_js_attributes', |
|
| 322 | + $this->header_js_attributes, |
|
| 323 | + $this |
|
| 324 | + ), |
|
| 325 | + 'footer_js' => (array) apply_filters( |
|
| 326 | + 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__footer_js_urls', |
|
| 327 | + $this->footer_js, |
|
| 328 | + $this |
|
| 329 | + ), |
|
| 330 | + 'footer_js_attributes' => (array) apply_filters( |
|
| 331 | + 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__footer_js_attributes', |
|
| 332 | + $this->footer_js_attributes, |
|
| 333 | + $this |
|
| 334 | + ), |
|
| 335 | + 'eei18n' => apply_filters( |
|
| 336 | + 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__eei18n_js_strings', |
|
| 337 | + EE_Registry::localize_i18n_js_strings() . $this->localizeJsonVars(), |
|
| 338 | + $this |
|
| 339 | + ), |
|
| 340 | + 'notices' => EEH_Template::display_template( |
|
| 341 | + EE_TEMPLATES . 'espresso-ajax-notices.template.php', |
|
| 342 | + array(), |
|
| 343 | + true |
|
| 344 | + ), |
|
| 345 | + ), |
|
| 346 | + true, |
|
| 347 | + true |
|
| 348 | + ); |
|
| 349 | + } |
|
| 350 | + |
|
| 351 | + |
|
| 352 | + /** |
|
| 353 | + * localizeJsonVars |
|
| 354 | + * |
|
| 355 | + * @return string |
|
| 356 | + */ |
|
| 357 | + public function localizeJsonVars() |
|
| 358 | + { |
|
| 359 | + $JSON = ''; |
|
| 360 | + foreach ((array) $this->localized_vars as $var_name => $vars) { |
|
| 361 | + $this->localized_vars[ $var_name ] = $this->encodeJsonVars($vars); |
|
| 362 | + $JSON .= "/* <![CDATA[ */ var {$var_name} = "; |
|
| 363 | + $JSON .= wp_json_encode($this->localized_vars[ $var_name ]); |
|
| 364 | + $JSON .= '; /* ]]> */'; |
|
| 365 | + } |
|
| 366 | + return $JSON; |
|
| 367 | + } |
|
| 368 | + |
|
| 369 | + |
|
| 370 | + /** |
|
| 371 | + * @param bool|int|float|string|array $var |
|
| 372 | + * @return array |
|
| 373 | + */ |
|
| 374 | + public function encodeJsonVars($var) |
|
| 375 | + { |
|
| 376 | + if (is_array($var)) { |
|
| 377 | + $localized_vars = array(); |
|
| 378 | + foreach ((array) $var as $key => $value) { |
|
| 379 | + $localized_vars[ $key ] = $this->encodeJsonVars($value); |
|
| 380 | + } |
|
| 381 | + return $localized_vars; |
|
| 382 | + } |
|
| 383 | + if (is_scalar($var)) { |
|
| 384 | + return html_entity_decode((string) $var, ENT_QUOTES, 'UTF-8'); |
|
| 385 | + } |
|
| 386 | + return null; |
|
| 387 | + } |
|
| 388 | 388 | } |
@@ -83,7 +83,7 @@ discard block |
||
| 83 | 83 | public function __construct($title, $content) |
| 84 | 84 | { |
| 85 | 85 | global $wp_version; |
| 86 | - if (! defined('EE_IFRAME_DIR_URL')) { |
|
| 86 | + if ( ! defined('EE_IFRAME_DIR_URL')) { |
|
| 87 | 87 | define('EE_IFRAME_DIR_URL', plugin_dir_url(__FILE__)); |
| 88 | 88 | } |
| 89 | 89 | $this->setContent($content); |
@@ -92,11 +92,11 @@ discard block |
||
| 92 | 92 | apply_filters( |
| 93 | 93 | 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_css', |
| 94 | 94 | array( |
| 95 | - 'site_theme' => get_stylesheet_directory_uri() . DS |
|
| 96 | - . 'style.css?ver=' . EVENT_ESPRESSO_VERSION, |
|
| 97 | - 'dashicons' => includes_url('css/dashicons.min.css?ver=' . $wp_version), |
|
| 95 | + 'site_theme' => get_stylesheet_directory_uri().DS |
|
| 96 | + . 'style.css?ver='.EVENT_ESPRESSO_VERSION, |
|
| 97 | + 'dashicons' => includes_url('css/dashicons.min.css?ver='.$wp_version), |
|
| 98 | 98 | 'espresso_default' => EE_GLOBAL_ASSETS_URL |
| 99 | - . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION, |
|
| 99 | + . 'css/espresso_default.css?ver='.EVENT_ESPRESSO_VERSION, |
|
| 100 | 100 | ), |
| 101 | 101 | $this |
| 102 | 102 | ) |
@@ -105,9 +105,9 @@ discard block |
||
| 105 | 105 | apply_filters( |
| 106 | 106 | 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_js', |
| 107 | 107 | array( |
| 108 | - 'jquery' => includes_url('js/jquery/jquery.js?ver=' . $wp_version), |
|
| 108 | + 'jquery' => includes_url('js/jquery/jquery.js?ver='.$wp_version), |
|
| 109 | 109 | 'espresso_core' => EE_GLOBAL_ASSETS_URL |
| 110 | - . 'scripts/espresso_core.js?ver=' . EVENT_ESPRESSO_VERSION, |
|
| 110 | + . 'scripts/espresso_core.js?ver='.EVENT_ESPRESSO_VERSION, |
|
| 111 | 111 | ), |
| 112 | 112 | $this |
| 113 | 113 | ) |
@@ -181,7 +181,7 @@ discard block |
||
| 181 | 181 | ); |
| 182 | 182 | } |
| 183 | 183 | foreach ($stylesheets as $handle => $stylesheet) { |
| 184 | - $this->css[ $handle ] = $stylesheet; |
|
| 184 | + $this->css[$handle] = $stylesheet; |
|
| 185 | 185 | } |
| 186 | 186 | } |
| 187 | 187 | |
@@ -203,9 +203,9 @@ discard block |
||
| 203 | 203 | } |
| 204 | 204 | foreach ($scripts as $handle => $script) { |
| 205 | 205 | if ($add_to_header) { |
| 206 | - $this->header_js[ $handle ] = $script; |
|
| 206 | + $this->header_js[$handle] = $script; |
|
| 207 | 207 | } else { |
| 208 | - $this->footer_js[ $handle ] = $script; |
|
| 208 | + $this->footer_js[$handle] = $script; |
|
| 209 | 209 | } |
| 210 | 210 | } |
| 211 | 211 | } |
@@ -228,9 +228,9 @@ discard block |
||
| 228 | 228 | } |
| 229 | 229 | foreach ($script_attributes as $handle => $script_attribute) { |
| 230 | 230 | if ($add_to_header) { |
| 231 | - $this->header_js_attributes[ $handle ] = $script_attribute; |
|
| 231 | + $this->header_js_attributes[$handle] = $script_attribute; |
|
| 232 | 232 | } else { |
| 233 | - $this->footer_js_attributes[ $handle ] = $script_attribute; |
|
| 233 | + $this->footer_js_attributes[$handle] = $script_attribute; |
|
| 234 | 234 | } |
| 235 | 235 | } |
| 236 | 236 | } |
@@ -253,14 +253,14 @@ discard block |
||
| 253 | 253 | } |
| 254 | 254 | foreach ($vars as $handle => $var) { |
| 255 | 255 | if ($var_name === 'eei18n') { |
| 256 | - EE_Registry::$i18n_js_strings[ $handle ] = $var; |
|
| 256 | + EE_Registry::$i18n_js_strings[$handle] = $var; |
|
| 257 | 257 | } elseif ($var_name === 'eeCAL' && $handle === 'espresso_calendar') { |
| 258 | - $this->localized_vars[ $var_name ] = $var; |
|
| 258 | + $this->localized_vars[$var_name] = $var; |
|
| 259 | 259 | } else { |
| 260 | - if (! isset($this->localized_vars[ $var_name ])) { |
|
| 261 | - $this->localized_vars[ $var_name ] = array(); |
|
| 260 | + if ( ! isset($this->localized_vars[$var_name])) { |
|
| 261 | + $this->localized_vars[$var_name] = array(); |
|
| 262 | 262 | } |
| 263 | - $this->localized_vars[ $var_name ][ $handle ] = $var; |
|
| 263 | + $this->localized_vars[$var_name][$handle] = $var; |
|
| 264 | 264 | } |
| 265 | 265 | } |
| 266 | 266 | } |
@@ -290,7 +290,7 @@ discard block |
||
| 290 | 290 | public function getTemplate() |
| 291 | 291 | { |
| 292 | 292 | return EEH_Template::display_template( |
| 293 | - __DIR__ . DIRECTORY_SEPARATOR . 'iframe_wrapper.template.php', |
|
| 293 | + __DIR__.DIRECTORY_SEPARATOR.'iframe_wrapper.template.php', |
|
| 294 | 294 | array( |
| 295 | 295 | 'title' => apply_filters( |
| 296 | 296 | 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__title', |
@@ -334,11 +334,11 @@ discard block |
||
| 334 | 334 | ), |
| 335 | 335 | 'eei18n' => apply_filters( |
| 336 | 336 | 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__eei18n_js_strings', |
| 337 | - EE_Registry::localize_i18n_js_strings() . $this->localizeJsonVars(), |
|
| 337 | + EE_Registry::localize_i18n_js_strings().$this->localizeJsonVars(), |
|
| 338 | 338 | $this |
| 339 | 339 | ), |
| 340 | 340 | 'notices' => EEH_Template::display_template( |
| 341 | - EE_TEMPLATES . 'espresso-ajax-notices.template.php', |
|
| 341 | + EE_TEMPLATES.'espresso-ajax-notices.template.php', |
|
| 342 | 342 | array(), |
| 343 | 343 | true |
| 344 | 344 | ), |
@@ -358,9 +358,9 @@ discard block |
||
| 358 | 358 | { |
| 359 | 359 | $JSON = ''; |
| 360 | 360 | foreach ((array) $this->localized_vars as $var_name => $vars) { |
| 361 | - $this->localized_vars[ $var_name ] = $this->encodeJsonVars($vars); |
|
| 361 | + $this->localized_vars[$var_name] = $this->encodeJsonVars($vars); |
|
| 362 | 362 | $JSON .= "/* <![CDATA[ */ var {$var_name} = "; |
| 363 | - $JSON .= wp_json_encode($this->localized_vars[ $var_name ]); |
|
| 363 | + $JSON .= wp_json_encode($this->localized_vars[$var_name]); |
|
| 364 | 364 | $JSON .= '; /* ]]> */'; |
| 365 | 365 | } |
| 366 | 366 | return $JSON; |
@@ -376,7 +376,7 @@ discard block |
||
| 376 | 376 | if (is_array($var)) { |
| 377 | 377 | $localized_vars = array(); |
| 378 | 378 | foreach ((array) $var as $key => $value) { |
| 379 | - $localized_vars[ $key ] = $this->encodeJsonVars($value); |
|
| 379 | + $localized_vars[$key] = $this->encodeJsonVars($value); |
|
| 380 | 380 | } |
| 381 | 381 | return $localized_vars; |
| 382 | 382 | } |
@@ -13,274 +13,274 @@ |
||
| 13 | 13 | { |
| 14 | 14 | |
| 15 | 15 | |
| 16 | - /** |
|
| 17 | - * @var string $iframe_name |
|
| 18 | - */ |
|
| 19 | - private $iframe_name; |
|
| 16 | + /** |
|
| 17 | + * @var string $iframe_name |
|
| 18 | + */ |
|
| 19 | + private $iframe_name; |
|
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * @var string $route_name |
|
| 23 | - */ |
|
| 24 | - private $route_name; |
|
| 21 | + /** |
|
| 22 | + * @var string $route_name |
|
| 23 | + */ |
|
| 24 | + private $route_name; |
|
| 25 | 25 | |
| 26 | - /** |
|
| 27 | - * @var string $slug |
|
| 28 | - */ |
|
| 29 | - private $slug; |
|
| 26 | + /** |
|
| 27 | + * @var string $slug |
|
| 28 | + */ |
|
| 29 | + private $slug; |
|
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * @var boolean $append_filterable_content |
|
| 33 | - */ |
|
| 34 | - private $append_filterable_content; |
|
| 31 | + /** |
|
| 32 | + * @var boolean $append_filterable_content |
|
| 33 | + */ |
|
| 34 | + private $append_filterable_content; |
|
| 35 | 35 | |
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * IframeEmbedButton constructor. |
|
| 39 | - * |
|
| 40 | - * @param string $iframe_name i18n name for the iframe. This will be used in HTML |
|
| 41 | - * @param string $route_name the name of the registered route |
|
| 42 | - * @param string $slug URL slug used for the thing the iframe button is being embedded in. |
|
| 43 | - * will most likely be "event" since that's the only usage atm |
|
| 44 | - */ |
|
| 45 | - public function __construct($iframe_name, $route_name, $slug = 'event') |
|
| 46 | - { |
|
| 47 | - $this->iframe_name = $iframe_name; |
|
| 48 | - $this->route_name = $route_name; |
|
| 49 | - $this->slug = $slug; |
|
| 50 | - } |
|
| 37 | + /** |
|
| 38 | + * IframeEmbedButton constructor. |
|
| 39 | + * |
|
| 40 | + * @param string $iframe_name i18n name for the iframe. This will be used in HTML |
|
| 41 | + * @param string $route_name the name of the registered route |
|
| 42 | + * @param string $slug URL slug used for the thing the iframe button is being embedded in. |
|
| 43 | + * will most likely be "event" since that's the only usage atm |
|
| 44 | + */ |
|
| 45 | + public function __construct($iframe_name, $route_name, $slug = 'event') |
|
| 46 | + { |
|
| 47 | + $this->iframe_name = $iframe_name; |
|
| 48 | + $this->route_name = $route_name; |
|
| 49 | + $this->slug = $slug; |
|
| 50 | + } |
|
| 51 | 51 | |
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * Adds an iframe embed code button to the Event editor. |
|
| 55 | - */ |
|
| 56 | - public function addEventEditorIframeEmbedButtonFilter() |
|
| 57 | - { |
|
| 58 | - // add button for iframe code to event editor. |
|
| 59 | - add_filter( |
|
| 60 | - 'get_sample_permalink_html', |
|
| 61 | - array($this, 'appendIframeEmbedButtonToSamplePermalinkHtml'), |
|
| 62 | - 10, |
|
| 63 | - 2 |
|
| 64 | - ); |
|
| 65 | - add_action( |
|
| 66 | - 'admin_enqueue_scripts', |
|
| 67 | - array($this, 'embedButtonAssets'), |
|
| 68 | - 10 |
|
| 69 | - ); |
|
| 70 | - } |
|
| 53 | + /** |
|
| 54 | + * Adds an iframe embed code button to the Event editor. |
|
| 55 | + */ |
|
| 56 | + public function addEventEditorIframeEmbedButtonFilter() |
|
| 57 | + { |
|
| 58 | + // add button for iframe code to event editor. |
|
| 59 | + add_filter( |
|
| 60 | + 'get_sample_permalink_html', |
|
| 61 | + array($this, 'appendIframeEmbedButtonToSamplePermalinkHtml'), |
|
| 62 | + 10, |
|
| 63 | + 2 |
|
| 64 | + ); |
|
| 65 | + add_action( |
|
| 66 | + 'admin_enqueue_scripts', |
|
| 67 | + array($this, 'embedButtonAssets'), |
|
| 68 | + 10 |
|
| 69 | + ); |
|
| 70 | + } |
|
| 71 | 71 | |
| 72 | 72 | |
| 73 | - /** |
|
| 74 | - * @param $permalink_string |
|
| 75 | - * @param $id |
|
| 76 | - * @return string |
|
| 77 | - */ |
|
| 78 | - public function appendIframeEmbedButtonToSamplePermalinkHtml($permalink_string, $id) |
|
| 79 | - { |
|
| 80 | - return $this->eventEditorIframeEmbedButton( |
|
| 81 | - $permalink_string, |
|
| 82 | - $id |
|
| 83 | - ); |
|
| 84 | - } |
|
| 73 | + /** |
|
| 74 | + * @param $permalink_string |
|
| 75 | + * @param $id |
|
| 76 | + * @return string |
|
| 77 | + */ |
|
| 78 | + public function appendIframeEmbedButtonToSamplePermalinkHtml($permalink_string, $id) |
|
| 79 | + { |
|
| 80 | + return $this->eventEditorIframeEmbedButton( |
|
| 81 | + $permalink_string, |
|
| 82 | + $id |
|
| 83 | + ); |
|
| 84 | + } |
|
| 85 | 85 | |
| 86 | 86 | |
| 87 | - /** |
|
| 88 | - * iframe embed code button to the Event editor. |
|
| 89 | - * |
|
| 90 | - * @param string $permalink_string |
|
| 91 | - * @param int $id |
|
| 92 | - * @return string |
|
| 93 | - */ |
|
| 94 | - public function eventEditorIframeEmbedButton( |
|
| 95 | - $permalink_string, |
|
| 96 | - $id |
|
| 97 | - ) { |
|
| 98 | - // make sure this is ONLY when editing and the event id has been set. |
|
| 99 | - if (! empty($id)) { |
|
| 100 | - $post = get_post($id); |
|
| 101 | - // if NOT event then let's get out. |
|
| 102 | - if ($post->post_type !== 'espresso_events') { |
|
| 103 | - return $permalink_string; |
|
| 104 | - } |
|
| 105 | - $permalink_string .= $this->embedButtonHtml( |
|
| 106 | - array($this->slug => $id), |
|
| 107 | - 'button-small' |
|
| 108 | - ); |
|
| 109 | - } |
|
| 110 | - return $permalink_string; |
|
| 111 | - } |
|
| 87 | + /** |
|
| 88 | + * iframe embed code button to the Event editor. |
|
| 89 | + * |
|
| 90 | + * @param string $permalink_string |
|
| 91 | + * @param int $id |
|
| 92 | + * @return string |
|
| 93 | + */ |
|
| 94 | + public function eventEditorIframeEmbedButton( |
|
| 95 | + $permalink_string, |
|
| 96 | + $id |
|
| 97 | + ) { |
|
| 98 | + // make sure this is ONLY when editing and the event id has been set. |
|
| 99 | + if (! empty($id)) { |
|
| 100 | + $post = get_post($id); |
|
| 101 | + // if NOT event then let's get out. |
|
| 102 | + if ($post->post_type !== 'espresso_events') { |
|
| 103 | + return $permalink_string; |
|
| 104 | + } |
|
| 105 | + $permalink_string .= $this->embedButtonHtml( |
|
| 106 | + array($this->slug => $id), |
|
| 107 | + 'button-small' |
|
| 108 | + ); |
|
| 109 | + } |
|
| 110 | + return $permalink_string; |
|
| 111 | + } |
|
| 112 | 112 | |
| 113 | 113 | |
| 114 | - /** |
|
| 115 | - * Adds an iframe embed code button via a WP do_action() as determined by the first parameter |
|
| 116 | - * |
|
| 117 | - * @param string $action name of the WP do_action() to hook into |
|
| 118 | - */ |
|
| 119 | - public function addActionIframeEmbedButton($action) |
|
| 120 | - { |
|
| 121 | - // add button for iframe code to event editor. |
|
| 122 | - add_action( |
|
| 123 | - $action, |
|
| 124 | - array($this, 'addActionIframeEmbedButtonCallback'), |
|
| 125 | - 10, |
|
| 126 | - 2 |
|
| 127 | - ); |
|
| 128 | - } |
|
| 114 | + /** |
|
| 115 | + * Adds an iframe embed code button via a WP do_action() as determined by the first parameter |
|
| 116 | + * |
|
| 117 | + * @param string $action name of the WP do_action() to hook into |
|
| 118 | + */ |
|
| 119 | + public function addActionIframeEmbedButton($action) |
|
| 120 | + { |
|
| 121 | + // add button for iframe code to event editor. |
|
| 122 | + add_action( |
|
| 123 | + $action, |
|
| 124 | + array($this, 'addActionIframeEmbedButtonCallback'), |
|
| 125 | + 10, |
|
| 126 | + 2 |
|
| 127 | + ); |
|
| 128 | + } |
|
| 129 | 129 | |
| 130 | 130 | |
| 131 | - /** |
|
| 132 | - * @return void |
|
| 133 | - */ |
|
| 134 | - public function addActionIframeEmbedButtonCallback() |
|
| 135 | - { |
|
| 136 | - echo $this->embedButtonHtml(); |
|
| 137 | - } |
|
| 131 | + /** |
|
| 132 | + * @return void |
|
| 133 | + */ |
|
| 134 | + public function addActionIframeEmbedButtonCallback() |
|
| 135 | + { |
|
| 136 | + echo $this->embedButtonHtml(); |
|
| 137 | + } |
|
| 138 | 138 | |
| 139 | 139 | |
| 140 | - /** |
|
| 141 | - * Adds an iframe embed code button via a WP apply_filters() as determined by the first parameter |
|
| 142 | - * |
|
| 143 | - * @param string $filter name of the WP apply_filters() to hook into |
|
| 144 | - * @param bool $append if true, will add iframe embed button to end of content, |
|
| 145 | - * else if false, will add to the beginning of the content |
|
| 146 | - */ |
|
| 147 | - public function addFilterIframeEmbedButton($filter, $append = true) |
|
| 148 | - { |
|
| 149 | - $this->append_filterable_content = $append; |
|
| 150 | - // add button for iframe code to event editor. |
|
| 151 | - add_filter( |
|
| 152 | - $filter, |
|
| 153 | - array($this, 'addFilterIframeEmbedButtonCallback'), |
|
| 154 | - 10 |
|
| 155 | - ); |
|
| 156 | - } |
|
| 140 | + /** |
|
| 141 | + * Adds an iframe embed code button via a WP apply_filters() as determined by the first parameter |
|
| 142 | + * |
|
| 143 | + * @param string $filter name of the WP apply_filters() to hook into |
|
| 144 | + * @param bool $append if true, will add iframe embed button to end of content, |
|
| 145 | + * else if false, will add to the beginning of the content |
|
| 146 | + */ |
|
| 147 | + public function addFilterIframeEmbedButton($filter, $append = true) |
|
| 148 | + { |
|
| 149 | + $this->append_filterable_content = $append; |
|
| 150 | + // add button for iframe code to event editor. |
|
| 151 | + add_filter( |
|
| 152 | + $filter, |
|
| 153 | + array($this, 'addFilterIframeEmbedButtonCallback'), |
|
| 154 | + 10 |
|
| 155 | + ); |
|
| 156 | + } |
|
| 157 | 157 | |
| 158 | 158 | |
| 159 | - /** |
|
| 160 | - * @param array|string $filterable_content |
|
| 161 | - * @return array|string |
|
| 162 | - */ |
|
| 163 | - public function addFilterIframeEmbedButtonCallback($filterable_content) |
|
| 164 | - { |
|
| 165 | - $embedButtonHtml = $this->embedButtonHtml(); |
|
| 166 | - if (is_array($filterable_content)) { |
|
| 167 | - $filterable_content = $this->append_filterable_content |
|
| 168 | - ? $filterable_content + array($this->route_name => $embedButtonHtml) |
|
| 169 | - : array($this->route_name => $embedButtonHtml) + $filterable_content; |
|
| 170 | - } else { |
|
| 171 | - $filterable_content = $this->append_filterable_content |
|
| 172 | - ? $filterable_content . $embedButtonHtml |
|
| 173 | - : $embedButtonHtml . $filterable_content; |
|
| 174 | - } |
|
| 175 | - return $filterable_content; |
|
| 176 | - } |
|
| 159 | + /** |
|
| 160 | + * @param array|string $filterable_content |
|
| 161 | + * @return array|string |
|
| 162 | + */ |
|
| 163 | + public function addFilterIframeEmbedButtonCallback($filterable_content) |
|
| 164 | + { |
|
| 165 | + $embedButtonHtml = $this->embedButtonHtml(); |
|
| 166 | + if (is_array($filterable_content)) { |
|
| 167 | + $filterable_content = $this->append_filterable_content |
|
| 168 | + ? $filterable_content + array($this->route_name => $embedButtonHtml) |
|
| 169 | + : array($this->route_name => $embedButtonHtml) + $filterable_content; |
|
| 170 | + } else { |
|
| 171 | + $filterable_content = $this->append_filterable_content |
|
| 172 | + ? $filterable_content . $embedButtonHtml |
|
| 173 | + : $embedButtonHtml . $filterable_content; |
|
| 174 | + } |
|
| 175 | + return $filterable_content; |
|
| 176 | + } |
|
| 177 | 177 | |
| 178 | 178 | |
| 179 | - /** |
|
| 180 | - * iframe_embed_html |
|
| 181 | - * |
|
| 182 | - * @param array $query_args |
|
| 183 | - * @param string $button_class |
|
| 184 | - * @return string |
|
| 185 | - */ |
|
| 186 | - public function embedButtonHtml($query_args = array(), $button_class = '') |
|
| 187 | - { |
|
| 188 | - // incoming args will replace the defaults listed here in the second array (union preserves first array) |
|
| 189 | - $query_args = (array) $query_args + array($this->route_name => 'iframe'); |
|
| 190 | - $query_args = (array) apply_filters( |
|
| 191 | - 'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__embedButtonHtml__query_args', |
|
| 192 | - $query_args |
|
| 193 | - ); |
|
| 194 | - // add this route to our localized vars |
|
| 195 | - $iframe_module_routes = isset(\EE_Registry::$i18n_js_strings['iframe_module_routes']) |
|
| 196 | - ? \EE_Registry::$i18n_js_strings['iframe_module_routes'] |
|
| 197 | - : array(); |
|
| 198 | - $iframe_module_routes[ $this->route_name ] = $this->route_name; |
|
| 199 | - \EE_Registry::$i18n_js_strings['iframe_module_routes'] = $iframe_module_routes; |
|
| 200 | - $iframe_embed_html = \EEH_HTML::link( |
|
| 201 | - '#', |
|
| 202 | - sprintf(esc_html__('Embed %1$s', 'event_espresso'), $this->iframe_name), |
|
| 203 | - sprintf( |
|
| 204 | - esc_html__( |
|
| 205 | - 'click here to generate code for embedding %1$s iframe into another site.', |
|
| 206 | - 'event_espresso' |
|
| 207 | - ), |
|
| 208 | - \EEH_Inflector::add_indefinite_article($this->iframe_name) |
|
| 209 | - ), |
|
| 210 | - "{$this->route_name}-iframe-embed-trigger-js", |
|
| 211 | - 'iframe-embed-trigger-js button ' . $button_class, |
|
| 212 | - '', |
|
| 213 | - ' data-iframe_embed_button="#' . $this->route_name . '-iframe-js" tabindex="-1"' |
|
| 214 | - ); |
|
| 215 | - $iframe_embed_html .= \EEH_HTML::div( |
|
| 216 | - '', |
|
| 217 | - "{$this->route_name}-iframe-js", |
|
| 218 | - 'iframe-embed-wrapper-js', |
|
| 219 | - 'display:none;' |
|
| 220 | - ); |
|
| 221 | - $iframe_embed_html .= esc_html( |
|
| 222 | - \EEH_HTML::div( |
|
| 223 | - '<iframe src="' . add_query_arg($query_args, site_url()) . '" width="100%" height="100%"></iframe>', |
|
| 224 | - '', |
|
| 225 | - '', |
|
| 226 | - 'width:100%; height: 500px;' |
|
| 227 | - ) |
|
| 228 | - ); |
|
| 229 | - $iframe_embed_html .= \EEH_HTML::divx(); |
|
| 230 | - return $iframe_embed_html; |
|
| 231 | - } |
|
| 179 | + /** |
|
| 180 | + * iframe_embed_html |
|
| 181 | + * |
|
| 182 | + * @param array $query_args |
|
| 183 | + * @param string $button_class |
|
| 184 | + * @return string |
|
| 185 | + */ |
|
| 186 | + public function embedButtonHtml($query_args = array(), $button_class = '') |
|
| 187 | + { |
|
| 188 | + // incoming args will replace the defaults listed here in the second array (union preserves first array) |
|
| 189 | + $query_args = (array) $query_args + array($this->route_name => 'iframe'); |
|
| 190 | + $query_args = (array) apply_filters( |
|
| 191 | + 'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__embedButtonHtml__query_args', |
|
| 192 | + $query_args |
|
| 193 | + ); |
|
| 194 | + // add this route to our localized vars |
|
| 195 | + $iframe_module_routes = isset(\EE_Registry::$i18n_js_strings['iframe_module_routes']) |
|
| 196 | + ? \EE_Registry::$i18n_js_strings['iframe_module_routes'] |
|
| 197 | + : array(); |
|
| 198 | + $iframe_module_routes[ $this->route_name ] = $this->route_name; |
|
| 199 | + \EE_Registry::$i18n_js_strings['iframe_module_routes'] = $iframe_module_routes; |
|
| 200 | + $iframe_embed_html = \EEH_HTML::link( |
|
| 201 | + '#', |
|
| 202 | + sprintf(esc_html__('Embed %1$s', 'event_espresso'), $this->iframe_name), |
|
| 203 | + sprintf( |
|
| 204 | + esc_html__( |
|
| 205 | + 'click here to generate code for embedding %1$s iframe into another site.', |
|
| 206 | + 'event_espresso' |
|
| 207 | + ), |
|
| 208 | + \EEH_Inflector::add_indefinite_article($this->iframe_name) |
|
| 209 | + ), |
|
| 210 | + "{$this->route_name}-iframe-embed-trigger-js", |
|
| 211 | + 'iframe-embed-trigger-js button ' . $button_class, |
|
| 212 | + '', |
|
| 213 | + ' data-iframe_embed_button="#' . $this->route_name . '-iframe-js" tabindex="-1"' |
|
| 214 | + ); |
|
| 215 | + $iframe_embed_html .= \EEH_HTML::div( |
|
| 216 | + '', |
|
| 217 | + "{$this->route_name}-iframe-js", |
|
| 218 | + 'iframe-embed-wrapper-js', |
|
| 219 | + 'display:none;' |
|
| 220 | + ); |
|
| 221 | + $iframe_embed_html .= esc_html( |
|
| 222 | + \EEH_HTML::div( |
|
| 223 | + '<iframe src="' . add_query_arg($query_args, site_url()) . '" width="100%" height="100%"></iframe>', |
|
| 224 | + '', |
|
| 225 | + '', |
|
| 226 | + 'width:100%; height: 500px;' |
|
| 227 | + ) |
|
| 228 | + ); |
|
| 229 | + $iframe_embed_html .= \EEH_HTML::divx(); |
|
| 230 | + return $iframe_embed_html; |
|
| 231 | + } |
|
| 232 | 232 | |
| 233 | 233 | |
| 234 | - /** |
|
| 235 | - * enqueue iframe button js |
|
| 236 | - */ |
|
| 237 | - public function embedButtonAssets() |
|
| 238 | - { |
|
| 239 | - \EE_Registry::$i18n_js_strings['iframe_embed_title'] = esc_html__( |
|
| 240 | - 'copy and paste the following into any other site\'s content to display this event:', |
|
| 241 | - 'event_espresso' |
|
| 242 | - ); |
|
| 243 | - \EE_Registry::$i18n_js_strings['iframe_embed_close_msg'] = esc_html__( |
|
| 244 | - 'click anywhere outside of this window to close it.', |
|
| 245 | - 'event_espresso' |
|
| 246 | - ); |
|
| 247 | - wp_register_script( |
|
| 248 | - 'iframe_embed_button', |
|
| 249 | - plugin_dir_url(__FILE__) . 'iframe-embed-button.js', |
|
| 250 | - array('ee-dialog'), |
|
| 251 | - EVENT_ESPRESSO_VERSION, |
|
| 252 | - true |
|
| 253 | - ); |
|
| 254 | - wp_enqueue_script('iframe_embed_button'); |
|
| 255 | - } |
|
| 234 | + /** |
|
| 235 | + * enqueue iframe button js |
|
| 236 | + */ |
|
| 237 | + public function embedButtonAssets() |
|
| 238 | + { |
|
| 239 | + \EE_Registry::$i18n_js_strings['iframe_embed_title'] = esc_html__( |
|
| 240 | + 'copy and paste the following into any other site\'s content to display this event:', |
|
| 241 | + 'event_espresso' |
|
| 242 | + ); |
|
| 243 | + \EE_Registry::$i18n_js_strings['iframe_embed_close_msg'] = esc_html__( |
|
| 244 | + 'click anywhere outside of this window to close it.', |
|
| 245 | + 'event_espresso' |
|
| 246 | + ); |
|
| 247 | + wp_register_script( |
|
| 248 | + 'iframe_embed_button', |
|
| 249 | + plugin_dir_url(__FILE__) . 'iframe-embed-button.js', |
|
| 250 | + array('ee-dialog'), |
|
| 251 | + EVENT_ESPRESSO_VERSION, |
|
| 252 | + true |
|
| 253 | + ); |
|
| 254 | + wp_enqueue_script('iframe_embed_button'); |
|
| 255 | + } |
|
| 256 | 256 | |
| 257 | 257 | |
| 258 | - /** |
|
| 259 | - * generates embed button sections for admin pages |
|
| 260 | - * |
|
| 261 | - * @param array $embed_buttons |
|
| 262 | - * @return string |
|
| 263 | - */ |
|
| 264 | - public function addIframeEmbedButtonsSection(array $embed_buttons) |
|
| 265 | - { |
|
| 266 | - $embed_buttons = (array) apply_filters( |
|
| 267 | - 'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__addIframeEmbedButtonsSection__embed_buttons', |
|
| 268 | - $embed_buttons |
|
| 269 | - ); |
|
| 270 | - if (empty($embed_buttons)) { |
|
| 271 | - return ''; |
|
| 272 | - } |
|
| 273 | - // add button for iframe code to event editor. |
|
| 274 | - $html = \EEH_HTML::br(2); |
|
| 275 | - $html .= \EEH_HTML::h3(esc_html__('iFrame Embed Code', 'event_espresso')); |
|
| 276 | - $html .= \EEH_HTML::p( |
|
| 277 | - esc_html__( |
|
| 278 | - 'Click the following button(s) to generate iframe HTML that will allow you to embed your event content within the content of other websites.', |
|
| 279 | - 'event_espresso' |
|
| 280 | - ) |
|
| 281 | - ); |
|
| 282 | - $html .= ' ' . implode(' ', $embed_buttons) . ' '; |
|
| 283 | - $html .= \EEH_HTML::br(2); |
|
| 284 | - return $html; |
|
| 285 | - } |
|
| 258 | + /** |
|
| 259 | + * generates embed button sections for admin pages |
|
| 260 | + * |
|
| 261 | + * @param array $embed_buttons |
|
| 262 | + * @return string |
|
| 263 | + */ |
|
| 264 | + public function addIframeEmbedButtonsSection(array $embed_buttons) |
|
| 265 | + { |
|
| 266 | + $embed_buttons = (array) apply_filters( |
|
| 267 | + 'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__addIframeEmbedButtonsSection__embed_buttons', |
|
| 268 | + $embed_buttons |
|
| 269 | + ); |
|
| 270 | + if (empty($embed_buttons)) { |
|
| 271 | + return ''; |
|
| 272 | + } |
|
| 273 | + // add button for iframe code to event editor. |
|
| 274 | + $html = \EEH_HTML::br(2); |
|
| 275 | + $html .= \EEH_HTML::h3(esc_html__('iFrame Embed Code', 'event_espresso')); |
|
| 276 | + $html .= \EEH_HTML::p( |
|
| 277 | + esc_html__( |
|
| 278 | + 'Click the following button(s) to generate iframe HTML that will allow you to embed your event content within the content of other websites.', |
|
| 279 | + 'event_espresso' |
|
| 280 | + ) |
|
| 281 | + ); |
|
| 282 | + $html .= ' ' . implode(' ', $embed_buttons) . ' '; |
|
| 283 | + $html .= \EEH_HTML::br(2); |
|
| 284 | + return $html; |
|
| 285 | + } |
|
| 286 | 286 | } |
@@ -96,7 +96,7 @@ discard block |
||
| 96 | 96 | $id |
| 97 | 97 | ) { |
| 98 | 98 | // make sure this is ONLY when editing and the event id has been set. |
| 99 | - if (! empty($id)) { |
|
| 99 | + if ( ! empty($id)) { |
|
| 100 | 100 | $post = get_post($id); |
| 101 | 101 | // if NOT event then let's get out. |
| 102 | 102 | if ($post->post_type !== 'espresso_events') { |
@@ -169,8 +169,8 @@ discard block |
||
| 169 | 169 | : array($this->route_name => $embedButtonHtml) + $filterable_content; |
| 170 | 170 | } else { |
| 171 | 171 | $filterable_content = $this->append_filterable_content |
| 172 | - ? $filterable_content . $embedButtonHtml |
|
| 173 | - : $embedButtonHtml . $filterable_content; |
|
| 172 | + ? $filterable_content.$embedButtonHtml |
|
| 173 | + : $embedButtonHtml.$filterable_content; |
|
| 174 | 174 | } |
| 175 | 175 | return $filterable_content; |
| 176 | 176 | } |
@@ -195,7 +195,7 @@ discard block |
||
| 195 | 195 | $iframe_module_routes = isset(\EE_Registry::$i18n_js_strings['iframe_module_routes']) |
| 196 | 196 | ? \EE_Registry::$i18n_js_strings['iframe_module_routes'] |
| 197 | 197 | : array(); |
| 198 | - $iframe_module_routes[ $this->route_name ] = $this->route_name; |
|
| 198 | + $iframe_module_routes[$this->route_name] = $this->route_name; |
|
| 199 | 199 | \EE_Registry::$i18n_js_strings['iframe_module_routes'] = $iframe_module_routes; |
| 200 | 200 | $iframe_embed_html = \EEH_HTML::link( |
| 201 | 201 | '#', |
@@ -208,9 +208,9 @@ discard block |
||
| 208 | 208 | \EEH_Inflector::add_indefinite_article($this->iframe_name) |
| 209 | 209 | ), |
| 210 | 210 | "{$this->route_name}-iframe-embed-trigger-js", |
| 211 | - 'iframe-embed-trigger-js button ' . $button_class, |
|
| 211 | + 'iframe-embed-trigger-js button '.$button_class, |
|
| 212 | 212 | '', |
| 213 | - ' data-iframe_embed_button="#' . $this->route_name . '-iframe-js" tabindex="-1"' |
|
| 213 | + ' data-iframe_embed_button="#'.$this->route_name.'-iframe-js" tabindex="-1"' |
|
| 214 | 214 | ); |
| 215 | 215 | $iframe_embed_html .= \EEH_HTML::div( |
| 216 | 216 | '', |
@@ -220,7 +220,7 @@ discard block |
||
| 220 | 220 | ); |
| 221 | 221 | $iframe_embed_html .= esc_html( |
| 222 | 222 | \EEH_HTML::div( |
| 223 | - '<iframe src="' . add_query_arg($query_args, site_url()) . '" width="100%" height="100%"></iframe>', |
|
| 223 | + '<iframe src="'.add_query_arg($query_args, site_url()).'" width="100%" height="100%"></iframe>', |
|
| 224 | 224 | '', |
| 225 | 225 | '', |
| 226 | 226 | 'width:100%; height: 500px;' |
@@ -246,7 +246,7 @@ discard block |
||
| 246 | 246 | ); |
| 247 | 247 | wp_register_script( |
| 248 | 248 | 'iframe_embed_button', |
| 249 | - plugin_dir_url(__FILE__) . 'iframe-embed-button.js', |
|
| 249 | + plugin_dir_url(__FILE__).'iframe-embed-button.js', |
|
| 250 | 250 | array('ee-dialog'), |
| 251 | 251 | EVENT_ESPRESSO_VERSION, |
| 252 | 252 | true |
@@ -279,7 +279,7 @@ discard block |
||
| 279 | 279 | 'event_espresso' |
| 280 | 280 | ) |
| 281 | 281 | ); |
| 282 | - $html .= ' ' . implode(' ', $embed_buttons) . ' '; |
|
| 282 | + $html .= ' '.implode(' ', $embed_buttons).' '; |
|
| 283 | 283 | $html .= \EEH_HTML::br(2); |
| 284 | 284 | return $html; |
| 285 | 285 | } |
@@ -20,85 +20,85 @@ |
||
| 20 | 20 | class Read |
| 21 | 21 | { |
| 22 | 22 | |
| 23 | - /** |
|
| 24 | - * @param WP_REST_Request $request |
|
| 25 | - * @param string $version |
|
| 26 | - * @return EE_Config|WP_Error |
|
| 27 | - */ |
|
| 28 | - public static function handleRequest(WP_REST_Request $request, $version) |
|
| 29 | - { |
|
| 30 | - $cap = EE_Restriction_Generator_Base::get_default_restrictions_cap(); |
|
| 31 | - if (EE_Capabilities::instance()->current_user_can($cap, 'read_over_api')) { |
|
| 32 | - return EE_Config::instance(); |
|
| 33 | - } else { |
|
| 34 | - return new WP_Error( |
|
| 35 | - 'cannot_read_config', |
|
| 36 | - sprintf( |
|
| 37 | - __( |
|
| 38 | - 'You do not have the necessary capabilities (%s) to read Event Espresso Configuration data', |
|
| 39 | - 'event_espresso' |
|
| 40 | - ), |
|
| 41 | - $cap |
|
| 42 | - ), |
|
| 43 | - array('status' => 403) |
|
| 44 | - ); |
|
| 45 | - } |
|
| 46 | - } |
|
| 23 | + /** |
|
| 24 | + * @param WP_REST_Request $request |
|
| 25 | + * @param string $version |
|
| 26 | + * @return EE_Config|WP_Error |
|
| 27 | + */ |
|
| 28 | + public static function handleRequest(WP_REST_Request $request, $version) |
|
| 29 | + { |
|
| 30 | + $cap = EE_Restriction_Generator_Base::get_default_restrictions_cap(); |
|
| 31 | + if (EE_Capabilities::instance()->current_user_can($cap, 'read_over_api')) { |
|
| 32 | + return EE_Config::instance(); |
|
| 33 | + } else { |
|
| 34 | + return new WP_Error( |
|
| 35 | + 'cannot_read_config', |
|
| 36 | + sprintf( |
|
| 37 | + __( |
|
| 38 | + 'You do not have the necessary capabilities (%s) to read Event Espresso Configuration data', |
|
| 39 | + 'event_espresso' |
|
| 40 | + ), |
|
| 41 | + $cap |
|
| 42 | + ), |
|
| 43 | + array('status' => 403) |
|
| 44 | + ); |
|
| 45 | + } |
|
| 46 | + } |
|
| 47 | 47 | |
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * Handles the request for public site info |
|
| 51 | - * |
|
| 52 | - * @global $wp_json_basic_auth_success boolean set by the basic auth plugin, indicates if the |
|
| 53 | - * current user could be authenticated using basic auth |
|
| 54 | - * data |
|
| 55 | - * @global $wp_json_basic_auth_received_data boolean set by the basic auth plugin, indicates if |
|
| 56 | - * basic auth data was somehow received |
|
| 57 | - * @param WP_REST_Request $request |
|
| 58 | - * @param string $version |
|
| 59 | - * @return array|WP_Error |
|
| 60 | - */ |
|
| 61 | - public static function handleRequestSiteInfo(WP_REST_Request $request, $version) |
|
| 62 | - { |
|
| 63 | - global $wp_json_basic_auth_success, $wp_json_basic_auth_received_data; |
|
| 64 | - $insecure_usage_of_basic_auth = apply_filters( |
|
| 65 | - // @codingStandardsIgnoreStart |
|
| 66 | - 'EventEspresso__core__libraries__rest_api__controllers__config__handle_request_site_info__insecure_usage_of_basic_auth', |
|
| 67 | - // @codingStandardsIgnoreEnd |
|
| 68 | - $wp_json_basic_auth_success && ! is_ssl(), |
|
| 69 | - $request |
|
| 70 | - ); |
|
| 71 | - if ($insecure_usage_of_basic_auth) { |
|
| 72 | - $warning = sprintf( |
|
| 73 | - esc_html__( |
|
| 74 | - // @codingStandardsIgnoreStart |
|
| 75 | - 'Notice: We strongly recommend installing an SSL Certificate on your website to keep your data secure. %1$sPlease see our recommendations.%2$s', |
|
| 76 | - // @codingStandardsIgnoreEnd |
|
| 77 | - 'event_espresso' |
|
| 78 | - ), |
|
| 79 | - '<a href="https://eventespresso.com/wiki/rest-api-security-recommendations/">', |
|
| 80 | - '</a>' |
|
| 81 | - ); |
|
| 82 | - } else { |
|
| 83 | - $warning = ''; |
|
| 84 | - } |
|
| 85 | - return apply_filters( |
|
| 86 | - 'FHEE__EventEspresso_core_libraries_rest_api_controllers_config__handleRequestSiteInfo__return_val', |
|
| 87 | - array( |
|
| 88 | - 'default_timezone' => array( |
|
| 89 | - 'pretty' => EEH_DTT_Helper::get_timezone_string_for_display(), |
|
| 90 | - 'string' => get_option('timezone_string'), |
|
| 91 | - 'offset' => EEH_DTT_Helper::get_site_timezone_gmt_offset(), |
|
| 92 | - ), |
|
| 93 | - 'default_currency' => EE_Config::instance()->currency, |
|
| 94 | - 'authentication' => array( |
|
| 95 | - 'received_basic_auth_data' => (bool) $wp_json_basic_auth_received_data, |
|
| 96 | - 'insecure_usage_of_basic_auth' => (bool) $insecure_usage_of_basic_auth, |
|
| 97 | - 'warning' => $warning, |
|
| 98 | - ), |
|
| 99 | - ) |
|
| 100 | - ); |
|
| 101 | - } |
|
| 49 | + /** |
|
| 50 | + * Handles the request for public site info |
|
| 51 | + * |
|
| 52 | + * @global $wp_json_basic_auth_success boolean set by the basic auth plugin, indicates if the |
|
| 53 | + * current user could be authenticated using basic auth |
|
| 54 | + * data |
|
| 55 | + * @global $wp_json_basic_auth_received_data boolean set by the basic auth plugin, indicates if |
|
| 56 | + * basic auth data was somehow received |
|
| 57 | + * @param WP_REST_Request $request |
|
| 58 | + * @param string $version |
|
| 59 | + * @return array|WP_Error |
|
| 60 | + */ |
|
| 61 | + public static function handleRequestSiteInfo(WP_REST_Request $request, $version) |
|
| 62 | + { |
|
| 63 | + global $wp_json_basic_auth_success, $wp_json_basic_auth_received_data; |
|
| 64 | + $insecure_usage_of_basic_auth = apply_filters( |
|
| 65 | + // @codingStandardsIgnoreStart |
|
| 66 | + 'EventEspresso__core__libraries__rest_api__controllers__config__handle_request_site_info__insecure_usage_of_basic_auth', |
|
| 67 | + // @codingStandardsIgnoreEnd |
|
| 68 | + $wp_json_basic_auth_success && ! is_ssl(), |
|
| 69 | + $request |
|
| 70 | + ); |
|
| 71 | + if ($insecure_usage_of_basic_auth) { |
|
| 72 | + $warning = sprintf( |
|
| 73 | + esc_html__( |
|
| 74 | + // @codingStandardsIgnoreStart |
|
| 75 | + 'Notice: We strongly recommend installing an SSL Certificate on your website to keep your data secure. %1$sPlease see our recommendations.%2$s', |
|
| 76 | + // @codingStandardsIgnoreEnd |
|
| 77 | + 'event_espresso' |
|
| 78 | + ), |
|
| 79 | + '<a href="https://eventespresso.com/wiki/rest-api-security-recommendations/">', |
|
| 80 | + '</a>' |
|
| 81 | + ); |
|
| 82 | + } else { |
|
| 83 | + $warning = ''; |
|
| 84 | + } |
|
| 85 | + return apply_filters( |
|
| 86 | + 'FHEE__EventEspresso_core_libraries_rest_api_controllers_config__handleRequestSiteInfo__return_val', |
|
| 87 | + array( |
|
| 88 | + 'default_timezone' => array( |
|
| 89 | + 'pretty' => EEH_DTT_Helper::get_timezone_string_for_display(), |
|
| 90 | + 'string' => get_option('timezone_string'), |
|
| 91 | + 'offset' => EEH_DTT_Helper::get_site_timezone_gmt_offset(), |
|
| 92 | + ), |
|
| 93 | + 'default_currency' => EE_Config::instance()->currency, |
|
| 94 | + 'authentication' => array( |
|
| 95 | + 'received_basic_auth_data' => (bool) $wp_json_basic_auth_received_data, |
|
| 96 | + 'insecure_usage_of_basic_auth' => (bool) $insecure_usage_of_basic_auth, |
|
| 97 | + 'warning' => $warning, |
|
| 98 | + ), |
|
| 99 | + ) |
|
| 100 | + ); |
|
| 101 | + } |
|
| 102 | 102 | } |
| 103 | 103 | |
| 104 | 104 | // End of file Read.php |