EventCalendar::getParamDefinitions() - Code Metrics - Inspection of "Remove deprecated ApiResultPrinter, refs 317" - SemanticMediaWiki/SemanticResultFormats - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — res ( 89f49e )

by mw

created 2017-10-14 07:34 UTC

EventCalendar::getParamDefinitions() A

↳ Parent: EventCalendar

Complexity

Conditions	1
Paths	1

Size

Total Lines	51
Code Lines	33

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	51
rs	9.4109
c	0
b	0
f	0
cc	1
eloc	33
nc	1
nop	1

How to fix Long Method

<?php

namespace SRF;

use SMW\ResultPrinter;
use SMWQueryResult as QueryResult;
use Html;

/**
 * An event calendar printer using the FullCalendar JavaScript library
 * and SMWAPI.
 *
 * @since 1.9
 *
 * @file
 * @ingroup QueryPrinter
 *
 * @licence GNU GPL v2+
 * @author mwjames
 */

/**
 * Query printer supporting a JavaScript Event calendar using the
 * Semantic MediaWiki Api
 *
 * @ingroup QueryPrinter
 */
class EventCalendar extends ResultPrinter {

	/**
	 * @see ResultPrinter::getName
	 *
	 * {@inheritDoc}
	 */
	public function getName() {
		return $this->msg( 'srf-printername-eventcalendar' )->text();
	}

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

		$params['defaultview'] = [
			'message' => 'srf-paramdesc-calendardefaultview',
			'default' => 'month',
			'values' =>  [ 'month', 'basicweek', 'basicday', 'agendaweek', 'agendaday' ]
		];

		$params['firstday'] = [
			'message' => 'srf-paramdesc-calendarfirstday',
			'default' => 'Sunday',
			'values' =>  [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ]
		];

		$params['start'] = [
			'message' => 'srf-paramdesc-calendarstart',
			'default' => 'current',
			'values' =>  [ 'current', 'earliest', 'latest' ]
		];

		$params['legend'] = [
			'message' => 'srf-paramdesc-calendarlegend',
			'default' => 'none',
			'values' =>  [ 'none', 'top', 'bottom', 'tooltip', 'pane' ]
		];

		$params['dayview'] = [
			'type' => 'boolean',
			'message' => 'srf-paramdesc-dayview',
			'default' => false
		];

		$params['class'] = [
			'message' => 'srf-paramdesc-class',
			'default' => '',
		];

		$params['theme'] = [
			'message' => 'srf-paramdesc-theme',
			'default' => 'basic',
			'values' =>  [ 'basic', 'vector' ]
		];

		$params['clicktarget'] = [
			'message' => 'srf-paramdesc-clicktarget',
			'default' => 'none'
		];

		return $params;
	}

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

		$resourceFormatter = new ResourceFormatter();
		$data = $resourceFormatter->getData( $res, $outputmode, $this->params );

		$this->isHTML = true;
		$id = $resourceFormatter->session();

		// Add options
		$data['version'] = '0.8.0';

		// Encode data object
		$resourceFormatter->encode( $id, $data );

		// Init RL module
		$resourceFormatter->registerResources( [ 'ext.srf.eventcalendar' ] );

		// Element includes info, spinner, and container placeholder
		return Html::rawElement(
			'div',
			[
				'class' => 'srf-eventcalendar',
				'data-external-class' => ( $this->params['class'] ? $this->params['class'] : '' )
			],
			Html::element(
				'div',
				[
					'class' => 'srf-top'
				],
				''
			) .  $resourceFormatter->placeholder() . Html::element(
				'div',
				[
					'id' => $id,
					'class' => 'srf-container',
					'style' => 'display:none;'
				]
			)
		);
	}

}


1			<?php
2
3			namespace SRF;
4
5			use SMW\ResultPrinter;
6			use SMWQueryResult as QueryResult;
7			use Html;
8
9			/**
10			* An event calendar printer using the FullCalendar JavaScript library
11			* and SMWAPI.
12			*
13			* @since 1.9
14			*
15			* @file
16			* @ingroup QueryPrinter
17			*
18			* @licence GNU GPL v2+
19			* @author mwjames
20			*/
21
22			/**
23			* Query printer supporting a JavaScript Event calendar using the
24			* Semantic MediaWiki Api
25			*
26			* @ingroup QueryPrinter
27			*/
28			class EventCalendar extends ResultPrinter {
29
30			/**
31			* @see ResultPrinter::getName
32			*
33			* {@inheritDoc}
34			*/
35			public function getName() {
36			return $this->msg( 'srf-printername-eventcalendar' )->text();
37			}
38
39			/**
40			* @see ResultPrinter::getParamDefinitions
41			*
42			* @since 1.8
43			*
44			* {@inheritDoc}
45			*/
46			public function getParamDefinitions( array $definitions ) {
47			$params = parent::getParamDefinitions( $definitions );
48
49			$params['defaultview'] = [
50			'message' => 'srf-paramdesc-calendardefaultview',
51			'default' => 'month',
52			'values' => [ 'month', 'basicweek', 'basicday', 'agendaweek', 'agendaday' ]
53			];
54
55			$params['firstday'] = [
56			'message' => 'srf-paramdesc-calendarfirstday',
57			'default' => 'Sunday',
58			'values' => [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ]
59			];
60
61			$params['start'] = [
62			'message' => 'srf-paramdesc-calendarstart',
63			'default' => 'current',
64			'values' => [ 'current', 'earliest', 'latest' ]
65			];
66
67			$params['legend'] = [
68			'message' => 'srf-paramdesc-calendarlegend',
69			'default' => 'none',
70			'values' => [ 'none', 'top', 'bottom', 'tooltip', 'pane' ]
71			];
72
73			$params['dayview'] = [
74			'type' => 'boolean',
75			'message' => 'srf-paramdesc-dayview',
76			'default' => false
77			];
78
79			$params['class'] = [
80			'message' => 'srf-paramdesc-class',
81			'default' => '',
82			];
83
84			$params['theme'] = [
85			'message' => 'srf-paramdesc-theme',
86			'default' => 'basic',
87			'values' => [ 'basic', 'vector' ]
88			];
89
90			$params['clicktarget'] = [
91			'message' => 'srf-paramdesc-clicktarget',
92			'default' => 'none'
93			];
94
95			return $params;
96			}
97
98			/**
99			* @see ResultPrinter::getResultText
100			*
101			* {@inheritDoc}
102			*/
103			protected function getResultText( QueryResult $res, $outputmode ) {
104
105			$resourceFormatter = new ResourceFormatter();
106			$data = $resourceFormatter->getData( $res, $outputmode, $this->params );
107
108			$this->isHTML = true;
109			$id = $resourceFormatter->session();
110
111			// Add options
112			$data['version'] = '0.8.0';
113
114			// Encode data object
115			$resourceFormatter->encode( $id, $data );
116
117			// Init RL module
118			$resourceFormatter->registerResources( [ 'ext.srf.eventcalendar' ] );
119
120			// Element includes info, spinner, and container placeholder
121			return Html::rawElement(
122			'div',
123			[
124			'class' => 'srf-eventcalendar',
125			'data-external-class' => ( $this->params['class'] ? $this->params['class'] : '' )
126			],
127			Html::element(
128			'div',
129			[
130			'class' => 'srf-top'
131			],
132			''
133			) . $resourceFormatter->placeholder() . Html::element(
134			'div',
135			[
136			'id' => $id,
137			'class' => 'srf-container',
138			'style' => 'display:none;'
139			]
140			)
141			);
142			}
143
144			}
145

SemanticMediaWiki / SemanticResultFormats

Push — res ( 89f49e )

EventCalendar::getParamDefinitions() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like