Lodata

https://github.com/flat3/lodata
Admin
Lodata is an OData v4.01 Producer protocol implementation for the Laravel framework, simplifying...
Tokens:56,680
Snippets:412
Trust Score:5.4
License:MIT
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Define navigation property with entity types and sets

Source: https://github.com/flat3/lodata/blob/5.x/doc/modelling/relationships.md

Shows the full setup for a one-to-many relationship between 'person' and 'pet' entity types, including creating entity types, entity sets, a navigation property, and a binding. This is the main example for the 'Navigation properties' section.

```php
class LodataServiceProvider extends ServiceProvider
{
    public function boot()
    {
        /* Step 1 - Create the standard types and sets */
       
        // Create the source entity type
        $person = new EntityType('person')
            ->setKey(new DeclaredProperty('id', Type::int32())) // Primary key
            ->addDeclaredProperty('name', Type::string());

        // Create the related entity type
        $pet = new EntityType('pet')
            ->setKey(new DeclaredProperty('id', Type::int32())) // Primary key
            ->addDeclaredProperty('name', Type::string())
            ->addDeclaredProperty('owner_id', Type::int32());   // Foreign key

        // Add the entity types to the model
        Lodata::add($person);
        Lodata::add($pet);

        // Create the entity sets
        $pets = new SQLEntitySet('pets', $pet);
        $people = new SQLEntitySet('people', $person);

        // Add the entity sets to the model
        Lodata::add($people);
        Lodata::add($pets);

        /* Step 2: Create the navigation property on the source type */

        // Create the navigation property
        $toPet = new NavigationProperty(
            'pets', // Navigation property name
            $pet    // Target entity type
        );
        $toPet->setCollection(true); // Navigates to a collection of entities

        // Add the navigation property to the source entity type
        $person->addProperty($toPet);

        /* Step 3: Create a binding between the two entity sets */

        // Create a binding between the navigation property and its target entity set
        $binding = new NavigationBinding(
            $toPet, // Navigation property
            $pets   // Target entity set
        );

        // Attach the binding to the source entity set
        $people->addNavigationBinding($binding);
    }
}
```

--------------------------------

### Install Lodata with Composer

Source: https://github.com/flat3/lodata/blob/5.x/doc/getting-started/README.md

Run this command to install the flat3/lodata package into your Laravel application. After installation, restart your app; the OData endpoint will be available at http://127.0.0.1:8000/odata/.

```sh
composer require flat3/lodata
```

--------------------------------

### Create POST request with body and assert response

Source: https://github.com/flat3/lodata/blob/5.x/doc/introduction/reporting-issues.md

Use this example to generate a snapshot test for a POST request. It creates a Request object, sets the method to POST, adds a body, and targets a specific path. The assertion checks the HTTP response code and generates a snapshot.

```php
$this->assertJsonResponse(
    (new Request)
        ->post()
        ->body([
            'name' => 'Harry Horse',
        ])
        ->path('/Flights(1)/passengers'),
    Response::HTTP_CREATED
);
```

--------------------------------

### GET /odata/People (async with callback)

Source: https://github.com/flat3/lodata/blob/5.x/doc/making-requests/asynchronous-requests.md

Sends an asynchronous request with a callback URL. The service will make a GET request to the provided callback URL when the request is complete.

```APIDOC
## GET /odata/People (async with callback)

### Description
Sends an asynchronous OData request with a callback URL. The client provides a callback URL in the `Prefer` header. When the request is complete, the service makes a GET request to the callback URL. No payload or query parameters are added to the callback request.

### Method
GET

### Endpoint
/odata/People

### Headers
- **Prefer** (string) - Required - Set to `respond-async,callback;url=<callback_url>` to request asynchronous processing and provide a callback URL.

### Request Example
```
GET http://localhost:8000/odata/People
Prefer: respond-async,callback;url=https://client.example.com/callback
```

### Response
#### Success Response (202 Accepted)
- **Location** (string) - The monitoring URL to track the request status and retrieve the result.
- **Body** (object) - Contains an error object with code "accepted" and message "Accepted".

#### Response Example
```
HTTP/1.1 202 Accepted
location: http://localhost:8000/odata/_lodata/monitor/b6534e03-564b-4a74-abe6-a912483688e6
```
```json
{
    "error": {
        "code": "accepted",
        "message": "Accepted",
        "target": null,
        "details": [],
        "innererror": {}
    }
}
```
```

--------------------------------

### $select request and response

Source: https://github.com/flat3/lodata/blob/5.x/doc/making-requests/querying-data.md

Shows a GET request using $select to return only the origin and destination properties of all flights, followed by the JSON response containing only those properties.

```uri
GET http://localhost:8000/odata/flights?$select=origin,destination
```

```json
{
    "@context": "http://localhost:8000/odata/$metadata#flights(origin,destination)",
    "value": [
        {
            "origin": "lhr",
            "destination": "lax"
        },
        {
            "origin": "sam",
            "destination": "rgr"
        },
        {
            "origin": "sfo",
            "destination": "lax"
        }
    ]
}
```

--------------------------------

### JSON batch request and response

Source: https://github.com/flat3/lodata/blob/5.x/doc/making-requests/batch.md

Shows a JSON batch request to the $batch endpoint with multiple operations (GET, POST, PATCH) and the corresponding response. The request includes a GET for a flight, a POST to create an airport, a PATCH to update an airport, and a final GET for the airports list. The response shows the status codes and bodies for each operation.

```uri
POST http://localhost:8000/odata/$batch
{
  "requests": [
    {
      "id": 0,
      "method": "get",
      "url": "\/odata\/flights(1)"
    },
    {
      "id": 1,
      "method": "post",
      "url": "\/odata\/airports",
      "headers": {
        "content-type": "application\/json"
      },
      "body": {
        "name": "One",
        "code": "one"
      }
    },
    {
      "id": 2,
      "method": "patch",
      "headers": {
        "content-type": "application\/json",
        "if-match": "W\/\"73fa0e567cdc8392d1869d47b3f0886db629d38780a5f2010ce767900cde7266\""
      },
      "url": "\/odata\/airports(1)",
      "body": {
        "code": "xyz"
      }
    },
    {
      "id": 3,
      "method": "get",
      "url": "\/odata\/airports"
    }
  ]
}
```

```json
{
    "responses": [
        {
            "id": 0,
            "status": 200,
            "headers": {
                "content-type": "application/json",
                "etag": "W/\"2ccaaf443e26494dff243377cb72fb508b6dfad077dd4216f294be3fc0e7d0b5\""
            },
            "body": {
                "@context": "http://localhost:8000/odata/$metadata#flights/$entity",
                "id": 1,
                "origin": "lhr",
                "destination": "lax",
                "gate": null,
                "duration": "PT11H25M0S"
            }
        },
        {
            "id": 1,
            "status": 201,
            "headers": {
                "content-type": "application/json",
                "location": "http://localhost:8000/odata/airports(5)",
                "etag": "W/\"7f1bc052a54d9aed031b61b33efcee8e26c23b55f10814770f991b58d17c90e5\""
            },
            "body": {
                "@context": "http://localhost:8000/odata/$metadata#airports/$entity",
                "id": 5,
                "name": "One",
                "code": "one"
            }
        },
        {
            "id": 2,
            "status": 200,
            "headers": {
                "content-type": "application/json",
                "etag": "W/\"f593e92b83b424d5c98f33196d1cfff09a070417c1f5f37ffdb2a1451dd8343d\""
            },
            "body": {
                "@context": "http://localhost:8000/odata/$metadata#airports/$entity",
                "id": 1,
                "name": "Heathrow",
                "code": "xyz"
            }
        },
        {
            "id": 3,
            "status": 200,
            "headers": {
                "content-type": "application/json"
            },
            "body": {
                "@context": "http://localhost:8000/odata/$metadata#airports",
                "value": [
                    {
                        "id": 1,
                        "name": "Heathrow",
                        "code": "xyz"
                    },
                    {
                        "id": 2,
                        "name": "Los Angeles",
                        "code": "lax"
                    },
                    {
                        "id": 3,
                        "name": "San Francisco",
                        "code": "sfo"
                    },
                    {
                        "id": 4,
                        "name": "O'Hare",
                        "code": "ohr"
                    },
                    {
                        "id": 5,
                        "name": "One",
                        "code": "one"
                    }
                ]
            }
        }
    ]
}
```

--------------------------------

### Minimal metadata request and response

Source: https://github.com/flat3/lodata/blob/5.x/doc/making-requests/metadata.md

Shows a GET request with Accept: application/json;odata.metadata=minimal and the corresponding JSON response with minimal control information, including only the @context property.

```uri
GET http://localhost:8000/odata/People/8
Accept: application/json;odata.metadata=minimal
```

```json
{
    "@context": "http://localhost:8000/odata/$metadata#People/$entity",
    "id": 8,
    "FirstName": "Jason",
    "LastName": "Bourne",
    "Email": "jason.bourne@gmail.com"
}
```

--------------------------------

### Send asynchronous request with Prefer: respond-async

Source: https://github.com/flat3/lodata/blob/5.x/doc/making-requests/asynchronous-requests.md

Sends a GET request to the People entity set with the `Prefer: respond-async` header. The server responds with `202 Accepted` and a `Location` header containing a monitoring URL.

```uri
GET http://localhost:8000/odata/People
Prefer: respond-async
```

--------------------------------

### None metadata request and response

Source: https://github.com/flat3/lodata/blob/5.x/doc/making-requests/metadata.md

Shows a GET request with Accept: application/json;odata.metadata=none and the corresponding JSON response with no control information, only the data properties.

```uri
GET http://localhost:8000/odata/People/8
Accept: application/json;odata.metadata=none
```

```json
{
    "id": 8,
    "FirstName": "Jason",
    "LastName": "Bourne",
    "Email": "jason.bourne@gmail.com"
}
```

--------------------------------

### Use callback URL with asynchronous request

Source: https://github.com/flat3/lodata/blob/5.x/doc/making-requests/asynchronous-requests.md

Sends a GET request with `Prefer: respond-async,callback;url=...` to have the service notify the client via a callback URL when the request completes.

```uri
GET http://localhost:8000/odata/People
Prefer: respond-async,callback;url=https://client.example.com/callback
```

--------------------------------

### $skip=1 request and response

Source: https://github.com/flat3/lodata/blob/5.x/doc/making-requests/querying-data.md

Returns people starting with the 2nd person of the People entity set, skipping the first item.

```uri
GET http://localhost:8000/odata/People?$skip=1
```

```json
{
  "@context": "http://localhost:8000/odata/$metadata#People",
  "value": [
    {
      "id": 2,
      "FirstName": "Scott",
      "LastName": "Yammo",
      "Email": "scott.yammo@gmail.com"
    },
    {
      "id": 3,
      "FirstName": "Michael",
      "LastName": "Scott",
      "Email": "michael.scott@hotmail.com"
    }
  ]
}
```

--------------------------------

### Bound parameters: Inline operation example

Source: https://github.com/flat3/lodata/blob/5.x/doc/modelling/operations.md

Shows the same bound-parameter functions defined inline. The add operation sets its binding parameter name to 'timestamp', and the now operation is added separately.

```php
use Carbon\Carbon;
use Flat3\Lodata\Operation;
use Flat3\Lodata\Type\DateTimeOffset;
use Flat3\Lodata\Type\Duration;

class LodataServiceProvider extends ServiceProvider
{
    public function boot()
    {
        $add = new Operation\Function_('add');
        $add->setCallable(function (DateTimeOffset $timestamp, Duration $increment): DateTimeOffset {
            return new DateTimeOffset($timestamp->get()->addSeconds($increment->get()));
        })->setBindingParameterName('timestamp');
        Lodata::add($add);

        $now = new Operation\Function_('now');
        $now->setCallable(function (): DateTimeOffset {
            return new DateTimeOffset(Carbon::now()); 
        });
        Lodata::add($now);
    }
}
```

--------------------------------

### Full metadata request and response

Source: https://github.com/flat3/lodata/blob/5.x/doc/making-requests/metadata.md

Shows a GET request with Accept: application/json;odata.metadata=full and the corresponding JSON response with full control information, including @type, @id, and @readLink properties.

```uri
GET http://localhost:8000/odata/People/8
Accept: application/json;odata.metadata=full
```

```json
{
    "@context": "http://localhost:8000/odata/$metadata#People/$entity",
    "@type": "#com.example.odata.Person",
    "@id": "http://localhost:8000/odata/People(8)",
    "@readLink": "http://localhost:8000/odata/People(8)",
    "id": 8,
    "FirstName": "Jason",
    "LastName": "Bourne",
    "Email": "jason.bourne@gmail.com"
}
```

--------------------------------

### $search request and response

Source: https://github.com/flat3/lodata/blob/5.x/doc/making-requests/querying-data.md

Shows a GET request using $search to find airports with 'fo' or 'lh' in their code, followed by the JSON response listing matching airports.

```uri
GET http://localhost:8000/odata/flights?$search=fo OR lh
```

```json
{
    "@context": "http://localhost:8000/odata/$metadata#airports",
    "value": [
        {
            "id": 1,
            "name": "Heathrow",
            "code": "lhr",
        },
        {
            "id": 3,
            "name": "San Francisco",
            "code": "sfo",
        }
    ]
}
```

--------------------------------

### Class instance with LodataFunction attribute

Source: https://github.com/flat3/lodata/blob/5.x/doc/modelling/operations.md

Provides a class instance to the operation; the same instance is invoked with each call. The Example class exposes an incr() method decorated with #[LodataFunction] that increments and returns an internal counter. The service provider boots by discovering the instance via Lodata::discover().

```php
use Flat3\Lodata\Attributes\LodataFunction;

class Example {
    protected $value = 0;

    #[LodataFunction]
    public function incr(): int {
        return ++$this->value;
    }
}

class LodataServiceProvider extends ServiceProvider
{
    public function boot()
    {
        $example = new Example();
        Lodata::discover($example);
    }
}
```

```http
http://localhost:8000/odata/incr()
```

```json
{
    "@context": "http://localhost:8000/odata/$metadata#Edm.Int64",
    "value": 1
}
```

--------------------------------

### Monitor asynchronous request

Source: https://github.com/flat3/lodata/blob/5.x/doc/making-requests/asynchronous-requests.md

GET the monitoring URL to check the status. Returns `202 Accepted` if in progress, or `200 OK` with the result and `asyncresult` header when complete.

```uri
GET http://localhost:8000/odata/_lodata/monitor/b6534e03-564b-4a74-abe6-a912483688e6
```

--------------------------------

### Bound parameters: Class attribute example

Source: https://github.com/flat3/lodata/blob/5.x/doc/modelling/operations.md

Shows two functions using the #[LodataFunction] attribute. The now function returns a DateTimeOffset, and the add function is bound to the 'timestamp' parameter, allowing the output of now to be passed as the bound parameter.

```php
use Carbon\Carbon;
use Flat3\Lodata\Attributes\LodataFunction;
use Flat3\Lodata\Type\DateTimeOffset;
use Flat3\Lodata\Type\Duration;

class Example {
    #[LodataFunction]
    public function now(): DateTimeOffset {
        return new DateTimeOffset(Carbon::now()); 
    }

    #[LodataFunction(bind: "timestamp")]
    public function add(DateTimeOffset $timestamp, Duration $increment): DateTimeOffset {
        return new DateTimeOffset($timestamp->get()->addSeconds($increment->get()));
    }
}

class LodataServiceProvider extends ServiceProvider
{
    public function boot()
    {
        Lodata::discover(Example::class);
    }
}
```

--------------------------------

### GET /odata/People (async request)

Source: https://github.com/flat3/lodata/blob/5.x/doc/making-requests/asynchronous-requests.md

Sends an asynchronous OData request by including the Prefer: respond-async header. The server responds with 202 Accepted and a Location header containing a monitoring URL.

```APIDOC
## GET /odata/People

### Description
Sends an asynchronous OData request to retrieve data. The client indicates a preference for asynchronous processing via the `Prefer: respond-async` header. The server dispatches a job and returns a monitoring URL.

### Method
GET

### Endpoint
/odata/People

### Headers
- **Prefer** (string) - Required - Set to `respond-async` to request asynchronous processing.

### Request Example
```
GET http://localhost:8000/odata/People
Prefer: respond-async
```

### Response
#### Success Response (202 Accepted)
- **Location** (string) - The monitoring URL to track the request status and retrieve the result.
- **Body** (object) - Contains an error object with code "accepted" and message "Accepted".

#### Response Example
```
HTTP/1.1 202 Accepted
location: http://localhost:8000/odata/_lodata/monitor/b6534e03-564b-4a74-abe6-a912483688e6
```
```json
{
    "error": {
        "code": "accepted",
        "message": "Accepted",
        "target": null,
        "details": [],
        "innererror": {}
    }
}
```
```

--------------------------------

### Nullable types: Class attribute example

Source: https://github.com/flat3/lodata/blob/5.x/doc/modelling/operations.md

Shows how to define a nullable-argument function using the #[LodataFunction] attribute. The add function returns 0 if either argument is null. The service provider discovers the class.

```php
use Flat3\Lodata\Attributes\LodataFunction;

class Example {
    #[LodataFunction]
    public function add(?int $a, ?int $b): int {
        return (null === $a || null === $b) ? 0 : $a + $b;
    }
}

class LodataServiceProvider extends ServiceProvider
{
    public function boot()
    {
        Lodata::discover(Example::class);
    }
}
```

--------------------------------

### Nullable types: Inline operation example

Source: https://github.com/flat3/lodata/blob/5.x/doc/modelling/operations.md

Shows how to define the same nullable-argument function using an inline Operation\Function_ instance. The callable returns 0 if either argument is null, and the operation is added to Lodata.

```php
use Flat3\Lodata\Operation;

class LodataServiceProvider extends ServiceProvider
{
    public function boot()
    {
        $add = new Operation\Function_('add');
        $add->setCallable(function (?int $a, ?int $b): int {
            return (null === $a || null === $b) ? 0 : $a + $b;
        });
        Lodata::add($add);
    }
}
```

--------------------------------

### Hello World! - Request

Source: https://github.com/flat3/lodata/blob/5.x/doc/modelling/operations.md

HTTP request to invoke the 'hello' function.

```http
http://localhost:8000/odata/hello
```

--------------------------------

### Get Lodata endpoint URL

Source: https://github.com/flat3/lodata/blob/5.x/doc/clients/salesforce.md

Returns the endpoint URL for the Lodata service, used when configuring the Salesforce Connect external data source. This is the only code example on the page.

```php
\Lodata::getEndpoint()
```

--------------------------------

### Hello World! - Result

Source: https://github.com/flat3/lodata/blob/5.x/doc/modelling/operations.md

JSON response from the 'hello' function, returning an Edm.String value.

```json
{
    "@context": "http://localhost:8000/odata/$metadata#Edm.String",
    "value": "Hello world!"
}
```

--------------------------------

### Request complex property

Source: https://github.com/flat3/lodata/blob/5.x/doc/making-requests/requesting-data.md

Retrieves a property value of a complex type by composing property name segments. The example gets the Address property of the Location complex type of a Person.

```uri
GET http://localhost:8000/odata/People/michael-caine/location/address
```

```json
{
  "@context": "http://localhost:8000/odata/$metadata#People('michael-caine')/location/address",
  "value": "4 Hello Avenue"
}
```

--------------------------------

### GET /odata/People?$orderby=LastName

Source: https://github.com/flat3/lodata/blob/5.x/doc/making-requests/querying-data.md

Orders the People collection by the LastName property in ascending order (default) or descending order if 'desc' is specified. The example shows ordering by LastName in ascending order.

```APIDOC
## GET /odata/People?$orderby=LastName

### Description
Orders the People collection by the LastName property in ascending order (default) or descending order if 'desc' is specified. The example shows ordering by LastName in ascending order.

### Method
GET

### Endpoint
/odata/People?$orderby=LastName

### Parameters
#### Query Parameters
- **$orderby** (string) - Required - Specifies the property to order by and optional direction (asc or desc). Example: LastName or LastName desc.

### Response
#### Success Response (200)
- **@context** (string) - The OData metadata context.
- **value** (array) - List of People entities, each with id, FirstName, LastName, and Email.

#### Response Example
{
  "@context": "http://localhost:8000/odata/$metadata#People",
  "value": [
    {
      "id": 1,
      "FirstName": "Scott",
      "LastName": "Bumble",
      "Email": "scott.bumble@gmail.com"
    },
    {
      "id": 3,
      "FirstName": "Michael",
      "LastName": "Scott",
      "Email": "michael.scott@hotmail.com"
    },
    {
      "id": 2,
      "FirstName": "Scott",
      "LastName": "Yammo",
      "Email": "scott.yammo@gmail.com"
    }
  ]
}
```

--------------------------------

### Create and Request an OData Singleton with PHP

Source: https://github.com/flat3/lodata/blob/5.x/doc/modelling/singletons.md

Define a singleton named 'config' with properties for name, version, and session_lifetime, populate its values from Laravel's config and App facade, and register it with the OData service. The request URL retrieves the singleton, and the result shows the OData JSON response with the metadata context.

```php
use Flat3\Lodata\EntityType;
use Flat3\Lodata\Singleton;
use Flat3\Lodata\Type;
use Illuminate\Support\Facades\App;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    public function boot()
    {
        $Tconfig = new EntityType( 'config' );
        $Tconfig->addDeclaredProperty( 'name', Type::string() );
        $Tconfig->addDeclaredProperty( 'version', Type::string() );
        $Tconfig->addDeclaredProperty( 'session_lifetime', Type::int64() );

        $config = new Singleton( 'config', $Tconfig );

        $config['name'] = config( 'app.name' );
        $config['version'] = App::version();
        $config['session_lifetime'] = config('session.lifetime');

        \Lodata::add( $config );
    }
}

```

```text
http://127.0.0.1:8000/odata/config
```

```json
{
    "@context": "http://127.0.0.1:8000/odata/$metadata#com.example.odata.config",
    "name": "Laravel",
    "version": "8.51.0",
    "session_lifetime": 120
}
```

--------------------------------

### Define OData route in existing controller

Source: https://github.com/flat3/lodata/blob/5.x/doc/getting-started/routing.md

Shows how to mount the OData path as 'query' within a 'users' group in a service provider's boot method. The route uses a wildcard 'path' parameter and points to a UserController's query method.

```php
public function boot()
{   
    $this->configureRateLimiting();

    $this->routes(function () {
        Route::prefix('users')->group(function ($router) {
            $router->any("query{path}", [UserController::class, 'query'])->where('path', '(.*)');
        });
    });
}
```

--------------------------------

### Build a singleton with a collection property

Source: https://github.com/flat3/lodata/blob/5.x/doc/modelling/types/collections.md

Demonstrates creating a singleton entity with a collection property and assigning an array of values to it.

```php
$type = new EntityType('person');
$type->addDeclaredProperty('emails', Type::collection(Type::string()));
$entity = new Singleton('Person', $type);
$entity['emails'] = [
  'test@example.com',
  'test@gmail.com',
];
Lodata::add($entity);

```

--------------------------------

### Multipart Batch Request

Source: https://github.com/flat3/lodata/blob/5.x/doc/making-requests/batch.md

Sends a multipart batch request to the OData service. It includes a GET for a flight, a changeset with a POST and a PATCH for airports, and a final GET for airports. The request uses a boundary and changeset boundary to separate operations.

```http
POST http://localhost:8000/odata/$batch
Content-Type: multipart/mixed; boundary=batch_36522ad7-fc75-4b56-8c71-56071383e77b

--batch_36522ad7-fc75-4b56-8c71-56071383e77b
Content-Type: application/http

GET /odata/flights(1)
Host: localhost


--batch_36522ad7-fc75-4b56-8c71-56071383e77b
Content-Type: multipart/mixed; boundary=changeset_77162fcd-b8da-41ac-a9f8-9357efbbd

--changeset_77162fcd-b8da-41ac-a9f8-9357efbbd
Content-Type: application/http
Content-ID: 1

POST /odata/airports HTTP/1.1
Host: localhost
Content-Type: application/json

{
"name": "One",
"code": "one"
}
--changeset_77162fcd-b8da-41ac-a9f8-9357efbbd
Content-Type: application/http
Content-ID: 2

PATCH /odata/airports(1) HTTP/1.1
Host: localhost
Content-Type: application/json
Prefer: return=minimal
If-Match: W/"73fa0e567cdc8392d1869d47b3f0886db629d38780a5f2010ce767900cde7266"

{
"code": "xyz"
}
--changeset_77162fcd-b8da-41ac-a9f8-9357efbbd--
--batch_36522ad7-fc75-4b56-8c71-56071383e77b
Content-Type: application/http

GET /odata/airports HTTP/1.1
Host: localhost


--batch_36522ad7-fc75-4b56-8c71-56071383e77b--
```

--------------------------------

### Discover Eloquent model in AppServiceProvider boot()

Source: https://github.com/flat3/lodata/blob/5.x/doc/getting-started/README.md

Add this line to the boot() method of app/Providers/AppServiceProvider.php to expose the User model via auto-discovery. The model is exposed as 'Users' in the OData URL, and its properties are automatically detected.

```php
\Lodata::discover(\App\Models\User::class)
```

--------------------------------

### GET /odata/People/michael-caine/name

Source: https://github.com/flat3/lodata/blob/5.x/doc/making-requests/requesting-data.md

Retrieves the value of a simple property (Name) of a Person entity.

```APIDOC
## GET /odata/People/michael-caine/name

### Description
Retrieves the value of a simple property (Name) of a Person entity.

### Method
GET

### Endpoint
/odata/People/michael-caine/name

### Parameters
#### Path Parameters
- **key** (string) - Required - The key of the entity.
- **property** (string) - Required - The name of the property to retrieve.

### Response
#### Success Response (200)
- **@context** (string) - The context URL for the response.
- **value** (string) - The value of the property.

#### Response Example
{
  "@context": "http://localhost:8000/odata/$metadata#People('michael-caine')/name",
  "value": "Michael Caine"
}
```

--------------------------------

### Define partner navigation properties

Source: https://github.com/flat3/lodata/blob/5.x/doc/modelling/relationships.md

Creates two navigation properties ('pets' and 'person') and sets them as partners, allowing navigation in both directions on a single relationship.

```php
// Create one navigation property
$toPet = new NavigationProperty(
    'pets', // Navigation property name
    $pet    // Target entity type
);

$toPet->setCollection(true);

// Create the reverse navigation property
$toPerson = new NavigationProperty(
    'person', // Navigation property name
    $person   // Target entity type
);

// Set the properties as partners
$toPet->setPartner($toPerson);
$toPerson->setPartner($toPet);
```

--------------------------------

### GET /odata/flights?$select=origin,destination

Source: https://github.com/flat3/lodata/blob/5.x/doc/making-requests/querying-data.md

Requests only the origin and destination properties for each flight entity.

```APIDOC
## GET /odata/flights?$select=origin,destination

### Description
Requests only the origin and destination properties for each flight entity.

### Method
GET

### Endpoint
/odata/flights?$select=origin,destination

### Parameters
#### Query Parameters
- **$select** (string) - Required - Comma-separated list of properties to include in the response.

### Request Example
```uri
GET http://localhost:8000/odata/flights?$select=origin,destination
```

### Response
#### Success Response (200)
- **@context** (string) - The OData metadata context.
- **value** (array) - Array of flight objects with only the selected properties.

#### Response Example
```json
{
    "@context": "http://localhost:8000/odata/$metadata#flights(origin,destination)",
    "value": [
        {
            "origin": "lhr",
            "destination": "lax"
        },
        {
            "origin": "sam",
            "destination": "rgr"
        },
        {
            "origin": "sfo",
            "destination": "lax"
        }
    ]
}
```
```

--------------------------------

### GET /odata/flights?$search=fo OR lh

Source: https://github.com/flat3/lodata/blob/5.x/doc/making-requests/querying-data.md

Searches for airports whose code contains 'fo' or 'lh'.

```APIDOC
## GET /odata/flights?$search=fo OR lh

### Description
Searches for airports whose code contains 'fo' or 'lh'.

### Method
GET

### Endpoint
/odata/flights?$search=fo OR lh

### Parameters
#### Query Parameters
- **$search** (string) - Required - Search expression to filter entities.

### Request Example
```uri
GET http://localhost:8000/odata/flights?$search=fo OR lh
```

### Response
#### Success Response (200)
- **@context** (string) - The OData metadata context.
- **value** (array) - Array of airport objects matching the search expression.

#### Response Example
```json
{
    "@context": "http://localhost:8000/odata/$metadata#airports",
    "value": [
        {
            "id": 1,
            "name": "Heathrow",
            "code": "lhr"
        },
        {
            "id": 3,
            "name": "San Francisco",
            "code": "sfo"
        }
    ]
}
```
```

--------------------------------

### Discover Eloquent model with Lodata facade

Source: https://github.com/flat3/lodata/blob/5.x/doc/modelling/drivers/eloquent.md

Use the Lodata facade in a service provider's boot method to discover an Eloquent model. This enables automatic discovery of model properties, relationships, and methods as OData operations.

```php
class LodataServiceProvider extends ServiceProvider
{
    public function boot()
    {
        \Lodata::discover(\App\Models\Flight::class);
    }
}
```

--------------------------------

### GET /odata/People/michael-caine/name/$value

Source: https://github.com/flat3/lodata/blob/5.x/doc/making-requests/requesting-data.md

Retrieves the raw value of a primitive property (Name) of a Person entity.

```APIDOC
## GET /odata/People/michael-caine/name/$value

### Description
Retrieves the raw value of a primitive property (Name) of a Person entity.

### Method
GET

### Endpoint
/odata/People/michael-caine/name/$value

### Parameters
#### Path Parameters
- **key** (string) - Required - The key of the entity.
- **property** (string) - Required - The name of the property.
- **$value** (string) - Required - The raw value segment.

### Response
#### Success Response (200)
- **body** (text) - The raw value of the property.

#### Response Example
Michael Caine
```

--------------------------------

### Hello World! - Inline Operation

Source: https://github.com/flat3/lodata/blob/5.x/doc/modelling/operations.md

Defines the same 'hello' function using an inline Operation\Function_ instance with an anonymous function. The operation is added via Lodata::add().

```php
use Flat3\Lodata\Operation;

class LodataServiceProvider extends ServiceProvider
{
    public function boot()
    {
        $hello = new Operation\Function_('hello');
        $hello->setCallable(function () {
            return 'Hello world!';
        });
        Lodata::add($hello);
    }
}
```

--------------------------------

### Get original exception from ProtocolException

Source: https://github.com/flat3/lodata/blob/5.x/doc/making-requests/error.md

Catch a ProtocolException and retrieve the original exception using getOriginalException().

```php
try {
  // XXX
} catch (ProtocolException $protocolException) {
  /** @var Throwable $originalException */
  $originalException = $protocolException->getOriginalException();
}
```

--------------------------------

### Class Instance Operation

Source: https://github.com/flat3/lodata/blob/5.x/doc/modelling/operations.md

Demonstrates how a class instance can be used for an OData function, with the same instance called on each invocation.

```APIDOC
## GET /odata/incr()

### Description
Calls the incr function on a class instance, incrementing its internal value and returning the new value.

### Method
GET

### Endpoint
/odata/incr()

### Parameters
None

### Request Example
```
http://localhost:8000/odata/incr()
```

### Response
#### Success Response (200)
- **@context** (string) - The OData metadata context.
- **value** (integer) - The incremented value.

#### Response Example
```json
{
    "@context": "http://localhost:8000/odata/$metadata#Edm.Int64",
    "value": 1
}
```

```

--------------------------------

### GET /odata/people/0/nb

Source: https://github.com/flat3/lodata/blob/5.x/doc/modelling/operations.md

Invokes the 'nb' function bound to the 'person' entity, which calculates the duration until the next birthday.

```APIDOC
## [GET] /odata/people/0/nb

### Description
Invokes the 'nb' function bound to the 'person' entity, which calculates the duration until the next birthday.

### Method
GET

### Endpoint
/odata/people/0/nb

### Parameters
#### Path Parameters
- **0** (integer) - Required - The entity ID of the person to bind.

### Response
#### Success Response (200)
- **@context** (string) - The OData metadata context.
- **value** (string) - The duration until the next birthday in ISO 8601 duration format.

#### Response Example
{
    "@context": "http://localhost:8000/odata/$metadata#Edm.Duration",
    "value": "P234DT3H21M51S"
}
```

--------------------------------

### GET /odata/People/michael-caine/location/address

Source: https://github.com/flat3/lodata/blob/5.x/doc/making-requests/requesting-data.md

Retrieves the value of a property of a complex type (Address of the Location complex type) of a Person entity.

```APIDOC
## GET /odata/People/michael-caine/location/address

### Description
Retrieves the value of a property of a complex type (Address of the Location complex type) of a Person entity.

### Method
GET

### Endpoint
/odata/People/michael-caine/location/address

### Parameters
#### Path Parameters
- **key** (string) - Required - The key of the entity.
- **complexProperty** (string) - Required - The name of the complex property.
- **property** (string) - Required - The name of the property within the complex type.

### Response
#### Success Response (200)
- **@context** (string) - The context URL for the response.
- **value** (string) - The value of the property.

#### Response Example
{
  "@context": "http://localhost:8000/odata/$metadata#People('michael-caine')/location/address",
  "value": "4 Hello Avenue"
}
```

--------------------------------

### GET /odata/People

Source: https://github.com/flat3/lodata/blob/5.x/doc/making-requests/requesting-data.md

Retrieves a collection of entities from the People entity set. The response contains a list of entities with their properties.

```APIDOC
## GET /odata/People

### Description
Retrieves a collection of entities from the People entity set.

### Method
GET

### Endpoint
/odata/People

### Response
#### Success Response (200)
- **@context** (string) - The context URL for the response.
- **value** (array) - Array of entity objects.

#### Response Example
{
  "@context": "http://127.0.0.1:8000/odata/$metadata#People",
  "value": [
    {
      "id": "michael-caine",
      "name": "Michael Caine"
    },
    {
      "id": "bob-hoskins",
      "name": "Bob Hoskins"
    }
  ]
}
```

--------------------------------

### Discover SQL database table with Lodata

Source: https://github.com/flat3/lodata/blob/5.x/doc/modelling/drivers/database.md

Define an empty entity type, create an SQLEntitySet for the 'passengers' table, and call discoverProperties() to populate the entity type with field types. Add the set to Lodata in the service provider's boot method.

```php
class LodataServiceProvider extends ServiceProvider
{
    public function boot()
    {
        $passengerType = new \Flat3\Lodata\EntityType('passenger');
        $passengerSet = (new \Flat3\Lodata\Drivers\SQLEntitySet('passengers', $passengerType))
            ->setTable('passengers')
            ->discoverProperties();
        \Lodata::add($passengerSet);
    }
}
```

--------------------------------

### JSON result of randomperson operation

Source: https://github.com/flat3/lodata/blob/5.x/doc/modelling/operations.md

Example JSON response from the randomperson operation, showing the entity with name and dob fields.

```json
{
    "@context": "http://127.0.0.1:8000/odata/$metadata#com.example.odata.person",
    "name": "Jannie Harber",
    "dob": "1970-02-14"
}
```

--------------------------------

### Publish Lodata configuration

Source: https://github.com/flat3/lodata/blob/5.x/doc/getting-started/configuration.md

Run this artisan command to publish Lodata's configuration file into your application. The command uses the --provider and --tag flags to specify the service provider and configuration tag.

```sh
php artisan vendor:publish \
  --provider="Flat3\Lodata\ServiceProvider" \
  --tag="config"
```

--------------------------------

### GET /odata/flights?$expand=passengers

Source: https://github.com/flat3/lodata/blob/5.x/doc/making-requests/querying-data.md

Requests flights with their related passengers included inline. The response includes the passengers navigation property for each flight.

```APIDOC
## GET /odata/flights?$expand=passengers

### Description
Requests flights with their related passengers included inline. The response includes the passengers navigation property for each flight.

### Method
GET

### Endpoint
/odata/flights?$expand=passengers

### Parameters
#### Query Parameters
- **$expand** (string) - Required - Specifies the navigation property to include, e.g., passengers.

### Request Example
```uri
GET http://localhost:8000/odata/flights?$expand=passengers
```

### Response
#### Success Response (200)
- **@context** (string) - The OData metadata context.
- **value** (array) - The collection of flights, each with an embedded passengers array.

#### Response Example
```json
{
  "@context": "http://localhost:8000/odata/$metadata#flights(passengers())",
  "value": [
    {
      "id": 1,
      "origin": "lhr",
      "destination": "lax",
      "gate": null,
      "duration": "PT11H25M0S",
      "passengers": [
        {
          "id": 1,
          "name": "Anne Arbor",
          "flight_id": 1
        },
        {
          "id": 2,
          "name": "Bob Barry",
          "flight_id": 1
        },
        {
          "id": 3,
          "name": "Charlie Carrot",
          "flight_id": 1
        }
      ]
    },
    {
      "id": 2,
      "origin": "sam",
      "destination": "rgr",
      "gate": null,
      "duration": "PT39M44S",
      "passengers": [
        {
          "id": 4,
          "name": "Fox Flipper",
          "flight_id": 2
        }
      ]
    },
    {
      "id": 3,
      "origin": "sfo",
      "destination": "lax",
      "gate": null,
      "duration": "PT35M33S",
      "passengers": [
        {
          "id": 5,
          "name": "Grace Gumbo",
          "flight_id": 3
        }
      ]
    }
  ]
}
```
```

--------------------------------

### GET /odata/People/michael-caine

Source: https://github.com/flat3/lodata/blob/5.x/doc/making-requests/requesting-data.md

Retrieves an individual entity of type Person by its key using the key-as-segment convention. The key is type-coerced into the correct format.

```APIDOC
## GET /odata/People/michael-caine

### Description
Retrieves an individual entity of type Person by its key using the key-as-segment convention. The key is type-coerced into the correct format.

### Method
GET

### Endpoint
/odata/People/michael-caine

### Parameters
#### Path Parameters
- **key** (string) - Required - The key of the entity to retrieve.

### Response
#### Success Response (200)
- **@context** (string) - The context URL for the response.
- **id** (string) - The ID of the entity.
- **name** (string) - The name of the entity.

#### Response Example
{
  "@context": "http://localhost:8000/odata/$metadata#People/$entity",
  "id": "michael-caine",
  "name": "Michael Caine"
}
```

--------------------------------

### Define entity type and CollectionEntitySet in Laravel service provider

Source: https://github.com/flat3/lodata/blob/5.x/doc/modelling/drivers/collection.md

In the boot method of a Laravel service provider, define an entity type named 'example', set its key property as a string, add declared properties for 'name' and 'dob', create a CollectionEntitySet, and connect a collection using setCollection().

```php
class LodataServiceProvider extends ServiceProvider
{
    public function boot()
    {
        $entityType = new \Flat3\Lodata\EntityType('example');
        $entityType->setKey(new \Flat3\Lodata\DeclaredProperty('id', \Flat3\Lodata\Type::string()));
        $entityType->addDeclaredProperty('name', \Flat3\Lodata\Type::string());
        $entityType->addDeclaredProperty('dob', \Flat3\Lodata\Type::date());
        $entitySet = new \Flat3\Lodata\Drivers\CollectionEntitySet('examples', $entityType);
        $entitySet->setCollection($collection);
        \Lodata::add($entitySet);
    }
}
```

--------------------------------

### Register FilesystemEntitySet in Laravel service provider

Source: https://github.com/flat3/lodata/blob/5.x/doc/modelling/drivers/filesystem.md

In the boot method of a Laravel service provider, create a FilesystemEntitySet with a FilesystemEntityType, set the disk to 'default', and add it to Lodata. This exposes the filesystem as an OData entity set.

```php
class LodataServiceProvider extends ServiceProvider
{
    public function boot()
    {
        $entitySet = new \Flat3\Lodata\Drivers\FilesystemEntitySet('files', new \Flat3\Lodata\Drivers\FilesystemEntityType());
        $entitySet->setDisk('default');
        \Lodata::add($entitySet);
    }
}
```

--------------------------------

### Get original exception from Response object

Source: https://github.com/flat3/lodata/blob/5.x/doc/making-requests/error.md

Obtain the original exception from a captured Response object using the exception property and getOriginalException().

```php
$originalException = $response->exception->getOriginalException();
```
Tokens:
Raw