wikimedia/mediawiki-extensions-ConfirmEdit
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/ConfirmEdit synced 2024-11-27 09:30:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add missing documentation to class properties

Browse source 
Change-Id: Ic7872cd2539dc79f88c70548cbd82d9de98f66b0
This commit is contained in:
Umherirrender 2024-08-19 21:36:23 +02:00
parent 406b04553e
commit 29103eecde
10 changed files with 31 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
.phpcs.xml
View file

@ -1,10 +1,6 @@
<?xml version="1.0"?> <?xml version="1.0"?>
<ruleset> <ruleset>
<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki"> <rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki" />
<exclude name="MediaWiki.Commenting.PropertyDocumentation.MissingDocumentationPrivate" />
<exclude name="MediaWiki.Commenting.PropertyDocumentation.MissingDocumentationProtected" />
<exclude name="MediaWiki.Commenting.PropertyDocumentation.WrongStyle" />
</rule>
<file>.</file> <file>.</file>
<arg name="extensions" value="php"/> <arg name="extensions" value="php"/>
<arg name="encoding" value="UTF-8"/> <arg name="encoding" value="UTF-8"/>

6
FancyCaptcha/includes/FancyCaptcha.php
View file

@ -22,8 +22,10 @@ use UnderflowException;
* FancyCaptcha for displaying captchas precomputed by captcha.py * FancyCaptcha for displaying captchas precomputed by captcha.py
*/ */
class FancyCaptcha extends SimpleCaptcha { class FancyCaptcha extends SimpleCaptcha {
// used for fancycaptcha-edit, fancycaptcha-addurl, fancycaptcha-badlogin, /**
// fancycaptcha-accountcreate, fancycaptcha-create, fancycaptcha-sendemail via getMessage() * @var string used for fancycaptcha-edit, fancycaptcha-addurl, fancycaptcha-badlogin,
* fancycaptcha-accountcreate, fancycaptcha-create, fancycaptcha-sendemail via getMessage()
*/
protected static $messagePrefix = 'fancycaptcha-'; protected static $messagePrefix = 'fancycaptcha-';
/** /**

1
FancyCaptcha/includes/HTMLFancyCaptchaField.php
View file

@ -16,6 +16,7 @@ class HTMLFancyCaptchaField extends HTMLFormField {
/** @var bool */ /** @var bool */
protected $showCreateHelp; protected $showCreateHelp;
/** @var string */
protected $mClass = 'captcha'; protected $mClass = 'captcha';
/** /**

6
QuestyCaptcha/includes/QuestyCaptcha.php
View file

@ -19,8 +19,10 @@ use MediaWiki\Html\Html;
use Xml; use Xml;
class QuestyCaptcha extends SimpleCaptcha { class QuestyCaptcha extends SimpleCaptcha {
// used for questycaptcha-edit, questycaptcha-addurl, questycaptcha-badlogin, /**
// questycaptcha-createaccount, questycaptcha-create, questycaptcha-sendemail via getMessage() * @var string used for questycaptcha-edit, questycaptcha-addurl, questycaptcha-badlogin,
* questycaptcha-createaccount, questycaptcha-create, questycaptcha-sendemail via getMessage()
*/
protected static $messagePrefix = 'questycaptcha-'; protected static $messagePrefix = 'questycaptcha-';
/** /**

7
ReCaptchaNoCaptcha/includes/ReCaptchaNoCaptcha.php
View file

@ -16,10 +16,13 @@ use MediaWiki\Request\WebRequest;
use MediaWiki\Status\Status; use MediaWiki\Status\Status;
class ReCaptchaNoCaptcha extends SimpleCaptcha { class ReCaptchaNoCaptcha extends SimpleCaptcha {
// used for renocaptcha-edit, renocaptcha-addurl, renocaptcha-badlogin, renocaptcha-createaccount, /**
// renocaptcha-create, renocaptcha-sendemail via getMessage() * @var string used for renocaptcha-edit, renocaptcha-addurl, renocaptcha-badlogin, renocaptcha-createaccount,
* renocaptcha-create, renocaptcha-sendemail via getMessage()
*/
protected static $messagePrefix = 'renocaptcha-'; protected static $messagePrefix = 'renocaptcha-';
/** @var string|null */
private $error = null; private $error = null;
/** /**

1
SimpleCaptcha/SimpleCaptcha.php
View file

@ -45,6 +45,7 @@ use WikiPage;
* Demo CAPTCHA (not for production usage) and base class for real CAPTCHAs * Demo CAPTCHA (not for production usage) and base class for real CAPTCHAs
*/ */
class SimpleCaptcha { class SimpleCaptcha {
/** @var string */
protected static $messagePrefix = 'captcha-'; protected static $messagePrefix = 'captcha-';
/** @var bool Override to force showing the CAPTCHA to users who don't have "skipcaptcha" right. */ /** @var bool Override to force showing the CAPTCHA to users who don't have "skipcaptcha" right. */

7
Turnstile/includes/Turnstile.php
View file

@ -16,10 +16,13 @@ use MediaWiki\Request\WebRequest;
use MediaWiki\Status\Status; use MediaWiki\Status\Status;
class Turnstile extends SimpleCaptcha { class Turnstile extends SimpleCaptcha {
// used for turnstile-edit, turnstile-addurl, turnstile-badlogin, turnstile-createaccount, /**
// turnstile-create, turnstile-sendemail via getMessage() * @var string used for turnstile-edit, turnstile-addurl, turnstile-badlogin, turnstile-createaccount,
* turnstile-create, turnstile-sendemail via getMessage()
*/
protected static $messagePrefix = 'turnstile-'; protected static $messagePrefix = 'turnstile-';
/** @var string|null */
private $error = null; private $error = null;
/** /**

10
hCaptcha/includes/HCaptcha.php
View file

@ -5,6 +5,7 @@ namespace MediaWiki\Extension\ConfirmEdit\hCaptcha;
use ApiBase; use ApiBase;
use FormatJson; use FormatJson;
use MediaWiki\Auth\AuthenticationRequest; use MediaWiki\Auth\AuthenticationRequest;
use MediaWiki\Config\Config;
use MediaWiki\Context\RequestContext; use MediaWiki\Context\RequestContext;
use MediaWiki\Extension\ConfirmEdit\Auth\CaptchaAuthenticationRequest; use MediaWiki\Extension\ConfirmEdit\Auth\CaptchaAuthenticationRequest;
use MediaWiki\Extension\ConfirmEdit\Hooks; use MediaWiki\Extension\ConfirmEdit\Hooks;
@ -18,14 +19,19 @@ use MediaWiki\Request\WebRequest;
use MediaWiki\Status\Status; use MediaWiki\Status\Status;
class HCaptcha extends SimpleCaptcha { class HCaptcha extends SimpleCaptcha {
// used for hcaptcha-edit, hcaptcha-addurl, hcaptcha-badlogin, hcaptcha-createaccount, /**
// hcaptcha-create, hcaptcha-sendemail via getMessage() * @var string used for hcaptcha-edit, hcaptcha-addurl, hcaptcha-badlogin, hcaptcha-createaccount,
* hcaptcha-create, hcaptcha-sendemail via getMessage()
*/
protected static $messagePrefix = 'hcaptcha-'; protected static $messagePrefix = 'hcaptcha-';
/** @var string|null */
private $error = null; private $error = null;
/** @var Config */
private $hCaptchaConfig; private $hCaptchaConfig;
/** @var string */
private $siteKey; private $siteKey;
public function __construct() { public function __construct() {

1
includes/Hooks.php
View file

@ -53,6 +53,7 @@ class Hooks implements
AuthChangeFormFieldsHook AuthChangeFormFieldsHook
{ {
/** @var bool */
protected static $instanceCreated = false; protected static $instanceCreated = false;
private WANObjectCache $cache; private WANObjectCache $cache;

1
includes/Store/CaptchaHashStore.php
View file

@ -3,6 +3,7 @@
namespace MediaWiki\Extension\ConfirmEdit\Store; namespace MediaWiki\Extension\ConfirmEdit\Store;
class CaptchaHashStore extends CaptchaStore { class CaptchaHashStore extends CaptchaStore {
/** @var array */
protected $data = []; protected $data = [];
/** /**