Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
TP-PHP-LPPRISM
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Sofiane Lasri
TP-PHP-LPPRISM
Commits
cc7986d4
Commit
cc7986d4
authored
2 years ago
by
Sofiane Lasri
Browse files
Options
Downloads
Patches
Plain Diff
Ajout de la documentation.
parent
29d5ae87
No related branches found
No related tags found
No related merge requests found
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
README.md
+140
-0
140 additions, 0 deletions
README.md
models/Objet.php
+58
-11
58 additions, 11 deletions
models/Objet.php
with
198 additions
and
11 deletions
README.md
0 → 100644
+
140
−
0
View file @
cc7986d4
# Documentation
## Objet
Les fonctions publiques statiques retournent des arrays se basant sur ce format :
````
php
[
"status"
=>
"fail|success"
,
"message"
=>
"message d'erreur"
]
````
``
### addObject
Permet d'insérer un objet dans la base de données
* @param String $tableName
* @param array $columns
* @return array|string[]
Le paramètre ``
$columns
`` doit être un array indexé comme ceci :
````php
[
"index" => "valeur",
"index2" => "valeur2"
]
````
Retourne en plus `pdoError` de l'index `message` en cas d'erreur.
````php
[
"status" => "fail",
"message" => "L'insertion de l'objet a échoué.",
"pdoError" => $e
]
````
### describeObject
Permet de décrire une table représentant un objet. Exécute ``
SHOW FULL COLUMNS FROM $tableName
`` sur le serveur.
* @param $tableName
* @return array
Retourne ``
columns
``.
````php
[
"status" => "success",
"columns" => [
// Colonnes du retour de la commande sql
]
]
````
### modifyObject
Permet la modification d'un objet dans la base de données
* @param String $tableName
* @param array $id
* @param array $columns
* @return array|string[]
Le paramètre ``
$id
`` doit respecter ce format :
````php
[
"name" => "nom_de_la_colonne",
"value" => "Valeur de la clé primaire"
]
````
Le paramètre ``
$columns
`` doit être un array indexé comme ceci :
````php
[
"index" => "valeur",
"index2" => "valeur2"
]
````
### getObject
Permet la récupération d'un objet depuis la base de données
* @param string $tableName
* @param array $id
* @return array|string[]
Le paramètre ``
$id
`` doit respecter ce format :
````php
[
"name" => "nom_de_la_colonne",
"value" => "Valeur de la clé primaire"
]
````
Retourne ``
data
`` avec les colonnes de l'objet demandé.
````php
[
"status" => "success",
"message" => "Récupération réussie.",
"data" => [
// Colonnes
]
]
````
### verifyTableAndFormat
Permet de vérifier le format du nom de la table et des nom des colonnes + vérifier l'existance de la table.
* @param String $tableName
* @param array|null $columns
* @return array|string[]
Le paramètre ``
$columns
`` est optionnel. Renverra en plus `pdoError` de l'index `message` en cas d'erreur si `$columns`
a été utilisé.
````php
[
"status" => "fail",
"message" => "Le format du nom de la table est incorrect."
]
````
````php
[
"status" => "fail",
"message" => "La table $tableName ne semble pas exister.",
"pdoError" => $e
]
````
````php
[
"status" => "success",
"message" => "Validation réussie."
]
````
## Routes
Les pages sont générées à partir du paramètre url ``
action=nomDeLaPage
``.
```php
"lireAuteur" => ControleurAuteur::lireAuteur(),
"lireAuteurs" => ControleurAuteur::lireAuteurs(),
"creerObjet" => ControleurObjet::createObject(),
"lireAdherent" => ControleurAdherent::lireAdherent(),
"lireAdherents" => ControleurAdherent::lireAdherents(),
"lireLivre" => ControleurLivre::lireLivre(),
"lireLivres" => ControleurLivre::lireLivres(),
"describeTable" => ControleurObjet::describeTable(),
default => ControleurAuteur::lireAuteur(),
```
### describeTable
describeTable retourne le résultat de ``
ControleurObjet::describeTable()
``
au format JSON.
\ No newline at end of file
This diff is collapsed.
Click to expand it.
models/Objet.php
+
58
−
11
View file @
cc7986d4
...
@@ -99,6 +99,13 @@ class Objet
...
@@ -99,6 +99,13 @@ class Objet
}
}
}
}
/**
* Permet la modification d'un objet dans la base de données
* @param String $tableName
* @param array $id
* @param array $columns
* @return array|string[]
*/
public
static
function
modifyObject
(
String
$tableName
,
array
$id
,
array
$columns
)
:
array
public
static
function
modifyObject
(
String
$tableName
,
array
$id
,
array
$columns
)
:
array
{
{
$result
[
"status"
]
=
"success"
;
$result
[
"status"
]
=
"success"
;
...
@@ -132,13 +139,53 @@ class Objet
...
@@ -132,13 +139,53 @@ class Objet
return
$result
;
return
$result
;
}
}
/**
* Permet la récupération d'un objet depuis la base de données
* @param string $tableName
* @param array $id
* @return array|string[]
*/
public
static
function
getObject
(
string
$tableName
,
array
$id
)
:
array
{
$validation
=
Objet
::
verifyTableAndFormat
(
$tableName
);
if
(
$validation
[
"status"
]
!==
"success"
){
return
$validation
;
}
if
(
empty
(
$id
[
"name"
])
||
empty
(
$id
[
"value"
])
||
!
isAlphaNumeric
(
$id
[
"name"
])){
return
[
"status"
=>
"fail"
,
"message"
=>
"L'identifiant de la table envoyé est incorrect!"
];
}
// On prépare la requête
$queryString
=
(
"SELECT * FROM
$tableName
WHERE "
.
$id
[
"name"
]
.
"=?"
);
$insertQuery
=
Database
::
pdo
()
->
prepare
(
$queryString
);
try
{
// Et on l'exécute
$insertQuery
->
execute
([
$id
[
"name"
]]);
}
catch
(
PDOException
$e
)
{
return
[
"status"
=>
"fail"
,
"message"
=>
"La récupération de l'objet a échoué."
,
"pdoError"
=>
$e
];
}
return
[
"status"
=>
"success"
,
"message"
=>
"Récupération réussie."
,
"data"
=>
$insertQuery
->
fetch
(
PDO
::
FETCH_ASSOC
)
];
}
/**
/**
* Permet de vérifier le format du nom de la table et des nom des colonnes + vérifier l'existance de la table.
* Permet de vérifier le format du nom de la table et des nom des colonnes + vérifier l'existance de la table.
* @param String $tableName
* @param String $tableName
* @param array $columns
* @param array
|null
$columns
* @return array|string[]
* @return array|string[]
*/
*/
public
static
function
verifyTableAndFormat
(
string
$tableName
,
array
$columns
)
:
array
public
static
function
verifyTableAndFormat
(
string
$tableName
,
array
$columns
=
null
)
:
array
{
{
// On va vérifier que $tableName est bien en format alphanumérique
// On va vérifier que $tableName est bien en format alphanumérique
if
(
!
isAlphaNumeric
(
$tableName
)){
if
(
!
isAlphaNumeric
(
$tableName
)){
...
@@ -159,8 +206,7 @@ class Objet
...
@@ -159,8 +206,7 @@ class Objet
];
];
}
}
// Nous pouvons commencer l'insertion
if
(
!
is_null
(
$columns
)){
// On va vérifier que l'index de chaque est bien en format alphanumérique
// On va vérifier que l'index de chaque est bien en format alphanumérique
foreach
(
$columns
as
$index
=>
$value
){
foreach
(
$columns
as
$index
=>
$value
){
if
(
!
isAlphaNumeric
(
$index
)){
if
(
!
isAlphaNumeric
(
$index
)){
...
@@ -170,6 +216,7 @@ class Objet
...
@@ -170,6 +216,7 @@ class Objet
];
];
}
}
}
}
}
return
[
return
[
"status"
=>
"success"
,
"status"
=>
"success"
,
"message"
=>
"Validation réussie."
"message"
=>
"Validation réussie."
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment