Download the PHP package php-baremetal/conductor without Composer
On this page you can find all versions of the php package php-baremetal/conductor. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download php-baremetal/conductor
More information about php-baremetal/conductor
Files in php-baremetal/conductor
Package conductor
Short Description Composer plugin for php-baremetal: binds platform HALs, installs bm-* packages into .phpbm/packages and writes .phpbm/manifest.json.
License MIT
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 conductor
conductor
php-baremetal/conductor is the Composer plugin behind every php-baremetal firmware project. A firmware is a
Composer project: its packages add functions, classes and chip support to the PHP that runs on the board, and
conductor is what makes Composer understand them. It runs on your computer, never on the board, and is published on
Packagist.
It needs PHP 8.4 or later and Composer 2 (composer-plugin-api ^2.0), and depends on
php-baremetal/spec for the manifest model.
What it does
- *Installs `bm-
packages into the project.** Packages whose Composer type starts withbm-(bm-ext,bm-hal,bm-lib,bm-php-ext) are installed in.phpbm/packages// instead ofvendor/`, where the SDK build reads them. - Binds the HAL for the project's platform. A neutral extension requires a virtual such as
php-baremetal/i2c-hal. Whenextra.baremetal.sdkis set, conductor walks the project's requirements, finds eachphp-baremetal/<x>-halvirtual, and adds the concrete provider for the SDK's platform (php-baremetal/esp32-<x>-halforesp32@^2.0) to the project's requirements, so you never require a HAL yourself. It warns when the platform has no provider, and for the retired<x>-transportrequirements. - Writes the build manifest. After every
composer installandcomposer updateit writes.phpbm/manifest.json(schema 1): the project's settings fromextra.baremetal, and every installedbm-*package with its version, install path andextra.baremetaldata.phpbmreads this file to build and flash. Problems it can detect (an extension without amodule, two extensions with the same module, a HAL for another platform, abm-php-extwith extra keys) are printed as warnings; an invalid configuration prints an error and removes a stale manifest.
All of it applies only to projects whose composer.json has an extra.baremetal object. Any other project installs
as usual.
Install
Conductor is installed twice. Once per machine, so the plugin is already active during the very first dependency solve of a new project:
And in the project, which phpbm init writes for you: require with ^1.0 and an allow-plugins entry, because
Composer 2 does not run a plugin that is not allowed.
The packages come from the php-baremetal registry (https://repository.php-baremetal.com, canonical, so it wins for
php-baremetal/*); a package under development comes from a path repository next to it.
Project settings
Read from extra.baremetal, plus the PHP version from config.platform.php, which is required.
| Key | Meaning |
|---|---|
sdk |
Required. <name>@<constraint>, for example esp32@^2.0. The name is the platform. |
board |
Required. A board id of the SDK. |
runtime |
Required. init-loop, event-driven or web-server. |
storage |
Required. embedded or microsd. |
src, entry |
Directory of the PHP sources (default project-src) and the entry script (default index.php). |
env |
Optional. Path, relative to the project, of a file of values baked into the firmware (never copied to the microSD). |
board-overrides |
Optional. Fields of the board descriptor to replace. |
options |
Optional. SDK and package options, each a string, an integer or a boolean. |
The project name is the name of composer.json without its vendor. The SDK validates the values against its own
descriptors when it builds.
Commands
Both work on the project in the current directory (or the one given with composer -d <dir>).
conductor:info prints the SDK, board, runtime, storage and PHP version, then one line per installed bm-*
package.
Not for hand editing
.phpbm/ is generated: rebuild the manifest with composer conductor:generate instead of editing it, and keep the
directory out of version control.
Development
The tests use php-baremetal/spec from Packagist. To test against a local checkout in ../spec instead,
register it for your working copy and do not commit the change:
License
MIT.
