From 9ae4a82837d5e2948499a10e108aafb64fb61097 Mon Sep 17 00:00:00 2001
From: Gael PICOT <gael.picot@free.fr>
Date: Wed, 8 Jun 2022 09:29:36 +0200
Subject: [PATCH] Ajout documentation de code.

---
 index.php | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/index.php b/index.php
index ee1ca4c..b6490a9 100644
--- a/index.php
+++ b/index.php
@@ -27,6 +27,7 @@ require('halRequestBuilder.php');
 require('clean.php');
 cleanOldFile();
 
+// création de la clés personnelle
 if(!isset($_SESSION['personalKey'])) {
     $_SESSION['personalKey'] = bin2hex(random_bytes(20));
 }
@@ -98,7 +99,16 @@ if(isset($_GET['requestName2'])) {
     </form><br /><br />
 <?php
 
-function paralelle($a, $b, $fields, $key) {
+/**
+ * génére les fichier temporaire
+ *
+ * @param HalRequestIterator $a itéraateur sur la requête numéro 1
+ * @param HalRequestIterator $b itéraateur sur la requête numéro 2
+ * @param array $fields champs à renvoyer dans le fichier
+ * @param string $key clés unique pour créé des fichier différent pour chaques utilisateurs
+ * @return array tableau des noms de fichier
+ */
+function paralelle(HalRequestIterator $a, HalRequestIterator $b, array $fields, string $key) {
     $filenames = [
         'a' => $a->getName(),
         'b' => $b->getName(),
@@ -160,6 +170,9 @@ function paralelle($a, $b, $fields, $key) {
     return $filenames;
 }
 
+/*
+ * verification de la présence des champs requie dans les parametre de la requête get
+ */
 if(isset($_GET['request1'])&&isset($_GET['request2'])&&isset($_GET['fields'])&&isset($_GET['requestName1'])&&isset($_GET['requestName2'])) {
     if(strpos($fields, 'docid')===false) $fields = 'docid,'.$fields;
     $full_request1 = $request1.'&fl='.$fields;
-- 
GitLab