PPP\Wikidata\ValueFormatters\ExtendedJsonLdItemFormatter

Complexity

Total Complexity

14

Size/Duplication

Total Lines	127
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Test Coverage

Coverage

98.7%

Importance

Changes	3
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	1
A	format()	0	7	2
A	toJsonLd()	0	15	1
A	addSiteLinksContentToResource()	0	13	3
B	addArticleToResource()	0	28	3
A	addImageToResource()	0	9	1
A	newViewAction()	0	11	2
A	newResourceFromTerm()	0	6	1

<?php

namespace PPP\Wikidata\ValueFormatters;

use InvalidArgumentException;
use OutOfBoundsException;
use PPP\Wikidata\Wikipedia\MediawikiArticle;
use PPP\Wikidata\Wikipedia\MediawikiArticleImage;
use PPP\Wikidata\Wikipedia\MediawikiArticleProvider;
use stdClass;
use ValueFormatters\FormatterOptions;
use ValueFormatters\ValueFormatter;
use ValueFormatters\ValueFormatterBase;
use Wikibase\DataModel\Entity\Item;
use Wikibase\DataModel\SiteLinkList;
use Wikibase\DataModel\Term\Term;

/**
 * Returns the label of a given Wikibase entity id
 *
 * @licence GPLv2+
 * @author Thomas Pellissier Tanon
 */
class ExtendedJsonLdItemFormatter extends ValueFormatterBase {

	/**
	 * @var ValueFormatter
	 */
	private $itemFormatter;

	/**
	 * @var MediawikiArticleProvider
	 */
	private $articleProvider;

	/**
	 * @param ValueFormatter $itemFormatter
	 * @param MediawikiArticleProvider $articleProvider
	 * @param FormatterOptions $options
	 */
	public function __construct(
		ValueFormatter $itemFormatter,
		MediawikiArticleProvider $articleProvider,
		FormatterOptions $options
	) {
		$this->itemFormatter = $itemFormatter;
		$this->articleProvider = $articleProvider;

		parent::__construct($options);
	}

	/**
	 * @see ValueFormatter::format
	 */
	public function format($value) {
		if(!($value instanceof Item)) {
			throw new InvalidArgumentException('$value is not an Item');
		}

		return $this->toJsonLd($value);
	}

	private function toJsonLd(Item $item) {
		$resource = $this->itemFormatter->format($item);

		$resource->potentialAction = array(
			$this->newViewAction(
				array(new Term('en', 'View on Wikidata'), new Term('fr', 'Voir sur Wikidata')),
				'//upload.wikimedia.org/wikipedia/commons/f/ff/Wikidata-logo.svg',
				'//www.wikidata.org/entity/' . $item->getId()->getSerialization()
			)
		);

		$this->addSiteLinksContentToResource($item->getSiteLinkList(), $resource);

		return $resource;
	}

	private function addSiteLinksContentToResource(SiteLinkList $siteLinkList, stdClass $resource) {
		$wikiId = $this->getOption(ValueFormatter::OPT_LANG) . 'wiki';

		if(!$this->articleProvider->isWikiIdSupported($wikiId)) {
			return;
		}

		try {
			$article = $this->articleProvider->getArticleForSiteLink($siteLinkList->getBySiteId($wikiId));
			$this->addArticleToResource($article, $resource);
		} catch(OutOfBoundsException $e) {

Consider adding a comment why this CATCH block is empty.

		}
	}

	private function addArticleToResource(MediawikiArticle $article, stdClass $resource) {
		$articleResource = new stdClass();
		$articleResource->{'@type'} = 'Article';
		$articleResource->{'@id'} = $article->getUrl();
		$articleResource->inLanguage = $article->getLanguageCode();
		$articleResource->headline = $article->getHeaderText();
		$articleResource->license = 'http://creativecommons.org/licenses/by-sa/3.0/';
		$articleResource->author = new stdClass();
		$articleResource->author->{'@type'} = 'Organization';
		$articleResource->author->{'@id'} = 'http://www.wikidata.org/entity/Q52';
		$articleResource->author->name = 'Wikipedia';

		if(!property_exists($resource, '@reverse')) {
			$resource->{'@reverse'} = new stdClass();
		}
		$resource->{'@reverse'}->about = $articleResource;

		$resource->potentialAction[] = $this->newViewAction(
			array(new Term('en', 'View on Wikipedia'), new Term('fr', 'Voir sur Wikipédia')),
			'//upload.wikimedia.org/wikipedia/commons/thumb/8/80/Wikipedia-logo-v2.svg/64px-Wikipedia-logo-v2.svg.png',
			$article->getUrl()
		);

		$image = $article->getImage();
		if($image !== null) {
			$this->addImageToResource($image, $resource);
		}
	}

	private function addImageToResource(MediawikiArticleImage $image, stdClass $resource) {
		$resource->image = new stdClass();
		$resource->image->{'@type'} = 'ImageObject';
		$resource->image->{'@id'} = 'http://commons.wikimedia.org/wiki/Image:' . str_replace(' ', '_', $image->getTitle()); //TODO configure
		$resource->image->contentUrl = $image->getUrl();
		$resource->image->width = $image->getWidth();
		$resource->image->height = $image->getHeight();
		$resource->image->name = $image->getTitle();
	}

	private function newViewAction(array $nameTerms, $image, $target) {
		$actionResource = new stdClass();
		$actionResource->{'@type'} = 'ViewAction';
		$actionResource->name = array();
		foreach($nameTerms as $term) {
			$actionResource->name[] = $this->newResourceFromTerm($term);
		}
		$actionResource->image = $image;
		$actionResource->target = $target;
		return $actionResource;
	}

	private function newResourceFromTerm(Term $term) {
		$resource = new stdClass();
		$resource->{'@language'} = $term->getLanguageCode();
		$resource->{'@value'} = $term->getText();
		return $resource;
	}
}