Weave Code
Storage Api Php Client Branch Wrapper Laravel Package
keboola/storage-api-php-client-branch-wrapper
A PHP wrapper around the Keboola Storage API client that adds branch support, enabling applications to target production or development branches for table, file, and configuration operations without changing their existing Storage API workflow.
Wrapper for Storage API clients for Dev/Prod mode
Frequently asked questions about Storage Api Php Client Branch Wrapper
- What is keboola/storage-api-php-client-branch-wrapper used for?
- It provides a thin, branch-aware compatibility layer around the Keboola Storage API PHP client. It lets applications pin or switch the underlying client branch while keeping a consistent interface for storage operations. It is aimed at projects that already use Keboola storage integrations and want to avoid rewriting integration code when client branches change.
- How do I install keboola/storage-api-php-client-branch-wrapper with Composer?
- Install it with Composer using composer require keboola/storage-api-php-client-branch-wrapper. Make sure your PHP version and Composer setup satisfy the package and underlying client requirements. Then load dependencies through Composer autoload in your application.
- Does this package work with Laravel?
- Yes, it is framework-agnostic and can be used in Laravel applications as a Composer dependency. It does not require Laravel-specific bootstrapping to wrap the Keboola Storage API client. You can instantiate or inject it using Laravel's container like any other PHP service.
- Which Laravel versions are supported?
- The package does not advertise a Laravel version constraint because it is a PHP wrapper rather than a Laravel package. Compatibility depends on your PHP version and the requirements of the underlying Keboola Storage API client. Check composer.json and test against your Laravel version before upgrading.
- How do I switch between production and development branches of the Keboola Storage API client?
- The wrapper is designed for dependency pinning, so you switch by changing the Composer version constraint for the wrapper or its underlying client branch. Review the package's composer.json and README for the exact branch mapping. After changing constraints, run composer update and test your storage operations.
- Does it replace the Keboola Storage API PHP client?
- No, it wraps the Keboola Storage API PHP client rather than replacing it. You still rely on the underlying client for actual storage operations. The wrapper adds branch-aware compatibility and dependency-pinning convenience.
- Can I use it for table, file, and configuration operations?
- Yes, the wrapper keeps a consistent interface for Keboola storage operations including table, file, and configuration workflows. The actual operations are handled by the underlying Storage API client. The wrapper is designed to add minimal overhead.
- Is there a Laravel service provider or config file?
- The package is described as a lightweight wrapper and does not advertise a Laravel service provider or config file. In Laravel, you can bind or resolve it through the container if needed. Otherwise, instantiate it directly in your integration code.
- How do I test my integration with this wrapper?
- Use your normal PHP testing setup, such as PHPUnit, and test against the wrapper interface you use. Because it delegates to the Keboola Storage API client, you can mock the client or use appropriate test credentials for integration tests. No dedicated Laravel testing helpers are documented.
- Is it suitable for production use?
- It is lightweight and adds minimal overhead, making it suitable for production when you need branch pinning. You should verify that the pinned client branch is stable and compatible with your PHP and Laravel versions. Review maintenance activity and test upgrades before deploying.
Weaver
How can I help you explore Laravel packages today?