Download the PHP package khalyomede/laravel-odata-adaptable without Composer
On this page you can find all versions of the php package khalyomede/laravel-odata-adaptable. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download khalyomede/laravel-odata-adaptable
More information about khalyomede/laravel-odata-adaptable
Files in khalyomede/laravel-odata-adaptable
Package laravel-odata-adaptable
Short Description Adapt your Eloquent model automatically according to the OData query strings.
License MIT
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 laravel-odata-adaptable
laravel-odata-adaptable
Adapt your Eloquent model automatically according to the OData query strings.
Summary
- About
- Features
- Requirements
- Installation
- Usage
- Examples
- API
- Known issues
About
I needed to customize how my client side application fetches results from my Laravel REST API. Mostly, I just need to filter which fields I want to get from my API. I checked for POData-Laravel, but I found it too much strict.
I wanted a drop-in solution, that does not change the way I work with my existing Eloquent models, so I decided to create this library.
Features
- use a Trait on your model, which will make them automatically mutate the result according to the OData query strings
- Support for the following OData keywords:
$select,$orderBy,$topand$skip - Throw an error if you use
$selectusing$hiddencolumns - Tested with Laravel versions:
- 5.8.*
Requirements
- PHP >= 7.2.0
- Composer
Installation
Add the dependency:
Usage
Add the OdataAdaptable trait to your existing model.
You should have a route like:
In your controller, add the capability to adapt to the OData V4 query strings to your Eloquent model like this:
Now, if you run this HTTP query
You will get
But if you use OData query strings, you will be able to do
And you will get
Examples
- 1. Calling it at the very first
- 2. Chaining it after previous call to the Eloquent query builder
1. Calling it at the very first
In this example, we will call the adapt method to adapt our Eloquent ORM result according to the query strings received from the controller's request. The file below is extracted from an hypothetical controller.
2. Chaining it after previous call to the Eloquent query builder
In this example, we will call the adapt method right after some methods, to show you how you can still take advantage of this library even after existing changes to the result of your Eloquent query.
API
parameters
Request $request: The request from your Controller. It will be used to extract the URL using$request->fullUrl().
return
An instance of Builder that let you chain other query builder methods.
exceptions
See all the exceptions thrown by OdataQueryParser.
Known issues
The following OData V4 query strings commands will not work:
- count
- filter
