mirror of
https://github.com/JeroenED/libpairtwo.git
synced 2024-11-21 22:17:41 +01:00
Merge branch 'task/docs' into develop
This commit is contained in:
commit
74237ace5c
@ -1,13 +1,14 @@
|
|||||||
# Lib Pairtwo
|
# libpairtwo
|
||||||
|
|
||||||
Copyright 2018- (c) Jeroen De Meerleer <schaak@jeroened.be>
|
Copyright 2018- (c) Jeroen De Meerleer <schaak@jeroened.be>
|
||||||
|
|
||||||
This library reads sws-files that are saved using PairTwo developed by the Belgian Chess Federation (KBSB-FRBE).
|
This library reads out pairing files that are saved using common pairing applications
|
||||||
|
|
||||||
## Special thanks
|
## Special thanks
|
||||||
|
|
||||||
* Daniel Halleux (Webmaster KBSB)
|
* Daniel Halleux (Webmaster KBSB)
|
||||||
* Bernard Malfliet (Original developer Pairtwo)
|
* Bernard Malfliet (Original developer Pairtwo)
|
||||||
|
* Sylvin De Vet (Arbiter at VSF championship 2019 who helped me explaining several tiebreaks and other arbiter related stuff)
|
||||||
|
|
||||||
## Licence
|
## Licence
|
||||||
|
|
||||||
|
0
doc/.gitkeep
Normal file
0
doc/.gitkeep
Normal file
@ -1,69 +0,0 @@
|
|||||||
# 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;
|
|
||||||
```
|
|
Loading…
Reference in New Issue
Block a user