thecodingmachine / utils.patcher

src/Mouf/Utils/Patcher/Commands/SkipPatchCommand.php

Indentation +34 added lines, -34 removed lines

@@ -15,45 +15,45 @@
  */
 class SkipPatchCommand extends Command
 {
-    /**
-     * @var PatchService
-     */
-    private $patchService;
+	/**
+	 * @var PatchService
+	 */
+	private $patchService;
 
-    public function __construct(PatchService $patchService)
-    {
-        parent::__construct();
-        $this->patchService = $patchService;
-    }
+	public function __construct(PatchService $patchService)
+	{
+		parent::__construct();
+		$this->patchService = $patchService;
+	}
 
 
-    /**
-     * {@inheritdoc}
-     */
-    protected function configure()
-    {
-        $this
-        ->setName('patches:skip')
-        ->setDescription('Skip a patch.')
-        ->addArgument(
-            'name',
-            InputArgument::REQUIRED,
-            'The name of the patch instance to be skipped'
-        )
-        ->setHelp(<<<EOT
+	/**
+	 * {@inheritdoc}
+	 */
+	protected function configure()
+	{
+		$this
+		->setName('patches:skip')
+		->setDescription('Skip a patch.')
+		->addArgument(
+			'name',
+			InputArgument::REQUIRED,
+			'The name of the patch instance to be skipped'
+		)
+		->setHelp(<<<EOT
 Skips a patch. You must pass in parameter the name of the patch.
 EOT
-        );
-    }
+		);
+	}
 
-    /**
-     * {@inheritdoc}
-     */
-    protected function execute(InputInterface $input, OutputInterface $output)
-    {
-        $patchName = $input->getArgument('name');
-        $this->patchService->skip($patchName);
+	/**
+	 * {@inheritdoc}
+	 */
+	protected function execute(InputInterface $input, OutputInterface $output)
+	{
+		$patchName = $input->getArgument('name');
+		$this->patchService->skip($patchName);
 
-        $output->writeln('Patch marked as skipped');
-    }
+		$output->writeln('Patch marked as skipped');
+	}
 }

src/Mouf/Utils/Patcher/PatchType.php

Indentation +55 added lines, -55 removed lines

@@ -8,64 +8,64 @@
 
 class PatchType implements \JsonSerializable
 {
-    /**
-     * @var string
-     */
-    private $name;
-    /**
-     * @var string
-     */
-    private $description;
+	/**
+	 * @var string
+	 */
+	private $name;
+	/**
+	 * @var string
+	 */
+	private $description;
 
-    /**
-     * @Important
-     * @param string $name The name of the patch type. Should not contain special characters or spaces. Note: the default type is an empty string.
-     * @param string $description The description of the patch type
-     * @throws PatchException
-     */
-    public function __construct(string $name, string $description)
-    {
-        if (!preg_match('/^[a-z_\-0-9]*$/i', $name)) {
-            throw new PatchException('A patch name can only contain alphanumeric characters and underscore. Name passed: "'.$name.'"');
-        }
+	/**
+	 * @Important
+	 * @param string $name The name of the patch type. Should not contain special characters or spaces. Note: the default type is an empty string.
+	 * @param string $description The description of the patch type
+	 * @throws PatchException
+	 */
+	public function __construct(string $name, string $description)
+	{
+		if (!preg_match('/^[a-z_\-0-9]*$/i', $name)) {
+			throw new PatchException('A patch name can only contain alphanumeric characters and underscore. Name passed: "'.$name.'"');
+		}
 
-        $this->name = $name;
-        $this->description = $description;
-    }
+		$this->name = $name;
+		$this->description = $description;
+	}
 
-    /**
-     * The name of the patch type. Should not contain special characters or spaces.
-     *
-     * @return string
-     */
-    public function getName(): string
-    {
-        return $this->name;
-    }
+	/**
+	 * The name of the patch type. Should not contain special characters or spaces.
+	 *
+	 * @return string
+	 */
+	public function getName(): string
+	{
+		return $this->name;
+	}
 
-    /**
-     * The description of the patch type.
-     *
-     * @return string
-     */
-    public function getDescription(): string
-    {
-        return $this->description;
-    }
+	/**
+	 * The description of the patch type.
+	 *
+	 * @return string
+	 */
+	public function getDescription(): string
+	{
+		return $this->description;
+	}
 
-    /**
-     * Specify data which should be serialized to JSON
-     * @link http://php.net/manual/en/jsonserializable.jsonserialize.php
-     * @return mixed data which can be serialized by <b>json_encode</b>,
-     * which is a value of any type other than a resource.
-     * @since 5.4.0
-     */
-    public function jsonSerialize()
-    {
-        return [
-            'name' => $this->name,
-            'description' => $this->description,
-            'instanceName' => MoufManager::getMoufManager()->findInstanceName($this)
-        ];
-    }
+	/**
+	 * Specify data which should be serialized to JSON
+	 * @link http://php.net/manual/en/jsonserializable.jsonserialize.php
+	 * @return mixed data which can be serialized by <b>json_encode</b>,
+	 * which is a value of any type other than a resource.
+	 * @since 5.4.0
+	 */
+	public function jsonSerialize()
+	{
+		return [
+			'name' => $this->name,
+			'description' => $this->description,
+			'instanceName' => MoufManager::getMoufManager()->findInstanceName($this)
+		];
+	}
 }

src/Mouf/Utils/Patcher/Commands/ListPatchesCommand.php

Indentation +50 added lines, -50 removed lines

@@ -15,66 +15,66 @@
  */
 class ListPatchesCommand extends Command
 {
-    /**
-     * @var PatchService
-     */
-    private $patchService;
+	/**
+	 * @var PatchService
+	 */
+	private $patchService;
 
-    public function __construct(PatchService $patchService)
-    {
-        parent::__construct();
-        $this->patchService = $patchService;
-    }
+	public function __construct(PatchService $patchService)
+	{
+		parent::__construct();
+		$this->patchService = $patchService;
+	}
 
 
-    /**
-     * {@inheritdoc}
-     */
-    protected function configure()
-    {
-        $this
-        ->setName('patches:list')
-        ->setDescription('List all the patches.')
-        ->setDefinition(array(
+	/**
+	 * {@inheritdoc}
+	 */
+	protected function configure()
+	{
+		$this
+		->setName('patches:list')
+		->setDescription('List all the patches.')
+		->setDefinition(array(
 
-        ))
-        ->setHelp(<<<EOT
+		))
+		->setHelp(<<<EOT
 List all patches declared in Mouf patch service.
 
 The command will display the status of each patch, i.e. whether it has been applied or skipped or is waiting to be applied.
 EOT
-        );
-    }
+		);
+	}
 
-    /**
-     * {@inheritdoc}
-     */
-    protected function execute(InputInterface $input, OutputInterface $output)
-    {
-        $patches = $this->patchService->getView();
+	/**
+	 * {@inheritdoc}
+	 */
+	protected function execute(InputInterface $input, OutputInterface $output)
+	{
+		$patches = $this->patchService->getView();
 
-        $rows = array_map(function($row) {
-            return [ $row['uniqueName'], $this->renderStatus($row['status']), $row['patch_type'] ?: '(default)' ];
-        }, $patches);
+		$rows = array_map(function($row) {
+			return [ $row['uniqueName'], $this->renderStatus($row['status']), $row['patch_type'] ?: '(default)' ];
+		}, $patches);
 
-        $table = new Table($output);
-        $table
-            ->setHeaders(array('Patch', 'Status', 'Type'))
-            ->setRows($rows)
-        ;
-        $table->render();
-    }
+		$table = new Table($output);
+		$table
+			->setHeaders(array('Patch', 'Status', 'Type'))
+			->setRows($rows)
+		;
+		$table->render();
+	}
 
-    private function renderStatus($status) {
-        $map = [
-            PatchInterface::STATUS_APPLIED => "<info>Applied</info>",
-            PatchInterface::STATUS_SKIPPED => "<comment>Skipped</comment>",
-            PatchInterface::STATUS_AWAITING => "Awaiting",
-            PatchInterface::STATUS_ERROR => "<error>Skipped</error>",
-        ];
-        if (!isset($map[$status])) {
-            throw new \Exception('Unexpected status "'.$map[$status].'"');
-        }
-        return $map[$status];
-    }
+	private function renderStatus($status) {
+		$map = [
+			PatchInterface::STATUS_APPLIED => "<info>Applied</info>",
+			PatchInterface::STATUS_SKIPPED => "<comment>Skipped</comment>",
+			PatchInterface::STATUS_AWAITING => "Awaiting",
+			PatchInterface::STATUS_ERROR => "<error>Skipped</error>",
+		];
+		if (!isset($map[$status])) {
+			throw new \Exception('Unexpected status "'.$map[$status].'"');
+		}
+		return $map[$status];
+	}
 }

src/Mouf/Utils/Patcher/PatchInterface.php

Indentation +14 added lines, -14 removed lines

@@ -39,20 +39,20 @@ 
 	/**
 	 * Skips the patch (sets its status to "skipped").
 	 */
-    public function skip(): void;
+	public function skip(): void;
 
 	/**
 	 * Reverts (cancels) the patch.
 	 * Note: patchs do not have to provide a "revert" feature (see canRevert method).
 	 */
-    public function revert(): void;
+	public function revert(): void;
 	
 	/**
 	 * Returns true if this patch can be canceled, false otherwise.
 	 * 
 	 * @return boolean
 	 */
-    public function canRevert(): bool;
+	public function canRevert(): bool;
 	
 	/**
 	 * Returns the status of this patch.
@@ -65,28 +65,28 @@ 
 	 * 
 	 * @return string
 	 */
-    public function getStatus(): string;
+	public function getStatus(): string;
 	
 	/**
 	 * Returns a unique name for this patch. 
 	 *
 	 * @return string
 	 */
-    public function getUniqueName(): string;
+	public function getUniqueName(): string;
 	
 	/**
 	 * Returns a short description of the patch.
 	 * 
 	 * @return string
 	 */
-    public function getDescription(): string;
+	public function getDescription(): string;
 	
 	/**
 	 * Returns the error message of the last action performed, or null if last action was successful.
 	 * 
 	 * @return string
 	 */
-    public function getLastErrorMessage(): ?string;
+	public function getLastErrorMessage(): ?string;
 	
 	/**
 	 * Returns the URL that can be used to edit this patch.
@@ -94,12 +94,12 @@ 
 	 * 
 	 * @return string
 	 */
-    public function getEditUrl(): ?string;
+	public function getEditUrl(): ?string;
 
-    /**
-     * Returns the type of the patch.
-     *
-     * @return PatchType
-     */
-    public function getPatchType() : PatchType;
+	/**
+	 * Returns the type of the patch.
+	 *
+	 * @return PatchType
+	 */
+	public function getPatchType() : PatchType;
 }

src/Mouf/Utils/Patcher/PatchInstaller3.php

Indentation +41 added lines, -41 removed lines

@@ -20,56 +20,56 @@
 
 class PatchInstaller3 implements PackageInstallerInterface
 {
-    /**
-     * (non-PHPdoc)
-     * @see \Mouf\Installer\PackageInstallerInterface::install()
-     * @param  MoufManager         $moufManager
-     * @throws \Mouf\MoufException
-     */
-    public static function install(MoufManager $moufManager)
-    {
-        // Let's create the instance.
-        $patchDefaultType = InstallUtils::getOrCreateInstance('patch.default_type', PatchType::class, $moufManager);
-        $patchDefaultType->getConstructorArgumentProperty('name')->setValue('');
-        $patchDefaultType->getConstructorArgumentProperty('description')->setValue('Patches that should be always applied should have this type. Typically, use this type for DDL changes or reference data insertion.');
+	/**
+	 * (non-PHPdoc)
+	 * @see \Mouf\Installer\PackageInstallerInterface::install()
+	 * @param  MoufManager         $moufManager
+	 * @throws \Mouf\MoufException
+	 */
+	public static function install(MoufManager $moufManager)
+	{
+		// Let's create the instance.
+		$patchDefaultType = InstallUtils::getOrCreateInstance('patch.default_type', PatchType::class, $moufManager);
+		$patchDefaultType->getConstructorArgumentProperty('name')->setValue('');
+		$patchDefaultType->getConstructorArgumentProperty('description')->setValue('Patches that should be always applied should have this type. Typically, use this type for DDL changes or reference data insertion.');
 
-        $patchTestDataType = InstallUtils::getOrCreateInstance('patch.testdata_type', PatchType::class, $moufManager);
-        $patchTestDataType->getConstructorArgumentProperty('name')->setValue('test_data');
-        $patchTestDataType->getConstructorArgumentProperty('description')->setValue('Use this type to mark patches that contain test data that should only be used in staging environment.');
+		$patchTestDataType = InstallUtils::getOrCreateInstance('patch.testdata_type', PatchType::class, $moufManager);
+		$patchTestDataType->getConstructorArgumentProperty('name')->setValue('test_data');
+		$patchTestDataType->getConstructorArgumentProperty('description')->setValue('Use this type to mark patches that contain test data that should only be used in staging environment.');
 
-        $patchService = InstallUtils::getOrCreateInstance('patchService', PatchService::class, $moufManager);
+		$patchService = InstallUtils::getOrCreateInstance('patchService', PatchService::class, $moufManager);
 
-        if (empty($patchService->getConstructorArgumentProperty('types')->getValue())) {
-            $patchService->getConstructorArgumentProperty('types')->setValue([ $patchDefaultType, $patchTestDataType ]);
-        }
+		if (empty($patchService->getConstructorArgumentProperty('types')->getValue())) {
+			$patchService->getConstructorArgumentProperty('types')->setValue([ $patchDefaultType, $patchTestDataType ]);
+		}
 
-        $consoleUtils = new ConsoleUtils($moufManager);
+		$consoleUtils = new ConsoleUtils($moufManager);
 
-        $listPatchesCommand = $moufManager->createInstance(ListPatchesCommand::class);
-        $listPatchesCommand->getConstructorArgumentProperty("patchService")->setValue($patchService);
-        $consoleUtils->registerCommand($listPatchesCommand);
+		$listPatchesCommand = $moufManager->createInstance(ListPatchesCommand::class);
+		$listPatchesCommand->getConstructorArgumentProperty("patchService")->setValue($patchService);
+		$consoleUtils->registerCommand($listPatchesCommand);
 
-        $applyAllPatchesCommand = $moufManager->createInstance(ApplyAllPatchesCommand::class);
-        $applyAllPatchesCommand->getConstructorArgumentProperty("patchService")->setValue($patchService);
-        $consoleUtils->registerCommand($applyAllPatchesCommand);
+		$applyAllPatchesCommand = $moufManager->createInstance(ApplyAllPatchesCommand::class);
+		$applyAllPatchesCommand->getConstructorArgumentProperty("patchService")->setValue($patchService);
+		$consoleUtils->registerCommand($applyAllPatchesCommand);
 
-        $applyPatchCommand = $moufManager->createInstance(ApplyPatchCommand::class);
-        $applyPatchCommand->getConstructorArgumentProperty("patchService")->setValue($patchService);
-        $consoleUtils->registerCommand($applyPatchCommand);
+		$applyPatchCommand = $moufManager->createInstance(ApplyPatchCommand::class);
+		$applyPatchCommand->getConstructorArgumentProperty("patchService")->setValue($patchService);
+		$consoleUtils->registerCommand($applyPatchCommand);
 
-        $skipPatchCommand = $moufManager->createInstance(SkipPatchCommand::class);
-        $skipPatchCommand->getConstructorArgumentProperty("patchService")->setValue($patchService);
-        $consoleUtils->registerCommand($skipPatchCommand);
+		$skipPatchCommand = $moufManager->createInstance(SkipPatchCommand::class);
+		$skipPatchCommand->getConstructorArgumentProperty("patchService")->setValue($patchService);
+		$consoleUtils->registerCommand($skipPatchCommand);
 
-        $revertPatchCommand = $moufManager->createInstance(RevertPatchCommand::class);
-        $revertPatchCommand->getConstructorArgumentProperty("patchService")->setValue($patchService);
-        $consoleUtils->registerCommand($revertPatchCommand);
+		$revertPatchCommand = $moufManager->createInstance(RevertPatchCommand::class);
+		$revertPatchCommand->getConstructorArgumentProperty("patchService")->setValue($patchService);
+		$consoleUtils->registerCommand($revertPatchCommand);
 
-        $resetPatchCommand = $moufManager->createInstance(ResetPatchesCommand::class);
-        $resetPatchCommand->getConstructorArgumentProperty("patchService")->setValue($patchService);
-        $consoleUtils->registerCommand($resetPatchCommand);
+		$resetPatchCommand = $moufManager->createInstance(ResetPatchesCommand::class);
+		$resetPatchCommand->getConstructorArgumentProperty("patchService")->setValue($patchService);
+		$consoleUtils->registerCommand($resetPatchCommand);
 
-        // Let's rewrite the MoufComponents.php file to save the component
-        $moufManager->rewriteMouf();
-    }
+		// Let's rewrite the MoufComponents.php file to save the component
+		$moufManager->rewriteMouf();
+	}
 }

src/Mouf/Utils/Patcher/PatchListenerInterface.php

Indentation +10 added lines, -10 removed lines

@@ -8,16 +8,16 @@
  */
 interface PatchListenerInterface
 {
-    /**
-     * Triggered when the 'reset()' method is called on the PatchService
-     */
-    public function onReset(): void;
+	/**
+	 * Triggered when the 'reset()' method is called on the PatchService
+	 */
+	public function onReset(): void;
 
-    /**
-     * Triggered when one or many patches have been applied.
-     *
-     * @param PatchInterface[] $patches
-     */
-    //public function onPatchesApplied(array $patches): void;
+	/**
+	 * Triggered when one or many patches have been applied.
+	 *
+	 * @param PatchInterface[] $patches
+	 */
+	//public function onPatchesApplied(array $patches): void;
 
 }
\ No newline at end of file

src/Mouf/Utils/Patcher/Controllers/PatchController.php

Unused Use Statements -9 removed lines

@@ -2,16 +2,7 @@
 namespace Mouf\Utils\Patcher\Controllers;
 
 use Mouf\Controllers\AbstractMoufInstanceController;
-
-use Mouf\Database\TDBM\Utils\TDBMDaoGenerator;
-
 use Mouf\Html\Widgets\MessageService\Service\UserMessageInterface;
-use Mouf\MoufManager;
-
-use Mouf\Mvc\Splash\Controllers\Controller;
-
-use Mouf\Reflection\MoufReflectionProxy;
-
 use Mouf\Html\HtmlElement\HtmlBlock;
 use Mouf\InstanceProxy;
 use Mouf\Utils\Patcher\PatchException;

Indentation +97 added lines, -98 removed lines

@@ -20,7 +20,6 @@ 
 
 /**
  * The controller to track which patchs have been applied.
-
  */
 class PatchController extends AbstractMoufInstanceController {
 	
@@ -99,115 +98,115 @@ 
 		header('Location: .?name='.urlencode($name));
 	}
 
-    /**
-     * Displays the page to select the patch types to be applied.
-     *
-     * @Action
-     * @Logged
-     * @param string $name
-     * @param string $selfedit
-     * @param string $action One of "reset" or "apply"
-     */
-    public function runAllPatches($name, $selfedit, $action) {
-        $this->initController($name, $selfedit);
-
-        $patchService = new InstanceProxy($name, $selfedit == "true");
-        $this->patchesArray = $patchService->getView();
-
-        $types = $patchService->_getSerializedTypes();
-
-        foreach ($types as $type) {
-            $this->nbPatchesByType[$type['name']] = 0;
-        }
-
-        $nbNoneDefaultPatches = 0;
-
-        foreach ($this->patchesArray as $patch) {
-            if ($action === 'reset' || $patch['status'] === PatchInterface::STATUS_AWAITING || $patch['status'] === PatchInterface::STATUS_ERROR) {
-                $type = $patch['patch_type'];
-                if ($type !== '') {
-                    $nbNoneDefaultPatches++;
-                }
-                $this->nbPatchesByType[$type]++;
-            }
-        }
-
-        // If all patches to be applied are default patches, let's do this right now.
-        if ($nbNoneDefaultPatches === 0) {
-            $this->applyAllPatches($name, [''], $action, $selfedit);
-            return;
-        }
-
-        ksort($this->nbPatchesByType);
-
-        $this->action = $action;
-
-        // Otherwise, let's display a screen to select the patch types to be applied.
-        $this->content->addFile(__DIR__."/../../../../views/applyPatches.php", $this);
-        $this->template->toHtml();
-    }
-
-
-    /**
-     * Runs all patches in a row.
-     *
-     * @Action
-     * @Logged
-     * @param string $name
-     * @param string[] $types
-     * @param string $action One of "reset" or "apply"
-     * @param string $selfedit
-     */
+	/**
+	 * Displays the page to select the patch types to be applied.
+	 *
+	 * @Action
+	 * @Logged
+	 * @param string $name
+	 * @param string $selfedit
+	 * @param string $action One of "reset" or "apply"
+	 */
+	public function runAllPatches($name, $selfedit, $action) {
+		$this->initController($name, $selfedit);
+
+		$patchService = new InstanceProxy($name, $selfedit == "true");
+		$this->patchesArray = $patchService->getView();
+
+		$types = $patchService->_getSerializedTypes();
+
+		foreach ($types as $type) {
+			$this->nbPatchesByType[$type['name']] = 0;
+		}
+
+		$nbNoneDefaultPatches = 0;
+
+		foreach ($this->patchesArray as $patch) {
+			if ($action === 'reset' || $patch['status'] === PatchInterface::STATUS_AWAITING || $patch['status'] === PatchInterface::STATUS_ERROR) {
+				$type = $patch['patch_type'];
+				if ($type !== '') {
+					$nbNoneDefaultPatches++;
+				}
+				$this->nbPatchesByType[$type]++;
+			}
+		}
+
+		// If all patches to be applied are default patches, let's do this right now.
+		if ($nbNoneDefaultPatches === 0) {
+			$this->applyAllPatches($name, [''], $action, $selfedit);
+			return;
+		}
+
+		ksort($this->nbPatchesByType);
+
+		$this->action = $action;
+
+		// Otherwise, let's display a screen to select the patch types to be applied.
+		$this->content->addFile(__DIR__."/../../../../views/applyPatches.php", $this);
+		$this->template->toHtml();
+	}
+
+
+	/**
+	 * Runs all patches in a row.
+	 *
+	 * @Action
+	 * @Logged
+	 * @param string $name
+	 * @param string[] $types
+	 * @param string $action One of "reset" or "apply"
+	 * @param string $selfedit
+	 */
 	public function applyAllPatches($name, array $types, $action, $selfedit) {
 		$patchService = new InstanceProxy($name, $selfedit == "true");
 		/* @var $patchService PatchService */
 
-        if ($action === 'reset') {
-            $patchService->reset();
-        }
-        try {
+		if ($action === 'reset') {
+			$patchService->reset();
+		}
+		try {
 
-            [
-                'applied' => $appliedPatchArray,
-                'skipped' => $skippedPatchArray
-            ] = $patchService->applyAll($types);
+			[
+				'applied' => $appliedPatchArray,
+				'skipped' => $skippedPatchArray
+			] = $patchService->applyAll($types);
 
-            $this->displayNotificationMessage($appliedPatchArray, $skippedPatchArray);
-        } catch (\Exception $e) {
+			$this->displayNotificationMessage($appliedPatchArray, $skippedPatchArray);
+		} catch (\Exception $e) {
 			$htmlMessage = "An error occured while applying the patch: ".$e->getMessage();
 			set_user_message($htmlMessage);
 		}
 
 
-        header('Location: .?name='.urlencode($name));
+		header('Location: .?name='.urlencode($name));
 	}
 
 	private function displayNotificationMessage(array $appliedPatchArray, array $skippedPatchArray)
-    {
-        $nbPatchesApplied = array_sum($appliedPatchArray);
-        $nbPatchesSkipped = array_sum($skippedPatchArray);
-        $msg = '';
-        if ($nbPatchesApplied !== 0) {
-            $patchArr = [];
-            foreach ($appliedPatchArray as $name => $number) {
-                $name = $name ?: 'default';
-                $patchArr[] = plainstring_to_htmlprotected($name).': '.$number;
-            }
-
-            $msg .= sprintf('%d patch%s applied (%s)', $nbPatchesApplied, ($nbPatchesApplied > 1)?'es':'', implode(', ', $patchArr));
-        }
-        if ($nbPatchesSkipped !== 0) {
-            $patchArr = [];
-            foreach ($skippedPatchArray as $name => $number) {
-                $name = $name ?: 'default';
-                $patchArr[] = plainstring_to_htmlprotected($name).': '.$number;
-            }
-
-            $msg .= sprintf('%d patch%s skipped (%s)', $nbPatchesSkipped, ($nbPatchesSkipped > 1)?'es':'', implode(', ', $patchArr));
-        }
-
-        if ($msg !== '') {
-            set_user_message($msg, UserMessageInterface::SUCCESS);
-        }
-    }
+	{
+		$nbPatchesApplied = array_sum($appliedPatchArray);
+		$nbPatchesSkipped = array_sum($skippedPatchArray);
+		$msg = '';
+		if ($nbPatchesApplied !== 0) {
+			$patchArr = [];
+			foreach ($appliedPatchArray as $name => $number) {
+				$name = $name ?: 'default';
+				$patchArr[] = plainstring_to_htmlprotected($name).': '.$number;
+			}
+
+			$msg .= sprintf('%d patch%s applied (%s)', $nbPatchesApplied, ($nbPatchesApplied > 1)?'es':'', implode(', ', $patchArr));
+		}
+		if ($nbPatchesSkipped !== 0) {
+			$patchArr = [];
+			foreach ($skippedPatchArray as $name => $number) {
+				$name = $name ?: 'default';
+				$patchArr[] = plainstring_to_htmlprotected($name).': '.$number;
+			}
+
+			$msg .= sprintf('%d patch%s skipped (%s)', $nbPatchesSkipped, ($nbPatchesSkipped > 1)?'es':'', implode(', ', $patchArr));
+		}
+
+		if ($msg !== '') {
+			set_user_message($msg, UserMessageInterface::SUCCESS);
+		}
+	}
 }
\ No newline at end of file

src/Mouf/Utils/Patcher/Commands/AbstractApplyAllCommand.php

Indentation +77 added lines, -77 removed lines

@@ -12,81 +12,81 @@
 
 class AbstractApplyAllCommand extends Command
 {
-    /**
-     * @var PatchService
-     */
-    protected $patchService;
-
-    public function __construct(PatchService $patchService)
-    {
-        $this->patchService = $patchService;
-        parent::__construct();
-    }
-
-    protected function registerOptions(): void
-    {
-        foreach ($this->patchService->getTypes() as $type) {
-            if ($type->getName() !== '') {
-                $this->addOption($type->getName(), null, InputOption::VALUE_NONE, 'Applies patches of type "'.$type->getName().'". '.$type->getDescription());
-            }
-        }
-    }
-
-    protected function applyAll(InputInterface $input, OutputInterface $output)
-    {
-        $types = [];
-        foreach ($this->patchService->getTypes() as $type) {
-            if ($type->getName() !== '' && $input->getOption($type->getName())) {
-                $types[] = $type->getName();
-            }
-        }
-
-        try {
-
-            [
-                'applied' => $appliedPatchArray,
-                'skipped' => $skippedPatchArray
-            ] = $this->patchService->applyAll($types);
-
-        } catch (\Exception $e) {
-            $output->writeln(sprintf(
-                'An error occurred while applying patch: <error>%s</error>', $e->getMessage()
-            ));
-            throw $e;
-        }
-
-        $msg = $this->getNotificationMessage($appliedPatchArray, $skippedPatchArray);
-        if ($msg) {
-            $output->writeln($msg);
-        } else {
-            $output->writeln('<info>No patches to apply</info>');
-        }
-    }
-
-    private function getNotificationMessage(array $appliedPatchArray, array $skippedPatchArray): string
-    {
-        $nbPatchesApplied = array_sum($appliedPatchArray);
-        $nbPatchesSkipped = array_sum($skippedPatchArray);
-        $msg = '';
-        if ($nbPatchesApplied !== 0) {
-            $patchArr = [];
-            foreach ($appliedPatchArray as $name => $number) {
-                $name = $name ?: 'default';
-                $patchArr[] = $name.': <info>'.$number.'</info>';
-            }
-
-            $msg .= sprintf('<info>%d</info> patch%s applied (%s)', $nbPatchesApplied, ($nbPatchesApplied > 1)?'es':'', implode(', ', $patchArr))."\n";
-        }
-        if ($nbPatchesSkipped !== 0) {
-            $patchArr = [];
-            foreach ($skippedPatchArray as $name => $number) {
-                $name = $name ?: 'default';
-                $patchArr[] = $name.': <info>'.$number.'</info>';
-            }
-
-            $msg .= sprintf('<info>%d</info><comment> patch%s skipped</comment> (%s)', $nbPatchesSkipped, ($nbPatchesSkipped > 1)?'es':'', implode(', ', $patchArr));
-        }
-
-        return $msg;
-    }
+	/**
+	 * @var PatchService
+	 */
+	protected $patchService;
+
+	public function __construct(PatchService $patchService)
+	{
+		$this->patchService = $patchService;
+		parent::__construct();
+	}
+
+	protected function registerOptions(): void
+	{
+		foreach ($this->patchService->getTypes() as $type) {
+			if ($type->getName() !== '') {
+				$this->addOption($type->getName(), null, InputOption::VALUE_NONE, 'Applies patches of type "'.$type->getName().'". '.$type->getDescription());
+			}
+		}
+	}
+
+	protected function applyAll(InputInterface $input, OutputInterface $output)
+	{
+		$types = [];
+		foreach ($this->patchService->getTypes() as $type) {
+			if ($type->getName() !== '' && $input->getOption($type->getName())) {
+				$types[] = $type->getName();
+			}
+		}
+
+		try {
+
+			[
+				'applied' => $appliedPatchArray,
+				'skipped' => $skippedPatchArray
+			] = $this->patchService->applyAll($types);
+
+		} catch (\Exception $e) {
+			$output->writeln(sprintf(
+				'An error occurred while applying patch: <error>%s</error>', $e->getMessage()
+			));
+			throw $e;
+		}
+
+		$msg = $this->getNotificationMessage($appliedPatchArray, $skippedPatchArray);
+		if ($msg) {
+			$output->writeln($msg);
+		} else {
+			$output->writeln('<info>No patches to apply</info>');
+		}
+	}
+
+	private function getNotificationMessage(array $appliedPatchArray, array $skippedPatchArray): string
+	{
+		$nbPatchesApplied = array_sum($appliedPatchArray);
+		$nbPatchesSkipped = array_sum($skippedPatchArray);
+		$msg = '';
+		if ($nbPatchesApplied !== 0) {
+			$patchArr = [];
+			foreach ($appliedPatchArray as $name => $number) {
+				$name = $name ?: 'default';
+				$patchArr[] = $name.': <info>'.$number.'</info>';
+			}
+
+			$msg .= sprintf('<info>%d</info> patch%s applied (%s)', $nbPatchesApplied, ($nbPatchesApplied > 1)?'es':'', implode(', ', $patchArr))."\n";
+		}
+		if ($nbPatchesSkipped !== 0) {
+			$patchArr = [];
+			foreach ($skippedPatchArray as $name => $number) {
+				$name = $name ?: 'default';
+				$patchArr[] = $name.': <info>'.$number.'</info>';
+			}
+
+			$msg .= sprintf('<info>%d</info><comment> patch%s skipped</comment> (%s)', $nbPatchesSkipped, ($nbPatchesSkipped > 1)?'es':'', implode(', ', $patchArr));
+		}
+
+		return $msg;
+	}
 }
\ No newline at end of file

src/Mouf/Utils/Patcher/PatchService.php

Indentation +109 added lines, -109 removed lines

@@ -32,47 +32,47 @@ 
  * @ExtendedAction {"name":"View patches list", "url":"patcher/", "default":false}
  */
 class PatchService implements MoufValidatorInterface, DumpableInterface {
-    const IFEXISTS_EXCEPTION = "exception";
-    const IFEXISTS_IGNORE = "ignore";
+	const IFEXISTS_EXCEPTION = "exception";
+	const IFEXISTS_IGNORE = "ignore";
 
 
-    /**
+	/**
 	 * The list of patches declared for this application.
 	 * 
 	 * @var PatchInterface[]
 	 */
 	private $patchs = [];
 
-    /**
-     * The list of exiting patch types for this application.
-     *
-     * @var PatchType[]
-     */
+	/**
+	 * The list of exiting patch types for this application.
+	 *
+	 * @var PatchType[]
+	 */
 	private $types = [];
 
-    /**
-     * The list of listeners on the patch service.
-     *
-     * @var array|PatchListenerInterface[]
-     */
-    private $listeners;
+	/**
+	 * The list of listeners on the patch service.
+	 *
+	 * @var array|PatchListenerInterface[]
+	 */
+	private $listeners;
 
-    /**
-     * @var DumperInterface
-     */
-    private $dumper;
+	/**
+	 * @var DumperInterface
+	 */
+	private $dumper;
 
-    /**
-     * @param PatchType[] $types
-     * @param PatchListenerInterface[] $listeners
-     */
-    public function __construct(array $types, array $listeners = [])
-    {
-        $this->types = $types;
-        $this->listeners = $listeners;
-    }
+	/**
+	 * @param PatchType[] $types
+	 * @param PatchListenerInterface[] $listeners
+	 */
+	public function __construct(array $types, array $listeners = [])
+	{
+		$this->types = $types;
+		$this->listeners = $listeners;
+	}
 
-    /**
+	/**
 	 * The list of patches declared for this application.
 	 * @param PatchInterface[] $patchs
 	 * @return PatchService
@@ -82,26 +82,26 @@ 
 		return $this;
 	}
 
-    /**
-     * The list of exiting patch types for this application.
-     *
-     * @return PatchType[]
-     */
-    public function getTypes(): array
-    {
-        return $this->types;
-    }
+	/**
+	 * The list of exiting patch types for this application.
+	 *
+	 * @return PatchType[]
+	 */
+	public function getTypes(): array
+	{
+		return $this->types;
+	}
 
-    /**
-     * @internal Returns a serialized list of types for the patch UI.
-     * @return array
-     */
-    public function _getSerializedTypes(): array
-    {
-        return array_map(function(PatchType $type) {
-            return $type->jsonSerialize();
-        }, $this->types);
-    }
+	/**
+	 * @internal Returns a serialized list of types for the patch UI.
+	 * @return array
+	 */
+	public function _getSerializedTypes(): array
+	{
+		return array_map(function(PatchType $type) {
+			return $type->jsonSerialize();
+		}, $this->types);
+	}
 
 	/**
 	 * Adds this patch to the list of existing patches.
@@ -230,8 +230,8 @@ 
 	
 	/**
 	 * Returns a PHP array representing the patchs.
-     *
-     * @internal
+	 *
+	 * @internal
 	 */
 	public function getView(): array {
 		$view = array();
@@ -265,7 +265,7 @@ 
 				"description"=>$description,
 				"error_message"=>$error_message,
 				"edit_url"=>$editUrl,
-                "patch_type"=>$patchType
+				"patch_type"=>$patchType
 			);
 			$view[] = $patchView;
 		}
@@ -279,9 +279,9 @@ 
 	public function apply($uniqueName): void {
 		$patch = $this->get($uniqueName);
 		if ($patch instanceof DumpableInterface && $this->dumper !== null) {
-		    $patch->setDumper($this->dumper);
-        }
-        // TODO: in next major version, get rid of the DumpableInterface and pass the dumper right in the apply method.
+			$patch->setDumper($this->dumper);
+		}
+		// TODO: in next major version, get rid of the DumpableInterface and pass the dumper right in the apply method.
 		$patch->apply();
 	}
 	
@@ -291,9 +291,9 @@ 
 	 */
 	public function skip($uniqueName): void {
 		$patch = $this->get($uniqueName);
-        if ($patch instanceof DumpableInterface && $this->dumper !== null) {
-            $patch->setDumper($this->dumper);
-        }
+		if ($patch instanceof DumpableInterface && $this->dumper !== null) {
+			$patch->setDumper($this->dumper);
+		}
 		$patch->skip();
 	}
 	
@@ -304,66 +304,66 @@ 
 	 */
 	public function revert($uniqueName): void {
 		$patch = $this->get($uniqueName);
-        if ($patch instanceof DumpableInterface && $this->dumper !== null) {
-            $patch->setDumper($this->dumper);
-        }
+		if ($patch instanceof DumpableInterface && $this->dumper !== null) {
+			$patch->setDumper($this->dumper);
+		}
 		$patch->revert();
 	}
 
-    /**
-     * Apply all remaining patches (patches in state "awaiting" or in "error").
-     * The types of the patches can be passed as an array of string where the string is the name of the patch.
-     * Patches with the "default" type are always applied.
-     *
-     * @param string[] $types
-     * @return array An array containing 2 keys: "applied" and "skipped". Each key contains an associative array with the type of the patch and the number of patches of this type applied.
-     */
+	/**
+	 * Apply all remaining patches (patches in state "awaiting" or in "error").
+	 * The types of the patches can be passed as an array of string where the string is the name of the patch.
+	 * Patches with the "default" type are always applied.
+	 *
+	 * @param string[] $types
+	 * @return array An array containing 2 keys: "applied" and "skipped". Each key contains an associative array with the type of the patch and the number of patches of this type applied.
+	 */
 	public function applyAll(array $types = []): array {
-        // Array of count of applied and skipped patches. Key is the patch type.
-        $appliedPatchArray = [];
-        $skippedPatchArray = [];
+		// Array of count of applied and skipped patches. Key is the patch type.
+		$appliedPatchArray = [];
+		$skippedPatchArray = [];
 
-        foreach ($this->patchs as $patch) {
-            if ($patch->getStatus() === PatchInterface::STATUS_AWAITING || $patch->getStatus() === PatchInterface::STATUS_ERROR) {
-                $type = $patch->getPatchType()->getName();
-                if ($type === '' || in_array($type, $types, true)) {
-                    $this->apply($patch->getUniqueName());
-                    if (!isset($appliedPatchArray[$type])) {
-                        $appliedPatchArray[$type] = 0;
-                    }
-                    $appliedPatchArray[$type]++;
-                } else {
-                    $this->skip($patch->getUniqueName());
-                    if (!isset($skippedPatchArray[$type])) {
-                        $skippedPatchArray[$type] = 0;
-                    }
-                    $skippedPatchArray[$type]++;
-                }
-            }
-        }
+		foreach ($this->patchs as $patch) {
+			if ($patch->getStatus() === PatchInterface::STATUS_AWAITING || $patch->getStatus() === PatchInterface::STATUS_ERROR) {
+				$type = $patch->getPatchType()->getName();
+				if ($type === '' || in_array($type, $types, true)) {
+					$this->apply($patch->getUniqueName());
+					if (!isset($appliedPatchArray[$type])) {
+						$appliedPatchArray[$type] = 0;
+					}
+					$appliedPatchArray[$type]++;
+				} else {
+					$this->skip($patch->getUniqueName());
+					if (!isset($skippedPatchArray[$type])) {
+						$skippedPatchArray[$type] = 0;
+					}
+					$skippedPatchArray[$type]++;
+				}
+			}
+		}
 
-        return [
-            'applied' => $appliedPatchArray,
-            'skipped' => $skippedPatchArray
-        ];
-    }
+		return [
+			'applied' => $appliedPatchArray,
+			'skipped' => $skippedPatchArray
+		];
+	}
 
-    /**
-     * Reset all patches to a not applied state.
-     *
-     * Note: this does NOT run the "revert" method on each patch but DOES trigger a "reset" event.
-     */
+	/**
+	 * Reset all patches to a not applied state.
+	 *
+	 * Note: this does NOT run the "revert" method on each patch but DOES trigger a "reset" event.
+	 */
 	public function reset(): void {
-        foreach ($this->listeners as $listener) {
-            if ($listener instanceof DumpableInterface && $this->dumper !== null) {
-                $listener->setDumper($this->dumper);
-            }
-            $listener->onReset();
-        }
-    }
+		foreach ($this->listeners as $listener) {
+			if ($listener instanceof DumpableInterface && $this->dumper !== null) {
+				$listener->setDumper($this->dumper);
+			}
+			$listener->onReset();
+		}
+	}
 
-    public function setDumper(DumperInterface $dumper)
-    {
-        $this->dumper = $dumper;
-    }
+	public function setDumper(DumperInterface $dumper)
+	{
+		$this->dumper = $dumper;
+	}
 }