JeroenED/libpairtwo
1
0
Fork 0
mirror of https://github.com/JeroenED/libpairtwo.git synced 2024-12-22 12:21:22 +01:00
Code Issues Projects Releases Wiki Activity

Updated docs

Browse Source
This commit is contained in:
Jeroen De Meerleer 2019-03-20 18:50:31 +01:00
parent 7bafdc6d5f
commit fc2292414f
Signed by: JeroenED
GPG Key ID: 28CCCB8F62BFADD6
1 changed files with 69 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
doc/0. Getting started.md Normal file
View File

@ -0,0 +1,69 @@
# Getting started
## Installing Libpairtwo
You can easily start using libpairtwo by installing it via composer
```bash
$ composer install JeroenED/libpairtwo
```
In you initialization code add the vendor/autoload.php
```php
require_once("vendor/autoload.php");
```
## Reading out a sws-file
Reading out a sws-file is very simple. Just call the Sws::ReadSws() method.
```php
$sws = JeroenED\Libpairtwo\Sws::ReadSws("Clubcompetition.sws");
```
This will return a usable object for reaching out for results, rankings, etc.
## Getting methods of the class
I didn't want to add the generated phpdoc in this library simply because it is generated.
The command to generate it yourself is just `$ phpdoc`. This will generate the docs in the doc/api folder.
## Examples
### Getting results of a tournament
```php
<?php
require_once("vendor/autoload.php");
use JeroenED\Libpairtwo\Sws;
$sws = Sws::ReadSws("Clubcompetition.sws");
$tournament = $sws->getTournament();
$calendar = $tournament->getRounds();
$roundNo = 1;
foreach ($calendar as $round) {
echo "Ronde: " . $roundNo . ' (' . $round->getDate()->format('Y/m/d') . PHP_EOL . ')'; $roundNo++;
foreach($round->getGames() as $game) {
if (!is_null($game->getResult())) {
echo (is_null($game->getWhite())) ? "bye" : $game->getWhite()->getPlayer()->getName();
echo " " . $game->getResult()->getValue() . " ";
echo (is_null($game->getBlack())) ? "bye" : $game->getBlack()->getPlayer()->getName();
echo PHP_EOL;
}
}
echo PHP_EOL;
```
### Getting rankings of the tournament
```php
<?php
require_once("vendor/autoload.php");
use JeroenED\Libpairtwo\Sws;
$sws = Sws::ReadSws("Clubcompetition.sws");
$tournament = $sws->getTournament();
$rankings = $tournament->getRanking();
$rankingNo = 1;
foreach ($rankings as $ranking) {
echo $rankingNo . '. ' . $ranking->getTitle()->getKey() . ' ' . $ranking->getName() . '(' . $ranking->getPoints() . '/' . $tournament->getNoOfRounds() . ')' . PHP_EOL;
}
echo PHP_EOL;
```