Download the PHP package ghorwood/phelo without Composer
On this page you can find all versions of the php package ghorwood/phelo. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
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 phelo
Phelo
Phelo is a simple library for managing the elo rating system.
The elo system is a rating method used in chess and other comptetitive games to calculate an estimate of the strength of the player, based on his or her performance versus other players.
Installation
The preferred installation method is via composer
Usage
Phelo works by creating an object to which you can add an arbitrary number of players and their associated initial elo scores. You can then:
- Calculate the percentage chance of a given player defeating another player
- Match two players against each other, setting a winner, and harvest the resulting elos
Instantiation
Presuming you have used an autoloader, you can use and instantiate phelo as such:
Adding players
Players can be set directly into the Phelo object as such
Getting a players elo
An individual player's elo can be retreived by referencing their name
All players can be retreived using getAll() which returns an array keyed by the player name.
Calculating chance of win
If two players with different elo ratings are matched against each other, it is assumed the player with the higher elo score has a greater probability of winning. Phelo can calculate the percent chance of a given player defeating another player with the chance() method.
The chance() method takes two player names as arguments. The first argument is the player for whom the chance of winning will be calculated
Running matches to calculate elo changes
Elo scores change for players after they win or lose matches. Phelo provides the method match() to simulate a contest between two players. The leftmost of the two players is the winner. After a call to match() the new elo scores for the contestants is updated in the object and can be retreived.
Calls to match() can be chained to simulate several consecutive contests.
Errors
Phelo will throw an Exception in the following cases:
- Attempt to get a player that does not exist
- Attempt a match() or chance() on a player that does not exist
- Attempt to create a player with an elo less than 1
The use of try/catch blocks for Exception is encouraged.
K factor
The K factor affects the sensitivity of changes: a higher K factor increases the changes in elo scores created by matches.
Choosig a K factor that is right for your requirements can be difficult. A good starting place to read on K factor is the 'Most accurate K-factor' sectionof the wikipedia entry on elo.
Phelo's default K factor is 30. You can change this to your custom value at instation by passing a new value to the contructor:
Gradation of K factor for different elo ratings is not supported in Phelo as this time.
Getting support or contributing
Any prs should conform to PSR-2 formatting, pass phpstan static analysis at level 7 and be accompanied by tests.
The precommit.sh script is provided to do the formatting, analysis and tests.
Support requests, questions or bug reports should also be accompanied by a twitter dm to @gbhorwood, because i'm terrible at email.
