avoo/elo

Elo calculator library

Elo

, _(*1)

This is a PHP library to calculate the Elo rank between two players., _(*2)

Documentation

into your composer.json file:, _(*3)

``` json { "require": { "avoo/elo": "~0.2" } }, <sub>(*4)</sub>

Default Usage
-------------

You need to implement the class `Avoo\Elo\Model\EloPlayerInterface` on your own player class

``` php
use Avoo\Elo\Model\EloPlayerInterface;
use Avoo\Elo\Model\EloUserInterface;

class EloPlayer implements EloPlayerInterface
{
    /**
     * @var integer
     */
    protected $elo;

    /**
     * @var EloUserInterface $user
     */
    protected $user;

    /**
     * {@inheritdoc}
     */
    public function setElo($elo)
    {
        $this->elo = $elo;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getElo()
    {
        return $this->elo;
    }

    /**
     * {@inheritdoc}
     */
    public function setUser(EloUserInterface $user)
    {
        $this->user = $user;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getUser()
    {
        return $this->user;
    }

    //... Your own code
}

Consider the player A with 2300 elo and the player B 1800, the player A lose., <sub>(*5)</sub>

The default setup for winner is: - 0 Player A lose - 0.5 Draw - 1 Player A win, <sub>(*6)</sub>

Example 1

``` php use Avoo\Elo\EloPoint; use Avoo\Elo\EloVersusInterface; use Avoo\Elo\EloAggregagtionInterface;, <sub>(*7)</sub>

$eloCalculator = new EloPoint();, <sub>(*8)</sub>

/** @var EloVersusInterface $match */ $eloPoint->calculate($match);, <sub>(*9)</sub>

/** @var EloAggregationInterface $aggregation */ $aggregation = $eloPoint->getAggregation();, <sub>(*10)</sub>

Example 2
---------

``` php
use Avoo\Elo\EloPoint;
use Avoo\Elo\EloVersusInterface;
use Avoo\Elo\EloAggregagtionInterface;

/** @var EloVersusInterface $match */
$eloCalculator = new EloPoint($match);
$eloPoint->calculate();

/** @var EloAggregationInterface $aggregation */
$aggregation = $eloPoint->getAggregation(); 

Override configuration

You can override the default configuration for adjust your elo calculator, <sub>(*11)</sub>

``` php use Avoo\Elo\EloPoint; use Avoo\Elo\EloVersusInterface; use Avoo\Elo\EloAggregagtionInterface; use Avoo\Elo\ConfigurationInterface;, <sub>(*12)</sub>

/** @var ConfigurationInterface $configuration */ $configuration = new Configuration();, <sub>(*13)</sub>

/** * Floor is the experience range calculator */ $configuration->setFloor(200);, <sub>(*14)</sub>

/** * Base range is ratio number for calculate the new elo * In this case between 0 and 1700 elo point the range is 50, over it's 20 * For example with 1500 elo point for both players, with 50 elo range, the new elo will be 18 and -18, * and for 20 elo range, the new elo will be 7 and -7 */ $configuration->setBaseRange(array( 0 => 50 1700 => 20 ));, <sub>(*15)</sub>

/* * Base elo is the start elo point for a new player */ $configuration->setBaseElo(1000);, <sub>(*16)</sub>

/** @var EloVersusInterface $match */ $eloCalculator = new EloPoint($match, $configuration); $eloPoint->calculate();, <sub>(*17)</sub>

/** @var EloAggregationInterface $aggregation */ $aggregation = $eloPoint->getAggregation(); ```, <sub>(*18)</sub>