Download the PHP package graymatterlabs/pingtree without Composer
On this page you can find all versions of the php package graymatterlabs/pingtree. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download graymatterlabs/pingtree
More information about graymatterlabs/pingtree
Files in graymatterlabs/pingtree
Package pingtree
Short Description A Ping Tree is a process in which a single lead is offered to multiple buyers in real-time and sold to the highest bidder
License MIT
Homepage https://github.com/graymatterlabs/pingtree
Informations about the package pingtree
Ping Tree Lead Distribution
A Ping Tree is a process in which a single lead is offered to multiple buyers in real-time and sold to the highest bidder.
Installation
You can install the package via composer:
Usage
Responses
The ping tree will return the first successful response provided by an offer. Responses must implement the GrayMatterLabs\PingTree\Contracts\Response
interface but should be customized beyond that.
Offers
Offer instances are responsible for communicating with and managing state of the offer such as health and eligibility rules.
Events
This package fires events and provides you the ability to register listeners for each. Listeners can be used for performing any custom logic. Listeners are executed synchronously to be sure to handle any potential exceptions.
Listeners can be registered to the Tree class, which handles all events, using the listen
method, like so:
Below is a list of all events fired, their descriptions, and the parameters passed to any registered listeners.
Name | Description | Parameters |
---|---|---|
selecting |
An offer is being selected | Strategy $strategy, Lead $lead, array $offers |
selected |
An offer has been selected | Strategy $strategy, Lead $lead, array $offers, Offer $offer |
sending |
The lead is being sent to the offer | Lead $lead, Offer $offer |
sent |
The lead has been send to the offer | Lead $lead, Offer $offer, Response $response, int $attempts |
Strategies
This package provides a concept of "strategies" to decide which offer to send the lead to. A default set of strategies are provided out-of-the-box. The only requirement to providing your own strategies is that they implement the GrayMatterLabs\PingTree\Contracts\Strategy
interface.
Strategy | Description |
---|---|
HighestPing | Gets the offer with the highest ping() value |
RoundRobin | A decorator to ensure each offer is attempted across multiple executions for a given lead |
Shuffled | A decorator to ensure random order before executing the given strategy |
Ordered | Gets the first offer in the list of provided offers |
Testing
Changelog
Please see the Release Notes for more information on what has changed recently.
Credits
- Ryan Colson
- All Contributors
License
The MIT License (MIT). Please see License File for more information.