wiki.techinc.nl/includes/auth/CreatedAccountAuthenticationRequest.php
Umherirrender e44aee1f74 auth: Add missing documentation to class properties
Add doc-typehints to class properties found by the PropertyDocumentation
sniff to improve the documentation.

Once the sniff is enabled it avoids that new code is missing type
declarations. This is focused on documentation and does not change code.

Change-Id: Ib6081f5519d2294bb14f81bf399f9c45315f2b69
2024-09-01 11:27:45 +02:00

55 lines
1.4 KiB
PHP

<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Auth
*/
namespace MediaWiki\Auth;
/**
* Returned from account creation to allow for logging into the created account
* @stable to extend
* @ingroup Auth
* @since 1.27
*/
class CreatedAccountAuthenticationRequest extends AuthenticationRequest {
/** @inheritDoc */
public $required = self::OPTIONAL;
/** @var int User id */
public $id;
/**
* @inheritDoc
* @stable to override
*/
public function getFieldInfo() {
return [];
}
/**
* @stable to call
* @param int $id User id
* @param string $name Username
*/
public function __construct( $id, $name ) {
$this->id = (int)$id;
$this->username = $name;
}
}