PPP\Wikidata\ValueFormatters\JsonLd\Entity\ExtendedJsonLdEntityFormatter

Complexity

Total Complexity

15

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

95.24%

Importance

Changes	3
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	format()	0	7	2
A	toJsonLd()	0	13	3
A	addFingerprintAliasesToResource()	0	13	3
B	addStatementListToResource()	0	12	5
A	newResourceFromTerm()	0	6	1

<?php

namespace PPP\Wikidata\ValueFormatters\JsonLd\Entity;

use InvalidArgumentException;
use OutOfBoundsException;
use stdClass;
use ValueFormatters\FormatterOptions;
use ValueFormatters\ValueFormatter;
use ValueFormatters\ValueFormatterBase;
use Wikibase\DataModel\Entity\EntityDocument;
use Wikibase\DataModel\Statement\StatementList;
use Wikibase\DataModel\StatementListProvider;
use Wikibase\DataModel\Term\Fingerprint;
use Wikibase\DataModel\Term\FingerprintProvider;
use Wikibase\DataModel\Term\Term;

/**
 * @licence GPLv2+
 * @author Thomas Pellissier Tanon
 */
class ExtendedJsonLdEntityFormatter extends ValueFormatterBase {

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

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

	/**
	 * @param ValueFormatter $entityFormatter
	 * @param ValueFormatter $snakFormatter
	 * @param FormatterOptions $options
	 */
	public function __construct(ValueFormatter $entityFormatter, ValueFormatter $snakFormatter, FormatterOptions $options) {

		$this->entityFormatter = $entityFormatter;
		$this->snakFormatter = $snakFormatter;

		parent::__construct($options);
	}

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

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

	private function toJsonLd(EntityDocument $entity) {
		$resource = $this->entityFormatter->format($entity);

		if($entity instanceof FingerprintProvider) {
			$this->addFingerprintAliasesToResource($entity->getFingerprint(), $resource);
		}

		if($entity instanceof StatementListProvider) {
			$this->addStatementListToResource($entity->getStatements(), $resource);
		}

		return $resource;
	}

	private function addFingerprintAliasesToResource(Fingerprint $fingerprint, stdClass $resource) {
		$languageCode = $this->getOption(ValueFormatter::OPT_LANG);

		try {
			$aliasGroup = $fingerprint->getAliasGroup($languageCode);
			$resource->alternateName = array();
			foreach($aliasGroup->getAliases() as $alias) {
				$resource->alternateName[] = $this->newResourceFromTerm(new Term($aliasGroup->getLanguageCode(), $alias));
			}
		} catch(OutOfBoundsException $e) {
			//Just ignore it
		}
	}

	private function addStatementListToResource(StatementList $statementList, stdClass $resource) {
		foreach($statementList->getBestStatements()->getMainSnaks() as $snak) {
			$formatted = $this->snakFormatter->format($snak);

			foreach($formatted as $property => $value) {
				if(isset($resource->{$property}) && !is_array($resource->{$property})) {
					continue; //We do not allow to edit special properties
				}
				$resource->{$property}[] = $value;
			}
		}
	}

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