Download the PHP package peterfox/graphaware-reco-client without Composer
On this page you can find all versions of the php package peterfox/graphaware-reco-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download peterfox/graphaware-reco-client
More information about peterfox/graphaware-reco-client
Files in peterfox/graphaware-reco-client
Package graphaware-reco-client
Short Description An API client implemented in PHP to work with GraphAware's Recommendation framework
License MIT
Informations about the package graphaware-reco-client
GraphAware-Reco client for PHP
The client is designed to work in turning recommendations and scores from a GraphAware Recommendation endpoint into objects that are easy to work with.
The current implementation uses Guzzle but can easily build your own to work with any HTTP client library.
Install
Use composer to get the package
Basic Setup
A basic example can use the common implementations of the interfaces set out but it's easy to create your own or extend the common ones to make it work with your own tweaks to the recommendations end point you've created.
You can then just supply a parameter array to fetch a set of recommendations
Implement your own service
You can implement your own setup as needed, the common classes are mainly for examples and because they cover how most developers would set up a recommendation endpoint for their service.
Create a recommendation service
The purpose of the RecommendationService interface is to simply state the uri for the endpoint and any arguments that you'll use for to request your recommendations.
Create a response parser
Overall the response parser is simply used as a way of taking the json as an array and breaking it down into an array of recommendations. By default most setups will just be an array of recommendations already so nothing happens in the common example but if you need to change that you can.
Create a recommendation model
Your models might differ from the common example as each recommendation might provide more details about the nodes it's recommending, as such you can implement your own.
Create a recommendation factory
If you have made your own recommendation models you'll need to implement a factory for the client to initiate an instance of it using the date for each recommendation.
Testing
There's some basic testing you can run for the library, namely PHPSpec and Behat. To run the behat tests you must also run the tutu server to emulate a GraphAware Reco setup.