Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/glaivepro/iaafpoints
PHP library to calculate IAAF scoring points of athletics and IAAF scoring points for combined events.
https://github.com/glaivepro/iaafpoints
combined-events hacktoberfest iaaf iaaf-scores-calculator iaaf-scoring-points php-library
Last synced: about 2 months ago
JSON representation
PHP library to calculate IAAF scoring points of athletics and IAAF scoring points for combined events.
- Host: GitHub
- URL: https://github.com/glaivepro/iaafpoints
- Owner: GlaivePro
- License: mit
- Created: 2017-09-02T08:50:23.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-19T13:30:50.000Z (9 months ago)
- Last Synced: 2024-10-20T11:51:23.902Z (3 months ago)
- Topics: combined-events, hacktoberfest, iaaf, iaaf-scores-calculator, iaaf-scoring-points, php-library
- Language: PHP
- Homepage:
- Size: 232 KB
- Stars: 17
- Watchers: 5
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# IaafPoints
PHP library to calculate World Athletics (IAAF) scoring points of athletics and
WA (IAAF) scoring points for combined events. And some other evaluations of
track and field results.
> IAAF is rolling a rebrand to WA, but we currently have no plans to rename the
> package or any of classes.
The WA scoring tables that we reproduce are these ones:
https://www.worldathletics.org/about-iaaf/documents/technical-information#collapsescoring-tables
This package is used for the stats system of [Latvian Athletics Association](https://athletics.lv).
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [Changelog](#changelog)
- [License](#license)
## Installation
Use composer:
```sh
composer require glaivepro/iaafpoints
```
## Usage
This package provides mutliple calculators that all provide the same interface.
```php
// Calculator and use-case specific options.
$options = [
'gender' => 'm',
'venueType' => 'outdoor',
'discipline' => '200m',
];
// Create a calculator instance
$calculator = new \GlaivePro\IaafPoints\IaafCalculator($options);
// Evaluate a result getting some points or a class assigned to result.
$points = $calculator->evaluate(21.61);
// 980
// Update options
$calculator->setOptions(['gender' => 'f']);
$points = $calculator->evaluate(21.61);
// 1279
```
See [docs](docs) for more details.
## Contributing
> [!IMPORTANT]
> Do not edit anything in `data/`, edit it in `resources/`. The files in `data/`
> are auto-generated from files in `resources/`.
More [here](CONTRIBUTING.md).
## Changelog
It's [here](CHANGELOG.md).
## License
This package is licensed under the [MIT license](LICENSE.md).