X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/af50974463450c98503e763a7836a50e260461a9..784f914b1e4b1c62d6657e86397c2e83bcee4295:/wp-admin/includes/class-wp-upgrader-skins.php diff --git a/wp-admin/includes/class-wp-upgrader-skins.php b/wp-admin/includes/class-wp-upgrader-skins.php index 7d403739..c9d32ceb 100644 --- a/wp-admin/includes/class-wp-upgrader-skins.php +++ b/wp-admin/includes/class-wp-upgrader-skins.php @@ -22,6 +22,10 @@ class WP_Upgrader_Skin { public $result = false; public $options = array(); + /** + * + * @param array $args + */ public function __construct($args = array()) { $defaults = array( 'url' => '', 'nonce' => '', 'title' => '', 'context' => false ); $this->options = wp_parse_args($args, $defaults); @@ -36,13 +40,27 @@ class WP_Upgrader_Skin { $this->add_strings(); } + /** + * @access public + */ public function add_strings() { } + /** + * + * @param string|false|WP_Error $result + */ public function set_result($result) { $this->result = $result; } + /** + * + * @param bool $error + * @param string $context + * @param bool $allow_relaxed_file_ownership + * @return type + */ public function request_filesystem_credentials( $error = false, $context = false, $allow_relaxed_file_ownership = false ) { $url = $this->options['url']; if ( ! $context ) { @@ -57,14 +75,21 @@ class WP_Upgrader_Skin { return request_filesystem_credentials( $url, '', $error, $context, $extra_fields, $allow_relaxed_file_ownership ); } + /** + * @access public + */ public function header() { if ( $this->done_header ) { return; } $this->done_header = true; echo '
'; - echo '

' . $this->options['title'] . '

'; + echo '

' . $this->options['title'] . '

'; } + + /** + * @access public + */ public function footer() { if ( $this->done_footer ) { return; @@ -73,6 +98,10 @@ class WP_Upgrader_Skin { echo '
'; } + /** + * + * @param string|WP_Error $errors + */ public function error($errors) { if ( ! $this->done_header ) $this->header(); @@ -88,6 +117,10 @@ class WP_Upgrader_Skin { } } + /** + * + * @param string $string + */ public function feedback($string) { if ( isset( $this->upgrader->strings[$string] ) ) $string = $this->upgrader->strings[$string]; @@ -105,7 +138,15 @@ class WP_Upgrader_Skin { return; show_message($string); } + + /** + * @access public + */ public function before() {} + + /** + * @access public + */ public function after() {} /** @@ -137,6 +178,16 @@ class WP_Upgrader_Skin { '; } } + + /** + * @access public + */ + public function bulk_header() {} + + /** + * @access public + */ + public function bulk_footer() {} } /** @@ -151,7 +202,11 @@ class Plugin_Upgrader_Skin extends WP_Upgrader_Skin { public $plugin_active = false; public $plugin_network_active = false; - public function __construct($args = array()) { + /** + * + * @param array $args + */ + public function __construct( $args = array() ) { $defaults = array( 'url' => '', 'plugin' => '', 'nonce' => '', 'title' => __('Update Plugin') ); $args = wp_parse_args($args, $defaults); @@ -163,17 +218,21 @@ class Plugin_Upgrader_Skin extends WP_Upgrader_Skin { parent::__construct($args); } + /** + * @access public + */ public function after() { $this->plugin = $this->upgrader->plugin_info(); if ( !empty($this->plugin) && !is_wp_error($this->result) && $this->plugin_active ){ - echo ''; + // Currently used only when JS is off for a single plugin update? + echo ''; } $this->decrement_update_count( 'plugin' ); $update_actions = array( - 'activate_plugin' => '' . __('Activate Plugin') . '', - 'plugins_page' => '' . __('Return to Plugins page') . '' + 'activate_plugin' => '' . __( 'Activate Plugin' ) . '', + 'plugins_page' => '' . __( 'Return to Plugins page' ) . '' ); if ( $this->plugin_active || ! $this->result || is_wp_error( $this->result ) || ! current_user_can( 'activate_plugins' ) ) unset( $update_actions['activate_plugin'] ); @@ -202,8 +261,15 @@ class Plugin_Upgrader_Skin extends WP_Upgrader_Skin { */ class Bulk_Upgrader_Skin extends WP_Upgrader_Skin { public $in_loop = false; + /** + * @var string|false + */ public $error = false; + /** + * + * @param array $args + */ public function __construct($args = array()) { $defaults = array( 'url' => '', 'nonce' => '' ); $args = wp_parse_args($args, $defaults); @@ -211,11 +277,17 @@ class Bulk_Upgrader_Skin extends WP_Upgrader_Skin { parent::__construct($args); } + /** + * @access public + */ public function add_strings() { $this->upgrader->strings['skin_upgrade_start'] = __('The update process is starting. This process may take a while on some hosts, so please be patient.'); - $this->upgrader->strings['skin_update_failed_error'] = __('An error occurred while updating %1$s: %2$s'); + /* translators: 1: Title of an update, 2: Error message */ + $this->upgrader->strings['skin_update_failed_error'] = __('An error occurred while updating %1$s: %2$s'); + /* translators: 1: Title of an update */ $this->upgrader->strings['skin_update_failed'] = __('The update of %1$s failed.'); - $this->upgrader->strings['skin_update_successful'] = __('%1$s updated successfully.').' '.__('Show Details').'.'; + /* translators: 1: Title of an update */ + $this->upgrader->strings['skin_update_successful'] = __( '%1$s updated successfully.' ) . ' ' . __( 'Show Details' ) . ''; $this->upgrader->strings['skin_upgrade_end'] = __('All updates have been completed.'); } @@ -243,13 +315,24 @@ class Bulk_Upgrader_Skin extends WP_Upgrader_Skin { echo "

$string

\n"; } + /** + * @access public + */ public function header() { // Nothing, This will be displayed within a iframe. } + /** + * @access public + */ public function footer() { // Nothing, This will be displayed within a iframe. } + + /** + * + * @param string|WP_Error $error + */ public function error($error) { if ( is_string($error) && isset( $this->upgrader->strings[$error] ) ) $this->error = $this->upgrader->strings[$error]; @@ -267,29 +350,44 @@ class Bulk_Upgrader_Skin extends WP_Upgrader_Skin { echo ''; } + /** + * @access public + */ public function bulk_header() { $this->feedback('skin_upgrade_start'); } + /** + * @access public + */ public function bulk_footer() { $this->feedback('skin_upgrade_end'); } + /** + * + * @param string $title + */ public function before($title = '') { $this->in_loop = true; - printf( '

' . $this->upgrader->strings['skin_before_update_header'] . '

', $title, $this->upgrader->update_current, $this->upgrader->update_count); + printf( '

' . $this->upgrader->strings['skin_before_update_header'] . '

', $title, $this->upgrader->update_current, $this->upgrader->update_count ); echo ''; echo '

'; $this->flush_output(); } + /** + * + * @param string $title + */ public function after($title = '') { echo '

'; if ( $this->error || ! $this->result ) { - if ( $this->error ) - echo '

' . sprintf($this->upgrader->strings['skin_update_failed_error'], $title, $this->error) . '

'; - else + if ( $this->error ) { + echo '

' . sprintf($this->upgrader->strings['skin_update_failed_error'], $title, '' . $this->error . '' ) . '

'; + } else { echo '

' . sprintf($this->upgrader->strings['skin_update_failed'], $title) . '

'; + } echo ''; } @@ -303,11 +401,17 @@ class Bulk_Upgrader_Skin extends WP_Upgrader_Skin { $this->flush_output(); } + /** + * @access public + */ public function reset() { $this->in_loop = false; $this->error = false; } + /** + * @access public + */ public function flush_output() { wp_ob_end_flush_all(); flush(); @@ -317,28 +421,36 @@ class Bulk_Upgrader_Skin extends WP_Upgrader_Skin { class Bulk_Plugin_Upgrader_Skin extends Bulk_Upgrader_Skin { public $plugin_info = array(); // Plugin_Upgrader::bulk() will fill this in. - public function __construct($args = array()) { - parent::__construct($args); - } - public function add_strings() { parent::add_strings(); $this->upgrader->strings['skin_before_update_header'] = __('Updating Plugin %1$s (%2$d/%3$d)'); } + /** + * + * @param string $title + */ public function before($title = '') { parent::before($this->plugin_info['Title']); } + /** + * + * @param string $title + */ public function after($title = '') { parent::after($this->plugin_info['Title']); $this->decrement_update_count( 'plugin' ); } + + /** + * @access public + */ public function bulk_footer() { parent::bulk_footer(); $update_actions = array( - 'plugins_page' => '' . __('Return to Plugins page') . '', - 'updates_page' => '' . __('Return to WordPress Updates') . '' + 'plugins_page' => '' . __( 'Return to Plugins page' ) . '', + 'updates_page' => '' . __( 'Return to WordPress Updates page' ) . '' ); if ( ! current_user_can( 'activate_plugins' ) ) unset( $update_actions['plugins_page'] ); @@ -361,29 +473,36 @@ class Bulk_Plugin_Upgrader_Skin extends Bulk_Upgrader_Skin { class Bulk_Theme_Upgrader_Skin extends Bulk_Upgrader_Skin { public $theme_info = array(); // Theme_Upgrader::bulk() will fill this in. - public function __construct($args = array()) { - parent::__construct($args); - } - public function add_strings() { parent::add_strings(); $this->upgrader->strings['skin_before_update_header'] = __('Updating Theme %1$s (%2$d/%3$d)'); } + /** + * + * @param string $title + */ public function before($title = '') { parent::before( $this->theme_info->display('Name') ); } + /** + * + * @param string $title + */ public function after($title = '') { parent::after( $this->theme_info->display('Name') ); $this->decrement_update_count( 'theme' ); } + /** + * @access public + */ public function bulk_footer() { parent::bulk_footer(); $update_actions = array( - 'themes_page' => '' . __('Return to Themes page') . '', - 'updates_page' => '' . __('Return to WordPress Updates') . '' + 'themes_page' => '' . __( 'Return to Themes page' ) . '', + 'updates_page' => '' . __( 'Return to WordPress Updates page' ) . '' ); if ( ! current_user_can( 'switch_themes' ) && ! current_user_can( 'edit_theme_options' ) ) unset( $update_actions['themes_page'] ); @@ -414,6 +533,10 @@ class Plugin_Installer_Skin extends WP_Upgrader_Skin { public $api; public $type; + /** + * + * @param array $args + */ public function __construct($args = array()) { $defaults = array( 'type' => 'web', 'url' => '', 'plugin' => '', 'nonce' => '', 'title' => '' ); $args = wp_parse_args($args, $defaults); @@ -424,13 +547,18 @@ class Plugin_Installer_Skin extends WP_Upgrader_Skin { parent::__construct($args); } + /** + * @access public + */ public function before() { if ( !empty($this->api) ) $this->upgrader->strings['process_success'] = sprintf( __('Successfully installed the plugin %s %s.'), $this->api->name, $this->api->version); } + /** + * @access public + */ public function after() { - $plugin_file = $this->upgrader->plugin_info(); $install_actions = array(); @@ -438,21 +566,22 @@ class Plugin_Installer_Skin extends WP_Upgrader_Skin { $from = isset($_GET['from']) ? wp_unslash( $_GET['from'] ) : 'plugins'; if ( 'import' == $from ) - $install_actions['activate_plugin'] = '' . __('Activate Plugin & Run Importer') . ''; + $install_actions['activate_plugin'] = '' . __( 'Activate Plugin & Run Importer' ) . ''; else - $install_actions['activate_plugin'] = '' . __('Activate Plugin') . ''; + $install_actions['activate_plugin'] = '' . __( 'Activate Plugin' ) . ''; if ( is_multisite() && current_user_can( 'manage_network_plugins' ) ) { - $install_actions['network_activate'] = '' . __('Network Activate') . ''; + $install_actions['network_activate'] = '' . __( 'Network Activate' ) . ''; unset( $install_actions['activate_plugin'] ); } - if ( 'import' == $from ) - $install_actions['importers_page'] = '' . __('Return to Importers') . ''; - else if ( $this->type == 'web' ) - $install_actions['plugins_page'] = '' . __('Return to Plugin Installer') . ''; - else - $install_actions['plugins_page'] = '' . __('Return to Plugins page') . ''; + if ( 'import' == $from ) { + $install_actions['importers_page'] = '' . __( 'Return to Importers' ) . ''; + } elseif ( $this->type == 'web' ) { + $install_actions['plugins_page'] = '' . __( 'Return to Plugin Installer' ) . ''; + } else { + $install_actions['plugins_page'] = '' . __( 'Return to Plugins page' ) . ''; + } if ( ! $this->result || is_wp_error($this->result) ) { unset( $install_actions['activate_plugin'], $install_actions['network_activate'] ); @@ -489,6 +618,10 @@ class Theme_Installer_Skin extends WP_Upgrader_Skin { public $api; public $type; + /** + * + * @param array $args + */ public function __construct($args = array()) { $defaults = array( 'type' => 'web', 'url' => '', 'theme' => '', 'nonce' => '', 'title' => '' ); $args = wp_parse_args($args, $defaults); @@ -499,11 +632,17 @@ class Theme_Installer_Skin extends WP_Upgrader_Skin { parent::__construct($args); } + /** + * @access public + */ public function before() { if ( !empty($this->api) ) $this->upgrader->strings['process_success'] = sprintf( $this->upgrader->strings['process_success_specific'], $this->api->name, $this->api->version); } + /** + * @access public + */ public function after() { if ( empty($this->upgrader->result['destination_name']) ) return; @@ -516,12 +655,6 @@ class Theme_Installer_Skin extends WP_Upgrader_Skin { $stylesheet = $this->upgrader->result['destination_name']; $template = $theme_info->get_template(); - $preview_link = add_query_arg( array( - 'preview' => 1, - 'template' => urlencode( $template ), - 'stylesheet' => urlencode( $stylesheet ), - ), trailingslashit( home_url() ) ); - $activate_link = add_query_arg( array( 'action' => 'activate', 'template' => urlencode( $template ), @@ -530,19 +663,19 @@ class Theme_Installer_Skin extends WP_Upgrader_Skin { $activate_link = wp_nonce_url( $activate_link, 'switch-theme_' . $stylesheet ); $install_actions = array(); - $install_actions['preview'] = '' . __('Preview') . ''; + if ( current_user_can( 'edit_theme_options' ) && current_user_can( 'customize' ) ) { - $install_actions['preview'] .= '' . __('Live Preview') . ''; + $install_actions['preview'] = '' . sprintf( __( 'Live Preview “%s”' ), $name ) . ''; } - $install_actions['activate'] = '' . __('Activate') . ''; + $install_actions['activate'] = '' . sprintf( __( 'Activate “%s”' ), $name ) . ''; if ( is_network_admin() && current_user_can( 'manage_network_themes' ) ) - $install_actions['network_enable'] = '' . __( 'Network Enable' ) . ''; + $install_actions['network_enable'] = '' . __( 'Network Enable' ) . ''; if ( $this->type == 'web' ) - $install_actions['themes_page'] = '' . __('Return to Theme Installer') . ''; + $install_actions['themes_page'] = '' . __( 'Return to Theme Installer' ) . ''; elseif ( current_user_can( 'switch_themes' ) || current_user_can( 'edit_theme_options' ) ) - $install_actions['themes_page'] = '' . __('Return to Themes page') . ''; + $install_actions['themes_page'] = '' . __( 'Return to Themes page' ) . ''; if ( ! $this->result || is_wp_error($this->result) || is_network_admin() || ! current_user_can( 'switch_themes' ) ) unset( $install_actions['activate'], $install_actions['preview'] ); @@ -573,6 +706,10 @@ class Theme_Installer_Skin extends WP_Upgrader_Skin { class Theme_Upgrader_Skin extends WP_Upgrader_Skin { public $theme = ''; + /** + * + * @param array $args + */ public function __construct($args = array()) { $defaults = array( 'url' => '', 'theme' => '', 'nonce' => '', 'title' => __('Update Theme') ); $args = wp_parse_args($args, $defaults); @@ -582,6 +719,9 @@ class Theme_Upgrader_Skin extends WP_Upgrader_Skin { parent::__construct($args); } + /** + * @access public + */ public function after() { $this->decrement_update_count( 'theme' ); @@ -591,12 +731,6 @@ class Theme_Upgrader_Skin extends WP_Upgrader_Skin { $stylesheet = $this->upgrader->result['destination_name']; $template = $theme_info->get_template(); - $preview_link = add_query_arg( array( - 'preview' => 1, - 'template' => urlencode( $template ), - 'stylesheet' => urlencode( $stylesheet ), - ), trailingslashit( home_url() ) ); - $activate_link = add_query_arg( array( 'action' => 'activate', 'template' => urlencode( $template ), @@ -606,21 +740,20 @@ class Theme_Upgrader_Skin extends WP_Upgrader_Skin { if ( get_stylesheet() == $stylesheet ) { if ( current_user_can( 'edit_theme_options' ) && current_user_can( 'customize' ) ) { - $update_actions['preview'] = '' . __('Customize') . ''; + $update_actions['preview'] = '' . sprintf( __( 'Customize “%s”' ), $name ) . ''; } } elseif ( current_user_can( 'switch_themes' ) ) { - $update_actions['preview'] = '' . __('Preview') . ''; if ( current_user_can( 'edit_theme_options' ) && current_user_can( 'customize' ) ) { - $update_actions['preview'] .= '' . __('Live Preview') . ''; + $update_actions['preview'] = '' . sprintf( __( 'Live Preview “%s”' ), $name ) . ''; } - $update_actions['activate'] = '' . __('Activate') . ''; + $update_actions['activate'] = '' . sprintf( __( 'Activate “%s”' ), $name ) . ''; } if ( ! $this->result || is_wp_error( $this->result ) || is_network_admin() ) unset( $update_actions['preview'], $update_actions['activate'] ); } - $update_actions['themes_page'] = '' . __('Return to Themes page') . ''; + $update_actions['themes_page'] = '' . __( 'Return to Themes page' ) . ''; /** * Filter the list of action links available following a single theme update. @@ -650,6 +783,10 @@ class Language_Pack_Upgrader_Skin extends WP_Upgrader_Skin { public $done_footer = false; public $display_footer_actions = true; + /** + * + * @param array $args + */ public function __construct( $args = array() ) { $defaults = array( 'url' => '', 'nonce' => '', 'title' => __( 'Update Translations' ), 'skip_header_footer' => false ); $args = wp_parse_args( $args, $defaults ); @@ -661,28 +798,41 @@ class Language_Pack_Upgrader_Skin extends WP_Upgrader_Skin { parent::__construct( $args ); } + /** + * @access public + */ public function before() { $name = $this->upgrader->get_name_for_update( $this->language_update ); echo '
'; - printf( '

' . __( 'Updating translations for %1$s (%2$s)…' ) . '

', $name, $this->language_update->language ); + printf( '

' . __( 'Updating translations for %1$s (%2$s)…' ) . '

', $name, $this->language_update->language ); } + /** + * + * @param string|WP_Error $error + */ public function error( $error ) { echo '
'; parent::error( $error ); echo '
'; } + /** + * @access public + */ public function after() { echo '
'; } + /** + * @access public + */ public function bulk_footer() { $this->decrement_update_count( 'translation' ); $update_actions = array(); - $update_actions['updates_page'] = '' . __( 'Return to WordPress Updates' ) . ''; + $update_actions['updates_page'] = '' . __( 'Return to WordPress Updates page' ) . ''; /** * Filter the list of action links available following a translations update. @@ -711,6 +861,13 @@ class Language_Pack_Upgrader_Skin extends WP_Upgrader_Skin { class Automatic_Upgrader_Skin extends WP_Upgrader_Skin { protected $messages = array(); + /** + * + * @param bool $error + * @param string $context + * @param bool $allow_relaxed_file_ownership + * @return bool + */ public function request_filesystem_credentials( $error = false, $context = '', $allow_relaxed_file_ownership = false ) { if ( $context ) { $this->options['context'] = $context; @@ -723,6 +880,11 @@ class Automatic_Upgrader_Skin extends WP_Upgrader_Skin { return $result; } + /** + * @access public + * + * @return array + */ public function get_upgrade_messages() { return $this->messages; } @@ -731,13 +893,13 @@ class Automatic_Upgrader_Skin extends WP_Upgrader_Skin { * @param string|array|WP_Error $data */ public function feedback( $data ) { - if ( is_wp_error( $data ) ) + if ( is_wp_error( $data ) ) { $string = $data->get_error_message(); - else if ( is_array( $data ) ) + } elseif ( is_array( $data ) ) { return; - else + } else { $string = $data; - + } if ( ! empty( $this->upgrader->strings[ $string ] ) ) $string = $this->upgrader->strings[ $string ]; @@ -766,19 +928,19 @@ class Automatic_Upgrader_Skin extends WP_Upgrader_Skin { $this->messages[] = $string; } + /** + * @access public + */ public function header() { ob_start(); } + /** + * @access public + */ public function footer() { - $output = ob_get_contents(); + $output = ob_get_clean(); if ( ! empty( $output ) ) $this->feedback( $output ); - ob_end_clean(); } - - public function bulk_header() {} - public function bulk_footer() {} - public function before() {} - public function after() {} }