Plug:obw:YDownLoader:doc:de

From phpCMS

[edit] YDownLoader Deutsche Dokumentation

Alle Angaben beziehen sich auf die Version 0.00.003 BETA (sollte aber auch mit 0.00.002 zusammen arbeiten.)

Contents 1 YDownLoader Deutsche Dokumentation 1.1 Instalation 1.1.1 Plugs Verzeichnis 1.1.2 Download Verzeichnis 1.1.3 Einbindung in Content Dateien 1.1.3.1 Verfügbare Tags 1.1.3.1.1 Das eigentliche Download Formular 1.1.3.1.2 Benutzer Information 1.1.3.1.3 Der Download Starter 1.2 Die Dateien 1.2.1 ydownloader.php 1.2.2 ydownloader.conf.inc.php 1.2.2.1 Anpassung der Allgemeinen Einstellungen 1.2.2.2 Anpassung des Layouts an eigene Bedürfnisse 1.2.2.3 Anpassung der Fehlermeldungen an eigene Bedürfnisse 1.2.2.4 Anpassung der Aktionsseiten 1.2.3 ydownloader.func.inc.php 1.2.4 Die Projekt ini Dateien 1.2.5 Die Log Formate 1.3 Die Verzeichnisse 1.3.1 Plugin 1.3.2 ini 1.3.3 log 1.3.4 downloader 1.4 Anpassung des CSS 1.4.1 Die benutzten Classen 1.4.1.1 success 1.4.1.2 warning 1.4.1.3 error 1.5 Bekannte Probleme 1.6 Zukünftige Versionen 1.7 Danksagung

[edit] Instalation

Alle meine Plugins arbeiten grunsätzlich nach dem selben Prinzip.

Sie parsen das Feld {CONTENT} nach Tags in dem Format:

<!-- PLUGINNAME PARAMETER -->

Desweiteren bestehen sie aus mindestens 2, meistens allerdings aus 3 Dateien.

Einem Loader, der so heißt wie das Plugin mit der Endung php und den eigentlichen Funktions- und Konfigurationsdateien. Dies ist auch bei YDownLoader nicht anders. Die Details entnehmen sie bitte den folgenden Kapitel der Dokumentation.

[edit] Plugs Verzeichnis

Das Einfügen von YDownLoader ist denkar einfach:

• Plugin Verzeichnis erzeugen
  Im Plugs Verzeichnis wird ein Verzeichnis mit YDownLoader erzeugt und das ZIP dorthinein entpakt.
• Daten Verzeichnis erzeugen
  Am besten im DocumentROOT ein Datenverzeichnis erzeugen, default ist downloader.
• Rechte Setzen Log Verzeichnis
  Das Log Verzeichnis brauch Schreibrechte (665 wenn das nicht reicht 775, und wenn alle Stricke reichen 777, bei *nix Systemen)

[edit] Download Verzeichnis

Hier werden alle Projekte Abgelegt so das Sie heruntergelden werden können. Für jedes Projekt gibt es ein eigenes Unterverzeichnis.

Im laufenden Betrieb wird es also im Download Verzeichnis irdenwann einmal so oder so ähnlich aussehen:

• download
  • projekt1
    • project1_0.00.001.zip
    • project1_0.00.002.zip
    • project1_0.01.000.zip
    • project1_1.00.000.zip
  • project2
    • project2_0.00.001.zip
  • project3
    • project3_0.00.001.zip
    • project3_0.01.000.zip

Die aktuell verfügbare Version unterstützt augenblicklich nur ein Dateiformat pro Projekt.

[edit] Einbindung in Content Dateien

Die einbindung des Plugin ist denkbar einfach. Das Plugin wird als dynamisches Plugin eingebunden.

{PLUGIN FILE="$plugindir/ydownloader/ydownloader.php" TYPE="DYNAMIC"}

[edit] Verfügbare Tags

[edit] Das eigentliche Download Formular

<!-- YDOWNLOADER projekt -->

[edit] Benutzer Information

<!-- YDOWNLOADER_INFO -->

[edit] Der Download Starter

<!-- YDOWNLOADER_DOIT -->

[edit] Die Dateien

Dieses Plugin benutzt einige Dateien, zum einen besteht es aus drei PHP Dateien und dazu kommt für jedes Projekt eine INI Datei.

Damit man die Übersicht nicht verliert, gibt es noch ein paar Logdateien, für jedes Projekt eine *.details.log und für die globale Übersicht counter.log

[edit] ydownloader.php

Diese Datei wird als Plugin in eine Contentdatei Eingebunden.

In Ihr werden, alle Pfadkonstanten definiert, die anderen PHP Dateien nachgeladen und die Generierung der Tags gestarted.

Um sicher zustellen das dieses Plugin nicht von anderen Plugins gestört wird, bzw. stört, beginnen alle Parameter, die per Formular, bzw. http-get, übergeben werden mit folgendem String ydownloader_.

[edit] ydownloader.conf.inc.php

Grundsätzlich sind alle Parameter die zur Konfiguration notwendig sind, hier abgelegt.

Nur die Fehlermeldungen sind als globales Array angelegt.

[edit] Anpassung der Allgemeinen Einstellungen

• YDOWNLOADER_CONF
  Wurde die Konfiguration schon geladen oder nicht.
• YDOWNLOADER_FORM_ORDER
  In welcher Reihenfolge sollen die einzeilnen Informationsteile eines Downloadformulars dargestellt werden.
  folgende Informationsfelder sind bisher implementiert:
  • project
    Übergabe des Projektes als Hidden
  • desc
    Beschreibung
  • viewname
    Name des Projektes
  • version
    Ausgabe aller Versionen als Select
  • lincence
    Ausgabe des Lizenz Types und der dazu gehörenden Informationen, inkl. Link zum Lizenztext
  • checklicence
    Checkbox zum bestätigen der Lizenz
  • goback
    Wohin soll im Erfolgsfalle gegangen werden als Hidden
• YDOWNLOADER_SCRIPT
  Welche Seite soll aufgerufen werden, für den Download. (siehe auch <!-- YDOWNLOADER_DOIT --> Der Download Starter)

[edit] Anpassung des Layouts an eigene Bedürfnisse

[edit] Anpassung der Fehlermeldungen an eigene Bedürfnisse

[edit] Anpassung der Aktionsseiten

[edit] ydownloader.func.inc.php

[edit] Die Projekt ini Dateien

[edit] Die Log Formate

[edit] Die Verzeichnisse

[edit] Plugin

[edit] ini

[edit] log

[edit] downloader

[edit] Anpassung des CSS

[edit] Die benutzten Classen

[edit] success

[edit] warning

[edit] error

[edit] Bekannte Probleme

[edit] Zukünftige Versionen

Nach dem Cleanup zur Version 0.00.003 wird an dieser Version nicht weiter entwickelt!

Die nächste Version wird zusammen mit einer der nächsten Version von phpCMS vorraussichtlich 1.3 veröffentlicht. Da diese Version komplett auf das PluginToolKit dieser Version setzen wird.

[edit] Danksagung

Meiner Frau danke ich das Sie da ist und es erträgt wenn es mal wieder etwas später wird.

Meinen Kindern für die Freude die sie uns schenken.

---

Dann dem phpCMS Team für die tolle Arbeit die sie leisten.

Insbesondere Mycra für die geniale initial Zündung und Bernhard Grün für das hosten des gesamten phpCMS Projektes. --obw 11:58, 20 Nov 2004 (CET)