commit 61f9ce4ed81127d2827d8b54dd50dffac7033f43
parent d4ddb43b08c7be0f929aba63de60c9a77902f407
Author: dankert <devnull@localhost>
Date: Fri, 6 Nov 2009 09:53:51 +0100
Besser kommentiert.
Diffstat:
1 file changed, 60 insertions(+), 12 deletions(-)
diff --git a/serviceClasses/Publish.class.php b/serviceClasses/Publish.class.php
@@ -19,35 +19,83 @@
#
/**
- * Diese Klasse kapselt das Ver�ffentlichen von Dateien.<br>
+ * Diese Klasse kapselt das Veroeffentlichen von Dateien.<br>
* <br>
* Hier werden<br>
* - Dateien in das Zielverzeichnis kopiert<br>
- * - Dateien per FTP ver�ffentlicht<br>
- * - Zielverzeichnisse aufger�umt<br>
- * - Systembefehle ausgef�hrt.
+ * - Dateien per FTP veroeffentlicht<br>
+ * - Zielverzeichnisse aufgeraeumt<br>
+ * - Systembefehle ausgefuehrt.
*
- * @author $Author$
- * @version $Revision$
+ * @author Jan Dankert
* @package openrat.services
*/
class Publish
{
+ /**
+ * Enthaelt bei Bedarf das FTP-Objekt. Nämlich dann, wenn
+ * zu einem FTP-Server veroeffentlicht werden soll.
+ * @var Object
+ */
var $ftp;
+
+ /**
+ * Flag, ob in das lokale Dateisystem veroeffentlicht werden soll.
+ * @var boolean
+ */
var $with_local = false;
+
+ /**
+ * Flag, ob zu einem FTP-Server veröffentlicht werden soll.
+ * @var boolean
+ */
var $with_ftp = false;
+
var $local_destdir = '';
+
+ /**
+ * Enthaelt die gleichnamige Einstellung aus dem Projekt.
+ * @var boolean
+ */
var $content_negotiation = false;
+
+ /**
+ * Enthaelt die gleichnamige Einstellung aus dem Projekt.
+ * @var boolean
+ */
var $cut_index = false;
+
+ /**
+ * Enthaelt die gleichnamige Einstellung aus dem Projekt.
+ * @var String
+ */
var $cmd_after_publish = '';
- var $publishedObjects = array();
- var $log = array();
+
+ /**
+ * Enthaelt am Ende der Veröffentlichung ein Array mit den veröffentlichten Objekten.
+ * @var Array
+ */
+ var $publishedObjects = array();
+
+ /**
+ * Enthaelt im Fehlerfall (wenn 'ok' auf 'false' steht) eine
+ * Fehlermeldung.
+ *
+ * @var String
+ */
+ var $log = array();
+
+ /**
+ * Stellt nach der Veröffentlichung fest, ob der Vorgang erfolgreich ist.
+ * Falls nicht, enthält die Variable 'log' eine Fehlermeldung.
+ * @var boolean
+ */
var $ok = true;
/**
* Konstruktor.<br>
* <br>
- * �ffnet ggf. Verbindungen.
+ * Oeffnet ggf. Verbindungen.
*
* @return Publish
*/
@@ -266,10 +314,10 @@ class Publish
/**
- * Aufr�umen des Zielverzeichnisses.<br><br>
+ * Aufraeumen des Zielverzeichnisses.<br><br>
* Es wird der komplette Zielordner samt Unterverzeichnissen durchsucht. Jede
- * Datei, die l�nger existiert als der aktuelle Request alt ist, wird gel�scht.<br>
- * Nat�rlich darf diese Funktion nur nach einem Gesamt-Ver�ffentlichen ausgef�hrt werden.
+ * Datei, die laenger existiert als der aktuelle Request alt ist, wird geloescht.<br>
+ * Natuerlich darf diese Funktion nur nach einem Gesamt-Veroeffentlichen ausgefuehrt werden.
*/
function clean()
{