From 36c3c28a66d4f1db060e9534178e0a656f88d06c Mon Sep 17 00:00:00 2001 From: Kevin Frantz Date: Sun, 20 Jan 2019 10:52:30 +0100 Subject: [PATCH] Added README.md for Attribut --- application/symfony/src/Attribut/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 application/symfony/src/Attribut/README.md diff --git a/application/symfony/src/Attribut/README.md b/application/symfony/src/Attribut/README.md new file mode 100644 index 0000000..7a578ca --- /dev/null +++ b/application/symfony/src/Attribut/README.md @@ -0,0 +1,15 @@ +# Attribut +This folder containes the attributs which are used by entity, domain logic etc. +# Structure +Each attribut containes out of an interface and a trait. +## Interface +The interface MUST define a __get-__ and a __set-method__. Optional an interface can define a __has-method__. +### Methods +#### Set +The __setter__ MUST return nothing(void). It SHOULD throw an exception if the value is not valid. +#### Get +The __getter__ MUST return the attribute. Void is not allowed. +#### Has +__has__ must return an boolean. True if the attribut is defined, otherwise false. +## Trait +The trait represents the implementation of the interface. Also it contains an __private__ or __protected__ attribute, which is modified by the methods which are defined in the interface.