installer: Deprecate WebInstaller::getInfoBox, getWarningBox and getErrorBox

Since MW 1.31 there are messageBox, warningBox, errorBox and successBox
available which should be used instead.

These are simple wrappers around Html::messageBox and related methods
which should be used directly instead. Internal usage has been migrated
as of a9252abb1cf0, but these public methods remain for now. Once
removed we can also removed the internal Html::infoBox() method.

Bug: T232903
Change-Id: I2756c88987754c4e3f84d98c531d8396098cd7fe

diff --git a/RELEASE-NOTES-1.34 b/RELEASE-NOTES-1.34
index 6b89ff6..9e1e68d 100644 (file)
--- a/RELEASE-NOTES-1.34
+++ b/RELEASE-NOTES-1.34
@@ -575,6 +575,8 @@ because of Phabricator reports.
 * Specifying a SpecialPage object for the list of special pages (either through
   the SpecialPage_initList hook or by adding to $wgSpecialPages) is now
   deprecated.
+* WebInstaller::getInfoBox(), getWarningBox() and getErrorBox() are deprecated.
+  Use Html::errorBox() or Html::warningBox() instead.
 * Use of ActorMigration with 'ar_user', 'img_user', 'oi_user', 'fa_user',
   'rc_user', 'log_user', and 'ipb_by' is deprecated. Queries should be adjusted
   to use the corresponding actor fields directly. Note that use with

diff --git a/includes/Html.php b/includes/Html.php
index a8f3496..ea2ce07 100644 (file)
--- a/includes/Html.php
+++ b/includes/Html.php
@@ -1011,7 +1011,7 @@ class Html {
        /**
         * Get HTML for an information message box with an icon.
         *
-        * @internal For use by the WebInstaller class.
+        * @internal For use by the WebInstaller class only.
         * @param string $rawHtml HTML
         * @param string $icon Path to icon file (used as 'src' attribute)
         * @param string $alt Alternate text for the icon

diff --git a/includes/installer/WebInstaller.php b/includes/installer/WebInstaller.php
index 21ad210..d9cd6de 100644 (file)
--- a/includes/installer/WebInstaller.php
+++ b/includes/installer/WebInstaller.php
@@ -638,34 +638,40 @@ class WebInstaller extends Installer {
        /**
         * Get HTML for an error box with an icon.
         *
+        * @deprecated since 1.34 Use Html::errorBox() instead.
         * @param string $text Wikitext, get this with wfMessage()->plain()
         *
         * @return string
         */
        public function getErrorBox( $text ) {
+               wfDeprecated( __METHOD__, '1.34' );
                return $this->getInfoBox( $text, 'critical-32.png', 'config-error-box' );
        }
 
        /**
         * Get HTML for a warning box with an icon.
         *
+        * @deprecated since 1.34 Use Html::warningBox() instead.
         * @param string $text Wikitext, get this with wfMessage()->plain()
         *
         * @return string
         */
        public function getWarningBox( $text ) {
+               wfDeprecated( __METHOD__, '1.34' );
                return $this->getInfoBox( $text, 'warning-32.png', 'config-warning-box' );
        }
 
        /**
         * Get HTML for an information message box with an icon.
         *
+        * @deprecated since 1.34.
         * @param string|HtmlArmor $text Wikitext to be parsed (from Message::plain) or raw HTML.
         * @param string|bool $icon Icon name, file in mw-config/images. Default: false
         * @param string|bool $class Additional class name to add to the wrapper div. Default: false.
         * @return string HTML
         */
        public function getInfoBox( $text, $icon = false, $class = false ) {
+               wfDeprecated( __METHOD__, '1.34' );
                $html = ( $text instanceof HtmlArmor ) ?
                        HtmlArmor::getHtml( $text ) :
                        $this->parse( $text, true );