wikimedia/mediawiki-extensions-OATHAuth
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/OATHAuth synced 2024-11-23 15:56:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Couple of fixme comments

Browse source 
Tidy up parameter documentation

Change-Id: I1a615d44e9092cf080ef1aed9dba50c3b5416392
This commit is contained in:
Reedy 2012-05-11 19:05:16 +01:00
parent 2869316e32
commit 1eea41eb1c
3 changed files with 34 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
OATHAuth.i18n.php
View file

@ -48,4 +48,5 @@ $messages['en'] = array(
* @author Ryan Lane <rlane@wikimedia.org>
*/
$messages['qqq'] = array(
'oathauth-desc' => '{{desc}}',
);

33
OATHUser.php
View file

@ -14,11 +14,14 @@ class OATHUser {
/**
* Constructor. Can't be called directly. Call one of the static NewFrom* methods
* @param $id Int Database id for the group
* @param $name String User-defined name of the group
* @param $position int
* @param $project string|null
* @param $account
* @param $secret
* @param $secretReset
* @param $scratchTokens
* @param $scratchTokensReset
* @param bool $isValidated bool
*/
public function __construct( $id, $account, $secret=null, $secretReset = null, $scratchTokens=null, $scratchTokensReset=null, $isValidated=false ) {
public function __construct( $id, $account, $secret = null, $secretReset = null, $scratchTokens = null, $scratchTokensReset = null, $isValidated = false ) {
$this->id = $id;
$this->account = $account;
$this->isEnabled = true;
@ -36,7 +39,7 @@ class OATHUser {
if ( $scratchTokens ) {
$this->scratchTokens = $scratchTokens;
} else {
$this->regenerateScratchTokens();
$this->regenerateScratchTokens(); // FIXME: Missing parameter
$this->isEnabled = false;
}
if ( $scratchTokensReset ) {
@ -47,6 +50,9 @@ class OATHUser {
$this->isValidated = $isValidated;
}
/**
* @param $reset bool
*/
public function regenerateScratchTokens( $reset ) {
$scratchTokens = array();
for ( $i = 0; $i < 5; $i++ ) {
@ -109,10 +115,12 @@ class OATHUser {
}
/**
* @param $token
* @param $reset bool
* @return Boolean
*/
public function verifyToken( $token, $reset=false ) {
if ( $reset ) {
public function verifyToken( $token, $reset = false ) {
if ( $reset ) {
$secret = $this->secretReset;
} else {
$secret = $this->secret;
@ -139,7 +147,7 @@ class OATHUser {
}
/**
* @param $name string
* @param $user User
* @return OATHUser|null
*/
public static function newFromUser( $user ) {
@ -180,7 +188,7 @@ class OATHUser {
}
/**
* @param $name string
* @param $username string
* @return OATHUser|null
*/
public static function newFromUsername( $username ) {
@ -228,7 +236,7 @@ class OATHUser {
array( 'secret' => $this->secretReset,
'secret_reset' => null,
'scratch_tokens' => base64_encode( serialize( $this->scratchTokensReset ) ),
'scratch_tokens_reset' => null,
'scratch_tokens_reset' => null,
),
array( 'id' => $this->id ),
__METHOD__
@ -236,7 +244,6 @@ class OATHUser {
}
/**
* @param $token string
* @return bool
*/
public function validate() {
@ -263,7 +270,6 @@ class OATHUser {
}
/**
* @param $id int
* @return bool
*/
public function disable() {
@ -276,11 +282,11 @@ class OATHUser {
}
/**
* @static
* @param $template
* @return bool
*/
static function ModifyUITemplate( &$template ) {
// FIXME: First assignment of $input unused
$input = array( 'msg' => 'oathauth-token', 'type' => 'text', 'name' => 'token', 'value' => '', 'helptext' => 'oathauth-tokenhelp' );
$input = '<td class="mw-label"><label for="wpOATHToken">' . wfMsgHtml( 'oathauth-token' ) . '</label></td><td class="mw-input">' . Html::input( 'wpOATHToken', null, 'password', array( 'class' => 'loginPassword', 'id' => 'wpOATHToken', 'tabindex' => '2', 'size' => '20' ) ) . '</td>';
$template->set( 'extrafields', $input );
@ -289,7 +295,6 @@ class OATHUser {
}
/**
* @static
* @param $username string
* @param $password string
* @param $result bool

21
special/SpecialOATH.php
View file

@ -76,7 +76,10 @@ class SpecialOATH extends SpecialPage {
return true;
}
function displaySecret( $reset=false ) {
/**
* @param $reset bool
*/
function displaySecret( $reset = false ) {
$this->getOutput()->addModules( 'ext.oathauth' );
if ( $reset ) {
$secret = $this->OATHUser->getSecretReset();
@ -198,6 +201,10 @@ class SpecialOATH extends SpecialPage {
$this->getOutput()->addHTML( $this->createResourceList( $resources ) );
}
/**
* @param $resources array
* @return string
*/
function createResourceList( $resources ) {
$resourceList = '';
foreach ( $resources as $resource ) {
@ -207,8 +214,8 @@ class SpecialOATH extends SpecialPage {
}
/**
* @param $formData
* @param string $entryPoint
* @param $formData array
* @param $entryPoint string
* @return bool
*/
function tryValidateSubmit( $formData, $entryPoint = 'internal' ) {
@ -246,8 +253,8 @@ class SpecialOATH extends SpecialPage {
}
/**
* @param $formData
* @param string $entryPoint
* @param $formData array
* @param $entryPoint string
* @return bool
*/
function tryDisableSubmit( $formData, $entryPoint = 'internal' ) {
@ -268,8 +275,8 @@ class SpecialOATH extends SpecialPage {
}
/**
* @param $formData
* @param string $entryPoint
* @param $formData array
* @param $entryPoint string
* @return bool
*/
function tryResetSubmit( $formData, $entryPoint = 'internal' ) {