CitationReferenceValue - Code Metrics - Inspection of "Localisation updates from https://translatewiki.ne..." - SemanticMediaWiki/SemanticCite - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bef15a...eb6cae )

unknown

created 2016-11-01 07:28 UTC

CitationReferenceValue A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	142
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

87.69%

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	15
c	1
b	0
f	0
lcom	1
cbo	2
dl	0
loc	142
ccs	57
cts	65
cp	0.8769
rs	10

4 Methods

Rating	Name	Size	Complexity
A	__construct()	6	1
A	setCaptionFormat()	3	1
B	parseUserValue()	36	6
B	getShortWikiText()	53	7

<?php

namespace SCI\DataValues;

use SCI\CitationReferencePositionJournal;
use SMWStringValue as StringValue;
use SMWDIBlob as DIBlob;
use Html;

/**
 * @license GNU GPL v2+
 * @since 1.0
 *
 * @author mwjames
 */
class CitationReferenceValue extends StringValue {

	/**
	 * @var integer
	 */
	private $captionFormat;

	/**
	 * @var CitationReferencePositionJournal
	 */
	private $citationReferencePositionJournal;

	/**
	 * @var string
	 */
	private $reference;

	/**
	 * To display something like [[CiteRef::Foo, 1970|:50-52]] as [1]:50-52 for
	 * SCI_CITEREF_NUM
	 *
	 * @var boolean
	 */
	private $usesShortFormCaption = false;

	/**
	 * @param string $typeid
	 */
	public function __construct( $typeid = '' ) {
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
		parent::__construct( '_sci_ref' );

		// Currently there is no good way to inject the setting
		$this->captionFormat = $GLOBALS['scigCitationReferenceCaptionFormat'];
	}

	/**
	 * @since 1.0
	 *
	 * @param  integer $captionFormat
	 */
	public function setCaptionFormat( $captionFormat ) {
		$this->captionFormat = $captionFormat;
	}

	/**
	 * @see StringValue::parseUserValue
	 */
	protected function parseUserValue( $value ) {

		$this->citationReferencePositionJournal = $this->getExtraneousFunctionFor( '\SCI\CitationReferencePositionJournal' );

		$value = trim( $value );

		if ( $value === '' ) {
			$this->addError( wfMessage( 'sci-datavalue-empty-reference' )->inContentLanguage()->text() );
			$this->m_dataitem = new DIBlob( 'ERROR' );
			return;
		}

		if ( $this->m_contextPage === null ) {
			parent::parseUserValue( $value );
			return;
		}

		$this->reference = $value;

		if ( $this->m_caption && $this->captionFormat === SCI_CITEREF_NUM ) {
			$this->usesShortFormCaption = true;
		}

		if ( !$this->m_caption ) {
			$this->m_caption = $this->reference;
		}

		// This is where the magic happens, compute the position of
		// a reference relative to previous CiteRef annotations
		$this->citationReferencePositionJournal->addJournalEntryFor(
			$this->m_contextPage,
			$this->reference
		);

		parent::parseUserValue( $this->reference );
	}

	/**
	 * @see StringValue::parseUserValue
	 */
	public function getShortWikiText( $linked = null ) {

		if ( $this->citationReferencePositionJournal === null ) {
			$this->citationReferencePositionJournal = $this->getExtraneousFunctionFor( '\SCI\CitationReferencePositionJournal' );
		}

		// We want the last entry here to get the major/minor
		// number that was internally recorded
		$referencePosition = $this->citationReferencePositionJournal->findLastReferencePositionEntryFor(
			$this->m_contextPage,
			$this->reference
		);

		if ( $referencePosition === null || $this->m_caption === false ) {
			return '';
		}

		$referenceHash = md5( $this->reference );

		if ( $this->captionFormat === SCI_CITEREF_NUM ) {
			list( $major, $minor ) = explode( '-', $referencePosition );
<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;
			$caption = $major;
			$captionClass = 'number';

			// [[CiteRef::Foo, 1970|:50-52]] will add the caption to the outside

			$shortFormCaption = $this->usesShortFormCaption ? $this->m_caption : '';
		} else {
			$captionClass = 'key';
			$caption = $this->m_caption;
			$shortFormCaption = ''; // Never has a short form
		}

		if ( $shortFormCaption !== '' ) {
			$shortFormCaption = Html::rawElement(
				'span',
				array( 'class' => 'scite-citeref-shortcaption' ),
				$shortFormCaption
			);
		}

		// Build element with back and forth link anchor
		$html = Html::rawElement(
			'span',
			array(
				'id'    => 'scite-ref-'. $referenceHash . '-' . $referencePosition,
				'class' => 'scite-citeref-' . $captionClass,
				'data-reference' => $this->reference
			),
			'[[' .'#scite-' . $referenceHash . '|' . $caption . ']]'
		) . $shortFormCaption;

		return $html;
	}

}


1		<?php
2
3		namespace SCI\DataValues;
4
5		use SCI\CitationReferencePositionJournal;
6		use SMWStringValue as StringValue;
7		use SMWDIBlob as DIBlob;
8		use Html;
9
10		/**
11		* @license GNU GPL v2+
12		* @since 1.0
13		*
14		* @author mwjames
15		*/
16		class CitationReferenceValue extends StringValue {
17
18		/**
19		* @var integer
20		*/
21		private $captionFormat;
22
23		/**
24		* @var CitationReferencePositionJournal
25		*/
26		private $citationReferencePositionJournal;
27
28		/**
29		* @var string
30		*/
31		private $reference;
32
33		/**
34		* To display something like [[CiteRef::Foo, 1970\|:50-52]] as [1]:50-52 for
35		* SCI_CITEREF_NUM
36		*
37		* @var boolean
38		*/
39		private $usesShortFormCaption = false;
40
41		/**
42		* @param string $typeid
43		*/
44	11	public function __construct( $typeid = '' ) {
		0 ignored issues – show Coding Style introduced 2015-11-24 13:24 UTC by Report Bug Copy Issue Report `__construct` uses the super-global variable `$GLOBALS` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
45	11	parent::__construct( '_sci_ref' );
46
47		// Currently there is no good way to inject the setting
48	11	$this->captionFormat = $GLOBALS['scigCitationReferenceCaptionFormat'];
49	11	}
50
51		/**
52		* @since 1.0
53		*
54		* @param integer $captionFormat
55		*/
56		public function setCaptionFormat( $captionFormat ) {
57		$this->captionFormat = $captionFormat;
58		}
59
60		/**
61		* @see StringValue::parseUserValue
62		*/
63	9	protected function parseUserValue( $value ) {
64
65	9	$this->citationReferencePositionJournal = $this->getExtraneousFunctionFor( '\SCI\CitationReferencePositionJournal' );
66
67	9	$value = trim( $value );
68
69	9	if ( $value === '' ) {
70	1	$this->addError( wfMessage( 'sci-datavalue-empty-reference' )->inContentLanguage()->text() );
71	1	$this->m_dataitem = new DIBlob( 'ERROR' );
72	1	return;
73		}
74
75	8	if ( $this->m_contextPage === null ) {
76		parent::parseUserValue( $value );
77		return;
78		}
79
80	8	$this->reference = $value;
81
82	8	if ( $this->m_caption && $this->captionFormat === SCI_CITEREF_NUM ) {
83	1	$this->usesShortFormCaption = true;
84	1	}
85
86	8	if ( !$this->m_caption ) {
87	7	$this->m_caption = $this->reference;
88	7	}
89
90		// This is where the magic happens, compute the position of
91		// a reference relative to previous CiteRef annotations
92	8	$this->citationReferencePositionJournal->addJournalEntryFor(
93	8	$this->m_contextPage,
94	8	$this->reference
95	8	);
96
97	8	parent::parseUserValue( $this->reference );
98	8	}
99
100		/**
101		* @see StringValue::parseUserValue
102		*/
103	7	public function getShortWikiText( $linked = null ) {
104
105	7	if ( $this->citationReferencePositionJournal === null ) {
106		$this->citationReferencePositionJournal = $this->getExtraneousFunctionFor( '\SCI\CitationReferencePositionJournal' );
107		}
108
109		// We want the last entry here to get the major/minor
110		// number that was internally recorded
111	7	$referencePosition = $this->citationReferencePositionJournal->findLastReferencePositionEntryFor(
112	7	$this->m_contextPage,
113	7	$this->reference
114	7	);
115
116	7	if ( $referencePosition === null \|\| $this->m_caption === false ) {
117		return '';
118		}
119
120	7	$referenceHash = md5( $this->reference );
121
122	7	if ( $this->captionFormat === SCI_CITEREF_NUM ) {
123	4	list( $major, $minor ) = explode( '-', $referencePosition );
		0 ignored issues – show Unused Code introduced 2015-11-24 13:24 UTC by Report Bug Copy Issue Report The assignment to `$minor` is unused. Consider omitting it like so `list($first,,$third)`. This checks looks for assignemnts to variables using the `list(...)` function, where not all assigned variables are subsequently used. Consider the following code example. <?php function returnThreeValues() { return array('a', 'b', 'c'); } list($a, $b, $c) = returnThreeValues(); print $a . " - " . $c; Only the variables `$a` and `$c` are used. There was no need to assign `$b`. Instead, the list call could have been. list($a,, $c) = returnThreeValues(); Loading history...
124	4	$caption = $major;
125	4	$captionClass = 'number';
126
127		// [[CiteRef::Foo, 1970\|:50-52]] will add the caption to the outside
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-03-13 01:28 UTC by Report Bug Copy Issue Report `37%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
128	4	$shortFormCaption = $this->usesShortFormCaption ? $this->m_caption : '';
129	4	} else {
130	3	$captionClass = 'key';
131	3	$caption = $this->m_caption;
132	3	$shortFormCaption = ''; // Never has a short form
133		}
134
135	7	if ( $shortFormCaption !== '' ) {
136	1	$shortFormCaption = Html::rawElement(
137	1	'span',
138	1	array( 'class' => 'scite-citeref-shortcaption' ),
139		$shortFormCaption
140	1	);
141	1	}
142
143		// Build element with back and forth link anchor
144	7	$html = Html::rawElement(
145	7	'span',
146		array(
147	7	'id' => 'scite-ref-'. $referenceHash . '-' . $referencePosition,
148	7	'class' => 'scite-citeref-' . $captionClass,
149	7	'data-reference' => $this->reference
150	7	),
151	7	'[[' .'#scite-' . $referenceHash . '\|' . $caption . ']]'
152	7	) . $shortFormCaption;
153
154	7	return $html;
155		}
156
157		}
158

SemanticMediaWiki / SemanticCite

Push — master ( bef15a...eb6cae )

CitationReferenceValue A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

4 Methods

Duplication Side-by-Side

Filter issues like