README

Features
Installation
Basics
IDE-Helper
Standard-Accessoren
Eigene-Accessoren
- Beispiel
Hinweis
Testing
Copyright and license

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 vorausgesetzt.

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

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

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 

/**
 * @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 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

Accessor-Klasse anlegen

<?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 ]);
    }
}

Trait für Wiederverwendbarkeit anlegen

<?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);
   }

}

Eigenes Trait an Stelle von Standard-Trait im Object verwenden.

<?php

use PhoenixRVD\ODA\Interfaces\OdaObject;
use PhoenixRVD\ODA\Traits\ValueObject;

class MyDataObject implements OdaObject {

    use ValueObject, MyObjectDecorator;

}

Einfach die Methode aufrufen

<?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.

Testing

composer oda:test

Copyright and license

Code released under the MIT License.

phoenixrvd / oda

Maintainers

Details