SettingsController::__construct() - Code Metrics - Inspection of "Proper settings page" - nextcloud/files_antivirus - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#48)

by Roeland

created 2018-03-02 20:19 UTC

SettingsController::__construct() A

↳ Parent: SettingsController

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
ccs	0
cts	5
cp	0
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	4
nc	1
nop	4
crap	2

<?php
/**
 * Copyright (c) 2015 Victor Dubiniuk <[email protected]>
 * This file is licensed under the Affero General Public License version 3 or
 * later.
 * See the COPYING-README file.
 */

namespace OCA\Files_Antivirus\Controller;

use \OCP\AppFramework\Controller;
use \OCP\IRequest;
use \OCP\IL10N;
use \OCA\Files_Antivirus\AppConfig;

use \OCP\AppFramework\Http\TemplateResponse;
use \OCP\AppFramework\Http\JSONResponse;

class SettingsController extends Controller {

	/**
	 * @var AppConfig
	 */
	private $settings;
	
	/**
	 * @var IL10N
	 */
	private $l10n;
	
	public function __construct($appName, IRequest $request, AppConfig $appconfig, IL10N $l10n) {
		parent::__construct($appName, $request);

		$this->settings = $appconfig;
		$this->l10n = $l10n;
	}

	/**
	 * Save Parameters
	 *
	 * @param string $avMode - antivirus mode
	 * @param string $avSocket - path to socket (Socket mode)
	 * @param string $avHost - antivirus url
	 * @param int $avPort - port
	 * @param string $avCmdOptions - extra command line options
	 * @param string $avPath - path to antivirus executable (Executable mode)
	 * @param string $avInfectedAction - action performed on infected files
	 * @param $avStreamMaxLength - reopen socket after bytes
	 * @param int $avMaxFileSize - file size limit
	 * @return JSONResponse
	 */
	public function save($avMode, $avSocket, $avHost, $avPort, $avCmdOptions, $avPath, $avInfectedAction, $avStreamMaxLength, $avMaxFileSize) {
		$this->settings->setAvMode($avMode);
		$this->settings->setAvSocket($avSocket);
		$this->settings->setAvHost($avHost);
		$this->settings->setAvPort($avPort);
		$this->settings->setAvCmdOptions($avCmdOptions);
		$this->settings->setAvPath($avPath);
		$this->settings->setAvInfectedAction($avInfectedAction);
		$this->settings->setAvStreamMaxLength($avStreamMaxLength);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
		$this->settings->setAvMaxFileSize($avMaxFileSize);
		
		return new JSONResponse(
			['data' =>
				['message' =>
					$this->l10n->t('Saved')
				],
				'status' => 'success',
				'settings' => $this->settings->getAllValues()
			]
		);
	}
}


1			<?php
2			/**
3			* Copyright (c) 2015 Victor Dubiniuk <[email protected]>
4			* This file is licensed under the Affero General Public License version 3 or
5			* later.
6			* See the COPYING-README file.
7			*/
8
9			namespace OCA\Files_Antivirus\Controller;
10
11			use \OCP\AppFramework\Controller;
12			use \OCP\IRequest;
13			use \OCP\IL10N;
14			use \OCA\Files_Antivirus\AppConfig;
15
16			use \OCP\AppFramework\Http\TemplateResponse;
17			use \OCP\AppFramework\Http\JSONResponse;
18
19			class SettingsController extends Controller {
20
21			/**
22			* @var AppConfig
23			*/
24			private $settings;
25
26			/**
27			* @var IL10N
28			*/
29			private $l10n;
30
31			public function __construct($appName, IRequest $request, AppConfig $appconfig, IL10N $l10n) {
32			parent::__construct($appName, $request);
33
34			$this->settings = $appconfig;
35			$this->l10n = $l10n;
36			}
37
38			/**
39			* Save Parameters
40			*
41			* @param string $avMode - antivirus mode
42			* @param string $avSocket - path to socket (Socket mode)
43			* @param string $avHost - antivirus url
44			* @param int $avPort - port
45			* @param string $avCmdOptions - extra command line options
46			* @param string $avPath - path to antivirus executable (Executable mode)
47			* @param string $avInfectedAction - action performed on infected files
48			* @param $avStreamMaxLength - reopen socket after bytes
49			* @param int $avMaxFileSize - file size limit
50			* @return JSONResponse
51			*/
52			public function save($avMode, $avSocket, $avHost, $avPort, $avCmdOptions, $avPath, $avInfectedAction, $avStreamMaxLength, $avMaxFileSize) {
53			$this->settings->setAvMode($avMode);
54			$this->settings->setAvSocket($avSocket);
55			$this->settings->setAvHost($avHost);
56			$this->settings->setAvPort($avPort);
57			$this->settings->setAvCmdOptions($avCmdOptions);
58			$this->settings->setAvPath($avPath);
59			$this->settings->setAvInfectedAction($avInfectedAction);
60			$this->settings->setAvStreamMaxLength($avStreamMaxLength);
			0 ignored issues – show Documentation Bug introduced 2017-02-07 20:56 UTC by Report Bug Copy Issue Report The method `setAvStreamMaxLength` does not exist on `object<OCA\Files_Antivirus\AppConfig>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
61			$this->settings->setAvMaxFileSize($avMaxFileSize);
62
63			return new JSONResponse(
64			['data' =>
65			['message' =>
66			$this->l10n->t('Saved')
67			],
68			'status' => 'success',
69			'settings' => $this->settings->getAllValues()
70			]
71			);
72			}
73			}
74

nextcloud / files_antivirus

Pull Request — master (#48)

SettingsController::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like