MediaWiki  1.34.0
UserDataAuthenticationRequest.php
Go to the documentation of this file.
1 <?php
22 namespace MediaWiki\Auth;
23 
25 use StatusValue;
26 use User;
27 
36  public $email;
37 
39  public $realname;
40 
41  public function getFieldInfo() {
42  $config = MediaWikiServices::getInstance()->getMainConfig();
43  $ret = [
44  'email' => [
45  'type' => 'string',
46  'label' => wfMessage( 'authmanager-email-label' ),
47  'help' => wfMessage( 'authmanager-email-help' ),
48  'optional' => true,
49  ],
50  'realname' => [
51  'type' => 'string',
52  'label' => wfMessage( 'authmanager-realname-label' ),
53  'help' => wfMessage( 'authmanager-realname-help' ),
54  'optional' => true,
55  ],
56  ];
57 
58  if ( !$config->get( 'EnableEmail' ) ) {
59  unset( $ret['email'] );
60  }
61 
62  if ( in_array( 'realname', $config->get( 'HiddenPrefs' ), true ) ) {
63  unset( $ret['realname'] );
64  }
65 
66  return $ret;
67  }
68 
76  public function populateUser( $user ) {
77  if ( $this->email !== null && $this->email !== '' ) {
78  if ( !\Sanitizer::validateEmail( $this->email ) ) {
79  return StatusValue::newFatal( 'invalidemailaddress' );
80  }
81  $user->setEmail( $this->email );
82  }
83  if ( $this->realname !== null && $this->realname !== '' ) {
84  $user->setRealName( $this->realname );
85  }
86  return StatusValue::newGood();
87  }
88 
89 }
StatusValue
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: StatusValue.php:42
MediaWiki\Auth\UserDataAuthenticationRequest\$email
string null $email
Email address.
Definition: UserDataAuthenticationRequest.php:36
StatusValue\newFatal
static newFatal( $message,... $parameters)
Factory function for fatal errors.
Definition: StatusValue.php:69
MediaWiki\Auth\UserDataAuthenticationRequest\$realname
string null $realname
Real name.
Definition: UserDataAuthenticationRequest.php:39
MediaWiki\MediaWikiServices
MediaWikiServices is the service locator for the application scope of MediaWiki.
Definition: MediaWikiServices.php:117
MediaWiki\Auth\UserDataAuthenticationRequest\getFieldInfo
getFieldInfo()
Fetch input field info.
Definition: UserDataAuthenticationRequest.php:41
true
return true
Definition: router.php:92
wfMessage
wfMessage( $key,... $params)
This is the function for getting translated interface messages.
Definition: GlobalFunctions.php:1264
MediaWiki\MediaWikiServices\getInstance
static getInstance()
Returns the global default instance of the top level service locator.
Definition: MediaWikiServices.php:138
Config\get
get( $name)
Get a configuration variable such as "Sitename" or "UploadMaintenance.".
MediaWiki\Auth\UserDataAuthenticationRequest
This represents additional user data requested on the account creation form.
Definition: UserDataAuthenticationRequest.php:34
StatusValue\newGood
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
MediaWiki\Auth\UserDataAuthenticationRequest\populateUser
populateUser( $user)
Add data to the User object.
Definition: UserDataAuthenticationRequest.php:76
MediaWiki\$config
Config $config
Definition: MediaWiki.php:43
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:51
MediaWiki\Auth
Definition: AbstractAuthenticationProvider.php:22
MediaWiki\Auth\AuthenticationRequest
This is a value object for authentication requests.
Definition: AuthenticationRequest.php:37