wikimedia/mediawiki-extensions-Wikibase

<?php declare( strict_types = 1 );

namespace Wikibase\Repo\RestApi\Application\UseCases\SetItemDescription;

use Wikibase\Repo\RestApi\Application\UseCases\AssertItemExists;
use Wikibase\Repo\RestApi\Application\UseCases\AssertUserIsAuthorized;
use Wikibase\Repo\RestApi\Application\UseCases\ItemRedirect;
use Wikibase\Repo\RestApi\Application\UseCases\UpdateExceptionHandler;
use Wikibase\Repo\RestApi\Application\UseCases\UseCaseError;
use Wikibase\Repo\RestApi\Domain\Model\DescriptionEditSummary;
use Wikibase\Repo\RestApi\Domain\Model\EditMetadata;
use Wikibase\Repo\RestApi\Domain\Services\ItemUpdater;
use Wikibase\Repo\RestApi\Domain\Services\ItemWriteModelRetriever;

/**
 * @license GPL-2.0-or-later
 */
class SetItemDescription {

    use UpdateExceptionHandler;

    private SetItemDescriptionValidator $validator;
    private AssertItemExists $assertItemExists;
    private ItemWriteModelRetriever $itemRetriever;
    private ItemUpdater $itemUpdater;
    private AssertUserIsAuthorized $assertUserIsAuthorized;

    public function __construct(
        SetItemDescriptionValidator $validator,
        AssertItemExists $assertItemExists,
        ItemWriteModelRetriever $itemRetriever,
        ItemUpdater $itemUpdater,
        AssertUserIsAuthorized $assertUserIsAuthorized
    ) {
        $this->validator = $validator;
        $this->assertItemExists = $assertItemExists;
        $this->itemRetriever = $itemRetriever;
        $this->itemUpdater = $itemUpdater;
        $this->assertUserIsAuthorized = $assertUserIsAuthorized;
    }

    /**
     * @throws ItemRedirect
     * @throws UseCaseError
     */
    public function execute( SetItemDescriptionRequest $request ): SetItemDescriptionResponse {
        $deserializedRequest = $this->validator->validateAndDeserialize( $request );
        $itemId = $deserializedRequest->getItemId();
        $description = $deserializedRequest->getItemDescription();
        $editMetadata = $deserializedRequest->getEditMetadata();

        $this->assertItemExists->execute( $itemId );

        $this->assertUserIsAuthorized->checkEditPermissions( $itemId, $editMetadata->getUser() );

        $item = $this->itemRetriever->getItemWriteModel( $itemId );
        $descriptionExists = $item->getDescriptions()->hasTermForLanguage( $request->getLanguageCode() );
        $item->getDescriptions()->setTerm( $description );

        $editSummary = $descriptionExists
            ? DescriptionEditSummary::newReplaceSummary( $editMetadata->getComment(), $description )
            : DescriptionEditSummary::newAddSummary( $editMetadata->getComment(), $description );

        $revision = $this->executeWithExceptionHandling( fn() => $this->itemUpdater->update(
            $item, // @phan-suppress-current-line PhanTypeMismatchArgumentNullable Item validated and exists
            new EditMetadata(
                $editMetadata->getTags(),
                $editMetadata->isBot(),
                $editSummary
            )
        ) );

        return new SetItemDescriptionResponse(
            $revision->getItem()->getDescriptions()[$description->getLanguageCode()],
            $revision->getLastModified(),
            $revision->getRevisionId(),
            $descriptionExists
        );
    }
}