Download the PHP package magicsunday/webtrees-module-installer-plugin without Composer

On this page you can find all versions of the php package magicsunday/webtrees-module-installer-plugin. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Informations about the package webtrees-module-installer-plugin

Webtrees Module Installer Plugin

Latest version License CI

A powerful Composer plugin that simplifies the installation of modules for the webtrees genealogy application by automatically placing them in the correct directory structure.

🚀 Seamless Integration

Automatically installs webtrees modules to the correct modules_v4 directory without manual file copying.

⚙️ Easy Configuration

Simple setup with minimal configuration required in your composer.json file.

🌟 Why Use This Plugin?

When developing or using modules for webtrees, managing the installation process can be cumbersome. This plugin solves that problem by:

📋 Requirements

System Requirements

🔧 Installation

Add this plugin to the require or require-dev section of your composer.json file:

Or install it using Composer:

Make sure to allow the plugin in your composer.json:

📦 Usage

For Module Users

To install a webtrees module with composer, simply require the module in your composer.json:

The plugin will automatically install the module to the modules_v4 directory.

For Module Developers

When creating a webtrees module, set the package type to webtrees-module in your module's composer.json:

Pro Tip

The module name in the composer.json file will determine the directory name in the modules_v4 directory.

Themes

Themes are installed exactly like modules. Since a webtrees theme is a module as well, set the package type to webtrees-theme and it will be placed in the same modules_v4 directory:

Installing from GitHub

If your module is not listed on Packagist, you can install it directly from GitHub:

For example, to install the dev-main branch:

🧪 Testing

The quality tooling comes from magicsunday/coding-standard (^3.0): the php-cs-fixer, PHPStan (level max, checked exceptions) and Rector configs are the shared ones, and Deptrac enforces the layer rules in deptrac.yaml.

🔍 How It Works

The plugin works by:

  1. Registering a custom installer with Composer's installation manager
  2. Subscribing to package-level events (PRE_PACKAGE_* / POST_PACKAGE_*) to queue webtrees-module and webtrees-theme operations
  3. Determining the correct installation path in the modules_v4 directory, whether fisharebest/webtrees is installed as a dependency or as the root package
  4. Re-installing all webtrees-module and webtrees-theme packages when fisharebest/webtrees itself is updated, so the modules and themes survive the core upgrade

The main components are:

👥 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Please make sure your code follows the project's coding standards by running the tests before submitting.

📄 License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

🙏 Acknowledgements

All versions of webtrees-module-installer-plugin with dependencies

PHP Build Version
Package Version
Requires php Version 8.3 - 8.5
composer-plugin-api Version ^2.6
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package magicsunday/webtrees-module-installer-plugin contains the following files

Loading the files please wait ...