OCA\CMSPico\Migration\MigrationTrait

Complexity

Total Complexity

16

Size/Duplication

Total Lines	85
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	logWarning()	0	9	3
A	setOutput()	0	3	1
B	logChanges()	0	25	8
A	logInfo()	0	9	3
A	setLogger()	0	3	1

<?php
/**
 * CMS Pico - Create websites using Pico CMS for Nextcloud.
 *
 * @copyright Copyright (c) 2019, Daniel Rudolf (<picocms.org@daniel-rudolf.de>)
 *
 * @license GNU AGPL version 3 or any later version
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace OCA\CMSPico\Migration;

use OCA\CMSPico\AppInfo\Application;
use OCP\ILogger;
use OCP\Migration\IOutput;

trait MigrationTrait
{
	/** @var ILogger */
	private $logger;

	/** @var IOutput */
	private $output;

	/**
	 * @param ILogger $logger
	 */
	protected function setLogger(ILogger $logger)
	{
		$this->logger = $logger;
	}

	/**
	 * @param IOutput $output
	 */
	protected function setOutput(IOutput $output)
	{
		$this->output = $output;
	}

	/**
	 * @param string  $message
	 * @param mixed[] ...$arguments
	 */
	protected function logInfo(string $message, ...$arguments)
	{
		if (!$this->logger || !$this->output) {
			throw new \LogicException('No logger or output instance set');
		}

		$message = sprintf($message, ...$arguments);
		$this->logger->log(ILogger::INFO, $message, [ 'app' => Application::APP_NAME ]);
		$this->output->info($message);
	}

	/**
	 * @param string $message
	 * @param mixed[] ...$arguments
	 */
	protected function logWarning(string $message, ...$arguments)
	{
		if (!$this->logger || !$this->output) {
			throw new \LogicException('No logger or output instance set');
		}

		$message = sprintf($message, ...$arguments);
		$this->logger->log(ILogger::WARN, $message, [ 'app' => Application::APP_NAME ]);
		$this->output->warning($message);
	}

	/**
	 * @param string $title
	 * @param array  $newItems
	 * @param array  $oldItems
	 * @param bool   $warnUpdates
	 */
	protected function logChanges(string $title, array $newItems, array $oldItems, bool $warnUpdates = false)
	{
		if (!$this->logger || !$this->output) {
			throw new \LogicException('No logger or output instance set');
		}

		$addedItems = array_diff($newItems, $oldItems);
		foreach ($addedItems as $item) {
			$this->logInfo('Adding %s "%s"', $title, $item);
		}

		$updatedItems = array_intersect($newItems, $oldItems);
		if ($warnUpdates) {
			foreach ($updatedItems as $item) {
				$this->logWarning('Replacing %s "%s"', $title, $item);
			}
		} else {
			foreach ($updatedItems as $item) {
				$this->logInfo('Keeping %s "%s"', $title, $item);
			}
		}

		$removedItems = array_diff($oldItems, $newItems);
		foreach ($removedItems as $item) {
			$this->logWarning('Removing %s "%s"', $title, $item);
		}
	}
}