Initial commit

Author: luca-vogels

.htaccess

@@ -0,0 +1,6 @@
+FallbackResource index.php
+
+RewriteEngine On
+
+# Rewrites everything to root index.php
+RewriteRule ^(.*)$ "index.php"

README.md

@@ -1,2 +1,61 @@
-# php-framework
-A PHP framework for easy and efficient creation of multi-lingual websites
+# PHP Framework (Work in progress)
+A PHP framework for easy creation of high-performance, multi-lingual websites.  
+
+This framework does not contain pre-defined HTML code or something like that, 
+the purpose of it is to organize your code and eliminate code duplication while 
+providing maximum performance. 
+
+## How to use
+In the following is described how to build a website with this framework:
+
+### Structure
+#### `views`
+Inside of the `views` folder you put your PHP or HTML files that define the layout of each page view of your website. 
+The structure inside the `views` folder is important because it also defines how the URLs, that the user calls, will look like later on.  
+For example if you place a file the following `views/login/index.php` then the resulting URL to request the file 
+will be  `https://<yourDomain>/<languageCode>/login/`.
+
+#### `translations`
+The `translations` directory contains JSON files that contain the actual text in different languages.  
+Inside the `translations/globals.json` you can define text variables that should be available in every language  
+e.g. all the native names 
+
+#### `css-components`
+You can put CSS files into the `css-components` directory, however they can not directly be called from an URL!  
+Instead you can define in the `css-components/routes.json` file names that should be generated as keys 
+and as values an array of files names you've created inside `css-components`. Calling a file name defined as key will 
+automatically generate the appropriate file consisting of the contents of the file names defined in the value array. 
+Those generated files will be put in the `css` folder that is publicly accessible over the URL `https://<yourDomain>/css/`. 
+If a file inside the `css-components` folder gets changed the generated files inside the `css` folder will be automatically updated. 
+
+#### `css`
+Files automatically generated out of the `css-components` will be placed here. 
+However you can also directly place static CSS files inside of here if you don't want to use the CSS components system. 
+All files of the `css` folder are publicly accessible over the URL `https://<yourDomain>/css/`.
+
+#### `js-components`
+TODO
+
+#### `js`
+TODO
+
+#### `scripts`
+TODO
+
+#### `images`
+The `images` folder contains all the images. You can create subdirectories in it as you like. 
+Referencing images inside your code looks like the following `<?php echo IMAGES.'<pathInsideImagesDir>'; ?>` 
+where the keyword `IMAGES` will get replaced with the relative path to the `images/` directory. So you need just to 
+append your path as if you were inside the `images/` directory.
+For  example `<?php echo IMAGES.'backgrounds/start-background.jpg'; ?>`
+
+### Global Variables
+* `CSS` TODO
+* `JS` TODO
+* `IMAGES` TODO
+* `SCRIPTS` TODO
+* `BASE` Relative path to root index file but still with the language prefix e.g. `https://<yourDomain>/en/`
+* `ROOT` Relative path to absolute root index file without the language prefix e.g. `https://<yourDomain>/`
+* `LANGUAGE_CODE` TODO
+* `REQUEST` TODO
+* `FULL_REQUEST` TODO

css-components/default.css

@@ -0,0 +1,20 @@
+:root {
+    --color-main: '#333';
+
+    --background-main: '#fff';
+}
+
+.noselect {
+	-webkit-user-select: none;
+	-khtml-user-select: none;
+	-moz-user-select: none;
+	-o-user-select: none;
+	user-select: none;
+}
+.nodrag {
+	-webkit-user-drag: none;
+	-khtml-user-drag: none;
+	-moz-user-drag: none;
+	-o-user-drag: none;
+	user-drag: none;
+}

css-components/header.css

@@ -0,0 +1,4 @@
+header {
+    display: block;
+    width: 100%;
+}

css-components/routes.json

@@ -0,0 +1,4 @@
+{
+    "home": ["default", "header", "home", "footer"],
+    "contact": ["default", "header", "about", "footer"],
+}

css/static.css

@@ -0,0 +1,69 @@
+<?php
+
+
+// ---------------------------------------------------------------------------------------
+// CONFIG
+// ---------------------------------------------------------------------------------------
+
+define('DEFAULT_LANGUAGE_CODE', 'en');
+
+define('_CSS', 'css/'); // internal use only
+define('_IMAGES', 'images/'); // internal use only
+define('_JS', 'js/'); // internal use only
+define('_VIEWS', 'views/'); // internal use only
+define('_SCRIPTS', 'scripts/'); // internal use only
+define('_TRANSLATIONS', 'translations/'); // internal use only
+
+
+
+
+
+// ---------------------------------------------------------------------------------------
+// DEFINING DEFAULT FUNCTIONS
+// ---------------------------------------------------------------------------------------
+
+function isSupportedLanguage($langCode){
+	return is_string($langCode) && file_exists(_TRANSLATIONS.strtolower($langCode).'.php');
+}
+
+// ---------------------------------------------------------------------------------------
+// PROCESSING REQUEST URI
+// ---------------------------------------------------------------------------------------
+
+$base = substr($_SERVER['SCRIPT_NAME'], 0, -strlen(basename($_SERVER['SCRIPT_NAME'])));
+
+define('FULL_REQUEST', substr($_SERVER['REQUEST_URI'], strlen($base)));
+$fullRequestLen = strlen(FULL_REQUEST);
+
+// ---------------------------------------------------------------------------------------
+// DETECTING LANGUAGE
+// ---------------------------------------------------------------------------------------
+
+$lang = false;
+// TODO check if language codes exist as /translations/<lang>.php
+
+// TODO based on URI
+
+// TODO based cookie
+
+// TODO default language
+
+if(!isSupportedLanguage($lang)) $lang = DEFAULT_LANGUAGE_CODE;
+
+define('LANGUAGE_CODE', $lang);
+
+$langLen = strlen(LANGUAGE_CODE);
+
+define('REQUEST', ($fullRequestLen < $langLen || strtolower(substr(FULL_REQUEST, 0, $langLen)) != $lang) ? FULL_REQUEST : substr(FULL_REQUEST, $langLen+1));
+
+// ---------------------------------------------------------------------------------------
+// ---------------------------------------------------------------------------------------
+
+
+// TODO HANDLE _CSS
+// TODO HANDLE _IMAGES
+// TODO HANDLE _JS
+
+// TODO HANDLE sitemap.
+
+?>

index.php

@@ -0,0 +1,9 @@
+{
+    "home": {
+        "instant": ["storage.js"],
+        "onload": ["home-onload"]
+    },
+    "about": {
+        "onload": ["about"]
+    }
+}

js-components/routes.json

@@ -0,0 +1,6 @@
+{
+	"descriptionAbout": "Weitere Informationen über dieses Framework und LupCode",
+	"descriptionStart": "Startseite dieses Frameworks, welches von LupCode entwickelt wurde",
+
+	"languageName": "Deutsch"
+}

js/static.js

@@ -0,0 +1,6 @@
+{
+	"descriptionAbout": "More information about this framework and LupCode",
+	"descriptionStart": "Start page of this framework developed by LupCode",
+
+	"languageName": "English"
+}

translations/de.json

@@ -0,0 +1,16 @@
+{
+    "languageNameDE": "Deutsch",
+    "languageNameEN": "English",
+    "languageNameES": "Español",
+    "languageNameFR": "Français",
+    "languageNameIT": "Italiano",
+    "languageNameNL": "Nederlands",
+    "languageNamePO": "Polskie",
+    "languageNameRU": "русский",
+
+    "keywordsStartEN": "Start,Framework,PHP,LupCode",
+    "keywordsStartDE": "Start,Framework,PHP,LupCode",
+
+    "keywordsAboutEN": "About,Welcome,LupCode",
+    "keywordsAboutDE": "Über,Willkommen,LupCode"
+}