SRFBibTeX::newItem() - Code Metrics - Inspection of "Tidy `format=bibtex`" - SemanticMediaWiki/SemanticResultFormats - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — bibtex-refactor ( 88494c...f5535a )

by mw

created 2019-07-27 11:54 UTC

SRFBibTeX::newItem() B

↳ Parent: SRFBibTeX

Complexity

Conditions	11
Paths	8

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	42
rs	7.3166
c	0
b	0
f	0
cc	11
nc	8
nop	1

How to fix Complexity

<?php

use SRF\BibTex\Item;
use SMWTimeValue as TimeValue;
use SMWQueryResult as QueryResult;
use SMW\Query\ResultPrinters\FileExportPrinter;

/**
 * Printer class for creating BibTeX exports
 *
 * For details on availble keys see the README
 *
 * Example of a book :
 *
 * @Book{abramowitz1964homf,
 *   author =     "Milton Abramowitz and Irene A. Stegun",
 *   title =     "Handbook of Mathematical Functions",
 *   publisher =     "Dover",
 *   year =     1964,
 *   address =     "New York",
 *   edition =     "ninth Dover printing, tenth GPO printing"
 * }
 *
 * @file
 * @ingroup SemanticResultFormats
 *
 * @author Markus Krötzsch
 * @author Denny Vrandecic
 * @author Frank Dengler
 * @author Steren Giannini
 */
class SRFBibTeX extends FileExportPrinter {

	/**
	 * @see ResultPrinter::getName
	 *
	 * {@inheritDoc}
	 */
	public function getName() {
		return wfMessage( 'srf_printername_bibtex' )->text();
	}

	/**
	 * @see FileExportPrinter::getMimeType
	 *
	 * @since 1.8
	 *
	 * {@inheritDoc}
	 */
	public function getMimeType( QueryResult $queryResult ) {
		return 'text/bibtex';
	}

	/**
	 * @see FileExportPrinter::getFileName
	 *
	 * @since 1.8
	 *
	 * {@inheritDoc}
	 */
	public function getFileName( QueryResult $queryResult ) {

		if ( $this->params['filename'] !== '' ) {

			if ( strpos( $this->params['filename'], '.bib' ) === false ) {
				$this->params['filename'] .= '.bib';
			}

			return str_replace( ' ', '_', $this->params['filename'] );
		} elseif ( $this->getSearchLabel( SMW_OUTPUT_WIKI ) != '' ) {
			return str_replace( ' ', '_', $this->getSearchLabel( SMW_OUTPUT_WIKI ) ) . '.bib';
		}

		return 'BibTeX.bib';
	}

	/**
	 * @see ResultPrinter::getParamDefinitions
	 *
	 * @since 1.8
	 *
	 * {@inheritDoc}
	 */
	public function getParamDefinitions( array $definitions ) {
		$params = parent::getParamDefinitions( $definitions );

		$params['filename'] = [
			'message' => 'smw-paramdesc-filename',
			'default' => 'bibtex.bib',
		];

		return $params;
	}

	/**
	 * @since 3.1
	 *
	 * @param array $list
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 *
	 * @return string
	 */
	public function getFormattedList( $key, array $values ) {
		return $GLOBALS['wgLang']->listToText( $values );
	}

	/**
	 * @see ResultPrinter::getResultText
	 *
	 * {@inheritDoc}
	 */
	protected function getResultText( QueryResult $res, $outputMode ) {

		if ( $outputMode !== SMW_OUTPUT_FILE ) {
			return $this->getBibTexLink( $res, $outputMode );
		}

		$items = [];

		while ( $row = $res->getNext() ) {
			$items[] = $this->newItem( $row )->text();
		}

		return implode( "\r\n\r\n", $items );
	}

	private function getBibTexLink( QueryResult $res, $outputMode ) {

		// Can be viewed as HTML if requested, no more parsing needed
		$this->isHTML = $outputMode == SMW_OUTPUT_HTML;

		$link = $this->getLink(
			$res,
			$outputMode
		);

		return $link->getText( $outputMode, $this->mLinker );
	}

	/**
	 * @since 3.1
	 *
	 * @param $row array of SMWResultArray
	 *
	 * @return bibTexItem
	 */
	private function newItem( array /* of SMWResultArray */ $row ) {

		$item = new Item();
		$item->setFormatterCallback( [ $this, 'getFormattedList' ] );

		foreach ( $row as /* SMWResultArray */ $field ) {
			$printRequest = $field->getPrintRequest();
			$values = [];

			$label = strtolower( $printRequest->getLabel() );
			$dataValue = $field->getNextDataValue();

			if ( $dataValue === false ) {
				continue;
			}

			if ( $label === 'date' && $dataValue instanceof TimeValue ) {
				$item->set( 'year', $dataValue->getYear() );
				$item->set( 'month', $dataValue->getMonth() );
			} elseif ( $label === 'author' || $label === 'authors' ) {
				$values[] = $dataValue->getShortWikiText();

				while ( ( /* SMWDataValue */ $dataValue = $field->getNextDataValue() ) !== false ) {
					$values[] = $dataValue->getShortWikiText();
				}

				$item->set( 'author', $values );
			} elseif ( $label === 'editor' || $label === 'editors' ) {
				$values[] = $dataValue->getShortWikiText();

				while ( ( /* SMWDataValue */ $dataValue = $field->getNextDataValue() ) !== false ) {
					$values[] = $dataValue->getShortWikiText();
				}

				$item->set( 'editor', $values );
			} else {
				$item->set( $label, $dataValue->getShortWikiText() );
			}
		}

		return $item;
	}

}


1			<?php
2
3			use SRF\BibTex\Item;
4			use SMWTimeValue as TimeValue;
5			use SMWQueryResult as QueryResult;
6			use SMW\Query\ResultPrinters\FileExportPrinter;
7
8			/**
9			* Printer class for creating BibTeX exports
10			*
11			* For details on availble keys see the README
12			*
13			* Example of a book :
14			*
15			* @Book{abramowitz1964homf,
16			* author = "Milton Abramowitz and Irene A. Stegun",
17			* title = "Handbook of Mathematical Functions",
18			* publisher = "Dover",
19			* year = 1964,
20			* address = "New York",
21			* edition = "ninth Dover printing, tenth GPO printing"
22			* }
23			*
24			* @file
25			* @ingroup SemanticResultFormats
26			*
27			* @author Markus Krötzsch
28			* @author Denny Vrandecic
29			* @author Frank Dengler
30			* @author Steren Giannini
31			*/
32			class SRFBibTeX extends FileExportPrinter {
33
34			/**
35			* @see ResultPrinter::getName
36			*
37			* {@inheritDoc}
38			*/
39			public function getName() {
40			return wfMessage( 'srf_printername_bibtex' )->text();
41			}
42
43			/**
44			* @see FileExportPrinter::getMimeType
45			*
46			* @since 1.8
47			*
48			* {@inheritDoc}
49			*/
50			public function getMimeType( QueryResult $queryResult ) {
51			return 'text/bibtex';
52			}
53
54			/**
55			* @see FileExportPrinter::getFileName
56			*
57			* @since 1.8
58			*
59			* {@inheritDoc}
60			*/
61			public function getFileName( QueryResult $queryResult ) {
62
63			if ( $this->params['filename'] !== '' ) {
64
65			if ( strpos( $this->params['filename'], '.bib' ) === false ) {
66			$this->params['filename'] .= '.bib';
67			}
68
69			return str_replace( ' ', '_', $this->params['filename'] );
70			} elseif ( $this->getSearchLabel( SMW_OUTPUT_WIKI ) != '' ) {
71			return str_replace( ' ', '_', $this->getSearchLabel( SMW_OUTPUT_WIKI ) ) . '.bib';
72			}
73
74			return 'BibTeX.bib';
75			}
76
77			/**
78			* @see ResultPrinter::getParamDefinitions
79			*
80			* @since 1.8
81			*
82			* {@inheritDoc}
83			*/
84			public function getParamDefinitions( array $definitions ) {
85			$params = parent::getParamDefinitions( $definitions );
86
87			$params['filename'] = [
88			'message' => 'smw-paramdesc-filename',
89			'default' => 'bibtex.bib',
90			];
91
92			return $params;
93			}
94
95			/**
96			* @since 3.1
97			*
98			* @param array $list
			0 ignored issues – show Bug introduced 2019-07-27 12:57 UTC by Report Bug Copy Issue Report There is no parameter named `$list`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
99			*
100			* @return string
101			*/
102			public function getFormattedList( $key, array $values ) {
103			return $GLOBALS['wgLang']->listToText( $values );
104			}
105
106			/**
107			* @see ResultPrinter::getResultText
108			*
109			* {@inheritDoc}
110			*/
111			protected function getResultText( QueryResult $res, $outputMode ) {
112
113			if ( $outputMode !== SMW_OUTPUT_FILE ) {
114			return $this->getBibTexLink( $res, $outputMode );
115			}
116
117			$items = [];
118
119			while ( $row = $res->getNext() ) {
120			$items[] = $this->newItem( $row )->text();
121			}
122
123			return implode( "\r\n\r\n", $items );
124			}
125
126			private function getBibTexLink( QueryResult $res, $outputMode ) {
127
128			// Can be viewed as HTML if requested, no more parsing needed
129			$this->isHTML = $outputMode == SMW_OUTPUT_HTML;
130
131			$link = $this->getLink(
132			$res,
133			$outputMode
134			);
135
136			return $link->getText( $outputMode, $this->mLinker );
137			}
138
139			/**
140			* @since 3.1
141			*
142			* @param $row array of SMWResultArray
143			*
144			* @return bibTexItem
145			*/
146			private function newItem( array /* of SMWResultArray */ $row ) {
147
148			$item = new Item();
149			$item->setFormatterCallback( [ $this, 'getFormattedList' ] );
150
151			foreach ( $row as /* SMWResultArray */ $field ) {
152			$printRequest = $field->getPrintRequest();
153			$values = [];
154
155			$label = strtolower( $printRequest->getLabel() );
156			$dataValue = $field->getNextDataValue();
157
158			if ( $dataValue === false ) {
159			continue;
160			}
161
162			if ( $label === 'date' && $dataValue instanceof TimeValue ) {
163			$item->set( 'year', $dataValue->getYear() );
164			$item->set( 'month', $dataValue->getMonth() );
165			} elseif ( $label === 'author' \|\| $label === 'authors' ) {
166			$values[] = $dataValue->getShortWikiText();
167
168			while ( ( /* SMWDataValue */ $dataValue = $field->getNextDataValue() ) !== false ) {
169			$values[] = $dataValue->getShortWikiText();
170			}
171
172			$item->set( 'author', $values );
173			} elseif ( $label === 'editor' \|\| $label === 'editors' ) {
174			$values[] = $dataValue->getShortWikiText();
175
176			while ( ( /* SMWDataValue */ $dataValue = $field->getNextDataValue() ) !== false ) {
177			$values[] = $dataValue->getShortWikiText();
178			}
179
180			$item->set( 'editor', $values );
181			} else {
182			$item->set( $label, $dataValue->getShortWikiText() );
183			}
184			}
185
186			return $item;
187			}
188
189			}
190

SemanticMediaWiki / SemanticResultFormats

Push — bibtex-refactor ( 88494c...f5535a )

SRFBibTeX::newItem() B

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like