README.md
# Object Data Accessor (ODA)
[](https://php.net/)
[](https://packagist.org/packages/phoenixrvd/oda)
[](https://packagist.org/packages/phoenixrvd/oda)
[](https://packagist.org/packages/phoenixrvd/oda)
[](https://travis-ci.org/phoenixrvd/oda)
[](https://codeclimate.com/github/phoenixrvd/oda)
[](https://styleci.io/repos/87853601)
[](https://codeclimate.com/github/phoenixrvd/oda/coverage)
[](https://bettercodehub.com/results/phoenixrvd/oda)
[](https://packagist.org/packages/phoenixrvd/oda)
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
- [Features](#features)
- [Installation](#installation)
- [Basics](#basics)
- [IDE-Helper](#ide-helper)
- [Standard-Accessoren](#standard-accessoren)
- [Eigene-Accessoren](#eigene-accessoren)
- [Beispiel](#beispiel)
- [Hinweis](#hinweis)
- [Testing](#testing)
- [Copyright and license](#copyright-and-license)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
## Features
* Vereinfacht das Nutzen von Datenhaltungsobjekten.
* Erhöht die Lesbarkeit von Quellcode, durch das Minimieren von LOC.
* Standardisiert DAO-Schicht mit einem kleinem Package, ohne große Frameworks.
## Installation
Bei der Installation ist [Composer](https://getcomposer.org/download/) vorausgesetzt.
```bash
composer require phoenixrvd/oda
```
## Basics
Angenommen, braucht man ein ein Objekt, welches genau 2 Datenfelder hat (foo und bar).
Deklariert man Standard-Methoden, wird das Objekt wie Folgt aussehen:
```php
<?php
class MyDataObject {
private $data = [];
public function getFoo(){
return $this->data['foo'];
}
public function setFoo($value){
$this->data['foo'] = $value;
return $this;
}
public function hasFoo(){
return isset($this->data['foo']);
}
public function isFoo($value){
return $this->hasFoo() && $this->data['foo'] === $value;
}
public function getBar(){
return $this->data['bar'];
}
public function setBar($value){
$this->data['bar'] = $value;
return $this;
}
public function hasBar(){
return isset($this->data['bar']);
}
public function isBar($value){
return $this->hasBar() && $this->data['bar'] === $value;
}
}
```
Hätte man nicht 2 sondern 10 Properties, wird das Object gleich um 300 LOC länger.
Nutzt man das Packet, bekommt man gleiche Funktionalität wesentlich kompakter. Auch wenn anzahl von Datenfelder wächst,
vergrößert man nicht den Code-Basis.
Im Beispiel Unten ist vorheriges Objekt umgeschrieben:
```php
<?php
use PhoenixRVD\ODA\Interfaces\OdaObject;
use PhoenixRVD\ODA\Traits\DataAccessors;
use PhoenixRVD\ODA\Traits\ValueObject;
class MyDataObject implements OdaObject {
use ValueObject, DataAccessors;
}
```
## IDE-Helper
Damit die IDE auch alle Objekt-Methoden kennt und man Autovervollständigung nutzen kann, sollte man die Methoden
in der Klasse-Signatur festlegen.
Es ist aber immer noch kompakter als vorher.
```php
<?php
/**
* @method $this setFoo(mixed $value)
* @method string getFoo()
* @method bool isFoo(mixed $value)
* @method bool hasFoo()
*
* @method $this setBar(mixed $value)
* @method string getBar()
* @method bool isBar(mixed $value)
* @method bool hasBar()
*/
```
## Standard-Accessoren
Standard-Präfixes:
| Präfix | Beschreibung |
|---------------|-------------------------------------------------------------------------------------------|
| **get** | Gibt Wert eines Feldes zurück |
| **set** | Setzt Wert eines Feldes |
| **is(value)** | Prüftob Wert exakt dem ```value``` Parameter entspricht (Vergleich mit ```===```) |
| **has** | Prüft ob das Objekt ein Feld für Daten enthält (Equivalent: ```isset($array['value'])```) |
| **asJSON** | Gibt Wert eines Feldes als formatiertes JSON-String zurück. |
## Eigene-Accessoren
Manchmal braucht man, dass bestimmte Felder eines Objektes formatiert zurückgegeben werden.
Z.b. ```$this->data['created_at']``` ist Unix-Timestamp, man braucht es aber als RFC822-Datum.
Im [Bespiel](#beispiel) ist beschrieben, wie man der API ein **date** - Accessor beibringt. Damit wird voll automatisch
Unix-Timestamp nach Datum konvertieren und man es mit ```$this->dateCreatedAt()``` überall verwenden kann.
### Beispiel
1. Accessor-Klasse anlegen
```php
<?php
use PhoenixRVD\ODA\Methods\AbstractMethod;
use PhoenixRVD\ODA\Interfaces\OdaObject;
class DateRFC822 extends AbstractMethod {
public function execute(OdaObject $object, array $attributes = array()) {
$data = $object->getData();
return date(DATE_RFC822, $data[ $this->propertyName ]);
}
}
```
2. Trait für Wiederverwendbarkeit anlegen
```php
<?php
use PhoenixRVD\ODA\MethodFactory;
trait MyObjectDecorator {
public function __call($name, $arguments) {
return (MethodFactory::getInstance())
->setAccessor(new DateRFC822) // Eigenes Accessor bei der Factory registrieren
->makeMethod($name)
->execute($this, $arguments);
}
}
```
3. Eigenes Trait an Stelle von Standard-Trait im Object verwenden.
```php
<?php
use PhoenixRVD\ODA\Interfaces\OdaObject;
use PhoenixRVD\ODA\Traits\ValueObject;
class MyDataObject implements OdaObject {
use ValueObject, MyObjectDecorator;
}
```
4. Einfach die Methode aufrufen
```php
<?php
// Ausgabe: Tue, 11 Apr 2017 21:22:14 +0000
echo (new MyDataObject())->setCreatedAt(1491945734)->dateCreatedAt();
```
## Hinweis
Projekte, die auf sehr hohe Leistung ausgelegt sind, sollten auf die Methodik generell verzichten. Diskussion dazu findet man
[hier](http://stackoverflow.com/questions/3330852/get-set-call-performance-questions-with-php).
## Testing
```bash
composer oda:test
```
## Copyright and license
Code released under the [MIT License](LICENSE).