mirror of
https://github.com/kevinveenbirkenbach/infinito.git
synced 2024-12-04 23:17:19 +01:00
Optimized documentation of sources
This commit is contained in:
parent
7951b84a2a
commit
e65568bcb5
@ -13,7 +13,7 @@ This software should offer a cloud based application\\framework for GUI and REST
|
||||
- Support of mixtures between executables and data
|
||||
- Versioning of every state of the used data
|
||||
- Automized transparency for users about their data and use
|
||||
- Expanding the standard program paradigma of classes and objects through sources
|
||||
- Expanding the standard program paradigma of classes and objects through [sources](application/symfony/src/Entity/Source/README.md);
|
||||
- Implementation of all big standard applications via API to manage them over one interface
|
||||
- High scalability (IaaS compatible)
|
||||
|
||||
|
BIN
application/symfony/src/Entity/.meta/uml.dia
Normal file
BIN
application/symfony/src/Entity/.meta/uml.dia
Normal file
Binary file not shown.
BIN
application/symfony/src/Entity/.meta/uml.png
Normal file
BIN
application/symfony/src/Entity/.meta/uml.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 216 KiB |
9
application/symfony/src/Entity/README.md
Normal file
9
application/symfony/src/Entity/README.md
Normal file
@ -0,0 +1,9 @@
|
||||
# Entity
|
||||
This namespace uses [Doctrine ORM](https://www.doctrine-project.org/projects/doctrine-orm/en/2.6/reference/working-with-objects.html).
|
||||
|
||||
## UML
|
||||
The following [UML diagram](https://de.wikipedia.org/wiki/Unified_Modeling_Language) shows on an abstract way how the entities are organized.
|
||||
![Entity UML](.meta/uml.png)
|
||||
|
||||
## See
|
||||
Also check out the [Source README.md](Source/README.md).
|
25
application/symfony/src/Entity/Source/README.md
Normal file
25
application/symfony/src/Entity/Source/README.md
Normal file
@ -0,0 +1,25 @@
|
||||
# Source
|
||||
Entities are the core component of infinito.
|
||||
## Purpose
|
||||
The whole domain logic just processes sources. This allows a high layer of abstraction.
|
||||
### Functions
|
||||
- Heritage values from other sources
|
||||
- Connect data of APIS, executable, and static documents
|
||||
- High scalability of rights
|
||||
- Versioning of every state of a source
|
||||
- Process different kinds of types through a identical core of domain logic.
|
||||
- Easy to modify and to expand
|
||||
|
||||
## UML
|
||||
The following UML shows the context of source entities.
|
||||
![Entity UML](../.meta/uml.png)
|
||||
|
||||
## Types
|
||||
### Primitive
|
||||
Just contain one MySql native data type.
|
||||
### Complex
|
||||
Contain out of other sources. E.g. primitives and executables.
|
||||
#### Executable
|
||||
Process information. They have a seperat class with logic, which is automaticly loaded and processed by the domain logic.
|
||||
##### API
|
||||
API sources adapt CRUD actions to other services.
|
Loading…
Reference in New Issue
Block a user