Weave Code
Pixicato Bundle Laravel Package
phillarmonic/pixicato-bundle
Symfony bundle for integrating Pixicato into PHP applications. It registers Pixicato services with the container, exposes bundle configuration, and provides the framework wiring needed to use Pixicato features with minimal setup.
A Symfony bundle for validating Brazilian PIX keys.
Frequently asked questions about Pixicato Bundle
- What does phillarmonic/pixicato-bundle actually do?
- It is a Symfony bundle that integrates Pixicato, a Brazilian PIX key validation library, into PHP applications. It registers the Pixicato services in the Symfony service container, exposes bundle configuration, and handles the framework wiring so you can validate PIX keys with minimal setup. The bundle is only the Symfony integration layer, while the actual validation rules live in the underlying Pixicato library.
- How do I install phillarmonic/pixicato-bundle with Composer?
- Run composer require phillarmonic/pixicato-bundle from your Symfony project root, which installs the bundle plus its dependencies, including the core Pixicato library. Commit both composer.json and composer.lock so other environments resolve identical versions. If Symfony Flex is enabled, a recipe may register the bundle for you; otherwise add it manually to config/bundles.php.
- Do I need to install the core Pixicato library separately?
- Usually no, because the bundle declares Pixicato as a Composer dependency and it is pulled in automatically. Confirm what was installed by checking your composer.lock or running composer show for the Pixicato package. If you need to pin or upgrade validation behavior, do it on the core library rather than the bundle, since the bundle mainly provides container wiring.
- How do I register the bundle in a Symfony application?
- Add the bundle's class name to the array returned by config/bundles.php, which is the standard registration point for non-Flex applications. With Symfony Flex installed, the bundle may already be registered through its recipe after Composer finishes. Once registered, clear the cache with php bin/console cache:clear so the container compiles and exposes the new services.
- How do I configure the Pixicato bundle after installation?
- The bundle exposes configuration through its extension class, so you create a file under config/packages named after the bundle's config alias, typically in YAML. Exact keys depend on the version you install, so check the bundle README and its Configuration class in the repository. Configuration is validated and merged into container parameters during cache warmup, which means invalid keys fail fast instead of silently at runtime.
- Can I use this bundle in Laravel instead of Symfony?
- No, this is a Symfony bundle built on Symfony's dependency injection and bundle system, so it will not work as-is in a Laravel application. Laravel developers would install the underlying Pixicato library directly and bind it in a service provider, or look for a Laravel-specific wrapper. The validation logic itself is framework-agnostic, but the wiring shipped here is Symfony-only.
- Which PHP and Symfony versions are supported?
- Support is defined in the bundle's composer.json require section, so check that file for the minimum PHP version and the Symfony component constraints before upgrading. Because the bundle wires Symfony services, it usually targets a range of Symfony releases rather than a single major version. Running composer update --dry-run or composer why-not is the quickest way to confirm compatibility with your current Symfony version.
- How do I validate a PIX key using the registered services?
- After registration, the Pixicato services are available from the container, so you can autowire them into controllers, console commands, or your own services through constructor injection. If a service is not autowirable, fetch it with the container's get() method using the service ID documented by the bundle. Validation typically means passing the PIX key string to the validator service and inspecting the returned result or catching the exception it throws.
- How should I test PIX key validation in my application?
- Because the bundle mostly handles wiring, unit tests can instantiate or mock the Pixicato validator directly without booting the Symfony kernel. For integration coverage, extend KernelTestCase or WebTestCase so the test container registers the bundle and its configuration. Keep fixtures for each PIX key type, such as CPF, CNPJ, email, phone, and random EVP keys, plus known-invalid examples, to catch regressions after upgrades.
- Are there alternatives, and is this bundle safe to run in production?
- Alternatives include installing the core Pixicato library directly and wiring it yourself, or choosing a different PIX key validation package if you do not need Symfony integration. The bundle's value is convenience: container registration and configuration without manual service definitions. Before adopting it in production, review the repository's release history, open issues, and whether maintained branches align with your Symfony version, since a thin integration layer is only as reliable as the upstream library it wraps.
Weaver
How can I help you explore Laravel packages today?