MediaWiki  1.32.5
OATHUser Class Reference

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. More...

Collaboration diagram for OATHUser:

Public Member Functions

 __construct (User $user, OATHAuthKey $key=null)
 Constructor. More...
 
 getAccount ()
 
 getIssuer ()
 
 getKey ()
 Get the key associated with this user. More...
 
 getUser ()
 
 setKey (OATHAuthKey $key=null)
 Set the key associated with this user. More...
 

Private Attributes

OATHAuthKey null $key
 
User $user
 

Detailed Description

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html Class representing a user from OATH's perspective

Definition at line 24 of file OATHUser.php.

Constructor & Destructor Documentation

◆ __construct()

OATHUser::__construct ( User  $user,
OATHAuthKey  $key = null 
)

Constructor.

Can't be called directly. Use OATHUserRepository::findByUser instead.

Parameters
User$user
OATHAuthKey | null$key

Definition at line 36 of file OATHUser.php.

References $key, $user, key, and user.

Member Function Documentation

◆ getAccount()

OATHUser::getAccount ( )
Returns
String

Definition at line 62 of file OATHUser.php.

References user.

Referenced by SpecialOATHEnable\getFormFields().

◆ getIssuer()

OATHUser::getIssuer ( )
Returns
String

Definition at line 51 of file OATHUser.php.

References $wgSitename.

Referenced by SpecialOATHEnable\getFormFields().

◆ getKey()

OATHUser::getKey ( )

Get the key associated with this user.

Returns
null|OATHAuthKey

Definition at line 71 of file OATHUser.php.

References $key.

Referenced by SpecialOATHDisable\onSubmit().

◆ getUser()

OATHUser::getUser ( )
Returns
User

Definition at line 44 of file OATHUser.php.

References $user.

Referenced by SpecialOATHDisable\onSubmit(), and OATHUserRepository\persist().

◆ setKey()

OATHUser::setKey ( OATHAuthKey  $key = null)

Set the key associated with this user.

Parameters
OATHAuthKey | null$key

Definition at line 80 of file OATHUser.php.

References $key, and key.

Referenced by SpecialOATHDisable\onSubmit(), and SpecialOATHEnable\onSubmit().

Member Data Documentation

◆ $key

OATHAuthKey null OATHUser::$key
private

Definition at line 29 of file OATHUser.php.

Referenced by __construct(), getKey(), and setKey().

◆ $user

User OATHUser::$user
private

Definition at line 26 of file OATHUser.php.

Referenced by __construct(), and getUser().


The documentation for this class was generated from the following file: