Refactor lib/private

Signed-off-by: Hamid Dehnavi <hamid.dev.pro@gmail.com>

lib/private/Setup.php

@@ -63,40 +63,18 @@
 use Psr\Log\LoggerInterface;
 
 class Setup {
-	/** @var SystemConfig */
-	protected $config;
-	/** @var IniGetWrapper */
-	protected $iniWrapper;
-	/** @var IL10N */
-	protected $l10n;
-	/** @var Defaults */
-	protected $defaults;
-	/** @var LoggerInterface */
-	protected $logger;
-	/** @var ISecureRandom */
-	protected $random;
-	/** @var Installer */
-	protected $installer;
-
 	public function __construct(
-		SystemConfig $config,
-		IniGetWrapper $iniWrapper,
-		IL10N $l10n,
-		Defaults $defaults,
-		LoggerInterface $logger,
-		ISecureRandom $random,
-		Installer $installer
+		protected SystemConfig $config,
+		protected IniGetWrapper $iniWrapper,
+		protected IL10N $l10n,
+		protected Defaults $defaults,
+		protected LoggerInterface $logger,
+		protected ISecureRandom $random,
+		protected Installer $installer,
 	) {
-		$this->config = $config;
-		$this->iniWrapper = $iniWrapper;
-		$this->l10n = $l10n;
-		$this->defaults = $defaults;
-		$this->logger = $logger;
-		$this->random = $random;
-		$this->installer = $installer;
 	}
 
-	protected static $dbSetupClasses = [
+	protected static array $dbSetupClasses = [
 		'mysql' => \OC\Setup\MySQL::class,
 		'pgsql' => \OC\Setup\PostgreSQL::class,
 		'oci' => \OC\Setup\OCI::class,
@@ -110,7 +88,7 @@ public function __construct(
 	 * @param string $name
 	 * @return bool
 	 */
-	protected function class_exists($name) {
+	protected function class_exists(string $name): bool {
 		return class_exists($name);
 	}
 
@@ -120,7 +98,7 @@ protected function class_exists($name) {
 	 * @param string $name
 	 * @return bool
 	 */
-	protected function is_callable($name) {
+	protected function is_callable(string $name): bool {
 		return is_callable($name);
 	}
 
@@ -129,7 +107,7 @@ protected function is_callable($name) {
 	 *
 	 * @return array
 	 */
-	protected function getAvailableDbDriversForPdo() {
+	protected function getAvailableDbDriversForPdo(): array {
 		if (class_exists(\PDO::class)) {
 			return \PDO::getAvailableDrivers();
 		}
@@ -143,7 +121,7 @@ protected function getAvailableDbDriversForPdo() {
 	 * @return array
 	 * @throws Exception
 	 */
-	public function getSupportedDatabases($allowAllDatabases = false) {
+	public function getSupportedDatabases(bool $allowAllDatabases = false): array {
 		$availableDatabases = [
 			'sqlite' => [
 				'type' => 'pdo',
@@ -202,10 +180,10 @@ public function getSupportedDatabases($allowAllDatabases = false) {
 	 * Gathers system information like database type and does
 	 * a few system checks.
 	 *
+	 * @param bool $allowAllDatabases
 	 * @return array of system info, including an "errors" value
-	 * in case of errors/warnings
 	 */
-	public function getSystemInfo($allowAllDatabases = false) {
+	public function getSystemInfo(bool $allowAllDatabases = false): array {
 		$databases = $this->getSupportedDatabases($allowAllDatabases);
 
 		$dataDir = $this->config->getValue('datadirectory', \OC::$SERVERROOT . '/data');
@@ -270,11 +248,7 @@ public function getSystemInfo($allowAllDatabases = false) {
 		];
 	}
 
-	/**
-	 * @param $options
-	 * @return array
-	 */
-	public function install($options) {
+	public function install($options): array {
 		$l = $this->l10n;
 
 		$error = [];
@@ -448,7 +422,7 @@ public function install($options) {
 		return $error;
 	}
 
-	public static function installBackgroundJobs() {
+	public static function installBackgroundJobs(): void {
 		$jobList = \OC::$server->getJobList();
 		$jobList->add(TokenCleanupJob::class);
 		$jobList->add(Rotate::class);
@@ -458,7 +432,7 @@ public static function installBackgroundJobs() {
 	/**
 	 * @return string Absolute path to htaccess
 	 */
-	private function pathToHtaccess() {
+	private function pathToHtaccess(): string {
 		return \OC::$SERVERROOT . '/.htaccess';
 	}
 
@@ -493,7 +467,7 @@ private static function findWebRoot(SystemConfig $config): string {
 	 * @return bool True when success, False otherwise
 	 * @throws \OCP\AppFramework\QueryException
 	 */
-	public static function updateHtaccess() {
+	public static function updateHtaccess(): bool {
 		$config = \OC::$server->getSystemConfig();
 
 		try {
@@ -557,7 +531,7 @@ public static function updateHtaccess() {
 		return false;
 	}
 
-	public static function protectDataDirectory() {
+	public static function protectDataDirectory(): void {
 		//Require all denied
 		$now = date('Y-m-d H:i:s');
 		$content = "# Generated by Nextcloud on $now\n";
@@ -604,14 +578,14 @@ private function getVendorData(): array {
 	/**
 	 * @return bool
 	 */
-	public function shouldRemoveCanInstallFile() {
+	public function shouldRemoveCanInstallFile(): bool {
 		return \OC_Util::getChannel() !== 'git' && is_file(\OC::$configDir.'/CAN_INSTALL');
 	}
 
 	/**
 	 * @return bool
 	 */
-	public function canInstallFileExists() {
+	public function canInstallFileExists(): bool {
 		return is_file(\OC::$configDir.'/CAN_INSTALL');
 	}
 }

lib/private/StreamImage.php

@@ -34,24 +34,13 @@
  * valid result.
  */
 class StreamImage implements IStreamImage {
-	/** @var resource The internal stream */
-	private $stream;
-
-	/** @var null|string */
-	private $mimeType;
-
-	/** @var int */
-	private $width;
-
-	/** @var int */
-	private $height;
-
 	/** @param resource $stream */
-	public function __construct($stream, string $mimeType, int $width, int $height) {
-		$this->stream = $stream;
-		$this->mimeType = $mimeType;
-		$this->width = $width;
-		$this->height = $height;
+	public function __construct(
+		private $stream,
+		private ?string $mimeType,
+		private int $width,
+		private int $height,
+	) {
 	}
 
 	/** @inheritDoc */

lib/private/Streamer.php

@@ -43,7 +43,7 @@ class Streamer {
 	private array $preferTarFor = [ '/macintosh|mac os x/i' ];
 
 	// streamer instance
-	private $streamerInstance;
+	private ZipStreamer|TarStreamer $streamerInstance;
 
 	/**
 	 * Streamer constructor.
@@ -91,9 +91,10 @@ public function __construct(IRequest $request, int|float $size, int $numberOfFil
 
 	/**
 	 * Send HTTP headers
+	 *
 	 * @param string $name
 	 */
-	public function sendHeaders($name) {
+	public function sendHeaders(string $name): void {
 		header('X-Accel-Buffering: no');
 		$extension = $this->streamerInstance instanceof ZipStreamer ? '.zip' : '.tar';
 		$fullName = $name . $extension;
@@ -174,7 +175,7 @@ public function addFileFromStream($stream, string $internalName, int|float $size
 	 * @param string $dirName Directory Path and name to be added to the archive.
 	 * @return bool $success
 	 */
-	public function addEmptyDir($dirName) {
+	public function addEmptyDir(string $dirName): bool {
 		return $this->streamerInstance->addEmptyDir($dirName);
 	}
 
@@ -184,7 +185,7 @@ public function addEmptyDir($dirName) {
 	 * closing, the file is completely written to the output stream.
 	 * @return bool $success
 	 */
-	public function finalize() {
+	public function finalize(): bool {
 		return $this->streamerInstance->finalize();
 	}
 }

lib/private/SubAdmin.php

@@ -42,32 +42,12 @@
 use OCP\IUserManager;
 
 class SubAdmin extends PublicEmitter implements ISubAdmin {
-	/** @var IUserManager */
-	private $userManager;
-
-	/** @var IGroupManager */
-	private $groupManager;
-
-	/** @var IDBConnection */
-	private $dbConn;
-
-	/** @var IEventDispatcher */
-	private $eventDispatcher;
-
-	/**
-	 * @param IUserManager $userManager
-	 * @param IGroupManager $groupManager
-	 * @param IDBConnection $dbConn
-	 */
-	public function __construct(IUserManager $userManager,
-								IGroupManager $groupManager,
-								IDBConnection $dbConn,
-								IEventDispatcher $eventDispatcher) {
-		$this->userManager = $userManager;
-		$this->groupManager = $groupManager;
-		$this->dbConn = $dbConn;
-		$this->eventDispatcher = $eventDispatcher;
-
+	public function __construct(
+		private IUserManager $userManager,
+		private IGroupManager $groupManager,
+		private IDBConnection $dbConn,
+		private IEventDispatcher $eventDispatcher,
+	) {
 		$this->userManager->listen('\OC\User', 'postDelete', function ($user) {
 			$this->post_deleteUser($user);
 		});
@@ -240,7 +220,7 @@ public function isSubAdminOfGroup(IUser $user, IGroup $group): bool {
 
 		$fetch = $result->fetch();
 		$result->closeCursor();
-		$result = !empty($fetch) ? true : false;
+		$result = !empty($fetch);
 
 		return $result;
 	}
@@ -294,7 +274,7 @@ public function isUserAccessible(IUser $subadmin, IUser $user): bool {
 	 * delete all SubAdmins by $user
 	 * @param IUser $user
 	 */
-	private function post_deleteUser(IUser $user) {
+	private function post_deleteUser(IUser $user): void {
 		$qb = $this->dbConn->getQueryBuilder();
 
 		$qb->delete('group_admin')
@@ -306,7 +286,7 @@ private function post_deleteUser(IUser $user) {
 	 * delete all SubAdmins by $group
 	 * @param IGroup $group
 	 */
-	private function post_deleteGroup(IGroup $group) {
+	private function post_deleteGroup(IGroup $group): void {
 		$qb = $this->dbConn->getQueryBuilder();
 
 		$qb->delete('group_admin')

lib/private/SystemConfig.php

@@ -35,7 +35,7 @@
  */
 class SystemConfig {
 	/** @var array */
-	protected $sensitiveValues = [
+	protected array $sensitiveValues = [
 		'instanceid' => true,
 		'datadirectory' => true,
 		'dbname' => true,
@@ -120,18 +120,16 @@ class SystemConfig {
 		],
 	];
 
-	/** @var Config */
-	private $config;
-
-	public function __construct(Config $config) {
-		$this->config = $config;
+	public function __construct(
+		private Config $config,
+	) {
 	}
 
 	/**
 	 * Lists all available config keys
 	 * @return array an array of key names
 	 */
-	public function getKeys() {
+	public function getKeys(): array {
 		return $this->config->getKeys();
 	}
 
@@ -141,7 +139,7 @@ public function getKeys() {
 	 * @param string $key the key of the value, under which will be saved
 	 * @param mixed $value the value that should be stored
 	 */
-	public function setValue($key, $value) {
+	public function setValue(string $key, mixed $value): void {
 		$this->config->setValue($key, $value);
 	}
 
@@ -151,7 +149,7 @@ public function setValue($key, $value) {
 	 * @param array $configs Associative array with `key => value` pairs
 	 *                       If value is null, the config key will be deleted
 	 */
-	public function setValues(array $configs) {
+	public function setValues(array $configs): void {
 		$this->config->setValues($configs);
 	}
 
@@ -162,7 +160,7 @@ public function setValues(array $configs) {
 	 * @param mixed $default the default value to be returned if the value isn't set
 	 * @return mixed the value or $default
 	 */
-	public function getValue($key, $default = '') {
+	public function getValue(string $key, mixed $default = ''): mixed {
 		return $this->config->getValue($key, $default);
 	}
 
@@ -173,7 +171,7 @@ public function getValue($key, $default = '') {
 	 * @param mixed $default the default value to be returned if the value isn't set
 	 * @return mixed the value or $default
 	 */
-	public function getFilteredValue($key, $default = '') {
+	public function getFilteredValue(string $key, mixed $default = ''): mixed {
 		$value = $this->getValue($key, $default);
 
 		if (isset($this->sensitiveValues[$key])) {
@@ -188,7 +186,7 @@ public function getFilteredValue($key, $default = '') {
 	 *
 	 * @param string $key the key of the value, under which it was saved
 	 */
-	public function deleteValue($key) {
+	public function deleteValue(string $key): void {
 		$this->config->deleteKey($key);
 	}
 
@@ -197,7 +195,7 @@ public function deleteValue($key) {
 	 * @param mixed $value
 	 * @return mixed
 	 */
-	protected function removeSensitiveValue($keysToRemove, $value) {
+	protected function removeSensitiveValue(bool|array $keysToRemove, mixed $value): mixed {
 		if ($keysToRemove === true) {
 			return IConfig::SENSITIVE_VALUE;
 		}