ApiSemanticFormsSelect::getParamDescription() - Code Metrics - Inspection of "added support for mapping properties ..." - SemanticMediaWiki/SemanticFormsSelect - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#59)

unknown

created 2017-05-02 18:11 UTC

ApiSemanticFormsSelect::getParamDescription() A

↳ Parent: ApiSemanticFormsSelect

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0
ccs	0
cts	6
cp	0
cc	1
eloc	4
nc	1
nop	0
crap	2

<?php

//namespace SFS;	# for some reason, this was not working with API registration via extension.json

use ApiBase;
use Parser;
use ParserOptions;
use ParserOutput;
use Title;

/**
 * API modules to communicate with the back-end
 *
 * @license GNU GPL v2+
 * @since 1.2
 *
 * @author Jason Zhang
 * @author Toni Hermoso Pulido
 */
class ApiSemanticFormsSelect extends ApiBase {
namespace YourVendor;

class YourClass { }

	/**
	 * @see ApiBase::execute
	 */
	public function execute() {
// 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);
    }
}

		$parser = new Parser( $GLOBALS['wgParserConf'] );
		$parser->setTitle( Title::newFromText( 'NO TITLE' ) );
		$parser->mOptions = new ParserOptions();
		$parser->mOutput = new ParserOutput();

		$apiRequestProcessor = new SFS\ApiSemanticFormsSelectRequestProcessor( $parser );
		$apiRequestProcessor->setDebugFlag( $GLOBALS['wgSF_Select_debug'] );

		$resultValues = $apiRequestProcessor->getJsonDecodedResultValuesForRequestParameters(
			$this->extractRequestParams()
		);

		$result = $this->getResult();
		$result->setIndexedTagName( $resultValues->values, 'value' );
		$result->addValue( $this->getModuleName(), 'values', $resultValues->values );
		$result->addValue( $this->getModuleName(), 'count', $resultValues->count );

		return true;
	}

	/**
	 * @see ApiBase::getAllowedParams
	 */
	public function getAllowedParams() {
		return array(
			'approach' => array(
				ApiBase::PARAM_TYPE => 'string',
				ApiBase::PARAM_REQUIRED => true
			),
			'query' => array(
				ApiBase::PARAM_TYPE => 'string',
				ApiBase::PARAM_REQUIRED => true
			),
			'sep' => array(
				ApiBase::PARAM_TYPE => 'string',
				ApiBase::PARAM_REQUIRED => false
			)
		);
	}

	/**
	 * @see ApiBase::getDescription
	 */
	public function getDescription() {
		return array(
			'API for providing SemanticFormsSelect values'
		);
	}

	/**
	 * @see ApiBase::getParamDescription
	 */
	public function getParamDescription() {
		return array(
			'approach' => 'The actual approach: function or smw',
			'query' => 'The query of the former'
		);
	}

	/**
	 * @see ApiBase::getVersion
	 */
	public function getVersion() {
		return __CLASS__ . ': 1.1';
	}

}


1			<?php
2
3			//namespace SFS; # for some reason, this was not working with API registration via extension.json
4
5			use ApiBase;
6			use Parser;
7			use ParserOptions;
8			use ParserOutput;
9			use Title;
10
11			/**
12			* API modules to communicate with the back-end
13			*
14			* @license GNU GPL v2+
15			* @since 1.2
16			*
17			* @author Jason Zhang
18			* @author Toni Hermoso Pulido
19			*/
20			class ApiSemanticFormsSelect extends ApiBase {
			0 ignored issues – show Coding Style Compatibility introduced 2017-05-02 18:16 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
21
22			/**
23			* @see ApiBase::execute
24			*/
25			public function execute() {
			0 ignored issues – show Coding Style introduced 2015-11-29 20:58 UTC by Report Bug Copy Issue Report `execute` 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...
26
27			$parser = new Parser( $GLOBALS['wgParserConf'] );
28			$parser->setTitle( Title::newFromText( 'NO TITLE' ) );
29			$parser->mOptions = new ParserOptions();
30			$parser->mOutput = new ParserOutput();
31
32			$apiRequestProcessor = new SFS\ApiSemanticFormsSelectRequestProcessor( $parser );
33			$apiRequestProcessor->setDebugFlag( $GLOBALS['wgSF_Select_debug'] );
34
35			$resultValues = $apiRequestProcessor->getJsonDecodedResultValuesForRequestParameters(
36			$this->extractRequestParams()
37			);
38
39			$result = $this->getResult();
40			$result->setIndexedTagName( $resultValues->values, 'value' );
41			$result->addValue( $this->getModuleName(), 'values', $resultValues->values );
42			$result->addValue( $this->getModuleName(), 'count', $resultValues->count );
43
44			return true;
45			}
46
47			/**
48			* @see ApiBase::getAllowedParams
49			*/
50			public function getAllowedParams() {
51			return array(
52			'approach' => array(
53			ApiBase::PARAM_TYPE => 'string',
54			ApiBase::PARAM_REQUIRED => true
55			),
56			'query' => array(
57			ApiBase::PARAM_TYPE => 'string',
58			ApiBase::PARAM_REQUIRED => true
59			),
60			'sep' => array(
61			ApiBase::PARAM_TYPE => 'string',
62			ApiBase::PARAM_REQUIRED => false
63			)
64			);
65			}
66
67			/**
68			* @see ApiBase::getDescription
69			*/
70			public function getDescription() {
71			return array(
72			'API for providing SemanticFormsSelect values'
73			);
74			}
75
76			/**
77			* @see ApiBase::getParamDescription
78			*/
79			public function getParamDescription() {
80			return array(
81			'approach' => 'The actual approach: function or smw',
82			'query' => 'The query of the former'
83			);
84			}
85
86			/**
87			* @see ApiBase::getVersion
88			*/
89			public function getVersion() {
90			return __CLASS__ . ': 1.1';
91			}
92
93			}
94

SemanticMediaWiki / SemanticFormsSelect

Pull Request — master (#59)

ApiSemanticFormsSelect::getParamDescription() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like