jenkins-bot has submitted this change and it was merged. Change subject: Remove unused ClaimSaver class ......................................................................
Remove unused ClaimSaver class Change-Id: Iffdca7762eecb0b716026e562664dc17a298e17a --- D repo/includes/ClaimSaver.php 1 file changed, 0 insertions(+), 192 deletions(-) Approvals: Daniel Kinzler: Looks good to me, approved jenkins-bot: Verified diff --git a/repo/includes/ClaimSaver.php b/repo/includes/ClaimSaver.php deleted file mode 100644 index 9541637..0000000 --- a/repo/includes/ClaimSaver.php +++ /dev/null @@ -1,192 +0,0 @@ -<?php - -namespace Wikibase; - -use User; -use MWException; -use Status; -use ValueParsers\ParseException; -use Wikibase\Claims; -use Wikibase\DataModel\Claim\ClaimGuidParsingException; -use Wikibase\ExceptionWithCode; -use Wikibase\Repo\WikibaseRepo; - -/** - * Class for updating a claim in the primary storage. - * - * TODO: add dedicated tests (now tested though SetClaim API module) - * FIXME: entity content fetching pulls in global factory - * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License along - * with this program; if not, write to the Free Software Foundation, Inc., - * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. - * http://www.gnu.org/copyleft/gpl.html - * - * @since 0.4 - * - * @ingroup WikibaseRepo - * - * @licence GNU GPL v2+ - * @author Jeroen De Dauw < [email protected] > - * @author Tobias Gritschacher < [email protected] > - */ -class ClaimSaver { - /** - * @see ApiBase::execute - * - * @since 0.4 - * - * @param Claim $claim - * @param int|null $baseRevId - * @param string $token - * @param User $user - * @param ClaimSummaryBuilder|null $claimSummaryBuilder - * @param int $flags - * - * @return Status The status. The status value is an array which may contain - * the following fields: - * - * -revision: the revision object created by the save - * -errorFlags: error flags using the EditEntity::XXX_ERROR constants - * -errorCode: error code to use in API output - * - * This status object can be used with ApiWikibase::handleSaveStatus(). - */ - public function saveClaim( Claim $claim, $baseRevId, $token, User $user, - ClaimSummaryBuilder $claimSummaryBuilder = null, $flags = 0 ) { - - try { - $entityId = $this->getEntityIdForClaim( $claim ); - - $content = $this->getEntityContent( $entityId, $baseRevId ); - - $summary = null; - - if ( $claimSummaryBuilder !== null ) { - $summary = $claimSummaryBuilder->buildClaimSummary( - new Claims( $content->getEntity()->getClaims() ), - $claim - ); - } - - $this->updateClaim( $content->getEntity(), $claim ); - - $status = $this->saveChanges( $content, $baseRevId, $token, $user, $summary, $flags ); - } catch ( ExceptionWithCode $ex ) { - // put the error code into the status - $value = array( 'errorCode' => $ex->getErrorCode() ); - $status = Status::newGood(); - $status->setResult( false, $value ); - //TODO: add an error message localization key, perhaps derived from the error code. - } - - return $status; - } - - /** - * @param Claim $claim - * - * @return EntityId - * @throws ExceptionWithCode - */ - protected function getEntityIdForClaim( Claim $claim ) { - try { - $parser = WikibaseRepo::getDefaultInstance()->getClaimGuidParser(); - return $parser->parse( $claim->getGuid() )->getEntityId(); - } - catch( ClaimGuidParsingException $exception ) { - //todo fix the error code below to be 'invalid-guid' - throw new ExceptionWithCode( $exception->getMessage(), 'setclaim-invalid-guid' ); - } - } - - /** - * @since 0.4 - * - * @param Entity $entity - * @param Claim $claim - * - */ - protected function updateClaim( Entity $entity, Claim $claim ) { - $claims = new Claims( $entity->getClaims() ); - - if ( $claims->hasClaimWithGuid( $claim->getGuid() ) ) { - $claims->removeClaimWithGuid( $claim->getGuid() ); - } - - $claims->addClaim( $claim ); - $entity->setClaims( $claims ); - } - - /** - * @since 0.4 - * - * @param EntityId $entityId - * @param int|null $revisionId - * - * @return EntityContent - * @throws ExceptionWithCode - */ - protected function getEntityContent( EntityId $entityId, $revisionId ) { - $entityContentFactory = WikibaseRepo::getDefaultInstance()->getEntityContentFactory(); - if ( $revisionId === null ) { - $content = $entityContentFactory->getFromId( $entityId ); - } - else { - $content = $entityContentFactory->getFromRevision( $revisionId ); - } - - if ( $content === null ) { - throw new ExceptionWithCode( 'No such entity', 'setclaim-entity-not-found' ); - } - - if ( !$content->getEntity()->getId()->equals( $entityId ) ) { - throw new ExceptionWithCode( - 'The provided revision belongs to the wrong entity', - 'setclaim-revision-wrong-entity' - ); - } - - return $content; - } - - /** - * @since 0.4 - * - * @param EntityContent $content - * @param int|null $baseRevisionId - * @param string $token - * @param User $user - * @param Summary|null $summary - * @param int $flags - * - * @return Status - */ - protected function saveChanges( EntityContent $content, $baseRevisionId, $token, User $user, - Summary $summary, $flags ) { - - $baseRevisionId = is_int( $baseRevisionId ) && $baseRevisionId > 0 ? $baseRevisionId : false; - $editEntity = new \Wikibase\EditEntity( $content, $user, $baseRevisionId ); - - $flags = $flags !== 0 ? $flags | EDIT_UPDATE : EDIT_UPDATE; - - $status = $editEntity->attemptSave( - $summary !== null ? $summary->toString() : '', - $flags, - $token - ); - - return $status; - } - -} -- To view, visit https://gerrit.wikimedia.org/r/88018 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: Iffdca7762eecb0b716026e562664dc17a298e17a Gerrit-PatchSet: 5 Gerrit-Project: mediawiki/extensions/Wikibase Gerrit-Branch: master Gerrit-Owner: Addshore <[email protected]> Gerrit-Reviewer: Aude <[email protected]> Gerrit-Reviewer: Daniel Kinzler <[email protected]> Gerrit-Reviewer: Hoo man <[email protected]> Gerrit-Reviewer: Jeroen De Dauw <[email protected]> Gerrit-Reviewer: Tobias Gritschacher <[email protected]> Gerrit-Reviewer: jenkins-bot _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
