HtmlResponseParserRenderer - Code Metrics - Inspection of "Add @show parameter (#52)" - SemanticMediaWiki/SemanticCite - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1a6713...36ba73 )

by mw

created 2017-05-28 04:01 UTC

HtmlResponseParserRenderer A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	124
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

90.91%

Importance

Changes

Metric	Value
wmc	7
lcom	1
cbo	2
dl	0
loc	124
ccs	50
cts	55
cp	0.9091
rs	10
c	0
b	0
f	0

4 Methods

Rating	Name	Size	Complexity
A	__construct()	3	1
A	isReadOnly()	3	1
A	getRawResponse()	8	2
A	renderTextFor()	73	3

<?php

namespace SCI\Specials\CitableMetadata;

use Onoi\Remi\ResponseParser;
use Html;

/**
 * @license GNU GPL v2+
 * @since 1.0
 *
 * @author mwjames
 */
class HtmlResponseParserRenderer {

	/**
	 * @var ResponseParser
	 */
	private $responseParser;

	/**
	 * @var boolean
	 */
	private $isReadOnly = false;

	/**
	 * @since 1.0
	 *
	 * @param ResponseParser $responseParser
	 */
	public function __construct( ResponseParser $responseParser ) {
		$this->responseParser = $responseParser;
	}

	/**
	 * @since 1.4
	 *
	 * @param boolean $isReadOnly
	 */
	public function isReadOnly( $isReadOnly ) {
		$this->isReadOnly = (bool)$isReadOnly;
	}

	/**
	 * @since 1.0
	 *
	 * @return string
	 */
	public function getRawResponse( $id ) {

		if ( $id === '' ) {
			return '';
		}

		return $this->responseParser->getRawResponse( $id );
	}

	/**
	 * @since 1.0
	 *
	 * @return string
	 */
	public function renderTextFor( $id ) {

		$html = '';

		$this->responseParser->doFilterResponseFor( $id );

		$html .= Html::rawElement(
			'div',
			array(
				'id' => 'scite-status',
			),
			''
		);

		if ( $this->responseParser->getMessages() !== array() ) {
			return '';
		}

		$create = '';

		// Only display the create button for when the DB can be actually
		// accessed
		if ( $this->isReadOnly === false ) {
			$create = Html::element(
				'a',
				array(
					'href' => '#',
					'class' => 'scite-create scite-action-button',
					'data-content-selector' => '#scite-record-content',
					'data-title' => $this->responseParser->getFilteredRecord()->getTitleForPageCreation()
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
				),
				wfMessage( 'sci-metadata-search-action-create' )->text()
			);
		}

		$html .= Html::rawElement(
			'div',
			array(
				'class' => 'scite-metadata-search-action'
			),
			Html::element(
				'a',
				array(
					'href' => '#',
					'class' => 'scite-highlight scite-action-button',
					'data-content-selector' => '#scite-record-content'
				),
				wfMessage( 'sci-metadata-search-action-highlight' )->text()
			) . '&nbsp;' . $create
		);

		// To display the #scite on the generated page
		$this->responseParser->getFilteredRecord()->set( '@show', 'true' );

		$html .= Html::rawElement(
			'div',
			array(
				'id' => 'scite-record-content',
				'class' => 'scite-pre'
			),
			$this->responseParser->getFilteredRecord()->asSciteTransclusion()
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
		);

		$html .= Html::rawElement(
			'div',
			array(
				'class' => 'visualClear'
			),
			''
		);

		return $html;
	}

}


Push — master ( 1a6713...36ba73 )

HtmlResponseParserRenderer A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

4 Methods

Available Fixes

Available Fixes

1		<?php
2
3		namespace SCI\Specials\CitableMetadata;
4
5		use Onoi\Remi\ResponseParser;
6		use Html;
7
8		/**
9		* @license GNU GPL v2+
10		* @since 1.0
11		*
12		* @author mwjames
13		*/
14		class HtmlResponseParserRenderer {
15
16		/**
17		* @var ResponseParser
18		*/
19		private $responseParser;
20
21		/**
22		* @var boolean
23		*/
24		private $isReadOnly = false;
25
26		/**
27		* @since 1.0
28		*
29		* @param ResponseParser $responseParser
30		*/
31	3	public function __construct( ResponseParser $responseParser ) {
32	3	$this->responseParser = $responseParser;
33	3	}
34
35		/**
36		* @since 1.4
37		*
38		* @param boolean $isReadOnly
39		*/
40		public function isReadOnly( $isReadOnly ) {
41		$this->isReadOnly = (bool)$isReadOnly;
42		}
43
44		/**
45		* @since 1.0
46		*
47		* @return string
48		*/
49	1	public function getRawResponse( $id ) {
50
51	1	if ( $id === '' ) {
52		return '';
53		}
54
55	1	return $this->responseParser->getRawResponse( $id );
56		}
57
58		/**
59		* @since 1.0
60		*
61		* @return string
62		*/
63	1	public function renderTextFor( $id ) {
64
65	1	$html = '';
66
67	1	$this->responseParser->doFilterResponseFor( $id );
68
69	1	$html .= Html::rawElement(
70	1	'div',
71		array(
72	1	'id' => 'scite-status',
73	1	),
74		''
75	1	);
76
77	1	if ( $this->responseParser->getMessages() !== array() ) {
78		return '';
79		}
80
81	1	$create = '';
82
83		// Only display the create button for when the DB can be actually
84		// accessed
85	1	if ( $this->isReadOnly === false ) {
86	1	$create = Html::element(
87	1	'a',
88		array(
89	1	'href' => '#',
90	1	'class' => 'scite-create scite-action-button',
91	1	'data-content-selector' => '#scite-record-content',
92	1	'data-title' => $this->responseParser->getFilteredRecord()->getTitleForPageCreation()
		0 ignored issues – show Bug introduced 2015-11-24 13:24 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Onoi\Remi\FilteredRecord` as the method `getTitleForPageCreation()` does only exist in the following sub-classes of `Onoi\Remi\FilteredRecord`: `SCI\FilteredMetadata\BibliographicFilteredRecord`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
93	1	),
94	1	wfMessage( 'sci-metadata-search-action-create' )->text()
95	1	);
96	1	}
97
98	1	$html .= Html::rawElement(
99	1	'div',
100		array(
101		'class' => 'scite-metadata-search-action'
102	1	),
103	1	Html::element(
104	1	'a',
105		array(
106	1	'href' => '#',
107	1	'class' => 'scite-highlight scite-action-button',
108		'data-content-selector' => '#scite-record-content'
109	1	),
110	1	wfMessage( 'sci-metadata-search-action-highlight' )->text()
111	1	) . ' ' . $create
112	1	);
113
114		// To display the #scite on the generated page
115	1	$this->responseParser->getFilteredRecord()->set( '@show', 'true' );
116
117	1	$html .= Html::rawElement(
118	1	'div',
119		array(
120	1	'id' => 'scite-record-content',
121		'class' => 'scite-pre'
122	1	),
123	1	$this->responseParser->getFilteredRecord()->asSciteTransclusion()
		0 ignored issues – show Bug introduced 2015-11-24 13:24 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Onoi\Remi\FilteredRecord` as the method `asSciteTransclusion()` does only exist in the following sub-classes of `Onoi\Remi\FilteredRecord`: `SCI\FilteredMetadata\BibliographicFilteredRecord`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
124	1	);
125
126	1	$html .= Html::rawElement(
127	1	'div',
128		array(
129		'class' => 'visualClear'
130	1	),
131		''
132	1	);
133
134	1	return $html;
135		}
136
137		}
138

SemanticMediaWiki / SemanticCite

Push — master ( 1a6713...36ba73 )

HtmlResponseParserRenderer A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

4 Methods

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like