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

META: Documentation fixups

Browse Source
This commit is contained in:
Jeroen De Meerleer 2019-09-28 10:34:43 +02:00
parent d4edff4717
commit fa30eb9ac3
Signed by: JeroenED
GPG Key ID: 28CCCB8F62BFADD6
8 changed files with 21 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@ -3,7 +3,7 @@
## vx.y.z (Release: aa-bbb-cccc)
## v1.2 (Release: 28-sep-2019)
* NEW READER: `Reader::swar-4` for reading out files created with Swar version 4.
* NEW READER: `Reader::swar-4` for reading out files created with SWAR version 4.
* NEW FEATURE: `Tournament::getArbiters()` for multiple arbiters in 1 tournament
* ENHANCEMENT: `Class::getBinaryData()` methods return null if field is non-existent
* ENHANCEMENT: The template in distributions provides a more usable starting implementation

4
dist/readme.md vendored
View File

@ -5,9 +5,9 @@ This distribution is a good start to use libpairtwo if you don't have knowledge
How to use this distribution?
-----------------------------
The file `template.php` is the one you'll probably want to work with. You'll want to point your browser to this file. It contains some initializations where the most important one is the variable `$pairingfile`. You'll want to set this to existing pairing file.
The other variable (`$pairingfileformat`) is a variable that defines the format of the above pairing file. For now only `Pairtwo-6` and `Pairtwo-5` are available. In the future more formats will become available.
The other variable (`$pairingfileformat`) is a variable that defines the format of the above pairing file. For now only `Pairtwo-6`, `Pairtwo-5` and `Swar-4` are available. In the future more formats will become available.
Below the comments you'll find some example code. This code is only a aggregation of several fields that are read out. If you need any modifications like putting the rankings in a table or you want to just write it to a file, go ahead it's all yours.
Below the comments you'll find some example code. The example codes gives the pairings and rankings of the currently used pairing file. If you need any modifications like adding your own template or you want to just write it to a file: go ahead it's all yours.
How to update the library?
--------------------------

3
src/Game.php
View File

@ -12,10 +12,9 @@
namespace JeroenED\Libpairtwo;
use DateTime;
use JeroenED\Libpairtwo\Enums\Gameresult;
use JeroenED\Libpairtwo\Models\Round;
use JeroenED\Libpairtwo\Pairing;
use DateTime;
/**
* Class Games

2
src/Player.php
View File

@ -12,8 +12,8 @@
namespace JeroenED\Libpairtwo;
use JeroenED\Libpairtwo\Enums\Title;
use JeroenED\Libpairtwo\Enums\Gender;
use JeroenED\Libpairtwo\Enums\Title;
use DateTime;
/**

14
src/Readers/Pairtwo6.php
View File

@ -13,18 +13,18 @@
namespace JeroenED\Libpairtwo\Readers;
use JeroenED\Libpairtwo\Enums\Color;
use JeroenED\Libpairtwo\Enums\Gender;
use JeroenED\Libpairtwo\Enums\Result;
use JeroenED\Libpairtwo\Enums\Tiebreak;
use JeroenED\Libpairtwo\Enums\Title;
use JeroenED\Libpairtwo\Enums\Gender;
use JeroenED\Libpairtwo\Enums\Color;
use JeroenED\Libpairtwo\Enums\Result;
use JeroenED\Libpairtwo\Enums\TournamentSystem;
use JeroenED\Libpairtwo\Exceptions\IncompatibleReaderException;
use JeroenED\Libpairtwo\Tournament;
use JeroenED\Libpairtwo\Interfaces\ReaderInterface;
use JeroenED\Libpairtwo\Pairing;
use JeroenED\Libpairtwo\Player;
use JeroenED\Libpairtwo\Round;
use JeroenED\Libpairtwo\Pairing;
use JeroenED\Libpairtwo\Interfaces\ReaderInterface;
use JeroenED\Libpairtwo\Enums\TournamentSystem;
use JeroenED\Libpairtwo\Tournament;
use DateTime;
/**

12
src/Readers/Swar4.php
View File

@ -1,6 +1,6 @@
<?php
/**
* Reader Pairtwo6
* Reader Swar4
*
* Reads out Swar-4 files
*
@ -13,9 +13,11 @@
namespace JeroenED\Libpairtwo\Readers;
use DateTime;
use JeroenED\Libpairtwo\Enums\Color;
use JeroenED\Libpairtwo\Enums\Gender;
use JeroenED\Libpairtwo\Enums\Result;
use JeroenED\Libpairtwo\Enums\Tiebreak;
use JeroenED\Libpairtwo\Enums\Title;
use JeroenED\Libpairtwo\Enums\TournamentSystem;
use JeroenED\Libpairtwo\Exceptions\IncompatibleReaderException;
use JeroenED\Libpairtwo\Interfaces\ReaderInterface;
@ -23,9 +25,7 @@ use JeroenED\Libpairtwo\Pairing;
use JeroenED\Libpairtwo\Player;
use JeroenED\Libpairtwo\Round;
use JeroenED\Libpairtwo\Tournament;
use JeroenED\Libpairtwo\Enums\Gender;
use JeroenED\Libpairtwo\Enums\Title;
use JeroenED\Libpairtwo\Enums\Result;
use DateTime;
/**
* Class Swar4
@ -613,7 +613,7 @@ class Swar4 implements ReaderInterface
* @param string $string
* @return DateTime
*/
public function convertStringToDate(string $string): \DateTime
public function convertStringToDate(string $string): DateTime
{
if (strlen($string) == 10) {
return DateTime::createFromFormat('d/m/Y', $string);

2
src/Round.php
View File

@ -14,8 +14,6 @@ namespace JeroenED\Libpairtwo;
use DateTime;
use JeroenED\Libpairtwo\Enums\Result;
use JeroenED\Libpairtwo\Game;
use JeroenED\Libpairtwo\Pairing;
/**
* Class Round

6
src/Tournament.php
View File

@ -12,11 +12,11 @@
namespace JeroenED\Libpairtwo;
use JeroenED\Libpairtwo\Enums\Color;
use JeroenED\Libpairtwo\Enums\Tiebreak;
use JeroenED\Libpairtwo\Enums\TournamentSystem;
use Closure;
use DateTime;
use JeroenED\Libpairtwo\Enums\Tiebreak;
use JeroenED\Libpairtwo\Enums\Color;
use JeroenED\Libpairtwo\Enums\TournamentSystem;
/**
* Class Tournament