WikibaseQuality\ConstraintReport\ConstraintCheck\Result\CheckResultSerializer

Complexity

Total Complexity

8

Size/Duplication

Total Lines	126
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	1
B	serialize()	0	25	3
A	serializeCachingMetadata()	0	11	2
A	serializeDependencyMetadata()	0	21	2

<?php

namespace WikibaseQuality\ConstraintReport\ConstraintCheck\Result;

use Wikibase\DataModel\Entity\EntityId;
use WikibaseQuality\ConstraintReport\ConstraintCheck\Cache\CachingMetadata;
use WikibaseQuality\ConstraintReport\ConstraintCheck\Context\ContextCursorSerializer;
use WikibaseQuality\ConstraintReport\ConstraintCheck\Message\ViolationMessageSerializer;
use WikibaseQuality\ConstraintReport\ConstraintSerializer;

/**
 * A serializer for {@link CheckResult}s.
 * Note that serializing the {@link CheckResult::getParameters parameters} is not (yet?) supported.
 *
 * @author Lucas Werkmeister
 * @license GPL-2.0-or-later
 */
class CheckResultSerializer {

	const KEY_CONTEXT_CURSOR = '|';
	const KEY_CONSTRAINT = 'c';
	const KEY_CHECK_RESULT_STATUS = 's';
	const KEY_VIOLATION_MESSAGE = 'm';
	const KEY_CACHING_METADATA = 'CM';
	const KEY_DEPENDENCY_METADATA = 'DM';

	const KEY_CACHING_METADATA_MAX_AGE = 'a';

	const KEY_DEPENDENCY_METADATA_ENTITY_IDS = 'e';
	const KEY_DEPENDENCY_METADATA_FUTURE_TIME = 'f';

	/**
	 * @var ConstraintSerializer
	 */
	private $constraintSerializer;

	/**
	 * @var ContextCursorSerializer
	 */
	private $contextCursorSerializer;

	/**
	 * @var ViolationMessageSerializer
	 */
	private $violationMessageSerializer;

	/**
	 * @var bool
	 */
	private $serializeDependencyMetadata;

	/**
	 * @param ConstraintSerializer $constraintSerializer
	 * @param ContextCursorSerializer $contextCursorSerializer
	 * @param ViolationMessageSerializer $violationMessageSerializer
	 * @param bool $serializeDependencyMetadata Whether to serialize the DependencyMetadata component
	 * of a result’s {@link CheckResult::getMetadata metadata} or not.
	 */
	public function __construct(
		ConstraintSerializer $constraintSerializer,
		ContextCursorSerializer $contextCursorSerializer,
		ViolationMessageSerializer $violationMessageSerializer,
		$serializeDependencyMetadata = true
	) {
		$this->constraintSerializer = $constraintSerializer;
		$this->contextCursorSerializer = $contextCursorSerializer;
		$this->violationMessageSerializer = $violationMessageSerializer;
		$this->serializeDependencyMetadata = $serializeDependencyMetadata;
	}

	/**
	 * @param CheckResult $checkResult
	 * @return array
	 */
	public function serialize( CheckResult $checkResult ) {
		$contextCursor = $checkResult->getContextCursor();
		$constraint = $checkResult->getConstraint();
		$violationMessage = $checkResult->getMessage();
		$cachingMetadata = $checkResult->getMetadata()->getCachingMetadata();

		$serialization = [
			self::KEY_CONTEXT_CURSOR => $this->contextCursorSerializer->serialize( $contextCursor ),
			self::KEY_CONSTRAINT => $this->constraintSerializer->serialize( $constraint ),
			self::KEY_CHECK_RESULT_STATUS => $checkResult->getStatus(),
			self::KEY_CACHING_METADATA => $this->serializeCachingMetadata( $cachingMetadata ),
		];

		if ( $violationMessage !== null ) {
			$serialization[self::KEY_VIOLATION_MESSAGE] =
				$this->violationMessageSerializer->serialize( $violationMessage );

It seems like $violationMessage defined by $checkResult->getMessage() on line 78 can also be of type string; however, WikibaseQuality\ConstraintReport\ConstraintCheck\Message\ViolationMessageSerializer::serialize() does only seem to accept object<WikibaseQuality\ConstraintReport\ConstraintCheck\Message\ViolationMessage>, maybe add an additional type check?

		}

		if ( $this->serializeDependencyMetadata ) {
			$serialization[self::KEY_DEPENDENCY_METADATA] =
				$this->serializeDependencyMetadata( $checkResult );
		}

		return $serialization;
	}

	/**
	 * @param CachingMetadata $cachingMetadata
	 * @return array
	 */
	private function serializeCachingMetadata( CachingMetadata $cachingMetadata ) {
		$maximumAge = $cachingMetadata->getMaximumAgeInSeconds();

		$serialization = [];

		if ( $maximumAge > 0 ) {
			$serialization[self::KEY_CACHING_METADATA_MAX_AGE] = $maximumAge;
		}

		return $serialization;
	}

	/**
	 * @param CheckResult $checkResult
	 * @return array
	 */
	private function serializeDependencyMetadata( CheckResult $checkResult ) {
		$dependencyMetadata = $checkResult->getMetadata()->getDependencyMetadata();
		$entityIds = $dependencyMetadata->getEntityIds();
		$futureTime = $dependencyMetadata->getFutureTime();

		$serialization = [
			self::KEY_DEPENDENCY_METADATA_ENTITY_IDS => array_map(
				function ( EntityId $entityId ) {
					return $entityId->getSerialization();
				},
				$entityIds
			),
		];

		if ( $futureTime !== null ) {
			$serialization[self::KEY_DEPENDENCY_METADATA_FUTURE_TIME] =
				$futureTime->getArrayValue();
		}

		return $serialization;
	}

}