Download the PHP package axy/docker-compose-config without Composer
On this page you can find all versions of the php package axy/docker-compose-config. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download axy/docker-compose-config
More information about axy/docker-compose-config
Files in axy/docker-compose-config
Package docker-compose-config
Short Description Work with docker-compose config
License MIT
Homepage https://github.com/axypro/docker-compose-config
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package docker-compose-config
axy\docker\compose\config
Work with docker-compose config.
The library don't create and load any files, don't parse and build Yml. Regular PHP arrays are used for input and output.
ComposeConfig
ComposeConfig is main class of the library.
You can create an empty config or load an existing.
The constructor new ComposeConfig() without argument creates an empty config.
Validation
The library doesn't strictly validate on load. If a field has wrong format it will be converted to correct value or ignored.
Structures
A class of a config component has its own set of properties that correspond to the fields of that component.
For example, ComposeConfig has properties $version, $services, $volumes, $network.
For simple fields are created simple properties.
Nullable strings (such $version) or arrays.
Complex field correspond to object of the specific class.
For example, $config->services is container of service objects.
All structures are initialized on load even if they are not specified in the source file.
For example, you can work with $service->build as with an object even if build section is not specified for this service or specified as string.
It is just that all fields of $service->build will be empty and this field will not be put to result unless you change it.
Usually fields with NULL, empty strings or empty values are not put to the result. Objects themselves decide this issue.
additional
Some classes have public array additional.
All fields that don't correspond to other property fall to there.
version and services are standard fields but foo and bar will be added to additional.
All addition fields will be added to result as is.
TDisable
Trait TDisable define follow methods:
isEnabled(): booldisable(): voidenable(): void
Objects with this trait can be disabled:
Disabled components will be removed from result config.
Disabled object stores all its data and will be restored after enable().
$config->services
List of services.
Implements ArrayAccess.
Service object
ComposeService instance contains follow properties:
- ?string
$image - ?string
$container_name - ?string
$restart - BuildSection
$build - PortsSection
$ports - ExposeSection
$expose - EnvironmentSection
$environment - LabelsSection
$labels - ?string
$network_mode - ServiceNetworksSection
$networks - DependsOnSection
$depends_on - array
$additional
Keys
Some sections like ports, expose and volumes (inside a service) are just a list of unnamed values.
Three are methods for search like $volumes->findBySource().
Can also use "keys" and "groups".
You can bind a value with a key (an arbitrary string) or add it to a group. Keys and groups will be not represented in yml file, but you can use for config manipulations.
