This commit is contained in:
Florian Bouillon 2019-02-11 17:36:40 +01:00
parent 14a732c31e
commit df674a7ec5
18 changed files with 344 additions and 62 deletions

4
.htaccess Normal file
View File

@ -0,0 +1,4 @@
RewriteEngine on
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^(.*)$ ./router.php [L,QSA]

0
admin/admin.css Normal file
View File

0
admin/admin.js Normal file
View File

0
admin/index.php Normal file
View File

View File

@ -0,0 +1,3 @@
function testModule($modulesVars, $elementVars) {
return new DO
}

View File

View File

@ -0,0 +1,4 @@
{
"theme": "default",
"modules": ["default"]
}

View File

View File

View File

@ -0,0 +1,6 @@
{
"default": {
"URI": "pouet/pouet.php",
"static": true
}
}

View File

@ -0,0 +1,3 @@
<?php
?>

View File

9
pages/index.json Normal file
View File

@ -0,0 +1,9 @@
{
"title": "Home",
"template": "page",
"access": "public",
"content": "<h1>hello world</h1>",
"modules": {
"?": "?"
}
}

3
pages/pokemon.json Normal file
View File

@ -0,0 +1,3 @@
{
"title":"test"
}

21
public.php Normal file
View File

@ -0,0 +1,21 @@
<?php
/*
if cache is active
if active is active load cache (scripts.js styles.css)
load templates.json
if template has cache for webpage and cache exist
load the file
else
launch generateWebPage()
if modules are in the page
load the modules
function generateWebPage()
load pages/page.json
load variables for theme
generate the basic web page
*/
?>

254
readme.md
View File

@ -8,100 +8,230 @@ WIP
see [changelog.md](./changelog.md) see [changelog.md](./changelog.md)
## Themes
### Templates
themes works via "templates".
first a template named "page" is a must, your template can be static or not (static templates will be updated on document update while not static the templateFile will always be used)
```php
website->addTemplate("Template Name", "templateURI/from/root/page.php", "functionName", true);
```
- `"Template Name"` is the shown name
- `"templateURI"` is the file URI
- `"functionName"` is the function used
- `true` is to says to the website if this template is static or not (default to `false`)
if cache is disabled globally static or not static pages will be updated at every load
example: a template named `Blog Page` can be static while a `Blog List` shouldn't be static to load newly added blog pages
```php
website->addTemplate("Blog Page", "templates/blog.php", "page", true);
website->addTemplate("Blog List", "templates/blog.php", "list", false);
```
### styles & scripts
themes must declare each scripts & styles so they can be cached when needed
```php
website->addNewStyle("styleURI/from/style/root/page.css", "styleName", ["styleDependency"]);
website->addNewScript("scriptURI/from/script/root/page.js", "scriptName", ["scriptdependency", "JQuery"]);
```
- `"styleURI"`/`"scriptURI"` is the link to the file
- [OPTIONAL] `"styleName"`/`"scriptName"` is the name of the style/script to be used by sub-dependencies
- [OPTIONAL] `["styleDependency"]`/`["scriptDependency", "JQuery"]` are used to load theses scripts after the followed dependencies
### Options
Options are declarated in the same file than before
and will be usable in the templates files
updating an option will update the static files
```php
$optionMenu = website->addOptionsMenu("Menu Name");
```
here we create a new option menu that will be located in the admin sidebar `theme -> Options` within the tabs
- `"Menu Name"` is the shown name
```php
$optionMenu->addTextOption("Option Name", "variableName", "defaultValue", {
"min": 1,
"max": 16,
"placeholder": "placeholder"
});
```
## Modules
modules will work like this in the `page.content` of the page `[moduleName variablesName="valueName"]`
the module will then receive a variable named `$modVars` that will contain `$modVars->variableName` = `valueName` and will have to return a `String` Object
To keep the document strict it's advised to use the php `DOMDocument` Object
## Files/Folders architecture ## Files/Folders architecture
- index.php (is it really necessary ?) - index.php (is it really necessary ?)
- .htaccess (handle file redirection) - .htaccess (handle file redirection)
- router.php (handle the first route part ( separating the loading process))
- uploads/ - uploads/
- cache/ (public cache (won't be seen by client via .htaccess redirection)) - cache/ (public cache (won't be seen by client via .htaccess redirection))
- .htaccess (make sure clients can't access this folder) - .htaccess (make sure clients can't access this folder)
- scripts.js - scripts.js
- styles.css - styles.css
- pages/ (NO `scripts.js` NOR `styles.css` NOR `admin` NOR `login` files must be in here) - pages/ (NO `scripts.js` NOR `styles.css` NOR `admin` NOR `login` files must be in here)
- .htaccess (make sure clients can't access this folder) - .htaccess (make sure clients can't access this folder)
- index.json (this index.json will be the root name "/") - index.json (this index.json will be the root name "/")
- slugname.json (path = "/slugname") - slugname.json (path = "/slugname")
- iamjson.json.json (path = "/iamjson.json" wand with a module/theme could just return json) - iamjson.json.json (path = "/iamjson.json" wand with a module/theme could just return json)
- folderslug/ - folderslug/
- index.json (path = "/folderslug" if no index.json is given there will be a 404 error for "/folderslug" but not for the "/folderslug/pouet") - index.json (path = "/folderslug" if no index.json is given there will be a 404 error for "/folderslug" but not for the "/folderslug/pouet")
- pouet.json (path = "/folderslug/pouet") - pouet.json (path = "/folderslug/pouet")
- admin/ - admin/
- .htaccess manage redirection for admin pages (pass throught a verify login script) - .htaccess manage redirection for admin pages (pass throught a verify login script)
- index.php - index.php
- admin.js - admin.js
- admin.css - admin.css
- settings/ (settings files more infos [here](#config-files)) - settings/ (settings files more infos [here](#config-files))
- scripts.json (if cache is disabled these files will be used to get the styles & scripts) - scripts.json (if cache is disabled these files will be used to get the styles & scripts)
- styles.json (else these files are only used to create the caches files) - styles.json (else these files are only used to create the caches files)
- admin.json (admin settings (see admin.json section)) - admin.json (admin settings (see admin.json section))
- templates.json (simple name to redirect) - templates.json (simple name to redirect)
- modules/ - modules/
- moduleName.json - moduleName/
- themes/ - settings.json
- themeName.json - vars.json
- admin.list (used to see what to launch on the admin side) - themes/
- options.list (options for modules & themes to be used site-wide) - themeName/
- templates.list (store the template used on the website with a link to there .php file) - settings.json
- themes/ (when a new theme is loaded regenerate scripts.js & styles.css, an option will allow the use of direct files) - vars.json
- default/ (a default theme will be here) - admin.list (used to see what to launch on the admin side)
- theme.php - options.list (options for modules & themes to be used site-wide)
- themeName/ - templates.list (store the template used on the website with a link to there .php file)
- theme.php (only launched on theme load, to generate cache files & admin options files) - themes/ (when a new theme is loaded regenerate scripts.js & styles.css, an option will allow the use of direct files)
- public.php (launched everytime on website when page is launched (admins sections are excluded) - default/ (a default theme will be here)
- admin.php (launched everytime on admin/themename/** launch (with args like page)) - theme.php
- templates/ (all folders included under are optional anc can be located somewhere else in the theme folder) - themeName/
- page.php (at least a template named "page" must exist to make the theme usable) - theme.php (only launched on theme load, to generate cache files & admin options files)
- templateName.php (file launched everytime a page is loaded with the template selected) - public.php (launched everytime on website when page is launched (admins sections are excluded)
- css/ - admin.php (launched everytime on admin/themename/** launch (with args like page))
- js/ - templates/ (all folders included under are optional anc can be located somewhere else in the theme folder)
- modules/ - page.php (at least a template named "page" must exist to make the theme usable)
- default/ (a default module will be here) - templateName.php (file launched everytime a page is loaded with the template selected)
- module.php - css/
- moduleName/ - js/
- module.php - modules/
- public.php (same as theme) - default/ (a default module will be here)
- module.php
- moduleName/
- module.php
- public.php (same as theme)
## Configs files ## Configs files
### page.json (in `pages` folder)
```json
{
"title": "pageTitle",
"template": "templateName",
"access": "typeOfAccess (public: everyone has access to the page, limited:only logged in users has access to the page, private: only the author & admins has access to the page)",
"author": "Aviortheking",
"content": "<h1>hello world</h1>"
}
```
### scripts.json & styles.json ### scripts.json & styles.json
```json ```json
{ {
[ [
"path/to/script" "path/to/script"
] ]
} }
``` ```
### admin.list ### admin.list
```json ```json
{ {
"themeUsed": "themeName", "themeUsed": "themeName",
"modulesUsed": [ "modulesUsed": [
"moduleName", "moduleName",
"etc" "etc"
] ]
} }
``` ```
### moduleName.json & themeName.json ### vars.json
```json ```json
{ {
"variable1": "value1", "variable1": "value1",
"list1": [ "list1": [
"pouet1", "pouet1",
"etc" "etc"
] ],
"variableSet1": { "variableSet1": {
"subVariable1": "value2" "subVariable1": "value2"
} }
}
```
### moduleName.json & themeName.json
*values for the options are located in the `vars.json` files*
```json
{
[
{
"title": "Menu Title",
"slug": "menu-title",
"options": {
"textOption": {
"type": "text",
"name": "Option Name",
},
"radioOption": {
"type": "radio",
"name": "Radio Option",
"values": [
"value1",
"value2",
"value3"
],
},
"selectOption": {
"type": "select",
"name": "Select",
"value": [
"value1",
"value2",
"value3",
"etc"
]
}
}
},
{
"title": "etc"
}
]
} }
``` ```
### templates.list ### templates.list
*voir si il y auras tout les themes ou seulement le theme actif* *voir si il y auras tout les themes ou seulement le theme actif*
if static is true then static webpage will be generated
```json ```json
{ {
"templateName": templates/templateName.php "templateName": {
"URI": "templates/templateName.php",
"function": "functionName",
"static": false
}
} }
``` ```

68
router.php Normal file
View File

@ -0,0 +1,68 @@
<?php
$url = strtolower(endsWith($_SERVER["REQUEST_URI"], "/") ? $_SERVER["REQUEST_URI"] . "index" : $_SERVER["REQUEST_URI"]);
if($url == "/test") {
require_once "test.php";
die;
}
$_SERVER = null;
$fileURI = "./pages" . $url . ".json";
if(in_array(explode("/", $url)[1], ["login", "admin"])) echo ("this is the login/admin page");
elseif (file_exists($fileURI)) {
$json = json_decode(file_get_contents($fileURI));
echo ($json->title);
} else echo "404";
/*
verify if the page to load exist
if page is login/admin then continue;
elif the page is a file in /pages/pagename.json then continue
else return 404 error
verify if user is logged in
if the user is logged in & the page is login return to /admin
elif the user is not logged in & the page is admin return to /login
else start the process to load the page
*/
function endsWith($haystack, $needle) {
$length = strlen($needle);
if ($length == 0) {
return true;
}
return (substr($haystack, -$length) === $needle);
}
?>

31
test.php Normal file
View File

@ -0,0 +1,31 @@
<?php
ini_set('display_errors', 'On');
$doc = new DOMDocument();
$test = "<html><body><p>pouet</p></body></html>";
$doc->loadHTML($test);
appendHTML($doc->getElementsByTagName("body")->item(0), "<img src=\"./\">");
echo $doc->saveHTML();
function appendHTML(DOMNode $parent, $source) {
$tmpDoc = new DOMDocument();
$html = "<html><body>";
$html .= $source;
$html .= "</body></html>";
$tmpDoc->loadHTML('<?xml encoding="UTF-8">'.$html);
foreach ($tmpDoc->childNodes as $item)
if ($item->nodeType == XML_PI_NODE)
$tmpDoc->removeChild($item);
$tmpDoc->encoding = 'UTF-8';
foreach ($tmpDoc->getElementsByTagName('body')->item(0)->childNodes as $node) {
$importedNode = $parent->ownerDocument->importNode($node, true);
$parent->appendChild($importedNode);
}
}
?>