Jingga/Developer-Guide
1
0
Fork 0
mirror of https://github.com/Karaka-Management/Developer-Guide.git synced 2026-01-10 20:08:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

bump

Browse Source
This commit is contained in:
Dennis Eichhorn 2024-02-28 05:09:09 +00:00
parent 52505439e3
commit 913f79913f
8 changed files with 29 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
.github/FUNDING.yml vendored
View File

@ -1,12 +0,0 @@
# These are supported funding model platforms
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
patreon: # orange_management
open_collective: # Replace with a single Open Collective username
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username
custom: ['https://paypal.me/orangemgmt']

10
cssOMS/alerts/alerts.md
View File

@ -9,7 +9,7 @@ Alerts are boxes styled in such a way that they attract the attention of the use
![Alert ok](Developer-Guide/frontend/elements/alerts/ok.png)
```html
<div class="log-msg log-msg-status-ok"><i class="fa fa-check"></i>This is ok</div>
<div class="log-msg log-lvl-ok"><i class="fa fa-check"></i>This is ok</div>
```
#### Advanced
@ -17,7 +17,7 @@ Alerts are boxes styled in such a way that they attract the attention of the use
![Alert ok advanced](Developer-Guide/frontend/elements/alerts/ok_advanced.png)
```html
<div class="log-msg log-msg-status-ok">
<div class="log-msg log-lvl-ok">
<h1 class="log-msg-title">This is a Title</h1><i class="close fa fa-times"></i>
<div class="log-msg-content">This is a message</div>
</div>
@ -28,7 +28,7 @@ Alerts are boxes styled in such a way that they attract the attention of the use
![Alert info](Developer-Guide/frontend/elements/alerts/info.png)
```html
<div class="log-msg log-msg-status-info"><i class="fa fa-bell"></i>This is a info</div>
<div class="log-msg log-lvl-info"><i class="fa fa-bell"></i>This is a info</div>
```
### Warning
@ -36,7 +36,7 @@ Alerts are boxes styled in such a way that they attract the attention of the use
![Alert warning](Developer-Guide/frontend/elements/alerts/warning.png)
```html
<div class="log-msg log-msg-status-warning"><i class="fa fa-exclamation-triangle"></i>This is a warning</div>
<div class="log-msg log-lvl-warning"><i class="fa fa-exclamation-triangle"></i>This is a warning</div>
```
### Error
@ -44,7 +44,7 @@ Alerts are boxes styled in such a way that they attract the attention of the use
![Alert error](Developer-Guide/frontend/elements/alerts/error.png)
```html
<div class="log-msg log-msg-status-error"><i class="fa fa-times"></i>This is an error</div>
<div class="log-msg log-lvl-error"><i class="fa fa-times"></i>This is an error</div>
```

2
general/setup.md
View File

@ -74,7 +74,7 @@ Additional tools and settings coming with the VM:
5. `sitespeed.io ./Build/Helper/Scripts/sitespeedDemoUrls.txt -b chrome --outputFolder /var/www/html/sitespeed`
6. Slow sql query threashold is defined as 0.5s.
<p class="centerText">
<p class="cT">
<img width="150px" tabindex="0" src="./Developer-Guide/general/img/webgrind.jpg"> <img width="150px" tabindex="0" src="./Developer-Guide/general/img/trace_visualizer.jpg"> <img width="150px" tabindex="0" src="./Developer-Guide/general/img/sitespeed.jpg"> <img width="150px" tabindex="0" src="./Developer-Guide/general/img/codecoverage.jpg"> <img width="150px" tabindex="0" src="./Developer-Guide/general/img/coverage_analysis.jpg"> <img width="150px" tabindex="0" src="./Developer-Guide/general/img/metrics.jpg">
</p>

4
general/structure.md
View File

@ -4,7 +4,7 @@ The user request gets passed through the entire application to all modules. The
The routes usually reference endpoints in the module `controllers` which collects the model data through the model `mapper` and creates a partial response `view` with an assigned `template` and the collected model data.
<p class="centerText">
<p class="cT">
<img alt="Application Flow" src="./Developer-Guide/general/app_flow.drawio.svg">
</p>
@ -35,6 +35,6 @@ Furthermore the Application also performs a `CSRF` check, defines the `CSP`, aut
A short extract of the database structure can be seen below. Please note that this only contains the very basic tables from a fresh install with very few modules and even then we only included the key tables for simplicity reasons.
<p class="centerText">
<p class="cT">
<img alt="Application UML" src="./Developer-Guide/general/base_uml.drawio.svg">
</p>

10
phpOMS/application.md
View File

@ -21,10 +21,10 @@ The .htaccess file can be used to enable URL rewriting, file compression for css
## index.php
In the index file the application gets initialized and executed.
In the index file the application gets initialized and executed.
```php
<?php
<?php
declare(strict_types=1);
// index.php
@ -40,14 +40,14 @@ echo $App->run(); // outputs the application response
\ob_end_flush();
```
We use output buffering `\ob_start()` and `\ob_end_flush()` which allows the application to internally modify the response before it gets returned to the user.
We use output buffering `\ob_start()` and `\ob_end_flush()` which allows the application to internally modify the response before it gets returned to the user.
## Application.php
The application file is responsible for initializing the application resources, handling the request and response population (see Router and Dispatcher) as well as rendering the main view. Another task which is often performed in this file is the user authentication.
```php
<?php
<?php
declare(strict_types=1);
// app/Application.php
@ -160,7 +160,7 @@ class Application extends ApplicationAbstract
The routes file contains the routing information. which is responsible for matching URLs to application end-points.
```php
<?php
<?php
declare(strict_types=1);
// app/Routes.php

2
quality/inspections.md
View File

@ -17,7 +17,7 @@ The following automated tests must pass without errors, failures and warnings fo
* `./cOMS/tests/test.sh`
* see [other checks](#other-checks) below
<p class="centerText">
<p class="cT">
<img width="150px" tabindex="0" src="./Developer-Guide/quality/img/webgrind.jpg"> <img width="150px" tabindex="0" src="./Developer-Guide/quality/img/trace_visualizer.jpg"> <img width="150px" tabindex="0" src="./Developer-Guide/quality/img/sitespeed.jpg"> <img width="150px" tabindex="0" src="./Developer-Guide/quality/img/sitespeed_waterfall.jpg"> <img width="150px" tabindex="0" src="./Developer-Guide/quality/img/codecoverage.jpg"> <img width="150px" tabindex="0" src="./Developer-Guide/quality/img/coverage_analysis.jpg"> <img width="150px" tabindex="0" src="./Developer-Guide/quality/img/metrics.jpg"> <img width="150px" tabindex="0" src="./Developer-Guide/quality/img/phpunit_html.jpg"> <img width="150px" tabindex="0" src="./Developer-Guide/quality/img/phpcs.jpg"> <img width="150px" tabindex="0" src="./Developer-Guide/quality/img/phpstan.jpg"> <img width="150px" tabindex="0" src="./Developer-Guide/quality/img/rector.jpg">
</p>

4
security/security_guidelines.md
View File

@ -72,8 +72,8 @@ Javascript can now be included like this:
$head = $response->data['Content']->head;
$nonce = $this->app->appSettings->getOption('script-nonce');
$head->addAsset(AssetType::JSLATE, 'Resources/chartjs/Chartjs/chart.js', ['nonce' => $nonce]);
$head->addAsset(AssetType::JSLATE, 'Modules/ItemManagement/Controller.js', ['nonce' => $nonce, 'type' => 'module']);
$head->addAsset(AssetType::JSLATE, 'Resources/chartjs/Chartjs/chart.js?v=' . $this->app->version, ['nonce' => $nonce]);
$head->addAsset(AssetType::JSLATE, 'Modules/ItemManagement/Controller.js?v=' . self::VERSION, ['nonce' => $nonce, 'type' => 'module']);
```
### X-XSS-Protection

18
standards/documentation.md
View File

@ -188,11 +188,19 @@ In code todos can be created like this
```php
/**
* @todo Multi line todo
* This way developers can see todos directly in the code without going to an external source.
* Todos must not have empty lines in their descriptions.
* If the external ressources have empty lines they must be removed in the todo comment.
* 1. list item 1
* 2. list item 2
* This way developers can see todos directly in the code without going to an external source.
* Todos must not have empty lines in their descriptions.
* If the external resources have empty lines they must be removed in the todo comment.
* 1. list item 1
* 2. list item 2
*/
```
We support and recognize the following todo tags:
* @security For todos which have a strong security impact
* @bug For bugs
* @feature For features that should be implemented
* @performance For ideas/concerns regarding performance
* @todo General todos
* @question Ideas and concerns that need further investigation