Methoden-Templates mit __call() erstellen

| 9 Kommentare

Die magischen Funktionen bei PHP sind wie sicher vieles in der Programmierung eine Geschmacks- oder sogar fast schon eine Glaubensfrage. Die einen lieben sie, die anderen hassen sie. Je nach Verwendung können sie schonmal einen Entwickler in den Wahnsinn treiben, wenn irgendwelche Werte, irgendwie aus dem Nichts kommen und auch wieder dahin verschwinden.

Es gibt aber auch Fälle, in denen die magische Methode __call() den Code lesbarer machen kann und gleichzeitig eine Menge Schreibarbeit einspart.

Stellen wir uns einfach mal vor, wir hätten ein Model mit 20 Werten und wollen es anhand eines bestimmten Feldes laden.

<?php
$model->load($id);  // lädt das Model mit Defaultkey = $id, oder

$model->load('Daniel', 'name');  // Feld 'name' = 'Daniel'

Letzteres ist durchaus gut zu lesen und lädt bestenfalls auch die richtigen Daten. Mit __call() lässt sich das ganze ohne viel Aufwand noch etwas dekorieren, so dass wir das Model dann so laden können:

<?php
$model->loadByName('Daniel');

Nun könnte man entweder für alle 20 Felder die jeweiligen Methoden schreiben, oder eine Art Template mit __call() und eines RegEx erstellen und den Aufruf einfach deligieren.

<?php
class Custom_Model
{
  public function __call($method, $args)
  {
    if (preg_match('/^loadBy([a-zA-Z]*?)$/', $method, $matches))
      return $this->load($args[0], $matches[1]);
    }
    // ...
  }
}

Der Vorteil ist ganz klar die eingesparte Tipparbeit und eine übersichtlichere Klasse, da wir alleine für diese Funktionalität 20 Methoden weniger im Code haben. Jedoch ist auch der Nachteil nicht außer Acht zu lassen. Weil die Methoden nur virtuell existieren, sind sie z.B. für die IDE unsichtbar und sind daher auch für neue Entwickler nicht sofort erkennbar.

Es bleibt also wieder dem eigenen Geschmack überlassen, für welchen Weg man sich entscheidet.

9 Kommentare

  1. Habe mich damit noch nich beschafft, aber sollten phpdoc kommentare nich auch in der Lage sein, virtuelle Methoden und Werte zu beschreiben?
    Falls nich, wäre das auf jeden Fall ein Sinnvoller Featurerequest.

  2. Also bei Zend, denke auch das das bei pdt geht (beides Eclipse), kann man mit phpdoc am klassenkopf “@method string funcname” und “@property string name” Methoden und Eigenschaften hinzufügen.

    /**
    * @property string name
    */
    class …

  3. Ich finde das solche late binding Mechanismen die Lesbarkeit des Codes stark einschränken. Die Kopplungen sind sehr schwer zu erkennen. Vor allem findet sie kein automatisiertes Tool. Die selbe Technik habe ich in diversen CMS Systemen gesehen mit dicken Regexblöcken in __call. Meiner Meinung nach ist das einfach nicht strikt genug und erhöht die Fehlerquellen für einen zu geringen Nutzen.

  4. Nie, Nie, Nie, so was in einem größeren Projekt benutzen. Es gibt IMHO keinen einzigen use-case der so etwas rechtfertigt! Der Verlust an Wartbarkeit ist einfach zu groß. Ich sag dann immer zu meinen Azubis: Faules Mädchen langes Fädchen.

  5. Never Say Never Again.

    Richtig ist, für die IDE’s sind zusätzliche Annotationen notwendig. Richtig ist auch, dass jeder Magic-Call Performance frisst. Hinzu kommt noch der Performanceverlust durch das Namens-Matching mittels Regular-Expressions.

    Die Frage lautet also, wie kann ich Methoden für Models haben, die ich nicht kenne. Antwort: _call.
    Haufenweise Kommentare/Aufregung…. ,)

    Aber wie kann ich die Methodenerstellung und die Annotationserstellung automatisieren und die Wartbarkeit wiederherstellen?

    Sowohl die Annotationen, aber auch die eigentlichen Methoden die über _call aufgerufen werden, kann man automatisch erstellen lassen. Und zwar bei einer erfolgreichen Delegation, denn man kennt den Methodennamen und die Parameter. Diese Angaben kann man verwenden, um mittels Scaffolding (hat auch was mit Methoden-Templates zu tun ,) die Methode selbst zu schreiben!

    Günstig ist folgendes Verfahren: _call() Methode in der Parentklasse unterbringen. Per Scaffolding eine Kindklasse zur Abfrage des Models schreiben und bei erfolgreichen _calls die Methoden in diese Klasse. Dadurch reduzieren sich die Erstellungkosten, die Performancenbremsen werden rausgeworfen, die Wartbarkeit steigt automatisch an und die IDE erkennt nach und nach alle verfügbaren Methoden.

    Gruß Jens

  6. Hehe, hätte mich gewundert, wenn der Artikel nicht derartige Reaktionen hervorgebracht hätte.

    @Jens-André: Dein Ansatz klingt zwar erstmal gut und logisch, dennoch würde ich dann doch lieber vollständige Codegeneration vorziehen, als zur Laufzeit an den Klassen rumzumachen.

    @Harald: Sag das mal den Leuten von Varien/Magento…

  7. Ich seh das wie Harald. Es ist Teufelszeug! Es kostet Dich Performance, Wartbarkeit und Debuggen macht auch kein Spaß. Doctrine1 verwendet es zahlreich und wenn man wirklich mal, weil etwas schief gegangen ist, tracken will, ob es vielleicht einfach nur ein Fehler in Doctrine steckt, dann brauch mal reichlich Geduld.

    @Daniel: von Magento habe ich nicht viel gutes gehört und Deine Aussage unterstützt dieses schlechte Bild, was ich habe, nur.

    OFFTOPIC: Übrigens bin ich mir auch noch nicht wirklich sicher, ob Closures eine gute Erfindung haben. Vermisst habe ich sie vor 5.3 auch nicht wirklich.

  8. man mag ja über doctrine sagen was man will .. aber ich würde doch stark davon ausgehen, dass die nicht einfach nur der laune halber die ganzen magic getter & setter beim umstieg von doctrine1 auf doctrine2 entfernt haben ..

  9. Wir hatten intern gerade vor kurzem bei uns im Geschäft die Diskussion, was die Vorteile/Nachteile von Magic Methoden sind. Danke für die interessanten Kommentare. Ich bin auch eher der Meinung, dass Magic Methoden mehr Probleme schaffen, als das sie helfen.

Hinterlasse eine Antwort

Pflichtfelder sind mit * markiert.


Schlagwörter: A/B-Test, AbstractType, Adapter, AddOn, Administration, Ajax, Amazon, Animation, Annotations, Anonyme Klasse, Ant, Apache, API, Array, ArrayAccess, Attachment, Auftrag, Ausbildung, Auswertung, Authentifizierung, AutoLoader, AWS, Bedienung, Bedingung, Benchmark, Berechtigung, Berlin, Bildbearbeitung, Bildschirmfoto, Blog, Blogroll, BOM, Bootstrap, Bot, Browser, Bugtracker, Byte Order Mark, Bücher, Cache, CakePHP, Call-Center, Callback, CamelCase, Canvas, Captcha, CDN, Cheatsheet, CLI, Clickout, Closure, Cloud, CodeSniffer, Collection, Community, Comparator, Config, Contest, Controller, Converter, CouchDB, Countable, Cronjob, CRUD, CSS, CSV, CustomLibrary, Custom_Model, Daemon, Data Mapper, Datei, Datenbank, Datenstruktur, Datentypen, Dating, Datum, Debug, Decorator, Dekorierer, Design, Design Patterns, Doctrine, Dokumentation, Dump, Duplikat, each, EC2, Eclipse, Email, Entwicklung, Entwurfsmuster, Enum, Erweiterung, Event, Eventhandling, Exception-Handling, Extension, Facebook, Factory, Fallback, Fehler, Fehlermeldung, Filter, Firefox, Flash, flexigrid, Foreach, Formatierung, Formular, Framework, FTP, Funktion, Futon, ga:pi(), Getter, Google Analytics, Hash, Hash-Bang, Header, htaccess, HTML5, htpasswd, HTTP, HTTPS, IDE, If, Implementierung, InnoDB, Interceptor, Interface, Internet Explorer, isset, Iterator, Java, JavaScript, Job, jQuery, Kommentar, Konfiguration, Konsole, Kontrollstruktur, kopieren, kostenlos, Kundenbetreuung, Late Static Binding, Layout, Links, Linux, Listeners, Lizenz, Logging, Löschen, Magento, Magic Methods, Manual, ManyToMany, Marketing, Methode, Model, Monolog, MVC, MySQL, NetBeans, Network, Nirvanix, Objekt, Observable, Observer, OneToMany, Online Tool, OOP, Open Source, Operator, OR-Mapper, Order, ORM, O’Reilly, Parameter, Partnersuche, Passwort, Performance, PHP, php.ini, PHP hates me, phpMyAdmin, PHPUnit, Plugin, Popup, Proxy, Prüfsumme, Prüfung, QR-Code, Qualitätssicherung, Query, Queue, Redesign, Refactoring, Reflection, Request, Response, Responsive Design, Rest-API, Rockstar, Rollback, Routing, S3, Samba, Scheifen, Schleife, Schutz, Screenshot, Secure Shell, Selbstreferenz, Server, Setter, setTimeout, Shop, Sicherheit, Sicherung, Sichtbarkeit, Singleton Pattern, Skin, SOAP, Social Network, Software, Sortierung, Sourcecode, Spam, Speicherproblem, Spickzettel, SPL, Splittest, SSH, SSL, Stammtisch, Statement, static, Statistik, Status, Stellvertreter, Strategy Pattern, Stream, String, Stuttgart, Stylesheet, Subversion, Sun VirtualBox, Support, SVN, Switch, Symfony, Symfony2, Symfony Live, Tag, Template, Template Method, Ternär Operator, Testing, Theme, Thumbnail, Tool, Tour, Tracking, Twig, Twitter, Type-Cast, Ubuntu, Umwandlung, Underscore, unset, Update, Upload, Url, User Story, Validierung, Vererbung, Versionskontrolle, Versionsnummer, Verzweigung, Video, Videospiel, Virtualisierung, Visitor Pattern, Vorschaubild, walk, Warteschlange, Webserver, Webservice, Weiterleitung, Werkzeug, Windows, WindowsAzure, WordPress, Wrapper, Writer, XML, Youtube, Zeitschleife, Zeitsteuerung, Zend Framework, Zend_Application, Zend_Cloud, Zend_CodeGenerator, Zend_Http_Client, Zend_Reflection, Zend_Service, ZPress, Zugangskontrolle, Zugriffsmethode