* @param IContextSource $context
* @param string $formClass
* @param array $remove Array of items to remove
- * @return PreferencesForm|HTMLForm
+ * @return PreferencesFormLegacy|HTMLForm
*/
public static function getFormObject(
$user,
IContextSource $context,
- $formClass = PreferencesForm::class,
+ $formClass = PreferencesFormLegacy::class,
array $remove = []
) {
$preferencesFactory = self::getDefaultPreferencesFactory();
use OutputPage;
use Parser;
use ParserOptions;
-use PreferencesForm;
+use PreferencesFormLegacy;
use Psr\Log\LoggerAwareTrait;
use Psr\Log\NullLogger;
use Skin;
public function getForm(
User $user,
IContextSource $context,
- $formClass = PreferencesForm::class,
+ $formClass = PreferencesFormLegacy::class,
array $remove = []
) {
if ( SpecialPreferences::isOouiEnabled( $context ) ) {
* A PreferencesFactory is a MediaWiki service that provides the definitions of preferences for a
* given user. These definitions are in the form of an HTMLForm descriptor.
*
- * PreferencesForm (a subclass of HTMLForm) is used to generate the Preferences form, and handles
- * generic submission, CSRF protection, layout and other logic in a reusable manner.
+ * PreferencesFormLegacy (a subclass of HTMLForm) is used to generate the Preferences form, and
+ * handles generic submission, CSRF protection, layout and other logic in a reusable manner.
*
* In order to generate the form, the HTMLForm object needs an array structure detailing the
* form fields available, and that's what this implementations of this interface provide. Each
public function getForm(
User $user,
IContextSource $contextSource,
- $formClass = \PreferencesForm::class,
+ $formClass = \PreferencesFormLegacy::class,
array $remove = []
);
* Get the preferences form to use.
* @param User $user The user.
* @param IContextSource $context The context.
- * @return PreferencesForm|HTMLForm
+ * @return PreferencesFormLegacy|HTMLForm
*/
protected function getFormObject( $user, IContextSource $context ) {
$preferencesFactory = MediaWikiServices::getInstance()->getPreferencesFactory();
}
}
-// Retain the old class name for backwards compatibility.
-// In the future, this alias will be changed to point to PreferencesFormOOUI.
-class PreferencesForm extends PreferencesFormLegacy {
-}
-// Phan doesn't understand class_alias()?
-// class_alias( PreferencesFormLegacy::class, 'PreferencesForm' );
+/**
+ * Retain the old class name for backwards compatibility.
+ * In the future, this alias will be changed to point to PreferencesFormOOUI.
+ *
+ * @deprecated since 1.32
+ */
+class_alias( PreferencesFormLegacy::class, 'PreferencesForm' );
public function testGetForm() {
$testUser = $this->getTestUser();
$form = $this->getPreferencesFactory()->getForm( $testUser->getUser(), $this->context );
- $this->assertInstanceOf( PreferencesForm::class, $form );
+ $this->assertInstanceOf( PreferencesFormLegacy::class, $form );
$this->assertCount( 5, $form->getPreferenceSections() );
}