wiki.techinc.nl/includes/auth/CreationReasonAuthenticationRequest.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

30 lines
660 B
PHP

<?php
namespace MediaWiki\Auth;
/**
* Authentication request for the reason given for account creation.
* Used in logs and for notification.
* @stable to extend
*/
class CreationReasonAuthenticationRequest extends AuthenticationRequest {
/** @var string Account creation reason (only used when creating for someone else) */
public $reason;
/** @inheritDoc */
public $required = self::OPTIONAL;
/**
* @inheritDoc
* @stable to override
*/
public function getFieldInfo() {
return [
'reason' => [
'type' => 'string',
'label' => wfMessage( 'createacct-reason' ),
'help' => wfMessage( 'createacct-reason-help' ),
],
];
}
}