MediaWiki  master
UserInfo.php
Go to the documentation of this file.
1 <?php
24 namespace MediaWiki\Session;
25 
26 use User;
27 
51 final class UserInfo {
53  private $verified = false;
54 
56  private $user = null;
57 
58  private function __construct( User $user = null, $verified ) {
59  if ( $user && $user->isAnon() && !User::isUsableName( $user->getName() ) ) {
60  $this->verified = true;
61  $this->user = null;
62  } else {
63  $this->verified = $verified;
64  $this->user = $user;
65  }
66  }
67 
75  public static function newAnonymous() {
76  return new self( null, true );
77  }
78 
85  public static function newFromId( $id, $verified = false ) {
86  $user = User::newFromId( $id );
87 
88  // Ensure the ID actually exists
89  $user->load();
90  if ( $user->isAnon() ) {
91  throw new \InvalidArgumentException( 'Invalid ID' );
92  }
93 
94  return new self( $user, $verified );
95  }
96 
103  public static function newFromName( $name, $verified = false ) {
104  $user = User::newFromName( $name, 'usable' );
105  if ( !$user ) {
106  throw new \InvalidArgumentException( 'Invalid user name' );
107  }
108  return new self( $user, $verified );
109  }
110 
117  public static function newFromUser( User $user, $verified = false ) {
118  return new self( $user, $verified );
119  }
120 
125  public function isAnon() {
126  return $this->user === null;
127  }
128 
133  public function isVerified() {
134  return $this->verified;
135  }
136 
142  public function getId() {
143  return $this->user === null ? 0 : $this->user->getId();
144  }
145 
150  public function getName() {
151  return $this->user === null ? null : $this->user->getName();
152  }
153 
158  public function getToken() {
159  return $this->user === null || $this->user->getId() === 0 ? '' : $this->user->getToken( false );
160  }
161 
166  public function getUser() {
167  return $this->user === null ? new User : $this->user;
168  }
169 
174  public function verified() {
175  return $this->verified ? $this : new self( $this->user, true );
176  }
177 
178  public function __toString() {
179  if ( $this->user === null ) {
180  return '<anon>';
181  }
182  return '<' .
183  ( $this->verified ? '+' : '-' ) . ':' .
184  $this->getId() . ':' . $this->getName() .
185  '>';
186  }
187 
188 }
Object holding data about a session&#39;s user.
Definition: UserInfo.php:51
getUser()
Return a User object.
Definition: UserInfo.php:166
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getToken()
Return the user token.
Definition: UserInfo.php:158
static newFromUser(User $user, $verified=false)
Create an instance from an existing User object.
Definition: UserInfo.php:117
getId()
Return the user ID.
Definition: UserInfo.php:142
getName()
Get the user name, or the IP of an anonymous user.
Definition: User.php:2251
static newAnonymous()
Create an instance for an anonymous (i.e.
Definition: UserInfo.php:75
static newFromId( $id, $verified=false)
Create an instance for a logged-in user by ID.
Definition: UserInfo.php:85
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:51
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:1972
isAnon()
Return whether this is an anonymous user.
Definition: UserInfo.php:125
verified()
Return a verified version of this object.
Definition: UserInfo.php:174
isAnon()
Get whether the user is anonymous.
Definition: User.php:3582
load( $flags=self::READ_NORMAL)
Load the user table data for this object from the source given by mFrom.
Definition: User.php:308
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such and we might be restricted by PHP settings such as safe mode or open_basedir We cannot assume that the software even has read access anywhere useful Many shared hosts run all users web applications under the same user
Wikitext formatted, in the key only.
Definition: distributors.txt:9
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:767
static isUsableName( $name)
Usernames which fail to pass this function will be blocked from user login and new account registrati...
Definition: User.php:1001
isVerified()
Return whether this represents a verified user.
Definition: UserInfo.php:133
getName()
Return the user name.
Definition: UserInfo.php:150
__construct(User $user=null, $verified)
Definition: UserInfo.php:58
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
static newFromId( $id)
Static factory method for creation from a given user ID.
Definition: User.php:559
static newFromName( $name, $verified=false)
Create an instance for a logged-in user by name.
Definition: UserInfo.php:103
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:535