wikimedia / mediawiki-extensions-Wikibase

repo/includes/Hooks/InfoActionHookHandler.php

<?php

namespace Wikibase\Repo\Hooks;

use Html;
use IContextSource;
use PageProps;
use SiteLookup;
use Title;
use Wikibase\Lib\Store\EntityIdLookup;
use Wikibase\Lib\Store\EntityNamespaceLookup;
use Wikibase\Repo\Store\SubscriptionLookup;

/**
 * @license GPL-2.0-or-later
 * @author Amir Sarabadani <ladsgroup@gmail.com>
 */
class InfoActionHookHandler {

	/**
	 * @var EntityNamespaceLookup
	 */
	private $namespaceChecker;

	/**
	 * @var SubscriptionLookup
	 */
	private $subscriptionLookup;

	/**
	 * @var SiteLookup
	 */
	private $siteLookup;

	/**
	 * @var EntityIdLookup
	 */
	private $entityIdLookup;

	/**
	 * @var IContextSource
	 */
	private $context;

	/**
	 * @var PageProps
	 */
	private $pageProps;

	public function __construct(
		EntityNamespaceLookup $namespaceChecker,
		SubscriptionLookup $subscriptionLookup,
		SiteLookup $siteLookup,
		EntityIdLookup $entityIdLookup,
		IContextSource $context,
		PageProps $pageProps
	) {
		$this->namespaceChecker = $namespaceChecker;
		$this->subscriptionLookup = $subscriptionLookup;
		$this->siteLookup = $siteLookup;
		$this->entityIdLookup = $entityIdLookup;
		$this->context = $context;
		$this->pageProps = $pageProps;
	}

	/**
	 * @param IContextSource $context
	 * @param array $pageInfo
	 *
	 * @return array[]
	 */
	public function handle( IContextSource $context, array $pageInfo ) {
		// Check if wikibase namespace is enabled
		$title = $context->getTitle();

		if ( $this->namespaceChecker->isNamespaceWithEntities( $title->getNamespace() )
			&& $title->exists()
		) {
			$pageInfo['header-properties'][] = $this->getSubscriptionsInfo( $title );
			$pageInfo['header-basic'] = array_merge( $pageInfo['header-basic'], $this->getStatementsInfo( $title ) );
		}

		return $pageInfo;
	}

	/**
	 * @param Title $title
	 *
	 * @return string[] HTML
	 */
	private function getSubscriptionsInfo( Title $title ) {
		$entity = $this->entityIdLookup->getEntityIdForTitle( $title );

		if ( $entity === null ) {
			return $this->getNoSubscriptionText();
		}

		$subscriptions = $this->subscriptionLookup->getSubscribers( $entity );

		if ( $subscriptions ) {

The expression $subscriptions of type string[] is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

			return $this->formatSubscriptions( $subscriptions, $title );
		}

		return $this->getNoSubscriptionText();
	}

	/**
	 * @param Title $title
	 *
	 * @return string[] HTML
	 */
	private function getStatementsInfo( Title $title ) {

		$properties = $this->pageProps->getProperties( $title, [ 'wb-claims', 'wb-identifiers' ] );

		if ( $properties ) {
			return $this->formatProperties( $properties );
		}

		return [];
	}

	/**
	 * @param array $properties
	 *
	 * @return string[] HTML
	 */
	private function formatProperties( array $properties ) {
		$output = [];

		foreach ( $properties as $pageId => $pageProperties ) {
			foreach ( $pageProperties as $property => $value ) {
				$output[] = [
					$this->context->msg( 'wikibase-pageinfo-' . $property )->parse(),
					$this->context->getLanguage()->formatNum( (int)$value )
				];
			}
		}

		return $output;
	}

	/**
	 * @param string[] $subscriptions
	 * @param Title $title
	 *
	 * @return string[] HTML
	 */
	private function formatSubscriptions( array $subscriptions, Title $title ) {
		$output = '';

		foreach ( $subscriptions as $subscription ) {
			$link = $this->formatSubscription( $subscription, $title );
			$output .= Html::rawElement( 'li', [], $link );

		}
		$output = Html::rawElement( 'ul', [], $output );
		return [ $this->context->msg( 'wikibase-pageinfo-subscription' )->parse(), $output ];
	}

	/**
	 * @return string[] HTML
	 */
	private function getNoSubscriptionText() {
		return [
			$this->context->msg( 'wikibase-pageinfo-subscription' )->parse(),
			$this->context->msg( 'wikibase-pageinfo-subscription-none' )->parse()
		];
	}

	/**
	 * @param string $subscription
	 * @param Title $title
	 *
	 * @return string HTML
	 */
	private function formatSubscription( $subscription, Title $title ) {
		$site = $this->siteLookup->getSite( $subscription );
		if ( $site === null ) {
			return $subscription;
		}

		$url = $site->getPageUrl( 'Special:EntityUsage/' . $title->getText() );
		if ( $url === false ) {
			return $subscription;
		}

		return Html::element( 'a',
			[ 'href' => $url ],
			$subscription
		);
	}

}