- What is tomatophp/tomato-branches-module used for?
- It is a Laravel module from the TomatoPHP ecosystem for managing organizational branches and locations. It gives you the data model plus admin scaffolding so you can create, edit, and organize branch records inside a TomatoPHP application. It is intended for companies that operate multiple locations and want a ready-made branch registry rather than building one from scratch.
- How do I install tomatophp/tomato-branches-module with Composer?
- Install it like any TomatoPHP module by requiring the package with Composer inside your Laravel project. After that, run the module migrations so the branches table and related structures exist in your database. Because TomatoPHP modules are discovered and registered by the ecosystem, check the package README for any panel-registration or asset-publishing step specific to your Tomato version.
- Do I need the Tomato admin panel to use this module?
- The module is built to integrate as a standard module within the Tomato admin panel, which is where its create, edit, and list scaffolding is designed to live. The underlying Eloquent model and migrations are plain Laravel code, so they can be reused elsewhere, but the admin resources are aimed at Tomato. If you are not running TomatoPHP, expect to build your own controllers and views around the model.
- Which Laravel versions does this branches module support?
- TomatoPHP modules typically track recent Laravel releases, but the exact constraint is declared in the package composer.json. Check that file or run composer why-not to confirm compatibility with your application before installing. If you are on an older Laravel version, verify the constraint rather than assuming support.
- How do I add custom fields to a branch record?
- Start by creating a migration that adds the columns you need to the branches table, then extend the module model or its fillable attributes accordingly. You will also need to surface the new fields in the module form and table resources used by the Tomato admin panel. Keeping custom columns in your own migrations makes future package updates safer.
- Can branches be linked to companies, users, or other models?
- The module provides the branch data model, and in Laravel you connect it to your own models with standard Eloquent relationships. A common pattern is a company hasMany branches relationship, with users or employees attached to a specific branch. Implement those relations in your application models or a small extension of the module model rather than editing vendor code.
- What should I check before running this module in production?
- Review the generated migrations, confirm your database backup strategy, and test the admin screens on a staging copy first. Also decide how branch permissions should work so only authorized staff can create or edit locations. Because the module ships admin scaffolding, verify that its routes and policies align with your application's authorization model.
- How do I test the branches module in my application?
- Write feature tests that hit the module routes and assert that branch records are created, updated, and listed correctly for an authenticated admin user. Use RefreshDatabase with your test database so module migrations run in isolation. For the model itself, unit tests around relationships and validation rules give fast feedback without rendering the admin UI.
- Is this module a good alternative to building a branches table myself?
- If you already run TomatoPHP, the module saves time by providing the model, migrations, and admin screens out of the box. If your requirements are unusual, a simple custom migration and resource may be less overhead than adapting someone else's scaffolding. Evaluate how closely your branch fields and workflows match what the module offers before committing.
- How is tomatophp/tomato-branches-module maintained and updated?
- It is part of the broader TomatoPHP package family, so updates follow the ecosystem's release cadence on Packagist and GitHub. Pin the version in composer.json and review changelogs before upgrading, especially if you have customized migrations or admin resources. Check the repository issue tracker for recent activity to gauge how actively it is maintained.