Updated documentation + started to add some documentation

1 year ago · 1b9a873cdc
parent d824f17ea7
commit 1b9a873cdc
3 changed files with 69 additions and 43 deletions
--- a/Documentation/team.puml
+++ b/Documentation/team.puml
@ -12,12 +12,14 @@ class Team {
 }

 Team --> "- mainColor" Color
-Team --> "- secondaryColor" Color
+Team --> "- secondColor" Color

 class Color {
-    - value: int
-
-    + getValue(): int
+    - value: string
+    - __construct(value : string)
+    + getValue(): string
+    + from(value: string): Color
+    + tryFrom(value : string) : ?Color
 }

 class TeamGateway{
@ -31,15 +33,11 @@ TeamGateway *--"- con" Connexion
 TeamGateway ..> Color

 class TeamModel{
-    + ERROR_INVALID_COLOR : int {readOnly}
-    + ERROR_INVALID_NAME : int {readOnly}
-    + ERROR_INVALID_PICTURE : int {readOnly}
-    + ERROR_INVALID_SEARCH : int {readOnly}
-    + ERROR_NO_DATA_FOUND : int {readOnly}
    ---
    + __construct(gateway : TeamGateway)
    + createTeam(name : string,picture : string, mainColorValue : int, secondColorValue : int, errors : array)
    + listByName(name : string ,errors : array) : ?array
+    + displayTeam(id : int): Team
 }

 TeamModel *--"- gateway" TeamGateway
@ -50,8 +48,11 @@ class TeamController{
    - twig : Environement
    --
    + __construct( model : TeamModel, twig : Environement)
-    + submitTeam(request : array)
-    + listTeamByName(request : array)
+    + displaySubmitTeam() : HttpResponse
+    + submitTeam(request : array) : HttpResponse
+    + displayListTeamByName(): HttpResponse
+    + listTeamByName(request : array) : HttpResponse
+    + displayTeam(id : int): HttpResponse
 }

 TeamController *--"- model" TeamModel
@ -62,7 +63,6 @@ class Connexion{
    + __constructor(pdo : PDO)
    + exec(query : string, args : array)
    + fetch(query string, args array): array
-
 }

@enduml
--- a/src/Controller/TeamController.php
+++ b/src/Controller/TeamController.php
@ -10,7 +10,7 @@ use App\Validation\FieldValidationFail;
 use App\Validation\Validators;
 use \Twig\Environment;

-class TeamController /* verif si les camp sont assignés, sinon erreur 400*/
+class TeamController
 {
    private TeamModel $model;
    private Environment $twig;
@ -24,7 +24,7 @@ class TeamController /* verif si les camp sont assignés, sinon erreur 400*/
        $this->twig = $twig;
    }

-    public function displaySubmitTeam() {
+    public function displaySubmitTeam() : HttpResponse {
        return ViewHttpResponse::twig("insert_team.html.twig", []);
    }

--- a/src/Views/display_team.html.twig
+++ b/src/Views/display_team.html.twig
@ -1,32 +1,58 @@
 <!DOCTYPE html>
 <html lang="en">
-<head>
-    <meta charset="UTF-8">
-    <title>Twig view</title>
-    <style>
-        .square{
-            width:50px;
-            height:50px;
-        }
-
-        #mainColor{
-            background-color: {{ team.mainColor.getValue() }};
-        }
-        #secondColor{
-            background-color: {{ team.secondColor.getValue() }};
-        }
-    </style>
-</head>
-<body>
-
-<h1>{{ team.name }}</h1>
-<img src="{{ team.picture }}" alt="Logo d'équipe">
-<div class="square" id="mainColor"></div>
-<div class="square" id="secondColor"></div>
-
-{% for m in team.members %}
-<p> m.id </p>
-{% endfor %}
-
-</body>
+    <head>
+        <meta charset="UTF-8">
+        <title>Twig view</title>
+        <style>
+            body{
+                background-color: #f1f1f1;
+                display: flex;
+                flex-direction: column;
+            }
+
+            section{
+                width: 80%;
+            }
+
+            .square{
+                width:50px;
+                height:50px;
+            }
+
+            #mainColor{
+                background-color: {{ team.mainColor.getValue() }};
+            }
+            #secondColor{
+                background-color: {{ team.secondColor.getValue() }};
+            }
+
+            .container{
+                background-color: #fff;
+            }
+            .team{
+                border-color: darkgrey;
+                border-radius: 20px;
+            }
+        </style>
+    </head>
+    <body>
+        <header>
+            <h1><a href="/">IQBall</a></h1>
+        </header>
+
+        <section class="container">
+
+            <div class="team">
+                <h1>{{ team.name }}</h1>
+                <img src="{{ team.picture }}" alt="Logo d'équipe">
+                <div class="square" id="mainColor"></div>
+                <div class="square" id="secondColor"></div>
+
+                {% for m in team.members %}
+                    <p> m.id </p>
+                {% endfor %}
+            </div>
+
+        </section>
+    </body>
 </html>