CitationReferenceValue::setCaptionFormat() - Code Metrics - Inspection of "[WIP] Add Citation meta to include Citation freque..." - SemanticMediaWiki/SemanticCite - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#22)

by mw

created 2015-12-09 19:23 UTC

CitationReferenceValue::setCaptionFormat() A

↳ Parent: CitationReferenceValue

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	3
ccs	0
cts	3
cp	0
rs	10
cc	1
eloc	2
nc	1
nop	1
crap	2

<?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 ) {

		$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 $this->m_dataitem->getString();
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.
    }
}
		}

		$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	$this->citationReferencePositionJournal = $this->getExtraneousFunctionFor( '\SCI\CitationReferencePositionJournal' );
106
107		// We want the last entry here to get the major/minor
108		// number that was internally recorded
109	7	$referencePosition = $this->citationReferencePositionJournal->findLastReferencePositionEntryFor(
110	7	$this->m_contextPage,
111	7	$this->reference
112	7	);
113
114	7	if ( $referencePosition === null \|\| $this->m_caption === false ) {
115		return $this->m_dataitem->getString();
		0 ignored issues – show Bug introduced 2015-12-09 19:26 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `SMWDataItem` as the method `getString()` does only exist in the following sub-classes of `SMWDataItem`: `SMWDIBlob`, `SMWDIError`, `SMWDIString`. 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...
116		}
117
118	7	$referenceHash = md5( $this->reference );
119
120	7	if ( $this->captionFormat === SCI_CITEREF_NUM ) {
121	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...
122	4	$caption = $major;
123	4	$captionClass = 'number';
124
125		// [[CiteRef::Foo, 1970\|:50-52]] will add the caption to the outside
		0 ignored issues – show Unused Code Comprehensibility introduced 2015-11-24 13:24 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...
126	4	$shortFormCaption = $this->usesShortFormCaption ? $this->m_caption : '';
127	4	} else {
128	3	$captionClass = 'key';
129	3	$caption = $this->m_caption;
130	3	$shortFormCaption = ''; // Never has a short form
131		}
132
133	7	if ( $shortFormCaption !== '' ) {
134	1	$shortFormCaption = Html::rawElement(
135	1	'span',
136	1	array( 'class' => 'scite-citeref-shortcaption' ),
137		$shortFormCaption
138	1	);
139	1	}
140
141		// Build element with back and forth link anchor
142	7	$html = Html::rawElement(
143	7	'span',
144		array(
145	7	'id' => 'scite-ref-'. $referenceHash . '-' . $referencePosition,
146	7	'class' => 'scite-citeref-' . $captionClass,
147	7	'data-reference' => $this->reference
148	7	),
149	7	'[[' .'#scite-' . $referenceHash . '\|' . $caption . ']]'
150	7	) . $shortFormCaption;
151
152	7	return $html;
153		}
154
155		}
156

SemanticMediaWiki / SemanticCite

Pull Request — master (#22)

CitationReferenceValue::setCaptionFormat() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like