| @@ -1,189 +1,191 @@ | ||
| 1 | 1 | <?php |
| 2 | -/** | |
| 3 | - * @package Polylang | |
| 4 | - */ | |
| 5 | 2 | |
| 6 | -/** | |
| 7 | - * Base class for both admin and frontend | |
| 8 | - * | |
| 9 | - * @since 1.2 | |
| 10 | - */ | |
| 11 | -abstract class PLL_Base { | |
| 12 | - /** | |
| 13 | - * Stores the plugin options. | |
| 14 | - * | |
| 15 | - * @var array | |
| 16 | - */ | |
| 17 | - public $options; | |
| 3 | +// setups basic functions used for admin and frontend | |
| 4 | +abstract class Polylang_Base { | |
| 5 | + var $strings; // strings to translate | |
| 6 | + | |
| 7 | + // returns the query variables of the referer | |
| 8 | + function get_referer_vars() { | |
| 9 | + $qvars = array(); | |
| 10 | + $referer = wp_get_referer(); | |
| 11 | + if ($referer) { | |
| 12 | + $urlparts = parse_url($referer); | |
| 13 | + if (isset($urlparts['query'])) { | |
| 14 | + parse_str($urlparts['query'], $qvars); | |
| 15 | + } | |
| 16 | + } | |
| 17 | + return $qvars; | |
| 18 | + } | |
| 18 | 19 | |
| 19 | - /** | |
| 20 | - * Instance of PLL_Model. | |
| 21 | - * | |
| 22 | - * @var PLL_Model | |
| 23 | - */ | |
| 24 | - public $model; | |
| 20 | + // returns the list of available languages | |
| 21 | + function get_languages_list($hide_empty = false) { | |
| 22 | + return get_terms('language', array('hide_empty'=>$hide_empty, 'orderby'=>'term_group' )); | |
| 23 | + } | |
| 25 | 24 | |
| 26 | - /** | |
| 27 | - * Instance of a child class of PLL_Links_Model. | |
| 28 | - * | |
| 29 | - * @var PLL_Links_Model | |
| 30 | - */ | |
| 31 | - public $links_model; | |
| 25 | + // retrieves the dropdown list of the languages | |
| 26 | + function dropdown_languages($args) { | |
| 27 | + $defaults = array('name' => 'lang_choice', 'class' => '', 'show_option_none' => false, 'show_option_all' => false, | |
| 28 | + 'hide_empty' => false, 'value' => 'slug', 'selected' => ''); | |
| 29 | + extract(wp_parse_args($args, $defaults)); | |
| 32 | 30 | |
| 33 | - /** | |
| 34 | - * Registers hooks on insert / update post related actions and filters. | |
| 35 | - * | |
| 36 | - * @var PLL_CRUD_Posts | |
| 37 | - */ | |
| 38 | - public $posts; | |
| 31 | + $out = sprintf('<select name="%1$s" id="%1$s"%2$s>'."\n", esc_attr($name), $class ? ' class="'.esc_attr($class).'"' : ''); | |
| 32 | + $out .= $show_option_none ? "<option value='0'></option>\n" : ''; | |
| 33 | + $out .= $show_option_all ? "<option value='0'>".__('All languages', 'polylang')."</option>\n" : ''; | |
| 34 | + foreach ($this->get_languages_list($hide_empty) as $language) { | |
| 35 | + $out .= sprintf("<option value='%s'%s>%s</option>\n", | |
| 36 | + esc_attr($language->$value), | |
| 37 | + $language->$value == $selected ? ' selected="selected"' : '', | |
| 38 | + esc_html($language->name) | |
| 39 | + ); | |
| 40 | + } | |
| 41 | + $out .= "</select>\n"; | |
| 42 | + return $out; | |
| 43 | + } | |
| 39 | 44 | |
| 40 | - /** | |
| 41 | - * Registers hooks on insert / update term related action and filters. | |
| 42 | - * | |
| 43 | - * @var PLL_CRUD_Terms | |
| 44 | - */ | |
| 45 | - public $terms; | |
| 45 | + // returns the language by its id or its slug | |
| 46 | + // Note: it seems that a numeric value is better for performance (3.2.1) | |
| 47 | + function get_language($value) { | |
| 48 | + if (is_object($value)) | |
| 49 | + return $value; | |
| 50 | + if (is_numeric($value) || (int) $value) | |
| 51 | + return get_term((int) $value, 'language'); | |
| 52 | + elseif (is_string($value)) | |
| 53 | + return get_term_by('slug', $value , 'language'); // seems it is not cached in 3.2.1 | |
| 54 | + return null; | |
| 55 | + } | |
| 46 | 56 | |
| 47 | - /** | |
| 48 | - * Constructor | |
| 49 | - * | |
| 50 | - * @since 1.2 | |
| 51 | - * | |
| 52 | - * @param object $links_model | |
| 53 | - */ | |
| 54 | - public function __construct( &$links_model ) { | |
| 55 | - $this->links_model = &$links_model; | |
| 56 | - $this->model = &$links_model->model; | |
| 57 | - $this->options = &$this->model->options; | |
| 57 | + // saves translations for posts or terms | |
| 58 | + // the underscore in '_lang' hides the post meta in the Custom Fields metabox in the Edit Post screen | |
| 59 | + // $type: either 'post' or 'term' | |
| 60 | + // $id: post id or term id | |
| 61 | + // $translations: an associative array of translations with language code as key and translation id as value | |
| 62 | + function save_translations($type, $id, $translations) { | |
| 63 | + $lang = call_user_func(array(&$this, 'get_'.$type.'_language'), $id); | |
| 64 | + if (!$lang) | |
| 65 | + return; | |
| 58 | 66 | |
| 59 | - $GLOBALS['l10n_unloaded']['pll_string'] = true; // Short-circuit _load_textdomain_just_in_time() for 'pll_string' domain in WP 4.6+ | |
| 67 | + if (isset($translations) && is_array($translations)) { | |
| 68 | + $tr = serialize(array_merge(array($lang->slug => $id), $translations)); | |
| 69 | + update_metadata($type, $id, '_translations', $tr); | |
| 60 | 70 | |
| 61 | - add_action( 'widgets_init', array( $this, 'widgets_init' ) ); | |
| 71 | + foreach($translations as $key=>$p) | |
| 72 | + update_metadata($type, (int) $p, '_translations', $tr); | |
| 73 | + } | |
| 74 | + } | |
| 62 | 75 | |
| 63 | - // User defined strings translations | |
| 64 | - add_action( 'pll_language_defined', array( $this, 'load_strings_translations' ), 5 ); | |
| 65 | - add_action( 'change_locale', array( $this, 'load_strings_translations' ) ); // Since WP 4.7 | |
| 76 | + // deletes a translation of a post or term | |
| 77 | + function delete_translation($type, $id) { | |
| 78 | + $translations = unserialize(get_metadata($type, $id, '_translations', true)); | |
| 79 | + if (is_array($translations)) { | |
| 80 | + $slug = array_search($id, $translations); | |
| 81 | + unset($translations[$slug]); | |
| 82 | + $tr = serialize($translations); | |
| 83 | + foreach($translations as $key=>$p) | |
| 84 | + update_metadata($type, (int) $p, '_translations', $tr); | |
| 85 | + delete_metadata($type, $id, '_translations'); | |
| 86 | + } | |
| 87 | + } | |
| 66 | 88 | |
| 67 | - // Switch_to_blog | |
| 68 | - add_action( 'switch_blog', array( $this, 'switch_blog' ), 10, 2 ); | |
| 89 | + // returns the id of the translation of a post or term | |
| 90 | + // $type: either 'post' or 'term' | |
| 91 | + // $id: post id or term id | |
| 92 | + // $lang: object or slug (in the order of preference latest to avoid) | |
| 93 | + function get_translation($type, $id, $lang) { | |
| 94 | + $translations = unserialize(get_metadata($type, $id, '_translations', true)); | |
| 95 | + $slug = $this->get_language($lang)->slug; | |
| 96 | + return isset($translations[$slug]) ? (int) $translations[$slug] : ''; | |
| 69 | 97 | } |
| 70 | 98 | |
| 71 | - /** | |
| 72 | - * Instantiates classes reacting to CRUD operations on posts and terms, | |
| 73 | - * only when at least one language is defined. | |
| 74 | - * | |
| 75 | - * @since 2.6 | |
| 76 | - */ | |
| 77 | - public function init() { | |
| 78 | - if ( $this->model->get_languages_list() ) { | |
| 79 | - $this->posts = new PLL_CRUD_Posts( $this ); | |
| 80 | - $this->terms = new PLL_CRUD_Terms( $this ); | |
| 81 | - } | |
| 99 | + // store the post language in the database | |
| 100 | + function set_post_language($post_id, $lang) { | |
| 101 | + wp_set_post_terms($post_id, $this->get_language($lang)->slug, 'language' ); | |
| 82 | 102 | } |
| 83 | 103 | |
| 84 | - /** | |
| 85 | - * Registers our widgets | |
| 86 | - * | |
| 87 | - * @since 0.1 | |
| 88 | - */ | |
| 89 | - public function widgets_init() { | |
| 90 | - register_widget( 'PLL_Widget_Languages' ); | |
| 104 | + // returns the language of a post | |
| 105 | + function get_post_language($post_id) { | |
| 106 | + $lang = get_the_terms($post_id, 'language' ); | |
| 107 | + return ($lang) ? reset($lang) : null; // there's only one language per post : first element of the array returned | |
| 108 | + } | |
| 91 | 109 | |
| 92 | - // Overwrites the calendar widget to filter posts by language | |
| 93 | - if ( ! defined( 'PLL_WIDGET_CALENDAR' ) || PLL_WIDGET_CALENDAR ) { | |
| 94 | - unregister_widget( 'WP_Widget_Calendar' ); | |
| 95 | - register_widget( 'PLL_Widget_Calendar' ); | |
| 96 | - } | |
| 110 | + // among the post and its translations, returns the id of the post which is in $lang | |
| 111 | + function get_post($post_id, $lang) { | |
| 112 | + $lang = $this->get_language($lang); | |
| 113 | + return $this->get_post_language($post_id)->term_id == $lang->term_id ? $post_id : $this->get_translation('post', $post_id, $lang); | |
| 97 | 114 | } |
| 98 | 115 | |
| 99 | - /** | |
| 100 | - * Loads user defined strings translations | |
| 101 | - * | |
| 102 | - * @since 1.2 | |
| 103 | - * @since 2.1.3 $locale parameter added. | |
| 104 | - * | |
| 105 | - * @param string $locale Locale. Defaults to current locale. | |
| 106 | - */ | |
| 107 | - public function load_strings_translations( $locale = '' ) { | |
| 108 | - if ( empty( $locale ) ) { | |
| 109 | - $locale = get_locale(); | |
| 110 | - } | |
| 116 | + // store the term language in the database | |
| 117 | + function set_term_language($term_id, $lang) { | |
| 118 | + update_metadata('term', $term_id, '_language', $this->get_language($lang)->term_id); | |
| 119 | + } | |
| 111 | 120 | |
| 112 | - $language = $this->model->get_language( $locale ); | |
| 121 | + // remove the term language in the database | |
| 122 | + function delete_term_language($term_id) { | |
| 123 | + delete_metadata('term', $term_id, '_language'); | |
| 124 | + } | |
| 113 | 125 | |
| 114 | - if ( ! empty( $language ) ) { | |
| 115 | - $mo = new PLL_MO(); | |
| 116 | - $mo->import_from_db( $language ); | |
| 117 | - $GLOBALS['l10n']['pll_string'] = &$mo; | |
| 118 | - } else { | |
| 119 | - unset( $GLOBALS['l10n']['pll_string'] ); | |
| 120 | - } | |
| 126 | + // returns the language of a term | |
| 127 | + function get_term_language($value, $taxonomy = '') { | |
| 128 | + if (is_numeric($value)) | |
| 129 | + $term_id = $value; | |
| 130 | + elseif (is_string($value) && $taxonomy) | |
| 131 | + $term_id = get_term_by('slug', $value , $taxonomy)->term_id; | |
| 132 | + return $term_id ? $this->get_language(get_metadata('term', $term_id, '_language', true)) : null; | |
| 121 | 133 | } |
| 122 | 134 | |
| 123 | - /** | |
| 124 | - * Resets some variables when switching blog | |
| 125 | - * Applies only if Polylang is active on the new blog | |
| 126 | - * | |
| 127 | - * @since 1.5.1 | |
| 128 | - * | |
| 129 | - * @param int $new_blog | |
| 130 | - * @param int $old_blog | |
| 131 | - * @return bool not used by WP but by child class | |
| 132 | - */ | |
| 133 | - public function switch_blog( $new_blog, $old_blog ) { | |
| 134 | - $plugins = ( $sitewide_plugins = get_site_option( 'active_sitewide_plugins' ) ) && is_array( $sitewide_plugins ) ? array_keys( $sitewide_plugins ) : array(); | |
| 135 | - $plugins = array_merge( $plugins, get_option( 'active_plugins', array() ) ); | |
| 135 | + // among the term and its translations, returns the id of the term which is in $lang | |
| 136 | + function get_term($term_id, $lang) { | |
| 137 | + $lang = $this->get_language($lang); | |
| 138 | + return $this->get_term_language($term_id)->term_id == $lang->term_id ? $term_id : $this->get_translation('term', $term_id, $lang); | |
| 139 | + } | |
| 136 | 140 | |
| 137 | - // 2nd test needed when Polylang is not networked activated | |
| 138 | - // 3rd test needed when Polylang is networked activated and a new site is created | |
| 139 | - if ( $new_blog != $old_blog && in_array( POLYLANG_BASENAME, $plugins ) && get_option( 'polylang' ) ) { | |
| 140 | - $this->options = get_option( 'polylang' ); // Needed for menus | |
| 141 | - remove_action( 'pre_option_rewrite_rules', array( $this->links_model, 'prepare_rewrite_rules' ) ); | |
| 142 | - $this->links_model = $this->model->get_links_model(); | |
| 143 | - return true; | |
| 144 | - } | |
| 145 | - return false; | |
| 141 | + // returns the html link to the flag if exists | |
| 142 | + // $lang: object | |
| 143 | + function get_flag($lang) { | |
| 144 | + if (file_exists(POLYLANG_DIR.($file = '/flags/'.$lang->description.'.png'))) | |
| 145 | + $url = POLYLANG_URL.$file; | |
| 146 | + | |
| 147 | + // overwrite with custom flags | |
| 148 | + if (!is_admin() && ( // never use custom flags on admin side | |
| 149 | + file_exists(PLL_LOCAL_DIR.($file = '/'.$lang->description.'.png')) || | |
| 150 | + file_exists(PLL_LOCAL_DIR.($file = '/'.$lang->description.'.jpg')) )) | |
| 151 | + $url = PLL_LOCAL_URL.$file; | |
| 152 | + | |
| 153 | + $title = apply_filters('pll_flag_title', $lang->name, $lang->slug, $lang->description); | |
| 154 | + return isset($url) ? '<img src="'.esc_url($url).'" title="'.esc_attr($title).'" alt="'.esc_attr($lang->name).'" />' : ''; | |
| 146 | 155 | } |
| 147 | 156 | |
| 148 | - /** | |
| 149 | - * Some backward compatibility with Polylang < 1.2 | |
| 150 | - * Allows for example to call $polylang->get_languages_list() instead of $polylang->model->get_languages_list() | |
| 151 | - * This works but should be slower than the direct call, thus an error is triggered in debug mode | |
| 152 | - * | |
| 153 | - * @since 1.2 | |
| 154 | - * | |
| 155 | - * @param string $func function name | |
| 156 | - * @param array $args function arguments | |
| 157 | - */ | |
| 158 | - public function __call( $func, $args ) { | |
| 159 | - foreach ( $this as $prop => &$obj ) { | |
| 160 | - if ( is_object( $obj ) && method_exists( $obj, $func ) ) { | |
| 161 | - if ( WP_DEBUG ) { | |
| 162 | - $debug = debug_backtrace( DEBUG_BACKTRACE_IGNORE_ARGS ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions | |
| 163 | - $i = 1 + empty( $debug[1]['line'] ); // The file and line are in $debug[2] if the function was called using call_user_func | |
| 164 | - trigger_error( // phpcs:ignore WordPress.PHP.DevelopmentFunctions | |
| 165 | - sprintf( | |
| 166 | - '%1$s was called incorrectly in %3$s on line %4$s: the call to $polylang->%1$s() has been deprecated in Polylang 1.2, use PLL()->%2$s->%1$s() instead.' . "\nError handler", | |
| 167 | - esc_html( $func ), | |
| 168 | - esc_html( $prop ), | |
| 169 | - esc_html( $debug[ $i ]['file'] ), | |
| 170 | - absint( $debug[ $i ]['line'] ) | |
| 171 | - ) | |
| 172 | - ); | |
| 173 | - } | |
| 174 | - return call_user_func_array( array( $obj, $func ), $args ); | |
| 175 | - } | |
| 157 | + // adds terms clauses to get_terms - used in both frontend and admin | |
| 158 | + function _terms_clauses($clauses, $lang, $display_all = false) { | |
| 159 | + global $wpdb; | |
| 160 | + if (isset($lang) && !is_wp_error($lang)) { | |
| 161 | + $clauses['join'] .= $wpdb->prepare(" LEFT JOIN $wpdb->termmeta AS pll_tm ON t.term_id = pll_tm.term_id"); | |
| 162 | + $where_lang = $wpdb->prepare("pll_tm.meta_key = '_language' AND pll_tm.meta_value = %d", $lang->term_id); // add terms in the right language | |
| 163 | + $where_all = $wpdb->prepare("t.term_id NOT IN (SELECT term_id FROM $wpdb->termmeta WHERE meta_key IN ('_language'))"); // add terms with no language set | |
| 164 | + $clauses['where'] .= $display_all ? " AND (($where_lang) OR ($where_all))" : " AND $where_lang"; | |
| 176 | 165 | } |
| 166 | + return $clauses; | |
| 167 | + } | |
| 177 | 168 | |
| 178 | - $debug = debug_backtrace( DEBUG_BACKTRACE_IGNORE_ARGS ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions | |
| 179 | - trigger_error( // phpcs:ignore WordPress.PHP.DevelopmentFunctions | |
| 180 | - sprintf( | |
| 181 | - 'Call to undefined function PLL()->%1$s() in %2$s on line %3$s' . "\nError handler", | |
| 182 | - esc_html( $func ), | |
| 183 | - esc_html( $debug[0]['file'] ), | |
| 184 | - absint( $debug[0]['line'] ) | |
| 185 | - ), | |
| 186 | - E_USER_ERROR | |
| 169 | + // returns all page ids *not in* language defined by $lang_id | |
| 170 | + function exclude_pages($lang_id) { | |
| 171 | + $q = array( | |
| 172 | + 'numberposts'=>-1, | |
| 173 | + 'post_type' => 'page', | |
| 174 | + 'fields' => 'ids', | |
| 175 | + 'tax_query' => array(array( | |
| 176 | + 'taxonomy'=>'language', | |
| 177 | + 'fields' => 'id', | |
| 178 | + 'terms'=>$lang_id, | |
| 179 | + 'operator'=>'NOT IN' | |
| 180 | + )) | |
| 187 | 181 | ); |
| 182 | + return get_posts($q); | |
| 188 | 183 | } |
| 189 | -} | |
| 184 | + | |
| 185 | + // register strings for translation | |
| 186 | + function register_string($name, $string) { | |
| 187 | + $this->strings[] = array('name'=> $name, 'string' => $string); | |
| 188 | + } | |
| 189 | + | |
| 190 | +} //class Polylang_Base | |
| 191 | +?> | |
