Ajout documentation & vérification compte publique close #2

This commit is contained in:
Rick 2020-07-16 20:38:51 +02:00
parent af8e931b17
commit 62d814bb57
Signed by: Rick
GPG key ID: 9570A7DB7CB2F436

View file

@ -1,4 +1,13 @@
<?php <?php
/*
Application web pour voir la durée pour finir à 100% des jeux de son compte steam
author: rick@gnous.eu
git: https://git.gnous.eu/Rick/triAchievements
version: 1.0.1
*/
// ~ 4 minutes pour ~ 350 jeux // ~ 4 minutes pour ~ 350 jeux
$config = parse_ini_file("config.ini"); $config = parse_ini_file("config.ini");
define('API_KEY', $config["steam_api_key"]); define('API_KEY', $config["steam_api_key"]);
@ -7,6 +16,12 @@ $apikey = $config["steam_api_key"];
/** /**
* retourne un objet json à partir d'une url * retourne un objet json à partir d'une url
*
* @param string $url
* lurl retournant un json
* @return
* - lobjet JSON de lurl
* - NULL si lurl ne renvoie pas de json
*/ */
function getJson($url) function getJson($url)
{ {
@ -17,6 +32,12 @@ function getJson($url)
/** /**
* renvoie le nombre d'heures qu'il faut pour finir un jeu à 100% * renvoie le nombre d'heures qu'il faut pour finir un jeu à 100%
*
* @param int $appid
* lid steam du jeu dont il faut récupérer lheure de complétion sur astat
* @return string|null
* - le temps quil faut pour finir le jeu
* - null si le jeu na pas de temps renseigné
*/ */
function getHours($appid) function getHours($appid)
{ {
@ -48,6 +69,11 @@ function getHours($appid)
/** /**
* check si un jeu a des succès * check si un jeu a des succès
*
* @param int $appid
* id du jeu à vérifier
* @return bool
* true si le jeu à des succès, false sinon
*/ */
function hasAchievements($appid) function hasAchievements($appid)
{ {
@ -61,9 +87,15 @@ function hasAchievements($appid)
} }
} }
/** /**
* verifie si le jeu est fini à 100% * verifie si le jeu est fini à 100%
*
* @param int $appid
* le numéro du jeu à vérifier
* @param int $steamid
* lid steam du compte possédant le jeu
* @return bool
* true si le jeu est fini, false sinon
*/ */
function checkComplete($appid, $steamid) function checkComplete($appid, $steamid)
{ {
@ -75,10 +107,8 @@ function checkComplete($appid, $steamid)
} }
} }
return true; return true;
} }
/** /**
* affiche un tableau HTML contenant les jeux triés par ordre croissant de temps de fin * affiche un tableau HTML contenant les jeux triés par ordre croissant de temps de fin
*/ */
@ -89,6 +119,8 @@ if (isset($_POST['steamid'])) {
$listGames = file_get_contents($url); $listGames = file_get_contents($url);
if ($listGames == NULL) { if ($listGames == NULL) {
$ret = array('error' => 'User not found.', 'response' => $http_response_header); $ret = array('error' => 'User not found.', 'response' => $http_response_header);
} elseif (empty($listGames["response"])) {
$ret = array('error' => 'Private Account.', 'response' => $http_response_header);
} else { } else {
$url = "http://api.steampowered.com/ISteamUser/GetPlayerSummaries/v0002/?key=".API_KEY."&steamids=".$steamid; $url = "http://api.steampowered.com/ISteamUser/GetPlayerSummaries/v0002/?key=".API_KEY."&steamids=".$steamid;
$userInformations = getJson($url); $userInformations = getJson($url);
@ -117,9 +149,6 @@ if (isset($_POST['steamid'])) {
} }
} }
} }
//$fileJson = fopen('result.json', 'w');
//fwrite($fileJson, json_encode($ret));
//fclose($fileJson);
$retJson = json_encode($ret); $retJson = json_encode($ret);
$_POST["game"] = $retJson; $_POST["game"] = $retJson;
header('Content-Type: application/json'); header('Content-Type: application/json');