@@ -15,45 +15,45 @@ |
||
| 15 | 15 | */ |
| 16 | 16 | class SkipPatchCommand extends Command |
| 17 | 17 | { |
| 18 | - /** |
|
| 19 | - * @var PatchService |
|
| 20 | - */ |
|
| 21 | - private $patchService; |
|
| 18 | + /** |
|
| 19 | + * @var PatchService |
|
| 20 | + */ |
|
| 21 | + private $patchService; |
|
| 22 | 22 | |
| 23 | - public function __construct(PatchService $patchService) |
|
| 24 | - { |
|
| 25 | - parent::__construct(); |
|
| 26 | - $this->patchService = $patchService; |
|
| 27 | - } |
|
| 23 | + public function __construct(PatchService $patchService) |
|
| 24 | + { |
|
| 25 | + parent::__construct(); |
|
| 26 | + $this->patchService = $patchService; |
|
| 27 | + } |
|
| 28 | 28 | |
| 29 | 29 | |
| 30 | - /** |
|
| 31 | - * {@inheritdoc} |
|
| 32 | - */ |
|
| 33 | - protected function configure() |
|
| 34 | - { |
|
| 35 | - $this |
|
| 36 | - ->setName('patches:skip') |
|
| 37 | - ->setDescription('Skip a patch.') |
|
| 38 | - ->addArgument( |
|
| 39 | - 'name', |
|
| 40 | - InputArgument::REQUIRED, |
|
| 41 | - 'The name of the patch instance to be skipped' |
|
| 42 | - ) |
|
| 43 | - ->setHelp(<<<EOT |
|
| 30 | + /** |
|
| 31 | + * {@inheritdoc} |
|
| 32 | + */ |
|
| 33 | + protected function configure() |
|
| 34 | + { |
|
| 35 | + $this |
|
| 36 | + ->setName('patches:skip') |
|
| 37 | + ->setDescription('Skip a patch.') |
|
| 38 | + ->addArgument( |
|
| 39 | + 'name', |
|
| 40 | + InputArgument::REQUIRED, |
|
| 41 | + 'The name of the patch instance to be skipped' |
|
| 42 | + ) |
|
| 43 | + ->setHelp(<<<EOT |
|
| 44 | 44 | Skips a patch. You must pass in parameter the name of the patch. |
| 45 | 45 | EOT |
| 46 | - ); |
|
| 47 | - } |
|
| 46 | + ); |
|
| 47 | + } |
|
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * {@inheritdoc} |
|
| 51 | - */ |
|
| 52 | - protected function execute(InputInterface $input, OutputInterface $output) |
|
| 53 | - { |
|
| 54 | - $patchName = $input->getArgument('name'); |
|
| 55 | - $this->patchService->skip($patchName); |
|
| 49 | + /** |
|
| 50 | + * {@inheritdoc} |
|
| 51 | + */ |
|
| 52 | + protected function execute(InputInterface $input, OutputInterface $output) |
|
| 53 | + { |
|
| 54 | + $patchName = $input->getArgument('name'); |
|
| 55 | + $this->patchService->skip($patchName); |
|
| 56 | 56 | |
| 57 | - $output->writeln('Patch marked as skipped'); |
|
| 58 | - } |
|
| 57 | + $output->writeln('Patch marked as skipped'); |
|
| 58 | + } |
|
| 59 | 59 | } |
@@ -15,47 +15,47 @@ |
||
| 15 | 15 | */ |
| 16 | 16 | class ApplyPatchCommand extends Command |
| 17 | 17 | { |
| 18 | - /** |
|
| 19 | - * @var PatchService |
|
| 20 | - */ |
|
| 21 | - private $patchService; |
|
| 22 | - |
|
| 23 | - public function __construct(PatchService $patchService) |
|
| 24 | - { |
|
| 25 | - parent::__construct(); |
|
| 26 | - $this->patchService = $patchService; |
|
| 27 | - } |
|
| 28 | - |
|
| 29 | - |
|
| 30 | - /** |
|
| 31 | - * {@inheritdoc} |
|
| 32 | - */ |
|
| 33 | - protected function configure() |
|
| 34 | - { |
|
| 35 | - $this |
|
| 36 | - ->setName('patches:apply') |
|
| 37 | - ->setDescription('Apply a patch.') |
|
| 38 | - ->addArgument( |
|
| 39 | - 'name', |
|
| 40 | - InputArgument::REQUIRED, |
|
| 41 | - 'The name of the patch instance to be applied' |
|
| 42 | - ) |
|
| 43 | - ->setHelp(<<<EOT |
|
| 18 | + /** |
|
| 19 | + * @var PatchService |
|
| 20 | + */ |
|
| 21 | + private $patchService; |
|
| 22 | + |
|
| 23 | + public function __construct(PatchService $patchService) |
|
| 24 | + { |
|
| 25 | + parent::__construct(); |
|
| 26 | + $this->patchService = $patchService; |
|
| 27 | + } |
|
| 28 | + |
|
| 29 | + |
|
| 30 | + /** |
|
| 31 | + * {@inheritdoc} |
|
| 32 | + */ |
|
| 33 | + protected function configure() |
|
| 34 | + { |
|
| 35 | + $this |
|
| 36 | + ->setName('patches:apply') |
|
| 37 | + ->setDescription('Apply a patch.') |
|
| 38 | + ->addArgument( |
|
| 39 | + 'name', |
|
| 40 | + InputArgument::REQUIRED, |
|
| 41 | + 'The name of the patch instance to be applied' |
|
| 42 | + ) |
|
| 43 | + ->setHelp(<<<EOT |
|
| 44 | 44 | Apply a patch. You must pass in parameter the name of the patch. |
| 45 | 45 | |
| 46 | 46 | Use patches:apply-all to apply all pending patches. |
| 47 | 47 | EOT |
| 48 | - ); |
|
| 49 | - } |
|
| 50 | - |
|
| 51 | - /** |
|
| 52 | - * {@inheritdoc} |
|
| 53 | - */ |
|
| 54 | - protected function execute(InputInterface $input, OutputInterface $output) |
|
| 55 | - { |
|
| 56 | - $patchName = $input->getArgument('name'); |
|
| 57 | - $this->patchService->apply($patchName); |
|
| 58 | - |
|
| 59 | - $output->writeln('Patch successfully applied'); |
|
| 60 | - } |
|
| 48 | + ); |
|
| 49 | + } |
|
| 50 | + |
|
| 51 | + /** |
|
| 52 | + * {@inheritdoc} |
|
| 53 | + */ |
|
| 54 | + protected function execute(InputInterface $input, OutputInterface $output) |
|
| 55 | + { |
|
| 56 | + $patchName = $input->getArgument('name'); |
|
| 57 | + $this->patchService->apply($patchName); |
|
| 58 | + |
|
| 59 | + $output->writeln('Patch successfully applied'); |
|
| 60 | + } |
|
| 61 | 61 | } |
@@ -15,45 +15,45 @@ |
||
| 15 | 15 | */ |
| 16 | 16 | class RevertPatchCommand extends Command |
| 17 | 17 | { |
| 18 | - /** |
|
| 19 | - * @var PatchService |
|
| 20 | - */ |
|
| 21 | - private $patchService; |
|
| 18 | + /** |
|
| 19 | + * @var PatchService |
|
| 20 | + */ |
|
| 21 | + private $patchService; |
|
| 22 | 22 | |
| 23 | - public function __construct(PatchService $patchService) |
|
| 24 | - { |
|
| 25 | - parent::__construct(); |
|
| 26 | - $this->patchService = $patchService; |
|
| 27 | - } |
|
| 23 | + public function __construct(PatchService $patchService) |
|
| 24 | + { |
|
| 25 | + parent::__construct(); |
|
| 26 | + $this->patchService = $patchService; |
|
| 27 | + } |
|
| 28 | 28 | |
| 29 | 29 | |
| 30 | - /** |
|
| 31 | - * {@inheritdoc} |
|
| 32 | - */ |
|
| 33 | - protected function configure() |
|
| 34 | - { |
|
| 35 | - $this |
|
| 36 | - ->setName('patches:revert') |
|
| 37 | - ->setDescription('Revert a patch.') |
|
| 38 | - ->addArgument( |
|
| 39 | - 'name', |
|
| 40 | - InputArgument::REQUIRED, |
|
| 41 | - 'The name of the patch instance to be reverted' |
|
| 42 | - ) |
|
| 43 | - ->setHelp(<<<EOT |
|
| 30 | + /** |
|
| 31 | + * {@inheritdoc} |
|
| 32 | + */ |
|
| 33 | + protected function configure() |
|
| 34 | + { |
|
| 35 | + $this |
|
| 36 | + ->setName('patches:revert') |
|
| 37 | + ->setDescription('Revert a patch.') |
|
| 38 | + ->addArgument( |
|
| 39 | + 'name', |
|
| 40 | + InputArgument::REQUIRED, |
|
| 41 | + 'The name of the patch instance to be reverted' |
|
| 42 | + ) |
|
| 43 | + ->setHelp(<<<EOT |
|
| 44 | 44 | Reverts a patch. You must pass in parameter the name of the patch. |
| 45 | 45 | EOT |
| 46 | - ); |
|
| 47 | - } |
|
| 46 | + ); |
|
| 47 | + } |
|
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * {@inheritdoc} |
|
| 51 | - */ |
|
| 52 | - protected function execute(InputInterface $input, OutputInterface $output) |
|
| 53 | - { |
|
| 54 | - $patchName = $input->getArgument('name'); |
|
| 55 | - $this->patchService->revert($patchName); |
|
| 49 | + /** |
|
| 50 | + * {@inheritdoc} |
|
| 51 | + */ |
|
| 52 | + protected function execute(InputInterface $input, OutputInterface $output) |
|
| 53 | + { |
|
| 54 | + $patchName = $input->getArgument('name'); |
|
| 55 | + $this->patchService->revert($patchName); |
|
| 56 | 56 | |
| 57 | - $output->writeln('Patch successfully reverted'); |
|
| 58 | - } |
|
| 57 | + $output->writeln('Patch successfully reverted'); |
|
| 58 | + } |
|
| 59 | 59 | } |
@@ -8,64 +8,64 @@ |
||
| 8 | 8 | |
| 9 | 9 | class PatchType implements \JsonSerializable |
| 10 | 10 | { |
| 11 | - /** |
|
| 12 | - * @var string |
|
| 13 | - */ |
|
| 14 | - private $name; |
|
| 15 | - /** |
|
| 16 | - * @var string |
|
| 17 | - */ |
|
| 18 | - private $description; |
|
| 11 | + /** |
|
| 12 | + * @var string |
|
| 13 | + */ |
|
| 14 | + private $name; |
|
| 15 | + /** |
|
| 16 | + * @var string |
|
| 17 | + */ |
|
| 18 | + private $description; |
|
| 19 | 19 | |
| 20 | - /** |
|
| 21 | - * @Important |
|
| 22 | - * @param string $name The name of the patch type. Should not contain special characters or spaces. Note: the default type is an empty string. |
|
| 23 | - * @param string $description The description of the patch type |
|
| 24 | - * @throws PatchException |
|
| 25 | - */ |
|
| 26 | - public function __construct(string $name, string $description) |
|
| 27 | - { |
|
| 28 | - if (!preg_match('/^[a-z_\-0-9]*$/i', $name)) { |
|
| 29 | - throw new PatchException('A patch name can only contain alphanumeric characters and underscore. Name passed: "'.$name.'"'); |
|
| 30 | - } |
|
| 20 | + /** |
|
| 21 | + * @Important |
|
| 22 | + * @param string $name The name of the patch type. Should not contain special characters or spaces. Note: the default type is an empty string. |
|
| 23 | + * @param string $description The description of the patch type |
|
| 24 | + * @throws PatchException |
|
| 25 | + */ |
|
| 26 | + public function __construct(string $name, string $description) |
|
| 27 | + { |
|
| 28 | + if (!preg_match('/^[a-z_\-0-9]*$/i', $name)) { |
|
| 29 | + throw new PatchException('A patch name can only contain alphanumeric characters and underscore. Name passed: "'.$name.'"'); |
|
| 30 | + } |
|
| 31 | 31 | |
| 32 | - $this->name = $name; |
|
| 33 | - $this->description = $description; |
|
| 34 | - } |
|
| 32 | + $this->name = $name; |
|
| 33 | + $this->description = $description; |
|
| 34 | + } |
|
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * The name of the patch type. Should not contain special characters or spaces. |
|
| 38 | - * |
|
| 39 | - * @return string |
|
| 40 | - */ |
|
| 41 | - public function getName(): string |
|
| 42 | - { |
|
| 43 | - return $this->name; |
|
| 44 | - } |
|
| 36 | + /** |
|
| 37 | + * The name of the patch type. Should not contain special characters or spaces. |
|
| 38 | + * |
|
| 39 | + * @return string |
|
| 40 | + */ |
|
| 41 | + public function getName(): string |
|
| 42 | + { |
|
| 43 | + return $this->name; |
|
| 44 | + } |
|
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * The description of the patch type. |
|
| 48 | - * |
|
| 49 | - * @return string |
|
| 50 | - */ |
|
| 51 | - public function getDescription(): string |
|
| 52 | - { |
|
| 53 | - return $this->description; |
|
| 54 | - } |
|
| 46 | + /** |
|
| 47 | + * The description of the patch type. |
|
| 48 | + * |
|
| 49 | + * @return string |
|
| 50 | + */ |
|
| 51 | + public function getDescription(): string |
|
| 52 | + { |
|
| 53 | + return $this->description; |
|
| 54 | + } |
|
| 55 | 55 | |
| 56 | - /** |
|
| 57 | - * Specify data which should be serialized to JSON |
|
| 58 | - * @link http://php.net/manual/en/jsonserializable.jsonserialize.php |
|
| 59 | - * @return mixed data which can be serialized by <b>json_encode</b>, |
|
| 60 | - * which is a value of any type other than a resource. |
|
| 61 | - * @since 5.4.0 |
|
| 62 | - */ |
|
| 63 | - public function jsonSerialize() |
|
| 64 | - { |
|
| 65 | - return [ |
|
| 66 | - 'name' => $this->name, |
|
| 67 | - 'description' => $this->description, |
|
| 68 | - 'instanceName' => MoufManager::getMoufManager()->findInstanceName($this) |
|
| 69 | - ]; |
|
| 70 | - } |
|
| 56 | + /** |
|
| 57 | + * Specify data which should be serialized to JSON |
|
| 58 | + * @link http://php.net/manual/en/jsonserializable.jsonserialize.php |
|
| 59 | + * @return mixed data which can be serialized by <b>json_encode</b>, |
|
| 60 | + * which is a value of any type other than a resource. |
|
| 61 | + * @since 5.4.0 |
|
| 62 | + */ |
|
| 63 | + public function jsonSerialize() |
|
| 64 | + { |
|
| 65 | + return [ |
|
| 66 | + 'name' => $this->name, |
|
| 67 | + 'description' => $this->description, |
|
| 68 | + 'instanceName' => MoufManager::getMoufManager()->findInstanceName($this) |
|
| 69 | + ]; |
|
| 70 | + } |
|
| 71 | 71 | } |
@@ -15,66 +15,66 @@ |
||
| 15 | 15 | */ |
| 16 | 16 | class ListPatchesCommand extends Command |
| 17 | 17 | { |
| 18 | - /** |
|
| 19 | - * @var PatchService |
|
| 20 | - */ |
|
| 21 | - private $patchService; |
|
| 18 | + /** |
|
| 19 | + * @var PatchService |
|
| 20 | + */ |
|
| 21 | + private $patchService; |
|
| 22 | 22 | |
| 23 | - public function __construct(PatchService $patchService) |
|
| 24 | - { |
|
| 25 | - parent::__construct(); |
|
| 26 | - $this->patchService = $patchService; |
|
| 27 | - } |
|
| 23 | + public function __construct(PatchService $patchService) |
|
| 24 | + { |
|
| 25 | + parent::__construct(); |
|
| 26 | + $this->patchService = $patchService; |
|
| 27 | + } |
|
| 28 | 28 | |
| 29 | 29 | |
| 30 | - /** |
|
| 31 | - * {@inheritdoc} |
|
| 32 | - */ |
|
| 33 | - protected function configure() |
|
| 34 | - { |
|
| 35 | - $this |
|
| 36 | - ->setName('patches:list') |
|
| 37 | - ->setDescription('List all the patches.') |
|
| 38 | - ->setDefinition(array( |
|
| 30 | + /** |
|
| 31 | + * {@inheritdoc} |
|
| 32 | + */ |
|
| 33 | + protected function configure() |
|
| 34 | + { |
|
| 35 | + $this |
|
| 36 | + ->setName('patches:list') |
|
| 37 | + ->setDescription('List all the patches.') |
|
| 38 | + ->setDefinition(array( |
|
| 39 | 39 | |
| 40 | - )) |
|
| 41 | - ->setHelp(<<<EOT |
|
| 40 | + )) |
|
| 41 | + ->setHelp(<<<EOT |
|
| 42 | 42 | List all patches declared in Mouf patch service. |
| 43 | 43 | |
| 44 | 44 | The command will display the status of each patch, i.e. whether it has been applied or skipped or is waiting to be applied. |
| 45 | 45 | EOT |
| 46 | - ); |
|
| 47 | - } |
|
| 46 | + ); |
|
| 47 | + } |
|
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * {@inheritdoc} |
|
| 51 | - */ |
|
| 52 | - protected function execute(InputInterface $input, OutputInterface $output) |
|
| 53 | - { |
|
| 54 | - $patches = $this->patchService->getView(); |
|
| 49 | + /** |
|
| 50 | + * {@inheritdoc} |
|
| 51 | + */ |
|
| 52 | + protected function execute(InputInterface $input, OutputInterface $output) |
|
| 53 | + { |
|
| 54 | + $patches = $this->patchService->getView(); |
|
| 55 | 55 | |
| 56 | - $rows = array_map(function($row) { |
|
| 57 | - return [ $row['uniqueName'], $this->renderStatus($row['status']), $row['patch_type'] ?: '(default)' ]; |
|
| 58 | - }, $patches); |
|
| 56 | + $rows = array_map(function($row) { |
|
| 57 | + return [ $row['uniqueName'], $this->renderStatus($row['status']), $row['patch_type'] ?: '(default)' ]; |
|
| 58 | + }, $patches); |
|
| 59 | 59 | |
| 60 | - $table = new Table($output); |
|
| 61 | - $table |
|
| 62 | - ->setHeaders(array('Patch', 'Status', 'Type')) |
|
| 63 | - ->setRows($rows) |
|
| 64 | - ; |
|
| 65 | - $table->render(); |
|
| 66 | - } |
|
| 60 | + $table = new Table($output); |
|
| 61 | + $table |
|
| 62 | + ->setHeaders(array('Patch', 'Status', 'Type')) |
|
| 63 | + ->setRows($rows) |
|
| 64 | + ; |
|
| 65 | + $table->render(); |
|
| 66 | + } |
|
| 67 | 67 | |
| 68 | - private function renderStatus($status) { |
|
| 69 | - $map = [ |
|
| 70 | - PatchInterface::STATUS_APPLIED => "<info>Applied</info>", |
|
| 71 | - PatchInterface::STATUS_SKIPPED => "<comment>Skipped</comment>", |
|
| 72 | - PatchInterface::STATUS_AWAITING => "Awaiting", |
|
| 73 | - PatchInterface::STATUS_ERROR => "<error>Skipped</error>", |
|
| 74 | - ]; |
|
| 75 | - if (!isset($map[$status])) { |
|
| 76 | - throw new \Exception('Unexpected status "'.$map[$status].'"'); |
|
| 77 | - } |
|
| 78 | - return $map[$status]; |
|
| 79 | - } |
|
| 68 | + private function renderStatus($status) { |
|
| 69 | + $map = [ |
|
| 70 | + PatchInterface::STATUS_APPLIED => "<info>Applied</info>", |
|
| 71 | + PatchInterface::STATUS_SKIPPED => "<comment>Skipped</comment>", |
|
| 72 | + PatchInterface::STATUS_AWAITING => "Awaiting", |
|
| 73 | + PatchInterface::STATUS_ERROR => "<error>Skipped</error>", |
|
| 74 | + ]; |
|
| 75 | + if (!isset($map[$status])) { |
|
| 76 | + throw new \Exception('Unexpected status "'.$map[$status].'"'); |
|
| 77 | + } |
|
| 78 | + return $map[$status]; |
|
| 79 | + } |
|
| 80 | 80 | } |
@@ -39,20 +39,20 @@ discard block |
||
| 39 | 39 | /** |
| 40 | 40 | * Skips the patch (sets its status to "skipped"). |
| 41 | 41 | */ |
| 42 | - public function skip(): void; |
|
| 42 | + public function skip(): void; |
|
| 43 | 43 | |
| 44 | 44 | /** |
| 45 | 45 | * Reverts (cancels) the patch. |
| 46 | 46 | * Note: patchs do not have to provide a "revert" feature (see canRevert method). |
| 47 | 47 | */ |
| 48 | - public function revert(): void; |
|
| 48 | + public function revert(): void; |
|
| 49 | 49 | |
| 50 | 50 | /** |
| 51 | 51 | * Returns true if this patch can be canceled, false otherwise. |
| 52 | 52 | * |
| 53 | 53 | * @return boolean |
| 54 | 54 | */ |
| 55 | - public function canRevert(): bool; |
|
| 55 | + public function canRevert(): bool; |
|
| 56 | 56 | |
| 57 | 57 | /** |
| 58 | 58 | * Returns the status of this patch. |
@@ -65,28 +65,28 @@ discard block |
||
| 65 | 65 | * |
| 66 | 66 | * @return string |
| 67 | 67 | */ |
| 68 | - public function getStatus(): string; |
|
| 68 | + public function getStatus(): string; |
|
| 69 | 69 | |
| 70 | 70 | /** |
| 71 | 71 | * Returns a unique name for this patch. |
| 72 | 72 | * |
| 73 | 73 | * @return string |
| 74 | 74 | */ |
| 75 | - public function getUniqueName(): string; |
|
| 75 | + public function getUniqueName(): string; |
|
| 76 | 76 | |
| 77 | 77 | /** |
| 78 | 78 | * Returns a short description of the patch. |
| 79 | 79 | * |
| 80 | 80 | * @return string |
| 81 | 81 | */ |
| 82 | - public function getDescription(): string; |
|
| 82 | + public function getDescription(): string; |
|
| 83 | 83 | |
| 84 | 84 | /** |
| 85 | 85 | * Returns the error message of the last action performed, or null if last action was successful. |
| 86 | 86 | * |
| 87 | 87 | * @return string |
| 88 | 88 | */ |
| 89 | - public function getLastErrorMessage(): ?string; |
|
| 89 | + public function getLastErrorMessage(): ?string; |
|
| 90 | 90 | |
| 91 | 91 | /** |
| 92 | 92 | * Returns the URL that can be used to edit this patch. |
@@ -94,12 +94,12 @@ discard block |
||
| 94 | 94 | * |
| 95 | 95 | * @return string |
| 96 | 96 | */ |
| 97 | - public function getEditUrl(): ?string; |
|
| 97 | + public function getEditUrl(): ?string; |
|
| 98 | 98 | |
| 99 | - /** |
|
| 100 | - * Returns the type of the patch. |
|
| 101 | - * |
|
| 102 | - * @return PatchType |
|
| 103 | - */ |
|
| 104 | - public function getPatchType() : PatchType; |
|
| 99 | + /** |
|
| 100 | + * Returns the type of the patch. |
|
| 101 | + * |
|
| 102 | + * @return PatchType |
|
| 103 | + */ |
|
| 104 | + public function getPatchType() : PatchType; |
|
| 105 | 105 | } |
@@ -20,56 +20,56 @@ |
||
| 20 | 20 | |
| 21 | 21 | class PatchInstaller3 implements PackageInstallerInterface |
| 22 | 22 | { |
| 23 | - /** |
|
| 24 | - * (non-PHPdoc) |
|
| 25 | - * @see \Mouf\Installer\PackageInstallerInterface::install() |
|
| 26 | - * @param MoufManager $moufManager |
|
| 27 | - * @throws \Mouf\MoufException |
|
| 28 | - */ |
|
| 29 | - public static function install(MoufManager $moufManager) |
|
| 30 | - { |
|
| 31 | - // Let's create the instance. |
|
| 32 | - $patchDefaultType = InstallUtils::getOrCreateInstance('patch.default_type', PatchType::class, $moufManager); |
|
| 33 | - $patchDefaultType->getConstructorArgumentProperty('name')->setValue(''); |
|
| 34 | - $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.'); |
|
| 23 | + /** |
|
| 24 | + * (non-PHPdoc) |
|
| 25 | + * @see \Mouf\Installer\PackageInstallerInterface::install() |
|
| 26 | + * @param MoufManager $moufManager |
|
| 27 | + * @throws \Mouf\MoufException |
|
| 28 | + */ |
|
| 29 | + public static function install(MoufManager $moufManager) |
|
| 30 | + { |
|
| 31 | + // Let's create the instance. |
|
| 32 | + $patchDefaultType = InstallUtils::getOrCreateInstance('patch.default_type', PatchType::class, $moufManager); |
|
| 33 | + $patchDefaultType->getConstructorArgumentProperty('name')->setValue(''); |
|
| 34 | + $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.'); |
|
| 35 | 35 | |
| 36 | - $patchTestDataType = InstallUtils::getOrCreateInstance('patch.testdata_type', PatchType::class, $moufManager); |
|
| 37 | - $patchTestDataType->getConstructorArgumentProperty('name')->setValue('test_data'); |
|
| 38 | - $patchTestDataType->getConstructorArgumentProperty('description')->setValue('Use this type to mark patches that contain test data that should only be used in staging environment.'); |
|
| 36 | + $patchTestDataType = InstallUtils::getOrCreateInstance('patch.testdata_type', PatchType::class, $moufManager); |
|
| 37 | + $patchTestDataType->getConstructorArgumentProperty('name')->setValue('test_data'); |
|
| 38 | + $patchTestDataType->getConstructorArgumentProperty('description')->setValue('Use this type to mark patches that contain test data that should only be used in staging environment.'); |
|
| 39 | 39 | |
| 40 | - $patchService = InstallUtils::getOrCreateInstance('patchService', PatchService::class, $moufManager); |
|
| 40 | + $patchService = InstallUtils::getOrCreateInstance('patchService', PatchService::class, $moufManager); |
|
| 41 | 41 | |
| 42 | - if (empty($patchService->getConstructorArgumentProperty('types')->getValue())) { |
|
| 43 | - $patchService->getConstructorArgumentProperty('types')->setValue([ $patchDefaultType, $patchTestDataType ]); |
|
| 44 | - } |
|
| 42 | + if (empty($patchService->getConstructorArgumentProperty('types')->getValue())) { |
|
| 43 | + $patchService->getConstructorArgumentProperty('types')->setValue([ $patchDefaultType, $patchTestDataType ]); |
|
| 44 | + } |
|
| 45 | 45 | |
| 46 | - $consoleUtils = new ConsoleUtils($moufManager); |
|
| 46 | + $consoleUtils = new ConsoleUtils($moufManager); |
|
| 47 | 47 | |
| 48 | - $listPatchesCommand = $moufManager->createInstance(ListPatchesCommand::class); |
|
| 49 | - $listPatchesCommand->getConstructorArgumentProperty("patchService")->setValue($patchService); |
|
| 50 | - $consoleUtils->registerCommand($listPatchesCommand); |
|
| 48 | + $listPatchesCommand = $moufManager->createInstance(ListPatchesCommand::class); |
|
| 49 | + $listPatchesCommand->getConstructorArgumentProperty("patchService")->setValue($patchService); |
|
| 50 | + $consoleUtils->registerCommand($listPatchesCommand); |
|
| 51 | 51 | |
| 52 | - $applyAllPatchesCommand = $moufManager->createInstance(ApplyAllPatchesCommand::class); |
|
| 53 | - $applyAllPatchesCommand->getConstructorArgumentProperty("patchService")->setValue($patchService); |
|
| 54 | - $consoleUtils->registerCommand($applyAllPatchesCommand); |
|
| 52 | + $applyAllPatchesCommand = $moufManager->createInstance(ApplyAllPatchesCommand::class); |
|
| 53 | + $applyAllPatchesCommand->getConstructorArgumentProperty("patchService")->setValue($patchService); |
|
| 54 | + $consoleUtils->registerCommand($applyAllPatchesCommand); |
|
| 55 | 55 | |
| 56 | - $applyPatchCommand = $moufManager->createInstance(ApplyPatchCommand::class); |
|
| 57 | - $applyPatchCommand->getConstructorArgumentProperty("patchService")->setValue($patchService); |
|
| 58 | - $consoleUtils->registerCommand($applyPatchCommand); |
|
| 56 | + $applyPatchCommand = $moufManager->createInstance(ApplyPatchCommand::class); |
|
| 57 | + $applyPatchCommand->getConstructorArgumentProperty("patchService")->setValue($patchService); |
|
| 58 | + $consoleUtils->registerCommand($applyPatchCommand); |
|
| 59 | 59 | |
| 60 | - $skipPatchCommand = $moufManager->createInstance(SkipPatchCommand::class); |
|
| 61 | - $skipPatchCommand->getConstructorArgumentProperty("patchService")->setValue($patchService); |
|
| 62 | - $consoleUtils->registerCommand($skipPatchCommand); |
|
| 60 | + $skipPatchCommand = $moufManager->createInstance(SkipPatchCommand::class); |
|
| 61 | + $skipPatchCommand->getConstructorArgumentProperty("patchService")->setValue($patchService); |
|
| 62 | + $consoleUtils->registerCommand($skipPatchCommand); |
|
| 63 | 63 | |
| 64 | - $revertPatchCommand = $moufManager->createInstance(RevertPatchCommand::class); |
|
| 65 | - $revertPatchCommand->getConstructorArgumentProperty("patchService")->setValue($patchService); |
|
| 66 | - $consoleUtils->registerCommand($revertPatchCommand); |
|
| 64 | + $revertPatchCommand = $moufManager->createInstance(RevertPatchCommand::class); |
|
| 65 | + $revertPatchCommand->getConstructorArgumentProperty("patchService")->setValue($patchService); |
|
| 66 | + $consoleUtils->registerCommand($revertPatchCommand); |
|
| 67 | 67 | |
| 68 | - $resetPatchCommand = $moufManager->createInstance(ResetPatchesCommand::class); |
|
| 69 | - $resetPatchCommand->getConstructorArgumentProperty("patchService")->setValue($patchService); |
|
| 70 | - $consoleUtils->registerCommand($resetPatchCommand); |
|
| 68 | + $resetPatchCommand = $moufManager->createInstance(ResetPatchesCommand::class); |
|
| 69 | + $resetPatchCommand->getConstructorArgumentProperty("patchService")->setValue($patchService); |
|
| 70 | + $consoleUtils->registerCommand($resetPatchCommand); |
|
| 71 | 71 | |
| 72 | - // Let's rewrite the MoufComponents.php file to save the component |
|
| 73 | - $moufManager->rewriteMouf(); |
|
| 74 | - } |
|
| 72 | + // Let's rewrite the MoufComponents.php file to save the component |
|
| 73 | + $moufManager->rewriteMouf(); |
|
| 74 | + } |
|
| 75 | 75 | } |
@@ -8,16 +8,16 @@ |
||
| 8 | 8 | */ |
| 9 | 9 | interface PatchListenerInterface |
| 10 | 10 | { |
| 11 | - /** |
|
| 12 | - * Triggered when the 'reset()' method is called on the PatchService |
|
| 13 | - */ |
|
| 14 | - public function onReset(): void; |
|
| 11 | + /** |
|
| 12 | + * Triggered when the 'reset()' method is called on the PatchService |
|
| 13 | + */ |
|
| 14 | + public function onReset(): void; |
|
| 15 | 15 | |
| 16 | - /** |
|
| 17 | - * Triggered when one or many patches have been applied. |
|
| 18 | - * |
|
| 19 | - * @param PatchInterface[] $patches |
|
| 20 | - */ |
|
| 21 | - //public function onPatchesApplied(array $patches): void; |
|
| 16 | + /** |
|
| 17 | + * Triggered when one or many patches have been applied. |
|
| 18 | + * |
|
| 19 | + * @param PatchInterface[] $patches |
|
| 20 | + */ |
|
| 21 | + //public function onPatchesApplied(array $patches): void; |
|
| 22 | 22 | |
| 23 | 23 | } |
| 24 | 24 | \ No newline at end of file |
@@ -30,42 +30,42 @@ discard block |
||
| 30 | 30 | * @ExtendedAction {"name":"View patches list", "url":"patcher/", "default":false} |
| 31 | 31 | */ |
| 32 | 32 | class PatchService implements MoufValidatorInterface { |
| 33 | - const IFEXISTS_EXCEPTION = "exception"; |
|
| 34 | - const IFEXISTS_IGNORE = "ignore"; |
|
| 33 | + const IFEXISTS_EXCEPTION = "exception"; |
|
| 34 | + const IFEXISTS_IGNORE = "ignore"; |
|
| 35 | 35 | |
| 36 | 36 | |
| 37 | - /** |
|
| 37 | + /** |
|
| 38 | 38 | * The list of patches declared for this application. |
| 39 | 39 | * |
| 40 | 40 | * @var PatchInterface[] |
| 41 | 41 | */ |
| 42 | 42 | private $patchs = []; |
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * The list of exiting patch types for this application. |
|
| 46 | - * |
|
| 47 | - * @var PatchType[] |
|
| 48 | - */ |
|
| 44 | + /** |
|
| 45 | + * The list of exiting patch types for this application. |
|
| 46 | + * |
|
| 47 | + * @var PatchType[] |
|
| 48 | + */ |
|
| 49 | 49 | private $types = []; |
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * The list of listeners on the patch service. |
|
| 53 | - * |
|
| 54 | - * @var array|PatchListenerInterface[] |
|
| 55 | - */ |
|
| 56 | - private $listeners; |
|
| 51 | + /** |
|
| 52 | + * The list of listeners on the patch service. |
|
| 53 | + * |
|
| 54 | + * @var array|PatchListenerInterface[] |
|
| 55 | + */ |
|
| 56 | + private $listeners; |
|
| 57 | 57 | |
| 58 | - /** |
|
| 59 | - * @param PatchType[] $types |
|
| 60 | - * @param PatchListenerInterface[] $listeners |
|
| 61 | - */ |
|
| 62 | - public function __construct(array $types, array $listeners = []) |
|
| 63 | - { |
|
| 64 | - $this->types = $types; |
|
| 65 | - $this->listeners = $listeners; |
|
| 66 | - } |
|
| 58 | + /** |
|
| 59 | + * @param PatchType[] $types |
|
| 60 | + * @param PatchListenerInterface[] $listeners |
|
| 61 | + */ |
|
| 62 | + public function __construct(array $types, array $listeners = []) |
|
| 63 | + { |
|
| 64 | + $this->types = $types; |
|
| 65 | + $this->listeners = $listeners; |
|
| 66 | + } |
|
| 67 | 67 | |
| 68 | - /** |
|
| 68 | + /** |
|
| 69 | 69 | * The list of patches declared for this application. |
| 70 | 70 | * @param PatchInterface[] $patchs |
| 71 | 71 | * @return PatchService |
@@ -75,26 +75,26 @@ discard block |
||
| 75 | 75 | return $this; |
| 76 | 76 | } |
| 77 | 77 | |
| 78 | - /** |
|
| 79 | - * The list of exiting patch types for this application. |
|
| 80 | - * |
|
| 81 | - * @return PatchType[] |
|
| 82 | - */ |
|
| 83 | - public function getTypes(): array |
|
| 84 | - { |
|
| 85 | - return $this->types; |
|
| 86 | - } |
|
| 78 | + /** |
|
| 79 | + * The list of exiting patch types for this application. |
|
| 80 | + * |
|
| 81 | + * @return PatchType[] |
|
| 82 | + */ |
|
| 83 | + public function getTypes(): array |
|
| 84 | + { |
|
| 85 | + return $this->types; |
|
| 86 | + } |
|
| 87 | 87 | |
| 88 | - /** |
|
| 89 | - * @internal Returns a serialized list of types for the patch UI. |
|
| 90 | - * @return array |
|
| 91 | - */ |
|
| 92 | - public function _getSerializedTypes(): array |
|
| 93 | - { |
|
| 94 | - return array_map(function(PatchType $type) { |
|
| 95 | - return $type->jsonSerialize(); |
|
| 96 | - }, $this->types); |
|
| 97 | - } |
|
| 88 | + /** |
|
| 89 | + * @internal Returns a serialized list of types for the patch UI. |
|
| 90 | + * @return array |
|
| 91 | + */ |
|
| 92 | + public function _getSerializedTypes(): array |
|
| 93 | + { |
|
| 94 | + return array_map(function(PatchType $type) { |
|
| 95 | + return $type->jsonSerialize(); |
|
| 96 | + }, $this->types); |
|
| 97 | + } |
|
| 98 | 98 | |
| 99 | 99 | /** |
| 100 | 100 | * Adds this patch to the list of existing patches. |
@@ -223,8 +223,8 @@ discard block |
||
| 223 | 223 | |
| 224 | 224 | /** |
| 225 | 225 | * Returns a PHP array representing the patchs. |
| 226 | - * |
|
| 227 | - * @internal |
|
| 226 | + * |
|
| 227 | + * @internal |
|
| 228 | 228 | */ |
| 229 | 229 | public function getView(): array { |
| 230 | 230 | $view = array(); |
@@ -258,7 +258,7 @@ discard block |
||
| 258 | 258 | "description"=>$description, |
| 259 | 259 | "error_message"=>$error_message, |
| 260 | 260 | "edit_url"=>$editUrl, |
| 261 | - "patch_type"=>$patchType |
|
| 261 | + "patch_type"=>$patchType |
|
| 262 | 262 | ); |
| 263 | 263 | $view[] = $patchView; |
| 264 | 264 | } |
@@ -293,52 +293,52 @@ discard block |
||
| 293 | 293 | $patch->revert(); |
| 294 | 294 | } |
| 295 | 295 | |
| 296 | - /** |
|
| 297 | - * Apply all remaining patches (patches in state "awaiting" or in "error"). |
|
| 298 | - * The types of the patches can be passed as an array of string where the string is the name of the patch. |
|
| 299 | - * Patches with the "default" type are always applied. |
|
| 300 | - * |
|
| 301 | - * @param string[] $types |
|
| 302 | - * @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. |
|
| 303 | - */ |
|
| 296 | + /** |
|
| 297 | + * Apply all remaining patches (patches in state "awaiting" or in "error"). |
|
| 298 | + * The types of the patches can be passed as an array of string where the string is the name of the patch. |
|
| 299 | + * Patches with the "default" type are always applied. |
|
| 300 | + * |
|
| 301 | + * @param string[] $types |
|
| 302 | + * @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. |
|
| 303 | + */ |
|
| 304 | 304 | public function applyAll(array $types = []): array { |
| 305 | - // Array of count of applied and skipped patches. Key is the patch type. |
|
| 306 | - $appliedPatchArray = []; |
|
| 307 | - $skippedPatchArray = []; |
|
| 305 | + // Array of count of applied and skipped patches. Key is the patch type. |
|
| 306 | + $appliedPatchArray = []; |
|
| 307 | + $skippedPatchArray = []; |
|
| 308 | 308 | |
| 309 | - foreach ($this->patchs as $patch) { |
|
| 310 | - if ($patch->getStatus() === PatchInterface::STATUS_AWAITING || $patch->getStatus() === PatchInterface::STATUS_ERROR) { |
|
| 311 | - $type = $patch->getPatchType()->getName(); |
|
| 312 | - if ($type === '' || in_array($type, $types, true)) { |
|
| 313 | - $this->apply($patch->getUniqueName()); |
|
| 314 | - if (!isset($appliedPatchArray[$type])) { |
|
| 315 | - $appliedPatchArray[$type] = 0; |
|
| 316 | - } |
|
| 317 | - $appliedPatchArray[$type]++; |
|
| 318 | - } else { |
|
| 319 | - $this->skip($patch->getUniqueName()); |
|
| 320 | - if (!isset($skippedPatchArray[$type])) { |
|
| 321 | - $skippedPatchArray[$type] = 0; |
|
| 322 | - } |
|
| 323 | - $skippedPatchArray[$type]++; |
|
| 324 | - } |
|
| 325 | - } |
|
| 326 | - } |
|
| 309 | + foreach ($this->patchs as $patch) { |
|
| 310 | + if ($patch->getStatus() === PatchInterface::STATUS_AWAITING || $patch->getStatus() === PatchInterface::STATUS_ERROR) { |
|
| 311 | + $type = $patch->getPatchType()->getName(); |
|
| 312 | + if ($type === '' || in_array($type, $types, true)) { |
|
| 313 | + $this->apply($patch->getUniqueName()); |
|
| 314 | + if (!isset($appliedPatchArray[$type])) { |
|
| 315 | + $appliedPatchArray[$type] = 0; |
|
| 316 | + } |
|
| 317 | + $appliedPatchArray[$type]++; |
|
| 318 | + } else { |
|
| 319 | + $this->skip($patch->getUniqueName()); |
|
| 320 | + if (!isset($skippedPatchArray[$type])) { |
|
| 321 | + $skippedPatchArray[$type] = 0; |
|
| 322 | + } |
|
| 323 | + $skippedPatchArray[$type]++; |
|
| 324 | + } |
|
| 325 | + } |
|
| 326 | + } |
|
| 327 | 327 | |
| 328 | - return [ |
|
| 329 | - 'applied' => $appliedPatchArray, |
|
| 330 | - 'skipped' => $skippedPatchArray |
|
| 331 | - ]; |
|
| 332 | - } |
|
| 328 | + return [ |
|
| 329 | + 'applied' => $appliedPatchArray, |
|
| 330 | + 'skipped' => $skippedPatchArray |
|
| 331 | + ]; |
|
| 332 | + } |
|
| 333 | 333 | |
| 334 | - /** |
|
| 335 | - * Reset all patches to a not applied state. |
|
| 336 | - * |
|
| 337 | - * Note: this does NOT run the "revert" method on each patch but DOES trigger a "reset" event. |
|
| 338 | - */ |
|
| 334 | + /** |
|
| 335 | + * Reset all patches to a not applied state. |
|
| 336 | + * |
|
| 337 | + * Note: this does NOT run the "revert" method on each patch but DOES trigger a "reset" event. |
|
| 338 | + */ |
|
| 339 | 339 | public function reset(): void { |
| 340 | - foreach ($this->listeners as $listener) { |
|
| 341 | - $listener->onReset(); |
|
| 342 | - } |
|
| 343 | - } |
|
| 340 | + foreach ($this->listeners as $listener) { |
|
| 341 | + $listener->onReset(); |
|
| 342 | + } |
|
| 343 | + } |
|
| 344 | 344 | } |