Download the PHP package viral-agency/master-caster without Composer
On this page you can find all versions of the php package viral-agency/master-caster. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download viral-agency/master-caster
More information about viral-agency/master-caster
Files in viral-agency/master-caster
Package master-caster
Short Description Easily cast JSON API responses into custom objects models
License Apache-2.0
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package master-caster
PHP MasterCaster
Unlike other strongly typed languages (such as Java), PHP typically converts API requests from/to JSON using arrays. The problem with this approach is that it is impossible to know upfront the number, names, or types of properties being converted. This leads to unpredictable scenarios and makes the code harder to maintain. As a result, developers are often forced into complex technical workarounds, which, over time, become unmanageable. This is especially true when dealing with deeply nested JSON properties, where developers are forced to write iterative loops, resulting in messy and poorly maintainable code. MasterCaster bridges the gap between strong typing and PHP's flexibility. It allows you to define a model where the properties of objects are specified in advance, based on the third-party API documentation. This enables JSON responses to be dynamically and recursively converted into specific objects. At the same time, it lets you define custom methods within the classes, taking full advantage of OOP principles such as inheritance, encapsulation, and polymorphism.
In short, it’s a small revolution in PHP.
Requirements
- PHP >= 8.0
- Composer (you can install from here)
- A well-written third-party API documentation (in order to fit the requirements out-of-the-box, the JSON representation of the response have to meet the Google JSON style guide, in particularly way the array naming convention)
Installation
To install the package, run the following command using Composer:
Alternatively, you can add the package to your composer.json file:
Then, run:
Usage
You can easily to use MasterCaster by defining a model from the third party API documentation:
Sample third-party API documentation
Here a sample third party API documentation that fits the Google JSON style guide
Define the models
Define each elements of the JSON representation by coping directly from the documentation, in order to be sure that's correct.
Sample Response Class
Sample Object Class
Please note: you are free to put all the nested objects that you need.
Replace the name following the third-party documentation.
Features
- Inheritance: All the defined objects inherit the same constructor
- Array casting of objects: MasterCaster translate the array of objects in the model-defined objects, getting che class name by singularize the array name
- Names translations: MasterCaster translate automatically names from camelCase to PascalCase, in order to get the classnames correctly
Troubleshooting
Array of objects name is not pluralized
Yeah. In some cases the array of objects is not pluralized. You are free to override the base method in order to match your name, by adding an intermediate class. In my case, the "video" object array wasn't pluralized:
Contributing
Contributions are welcome! If you find problems, please report by open a support request, thanks
Support
If you encounter issues, feel free to open an issue in the GitHub repository.
License
This package is open-sourced software licensed under the Apache 2 License.
