SetDescription::getChangeOp() - Code Metrics - wikimedia/mediawiki-extensions-Wikibase - Measure and Improve Code Quality continuously with Scrutinizer

SetDescription::getChangeOp() A
last analyzed 2020-11-13 17:34 UTC

↳ Parent: SetDescription

Complexity

Conditions	3
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	16
rs	9.7333
c	0
b	0
f	0
cc	3
nc	4
nop	2

<?php

declare( strict_types = 1 );

namespace Wikibase\Repo\Api;

use ApiMain;
use Wikibase\DataModel\Entity\EntityDocument;
use Wikibase\DataModel\Term\DescriptionsProvider;
use Wikibase\Lib\Summary;
use Wikibase\Repo\ChangeOp\ChangeOp;
use Wikibase\Repo\ChangeOp\ChangeOps;
use Wikibase\Repo\ChangeOp\FingerprintChangeOpFactory;
use Wikibase\Repo\WikibaseRepo;

/**
 * API module for the language attributes for a Wikibase entity.
 * Requires API write mode to be enabled.
 *
 * @license GPL-2.0-or-later
 * @author Jeroen De Dauw < [email protected] >
 * @author John Erling Blad < [email protected] >
 * @author Tobias Gritschacher < [email protected] >
 */
class SetDescription extends ModifyTerm {

	/**
	 * @var FingerprintChangeOpFactory
	 */
	private $termChangeOpFactory;

	public function __construct(
		ApiMain $mainModule,
		string $moduleName,
		FingerprintChangeOpFactory $termChangeOpFactory,
		bool $federatedPropertiesEnabled
	) {
		parent::__construct( $mainModule, $moduleName, $federatedPropertiesEnabled );

		$this->termChangeOpFactory = $termChangeOpFactory;
	}

	public static function factory( ApiMain $mainModule, string $moduleName ): self {
		$wikibaseRepo = WikibaseRepo::getDefaultInstance();
		return new self(
			$mainModule,
			$moduleName,
			$wikibaseRepo->getChangeOpFactoryProvider()
				->getFingerprintChangeOpFactory(),
			$wikibaseRepo->inFederatedPropertyMode()
		);
	}

	protected function modifyEntity( EntityDocument $entity, ChangeOp $changeOp, array $preparedParameters ): Summary {
		if ( !( $entity instanceof DescriptionsProvider ) ) {
			$this->errorReporter->dieError( 'The given entity cannot contain descriptions', 'not-supported' );

		}

		$summary = $this->createSummary( $preparedParameters );
		$language = $preparedParameters['language'];

		$this->applyChangeOp( $changeOp, $entity, $summary );

		$descriptions = $entity->getDescriptions();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
		$resultBuilder = $this->getResultBuilder();

		if ( $descriptions->hasTermForLanguage( $language ) ) {
			$termList = $descriptions->getWithLanguages( [ $language ] );
			$resultBuilder->addDescriptions( $termList, 'entity' );
		} else {
			$resultBuilder->addRemovedDescription( $language, 'entity' );
		}

		return $summary;
	}

	protected function getChangeOp( array $preparedParameters, EntityDocument $entity ): ChangeOp {
		$description = "";
		$language = $preparedParameters['language'];

		if ( isset( $preparedParameters['value'] ) ) {
			$description = $this->stringNormalizer->trimToNFC( $preparedParameters['value'] );
		}

		if ( $description === "" ) {
			$op = $this->termChangeOpFactory->newRemoveDescriptionOp( $language );
		} else {
			$op = $this->termChangeOpFactory->newSetDescriptionOp( $language, $description );
		}

		return $this->termChangeOpFactory->newFingerprintChangeOp( new ChangeOps( $op ) );
	}

	/**
	 * @see ApiBase::needsToken
	 *
	 * @return string
	 */
	public function needsToken(): string {
		return 'csrf';
	}

	/**
	 * @see ApiBase::isWriteMode()
	 *
	 * @return bool Always true.
	 */
	public function isWriteMode(): bool {
		return true;
	}

	/**
	 * @inheritDoc
	 */
	protected function getExamplesMessages(): array {
		return [
			'action=wbsetdescription&id=Q42&language=en&value=An%20encyclopedia%20that%20everyone%20can%20edit'
				=> 'apihelp-wbsetdescription-example-1',
			'action=wbsetdescription&site=enwiki&title=Wikipedia&language=en&value=An%20encyclopedia%20that%20everyone%20can%20edit'
				=> 'apihelp-wbsetdescription-example-2',
		];
	}

	/**
	 * @inheritDoc
	 */
	protected function getAllowedParams(): array {
		return array_merge(
			parent::getAllowedParams(),
			[
				'new' => [
					self::PARAM_TYPE => $this->getEntityTypesWithDescriptions(),
				],
			]
		);
	}

	protected function getEntityTypesWithDescriptions(): array {
		// TODO inject me
		$entityFactory = WikibaseRepo::getDefaultInstance()->getEntityFactory();
		$supportedEntityTypes = [];
		foreach ( $this->enabledEntityTypes as $entityType ) {
			$testEntity = $entityFactory->newEmpty( $entityType );
			if ( $testEntity instanceof DescriptionsProvider ) {
				$supportedEntityTypes[] = $entityType;
			}
		}
		return $supportedEntityTypes;
	}

}


1			<?php
2
3			declare( strict_types = 1 );
4
5			namespace Wikibase\Repo\Api;
6
7			use ApiMain;
8			use Wikibase\DataModel\Entity\EntityDocument;
9			use Wikibase\DataModel\Term\DescriptionsProvider;
10			use Wikibase\Lib\Summary;
11			use Wikibase\Repo\ChangeOp\ChangeOp;
12			use Wikibase\Repo\ChangeOp\ChangeOps;
13			use Wikibase\Repo\ChangeOp\FingerprintChangeOpFactory;
14			use Wikibase\Repo\WikibaseRepo;
15
16			/**
17			* API module for the language attributes for a Wikibase entity.
18			* Requires API write mode to be enabled.
19			*
20			* @license GPL-2.0-or-later
21			* @author Jeroen De Dauw < [email protected] >
22			* @author John Erling Blad < [email protected] >
23			* @author Tobias Gritschacher < [email protected] >
24			*/
25			class SetDescription extends ModifyTerm {
26
27			/**
28			* @var FingerprintChangeOpFactory
29			*/
30			private $termChangeOpFactory;
31
32			public function __construct(
33			ApiMain $mainModule,
34			string $moduleName,
35			FingerprintChangeOpFactory $termChangeOpFactory,
36			bool $federatedPropertiesEnabled
37			) {
38			parent::__construct( $mainModule, $moduleName, $federatedPropertiesEnabled );
39
40			$this->termChangeOpFactory = $termChangeOpFactory;
41			}
42
43			public static function factory( ApiMain $mainModule, string $moduleName ): self {
44			$wikibaseRepo = WikibaseRepo::getDefaultInstance();
45			return new self(
46			$mainModule,
47			$moduleName,
48			$wikibaseRepo->getChangeOpFactoryProvider()
49			->getFingerprintChangeOpFactory(),
50			$wikibaseRepo->inFederatedPropertyMode()
51			);
52			}
53
54			protected function modifyEntity( EntityDocument $entity, ChangeOp $changeOp, array $preparedParameters ): Summary {
55			if ( !( $entity instanceof DescriptionsProvider ) ) {
56			$this->errorReporter->dieError( 'The given entity cannot contain descriptions', 'not-supported' );
			0 ignored issues – show Deprecated Code introduced 2019-12-03 12:42 UTC by Report Bug Copy Issue Report The method `Wikibase\Repo\Api\ApiErrorReporter::dieError()` has been deprecated with message: Use dieWithError() instead. This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
57			}
58
59			$summary = $this->createSummary( $preparedParameters );
60			$language = $preparedParameters['language'];
61
62			$this->applyChangeOp( $changeOp, $entity, $summary );
63
64			$descriptions = $entity->getDescriptions();
			0 ignored issues – show Bug introduced 2016-03-15 13:13 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Wikibase\DataModel\Entity\EntityDocument` as the method `getDescriptions()` does only exist in the following implementations of said interface: `Wikibase\DataModel\Entity\Item`, `Wikibase\DataModel\Entity\Property`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
65			$resultBuilder = $this->getResultBuilder();
66
67			if ( $descriptions->hasTermForLanguage( $language ) ) {
68			$termList = $descriptions->getWithLanguages( [ $language ] );
69			$resultBuilder->addDescriptions( $termList, 'entity' );
70			} else {
71			$resultBuilder->addRemovedDescription( $language, 'entity' );
72			}
73
74			return $summary;
75			}
76
77			protected function getChangeOp( array $preparedParameters, EntityDocument $entity ): ChangeOp {
78			$description = "";
79			$language = $preparedParameters['language'];
80
81			if ( isset( $preparedParameters['value'] ) ) {
82			$description = $this->stringNormalizer->trimToNFC( $preparedParameters['value'] );
83			}
84
85			if ( $description === "" ) {
86			$op = $this->termChangeOpFactory->newRemoveDescriptionOp( $language );
87			} else {
88			$op = $this->termChangeOpFactory->newSetDescriptionOp( $language, $description );
89			}
90
91			return $this->termChangeOpFactory->newFingerprintChangeOp( new ChangeOps( $op ) );
92			}
93
94			/**
95			* @see ApiBase::needsToken
96			*
97			* @return string
98			*/
99			public function needsToken(): string {
100			return 'csrf';
101			}
102
103			/**
104			* @see ApiBase::isWriteMode()
105			*
106			* @return bool Always true.
107			*/
108			public function isWriteMode(): bool {
109			return true;
110			}
111
112			/**
113			* @inheritDoc
114			*/
115			protected function getExamplesMessages(): array {
116			return [
117			'action=wbsetdescription&id=Q42&language=en&value=An%20encyclopedia%20that%20everyone%20can%20edit'
118			=> 'apihelp-wbsetdescription-example-1',
119			'action=wbsetdescription&site=enwiki&title=Wikipedia&language=en&value=An%20encyclopedia%20that%20everyone%20can%20edit'
120			=> 'apihelp-wbsetdescription-example-2',
121			];
122			}
123
124			/**
125			* @inheritDoc
126			*/
127			protected function getAllowedParams(): array {
128			return array_merge(
129			parent::getAllowedParams(),
130			[
131			'new' => [
132			self::PARAM_TYPE => $this->getEntityTypesWithDescriptions(),
133			],
134			]
135			);
136			}
137
138			protected function getEntityTypesWithDescriptions(): array {
139			// TODO inject me
140			$entityFactory = WikibaseRepo::getDefaultInstance()->getEntityFactory();
141			$supportedEntityTypes = [];
142			foreach ( $this->enabledEntityTypes as $entityType ) {
143			$testEntity = $entityFactory->newEmpty( $entityType );
144			if ( $testEntity instanceof DescriptionsProvider ) {
145			$supportedEntityTypes[] = $entityType;
146			}
147			}
148			return $supportedEntityTypes;
149			}
150
151			}
152

wikimedia / mediawiki-extensions-Wikibase

SetDescription::getChangeOp() A last analyzed 2020-11-13 17:34 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

SetDescription::getChangeOp() A
last analyzed 2020-11-13 17:34 UTC