MediaWiki  1.29.1
UserDataAuthenticationRequest.php
Go to the documentation of this file.
1 <?php
22 namespace MediaWiki\Auth;
23 
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
MediaWiki\Auth\UserDataAuthenticationRequest\$realname
string null $realname
Real name.
Definition: UserDataAuthenticationRequest.php:39
MediaWiki\Auth\UserDataAuthenticationRequest\getFieldInfo
getFieldInfo()
Fetch input field info.
Definition: UserDataAuthenticationRequest.php:41
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:246
StatusValue\newFatal
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:63
User
User
Definition: All_system_messages.txt:425
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
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
MediaWiki\MediaWikiServices\getInstance
static getInstance()
Returns the global default instance of the top level service locator.
Definition: MediaWikiServices.php:97
StatusValue\newGood
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:76
MediaWiki\Auth\UserDataAuthenticationRequest\populateUser
populateUser( $user)
Add data to the User object.
Definition: UserDataAuthenticationRequest.php:76
$ret
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:1956
MediaWiki\$config
Config $config
Definition: MediaWiki.php:42
true
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 just before the function returns a value If you return true
Definition: hooks.txt:1956
wfMessage
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 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
MediaWikiServices
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:23
MediaWiki\Auth
Definition: AbstractAuthenticationProvider.php:22
MediaWiki\Auth\AuthenticationRequest
This is a value object for authentication requests.
Definition: AuthenticationRequest.php:37