MediaWiki REL1_32
UserDataAuthenticationRequest.php
Go to the documentation of this file.
1<?php
22namespace MediaWiki\Auth;
23
25use StatusValue;
26use 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}
This is a value object for authentication requests.
This represents additional user data requested on the account creation form.
MediaWikiServices is the service locator for the application scope of MediaWiki.
static getInstance()
Returns the global default instance of the top level service locator.
Generic operation result class Has warning/error list, boolean status and arbitrary value.
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:47
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition hooks.txt:2054
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt;div ...>$1&lt;/div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services