ProcessWire Composer Installer

ProcessWire Composer Installer provides Composer custom installers for ProcessWire CMS/CMF modules and site profiles. While not strictly required by Wireframe, it is an easy way to get started with either Wireframe or the Wireframe Boilerplate site profile.

By default Composer installs all packages into the /vendor/ directory. This is great for things that support this type of structure, but not so great for projects – such as ProcessWire – that expect things to be in specific location: modules in /site/modules/module-name/, and site profiles generally as the /site/ directory itself, /site-profile-name/ when the system hasn't been installed yet, or before installat/site-subsite-name/ in the case of native multisite support.

ProcessWire Composer Installer currently makes two "corrections" to packages that define it as a dependency in their composer.json files:

Site-specific modules supports

One more thing to note is that modules can be installed either from the root directory of the ProcessWire installation, or from the /site/ directory itself. Installer will automatically determine which location you're currently in, and adjust paths accordingly.

This way we can install modules on a per-site basis (in the case of multisite), or include Composer based module dependencies with a site profile (which would otherwise require manual modifications to the ProcessWire root directory composer.json file, or at least running composer require in the root directory for said dependencies.)

Alternatively...

There's a very similar project you might've heard of, called hari/pw-module. While this project and Hari's ProcessWire module installer are similar, there are a few key differences:

Usage

Using processwire-composer-installer depends on what role you're using it in: as a module or site profile author, or as a developer installing a module or site profile on your site using Composer.

For developers installing modules or site profiles

Note that in order for this work, the module or site profile in question has to have wireframe-framework/processwire-composer-installer as a dependency. See next section for instructions for module or site profile authors.

Customizing installer paths

By default site profiles are installed under current working directory, and modules under site/modules/ (or modules/ in case you're already in a site directory). You can, though, override the default paths in the root composer.json of your project:

{
    "require": {
        ...
    },
    "extra": {
        "pw-module-path": "site/modules",
        "pw-site-profile-path": "",
    }
}

For module or site profile authors

The usage of this project is rather simple. You just need to a) add `wireframe-framework/processwire-composer-installer` as a dependency to your project by manually modifying the composer.json file or by running `composer require wireframe-framework/processwire-composer-installer` in your module or site profile root directory, and b) define the type of your package (via composer.json) as `pw-module` (for modules) or `pw-site-profile` (for site profiles).

Here's a stripped-down sample composer.json for a module:

{
    "name": "vendor-name/module-name",
    "type": "pw-module",
    "require": {
        "wireframe-framework/processwire-composer-installer": "^1.0.0"
    }
}

And here's an equally stripped-down sample composer.json for a site profile:

{
    "name": "vendor-name/site-profile-name",
    "type": "pw-site-profile",
    "require": {
        "wireframe-framework/processwire-composer-installer": "^1.0.0"
    }
}

In order for your modules to be easily installed, you should also add them to Packagist: https://packagist.org/.

 

Requirements

ProcessWire Composer Installer requires PHP 5.5 or newer.

License

This project is licensed under the Mozilla Public License Version 2.0.

Back to top