Weave Code
Laravel Json Model Laravel Package
carsdotcom/laravel-json-model
A Laravel package for working with JSON-backed models, letting you define structured JSON data as Eloquent-style models and query or persist it through familiar Laravel conventions. Useful for flexible schemas, configuration, and document-style storage.
carsdotcom/laravel-json-model provides a lightweight, JSON-backed model layer for Laravel. It lets you define models around JSON data and interact with them using familiar, Eloquent-style patterns—useful for small datasets, fixtures, configuration-driven records, and prototypes without a database.
- Simple model definitions for JSON sources
- Eloquent-like access and querying
- Attribute casting and accessors/mutators
- Seamless Laravel integration
- Lightweight setup with no database required
Frequently asked questions about Laravel Json Model
- What is carsdotcom/laravel-json-model used for?
- It is a Laravel package for defining JSON-backed models that expose an Eloquent-style API, so you can query, validate, and persist structured JSON data. Because everything lives in JSON rather than a relational schema, it suits configuration files, document-style records, and flexible or evolving schemas. It is positioned as a lightweight alternative to writing custom file or settings handling in each project.
- How do I install carsdotcom/laravel-json-model in a Laravel app?
- Install it with Composer using composer require carsdotcom/laravel-json-model, then follow the README for any config publishing or model bootstrapping steps. Because it is a Laravel library, package discovery handles provider registration where applicable. After that you define model classes that extend the package's JSON model base and start reading and writing data.
- Do I need database migrations or tables to use this package?
- No. The package stores model data as JSON, so the usual migration-and-schema workflow does not apply. That removes the need for schema design, column migrations, and database rollouts when your data shape changes. It is the main reason the package is pitched for configuration files, documents, and flexible schemas.
- Which Laravel and PHP versions does the package support?
- The release line is at v1.4.10, which is past its 1.0 stability point and receiving patch-level maintenance. The specific Laravel and PHP support matrix is defined by the package's composer.json constraints and its README, so check those before adopting it. If your application pins an older Laravel or PHP version, verify the constraint allows the release you intend to install.
- How does the Eloquent-style API work for JSON models?
- You define model classes that behave like Eloquent models, so familiar patterns such as attribute access, querying, and persistence carry over to JSON-backed data. This keeps a consistent mental model across your codebase instead of introducing bespoke array or file handling. The result is structured JSON you can treat as models rather than raw decoded arrays.
- Can I validate JSON data with this package?
- Yes, validation is part of the documented surface area alongside querying and persisting. Because JSON payloads have no database-level constraints behind them, validating on write is how you keep documents consistent with the shape your application expects. Apply the same rules you would normally express as column types and constraints.
- Where is the JSON data stored and how is it persisted?
- Persistence is file or storage based rather than database based, which is what allows the package to work without migrations. The exact storage location and any configuration options are described in the package README. Review that before production use so you understand backup, permissions, and multi-server deployment implications for the underlying storage path.
- Does carsdotcom/laravel-json-model support PHPStan and Larastan?
- Yes. Recent releases ship first-party static-analysis annotations, and the v1.4.10 patch was explicitly a Larastan annotation update with zero code changes. That means typed, statically analyzed Laravel codebases get accurate type information for this dependency instead of accumulating baseline ignores. The annotations are consumed at analysis time only and are not loaded at runtime.
- Is upgrading the package risky in production?
- The v1.4.10 upgrade is low risk: it is a patch bump containing only Larastan annotations, with no public API, autoload, service provider, config, or migration changes. Annotations are read by PHPStan/Larastan during analysis and cannot alter runtime behavior, and rollback is a single version pin in composer.json. The only residual concern is that teams pinned below Larastan 3.11 may see new or stricter analysis output in their own code after upgrading.
- How does it compare to storing JSON in a database column or using a settings package?
- Storing JSON in a database column still requires migrations, a table, and a connection, whereas this package removes the database dependency entirely. That makes it a better fit for configuration files, documents, and data whose shape changes frequently, and a worse fit for data you need to join, aggregate, or query at scale in SQL. If your JSON must participate in relational queries or transactions, a native database column is usually the safer choice.
Weaver
How can I help you explore Laravel packages today?