Download the PHP package curiosity26/odataquery without Composer
On this page you can find all versions of the php package curiosity26/odataquery. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download curiosity26/odataquery
More information about curiosity26/odataquery
Files in curiosity26/odataquery
Package odataquery
Short Description A library of PHP Classes that allow for OData queries to be easily built and extended for appending to a URL Request to an API supporting OData server-side.
License GPL-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 odataquery
ODataQuery-PHP
A library of PHP Classes that allow for OData queries to be easily built and extended for appending to a URL Request to a server-side API supporting OData v4.0. Support for any of the query functions made available in this library are based on the configuration of the API server. This library simply conforms to the expected functionality as described on http://www.odata.org/. Other language versions of this library are available at http://www.odata.org/libraries or on GitHub at https://github.com/ODataOrg/.
Installation
Included in a PHP Project w/ Composer
Add the following to your composer.json file using the latest version number or 1.0.* to keep it fresh:
or to use the bleeding edge developement version:
Standalone Project
ODataQuery-PHP is packaged for Composer. If you don't have composer installed, go to https://getcomposer.org/ download and install.
Once composer is installed, use your command line terminal and cd into the ODataQuery-PHP folder. Run 'composer install'. If you have composer installed correctly, it should work fine and you'll see a new directory created called 'vendors'. Within the vendors folder there is an autoload.php file created by composer.
Basic Usage
Include this autoloader when loading your own code module or on any scripts that you are using ODataQuery-PHP in.
Example
Our base API URL:
First we'll build a path for the request of objects. (Namespaces will be implied in examples. Assuming you're using and IDE and the autoloader created by composer, these will be filled out for you anyway)
The created path can be used just like a string variable:
If you to force the path to be used as a string (sometimes helpful when passing as a variable into a function that requires a string parameter) you can simply cast the ODataResourcePath object as a string. The goes for any object in the ODataQuery library.
$select
You can select which properties of the returned objects are included:
See the Expand section below to learn how select can be applied to specific properties.
$search
You can search the properties of the object set using search:
Search queries are also chainable:
This will now search the set of Employees objects to be returned for '"mountain bike" AND balloon'. See the Expand section below to learn how the search function can be applied to specific properties.
$count
You can return the total record count of your query. The $count system query option ignores any $top, $skip, or $expand query options, and returns the total count of results across all pages including only those results matching any specified $filter and $search. Clients should be aware that the count returned inline may not exactly equal the actual number of items returned, due to latency between calculating the count and enumerating the last value or due to inexact calculations on the service.
$filter
The recordset queried can be filtered to return a more precise set of records. There are various filters available and most can be used in combination with another.
Each filter has a set of extensible functions that allow the filter to be passed into another filter, returning the new filter.
Filters can accept Filters as properties or values and a value can also be a property name
$pager
Records can be paged server-side by passing $top and $skip where $top is the limit of records returned and $skip is the start offset. The ODataQueryPager object takes the math out of the equation and lets you simply specify the limit and the page you want to return.
$orderby
Results can be sorted by a property name within the collection. Simply specify which property you would like to sort by in the orderBy() function.
$expand
The ODataQueryExpand object is used to subquery the results of the main query. It can be applied to properties of the main query's recordset using OData's path format (Property1/SubProperty1/AndSoOn) or to an expanded upon property (deep injection).
The ODataQueryExpand object is built off the same parent class as ODataResourcePath; ODataResource. So all of the above functions are available on the ODataQueryExpand object, including expand, which allows an expanded upon property to expand upon itself (deep injection).
Because multiple properties can be expanded upon, the expand() function of ODataResourcePath and ODataQueryExpand require a collection of ODataExpandableInterface objects in the form of a single ODataQueryExpandCollection object. The ODataQueryExpand objects must be added to the ODataQueryExpandCollection which is then passed to the ODataResourcePath or ODataQueryExpand objects.
