| @@ -1,14 +1,11 @@ | ||
| 1 | 1 | <?php |
| 2 | -/** | |
| 3 | - * @package Polylang | |
| 4 | - */ | |
| 5 | 2 | |
| 6 | 3 | /** |
| 7 | - * A language object is made of two terms in 'language' and 'term_language' taxonomies | |
| 4 | + * a language object is made of two terms in 'language' and 'term_language' taxonomies | |
| 8 | 5 | * manipulating only one object per language instead of two terms should make things easier |
| 9 | 6 | * |
| 10 | - * Properties: | |
| 7 | + * properties: | |
| 11 | 8 | * term_id => id of term in 'language' taxonomy |
| 12 | 9 | * name => language name. Ex: English |
| 13 | 10 | * slug => language code used in url. Ex: en |
| 14 | 11 | * term_group => order of the language when displayed in a list of languages |
| @@ -21,9 +18,8 @@ | ||
| 21 | 18 | * tl_term_taxonomy_id => term taxonomy id in 'term_language' taxonomy |
| 22 | 19 | * tl_count => number of terms in that language ( not used by Polylang ) |
| 23 | 20 | * locale => WordPress language locale. Ex: en_US |
| 24 | 21 | * is_rtl => 1 if the language is rtl |
| 25 | - * w3c => W3C locale | |
| 26 | 22 | * flag_code => code of the flag |
| 27 | 23 | * flag_url => url of the flag |
| 28 | 24 | * flag => html img of the flag |
| 29 | 25 | * custom_flag_url => url of the custom flag if exists, internal use only, moves to flag_url on frontend |
| @@ -40,9 +36,8 @@ | ||
| 40 | 36 | class PLL_Language { |
| 41 | 37 | public $term_id, $name, $slug, $term_group, $term_taxonomy_id, $taxonomy, $description, $parent, $count; |
| 42 | 38 | public $tl_term_id, $tl_term_taxonomy_id, $tl_count; |
| 43 | 39 | public $locale, $is_rtl; |
| 44 | - public $w3c, $facebook; | |
| 45 | 40 | public $flag_url, $flag; |
| 46 | 41 | public $home_url, $search_url; |
| 47 | 42 | public $host, $mo_id; |
| 48 | 43 | public $page_on_front, $page_for_posts; |
| @@ -47,17 +42,17 @@ | ||
| 47 | 42 | public $host, $mo_id; |
| 48 | 43 | public $page_on_front, $page_for_posts; |
| 49 | 44 | |
| 50 | 45 | /** |
| 51 | - * Constructor: builds a language object given its two corresponding terms in language and term_language taxonomies | |
| 46 | + * constructor: builds a language object given its two corresponding terms in language and term_language taxonomies | |
| 52 | 47 | * |
| 53 | 48 | * @since 1.2 |
| 54 | 49 | * |
| 55 | - * @param object|array $language 'language' term or language object properties stored as an array | |
| 56 | - * @param object $term_language Corresponding 'term_language' term | |
| 50 | + * @param object|array $language 'language' term or language object properties stored as an array | |
| 51 | + * @param object $term_language corresponding 'term_language' term | |
| 57 | 52 | */ |
| 58 | 53 | public function __construct( $language, $term_language = null ) { |
| 59 | - // Build the object from all properties stored as an array | |
| 54 | + // build the object from all properties stored as an array | |
| 60 | 55 | if ( empty( $term_language ) ) { |
| 61 | 56 | foreach ( $language as $prop => $value ) { |
| 62 | 57 | $this->$prop = $value; |
| 63 | 58 | } |
| @@ -62,134 +57,61 @@ | ||
| 62 | 57 | $this->$prop = $value; |
| 63 | 58 | } |
| 64 | 59 | } |
| 65 | 60 | |
| 66 | - // Build the object from taxonomies | |
| 61 | + // build the object from taxonomies | |
| 67 | 62 | else { |
| 68 | 63 | foreach ( $language as $prop => $value ) { |
| 69 | 64 | $this->$prop = in_array( $prop, array( 'term_id', 'term_taxonomy_id', 'count' ) ) ? (int) $language->$prop : $language->$prop; |
| 70 | 65 | } |
| 71 | 66 | |
| 67 | + // although it would be convenient here, don't assume the term is shared between taxonomies as it may not be the case in future | |
| 68 | + // http://make.wordpress.org/core/2013/07/28/potential-roadmap-for-taxonomy-meta-and-post-relationships/ | |
| 72 | 69 | $this->tl_term_id = (int) $term_language->term_id; |
| 73 | 70 | $this->tl_term_taxonomy_id = (int) $term_language->term_taxonomy_id; |
| 74 | 71 | $this->tl_count = (int) $term_language->count; |
| 75 | 72 | |
| 76 | - // The description field can contain any property | |
| 77 | - // Backward compatibility for is_rtl | |
| 73 | + // the description field can contain any property | |
| 74 | + // backward compatibility for is_rtl | |
| 78 | 75 | $description = maybe_unserialize( $language->description ); |
| 79 | 76 | foreach ( $description as $prop => $value ) { |
| 80 | 77 | 'rtl' == $prop ? $this->is_rtl = $value : $this->$prop = $value; |
| 81 | 78 | } |
| 82 | 79 | |
| 83 | - $this->description = &$this->locale; // Backward compatibility with Polylang < 1.2 | |
| 80 | + $this->description = &$this->locale; // backward compatibility with Polylang < 1.2 | |
| 84 | 81 | |
| 85 | 82 | $this->mo_id = PLL_MO::get_id( $this ); |
| 86 | - | |
| 87 | - $languages = include POLYLANG_DIR . '/settings/languages.php'; | |
| 88 | - $this->w3c = isset( $languages[ $this->locale ]['w3c'] ) ? $languages[ $this->locale ]['w3c'] : str_replace( '_', '-', $this->locale ); | |
| 89 | - if ( isset( $languages[ $this->locale ]['facebook'] ) ) { | |
| 90 | - $this->facebook = $languages[ $this->locale ]['facebook']; | |
| 91 | - } | |
| 83 | + $this->set_flag(); | |
| 92 | 84 | } |
| 93 | 85 | } |
| 94 | 86 | |
| 95 | 87 | /** |
| 96 | - * Get the flag informations | |
| 97 | - * 'url' => Flag url | |
| 98 | - * 'src' => Optional, src attribute value if different of the url, for example if base64 encoded | |
| 99 | - * 'width' => Optional, flag width in pixels | |
| 100 | - * 'height' => Optional, flag height in pixels | |
| 88 | + * sets flag_url and flag properties | |
| 101 | 89 | * |
| 102 | - * @since 2.6 | |
| 103 | - * | |
| 104 | - * @param string $code Flag code. | |
| 105 | - * @return array Flag informations. | |
| 90 | + * @since 1.2 | |
| 106 | 91 | */ |
| 107 | - public static function get_flag_informations( $code ) { | |
| 108 | - $flag = array( 'url' => '' ); | |
| 92 | + public function set_flag() { | |
| 93 | + $flags['flag']['url'] = ''; | |
| 109 | 94 | |
| 110 | 95 | // Polylang builtin flags |
| 111 | - if ( ! empty( $code ) && file_exists( POLYLANG_DIR . ( $file = '/flags/' . $code . '.png' ) ) ) { | |
| 112 | - $flag['url'] = $_url = plugins_url( $file, POLYLANG_FILE ); | |
| 113 | - } | |
| 96 | + if ( ! empty( $this->flag_code ) && file_exists( POLYLANG_DIR . ( $file = '/flags/' . $this->flag_code . '.png' ) ) ) { | |
| 97 | + $flags['flag']['url'] = esc_url_raw( POLYLANG_URL . $file ); | |
| 114 | 98 | |
| 115 | - /** | |
| 116 | - * Filter flag informations | |
| 117 | - * 'url' => Flag url | |
| 118 | - * 'src' => Optional, src attribute value if different of the url, for example if base64 encoded | |
| 119 | - * 'width' => Optional, flag width in pixels | |
| 120 | - * 'height' => Optional, flag height in pixels | |
| 121 | - * | |
| 122 | - * @since 2.4 | |
| 123 | - * | |
| 124 | - * @param array $flag Information about the flag | |
| 125 | - * @param string $code Flag code | |
| 126 | - */ | |
| 127 | - $flag = apply_filters( 'pll_flag', $flag, $code ); | |
| 128 | - | |
| 129 | - if ( empty( $flag['src'] ) ) { | |
| 130 | - // If using predefined flags and base64 encoded flags are preferred | |
| 131 | - if ( isset( $_url ) && $flag['url'] === $_url && ( ! defined( 'PLL_ENCODED_FLAGS' ) || PLL_ENCODED_FLAGS ) ) { | |
| 132 | - list( $flag['width'], $flag['height'] ) = getimagesize( POLYLANG_DIR . $file ); | |
| 133 | - $file_contents = file_get_contents( POLYLANG_DIR . $file ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents | |
| 134 | - $flag['src'] = 'data:image/png;base64,' . base64_encode( $file_contents ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode | |
| 99 | + // if base64 encoded flags are preferred | |
| 100 | + if ( ! defined( 'PLL_ENCODED_FLAGS' ) || PLL_ENCODED_FLAGS ) { | |
| 101 | + $flags['flag']['src'] = 'data:image/png;base64,' . base64_encode( file_get_contents( POLYLANG_DIR . $file ) ); | |
| 135 | 102 | } else { |
| 136 | - $flag['src'] = esc_url( set_url_scheme( $flag['url'], 'relative' ) ); | |
| 103 | + $flags['flag']['src'] = esc_url( POLYLANG_URL . $file ); | |
| 137 | 104 | } |
| 138 | 105 | } |
| 139 | 106 | |
| 140 | - $flag['url'] = esc_url_raw( $flag['url'] ); | |
| 141 | - | |
| 142 | - return $flag; | |
| 143 | - } | |
| 144 | - | |
| 145 | - /** | |
| 146 | - * Sets flag_url and flag properties | |
| 147 | - * | |
| 148 | - * @since 1.2 | |
| 149 | - */ | |
| 150 | - public function set_flag() { | |
| 151 | - $flags = array( 'flag' => self::get_flag_informations( $this->flag_code ) ); | |
| 152 | - | |
| 153 | - // Custom flags ? | |
| 154 | - $directories = array( | |
| 155 | - PLL_LOCAL_DIR, | |
| 156 | - get_stylesheet_directory() . '/polylang', | |
| 157 | - get_template_directory() . '/polylang', | |
| 158 | - ); | |
| 159 | - | |
| 160 | - foreach ( $directories as $dir ) { | |
| 161 | - if ( file_exists( $file = "{$dir}/{$this->locale}.png" ) || file_exists( $file = "{$dir}/{$this->locale}.jpg" ) || file_exists( $file = "{$dir}/{$this->locale}.svg" ) ) { | |
| 162 | - $flags['custom_flag']['url'] = content_url( '/' . str_replace( WP_CONTENT_DIR, '', $file ) ); | |
| 163 | - break; | |
| 164 | - } | |
| 107 | + // custom flags ? | |
| 108 | + if ( file_exists( PLL_LOCAL_DIR . ( $file = '/' . $this->locale . '.png' ) ) || file_exists( PLL_LOCAL_DIR . ( $file = '/' . $this->locale . '.jpg' ) ) ) { | |
| 109 | + $flags['custom_flag']['url'] = esc_url_raw( PLL_LOCAL_URL . $file ); | |
| 110 | + $flags['custom_flag']['src'] = esc_url( PLL_LOCAL_URL . $file ); | |
| 165 | 111 | } |
| 166 | 112 | |
| 167 | 113 | /** |
| 168 | - * Filter the custom flag informations | |
| 169 | - * 'url' => Flag url | |
| 170 | - * 'src' => Optional, src attribute value if different of the url, for example if base64 encoded | |
| 171 | - * 'width' => Optional, flag width in pixels | |
| 172 | - * 'height' => Optional, flag height in pixels | |
| 173 | - * | |
| 174 | - * @since 2.4 | |
| 175 | - * | |
| 176 | - * @param array $flag Information about the custom flag | |
| 177 | - * @param string $code Flag code | |
| 178 | - */ | |
| 179 | - $flags['custom_flag'] = apply_filters( 'pll_custom_flag', empty( $flags['custom_flag'] ) ? null : $flags['custom_flag'], $this->flag_code ); | |
| 180 | - | |
| 181 | - if ( ! empty( $flags['custom_flag']['url'] ) ) { | |
| 182 | - if ( empty( $flags['custom_flag']['src'] ) ) { | |
| 183 | - $flags['custom_flag']['src'] = esc_url( set_url_scheme( $flags['custom_flag']['url'], 'relative' ) ); | |
| 184 | - } | |
| 185 | - | |
| 186 | - $flags['custom_flag']['url'] = esc_url_raw( $flags['custom_flag']['url'] ); | |
| 187 | - } else { | |
| 188 | - unset( $flags['custom_flag'] ); | |
| 189 | - } | |
| 190 | - | |
| 191 | - /** | |
| 192 | 114 | * Filter the flag title attribute |
| 193 | 115 | * Defaults to the language name |
| 194 | 116 | * |
| 195 | 117 | * @since 0.7 |
| @@ -210,11 +132,15 @@ | ||
| 210 | 132 | * |
| 211 | 133 | * @param string $flag html markup of the flag or empty string |
| 212 | 134 | * @param string $slug language code |
| 213 | 135 | */ |
| 214 | - $this->{$key} = apply_filters( | |
| 215 | - 'pll_get_flag', | |
| 216 | - self::get_flag_html( $flag, $title, $this->name ), | |
| 136 | + $this->{$key} = apply_filters( 'pll_get_flag', empty( $flag['src'] ) ? '' : | |
| 137 | + sprintf( | |
| 138 | + '<img src="%s" title="%s" alt="%s" />', | |
| 139 | + $flag['src'], | |
| 140 | + esc_attr( $title ), | |
| 141 | + esc_attr( $this->name ) | |
| 142 | + ), | |
| 217 | 143 | $this->slug |
| 218 | 144 | ); |
| 219 | 145 | } |
| 220 | 146 | } |
| @@ -219,71 +145,34 @@ | ||
| 219 | 145 | } |
| 220 | 146 | } |
| 221 | 147 | |
| 222 | 148 | /** |
| 223 | - * Get HTML code for flag | |
| 149 | + * replace flag by custom flag | |
| 150 | + * takes care of url scheme | |
| 224 | 151 | * |
| 225 | - * @since 2.7 | |
| 226 | - * | |
| 227 | - * @param array $flag flag properties: src, width and height | |
| 228 | - * @param string $title optional title attribute | |
| 229 | - * @param string $alt optional alt attribute | |
| 152 | + * @since 1.7 | |
| 230 | 153 | */ |
| 231 | - public static function get_flag_html( $flag, $title = '', $alt = '' ) { | |
| 232 | - if ( empty( $flag['src'] ) ) { | |
| 233 | - return ''; | |
| 154 | + public function set_custom_flag() { | |
| 155 | + // overwrite with custom flags on frontend only | |
| 156 | + if ( ! empty( $this->custom_flag ) ) { | |
| 157 | + $this->flag = $this->custom_flag; | |
| 158 | + $this->flag_url = $this->custom_flag_url; | |
| 159 | + unset( $this->custom_flag, $this->custom_flag_url ); // hide this | |
| 234 | 160 | } |
| 235 | 161 | |
| 236 | - $title_attr = empty( $title ) ? '' : sprintf( ' title="%s"', esc_attr( $title ) ); | |
| 237 | - $alt_attr = empty( $alt ) ? '' : sprintf( ' alt="%s"', esc_attr( $alt ) ); | |
| 238 | - $width_attr = empty( $flag['width'] ) ? '' : sprintf( ' width="%s"', (int) $flag['width'] ); | |
| 239 | - $height_attr = empty( $flag['height'] ) ? '' : sprintf( ' height="%s"', (int) $flag['height'] ); | |
| 240 | - | |
| 241 | - $style = ''; | |
| 242 | - $sizes = array_intersect_key( $flag, array_flip( array( 'width', 'height' ) ) ); | |
| 243 | - | |
| 244 | - if ( ! empty( $sizes ) ) { | |
| 245 | - array_walk( | |
| 246 | - $sizes, | |
| 247 | - function ( &$value, $key ) { | |
| 248 | - $value = sprintf( '%s: %dpx;', esc_attr( $key ), (int) $value ); | |
| 249 | - } | |
| 250 | - ); | |
| 251 | - $style = sprintf( ' style="%s"', implode( ' ', $sizes ) ); | |
| 162 | + // set url scheme, also for default flags | |
| 163 | + if ( is_ssl() ) { | |
| 164 | + $this->flag = str_replace( 'http://', 'https://', $this->flag ); | |
| 165 | + $this->flag_url = str_replace( 'http://', 'https://', $this->flag_url ); | |
| 166 | + } else { | |
| 167 | + $this->flag = str_replace( 'https://', 'http://', $this->flag ); | |
| 168 | + $this->flag_url = str_replace( 'https://', 'http://', $this->flag_url ); | |
| 252 | 169 | } |
| 253 | - | |
| 254 | - return sprintf( | |
| 255 | - '<img src="%s"%s%s%s%s%s />', | |
| 256 | - $flag['src'], | |
| 257 | - $title_attr, | |
| 258 | - $alt_attr, | |
| 259 | - $width_attr, | |
| 260 | - $height_attr, | |
| 261 | - $style | |
| 262 | - ); | |
| 263 | 170 | } |
| 264 | 171 | |
| 265 | 172 | /** |
| 266 | - * Returns the html of the custom flag if any, or the default flag otherwise. | |
| 173 | + * updates post and term count | |
| 267 | 174 | * |
| 268 | - * @since 2.8 | |
| 269 | - */ | |
| 270 | - public function get_display_flag() { | |
| 271 | - return empty( $this->custom_flag ) ? $this->flag : $this->custom_flag; | |
| 272 | - } | |
| 273 | - | |
| 274 | - /** | |
| 275 | - * Returns the url of the custom flag if any, or the default flag otherwise. | |
| 276 | - * | |
| 277 | - * @since 2.8 | |
| 278 | - */ | |
| 279 | - public function get_display_flag_url() { | |
| 280 | - return empty( $this->custom_flag_url ) ? $this->flag_url : $this->custom_flag_url; | |
| 281 | - } | |
| 282 | - | |
| 283 | - /** | |
| 284 | - * Updates post and term count | |
| 285 | - * | |
| 286 | 175 | * @since 1.2 |
| 287 | 176 | */ |
| 288 | 177 | public function update_count() { |
| 289 | 178 | wp_update_term_count( $this->term_taxonomy_id, 'language' ); // posts count |
| @@ -290,9 +179,9 @@ | ||
| 290 | 179 | wp_update_term_count( $this->tl_term_taxonomy_id, 'term_language' ); // terms count |
| 291 | 180 | } |
| 292 | 181 | |
| 293 | 182 | /** |
| 294 | - * Set home_url and search_url properties | |
| 183 | + * set home_url and search_url properties | |
| 295 | 184 | * |
| 296 | 185 | * @since 1.3 |
| 297 | 186 | * |
| 298 | 187 | * @param string $search_url |
| @@ -303,28 +192,29 @@ | ||
| 303 | 192 | $this->home_url = $home_url; |
| 304 | 193 | } |
| 305 | 194 | |
| 306 | 195 | /** |
| 307 | - * Sets the scheme of the home url and the flag urls | |
| 196 | + * set home_url scheme | |
| 197 | + * this can't be cached accross pages | |
| 308 | 198 | * |
| 309 | - * This can't be cached across pages. | |
| 310 | - * | |
| 311 | - * @since 2.8 | |
| 199 | + * @since 1.6.4 | |
| 312 | 200 | */ |
| 313 | - public function set_url_scheme() { | |
| 314 | - $this->home_url = set_url_scheme( $this->home_url ); | |
| 315 | - $this->search_url = set_url_scheme( $this->search_url ); | |
| 201 | + public function set_home_url_scheme() { | |
| 202 | + if ( is_ssl() ) { | |
| 203 | + $this->home_url = str_replace( 'http://', 'https://', $this->home_url ); | |
| 204 | + $this->search_url = str_replace( 'http://', 'https://', $this->search_url ); | |
| 205 | + } | |
| 316 | 206 | |
| 317 | - // Set url scheme, also for the flags. | |
| 318 | - $this->flag_url = set_url_scheme( $this->flag_url ); | |
| 319 | - if ( ! empty( $this->custom_flag_url ) ) { | |
| 320 | - $this->custom_flag_url = set_url_scheme( $this->custom_flag_url ); | |
| 207 | + else { | |
| 208 | + $this->home_url = str_replace( 'https://', 'http://', $this->home_url ); | |
| 209 | + $this->search_url = str_replace( 'https://', 'http://', $this->search_url ); | |
| 321 | 210 | } |
| 322 | 211 | } |
| 323 | 212 | |
| 324 | 213 | /** |
| 325 | - * Returns the language locale | |
| 326 | - * Converts WP locales to W3C valid locales for display | |
| 214 | + * returns the language locale | |
| 215 | + * converts WP locales to W3C valid locales for display | |
| 216 | + * @see #33511 | |
| 327 | 217 | * |
| 328 | 218 | * @since 1.8 |
| 329 | 219 | * |
| 330 | 220 | * @param string $filter either 'display' or 'raw', defaults to raw |
| @@ -330,7 +220,26 @@ | ||
| 330 | 220 | * @param string $filter either 'display' or 'raw', defaults to raw |
| 331 | 221 | * @return string |
| 332 | 222 | */ |
| 333 | 223 | public function get_locale( $filter = 'raw' ) { |
| 334 | - return 'display' === $filter ? $this->w3c : $this->locale; | |
| 224 | + if ( 'display' == $filter ) { | |
| 225 | + static $valid_locales = array( | |
| 226 | + 'bel' => 'be', | |
| 227 | + 'bre' => 'br', | |
| 228 | + 'de_CH_informal' => 'de_CH', | |
| 229 | + 'de_DE_formal' => 'de_DE', | |
| 230 | + 'dzo' => 'dz', | |
| 231 | + 'ido' => 'io', | |
| 232 | + 'kin' => 'rw', | |
| 233 | + 'oci' => 'oc', | |
| 234 | + 'mri' => 'mi', | |
| 235 | + 'nl_NL_formal' => 'nl_NL', | |
| 236 | + 'roh' => 'rm', | |
| 237 | + 'srd' => 'sc', | |
| 238 | + 'tuk' => 'tk', | |
| 239 | + ); | |
| 240 | + $locale = isset( $valid_locales[ $this->locale ] ) ? $valid_locales[ $this->locale ] : $this->locale; | |
| 241 | + return str_replace( '_', '-', $locale ); | |
| 242 | + } | |
| 243 | + return $this->locale; | |
| 335 | 244 | } |
| 336 | 245 | } |
