mirror of
https://github.com/kevinveenbirkenbach/infinito.git
synced 2024-12-04 15:06:51 +01:00
Updated documentation
This commit is contained in:
parent
244d26f2f6
commit
463003f029
@ -1,57 +0,0 @@
|
||||
# Brainstorming
|
||||
This document is work in process and just contains some brainstorming ideas.
|
||||
## Interfaces
|
||||
|
||||
### Offered Interfaces
|
||||
- REST ___(JSON, HTML, XML)___
|
||||
- GUI ___(HTML)___
|
||||
- CLI
|
||||
|
||||
### Offered Methods
|
||||
|
||||
| Entity\Action | Create | Read | Update | Delete | Execute | Log | Schema |
|
||||
|-------------------|--------|------|--------|--------|---------|-----|--------|
|
||||
| Source | x | x | x | x | x | x | x |
|
||||
| Right | x | x | x | x | | x | x |
|
||||
| Law | | x | x | | | x | x |
|
||||
| Member Relation | | x | x | | | x | x |
|
||||
| Heredity Relation | | x | x | | | x | x |
|
||||
| Parent Relation | | x | | | | x | x |
|
||||
### Method Description
|
||||
#### Create
|
||||
Creates an entity
|
||||
#### Read
|
||||
Reads an entity
|
||||
#### Update
|
||||
Updates an entity
|
||||
#### Delete
|
||||
Deletes an entity
|
||||
#### Execute
|
||||
Executes an entity
|
||||
#### Log
|
||||
Logs of an entity
|
||||
##### Data
|
||||
- timestamp
|
||||
- client entity
|
||||
- requested entity
|
||||
- requested action
|
||||
|
||||
#### Schema
|
||||
Schema of an entity
|
||||
|
||||
## Entities
|
||||
### Source
|
||||
A source is executable data.
|
||||
|
||||
### Law
|
||||
A law contains rules, how to handle the rights
|
||||
|
||||
### Right
|
||||
A right defines, which client source is allowed to commit an action to a layer of a requested source.
|
||||
### Relations
|
||||
#### Member Relation
|
||||
The member relation describes which sources are members of which other sources.
|
||||
#### Parent Relation
|
||||
Describes which sources had been involved in the creation of sources.
|
||||
#### Heredity Relation
|
||||
Describes from which sources child sources inhere rights.
|
45
GLOSSARY.md
Normal file
45
GLOSSARY.md
Normal file
@ -0,0 +1,45 @@
|
||||
# Glossary
|
||||
## Action
|
||||
Operations, which can be executed on __entities__.
|
||||
## CLI
|
||||
## Client ___Source___
|
||||
## Create ___Action___
|
||||
Creates an __entity__.
|
||||
## Delete ___Action___
|
||||
Deletes an __entity__.
|
||||
## [Doctrine](https://www.doctrine-project.org/)
|
||||
Used for __ORM__ in __infinito__.
|
||||
## Entity
|
||||
An object which can be handled by an __ORM__ tool.
|
||||
## Execute ___Action___
|
||||
Executes the logic to an __entity__.
|
||||
## infinito
|
||||
The name of the project.
|
||||
## GUI
|
||||
## Heredity ___Relation___
|
||||
Describes from which __sources__ ,child __sources__ inhere __rights__.
|
||||
## HTML
|
||||
## JSON
|
||||
## Law ___Entity___
|
||||
A law contains rules, how to handle rights.
|
||||
## Log ___Entity___
|
||||
Logs of an entity
|
||||
## Member ___Relation___
|
||||
The member relation describes which sources are members of which other sources.
|
||||
## ORM
|
||||
[Object-relational mapping](https://de.wikipedia.org/wiki/Objektrelationale_Abbildung) is realized in __infinito__ with __doctrine__.
|
||||
## Parent ___Relation___
|
||||
Describes which __sources__ had been involved in the __creation__ of __sources__. Maybe this can be replaced through the __journal__.
|
||||
## Read ___Action___
|
||||
Reads an __entity__.
|
||||
## Relation ___Entity___
|
||||
## REST
|
||||
## Right ___Entity___
|
||||
A right defines, which __client source__ is allowed to commit an __action__ to a __layer__ of a __requested source__.
|
||||
## Requested ___Source___
|
||||
The __source__ which is requested.
|
||||
## Source ___Entity___
|
||||
A __source__ contains data.
|
||||
## Update ___Action___
|
||||
Updates an __entity__.
|
||||
## XML
|
15
application/symfony/src/Domain/RightManagement/README.md
Normal file
15
application/symfony/src/Domain/RightManagement/README.md
Normal file
@ -0,0 +1,15 @@
|
||||
# Right Management
|
||||
## Operation Matrix
|
||||
The following operations MUST be possible:
|
||||
|
||||
| Layer\Action | Create | Read | Update | Delete | Execute |
|
||||
|-------------------|--------|------|--------|--------|---------|
|
||||
| Source | x | x | x | x | x |
|
||||
| Right | x | x | x | x | |
|
||||
| Law | | x | x | | |
|
||||
| Relation | | x | | | |
|
||||
| Heredity Relation | | x | x | | |
|
||||
| Parent Relation | | x | | | |
|
||||
| Member Relation | | x | x | x | |
|
||||
| Journal | | x | | | |
|
||||
| Log | | x | | x | |
|
Loading…
Reference in New Issue
Block a user