wmde / WikibaseDataModelSerialization

src/Deserializers/PropertyDeserializer.php

<?php

namespace Wikibase\DataModel\Deserializers;

use Deserializers\Deserializer;
use Deserializers\Exceptions\DeserializationException;
use Deserializers\TypedObjectDeserializer;
use Wikibase\DataModel\Entity\Property;
use Wikibase\DataModel\Entity\PropertyId;
use Wikibase\DataModel\Statement\StatementList;
use Wikibase\DataModel\Term\AliasGroupList;
use Wikibase\DataModel\Term\TermList;

/**
 * Package private
 *
 * @license GPL-2.0+
 * @author Thomas Pellissier Tanon
 * @author Bene* < benestar.wikimedia@gmail.com >
 */
class PropertyDeserializer extends TypedObjectDeserializer {

	/**
	 * @var Deserializer
	 */
	private $entityIdDeserializer;

	/**
	 * @var Deserializer
	 */
	private $termListDeserializer;

	/**
	 * @var Deserializer
	 */
	private $aliasGroupListDeserializer;

	/**
	 * @var Deserializer
	 */
	private $statementListDeserializer;

	public function __construct(
		Deserializer $entityIdDeserializer,
		Deserializer $termListDeserializer,
		Deserializer $aliasGroupListDeserializer,
		Deserializer $statementListDeserializer
	) {
		parent::__construct( 'property', 'type' );

		$this->entityIdDeserializer = $entityIdDeserializer;
		$this->termListDeserializer = $termListDeserializer;
		$this->aliasGroupListDeserializer = $aliasGroupListDeserializer;
		$this->statementListDeserializer = $statementListDeserializer;
	}

	/**
	 * @see Deserializer::deserialize
	 *
	 * @param array $serialization
	 *
	 * @throws DeserializationException
	 * @return Property
	 */
	public function deserialize( $serialization ) {
		$this->assertCanDeserialize( $serialization );

		return $this->getDeserialized( $serialization );
	}

	/**
	 * @param array $serialization
	 *
	 * @return Property
	 */
	private function getDeserialized( array $serialization ) {
		$this->requireAttribute( $serialization, 'datatype' );

The method Deserializers\TypedObjectDeserializer::requireAttribute() has been deprecated with message: since 4.0, just do your own "if ( array_key_exists( … ) )" or "if ( isset( … ) )" instead

		$this->assertAttributeInternalType( $serialization, 'datatype', 'string' );

The method Deserializers\TypedObjectDeserializer::assertAttributeInternalType() has been deprecated with message: since 4.0, just do your own "if ( is_string( … ) )" and such instead

		$property = Property::newFromType( $serialization['datatype'] );

		$this->setIdFromSerialization( $serialization, $property );
		$this->setTermsFromSerialization( $serialization, $property );
		$this->setStatementListFromSerialization( $serialization, $property );

		return $property;
	}

	private function setIdFromSerialization( array $serialization, Property $property ) {
		if ( !array_key_exists( 'id', $serialization ) ) {
			return;
		}

		/** @var PropertyId $id */
		$id = $this->entityIdDeserializer->deserialize( $serialization['id'] );
		$property->setId( $id );
	}

	private function setTermsFromSerialization( array $serialization, Property $property ) {
		if ( array_key_exists( 'labels', $serialization ) ) {
			$this->assertAttributeIsArray( $serialization, 'labels' );

The method Deserializers\TypedObjectDeserializer::assertAttributeIsArray() has been deprecated with message: since 4.0, just do your own "if ( is_array( … ) )" instead

			/** @var TermList $labels */
			$labels = $this->termListDeserializer->deserialize( $serialization['labels'] );
			$property->getFingerprint()->setLabels( $labels );
		}

		if ( array_key_exists( 'descriptions', $serialization ) ) {
			$this->assertAttributeIsArray( $serialization, 'descriptions' );

The method Deserializers\TypedObjectDeserializer::assertAttributeIsArray() has been deprecated with message: since 4.0, just do your own "if ( is_array( … ) )" instead

			/** @var TermList $descriptions */
			$descriptions = $this->termListDeserializer->deserialize( $serialization['descriptions'] );
			$property->getFingerprint()->setDescriptions( $descriptions );
		}

		if ( array_key_exists( 'aliases', $serialization ) ) {
			$this->assertAttributeIsArray( $serialization, 'aliases' );

The method Deserializers\TypedObjectDeserializer::assertAttributeIsArray() has been deprecated with message: since 4.0, just do your own "if ( is_array( … ) )" instead

			/** @var AliasGroupList $aliases */
			$aliases = $this->aliasGroupListDeserializer->deserialize( $serialization['aliases'] );
			$property->getFingerprint()->setAliasGroups( $aliases );
		}
	}

	private function setStatementListFromSerialization( array $serialization, Property $property ) {
		if ( !array_key_exists( 'claims', $serialization ) ) {
			return;
		}

		/** @var StatementList $statements */
		$statements = $this->statementListDeserializer->deserialize( $serialization['claims'] );
		$property->setStatements( $statements );
	}

}