Download the PHP package zyos/install-bundle without Composer

Zyos Install Bundle (Symfony Bundle)

This project provides a series of processes which can help you systematize some processes in your project.

Install Bundle provides a series of commands that can be configured to:

• [x] Run symfony commands, whether native or custom
• [x] Execute directory creation, symlink and mirror
• [x] Run server operating system commands (CLI)
• [x] Validate path directories and files in a custom way

Requirements

PHP version >= 8.0 & Symfony >=5.0

All these processes use the symfony components: Console, Filesystem and Process

Installation

If you don't use flex (you should), you need to enable the package manually:

It is necessary to create the configuration file in the path:

Setting

These are the basic configurations that you need to enter for proper functioning.

Environments

The environments in which the different Install Bundle commands can be executed.

If this parameter is not assigned, "prod" is generated by default.

These environments are not limited by the Symfony .env files, in this case you can create your custom environments and run them in the sequence of your preference.

Locks

It is possible to generate execution locks in certain environments, in this case a lock.lock file is generated which will generate the corresponding lock, this lock is only generated when the zyos:install command is executed.

If this parameter is not assigned, "prod" is generated by default.

The lock file is created directly in the symfony project src/Resources/zyos-install-bundle/lock.lock

You must ensure that this directory is created

Install

This command executes only and exclusively Symfony commands which can be customized or any type of command within Symfony.

• command: (string) command to execute.
• arguments: (array) array of data with key value which are necessary for the command.
• enable: (boolean) enable or disable command on execution.
• environments: (array) environments in which the command will be executed.
• priority: (integer): It is the priority at which the command will be executed, (in positive values) the higher the number, less priority it has, (in negative numbers) the higher the number, more priority it has.
• if_error: (enum:[none, stop]) This field limits the action of the command in case of an error, the commands (CLI) return 3 exit codes: success: 0, Failure: 1, Invalid: 2. In this case there are two values in case of error: 1 and 2 which the command can be stopped and the following configured commands are not executed, in this case the value is used: "stop", in case an error occurs but the execution process of the following commands is not stopped, it is used the value: "none".

Usage

FileSystem

This command uses the Filesystem component with which you can create directories, Symlink and Mirror directories and files, this process is for creating structures for the project.

• source: (string) directory and/or file source path.
• destination: (string) directory and/or file destination path.
• environments: (array) environments in which the command will be executed.
• type: (enum:[directory, symlink, mirror]) type of creation.
• priority: (integer): It is the priority at which the command will be executed, (in positive values) the higher the number, less priority it has, (in negative numbers) the higher the number, more priority it has.
• if_error: (enum:[none, stop]) This field limits the action of the command in case of an error, the commands (CLI) return 3 exit codes: success: 0, Failure: 1, Invalid: 2. In this case there are two values in case of error: 1 and 2 which the command can be stopped and the following configured commands are not executed, in this case the value is used: "stop", in case an error occurs but the execution process of the following commands is not stopped, it is used the value: "none".

Keep in mind: when the type is "directory" it is necessary that both "source" and "destination" be the same, so that a creation problem is not generated.

Usage

CLI

This command uses the Symfony component "Process" which executes commands directly on the operating system where the application is located.

• command: (array) command to execute. This command follows the rules of the Process component.
• environments: (array) environments in which the command will be executed.
• priority: (integer): It is the priority at which the command will be executed, (in positive values) the higher the number, less priority it has, (in negative numbers) the higher the number, more priority it has.
• if_error: (enum:[none, stop]) This field limits the action of the command in case of an error, the commands (CLI) return 3 exit codes: success: 0, Failure: 1, Invalid: 2. In this case there are two values in case of error: 1 and 2 which the command can be stopped and the following configured commands are not executed, in this case the value is used: "stop", in case an error occurs but the execution process of the following commands is not stopped, it is used the value: "none".

Usage

Validate

This command generates the basic validation of directories, files that are configured for each of the environments, these validations will be shown as Success or Failed, in this case at the command level (CLI) the exit code is Success: 0, Failed : 1.

In this process there are no execution limits, the block that the other commands may have is not generated, but the configurations in which each validation fails can also be observed.

• filepath: (string) directory and/or file source path.
• type: (enum:[directory, file]) type of filepath.
• environments: (array) environments in which the command will be executed.
• enable: (boolean) enable or disable the command.
• validations: (array) validations to be executed.

Validations

• exists: If the file or directory exists.
• is_dir: If the file or directory is a directory.
• is_file: If the file or directory is a file.
• is_executable: If the file or directory is a executable.
• is_symlink: If the file or directory is a symlink.
• is_writable: If the file or directory is writable.
• is_readable: If the file or directory is readable.

Usage