🔥 Introduction :
VSTAT is a simple lightweight PHP MIT Package developed by Lotfio Lakehal That helps you to get VATSIM statistics and data in simple clean and easy way.
📌 Requirements :
- PHP 7.2 or newer versions
- PHPUnit >= 8 (for testing purpose)
👌 Features :
- Easy to use.
- Simple installation one line command with composer.
- Get all Vatsim Data.
- Get VATSIM servers data.
- Get clients data.
- Cache data to speed up the loading process.
🚀 Installation & Use :
composer require lotfio/vstat
✏️ Use it :
use Vstat\Vstat;
require 'vendor/autoload.php';
print_r(Vstat::getClients());🔧 Config:
Config file is located inside Vstat/config/app.php where you can change vatsim data url, cache time and cache location.
By default VSTAT is generating data each 5 minutes from http://vatsim-data.hardern.net/vatsim-data.txt
You can change the time of data loading to 2 - 3 minutes.
Recommended I recommend that you create a cron job on your host and update vatsim-data.txt file every minute
which will highly increase the loading speed of you application. (if you do so make sure to keep php cache time higher than the cron job).
📥 Available methods :
// get all vatsim clients
print_r((Vstat::getClients()));
// get prefile plans
print_r((Vstat::getPreFile()));
// get vatsim servers
print_r((Vstat::getServers()));
// get vatsim voice servers
print_r((Vstat::getVoiceServers()));
// filters
// show by Type ATC or PILOT by default show by PILOT
print_r((Vstat::showByType('ATC')));
// show by airline
print_r((Vstat::showByAirline('BAW')));
// show by callsign
print_r((Vstat::showByCallsign('BAW96')));
// show by vatsim id
print_r((Vstat::showByVatsimId(131)));
// get number of pilots
print_r((Vstat::getNumberOfPilots()));
// get number of controllers
print_r((Vstat::getNumberOfControllers()));
// get number of clients connected with the same airline
echo count(Vstat::showByAirline('DAH'));
// get data as json formt
print_r(json_encode(Vstat::showByAirline('DAH')));💻 Contributing
- Thank you for considering to contribute to Ouch. All the contribution guidelines are mentioned here.
📃 ChangeLog
- Here you can find the ChangeLog.
🍺 Support the development
- Share VSTAT and lets get more stars and more contributors.
- If this project helped you reduce time to develop, you can give me a cup of coffee :) : Paypal.
💖
📋 License
- VSTAT is an open-source software licensed under the MIT license.