REDAXO CodeHints für Adobe Dreamweaver CS3 – CS5

Als ich mich Anfang 2010 erstmalig intensiver mit REDAXO auseinandersetzte, fiel mir schnell eines auf: das zugrundeliegende PHP-Framework ist relativ komplex und wartet mit einer stattlichen Anzahl an z.B. Funktionen und Konstanten auf, die eines gemeinsam haben :: man kann sich besonders als Einsteiger die oft sehr langen Namen schlecht merken, was ein 100%-ig manuelles Coden fehleranfällig macht. Beispiel gefällig ? Wir wär´s mit der Funktion “rex_mediapool_addMediacatOptions” ? ;-)

Da ich und auch einige andere Entwickler ihre REDAXO Templates und Module vorzugsweise mit Adobe Dreamweaver erstellen, habe ich mir die Zeit für intensive Recherche genommen und eine entsprechend umfangreiche CodeHints-Datei für die Dreamweaver-Versionen CS3, CS4 und CS5 zusammengestellt. Diese Datei wurde bereits während der Entwicklungsphase an einige mit REDAXO gut vertraute User verteilt und von ihnen als z.B. “klappt bestens supi sache” bewertet, was ich natürlich gerne zum Anlass nehme, die jeweilige “finale” Version auf dieser Seite ordentlich zu dokumentieren und zum Download anzubieten.

FAQ

Q: Für welchen REDAXO-Entwicklertypus ist diese Datei gedacht ?
A: Für Template-, Module-, und Addons-Entwickler, also eigentlich für alle — hey, da ist mittlerweile sooo viel Krempel eingebaut, dass jeder was davon hat ;-)

Q: Wie installiere ich die CodeHints-Datei in Dreamweaver ?
A: die Datei Redaxo4_2_Core.xml aus dem Download-Archiv entpacken und – unter Windows – in das Vereichnis C:\Programme\Adobe\Adobe Dreamweaver CS3\configuration\CodeHints\ kopieren. Bitte den vorgenannten Pfad für Dreamweaver CS4 bzw. CS5 entsprechend anpassen ;-)

Q: Was passiert danach ?
A: beim nächsten Dreamweaver-Start stehen die REDAXO-CodeHints sofort zu Verfügung und sind in der Code-Ansicht innerhalb und ausserhalb von PHP-Tags wirksam.

Q: Wie kann ich diese CodeHints (vorübergehend) deaktivieren?
A: Menü “Bearbeiten” -> Einstellungen… -> Code Hints. Die CodeHints-Datei ist hier unter dem Namen “REDAXO 4.2.* Code Hints (Core)” eingetragen

Q: wie gehe ich nach dem Download einer neueren Version dieser Datei vor ?
A: die alte Datei im configuration\CodeHints\ – Ordner durch die neue Datei ersetzen, anschliessend Dreamweaver neu starten und im Menü “Bearbeiten” den Befehl “Code Hints aktualisieren” ausführen.

Q: ich kann die Funktion/Konstante xyz aus meiner REDAXO – Vorgängerversion 3.x nicht in der Liste finden ?
A: Dies kann mehrere Gründe haben: a) sie wurde in der aktuellen Version 4.2. als “deprecated” gekennzeichnet, b) sie ist nicht “deprecated”, aber ich habe sie einfach übersehen ;-)

Q: warum wird eine REDAXO-Funktion wie z.B. “array_insert()” nicht aufgeführt ?
A: bei der Konzeption der CodeHints-Datei bzw. der Analyse von z.B. Funktionsnamen habe ich mich auf diejenigen Pattern beschränkt, welche mehr als eine Option haben können, weil Code Hints nur bei einer multiplen Auswahlmöglichkeit Sinn machen. Dies bedeutet natürlich, dass im Endeffekt einige REDAXO-Funktionen bzw. Konstanten nicht berücksichtigt werden konnten.

Q: gibt´s hinsichtlich der Entwicklung der CodeHints – Datei eine Art “Roadmap” ?
A: für die kommende REDAXO-Version 4.3 werde ich wohl aufgrund diverser erwartbarer Änderungen bzw. Neuerungen eine separate CodeHints-Datei anfertigen, aber damit warte ich erstmal lieber ab, bis 4.3 ein offizielles Release hat und dessen Änderungen hinreichend dokumentiert sind.

Q: was ist neu in der aktuellen CodeHints – Datei ?
A: inhaltlich hat sich nix geändert, aber das “Verhalten” der CodeHints ist jetzt logischer :: eine Reihe von Patterns rufen jetzt (dank eines weiteren XML-Menüparameters) die entsprechenden Code Hints nur innerhalb der PHP Start- bzw. End – Tags auf und nicht länger an beliebiger Stelle in Dreamweavers Code-Ansicht — was besonders bei Redaxo´s PHP-Variablen Sinn macht, gelle ? ;-).

Q: und die aktuelle CodeHints – Version ist ?
A: vom 20.05.2010

die CodeHints-Datei herunterladen

Das unter dem folgenden Link herunterladbare ZIP-Archiv enthält die Datei “Redaxo4_2_Core.xml”, welche Sie bitte wie oben beschrieben unter Dreamweaver CS3, CS4 oder CS5 installieren


redaxo4_2_codehints_dreamweaver.zip
Datum: 20.05.2010 01:23 Größe: 8 kB

Erläuterung der implementierten REDAXO Core Konstanten und Variablen

die folgenden Screenshots und Erläuterungen verschaffen Ihnen einen Überblick über die gegenwärtig implementierten Features bzw. deren Funktionsweise.

In diesem Kontext ist ein “Pattern” eine Zeichenfolge, die Sie komplett eintippen müssen, um die entsprechende Code Hints – Liste angezeigt zu bekommen. Bitte beachten Sie, dass die Groß- und Kleinschreibung der Pattern von Bedeutung sind.

CodeHints Pattern: $REX[

das Dreamweaver CodeHints Pattern REX[
Geändert am 28.04.2010 !

Das Pattern $REX[ öffnet eine CodeHints-Liste, welche die entsprechenden REDAXO PHP-Variablen (z.B. $REX['CLANG']) anzeigt.

Die Dreamweaver Auto-Vervollständigung dieses Patterns funktioniert nunmehr wie erwartet, wobei man allerdings darauf achten sollte, selber kein Hochkomma einzugeben, sondern einfach nur - wie auf dem Screenshot gezeigt - den Namen der gewünschten Variable. Nach Bestätigung mit RETURN wird die vollständige Variable syntaktisch korrekt eingetragen.

CodeHints Pattern: $REX_A

das Dreamweaver CodeHints Pattern $REX_A
Geändert am 28.04.2010 !

Dieses Pattern öffnet die Liste der $REX_ACTION[] - Variablengruppe.

Da diese Liste ohnehin nicht so lang ist, habe ich mich in der Listenvorschau für leicht verständliche Begriffe wie "REX_ACTION: CTYPE_ID" entschieden -- am besten scrollen Sie zum gewünschten Eintrag runter und bestätigen mit RETURN, denn auch hier wird die vollständige Variable syntaktisch korrekt eingetragen.

CodeHints Pattern: REX

das Dreamweaver CodeHints Pattern REX
Neu am 28.04.2010 !

Dieses Pattern öffnet die Liste aller REX_... - Konstanten.

CodeHints Pattern: rex

das Dreamweaver CodeHints Pattern rex
Das Pattern rex öffnet eine - naturgemäß ziemlich lange - Liste aller entsprechenden REDAXO-Funktionen


Eine Auto-Vervollständigung ist hier und bei allen im Folgenden erläuterten Pattern problemlos möglich.

CodeHints Pattern: OO

das Dreamweaver CodeHints Pattern OO
Das Pattern OO ermöglicht einen schnellen Zugriff auf die Klassen von REDAXO´s Objekt-Orientiertes Framework. In Übereinstimmung mit dem Cheatsheet für Redaxo Version 4.2 enthält diese CodeHints-Liste sämtliche aktuellen Klassen (OOAddon, OOArticle, OOArticleSlice, OOCategory, OOMedia, OOMediaCategory, OOPlugin) zzgl. deren jeweiligen Klassenmethoden und fügt diese in korrekter Syntax (OOMediaCategory::getCategoryById()) in das Dokument ein.

CodeHints Pattern: add

das Dreamweaver CodeHints Pattern add
Diese Liste enthält eine Kollektion aller mir bekannten REDAXO-Objektmethoden, welche mit add beginnen.

CodeHints Pattern: app

das Dreamweaver CodeHints Pattern app
Diese Liste enthält drei REDAXO-Objektmethoden, welche mit app beginnen.

CodeHints Pattern: co

das Dreamweaver CodeHints Pattern co
Diese Liste enthält die im linken Bild angezeigten Objektmethoden, welche mit co beginnen.

CodeHints Pattern: del

das Dreamweaver CodeHints Pattern del
Diese Liste enthält die im linken Bild angezeigten Objektmethoden, welche mit del beginnen.

CodeHints Pattern: for

das Dreamweaver CodeHints Pattern for
Diese Liste enthält die im linken Bild angezeigten Objektmethoden, welche mit for beginnen.

CodeHints Pattern: get

das Dreamweaver CodeHints Pattern get
eine wesentlich umfangreichere Liste diverser Objektmethoden bekommt man bei Verwendung des Patterns get angezeigt.

CodeHints Pattern: has

das Dreamweaver CodeHints Pattern has
die Liste aller mit has beginnenden Objektmethoden ist wiederum nicht so lang, wofür ich den REDAXO-Programmierern sehr zu Dank verpflichtet bin ;-)

CodeHints Pattern: is

das Dreamweaver CodeHints Pattern is
Diese Liste enthält diverse u.a. im linken Bild angezeigten Objektmethoden, welche mit is beginnen.

CodeHints Pattern: pre

das Dreamweaver CodeHints Pattern pre
Diese Liste enthält die im linken Bild angezeigten Objektmethoden, welche mit pre beginnen.

CodeHints Pattern: rem

das Dreamweaver CodeHints Pattern rem
Diese Liste enthält die im linken Bild angezeigten Objektmethoden, welche mit rem beginnen.

CodeHints Pattern: rep

das Dreamweaver CodeHints Pattern rep
Diese Liste enthält die im linken Bild angezeigten Objektmethoden, welche mit rep beginnen.

CodeHints Pattern: set

das Dreamweaver CodeHints Pattern set
die auf dem Pattern set basierende Liste von Objektmethoden ist wiederum etwas länger.

CodeHints Pattern: to

das Dreamweaver CodeHints Pattern to
Diese Liste enthält die im linken Bild angezeigten Objektmethoden, welche mit to beginnen.

CodeHints Pattern: sql

das Dreamweaver CodeHints Pattern sql
Mit dem Pattern sql verabschieden wir uns von REDAXO´s Objektmethoden und widmen uns den "Version 4" - Methoden der sql - Klasse.

Falls dem/der geneigte(n) Anwender/in meiner CodeHints-Datei auffallen sollte, dass sich hier irrtümlicherweise irgendwelche "deprecated" - Methoden der sql-Klasse der REDAXO-Version 3.x eingeschlichen haben sollten, bitte ich um eine entsprechende Mitteilung,

CodeHints Pattern: ART, CAT, CLA, MED, OUT, PAG

die Dreamweaver CodeHints 'Extension Points' Patterns
die o.g. CodeHints - Patterns beziehen sich auf die entsprechenden REDAXO 4 "Extension Points" und beinhalten folgende Optionen:
  • ART : ART_ADDED ... ART_UPDATED sowie ARTICLE_GENERATED
  • CAT : CAT_ADDED ... CAT_UPDATED
  • CLA : CLANG_ADDED ... CLANG_UPDATED
  • MED : MEDIA_ADDED ... MEDIA_UPDATED
  • OUT : OUTPUT_FILTER sowie OUTPUT_FILTER_CACHE
  • PAG : PAGE_ADDED ... PAGE_TITLE_SHOWN

Artikel-Kommentar
Ihre Emailadresse wird nicht veröffentlicht




Kommentare
Stefan
(15.11.2010 13:30)
Vielen Dank für diese Datei, das macht das Coden mit Redaxo sehr viel komfortabler!