wikimedia/mediawiki-extensions-Wikibase

<?php

namespace Wikibase\Lib\Changes;

use InvalidArgumentException;
use Serializable;
use Wikimedia\Assert\Assert;

/**
 * This class holds a very compact and simple representation of an Entity diff for
 * propagating repo changes to clients (T113468).
 * This can also be used for entity types which don't have all aspects mentioned here,
 * the aspects are represented as unchanged in that case.
 *
 * @license GPL-2.0-or-later
 * @author Marius Hoch
 */
class EntityDiffChangedAspects implements Serializable {

    /**
     * Increases whenever the array format (self::toArray) changes
     */
    public const ARRAYFORMATVERSION = 1;

    /**
     * Language codes of the labels that changed (added, removed or updated)
     *
     * @var string[]
     */
    private $labelChanges;

    /**
     * Language codes of the descriptions that changed (added, removed or updated)
     *
     * @var string[]
     */
    private $descriptionChanges;

    /**
     * Property id serialization from the statements that changed (added, removed or updated)
     *
     * @var string[]
     */
    private $statementChanges;

    /**
     * Map of site ids to array of old value, new value and boolean value determining if badge
     * has changed or not
     *
     * @var array[]
     */
    private $siteLinkChanges;

    /**
     * Other changes that are not covered in above, like aliases
     *
     * @var bool
     */
    private $otherChanges;

    /**
     * Note: If an entity doesn't have a certain aspect, just report that no changes happened (empty array).
     *
     * @param string[] $labelChanges Language codes of the labels that changed (added, removed or updated)
     * @param string[] $descriptionChanges Language codes of the descriptions that changed (added, removed or updated)
     * @param string[] $statementChanges Property id serialization from the statements that changed (added, removed or updated)
     * @param array[] $siteLinkChanges Map of global site identifiers to [ string|null $oldPageName,
     *  string|null $newPageName, bool $badgesChanged ]
     * @param bool $otherChanges Do we have changes that are not covered more specifically?
     */
    public function __construct(
        array $labelChanges,
        array $descriptionChanges,
        array $statementChanges,
        array $siteLinkChanges,
        $otherChanges
    ) {
        Assert::parameterElementType( 'string', $labelChanges, '$labelChanges' );
        Assert::parameterElementType( 'string', $descriptionChanges, '$descriptionChanges' );
        Assert::parameterElementType( 'string', $statementChanges, '$statementChanges' );
        Assert::parameterElementType( 'string', array_keys( $siteLinkChanges ), 'array_keys( $siteLinkChanges )' );
        Assert::parameterElementType( 'array', $siteLinkChanges, '$siteLinkChanges' );
        Assert::parameterType( 'boolean', $otherChanges, '$otherChanges' );

        $this->labelChanges = $labelChanges;
        $this->descriptionChanges = $descriptionChanges;
        $this->statementChanges = $statementChanges;
        $this->siteLinkChanges = $siteLinkChanges;
        $this->otherChanges = $otherChanges;
    }

    /**
     * Language codes of the labels that changed (added, removed or updated)
     *
     * @return string[]
     */
    public function getLabelChanges() {
        return $this->labelChanges;
    }

    /**
     * Language codes of the descriptions that changed (added, removed or updated)
     *
     * @return string[]
     */
    public function getDescriptionChanges() {
        return $this->descriptionChanges;
    }

    /**
     * Property id serialization from the statements that changed (added, removed or updated)
     *
     * @return string[]
     */
    public function getStatementChanges() {
        return $this->statementChanges;
    }

    /**
     * Map of site ids to array of old value, new value and boolean value determining if badge
     * has changed or not
     *
     * @return array[]
     */
    public function getSiteLinkChanges() {
        return $this->siteLinkChanges;
    }

    /**
     * Do we have changes that are not covered more specifically?
     *
     * @return bool
     */
    public function hasOtherChanges() {
        return $this->otherChanges;
    }

    /**
     * @see Serializable::serialize
     *
     * @return string JSON
     */
    public function serialize(): string {
        return json_encode( $this->__serialize() );
    }

    public function __serialize(): array {
        return $this->toArray();
    }

    /**
     * @see Serializable::unserialize
     *
     * @param string $serialized JSON
     */
    public function unserialize( $serialized ) {
        $this->__unserialize( json_decode( $serialized, true ) );
    }

    public function __unserialize( array $data ): void {
        if ( $data['arrayFormatVersion'] !== self::ARRAYFORMATVERSION ) {
            throw new InvalidArgumentException( 'Unsupported format version ' . $data['arrayFormatVersion'] );
        }

        $this->labelChanges = $data['labelChanges'];
        $this->descriptionChanges = $data['descriptionChanges'];
        $this->statementChanges = array_values( (array)$data['statementChanges'] );
        $this->siteLinkChanges = (array)$data['siteLinkChanges'];
        $this->otherChanges = $data['otherChanges'];
    }

    /**
     * @return array
     */
    public function toArray(): array {
        return [
            'arrayFormatVersion' => self::ARRAYFORMATVERSION,
            'labelChanges' => $this->getLabelChanges(),
            'descriptionChanges' => $this->getDescriptionChanges(),
            'statementChanges' => $this->getStatementChanges(),
            'siteLinkChanges' => $this->getSiteLinkChanges(),
            'otherChanges' => $this->hasOtherChanges(),
        ];
    }

}