diff --git a/security/security_guidelines.md b/security/security_guidelines.md index 6941de3..2b42350 100644 --- a/security/security_guidelines.md +++ b/security/security_guidelines.md @@ -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. \ No newline at end of file +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. \ No newline at end of file diff --git a/services/filesystem.md b/services/filesystem.md index 12c959e..28f7093 100644 --- a/services/filesystem.md +++ b/services/filesystem.md @@ -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(); ``` \ No newline at end of file diff --git a/setup/configuration.md b/setup/configuration.md index e69de29..b13e42b 100644 --- a/setup/configuration.md +++ b/setup/configuration.md @@ -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 \ No newline at end of file diff --git a/setup/dev_environment.md b/setup/dev_environment.md index 7f4ac05..7dbb16d 100644 --- a/setup/dev_environment.md +++ b/setup/dev_environment.md @@ -1 +1,2 @@ -# Dev Environment \ No newline at end of file +# Dev Environment + diff --git a/standards/documentation.md b/standards/documentation.md index a4391e5..1c0078e 100644 --- a/standards/documentation.md +++ b/standards/documentation.md @@ -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 @@ -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 +// @author Your Author //// ```