Jingga/Developer-Guide
1
0
Fork 0
mirror of https://github.com/Karaka-Management/Developer-Guide.git synced 2026-03-07 11:48:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Correctiong/extending

Browse Source
This commit is contained in:
Dennis Eichhorn 2016-12-10 18:29:29 +01:00
parent f871e33c1c
commit a1d10d26ae
5 changed files with 26 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
security/security_guidelines.md
View File

@ -105,7 +105,7 @@ In some cases super globals will even be overwritten by values from these classe
Input validation be implemented on multiple levels.
1. Regex validation in html/javascript by using the `pattern=""` attribute
2. Type hints for method parameters wherever possible.
2. Type hints for method parameters and method returns wherever possible.
3. Making use of the `Validation` classes as much as possible
4. **Don't** sanitize at all! Accept or dismiss.
@ -136,4 +136,4 @@ if(($pathNew = realpath($path)) === false || !Validator::startsWith($pathNew, RO
}
```
This example now is not only checking if the path exists and if it contains a path element, it also makes sure that the path is inside the application root path. You could as easily replace `ROOT_PATH` with `self::MODULE_PATH` and this validation would make sure `$path` only directs within a module.
This example now is not only checking if the path exists and if it contains a path element, it also makes sure that the path is inside the application root path.

6
services/filesystem.md
View File

@ -20,9 +20,9 @@ The file system provides a simple way to handle operations on the file system. S
## Custom Implementations
Custom implementations can be created by implementing the FileSystemInterface. These implementations must get registered in the file system and can be used afterwards as the pre-defined implementations.
Custom implementations can be created by extending the StorageAbstract. These implementations must get registered in the file system and can be used afterwards as the pre-defined implementations.
```
FileSystem::register('custom1', '\implementation\namespace');
FileSystem::env('custom1')->list();
Storage::register('custom1', '\implementation\namespace');
Storage::env('custom1')->list();
```

17
setup/configuration.md
View File

@ -0,0 +1,17 @@
# Configuration
## IDE
### PHPStorm
For uniform code formatting and guidelines import the PHPStorm configuration located in the `Build` repository. The configuration includes the code formatting standards as well as code inspection standards used for PHP, JavaScript, CSS and HTML. Due to the limitations of the IDE not all guidelines can be implemented but provide a good start for further inspections.
## Build
### phpOMS
### cssOMS
### jsOMS
### Modules

3
setup/dev_environment.md
View File

@ -1 +1,2 @@
# Dev Environment
# Dev Environment

4
standards/documentation.md
View File

@ -69,7 +69,7 @@ A function/method documentation MUST be implemented in the following form:
* @param variable_type $param1Name Parameter description
* @param variable_type $param2Name Parameter description
*
* @return return_type
* @return return_type Return description
*
* @since 1.0.0
* @author Your Author 2 <your.second@email.com>
@ -113,7 +113,7 @@ The scss documentation is based on SassDoc, therefore only valid SassDoc comment
// Optional example or more detailed description.
//
// @since 1.0.0
// @author Your Author 2 <your.second@email.com>
// @author Your Author <your.second@email.com>
////
```