WikibaseQuality\ExternalValidation\Specials\SpecialExternalDatabases

Complexity

Total Complexity

10

Size/Duplication

Total Lines	164
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	newFromGlobalState()	0	10	1
A	__construct()	0	12	1
A	getGroupName()	0	3	1
A	getDescription()	0	3	1
B	execute()	0	48	4
B	getRowGroup()	0	37	2

<?php

namespace WikibaseQuality\ExternalValidation\Specials;

use Html;
use Language;
use Linker;
use SpecialPage;
use Wikibase\DataModel\Services\Lookup\LanguageLabelDescriptionLookup;
use Wikibase\DataModel\Services\Lookup\TermLookup;
use Wikibase\Repo\EntityIdHtmlLinkFormatterFactory;
use Wikibase\Repo\WikibaseRepo;
use WikibaseQuality\ExternalValidation\DumpMetaInformation\DumpMetaInformation;
use WikibaseQuality\ExternalValidation\DumpMetaInformation\DumpMetaInformationLookup;
use WikibaseQuality\ExternalValidation\DumpMetaInformation\SqlDumpMetaInformationRepo;
use WikibaseQuality\ExternalValidation\ExternalValidationServices;
use WikibaseQuality\Html\HtmlTableBuilder;
use WikibaseQuality\Html\HtmlTableCellBuilder;

class SpecialExternalDatabases extends SpecialPage {

	/**
	 * @var EntityIdHtmlLinkFormatterFactory
	 */
	private $entityIdLinkFormatter;

	/**
	 * @var SqlDumpMetaInformationRepo
	 */
	private $dumpMetaInformationRepo;

	/**
	 * Creates new instance from global state.
	 *
	 * @return self
	 */
	public static function newFromGlobalState() {
		$repo = WikibaseRepo::getDefaultInstance();
		$externalValidationServices = ExternalValidationServices::getDefaultInstance();

		return new self(
			$repo->getTermLookup(),
			$repo->getEntityIdHtmlLinkFormatterFactory(),
			$externalValidationServices->getDumpMetaInformationLookup()
		);
	}

	/**
	 * @param TermLookup $termLookup
	 * @param EntityIdHtmlLinkFormatterFactory $entityIdHtmlLinkFormatterFactory
	 * @param DumpMetaInformationLookup $dumpMetaInformationRepo
	 */
	public function __construct(
		TermLookup $termLookup,
		EntityIdHtmlLinkFormatterFactory $entityIdHtmlLinkFormatterFactory,
		DumpMetaInformationLookup $dumpMetaInformationRepo ) {
		parent::__construct( 'ExternalDatabases' );

		$this->entityIdLinkFormatter = $entityIdHtmlLinkFormatterFactory->getEntityIdFormatter(
			new LanguageLabelDescriptionLookup( $termLookup, $this->getLanguage()->getCode() )
		);

		$this->dumpMetaInformationRepo = $dumpMetaInformationRepo;

$dumpMetaInformationRepo is of type object<WikibaseQuality\ExternalValidation\DumpMetaInformation\DumpMetaInformationLookup>, but the property $dumpMetaInformationRepo was declared to be of type object<WikibaseQuality\ExternalValidation\DumpMetaInformation\SqlDumpMetaInformationRepo>. Are you sure that you always receive this specific sub-class here, or does it make sense to add an instanceof check?

	}

	/**
	 * @see SpecialPage::getGroupName
	 *
	 * @return string
	 */
	function getGroupName() {

It is generally recommended to explicitly declare the visibility for methods.

		return 'wikibasequality';
	}

	/**
	 * @see SpecialPage::getDescription
	 *
	 * @return string
	 */
	public function getDescription() {
		return $this->msg( 'wbqev-externaldbs' )->text();
	}

	/**
	 * @see SpecialPage::execute
	 *
	 * @param string|null $subPage
	 */
	public function execute( $subPage ) {
		$out = $this->getOutput();

		$this->setHeaders();

		$out->addHTML(
			Html::openElement( 'p' )
			. $this->msg( 'wbqev-externaldbs-instructions' )->parse()
			. Html::closeElement( 'p' )
			. Html::openElement( 'h3' )
			. $this->msg( 'wbqev-externaldbs-overview-headline' )->parse()
			. Html::closeElement( 'h3' )
		);

		$dumps = $this->dumpMetaInformationRepo->getAll();
		if ( count( $dumps ) > 0 ) {
			$groupedDumpMetaInformation = array();
			foreach ( $dumps as $dump ) {

The expression $dumps of type null|array is not guaranteed to be traversable. How about adding an additional type check?

				$sourceItemId = $dump->getSourceItemId()->getSerialization();
				$groupedDumpMetaInformation[$sourceItemId][] = $dump;
			}

			$table = new HtmlTableBuilder(
				array(
					$this->msg( 'wbqev-externaldbs-name' )->escaped(),
					$this->msg( 'wbqev-externaldbs-id' )->escaped(),
					$this->msg( 'wbqev-externaldbs-import-date' )->escaped(),
					$this->msg( 'wbqev-externaldbs-language' )->escaped(),
					$this->msg( 'wbqev-externaldbs-source-urls' )->escaped(),
					$this->msg( 'wbqev-externaldbs-size' )->escaped(),
					$this->msg( 'wbqev-externaldbs-license' )->escaped()
				),
				true
			);

			foreach ( $groupedDumpMetaInformation as $dumpMetaInformation ) {
				$table->appendRows( $this->getRowGroup( $dumpMetaInformation ) );
			}

			$out->addHTML( $table->toHtml() );
		} else {
			$out->addHTML(
				Html::openElement( 'p' )
				. $this->msg( 'wbqev-externaldbs-no-databases' )->escaped()
				. Html::closeElement( 'p' )
			);
		}
	}

	/**
	 * Build grouped rows for dump meta information with same source item id
	 *
	 * @param DumpMetaInformation[] $dumpMetaInformationGroup
	 *
	 * @return array
	 */
	private function getRowGroup( array $dumpMetaInformationGroup ) {
		$rows = array();

		foreach ( $dumpMetaInformationGroup as $dumpMetaInformation ) {
			$dumpId = $dumpMetaInformation->getDumpId();
			$importDate = $this->getLanguage()->timeanddate( $dumpMetaInformation->getImportDate() );
			$language = Language::fetchLanguageName(
				$dumpMetaInformation->getLanguageCode(),
				$this->getLanguage()->getCode()
			);
			$sourceUrl = Linker::makeExternalLink(
				$dumpMetaInformation->getSourceUrl(),
				$dumpMetaInformation->getSourceUrl()
			);
			$size = $this->getLanguage()->formatSize( $dumpMetaInformation->getSize() );
			$license = $this->entityIdLinkFormatter->formatEntityId( $dumpMetaInformation->getLicenseItemId() );
			$rows[] = array(
				new HtmlTableCellBuilder( $dumpId ),
				new HtmlTableCellBuilder( $importDate ),
				new HtmlTableCellBuilder( $language ),
				new HtmlTableCellBuilder( $sourceUrl, array(), true ),
				new HtmlTableCellBuilder( $size ),
				new HtmlTableCellBuilder( $license, array(), true )
			);
		}

		array_unshift(
			$rows[0],
			new HtmlTableCellBuilder(
				$this->entityIdLinkFormatter->formatEntityId( $dumpMetaInformationGroup[0]->getSourceItemId() ),
				array( 'rowspan' => (string)count( $dumpMetaInformationGroup ) ),
				true
			)
		);

		return $rows;
	}

}