EscapingEntityIdFormatter::__construct() - Code Metrics - wmde/WikibaseDataModelServices - Measure and Improve Code Quality continuously with Scrutinizer

EscapingEntityIdFormatter::__construct() A
last analyzed 2025-10-08 13:54 UTC

↳ Parent: EscapingEntityIdFormatter

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2.032

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	4
c	1
b	0
f	0
nc	2
nop	2
dl	0
loc	7
ccs	4
cts	5
cp	0.8
crap	2.032
rs	10

<?php

namespace Wikibase\DataModel\Services\EntityId;

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

/**
 * EscapingEntityIdFormatter wraps another EntityIdFormatter and
 * applies a transformation (escaping) to that formatter's output.
 *
 * @since 1.1
 *
 * @license GPL-2.0-or-later
 * @author Daniel Kinzler
 */
class EscapingEntityIdFormatter implements EntityIdFormatter {

	/**
	 * @var EntityIdFormatter
	 */
	private $formatter;

	/**
	 * @var callable
	 */
	private $escapeCallback;

	/**
	 * @param EntityIdFormatter $formatter A formatter returning plain text.
	 * @param callable $escapeCallback A callable taking plain text and returning escaped text.
	 *
	 * @throws InvalidArgumentException
	 */
	public function __construct( EntityIdFormatter $formatter, $escapeCallback ) {
		if ( !is_callable( $escapeCallback ) ) {
			throw new InvalidArgumentException( '$escapeCallback must be callable' );
		}

		$this->formatter = $formatter;
		$this->escapeCallback = $escapeCallback;
	}

	/**
	 * @see EntityIdFormatter::formatEntityId
	 *
	 * @param EntityId $value
	 *
	 * @return string Typically wikitext or HTML, depending on the $escapeCallback provided.
	 */
	public function formatEntityId( EntityId $value ) {
		$text = $this->formatter->formatEntityId( $value );
		$escaped = ( $this->escapeCallback )( $text );
		return $escaped;
	}

}


1		<?php
2
3		namespace Wikibase\DataModel\Services\EntityId;
4
5		use InvalidArgumentException;
6		use Wikibase\DataModel\Entity\EntityId;
7
8		/**
9		* EscapingEntityIdFormatter wraps another EntityIdFormatter and
10		* applies a transformation (escaping) to that formatter's output.
11		*
12		* @since 1.1
13		*
14		* @license GPL-2.0-or-later
15		* @author Daniel Kinzler
16		*/
17		class EscapingEntityIdFormatter implements EntityIdFormatter {
18
19		/**
20		* @var EntityIdFormatter
21		*/
22		private $formatter;
23
24		/**
25		* @var callable
26		*/
27		private $escapeCallback;
28
29		/**
30		* @param EntityIdFormatter $formatter A formatter returning plain text.
31		* @param callable $escapeCallback A callable taking plain text and returning escaped text.
32		*
33		* @throws InvalidArgumentException
34	1	*/
35	1	public function __construct( EntityIdFormatter $formatter, $escapeCallback ) {
36		if ( !is_callable( $escapeCallback ) ) {
37		throw new InvalidArgumentException( '$escapeCallback must be callable' );
38		}
39	1
40	1	$this->formatter = $formatter;
41	1	$this->escapeCallback = $escapeCallback;
42		}
43
44		/**
45		* @see EntityIdFormatter::formatEntityId
46		*
47		* @param EntityId $value
48		*
49	1	* @return string Typically wikitext or HTML, depending on the $escapeCallback provided.
50	1	*/
51	1	public function formatEntityId( EntityId $value ) {
52	1	$text = $this->formatter->formatEntityId( $value );
53		$escaped = ( $this->escapeCallback )( $text );
54		return $escaped;
55		}
56
57		}
58

wmde / WikibaseDataModelServices

EscapingEntityIdFormatter::__construct() A last analyzed 2025-10-08 13:54 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

EscapingEntityIdFormatter::__construct() A
last analyzed 2025-10-08 13:54 UTC