mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/DiscussionTools
synced 2024-11-14 19:35:38 +00:00
69e8e948b2
MediaWiki's PHPCS plugin requires documentation comments on all methods, unless those methods are fully typed (all parameters and return value). It turns out that almost all of our methods are fully typed already. Procedure: 1. Find: \*(\s*\*\s*(@param \??[\w\\]+(\|null)? &?\$\w+|@return \??[\w\\]+(\|null)?)\n)+\s*\*/ Replace with: */ This deletes type annotations, except those not representable as PHP type hints such as union types `a|b` or typed arrays `a[]`, or those with documentation beyond type hints, or those on functions with any other annotations. 2. Find: /\*\*/\n\s* Replace with nothing This deletes the remaining comments on methods that had no prose documentation. 3. Undo all changes that PHPCS complains about (those comments were not redundant) 4. Review the diff carefully, these regexps are imprecise :) Change-Id: Ic82e8b23f2996f44951208dbd9cfb4c8e0738dac
114 lines
2.2 KiB
PHP
114 lines
2.2 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Extension\DiscussionTools\ThreadItem;
|
|
|
|
use JsonSerializable;
|
|
use MediaWiki\Page\ProperPageIdentity;
|
|
use MediaWiki\Revision\RevisionRecord;
|
|
|
|
class DatabaseThreadItem implements JsonSerializable, ThreadItem {
|
|
use ThreadItemTrait;
|
|
|
|
private ProperPageIdentity $page;
|
|
private RevisionRecord $rev;
|
|
private string $type;
|
|
private string $name;
|
|
private string $id;
|
|
private ?DatabaseThreadItem $parent;
|
|
/** @var DatabaseThreadItem[] */
|
|
private array $replies = [];
|
|
/** @var string|bool */
|
|
private $transcludedFrom;
|
|
private int $level;
|
|
|
|
/**
|
|
* @param ProperPageIdentity $page
|
|
* @param RevisionRecord $rev
|
|
* @param string $type
|
|
* @param string $name
|
|
* @param string $id
|
|
* @param DatabaseThreadItem|null $parent
|
|
* @param bool|string $transcludedFrom
|
|
* @param int $level
|
|
*/
|
|
public function __construct(
|
|
ProperPageIdentity $page, RevisionRecord $rev,
|
|
string $type, string $name, string $id, ?DatabaseThreadItem $parent, $transcludedFrom, int $level
|
|
) {
|
|
$this->page = $page;
|
|
$this->rev = $rev;
|
|
$this->name = $name;
|
|
$this->id = $id;
|
|
$this->type = $type;
|
|
$this->parent = $parent;
|
|
$this->transcludedFrom = $transcludedFrom;
|
|
$this->level = $level;
|
|
}
|
|
|
|
public function getPage(): ProperPageIdentity {
|
|
return $this->page;
|
|
}
|
|
|
|
public function getRevision(): RevisionRecord {
|
|
return $this->rev;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function getName(): string {
|
|
return $this->name;
|
|
}
|
|
|
|
/**
|
|
* @param DatabaseThreadItem $reply Reply comment
|
|
*/
|
|
public function addReply( DatabaseThreadItem $reply ): void {
|
|
$this->replies[] = $reply;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function getId(): string {
|
|
return $this->id;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function getType(): string {
|
|
return $this->type;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
* @return DatabaseThreadItem|null
|
|
*/
|
|
public function getParent(): ?ThreadItem {
|
|
return $this->parent;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
* @return DatabaseThreadItem[]
|
|
*/
|
|
public function getReplies(): array {
|
|
return $this->replies;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function getTranscludedFrom() {
|
|
return $this->transcludedFrom;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function getLevel(): int {
|
|
return $this->level;
|
|
}
|
|
}
|