Jingga/phpOMS
1
0
Fork 0
mirror of https://github.com/Karaka-Management/phpOMS.git synced 2026-01-11 17:58:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix default respone generation

Browse Source
This commit is contained in:
Dennis Eichhorn 2023-07-26 09:18:05 +00:00
parent 83a36c1c66
commit e91e5fd405
2 changed files with 124 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Localization/BaseStringL11n.php
View File

@ -44,6 +44,7 @@ class BaseStringL11n implements \JsonSerializable
// maybe we can always use $type and remove $name.
// This would require some smart mapper adjustment where the name is part of the l11n model,
// maybe use the path definition in the mapper which is used by arrays (e.g. type/name)
// More maybe: $name might have been intended as internal value? -> Makes no sense because only string
public ?BaseStringL11nType $type = null;
/**

124
Module/ModuleAbstract.php
View File

@ -199,6 +199,13 @@ abstract class ModuleAbstract
/**
* Fills the response object
*
* The response object contains the following data:
*
* * status = Response status
* * title = Response title (e.g. for frontend reporting)
* * message = Response message (e.g. for frontend reporting)
* * response = Response object (e.g. for validation/frontend reporting/form validation)
*
* @param RequestAbstract $request Request
* @param ResponseAbstract $response Response
* @param string $status Response status
@ -231,6 +238,13 @@ abstract class ModuleAbstract
/**
* Create standard model create response.
*
* The response object contains the following data:
*
* * status = Response status
* * title = Response title (e.g. for frontend reporting)
* * message = Response message (e.g. for frontend reporting)
* * response = Response object (e.g. for validation/frontend reporting/form validation)
*
* @param RequestAbstract $request Request
* @param ResponseAbstract $response Response
* @param mixed $obj Response object
@ -257,6 +271,13 @@ abstract class ModuleAbstract
/**
* Create standard model update response.
*
* The response object contains the following data:
*
* * status = Response status
* * title = Response title (e.g. for frontend reporting)
* * message = Response message (e.g. for frontend reporting)
* * response = Response object (e.g. for validation/frontend reporting/form validation)
*
* @param RequestAbstract $request Request
* @param ResponseAbstract $response Response
* @param mixed $obj Response object
@ -283,6 +304,13 @@ abstract class ModuleAbstract
/**
* Create standard model delete response.
*
* The response object contains the following data:
*
* * status = Response status
* * title = Response title (e.g. for frontend reporting)
* * message = Response message (e.g. for frontend reporting)
* * response = Response object (e.g. for validation/frontend reporting/form validation)
*
* @param RequestAbstract $request Request
* @param ResponseAbstract $response Response
* @param mixed $obj Response object
@ -309,6 +337,13 @@ abstract class ModuleAbstract
/**
* Create standard model remove response.
*
* The response object contains the following data:
*
* * status = Response status
* * title = Response title (e.g. for frontend reporting)
* * message = Response message (e.g. for frontend reporting)
* * response = Response object (e.g. for validation/frontend reporting/form validation)
*
* @param RequestAbstract $request Request
* @param ResponseAbstract $response Response
* @param mixed $obj Response object
@ -335,6 +370,13 @@ abstract class ModuleAbstract
/**
* Create standard model return response.
*
* The response object contains the following data:
*
* * status = Response status
* * title = Response title (e.g. for frontend reporting)
* * message = Response message (e.g. for frontend reporting)
* * response = Response object (e.g. for validation/frontend reporting/form validation)
*
* @param RequestAbstract $request Request
* @param ResponseAbstract $response Response
* @param mixed $obj Response object
@ -361,6 +403,13 @@ abstract class ModuleAbstract
/**
* Create standard model relation add response.
*
* The response object contains the following data:
*
* * status = Response status
* * title = Response title (e.g. for frontend reporting)
* * message = Response message (e.g. for frontend reporting)
* * response = Response object (e.g. for validation/frontend reporting/form validation)
*
* @param RequestAbstract $request Request
* @param ResponseAbstract $response Response
* @param mixed $obj Response object
@ -387,6 +436,13 @@ abstract class ModuleAbstract
/**
* Create invalid model create response.
*
* The response object contains the following data:
*
* * status = Response status
* * title = Response title (e.g. for frontend reporting)
* * message = Response message (e.g. for frontend reporting)
* * response = Response object (e.g. for validation/frontend reporting/form validation)
*
* @param RequestAbstract $request Request
* @param ResponseAbstract $response Response
* @param mixed $obj Response object
@ -413,6 +469,13 @@ abstract class ModuleAbstract
/**
* Create invalid model update response.
*
* The response object contains the following data:
*
* * status = Response status
* * title = Response title (e.g. for frontend reporting)
* * message = Response message (e.g. for frontend reporting)
* * response = Response object (e.g. for validation/frontend reporting/form validation)
*
* @param RequestAbstract $request Request
* @param ResponseAbstract $response Response
* @param mixed $obj Response object
@ -439,6 +502,13 @@ abstract class ModuleAbstract
/**
* Create invalid model delete response.
*
* The response object contains the following data:
*
* * status = Response status
* * title = Response title (e.g. for frontend reporting)
* * message = Response message (e.g. for frontend reporting)
* * response = Response object (e.g. for validation/frontend reporting/form validation)
*
* @param RequestAbstract $request Request
* @param ResponseAbstract $response Response
* @param mixed $obj Response object
@ -466,6 +536,13 @@ abstract class ModuleAbstract
/**
* Create invalid model relation remove response.
*
* The response object contains the following data:
*
* * status = Response status
* * title = Response title (e.g. for frontend reporting)
* * message = Response message (e.g. for frontend reporting)
* * response = Response object (e.g. for validation/frontend reporting/form validation)
*
* @param RequestAbstract $request Request
* @param ResponseAbstract $response Response
* @param mixed $obj Response object
@ -492,6 +569,13 @@ abstract class ModuleAbstract
/**
* Create invalid model return response.
*
* The response object contains the following data:
*
* * status = Response status
* * title = Response title (e.g. for frontend reporting)
* * message = Response message (e.g. for frontend reporting)
* * response = Response object (e.g. for validation/frontend reporting/form validation)
*
* @param RequestAbstract $request Request
* @param ResponseAbstract $response Response
* @param mixed $obj Response object
@ -518,6 +602,13 @@ abstract class ModuleAbstract
/**
* Create invalid model relation create response.
*
* The response object contains the following data:
*
* * status = Response status
* * title = Response title (e.g. for frontend reporting)
* * message = Response message (e.g. for frontend reporting)
* * response = Response object (e.g. for validation/frontend reporting/form validation)
*
* @param RequestAbstract $request Request
* @param ResponseAbstract $response Response
* @param mixed $obj Response object
@ -544,6 +635,13 @@ abstract class ModuleAbstract
/**
* Create invalid model permission response.
*
* The response object contains the following data:
*
* * status = Response status
* * title = Response title (e.g. for frontend reporting)
* * message = Response message (e.g. for frontend reporting)
* * response = Response object (e.g. for validation/frontend reporting/form validation)
*
* @param RequestAbstract $request Request
* @param ResponseAbstract $response Response
* @param mixed $obj Response object
@ -587,6 +685,10 @@ abstract class ModuleAbstract
/**
* Create a model
*
* 1. Execute pre DB interaction event
* 2. Create model in DB
* 3. Execute post DB interaction event (e.g. generates an audit log)
*
* @param int $account Account id
* @param mixed $obj Response object
* @param string | \Closure $mapper Object mapper
@ -626,6 +728,10 @@ abstract class ModuleAbstract
/**
* Create a model
*
* 1. Execute pre DB interaction event
* 2. Create model in DB
* 3. Execute post DB interaction event (e.g. generates an audit log)
*
* @param int $account Account id
* @param array $objs Response object
* @param string | \Closure $mapper Object mapper
@ -667,6 +773,10 @@ abstract class ModuleAbstract
/**
* Update a model
*
* 1. Execute pre DB interaction event
* 2. Update model in DB
* 3. Execute post DB interaction event (e.g. generates an audit log)
*
* @param int $account Account id
* @param mixed $old Response object old
* @param mixed $new Response object new
@ -707,6 +817,10 @@ abstract class ModuleAbstract
/**
* Delete a model
*
* 1. Execute pre DB interaction event
* 2. Delete model in DB
* 3. Execute post DB interaction event (e.g. generates an audit log)
*
* @param int $account Account id
* @param mixed $obj Response object
* @param string | \Closure $mapper Object mapper
@ -746,6 +860,10 @@ abstract class ModuleAbstract
/**
* Create a model relation
*
* 1. Execute pre DB interaction event
* 2. Create model relation in DB
* 3. Execute post DB interaction event (e.g. generates an audit log)
*
* @param int $account Account id
* @param mixed $rel1 Object relation1 (parent object)
* @param mixed $rel2 Object relation2
@ -786,7 +904,11 @@ abstract class ModuleAbstract
}
/**
* Create a model relation
* Delete a model relation
*
* 1. Execute pre DB interaction event
* 2. Delete model in DB
* 3. Execute post DB interaction event (e.g. generates an audit log)
*
* @param int $account Account id
* @param mixed $rel1 Object relation1