From 97aee32c03fe027dbc269e9b442e71543812b48f Mon Sep 17 00:00:00 2001 From: Jan BELLON Date: Thu, 14 Mar 2024 20:32:00 +0000 Subject: [PATCH] Update file README.md --- README.md | 69 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 68 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8e53b821..bb5d41cf 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,71 @@ Le site officiel du club réseaux disponible à l'adresse https://e59.fr/ -```sudo apt-get install php7.4-gd``` \ No newline at end of file +```sudo apt-get install php7.4-gd``` + +# PHP Informations + +## Pages + +- news/ +- about/ +- account/ +- admin/ +- user/ + +## Code conventions + +- PHP Variables format : ```$phpVariable``` +- tables columns format : ```table_column``` +- HTML Class format : ```html-class``` + +## $_SESSION[] + +- ```userID``` +- ```userName``` +- ```userDisplayName``` +- ```userLevel``` +- ```userAccreditation``` + +## Global Variables + +- ```$rootPageURL``` +- ```$rootFilePath``` + +- ```$sqlDatabaseName``` +- ```$sqlDatabaseUser``` +- ```$sqldatabasePass``` +- ```$sqlDatabaseHost``` + +- ```$pageTitle``` +- ```$headerTitle``` +- ```$headerSubtitle``` +- ```$footerText``` + +- ```$confidentialLevels``` +- ```$userLevels``` +- ```$certificationColors``` + +- ```$darkThemes``` +- ```$lightThemes``` + +## Global Functions + +- ```markdownContent($filePath, $rootFilePath)``` + +- ```fillHead($rootPageURL, $pageTitle, $darkTheme, $lightTheme)``` +- ```fillHeader($rootPageURL, $headerTitle, $headerSubtitle)``` +- ```fillNav($rootPageURL)``` +- ```fillFooter($footerText)``` + +- ```sqlConnect($dbHost, $dbName, $dbUser, $dbPass)``` + +- ```userWidget($userPPURL, $userDisplayName, $userName, $userLevel, $certificationColors)``` + +- ```listArticles($result, $rootPageURL)``` + +- ```textInput($type, $shapePath, $name, $placeholder, $value)``` + +- ```fileInput($name)``` + +- ```selectInput($name, $label, $options, $defaultValue)``` \ No newline at end of file