wikimedia/mediawiki-extensions-Wikibase

View on GitHub
lib/includes/Store/EntityTermStoreWriter.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php

namespace Wikibase\Lib\Store;

use InvalidArgumentException;
use Wikibase\DataModel\Entity\EntityDocument;
use Wikibase\DataModel\Entity\EntityId;

/**
 * @license GPL-2.0-or-later
 */
interface EntityTermStoreWriter {

    /**
     * Saves the terms of the provided entity in the term cache.
     *
     * @param EntityDocument $entity Must have an ID, and optionally any combination of terms as
     *  declared by the TermIndexEntry::TYPE_... constants.
     *
     * @throws InvalidArgumentException when $entity does not have an ID.
     * @return bool Success indicator
     */
    public function saveTermsOfEntity( EntityDocument $entity );

    /**
     * Deletes the terms of the provided entity from the term cache.
     *
     * @param EntityId $entityId
     *
     * @return bool Success indicator
     */
    public function deleteTermsOfEntity( EntityId $entityId );

}