justbetter/odata-client

Saint Systems OData Client for PHP

1.3.2 2024-07-26 11:25 UTC

This package is auto-updated.

Last update: 2024-10-26 12:00:32 UTC


README

A fluent library for calling OData REST services inspired by and based on the Laravel Query Builder.

This library is a fork of saintsystems/odata-client. The maintainer seems to have abandoned the repo. We will maintain this fork and accept new PR's

Latest Version on Packagist Total Downloads

Looking for a way to interact with Microsoft Dynamics? Checkout our Laravel Dynamics Client!

Install the SDK

You can install the PHP SDK with Composer.

composer require justbetter/odata-client

Call an OData Service

The following is an example that shows how to call an OData service.

<?php

require_once __DIR__ . '/vendor/autoload.php';

use SaintSystems\OData\ODataClient;

class UsageExample
{
	public function __construct()
	{
		$odataServiceUrl = 'https://services.odata.org/V4/TripPinService';

		$odataClient = new ODataClient($odataServiceUrl);

		// Retrieve all entities from the "People" Entity Set
		$people = $odataClient->from('People')->get();

		// Or retrieve a specific entity by the Entity ID/Key
		try {
			$person = $odataClient->from('People')->find('russellwhyte');
			echo "Hello, I am $person->FirstName ";
		} catch (Exception $e) {
			echo $e->getMessage();
		}

		// Want to only select a few properties/columns?
		$people = $odataClient->from('People')->select('FirstName','LastName')->get();
	}
}

$example = new UsageExample();

Develop

Run Tests

Run vendor/bin/phpunit from the base directory.

Documentation and resources

Issues

View or log issues on the Issues tab in the repo.

Copyright and license

Copyright (c) Saint Systems, LLC. All Rights Reserved. Licensed under the MIT license.