WikibaseQuality\ConstraintReport\ConstraintCheck\Context\EntityContextCursor

Complexity

Total Complexity

10

Size/Duplication

Total Lines	77
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getType()	0	3	1
A	getEntityId()	0	3	1
A	getStatementPropertyId()	0	3	1
A	getStatementGuid()	0	3	1
A	getSnakPropertyId()	0	3	1
A	getSnakHash()	0	3	1
A	getMainArray()	0	3	1
A	storeCheckResultInArray()	0	7	2

<?php

namespace WikibaseQuality\ConstraintReport\ConstraintCheck\Context;

use LogicException;

/**
 * A context cursor that is only associated with an entity,
 * not with any statement or something else within it.
 * It can only be used to partially populate a results container,
 * not to actually store a full check result.
 *
 * @author Lucas Werkmeister
 * @license GPL-2.0-or-later
 */
class EntityContextCursor extends ApiV2ContextCursor {

	/**
	 * @var string
	 */
	private $entityId;

	/**
	 * @param string $entityId
	 */
	public function __construct(
		$entityId
	) {
		$this->entityId = $entityId;
	}

	/**
	 * @codeCoverageIgnore This method is not supported.
	 */
	public function getType() {
		throw new LogicException( 'EntityContextCursor has no full associated context' );
	}

	public function getEntityId() {
		return $this->entityId;
	}

	/**
	 * @codeCoverageIgnore This method is not supported.
	 */
	public function getStatementPropertyId() {
		throw new LogicException( 'EntityContextCursor has no full associated context' );
	}

	/**
	 * @codeCoverageIgnore This method is not supported.
	 */
	public function getStatementGuid() {
		throw new LogicException( 'EntityContextCursor has no full associated context' );
	}

	/**
	 * @codeCoverageIgnore This method is not supported.
	 */
	public function getSnakPropertyId() {
		throw new LogicException( 'EntityContextCursor has no full associated context' );
	}

	/**
	 * @codeCoverageIgnore This method is not supported.
	 */
	public function getSnakHash() {
		throw new LogicException( 'EntityContextCursor has no full associated context' );
	}

	/**
	 * @codeCoverageIgnore This method is not supported.
	 */
	public function &getMainArray( array &$container ) {
		throw new LogicException( 'EntityContextCursor cannot store check results' );
	}

	/**
	 * Populate the result container up to the 'claims' level.
	 *
	 * @param array|null $result must be null
	 * @param array[] &$container
	 */
	public function storeCheckResultInArray( array $result = null, array &$container ) {
		if ( $result !== null ) {
			throw new LogicException( 'EntityContextCursor cannot store check results' );
		}

		$this->getClaimsArray( $container );
	}

}