| @@ -1,93 +1,61 @@ | ||
| 1 | 1 | <?php |
| 2 | -/** | |
| 3 | - * @package Polylang | |
| 4 | - */ | |
| 5 | 2 | |
| 6 | 3 | /** |
| 7 | - * Main Polylang class for admin (except Polylang pages), accessible from @see PLL(). | |
| 4 | + * admin side controller | |
| 5 | + * accessible in $polylang global object | |
| 8 | 6 | * |
| 7 | + * properties: | |
| 8 | + * options => inherited, reference to Polylang options array | |
| 9 | + * model => inherited, reference to PLL_Model object | |
| 10 | + * links_model => inherited, reference to PLL_Links_Model object | |
| 11 | + * links => inherited, reference to PLL_Admin_Links object | |
| 12 | + * static_pages => inherited, reference to PLL_Admin_Static_Pages object | |
| 13 | + * filters_links => inherited, reference to PLL_Filters_Links object | |
| 14 | + * curlang => inherited, optional, current language used to filter the content (language of the post or term being edited, equal to filter_lang otherwise) | |
| 15 | + * filter_lang => inherited, optional, current status of the admin languages filter (in the admin bar) | |
| 16 | + * pref_lang => inherited, preferred language used as default when saving posts or terms | |
| 17 | + * filters => reference to PLL_Filters object | |
| 18 | + * filters_columns => reference to PLL_Admin_Filters_Columns object | |
| 19 | + * filters_post => reference to PLL_Admin_Filters_Post object | |
| 20 | + * filters_term => reference to PLL_Admin_filters_Term object | |
| 21 | + * nav_menu => reference to PLL_Admin_Nav_Menu object | |
| 22 | + * filters_media => optional, reference to PLL_Admin_Filters_Media object | |
| 23 | + * | |
| 9 | 24 | * @since 1.2 |
| 10 | 25 | */ |
| 11 | 26 | class PLL_Admin extends PLL_Admin_Base { |
| 12 | - /** | |
| 13 | - * @var PLL_Admin_Filters | |
| 14 | - */ | |
| 15 | - public $filters; | |
| 27 | + public $filters, $filters_columns, $filters_post, $filters_term, $nav_menu, $sync, $filters_media; | |
| 16 | 28 | |
| 17 | 29 | /** |
| 18 | - * @var PLL_Admin_Filters_Columns | |
| 19 | - */ | |
| 20 | - public $filters_columns; | |
| 21 | - | |
| 22 | - /** | |
| 23 | - * @var PLL_Admin_Filters_Post | |
| 24 | - */ | |
| 25 | - public $filters_post; | |
| 26 | - | |
| 27 | - /** | |
| 28 | - * @var PLL_Admin_Filters_Term | |
| 29 | - */ | |
| 30 | - public $filters_term; | |
| 31 | - | |
| 32 | - /** | |
| 33 | - * @var PLL_Admin_Filters_Media | |
| 34 | - */ | |
| 35 | - public $filters_media; | |
| 36 | - | |
| 37 | - /** | |
| 38 | - * @since 2.9 | |
| 30 | + * loads the polylang text domain | |
| 31 | + * setups filters and action needed on all admin pages and on plugins page | |
| 39 | 32 | * |
| 40 | - * @var PLL_Filters_Sanitization | |
| 41 | - */ | |
| 42 | - public $filters_sanitization; | |
| 43 | - | |
| 44 | - /** | |
| 45 | - * @var PLL_Admin_Block_Editor | |
| 46 | - */ | |
| 47 | - public $block_editor; | |
| 48 | - | |
| 49 | - /** | |
| 50 | - * @var PLL_Admin_Classic_Editor | |
| 51 | - */ | |
| 52 | - public $classic_editor; | |
| 53 | - | |
| 54 | - /** | |
| 55 | - * @var PLL_Admin_Nav_Menu | |
| 56 | - */ | |
| 57 | - public $nav_menu; | |
| 58 | - | |
| 59 | - /** | |
| 60 | - * @var PLL_Admin_Filters_Widgets_Options | |
| 61 | - */ | |
| 62 | - public $filters_widgets; | |
| 63 | - | |
| 64 | - /** | |
| 65 | - * Setups filters and action needed on all admin pages and on plugins page. | |
| 66 | - * | |
| 67 | 33 | * @since 1.2 |
| 68 | 34 | * |
| 69 | - * @param PLL_Links_Model $links_model Reference to the links model. | |
| 35 | + * @param object $links_model | |
| 70 | 36 | */ |
| 71 | 37 | public function __construct( &$links_model ) { |
| 72 | 38 | parent::__construct( $links_model ); |
| 73 | 39 | |
| 74 | - // Adds a 'settings' link in the plugins table | |
| 40 | + // adds a 'settings' link in the plugins table | |
| 75 | 41 | add_filter( 'plugin_action_links_' . POLYLANG_BASENAME, array( $this, 'plugin_action_links' ) ); |
| 76 | 42 | add_action( 'in_plugin_update_message-' . POLYLANG_BASENAME, array( $this, 'plugin_update_message' ), 10, 2 ); |
| 77 | 43 | } |
| 78 | 44 | |
| 79 | 45 | /** |
| 80 | - * Setups filters and action needed on all admin pages and on plugins page | |
| 81 | - * Loads the settings pages or the filters base on the request | |
| 46 | + * setups filters and action needed on all admin pages and on plugins page | |
| 47 | + * loads the settings pages or the filters base on the request | |
| 82 | 48 | * |
| 83 | 49 | * @since 1.2 |
| 50 | + * | |
| 51 | + * @param object $links_model | |
| 84 | 52 | */ |
| 85 | 53 | public function init() { |
| 86 | 54 | parent::init(); |
| 87 | 55 | |
| 88 | - // Setup filters for admin pages | |
| 89 | - // Priority 5 to make sure filters are there before customize_register is fired | |
| 56 | + // setup filters for admin pages | |
| 57 | + // priority 5 to make sure filters are there before customize_register is fired | |
| 90 | 58 | if ( $this->model->get_languages_list() ) { |
| 91 | 59 | add_action( 'wp_loaded', array( $this, 'add_filters' ), 5 ); |
| 92 | 60 | } |
| 93 | 61 | } |
| @@ -92,14 +60,14 @@ | ||
| 92 | 60 | } |
| 93 | 61 | } |
| 94 | 62 | |
| 95 | 63 | /** |
| 96 | - * Adds a 'settings' link for our plugin in the plugins list table. | |
| 64 | + * adds a 'settings' link in the plugins table | |
| 97 | 65 | * |
| 98 | 66 | * @since 0.1 |
| 99 | 67 | * |
| 100 | - * @param string[] $links List of links associated to the plugin. | |
| 101 | - * @return string[] Modified list of links. | |
| 68 | + * @param array $links list of links associated to the plugin | |
| 69 | + * @return array modified list of links | |
| 102 | 70 | */ |
| 103 | 71 | public function plugin_action_links( $links ) { |
| 104 | 72 | array_unshift( $links, '<a href="admin.php?page=mlang">' . __( 'Settings', 'polylang' ) . '</a>' ); |
| 105 | 73 | return $links; |
| @@ -105,17 +73,16 @@ | ||
| 105 | 73 | return $links; |
| 106 | 74 | } |
| 107 | 75 | |
| 108 | 76 | /** |
| 109 | - * Adds the upgrade notice in plugins table | |
| 77 | + * adds the upgrade notice in plugins table | |
| 110 | 78 | * |
| 111 | 79 | * @since 1.1.6 |
| 112 | 80 | * |
| 113 | - * @param array $plugin_data Not used | |
| 114 | - * @param object $r Plugin update data | |
| 115 | - * @return void | |
| 81 | + * @param array $plugin_data not used | |
| 82 | + * @param object $r plugin update data | |
| 116 | 83 | */ |
| 117 | - public function plugin_update_message( $plugin_data, $r ) { | |
| 84 | + function plugin_update_message( $plugin_data, $r ) { | |
| 118 | 85 | if ( isset( $r->upgrade_notice ) ) { |
| 119 | 86 | printf( '<p style="margin: 3px 0 0 0; border-top: 1px solid #ddd; padding-top: 3px">%s</p>', esc_html( $r->upgrade_notice ) ); |
| 120 | 87 | } |
| 121 | 88 | } |
| @@ -120,22 +87,17 @@ | ||
| 120 | 87 | } |
| 121 | 88 | } |
| 122 | 89 | |
| 123 | 90 | /** |
| 124 | - * Setup filters for admin pages | |
| 91 | + * setup filters for admin pages | |
| 125 | 92 | * |
| 126 | 93 | * @since 1.2 |
| 127 | - * @since 2.7 instantiate a PLL_Bulk_Translate instance. | |
| 128 | - * @return void | |
| 129 | 94 | */ |
| 130 | 95 | public function add_filters() { |
| 131 | - $this->filters_sanitization = new PLL_Filters_Sanitization( $this->get_locale_for_sanitization() ); | |
| 132 | - $this->filters_widgets = new PLL_Admin_Filters_Widgets_Options( $this ); | |
| 96 | + // all these are separated just for convenience and maintainability | |
| 97 | + $classes = array( 'Filters', 'Filters_Columns', 'Filters_Post', 'Filters_Term', 'Nav_Menu', 'Sync' ); | |
| 133 | 98 | |
| 134 | - // All these are separated just for convenience and maintainability | |
| 135 | - $classes = array( 'Filters', 'Filters_Columns', 'Filters_Post', 'Filters_Term', 'Nav_Menu', 'Classic_Editor', 'Block_Editor' ); | |
| 136 | - | |
| 137 | - // Don't load media filters if option is disabled or if user has no right | |
| 99 | + // don't load media filters if option is disabled or if user has no right | |
| 138 | 100 | if ( $this->options['media_support'] && ( $obj = get_post_type_object( 'attachment' ) ) && ( current_user_can( $obj->cap->edit_posts ) || current_user_can( $obj->cap->create_posts ) ) ) { |
| 139 | 101 | $classes[] = 'Filters_Media'; |
| 140 | 102 | } |
| 141 | 103 | |
| @@ -142,9 +104,9 @@ | ||
| 142 | 104 | foreach ( $classes as $class ) { |
| 143 | 105 | $obj = strtolower( $class ); |
| 144 | 106 | |
| 145 | 107 | /** |
| 146 | - * Filter the class to instantiate when loading admin filters | |
| 108 | + * Filter the class to instantiate when loding admin filters | |
| 147 | 109 | * |
| 148 | 110 | * @since 1.5 |
| 149 | 111 | * |
| 150 | 112 | * @param string $class class name |
| @@ -151,30 +113,6 @@ | ||
| 151 | 113 | */ |
| 152 | 114 | $class = apply_filters( 'pll_' . $obj, 'PLL_Admin_' . $class ); |
| 153 | 115 | $this->$obj = new $class( $this ); |
| 154 | 116 | } |
| 155 | - } | |
| 156 | - | |
| 157 | - /** | |
| 158 | - * Retrieve the locale according to the current language instead of the language | |
| 159 | - * of the admin interface. | |
| 160 | - * | |
| 161 | - * @since 2.0 | |
| 162 | - * | |
| 163 | - * @return string | |
| 164 | - */ | |
| 165 | - public function get_locale_for_sanitization() { | |
| 166 | - $locale = get_locale(); | |
| 167 | - | |
| 168 | - if ( isset( $_POST['post_lang_choice'] ) && $lang = $this->model->get_language( sanitize_key( $_POST['post_lang_choice'] ) ) ) { // phpcs:ignore WordPress.Security.NonceVerification | |
| 169 | - $locale = $lang->locale; | |
| 170 | - } elseif ( isset( $_POST['term_lang_choice'] ) && $lang = $this->model->get_language( sanitize_key( $_POST['term_lang_choice'] ) ) ) { // phpcs:ignore WordPress.Security.NonceVerification | |
| 171 | - $locale = $lang->locale; | |
| 172 | - } elseif ( isset( $_POST['inline_lang_choice'] ) && $lang = $this->model->get_language( sanitize_key( $_POST['inline_lang_choice'] ) ) ) { // phpcs:ignore WordPress.Security.NonceVerification | |
| 173 | - $locale = $lang->locale; | |
| 174 | - } elseif ( ! empty( $this->curlang ) ) { | |
| 175 | - $locale = $this->curlang->locale; | |
| 176 | - } | |
| 177 | - | |
| 178 | - return $locale; | |
| 179 | 117 | } |
| 180 | 118 | } |
