CakePHP Konventionen¶

Konventionen der Datei- und Klassennamen¶

Üblicherweise werden in Dateinamen unterstriche verwendet, während Klassennamen zusammenhängend Gross/Klein geschrieben sind. Die Klasse KissesAndHugsController kann zum Beispiel in der Datei kisses_and_hugs_controller.php gefunden werden.

Der Name der Klasse die sich in einer Datei befindet, muss sich nicht zwangsweise in dem Dateinamen wiederfinden. Die Klasse EmailComponent befindet sich in der Datei mit dem Namen email.php, und die Klasse HtmlHelper befindet sich in der Datei html.php.

Hier sind einige Beispiele, wie Dateien für die verschiedenen Klassen-Typen typischerweise in einer CakePHP Applikation benannt werden:

• Die Controller-Klasse KissesAndHugsController liegt in der Datei namens kisses_and_hugs_controller.php (beachte _controller im Dateinamen)

• Die Component-Klasse MyHandyComponent liegt in der Datei namens my_handy.php

• Die Model-Klasse OptionValue liegt in der Datei namens option_value.php

• Die Behavior-Klasse EspeciallyFunkableBehavior liegt in der Datei namens especially_funkable.php

• Die View-Klasse SuperSimpleView liegt in der Datei namens super_simple.php

• Die Helper-Klasse BestEverHelper liegt in der Datei namens best_ever.php

Jede Datei liegt inner- oder unterhalb (in einem Unterverzeichnis) des entsprechenden Verzeichnisses im app-Ordner.

Model and Database Conventions¶

Namen von Model-Klassen sind im Singular und GemischtKleinGross geschrieben.

Person, BigPerson, und ReallyBigPerson sind Beispiele für Klassennamen, die den Konventionen entsprechen.

Die Namen der Tabellen zu den Model-Klassen sind im Plural, mit Unterstrichen und klein geschrieben. Die Tabellen zu den oben genannten Modellen wären also people, big_people, and really_big_people.

Foreign-keys in hasMany-, belongsTo- oder hasOne-Beziehungen werden per default erkannt an dem Namen (im Singular) des entsprechenden Modells gefolgt von _id. Als Beispiel nehmen wir die Beziehung: baker hasMany cakes. In der cakes-Tabelle gibt es dann eine foreign-key-Spalte baker_id die den baker referenziert.

Verknüpfungs-Tabellen, wie sie in hasAndBelongsToMany-Beziehungen (HABTM) benötigt werden, sollten benannt werden, in dem die Namen der verknüpften Modell-Tabellen in alphabetischer Reihenfolge und durch Unterstrich verbunden werden (apples_zebras statt zebras_apples)

.

Alle Tabellen, mit denen CakePHP-Modelle interagieren, müssen eine Spalte mit einem primary key haben damit jede Zeile der Tabelle identifiziert werden kann. Solltest Du eine Tabelle benötigen, die keine solche Spalte hat, wie z.B. die Verknüpfungs-Tabelle posts_tags, so wird nach der CakePHP-Konvention ein primary key zu der Tabelle hinzugefügt.

CakePHP unterstützt keine composite primary keys. Wenn du die Join-Tabelle direkt bearbeiten willst, benutze query - Aufrufe oder füge einen primary key zu der Tabelle hinzu und arbeite auf ihr wie mit einem normalen Modell. Z.B.:

CREATE TABLE posts_tags (
id INT(10) NOT NULL AUTO_INCREMENT,
post_id INT(10) NOT NULL,
tag_id INT(10) NOT NULL,
PRIMARY KEY(id));

Controller Conventions¶

Controller Klassennamen sind im Plural, CamelCased (GroßKleinSchreibung) und enden in Controller. PeopleController und LatestArticlesController sind beides Beispiele von konventionellen Controller-Namen.

Die erste Methode, die du für einen Controller schreibst wird sicherlich die index() Methode sein. Falls eine Anfrage einen Controller aber keine Action beschreibt, führt CakePHP standardmäßig die index() Methode des Controllers aus. Beispielsweise führt die Anfrage der URL http://www.example.com/apples/ zum Aufruf der index() Methode des ApplesController, wobei http://www.example.com/apples/view/ die view() Methode des ApplesController aufruft.

Du kannst auch die Sichtbarkeit von Controller Methoden in CakePHP verändern, indem du die Controller-Methoden um Unterstriche ergänzt, dann wird die Methode nicht mehr direkt über das Web, aber für interne Zwecke weiterhin zugänglich. Ein kleines Beispiel:

<?php
class NewsController extends AppController {

    function latest() {
        $this->_findNewArticles();
    }

    function _findNewArticles() {
        //Logic to find latest news articles
    }
}

?>

Während die Seite http://www.example.com/news/lates/ weiterhin für den User normal erreichbar ist, bekommt jemand, der die Seite http://www.example.com/news/_findNewArticles/ einen Fehler erhalten, weil die Methode mit einem Unterstrich versehen wurde.

View Konventionen¶

Die Vorlagendateien (template) der Views werden nach den Controllerfunktionen die sie anzeigen - die Wörter werden durch Unterstriche getrennt - benannt. Für die Funktion getReady() des PeopleController würde die Viewvorlage /app/views/people/get_ready.ctp erwartet werden.

Das Muster für die Vorlagendateien ist ganz einfach: /app/views/controller/funktions_name_mit_unterstrichen.ctp.

Indem du die Dateien und Klassen deiner Applikation nach den CakePHP Konventionen benennst, bekommst du schnell und einfach eine funktionierendes System ohne in Konfigurationen wühlen zu müssen. Hier noch ein abschließendes Beispiel um die Konventionen zu festigen:

• Tabelle in der Datenbank: „people“

• Modellklasse: „Person“, in der Datei /app/models/person.php

• Kontrollerklasse: „PeopleController“, in der Datei /app/controllers/people_controller.php

• Viewvorlage in der Datei /app/views/people/index.ctp

Wenn man diese Konventionen befolgt, dann weiß CakePHP das eine Anfrage an die Adresse http://example.com/people/ einen Aufruf der Funktion index() des PeopleController bedeutet. Weiterhin wird das Modell von Person (welches an die Datenbanktabelle people gebunden ist) automatisch verfügbar gemacht und das Ergebnis mit der Viewvorlage /app/views/people/index.ctp ausgegeben. Diese Zusammenhänge wurden vollautomatisch erstellt und müssen nicht von Hand erzeugt werden.

Nachdem dir die Grundlagen von CakePHP bekannt sind, kannst du dich am CakePHP Blog Tutorial versuchen und sehen wie das ganze in der Praxis funktioniert.