A Composer plugin that provides automatic recipe processing for PHP packages, similar to Symfony Flex. It automatically discovers and applies local recipes from package directories when packages are installed, updated, or uninstalled. This plugin is part of the Valksor ecosystem and enables seamless package configuration management for PHP applications.
composer.json for it to work.
composer require valksor/php-plugin
composer config allow-plugins.valksor/php-plugin trueAdd to composer.json:
{
"config": {
"allow-plugins": {
"valksor/php-plugin": true
}
},
"extra": {
"valksor": {
"allow": "*"
}
}
}- Automatic Recipe Discovery: Automatically finds and processes local recipes in package directories during Composer operations
- Symfony Flex Compatibility: Built on top of Symfony Flex's configurator system with full recipe format compatibility
- Event-Driven Processing: Hooks into Composer's package lifecycle events (install, update, uninstall) for seamless automation
- Local Recipe Focus: Specifically designed for local recipe discovery within package directories
- Manual Recipe Management: Provides commands for manual recipe installation and removal when needed
- Configuration Flexibility: Supports both wildcard and package-specific recipe permissions
- Lock File Integration: Uses Symfony Flex's symfony.lock file for proper recipe tracking and cleanup
- Duplicate Prevention: Intelligent handling of package aliases to prevent duplicate processing
- Override Support: Configurable recipe override capabilities for development environments
The plugin automatically processes recipes when packages are installed. For manual control:
# Install recipes for all packages
composer valksor:install
# Install recipe for specific package
composer valksor:install vendor/package
# Remove recipe for specific package
composer valksor:uninstall vendor/package{
"config": {
"allow-plugins": {
"valksor/php-plugin": true,
"symfony/flex": true
}
},
"extra": {
"valksor": {
"allow": "*"
}
}
}config.allow-plugins.valksor/php-plugin: true- Required for Composer 2.2+extra.valksor.allow: "*"- Allow all packages to have recipes processedextra.valksor.allow: {"vendor/package": {}}- Allow only specific packagesextra.valksor.allow: {"vendor/package": {"allow_override": true}}- Allow recipe overrides
Uses the same recipe format as Symfony Flex. See Symfony Flex Recipe Documentation.
vendor/package/
recipe/
manifest.json
config/
packages.yaml
public/
src/
{
"bundles": {
"Symfony\\Bundle\\FrameworkBundle\\FrameworkBundle": ["all"]
},
"copy-from-recipe": {
"config/": "%CONFIG_DIR%/"
},
"env": {
"DATABASE_URL": "mysql://user:[email protected]:3306/db_name"
}
}Configure which packages are allowed to have recipes processed:
{
"extra": {
"valksor": {
"allow": {
"my-vendor/core-package": {},
"my-vendor/optional-package": {
"allow_override": true
},
"external-vendor/package": {}
}
}
}
}Enable recipe overrides for frequent development updates:
{
"extra": {
"valksor": {
"allow": {
"my-vendor/dev-package": {
"allow_override": true
}
}
}
}
}Create recipes for your packages following this structure:
your-package/
composer.json
src/
YourCode.php
recipe/
manifest.json
config/
packages.yaml
templates/
some_template.php.twig
manifest.json with multiple features:
{
"bundles": {
"YourVendor\\YourBundle\\YourBundle": ["all"]
},
"copy-from-recipe": {
"config/": "%CONFIG_DIR%/",
"templates/": "%TEMPLATES_DIR%/"
},
"env": {
"YOUR_SERVICE_URL": "https://api.example.com",
"YOUR_API_KEY": "your-api-key-here"
},
"post-install-output": [
" <info>✓ Your package has been configured</info>",
" <info> Update your .env file with the API key</info>"
]
}| Issue | Cause | Solution |
|---|---|---|
| Plugin blocked | Composer 2.2+ security feature | composer config allow-plugins.valksor/php-plugin true |
| Recipes not processing | Plugin not allowed or not configured | Check composer config allow-plugins and extra.valksor settings |
| Recipe not found | Package has no recipe directory | Contact package maintainer or create custom recipe |
# Check plugin status
composer show valksor/php-plugin
composer config allow-plugins | grep valksor
composer list | grep valksor
# Manual recipe processing
composer valksor:install vendor/packageContributions are welcome! Please follow these guidelines:
-
Clone the repository:
git clone https://github.com/valksor/php-plugin.git cd php-plugin -
Install dependencies:
composer install
-
Run tests:
vendor/bin/phpunit
- PSR-12 Coding Standards: Ensure code follows PSR-12 standards
- Tests: Include tests for new features
- Documentation: Update README and docblocks as needed
- Commits: Use clear, descriptive commit messages
- Branching: Create feature branches from
master
All code must pass:
- PHPUnit tests with 100% coverage where possible
- PHP-CS-Fixer code style checks (config file can be found in valksor-dev)
Please use GitHub Issues to report bugs or request features. Include:
- PHP and Composer versions
- Steps to reproduce
- Expected vs actual behavior
- Example configuration if applicable
If you discover a security vulnerability, please send an email to [email protected] instead of using the issue tracker. All security vulnerabilities will be promptly addressed.
- GitHub Issues: Bug reports and feature requests
- GitHub Discussions: Community discussions and Q&A
- Symfony Flex Documentation: Official Recipe Documentation
- Original Author: Davis Zalitis (k0d3r1s)
- Maintainer: SIA Valksor
- All Contributors: Contributors list
This plugin is inspired by and built upon Symfony Flex, providing enhanced local recipe discovery capabilities for the Valksor ecosystem.
- PHP 8.4 or higher
- Composer 2.0 or higher
- Symfony Flex (as dependency)
This package is part of the Valksor package. See the LICENSE file for copyright information.
