commit 15e2b094b90a129cda4a993bb934cca67c07f956 Author: Jeroen De Meerleer Date: Thu Jan 12 18:54:47 2023 +0100 Initial Commit This commit: - Creates the repository - Forks libpairtwo - Removes the unrelated files - Moves the namespaces to a new namespace - Uses native 8.1 enums instead of a thirdparty-library diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..79773d2 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,19 @@ +# editorconfig.org +root = true + +[*] +indent_style = space +indent_size = 4 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + +[*.md] +trim_trailing_whitespace = false + +[Makefile] +indent_style = tab + +[.travis.yml] +indent_size = 2 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..491f666 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/vendor/ +.idea/ diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..0531e17 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,62 @@ +# CHANGELOG + +## v2.0 (Release: aa-bbb-cccc) +* NEW FEATURE: `Game::Board` for getting the board number of the game +* MAJOR CHANGE: Getter and setter methods have been removed. (Please see [0d8a325](https://github.com/JeroenED/libpairtwo/commit/0d8a325eb501b775830f68fa6f600f9f4ca5588c) for more info) +* MAJOR CHANGE: Changed license to AGPL-3.0 +* CHANGE: Some fields has been renamed to match coding guideline (Please see [1ab96fa](https://github.com/JeroenED/libpairtwo/commit/1ab96fa04782c1b0f2b6bb9d1bac8397a74ab38e) for more info) +* CHANGE: Logo has been redesigned +* CHANGE: Phpdoc is used again for docs generation +* CHANGE: `Tiebreak::American` and all its uses were removed (Please see [a6015ae](https://github.com/JeroenED/libpairtwo/commit/a6015ae8169f0973f4937605d0f807aacc233630) for more info) +* CHANGE: `Tournament::calculateSonneborn()` did not use a virtual opponent for bye results +* BUGFIX: `Tournament::calculateMutualResult()` returned a value even it not all players did not play each other + +## v1.2 (Release: 28-sep-2019) +* NEW READER: `Readers\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 +* ENHANCEMENT: The template in distributions is renamed to template.php +* CHANGE: `Tournament::getArbiter()` accepts a `int` parameter representing the order of the arbiters +* BUGFIX: `Player:getId()` returned elo instead of id +* BUGFIX: `Tournament::calculateBuchholz()` did not return the correct score when player had unplayed rounds +* BUGFIX: `Tournament::calculateMutualResult()` returned NULL if result was invalid +* BUGFIX: `Tournament::calculateBaumbach()` treated bye as won +* BUGFIX: `Tournament::calculateAverageRating()` returned NaN if no games were played +* BUGFIX: Distributions could be created from a branch other than master + +## v1.1.2 (Release: 21-jun-2019) +* ENHANCEMENT: Added update section to dist/readme.md +* MAJOR BUGFIX: `Game::GetResult` threw fatal error `Cannot access parent:: when current class scope has no parent` + +## v1.1.1 (Released: 20-jun-2019) +* NEW FEATURE: Added clean-dist and clean-dev targets +* ENHANCEMENT: Better Docs generation +* ENHANCEMENT: Resized logo in Doxygen for better fit +* ENHANCEMENT: Doxygen takes branch name or version tag as `PROJECT_NUMBER` +* CHANGE: Version tag directly put in distribution filename +* CHANGE: `Tournament::GameExists()` renamed to `Tournament::gameExists()` +* CHANGE: Updated composer metadata +* CHANGE: Some setters changed to fluent setters. (More info: [7aca350](https://github.com/JeroenED/libpairtwo/commit/7aca35057c10d2b982f93a698499c0c01df2fdc5)) +* CHANGE: Kashdan and Soccer Kashdan are combined in 1 function +* BUGFIX: Tagging did not work + +## v1.1 (Released: 20-jun-2019) +* NEW FEATURE: Libpairtwo distribution releases (use these if you don't have knowledge of composer or dependency management) +* NEW FEATURE: Soccer Kashdan (aka: kashdan using 3-1-0 scoring) +* MAJOR CHANGE: Model Classes has been removed +* CHANGE: Deprecated `sws::class` was removed +* CHANGE: Added a logo to the project +* CHANGE: Replaced PhpDoc with Doxygen +* BUGFIX: `Tournament::getParticipants()` did not return a correct value + +## v1.0.2 (Released: 05-jun-2019) +* NEW FEATURE: `Player::getPlayedGames()` to return the number of played games +* BUGFIX: `Tournament::calculateBuchholz()` always returned 0 +* BUGFIX: `Tournament::calculateMutualResult()` only took account of last tiebreak instead all previous + +## v1.0.1 (Released: 04-jun-2019) +* BUGFIX: `Round::getBye()` did not return bye players + +## v1.0 (Released: 03-jun-2019) +* Initial release diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..4ef32f0 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,651 @@ +GNU Affero General Public License +================================= + +_Version 3, 19 November 2007_ +_Copyright © 2007 Free Software Foundation, Inc. <>_ + +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. + +## Preamble + +The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +Developers that use our General Public Licenses protect your rights +with two steps: **(1)** assert copyright on the software, and **(2)** offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + +A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + +The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + +An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + +The precise terms and conditions for copying, distribution and +modification follow. + +## TERMS AND CONDITIONS + +### 0. Definitions + +“This License” refers to version 3 of the GNU Affero General Public License. + +“Copyright” also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + +“The Program” refers to any copyrightable work licensed under this +License. Each licensee is addressed as “you”. “Licensees” and +“recipients” may be individuals or organizations. + +To “modify” a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a “modified version” of the +earlier work or a work “based on” the earlier work. + +A “covered work” means either the unmodified Program or a work based +on the Program. + +To “propagate” a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To “convey” a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + +An interactive user interface displays “Appropriate Legal Notices” +to the extent that it includes a convenient and prominently visible +feature that **(1)** displays an appropriate copyright notice, and **(2)** +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +### 1. Source Code + +The “source code” for a work means the preferred form of the work +for making modifications to it. “Object code” means any non-source +form of a work. + +A “Standard Interface” means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The “System Libraries” of an executable work include anything, other +than the work as a whole, that **(a)** is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and **(b)** serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +“Major Component”, in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The “Corresponding Source” for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + +The Corresponding Source for a work in source code form is that +same work. + +### 2. Basic Permissions + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + +### 3. Protecting Users' Legal Rights From Anti-Circumvention Law + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + +### 4. Conveying Verbatim Copies + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +### 5. Conveying Modified Source Versions + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + +* **a)** The work must carry prominent notices stating that you modified +it, and giving a relevant date. +* **b)** The work must carry prominent notices stating that it is +released under this License and any conditions added under section 7. +This requirement modifies the requirement in section 4 to +“keep intact all notices”. +* **c)** You must license the entire work, as a whole, under this +License to anyone who comes into possession of a copy. This +License will therefore apply, along with any applicable section 7 +additional terms, to the whole of the work, and all its parts, +regardless of how they are packaged. This License gives no +permission to license the work in any other way, but it does not +invalidate such permission if you have separately received it. +* **d)** If the work has interactive user interfaces, each must display +Appropriate Legal Notices; however, if the Program has interactive +interfaces that do not display Appropriate Legal Notices, your +work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +“aggregate” if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +### 6. Conveying Non-Source Forms + +You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + +* **a)** Convey the object code in, or embodied in, a physical product +(including a physical distribution medium), accompanied by the +Corresponding Source fixed on a durable physical medium +customarily used for software interchange. +* **b)** Convey the object code in, or embodied in, a physical product +(including a physical distribution medium), accompanied by a +written offer, valid for at least three years and valid for as +long as you offer spare parts or customer support for that product +model, to give anyone who possesses the object code either **(1)** a +copy of the Corresponding Source for all the software in the +product that is covered by this License, on a durable physical +medium customarily used for software interchange, for a price no +more than your reasonable cost of physically performing this +conveying of source, or **(2)** access to copy the +Corresponding Source from a network server at no charge. +* **c)** Convey individual copies of the object code with a copy of the +written offer to provide the Corresponding Source. This +alternative is allowed only occasionally and noncommercially, and +only if you received the object code with such an offer, in accord +with subsection 6b. +* **d)** Convey the object code by offering access from a designated +place (gratis or for a charge), and offer equivalent access to the +Corresponding Source in the same way through the same place at no +further charge. You need not require recipients to copy the +Corresponding Source along with the object code. If the place to +copy the object code is a network server, the Corresponding Source +may be on a different server (operated by you or a third party) +that supports equivalent copying facilities, provided you maintain +clear directions next to the object code saying where to find the +Corresponding Source. Regardless of what server hosts the +Corresponding Source, you remain obligated to ensure that it is +available for as long as needed to satisfy these requirements. +* **e)** Convey the object code using peer-to-peer transmission, provided +you inform other peers where the object code and Corresponding +Source of the work are being offered to the general public at no +charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A “User Product” is either **(1)** a “consumer product”, which means any +tangible personal property which is normally used for personal, family, +or household purposes, or **(2)** anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, “normally used” refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + +“Installation Information” for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +### 7. Additional Terms + +“Additional permissions” are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + +* **a)** Disclaiming warranty or limiting liability differently from the +terms of sections 15 and 16 of this License; or +* **b)** Requiring preservation of specified reasonable legal notices or +author attributions in that material or in the Appropriate Legal +Notices displayed by works containing it; or +* **c)** Prohibiting misrepresentation of the origin of that material, or +requiring that modified versions of such material be marked in +reasonable ways as different from the original version; or +* **d)** Limiting the use for publicity purposes of names of licensors or +authors of the material; or +* **e)** Declining to grant rights under trademark law for use of some +trade names, trademarks, or service marks; or +* **f)** Requiring indemnification of licensors and authors of that +material by anyone who conveys the material (or modified versions of +it) with contractual assumptions of liability to the recipient, for +any liability that these contractual assumptions directly impose on +those licensors and authors. + +All other non-permissive additional terms are considered “further +restrictions” within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + +### 8. Termination + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated **(a)** +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and **(b)** permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +### 9. Acceptance Not Required for Having Copies + +You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +### 10. Automatic Licensing of Downstream Recipients + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An “entity transaction” is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +### 11. Patents + +A “contributor” is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's “contributor version”. + +A contributor's “essential patent claims” are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, “control” includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a “patent license” is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To “grant” such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either **(1)** cause the Corresponding Source to be so +available, or **(2)** arrange to deprive yourself of the benefit of the +patent license for this particular work, or **(3)** arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. “Knowingly relying” means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is “discriminatory” if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license **(a)** in connection with copies of the covered work +conveyed by you (or copies made from those copies), or **(b)** primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +### 12. No Surrender of Others' Freedom + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + +### 13. Remote Network Interaction; Use with the GNU General Public License + +Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + +### 14. Revised Versions of this License + +The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License “or any later version” applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + +If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +### 15. Disclaimer of Warranty + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +### 16. Limitation of Liability + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + +### 17. Interpretation of Sections 15 and 16 + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +_END OF TERMS AND CONDITIONS_ + +## How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the “copyright” line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + +If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a “Source” link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + +You should also get your employer (if you work as a programmer) or school, +if any, to sign a “copyright disclaimer” for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +<>. diff --git a/README.md b/README.md new file mode 100644 index 0000000..c38ef13 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# Blackbird Chess (Results service) +## Part of Blackbird Chess +Copyright (C) 2018-2022 Jeroen De Meerleer +Copyright (C) 2023- Blackbird Chess Contributors + +*Forked from [Libpairtwo](https://www.github.com/JeroenED/libpairtwo)* + +This service provides the necessary code to get results from tournaments + +## Licence + +``` +Copyright (C) 2018- Jeroen De Meerleer +Copyright (C) 2023- Blackbird Chess Contributors + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU Affero General Public License as +published by the Free Software Foundation, either version 3 of the +License, or (at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU Affero General Public License for more details. + +You should have received a copy of the GNU Affero General Public License +along with this program. If not, see . +``` diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..bafd140 --- /dev/null +++ b/composer.json @@ -0,0 +1,36 @@ +{ + "name": "blakcbirdchess/blackbirdchess-service-results", + "type": "library", + "description": "Service to calculate results for blackbird chess", + "keywords": [ + "chess", + "pairing", + "blackbirdchess" + ], + "license": "AGPL-3.0-or-later", + "authors": [ + { + "name": "Jeroen De Meerleer", + "email": "schaak@jeroened.be", + "homepage": "https://www.jeroened.be", + "role": "Developer" + } + ], + "require": { + "php": "^8.1", + "ext-iconv": "*" + }, + "require-dev": { + }, + "autoload": { + "psr-4": { + "Blackbirdchess\\Service\\Results\\": "src/" + } + }, + "config": { + "platform": { + "php": "7.1" + }, + "sort-packages": true + } +} diff --git a/src/.gitkeep b/src/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/src/Constants.php b/src/Constants.php new file mode 100644 index 0000000..019e26d --- /dev/null +++ b/src/Constants.php @@ -0,0 +1,55 @@ + + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + */ + +namespace Blackbirdchess\Service\Results; + +use Blackbirdchess\Service\Results\Enums\Color; +use Blackbirdchess\Service\Results\Enums\Result; + +/** + * Class Constants + * + * Static class for constants + * + * @author Jeroen De Meerleer + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + */ +class Constants +{ + public const BLACK = [Color::BLACK]; + + public const DRAW = [Result::DRAW, Result::DRAW_ADJOURNED]; + + public const LOST = [Result::ABSENT, Result::BYE, Result::LOST, Result::ADJOURNED]; + + public const NOTPLAYED = [Result::BYE, Result::WON_BYE, Result::ABSENT]; + + public const PLAYED = [ + Result::WON, + Result::WON_FORFAIT, + Result::WON_BYE, + Result::WON_ADJOURNED, + Result::DRAW, + Result::DRAW_ADJOURNED, + Result::ABSENT, + Result::BYE, + Result::LOST, + Result::ADJOURNED + ]; + + public const WHITE = [Color::WHITE]; + + public const WON = [Result::WON, Result::WON_FORFAIT, Result::WON_BYE, Result::WON_ADJOURNED]; +} diff --git a/src/Enums/Color.php b/src/Enums/Color.php new file mode 100644 index 0000000..7864142 --- /dev/null +++ b/src/Enums/Color.php @@ -0,0 +1,22 @@ + + * @category Main + * @package Blackbird Chess + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + * @copyright Copyright (c) 2023- Blackbird Chess + */ +Enum Color: string +{ + case BLACK = 'B'; + case NONE = '*'; + case WHITE = 'W'; + +} diff --git a/src/Enums/Gameresult.php b/src/Enums/Gameresult.php new file mode 100644 index 0000000..dbed719 --- /dev/null +++ b/src/Enums/Gameresult.php @@ -0,0 +1,31 @@ + + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + * @copyright Copyright (c) 2023- Blackbird Chess + */ +Enum Gameresult: string +{ + case BLACK_WINS = '0-1'; + case BLACK_WINS_FORFAIT = '0-1 FF'; + case BOTH_LOSE_FORFAIT = '0-0 FF'; + case BOTH_WIN_ADJOURNED = '1-1 A'; + case DRAW = '0.5-0.5'; + case DRAW_ADJOURNED = '0.5-0.5 A'; + case NONE = '-'; + case WHITE_DRAWS_BLACK_LOSE_ADJOURNED = '0.5-0'; + case WHITE_DRAWS_BLACK_WINS_ADJOURNED = '0.5-1 A'; + case WHITE_LOST_BLACK_DRAWS_ADJOURNED = '0-0.5'; + case WHITE_WINS = '1-0'; + case WHITE_WINS_BLACK_DRAWS_ADJOURNED = '1-0.5 A'; + case WHITE_WINS_FORFAIT = '1-0 FF'; +} diff --git a/src/Enums/Gender.php b/src/Enums/Gender.php new file mode 100644 index 0000000..92d2daf --- /dev/null +++ b/src/Enums/Gender.php @@ -0,0 +1,21 @@ + + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + * @copyright Copyright (c) 2023- Blackbird Chess + */ +Enum Gender: string +{ + case FEMALE = 'F'; + case MALE = 'M'; + case NEUTRAL = 'X'; +} diff --git a/src/Enums/Result.php b/src/Enums/Result.php new file mode 100644 index 0000000..990a392 --- /dev/null +++ b/src/Enums/Result.php @@ -0,0 +1,39 @@ + + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + * @copyright Copyright (c) 2023- Blackbird Chess + */ +Enum Result: string +{ + case ABSENT = '0 FF'; + + case ADJOURNED = '0 A'; + + case BYE = '0 Bye'; + + case DRAW = '0.5'; + + case DRAW_ADJOURNED = '0.5 A'; + + case LOST = '0'; + + case NONE = '*'; + + case WON = '1'; + + case WON_ADJOURNED = '1 A'; + + case WON_BYE = '1 Bye'; + + case WON_FORFAIT = '1 FF'; +} diff --git a/src/Enums/Tiebreak.php b/src/Enums/Tiebreak.php new file mode 100644 index 0000000..25b6f53 --- /dev/null +++ b/src/Enums/Tiebreak.php @@ -0,0 +1,41 @@ + + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + * @copyright Copyright (c) 2023- Blackbird Chess + */ +Enum Tiebreak: string +{ + case ARO = "Average Rating"; + case AROCUT = "Average Rating Cut"; + case AVERAGE_PERFORMANCE = "Average performance"; + case BAUMBACH = "Most wins"; + case BETWEEN = "Mutual Result"; + case BLACK_PLAYED = "Black played"; + case BLACK_WIN = "Black Winned"; + case BUCHHOLZ = "Buchholz"; + case BUCHHOLZ_CUT = "Buchholz Cut"; + case BUCHHOLZ_CUT_2 = "Buchholz Cut 2"; + case BUCHHOLZ_MED = "Buchholz Median"; + case BUCHHOLZ_MED_2 = "Buchholz Median 2"; + case CUMULATIVE = "Cumulative"; + case DRAWING_OF_LOT = "Drawing of lot"; + case KASHDAN = "Kashdan"; + case KEIZER = "Keizer"; + case KOYA = "Koya"; + case NONE = ""; + case PERFORMANCE = "Performance"; + case POINTS = "Points"; + case SOCCER_KASHDAN = "Soccer Kashdan"; + case SONNEBORN = "Sonneborn-Berger"; + case TESTMATCH = "Testmatch"; +} diff --git a/src/Enums/Title.php b/src/Enums/Title.php new file mode 100644 index 0000000..9e67ea7 --- /dev/null +++ b/src/Enums/Title.php @@ -0,0 +1,30 @@ + + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + */ +Enum Title: string +{ + case CM = 'Candidate Master'; + case ELO = 'Elo'; + case FM = 'Fide Master'; + case GM = 'Grand Master'; + case HG = 'Honorary Grand Master'; + case HM = 'Honorary International Master'; + case IM = 'International Master'; + case NM = 'National Master'; + case NONE = '*'; + case WCM = 'Woman Candidate Master'; + case WFM = 'Woman Fide Master'; + case WGM = 'Woman Grand Master'; + case WIM = 'Woman International Master'; +} diff --git a/src/Enums/TournamentSystem.php b/src/Enums/TournamentSystem.php new file mode 100644 index 0000000..aa138e3 --- /dev/null +++ b/src/Enums/TournamentSystem.php @@ -0,0 +1,21 @@ + + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + */ +Enum TournamentSystem +{ + case AMERICAN; + case CLOSED; + case KEIZER; + case SWISS; +} diff --git a/src/Exceptions/LibpairtwoException.php b/src/Exceptions/LibpairtwoException.php new file mode 100644 index 0000000..077bf08 --- /dev/null +++ b/src/Exceptions/LibpairtwoException.php @@ -0,0 +1,30 @@ + + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + */ + +namespace Blackbirdchess\Service\Results\Exceptions; + +use Exception; + +/** + * Exception LibpairtwoException + * + * General exception when something goes wrong with libpairtwo + * + * @author Jeroen De Meerleer + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + */ +class LibpairtwoException extends Exception +{ +} diff --git a/src/Game.php b/src/Game.php new file mode 100644 index 0000000..de0ab91 --- /dev/null +++ b/src/Game.php @@ -0,0 +1,126 @@ + + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + */ + +namespace Blackbirdchess\Service\Results; + +use Blackbirdchess\Service\Results\Enums\Gameresult; + +/** + * Class Games + * + * Class for a game of the tournament + * + * @author Jeroen De Meerleer + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + */ +class Game +{ + /** + * The pairing for this games as seen from black's side + * + * @var Pairing | null + */ + public $Black; + + /** + * The board where this game is held + * + * @var int + */ + public $Board; + + /** + * The calculated game result + * + * @var GameResult | null + */ + private $CalculatedResult; + + /** + * The pairing for this games as seen from white's side + * + * @var Pairing | null + */ + public $White; + + /** + * Returns fields that were not directly assigned. + * Class Game contains the special field Result containing the result of the game + * + * @param string $key + * + * @return Gameresult + */ + public function __get(string $key) + { + if ($key == 'Result') { + return $this->calculateResult(); + } + + return null; + } + + /** + * Returns the result for the game. + * This method needs to be called from $Game->Result + * + * @return Gameresult + */ + private function calculateResult(): Gameresult + { + if (!is_null($this->CalculatedResult)) { + return $this->CalculatedResult; + } + + $whiteResult = $this->White->Result; + $blackResult = $this->Black->Result; + + $whitesplit = explode(" ", $whiteResult); + $blacksplit = explode(" ", $blackResult); + + $special = ''; + if (isset($whitesplit[ 1 ]) && $whitesplit[ 1 ] != 'Bye') { + $special = ' ' . $whitesplit[ 1 ]; + } + if (isset($blacksplit[ 1 ]) && $blacksplit[ 1 ] != 'Bye') { + $special = ' ' . $blacksplit[ 1 ]; + } + if ($whitesplit[ 0 ] == '*') { + $whitesplit[ 0 ] = ''; + } + if ($blacksplit[ 0 ] == '*') { + $blacksplit[ 0 ] = ''; + } + $result = Gameresult::from($whitesplit[ 0 ] . '-' . $blacksplit[ 0 ] . $special); + $this->CalculatedResult = $result; + + return $result; + } + + /** + * Checks if 2 games are equal + * + * @param Game $game + * + * @return bool + */ + public function equals(Game $game): bool + { + return ( + $this->White->Player === $game->White->Player && + $this->Black->Player === $game->Black->Player && + $this->Result->getKey() == $game->Result->getKey()); + } +} diff --git a/src/Pairing.php b/src/Pairing.php new file mode 100644 index 0000000..546f0c8 --- /dev/null +++ b/src/Pairing.php @@ -0,0 +1,73 @@ + + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + */ + +namespace Blackbirdchess\Service\Results; + +use Blackbirdchess\Service\Results\Enums\Color; +use Blackbirdchess\Service\Results\Enums\Result; + +/** + * Class Pairing + * + * Class for a pairing of the tournament + * + * @author Jeroen De Meerleer + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + */ +class Pairing +{ + /** + * The number of the board where the game was held + * + * @var int + */ + public $Board; + + /** + * The color of the player. + * Possible values are Black and White + * + * @var Color + */ + public $Color; + + /** + * The opponent of player + * + * @var Player | null + */ + public $Opponent; + + /** + * The player of the pairing. Please note this means the pairing was seen from the point of view of this player + * + * @var Player | null + */ + public $Player; + + /** + * The result of the Game. Possible values contain Won, Lost, Draw, Forfait, Bye, etc. + * + * @var Result + */ + public $Result; + + /** + * The round of the game + * + * @var int + */ + public $Round; +} diff --git a/src/Player.php b/src/Player.php new file mode 100644 index 0000000..a384a4a --- /dev/null +++ b/src/Player.php @@ -0,0 +1,424 @@ + + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + */ + +namespace Blackbirdchess\Service\Results; + +use DateTime; +use Blackbirdchess\Service\Results\Enums\Gender; +use Blackbirdchess\Service\Results\Enums\Result; +use Blackbirdchess\Service\Results\Enums\Title; + +/** + * Class Player + * + * Class for a player of the tournament + * + * @author Jeroen De Meerleer + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + */ +class Player +{ + /** + * Binary data that was read out of the pairing file + * + * @var bool|DateTime|int|string[] + */ + + private $BinaryData; + + /** + * The category the player belongs to + * + * @var string + */ + public $Category; + + /** + * Birthday of the player + * + * @var DateTime + */ + public $DateOfBirth; + + /** + * The Elos for the player. Possible keys are, but not limited to nation and fide + * + * @var int[] + */ + public $Elos; + + /** + * The gender of the player. Possible values contain Male, Female and Neutral + * + * @var Gender + */ + public $Gender; + + /** + * The player ids for the player. Possible keys are, but not limited to nation and fide + * + * @var int[] + */ + public $Ids; + + // TODO: Implement categories + + /** + * Name of the player + * + * @var string + */ + public $Name; + + /** + * The nation the player belongs to. Be noted this does not actually mean this is his main nationality. A player + * can be signed USCF but may be Italian + * + * @var string + */ + public $Nation; + + /** + * The pairings of the player + * + * @var Pairing[] + */ + public $Pairings = []; + + /** + * Tiebreak points of the player. These values are calculated when Tournament->Ranking is called + * + * @var float[] + */ + public $Tiebreaks = []; + + /** + * The title of the player. Possible values can be GM, IM, IA, etc. + * + * @var Title + */ + public $Title; + + /** + * Returns the performance rating of the player + * + * WARNING: Calculation currently incorrect. Uses the rule of 400 as temporary solution + * + * @param $type + * @param $unratedElo + * + * @return float + */ + public function Performance(string $type, int $unratedElo): float + { + $total = 0; + $opponents = 0; + foreach ($this->Pairings as $pairing) { + if (array_search($pairing->Result, Constants::NOTPLAYED) === false) { + $opponentElo = $pairing->Opponent->getElo($type); + $opponentElo = $opponentElo != 0 ? $opponentElo : $unratedElo; + if (array_search($pairing->Result, Constants::WON) !== false) { + $total += $opponentElo + 400; + } elseif (array_search($pairing->Result, Constants::LOST) !== false) { + $total += $opponentElo - 400; + } elseif (array_search($pairing->Result, Constants::DRAW) !== false) { + $total += $opponentElo; + } + $opponents++; + } + } + + return round($total / $opponents); + } + + /** + * Returns an array of Player objects where name matches $search + * + * @param string $search + * @param Tournament $tournament + * + * @return Player[] + */ + public static function PlayersByName(string $search, Tournament $tournament): array + { + /** + * @var Player[] + */ + $players = $tournament->Players; + + /** + * @var Player[] + */ + $return = []; + + foreach ($players as $player) { + if (fnmatch($search, $player->Name)) { + $return[] = $player; + } + } + + return $return; + } + + /** + * Magic method to read out several fields. If field was not found it is being searched in the binary data fields + * + * @param string $key + * + * @return bool|DateTime|int|string|null + */ + public function __get(string $key) + { + if ($key == 'PlayedGames') { + return $this->playedGames(); + } elseif ($key == 'NoOfWins') { + return $this->noOfWins(); + } elseif ($key == 'Opponents') { + return $this->opponents(); + } elseif (isset($this->BinaryData[ $key ])) { + return $this->BinaryData[ $key ]; + } + + return null; + } + + /** + * Sets binary data that is read out the pairing file but is not needed immediately + * + * @param string $key + * @param bool|int|DateTime|string $value + */ + public function __set(string $key, $value): void + { + $this->BinaryData[ $key ] = $value; + } + + /** + * Adds a pairing to the tournament + * + * @param Pairing $pairing + */ + public function addPairing(Pairing $pairing): void + { + $newArray = $this->Pairings; + $newArray[] = $pairing; + $this->Pairings = $newArray; + } + + /** + * Returns the points of the player after round $round + * + * 1 Point is awarded for winning + * 0.5 points are awarded for draw + * 0 points are awarded for loss + * + * @param int $round + * + * @return float + */ + public function calculatePoints(int $round = -1, array $custompoints = []): float + { + $points = 0; + foreach ($this->Pairings as $key => $pairing) { + if ($key < $round || $round == -1) { + if ($pairing->Result == Result::WON_BYE) { + $points += (isset($custompoints[ 'bye' ])) ? $custompoints[ 'bye' ] : 1; + } else if ($pairing->Result == Result::ABSENT) { + $points += (isset($custompoints[ 'absent' ])) ? $custompoints[ 'absent' ] : 0; + } elseif (array_search($pairing->Result, Constants::WON) !== false) { + $points += (isset($custompoints[ 'win' ])) ? $custompoints[ 'win' ] : 1; + } elseif (array_search($pairing->Result, Constants::DRAW) !== false) { + $points += (isset($custompoints[ 'draw' ])) ? $custompoints[ 'draw' ] : 0.5; + } elseif (array_search($pairing->Result, Constants::LOST) !== false) { + $points += (isset($custompoints[ 'loss' ])) ? $custompoints[ 'loss' ] : 0; + } + } + } + + return $points; + } + + /** + * Returns the points of the player that should be used for tiebreaking systems. + * + * 1 Point is awarded for winning + * 0.5 points are awarded for draw + * 0.5 points for not played + * + * @return float + */ + public function calculatePointsForTiebreaks(): float + { + $points = 0; + foreach ($this->Pairings as $pairing) { + if (array_search($pairing->Result, Constants::NOTPLAYED) !== false) { + $points = $points + 0.5; + } elseif (array_search($pairing->Result, Constants::WON) !== false) { + $points = $points + 1; + } elseif (array_search($pairing->Result, Constants::DRAW) !== false) { + $points = $points + 0.5; + } + } + + return $points; + } + + /** + * Returns the points of a virtual player as described in the Fide Handbook C.02 chapter 13.15.2. + * + * Return the same score for all rounds until $byeround and added with a half point for each subsequent round + * + * @param int $byeround + * + * @return float + */ + public function calculatePointsForVirtualPlayer(int $byeround): float + { + $points = $this->calculatePoints($byeround); + foreach (array_slice($this->Pairings, $byeround + 1) as $key => $pairing) { + $points += 0.5; + } + + return $points; + } + + /** + * Returns the elo of elotype for the player + * + * @param string $type + * + * @return int + */ + public function getElo(string $type): ?int + { + return isset($this->Elos[ $type ]) ? $this->Elos[ $type ] : null; + } + + /** + * Returns the identifier of type for the player + * + * Common possible values are Fide or National + * + * @param string $type + * + * @return string + */ + public function getId(string $type): string + { + return $this->Ids[ $type ]; + } + + /** + * Returns if player has played against all players of the array + * + * @param Player[] $players + * + * @return bool + */ + public function hasPlayedAllPlayersOfArray(array $players): bool + { + $ownkey = array_search($this, $players); + if ($ownkey !== false) { + unset($players[ $ownkey ]); + } + $total = 0; + foreach ($players as $player) { + if (array_search($player, $this->Opponents) !== false) { + $total++; + } + } + + return $total == count($players); + } + + /** + * Returns the number of won matches for the player + * + * @return int + */ + private function noOfWins(): int + { + $wins = 0; + foreach ($this->Pairings as $pairing) { + if (array_search($pairing->Result, Constants::WON) !== false) { + $wins++; + } + } + + return $wins; + } + + /** + * Returns all opponents of $this + * + * @return Player[] + */ + private function opponents() + { + $return = []; + foreach ($this->Pairings as $pairing) { + if (!empty($pairing->Opponent)) { + $return[] = $pairing->Opponent; + } + } + + return $return; + } + + /** + * Returns the number of played games of the player + * + * @return int + */ + private function playedGames(): int + { + $total = 0; + foreach ($this->Pairings as $pairing) { + if (array_search($pairing->Result, Constants::PLAYED) !== false) { + $total++; + } + } + + return $total; + } + + /** + * Sets the elo of elotype for the player + * + * @param string $type + * @param int $value + */ + public function setElo(string $type, int $value): void + { + $currentElos = $this->Elos; + $currentElos[ $type ] = $value; + $this->Elos = $currentElos; + } + + /** + * Sets the identifier of type for the player + * + * Common possible values are Fide or National + * + * @param string $type + * @param string $value + */ + public function setId(string $type, string $value): void + { + $currentIds = $this->Ids; + $currentIds[ $type ] = $value; + $this->Ids = $currentIds; + } +} diff --git a/src/Round.php b/src/Round.php new file mode 100644 index 0000000..982c047 --- /dev/null +++ b/src/Round.php @@ -0,0 +1,170 @@ + + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + */ + +namespace Blackbirdchess\Service\Results; + +use DateTime; +use Blackbirdchess\Service\Results\Enums\Result; + +/** + * Class Round + * + * Class for a round of the tournament + * + * @author Jeroen De Meerleer + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + */ +class Round +{ + /** + * Date of the round + * + * @var DateTime + */ + public $Date; + + /** + * Array of all games + * + * @var Game[] + */ + public $Games = []; + + /** + * Array of all pairings for this round + * + * @var Pairing[] + */ + public $Pairings = []; + + /** + * Number of the round + * + * @var int + */ + public $RoundNo; + + /** + * Magic method to read out several fields. If field was not found it is being searched in the binary data fields + * + * @param string $key + * + * @return bool|DateTime|int|string|null + */ + public function __get(string $key) + { + if ($key == 'Bye') { + return $this->bye(); + } elseif ($key == 'Absent') { + return $this->absent(); + } elseif ($key == 'GamesByBoard') { + return $this->gamesByBoard(); + } elseif (isset($this->BinaryData[ $key ])) { + return $this->BinaryData[ $key ]; + } + + return null; + } + + /** + * Returns an array of pairings where the player is absent + * + * @return Pairing[] + */ + private function absent(): array + { + $allPairings = $this->Pairings; + $absentPairings = []; + foreach ($allPairings as $pairing) { + if ($pairing->Result == Result::ABSENT) { + $absentPairings[] = $pairing; + } + } + + return $absentPairings; + } + + /** + * Adds a game to the round + * + * @param Game $game + */ + public function addGame(Game $game): void + { + $newarray = $this->Games; + $newarray[] = $game; + $this->Games = $newarray; + } + + /** + * Adds a pairing to the round + * + * @param Pairing $pairing + */ + public function addPairing(Pairing $pairing): void + { + $newarray = $this->Pairings; + $newarray[] = $pairing; + $this->Pairings = $newarray; + } + + /** + * Returns an array of pairings where the player is bye + * + * @return Pairing[] + */ + private function bye(): array + { + $allPairings = $this->Pairings; + $byePairings = []; + foreach ($allPairings as $pairing) { + if ($pairing->Result == Result::WON_BYE) { + $byePairings[] = $pairing; + } + } + + return $byePairings; + } + + /** + * Retuns an array with the games of this round sorted by board + * + * @return Game[] + */ + private function gamesByBoard(): array + { + $allGames = $this->Games; + usort($allGames, [$this, 'sortByBoard']); + + return $allGames; + } + + /** + * Sort by board + * + * @param Game $a + * @param Game $b + * + * @return int + */ + private function sortByBoard(Game $a, Game $b): int + { + if (($a->Board == $b->Board) || ($a->Board === false) || ($b->Board === false)) { + return 0; + } + + return ($a->Board > $b->Board) ? +1 : -1; + } +} diff --git a/src/Tournament.php b/src/Tournament.php new file mode 100644 index 0000000..f45f96c --- /dev/null +++ b/src/Tournament.php @@ -0,0 +1,1011 @@ + + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + */ + +namespace Blackbirdchess\Service\Results; + +use Closure; +use DateTime; +use Blackbirdchess\Service\Results\Enums\Color; +use Blackbirdchess\Service\Results\Enums\Result; +use Blackbirdchess\Service\Results\Enums\Tiebreak; +use Blackbirdchess\Service\Results\Enums\TournamentSystem; + +/** + * Class Tournament + * + * Class for the tournament from the pairing file + * + * @author Jeroen De Meerleer + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + */ +class Tournament +{ + /** + * An Array of the assigned arbiters + * + * @var string[] + */ + public $Arbiters; + + /** + * Binary data that was read out of the pairing file + * + * @var bool|DateTime|int|string[] + */ + private $BinaryData = []; + + /** + * Round objects of all rounds in the tournament + * + * @var $Categories [] + */ + public $Categories = []; + + /** + * End date (Last round or Award Ceremony) of the tournament + * + * @var DateTime + */ + public $EndDate; + + /** + * The federation for which this tournament is held + * + * @var string + */ + public $Federation; + + /** + * Whether or not the tournament is an official tournament and send to the world chess organisation + * + * @var int + */ + public $FideHomol; + + /** + * The tempo for the first period of a game in the tournament + * + * @var string + */ + public $FirstPeriod; + + /** + * Name of the Tournament + * + * @var string + */ + public $Name; + + /** + * Number of round the tournament has + * + * @var int + */ + public $NoOfRounds; + + /** + * The elo a player gets if he does not have an official elo + * + * @var int + */ + public $NonRatedElo; + + /** + * Organiser of the tournament (eg. Donald J. Trump) + * + * @var string + */ + public $Organiser; + + /** + * Club name of the tournament organiser (eg. The White House Chess Club) + * + * @var string + */ + public $OrganiserClub; + + /** + * Club ID of the tournament organiser (eg. 205001600) + * + * @var string + */ + public $OrganiserClubNo; + + /** + * The country where the tournament is held + * + * @var string + */ + public $OrganiserCountry; + + /** + * Place where the Tounament is held (eg. The Oval Office) + * + * @var string + */ + public $OrganiserPlace; + + /** + * All pairings of the tournament + * + * @var Pairing[] + */ + public $Pairings = []; + + /** + * All players of the tournament + * + * @var Player[] + */ + public $Players = []; + + /** + * The elo that priority above all others + * + * @var string + */ + public $PriorityElo = 'Fide'; + + /** + * The Id that has priority above all other + * + * @var string + */ + public $PriorityId = 'Nation'; + + /** + * Round objects of all rounds in the tournament + * + * @var Round[] + */ + public $Rounds = []; + + /** + * The tempo for the second period of a game in the tournament + * + * @var string + */ + public $SecondPeriod; + + /** + * Start date (First round or Players meeting) of the tournament + * + * @var DateTime + */ + public $StartDate; + + /** + * The system the tournament (eg. Swiss, Closed, American) + * + * @var TournamentSystem + */ + public $System; + + /** + * The tempo of the tournament (eg. 90 min/40 moves + 30 sec. increment starting from move 1) + * + * @var string + */ + public $Tempo; + + /** + * The tiebreaks for the tournament + * + * @var Tiebreak[] + */ + public $Tiebreaks = []; + + /** + * Custom points for the tournament + * + * @var float[] + */ + public $CustomPoints = ['win' => 1, 'draw' => 0.5, 'loss' => 0, 'bye' => 1, 'absent' => 0]; + + /** + * The year or season the tournament is held or is count for + * + * @var int + */ + public $Year; + + /** + * Get the ranking for a specific category + * + * @param string $category + * + * @return array + */ + public function RankingForCategory(string $category): array + { + $globalRanking = $this->ranking(); + + $return = []; + foreach ($globalRanking as $player) { + if ($player->Category == $category) { + $return[] = $player; + } + } + + return $return; + } + + /** + * Magic method to read out several fields. If field was not found it is being searched in the binary data fields + * + * @param string $key + * + * @return bool|DateTime|int|string|null + */ + public function __get(string $key) + { + if ($key == 'Participants') { + return $this->participants(); + } elseif ($key == 'AverageElo') { + return $this->averageElo(); + } elseif ($key == 'Ranking') { + return $this->ranking(); + } elseif (isset($this->BinaryData[ $key ])) { + return $this->BinaryData[ $key ]; + } + + return null; + } + + /** + * Sets binary data that is read out the pairing file but is not needed immediately + * + * @param string $key + * @param bool|int|DateTime|string $value + * + * @return void + */ + public function __set(string $key, $value): void + { + $this->BinaryData[ $key ] = $value; + } + + /** + * Adds an arbiter to the tournament + * + * @param string $Arbiter + */ + public function addArbiter(string $Arbiter): void + { + $newArray = $this->Arbiters; + $newArray[] = $Arbiter; + $this->Arbiters = $newArray; + } + + /** + * Adds a category with given name object + * + * @param string $name + */ + public function addCategory(string $name): void + { + $newArray = $this->Categories; + $newArray[] = $name; + $this->Categories = $newArray; + } + + /** + * Adds a game to the tournament + * + * @param Game $game + * @param int $round + */ + public function addGame(Game $game, int $round): void + { + if (!isset($this->Rounds[ $round ])) { + $roundObj = new Round(); + $roundObj->RoundNo = $round; + $this->addRound($roundObj); + } + + $this->roundByNo($round)->addGame($game); + } + + /** + * Adds a pairing to the tournament + * + * @param Pairing $pairing + * + */ + public function addPairing(Pairing $pairing): void + { + $newArray = $this->Pairings; + $newArray[] = $pairing; + $this->Pairings = $newArray; + } + + /** + * Adds a player + * + * @param Player $Player + */ + public function addPlayer(Player $Player): void + { + $newArray = $this->Players; + $newArray[] = $Player; + $this->Players = $newArray; + } + + /** + * Adds a round with given Round object + * + * @param Round $round + */ + public function addRound(Round $round): void + { + $newArray = $this->Rounds; + $newArray[ $round->RoundNo ] = $round; + $this->Rounds = $newArray; + } + + /** + * Adds a Tiebreak + * + * @param Tiebreak $tiebreak + */ + public function addTiebreak(Tiebreak $tiebreak): void + { + $newArray = $this->Tiebreaks; + $newArray[] = $tiebreak; + $this->Tiebreaks = $newArray; + } + + /** + * Return the average rating for tournament + * + * @return int + */ + private function averageElo(): int + { + $totalrating = 0; + $players = 0; + foreach ($this->Players as $player) { + $toadd = $player->getElo($this->PriorityElo); + if ($toadd == 0) { + $toadd = $this->NonRatedElo; + } + + $totalrating += $toadd; + $players++; + } + + return intdiv($totalrating, $players); + } + + /** + * The average performance of the opponents + * + * @param Player $player + * @param string $type + * @param int $cut + * + * @return float + */ + private function calculateAveragePerformance(Player $player, string $type, int $cut = 0): float + { + $pairings = $player->Pairings; + $allratings = []; + foreach ($pairings as $pairing) { + if (array_search($pairing->Result, Constants::NOTPLAYED) === false) { + $toadd = $pairing->Opponent->Performance($type, $this->NonRatedElo); + if ($toadd != 0) { + $allratings[] = $toadd; + } + } + } + sort($allratings); + $allratings = array_slice($allratings, $cut); + + return round(array_sum($allratings) / count($allratings)); + } + + /** + * The average rating of the opponents + * + * @param Player $player + * @param string $type + * @param int $cut + * + * @return float + */ + private function calculateAverageRating(Player $player, string $type, int $cut = 0): float + { + $pairings = $player->Pairings; + $allratings = []; + foreach ($pairings as $pairing) { + if (array_search($pairing->Result, Constants::NOTPLAYED) === false) { + $toadd = $pairing->Opponent->getElo($type); + if ($toadd != 0) { + $allratings[] = $toadd; + } + } + } + sort($allratings); + $allratings = array_slice($allratings, $cut); + $tiebreak = 0; + if (count($allratings) > 0) { + $tiebreak = round(array_sum($allratings) / count($allratings)); + } + + return $tiebreak; + } + + /** + * Number of won games + * + * @param Player $player + * + * @return float + */ + private function calculateBaumbach(Player $player): float + { + $totalwins = 0; + foreach ($player->Pairings as $pairing) { + if (array_search($pairing->Result, Constants::NOTPLAYED) === false) { + if (array_search($pairing->Result, Constants::WON) !== false) { + $totalwins++; + } + } + } + + return $totalwins; + } + + /** + * Number of played games with black + * + * @param Player $player + * + * @return float + */ + private function calculateBlackPlayed(Player $player): float + { + $totalwins = 0; + foreach ($player->Pairings as $pairing) { + if (array_search($pairing->Color, Constants::BLACK) !== false) { + $totalwins++; + } + } + + return $totalwins; + } + + /** + * Number of won games with black + * + * @param Player $player + * + * @return float + */ + private function calculateBlackWin(Player $player): float + { + $totalwins = 0; + foreach ($player->Pairings as $pairing) { + if (array_search($pairing->Color, Constants::BLACK) !== false && + array_search($pairing->Result, Constants::WON) !== false) { + $totalwins++; + } + } + + return $totalwins; + } + + /** + * The combined points of the opponents + * + * @param Player $player + * @param int $cutlowest + * @param int $cuthighest + * + * @return float + */ + private function calculateBuchholz(Player $player, int $cutlowest = 0, int $cuthighest = 0): float + { + $tiebreak = 0; + $intpairingsWithBye = $player->Pairings; + + $intpairings = []; + $curpoints = 0; + $curround = 1; + foreach ($intpairingsWithBye as $key => $pairing) { + $roundstoplay = (count($intpairingsWithBye)) - $curround; + if (is_null($pairing->Opponent)) { + $intpairings[] = $player->calculatePointsForVirtualPlayer($key); + } else { + $intpairings[] = $pairing->Opponent->calculatePointsForTiebreaks(); + if (array_search($pairing->Result, Constants::WON) !== false) { + $curpoints += 1; + } elseif (array_search($pairing->Result, Constants::DRAW) !== false) { + $curpoints += 0.5; + } + } + $curround++; + } + + usort( + $intpairings, + function ($a, $b) { + if ($b == $a) { + return 0; + } + + return ($a > $b) ? 1 : -1; + } + ); + + $intpairings = array_slice($intpairings, $cutlowest); + $intpairings = array_slice($intpairings, 0 - $cuthighest); + + return array_sum($intpairings); + } + + /** + * Combined score of $player after each round + * + * @param Player $player + * + * @return float + */ + private function calculateCumulative(Player $player): float + { + $tiebreak = 0; + $score = []; + foreach ($player->Pairings as $pairing) { + $toadd = 0; + if (array_search($pairing->Result, Constants::WON) !== false) { + $toadd = 1; + } elseif (array_search($pairing->Result, Constants::DRAW) !== false) { + $toadd = 0.5; + } + $tiebreak += $toadd; + $score[] = $tiebreak; + } + + return array_sum($score); + } + + /** + * $points["Won"] points for each win, $points["Draw"] for each draw and $points["Lost"] point for losing. + * $points["NotPlayed"] points for not played games + * + * @param Player $player + * @param int[] $points + * + * @return float + */ + private function calculateKashdan(Player $player, array $points): float + { + $tiebreak = 0; + foreach ($player->Pairings as $pairing) { + $toadd = 0; + if (array_search($pairing->Result, Constants::WON) !== false) { + $toadd = $points[ "Won" ]; + } elseif (array_search($pairing->Result, Constants::DRAW) !== false) { + $toadd = $points[ "Draw" ]; + } elseif (array_search($pairing->Result, Constants::LOST) !== false) { + $toadd = $points[ "Lost" ]; + } + + if (array_search($pairing->Result, Constants::NOTPLAYED) !== false) { + $toadd = $points[ "NotPlayed" ]; + } + $tiebreak += $toadd; + } + + return $tiebreak; // - $player->NoOfWins; + } + + /** + * Points following keizer system + * + * @param Player $player + * + * @return float + */ + private function calculateKeizer(Player $player): float + { + return $player->ScoreAmerican; + } + + /** + * Points against players who have more than $cut % points + * + * @param Player $player + * @param int $cut + * + * @return float + */ + private function calculateKoya(Player $player, int $cut = 50): float + { + $tiebreak = 0; + foreach ($player->Pairings as $plkey => $plpairing) { + if (($plpairing->Opponent->calculatePoints() / count($plpairing->Opponent->Pairings) * 100) >= $cut) { + if (array_search($plpairing->Result, Constants::WON) !== false) { + $tiebreak += 1; + } elseif (array_search($plpairing->Result, Constants::DRAW) !== false) { + $tiebreak += 0.5; + } + } + } + + return $tiebreak; + } + + /** + * Result between the tied players + * + * @param Player $player + * @param array $opponents + * @param int $key + * + * @return float + */ + private function calculateMutualResult(Player $player, array $opponents, int $key): float + { + $interestingplayers = $opponents; + if ($key != 0) { + $interestingplayers = []; + $playerstiebreaks = $player->Tiebreaks; + array_splice($playerstiebreaks, $key); + foreach ($opponents as $opponent) { + $opponenttiebreaks = $opponent->Tiebreaks; + array_splice($opponenttiebreaks, $key); + if (($playerstiebreaks == $opponenttiebreaks) && ($player != $opponent)) { + $interestingplayers[] = $opponent; + } + } + } + if ($interestingplayers) { + $allintplayers = $interestingplayers; + $allintplayers[] = $player; + foreach ($allintplayers as $player) { + if (!$player->hasPlayedAllPlayersOfArray($allintplayers)) { + return 0; + } + } + } + $points = 0; + $totalmatches = 0; + foreach ($player->Pairings as $pairing) { + if (array_search($pairing->Opponent, $interestingplayers) !== false) { + if (array_search($pairing->Result, Constants::WON) !== false) { + $points = $points + 1; + } elseif (array_search($pairing->Result, Constants::DRAW) !== false) { + $points = $points + 0.5; + } + $totalmatches++; + } + } + if ($totalmatches != count($interestingplayers)) { + $points = 0; + } + + return $points; + } + + /** + * Number of points + * + * @param Player $player + * + * @return float + */ + private function calculatePoints(Player $player): float + { + return $player->calculatePoints(-1, $this->CustomPoints); + } + + /** + * The points of $player's opponents who $player won against, plus half of the points of $player's opponents who + * $player drew against + * + * @param Player $player + * + * @return float + */ + private function calculateSonneborn(Player $player): float + { + $tiebreak = 0; + foreach ($player->Pairings as $key => $pairing) { + if ($pairing->Opponent) { + if (array_search($pairing->Result, Constants::WON) !== false) { + $tiebreak += $pairing->Opponent->calculatePointsForTiebreaks(); + } elseif (array_search($pairing->Result, Constants::DRAW) !== false) { + $tiebreak += $pairing->Opponent->calculatePointsForTiebreaks() / 2; + } + } + if ($pairing->Result == Result::WON_BYE) { + $tiebreak += $player->calculatePointsForVirtualPlayer($key); + } + } + + return $tiebreak; + } + + /** + * Calculates a specific tiebreak for $player + * + * @param Tiebreak $tiebreak + * @param Player $player + * @param int $tbkey + * + * @return float + */ + private function calculateTiebreak(Tiebreak $tiebreak, Player $player, int $tbkey = 0): float + { + switch ($tiebreak) { + case Tiebreak::KEIZER: + return $this->calculateKeizer($player); + case Tiebreak::POINTS: + return $this->calculatePoints($player); + case Tiebreak::BAUMBACH: + return $this->calculateBaumbach($player); + case Tiebreak::BLACK_PLAYED: + return $this->calculateBlackPlayed($player); + case Tiebreak::BLACK_WIN: + return $this->calculateBlackWin($player); + case Tiebreak::BETWEEN: + return $this->calculateMutualResult($player, $this->Players, $tbkey); + case Tiebreak::ARO: + return $this->calculateAverageRating($player, $this->PriorityElo); + case Tiebreak::AROCUT: + return $this->calculateAverageRating($player, $this->PriorityElo, 1); + case Tiebreak::KOYA: + return $this->calculateKoya($player); + case Tiebreak::BUCHHOLZ: + return $this->calculateBuchholz($player); + case Tiebreak::BUCHHOLZ_CUT: + return $this->calculateBuchholz($player, 1); + case Tiebreak::BUCHHOLZ_MED: + return $this->calculateBuchholz($player, 1, 1); + case Tiebreak::BUCHHOLZ_CUT_2: + return $this->calculateBuchholz($player, 2); + case Tiebreak::BUCHHOLZ_MED_2: + return $this->calculateBuchholz($player, 2, 2); + case Tiebreak::SONNEBORN: + return $this->calculateSonneborn($player); + case Tiebreak::KASHDAN: + return $this->calculateKashdan($player, ["Won" => 4, "Draw" => 2, "Lost" => 1, "NotPlayed" => 0]); + case Tiebreak::SOCCER_KASHDAN: + return $this->calculateKashdan($player, ["Won" => 3, "Draw" => 1, "Lost" => 0, "NotPlayed" => -1]); + case Tiebreak::CUMULATIVE: + return $this->calculateCumulative($player); + case Tiebreak::AVERAGE_PERFORMANCE: + return $this->calculateAveragePerformance($player, $this->PriorityElo); + case Tiebreak::PERFORMANCE: + return $player->Performance($this->PriorityElo, $this->NonRatedElo); + default: + return 0; + } + } + + /** + * Checks if a game already is already registered + * + * @param Game $game + * @param int $round + * + * @return bool + */ + public function gameExists(Game $game, int $round = -1): bool + { + $search = [$round]; + if ($round == -1) { + $search = []; + for ($i = 0; $i < $this->NoOfRounds; $i++) { + $search[] = $i; + } + } + + foreach ($search as $round) { + if (!isset($this->Rounds[ $round ])) { + return false; + } + $games = $this->Rounds[ $round ]->Games; + if (is_null($games)) { + return false; + } + foreach ($games as $roundgame) { + if ($game->equals($roundgame)) { + return true; + } + } + } + + return false; + } + + /** + * Converts pairings into games with a black and white player + */ + public function pairingsToRounds(): void + { + $pairings = $this->Pairings; + + /** + * @var Pairing[] + */ + $cache = []; + + foreach ($pairings as $pairing) { + // Add pairing to player + $pairing->Player->addPairing($pairing); + $round = $pairing->Round; + $color = $pairing->Color; + + $this->roundByNo($round)->addPairing($pairing); + $opponent = null; + + /** + * @var int $key + * @var Pairing $cached + */ + foreach ($cache as $key => $cached) { + if (!is_null($cached)) { + if (($cached->Opponent == $pairing->Player) && ($cached->Round == $pairing->Round)) { + $opponent = $cached; + $cache[ $key ] = null; + break; + } + } + } + $game = new Game(); + if ($color->getValue() == Color::WHITE) { + $game->White = $pairing; + $game->Black = $opponent; + } elseif ($color->getValue() == Color::BLACK) { + $game->White = $opponent; + $game->Black = $pairing; + } + + if (is_null($game->White) || is_null($game->Black)) { + $cache[] = $pairing; + } elseif (!$this->gameExists($game, $round)) { // Check if game already exists + $game->Board = $game->White->Board; + // Add board if inexistent + if ($game->Board == -1) { + if (isset($lastboards[ $round ])) { + $lastboards[ $round ] += 1; + } else { + $lastboards[ $round ] = 0; + } + $game->Board = $lastboards[ $round ]; + $game->White->Board = $lastboards[ $round ]; + $game->Black->Board = $lastboards[ $round ]; + } + $this->AddGame($game, $round); + } + } + } + + /** + * Returns the number of participants + * + * @return int + */ + private function participants(): int + { + return count($this->Players); + } + + /** + * Gets a player by its ID + * + * @param int $id + * + * @return Player + */ + public function playerById(int $id): Player + { + return $this->Players[ $id ]; + } + + /** + * Gets the ranking of the tournament + * + * @return Player[] + */ + private function ranking(): array + { + $players = $this->Players; + foreach ($this->Tiebreaks as $tbkey => $tiebreak) { + foreach ($players as $pkey => $player) { + $break = $this->calculateTiebreak($tiebreak, $player, $tbkey); + $tiebreaks = $player->Tiebreaks; + $tiebreaks[ $tbkey ] = $break; + $player->Tiebreaks = $tiebreaks; + $this->updatePlayer($pkey, $player); + } + } + $sortedplayers[ 0 ] = $players; + foreach ($this->Tiebreaks as $tbkey => $tiebreak) { + $newgroupkey = 0; + $tosortplayers = $sortedplayers; + $sortedplayers = []; + foreach ($tosortplayers as $groupkey => $sortedplayerselem) { + usort($tosortplayers[ $groupkey ], $this->sortTiebreak($tbkey)); + foreach ($tosortplayers[ $groupkey ] as $playerkey => $player) { + if (!is_null($player->Tiebreaks[ $tbkey ])) { + if ($playerkey != 0) { + $newgroupkey++; + if ($player->Tiebreaks[ $tbkey ] == + $tosortplayers[ $groupkey ][ $playerkey - 1 ]->Tiebreaks[ $tbkey ]) { + $newgroupkey--; + } + } + } + $sortedplayers[ $newgroupkey ][] = $player; + } + $newgroupkey++; + } + } + $finalarray = []; + foreach ($sortedplayers as $sort1) { + foreach ($sort1 as $player) { + $finalarray[] = $player; + } + } + + return $finalarray; + } + + /** + * Gets a round by its number. + * + * @param int $roundNo + * + * @return Round + */ + public function roundByNo(int $roundNo): Round + { + return $this->Rounds[ $roundNo ]; + } + + /** + * Sort by tiebreak + * + * @param int $key + * + * @return Closure + */ + private function sortTiebreak(int $key): Closure + { + return function (Player $a, Player $b) use ($key) { + if (($b->Tiebreaks[ $key ] == $a->Tiebreaks[ $key ]) || + ($a->Tiebreaks[ $key ] === false) || + ($b->Tiebreaks[ $key ] === false)) { + return 0; + } + + return ($b->Tiebreaks[ $key ] > $a->Tiebreaks[ $key ]) ? +1 : -1; + }; + } + + /** + * Updates player on id to the given Player object + * + * @param int $id + * @param Player $player + */ + public function updatePlayer(int $id, Player $player): void + { + $newArray = $this->Players; + $newArray[ $id ] = $player; + $this->Players = $newArray; + } +} diff --git a/tests/.gitkeep b/tests/.gitkeep new file mode 100644 index 0000000..e69de29