270 lines
14 KiB
HTML
Executable File
270 lines
14 KiB
HTML
Executable File
<html>
|
|
<head>
|
|
<title>ProgressClass v1.0 Anleitung</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
<style type="text/css">
|
|
<!--
|
|
.normal { font-family: Arial, Helvetica, sans-serif; font-size: 12px; text-align: justify}
|
|
.klein { font-family: Arial, Helvetica, sans-serif; font-size: 10px}
|
|
.ueberschrift { font-family: Arial, Helvetica, sans-serif; font-size: 16px; font-weight: bold}
|
|
.unterueberschrift { font-family: Arial, Helvetica, sans-serif; font-size: 14px; font-weight: bold; font-style: italic}
|
|
.code { font-family: "Courier New", Courier, mono; font-size: 14px; font-weight: bold; color: #000099; text-align: left}
|
|
-->
|
|
</style>
|
|
</head>
|
|
|
|
<body bgcolor="#FFFFFF" text="#000000">
|
|
<p class="normal"><span class="ueberschrift">ProgressClass v1.0 Anleitung<br>
|
|
</span>
|
|
(c) 2002 Boris Wylutzki / www.edv-internet.de</p>
|
|
<table width="100%" border="0" bgcolor="#CCCCCC">
|
|
<tr>
|
|
<td>
|
|
<p class="klein">Dieses Programm ist freie Software. Sie können es unter den
|
|
Bedingungen der GNU General Public License, wie von der Free
|
|
Software Foundation veröffentlicht, weitergeben und/oder
|
|
modifizieren, entweder gemäß Version 2 der Lizenz oder (nach
|
|
Ihrer Option) jeder späteren Version.<br>
|
|
<br>
|
|
Die Veröffentlichung dieses Programms erfolgt in der
|
|
Hoffnung, daß es Ihnen von Nutzen sein wird, aber OHNE
|
|
IRGENDEINE GARANTIE, sogar ohne die implizite Garantie der
|
|
MARKTREIFE oder der VERWENDBARKEIT FÜR EINEN BESTIMMTEN
|
|
ZWECK. Details finden Sie in der GNU General Public License.<br>
|
|
<br>
|
|
Sie sollten eine <a href="lizenz.txt">Kopie der GNU General Public License</a>
|
|
zusammen mit diesem Programm erhalten haben. Falls nicht,
|
|
schreiben Sie an die Free Software Foundation, Inc., 59
|
|
Temple Place, Suite 330, Boston, MA 02111-1307, USA.<br>
|
|
<br>
|
|
Falls Sie eine Lizenz für die Verwendung in kostenpflichtigen Softwarepaketen benötigen, kontaktieren Sie bitte den Autor unter www.edv-internet.de.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<p class="unterueberschrift">Programmbeschreibung</p>
|
|
<p class="normal">ProgressClass stellt eine PHP-Klasse für die dynamische Anzeige und Veränderung eines Fortschrittsbalkens zur Verfügung. In einem Fenster im Windows-Stil kann noch während der Laufzeit des Scripts der Fortschritt angezeigt werden, z.B. beim Laden/Ausgeben der Seite, Versenden von E-Mails oder Bearbeiten von Datenbanken. Am Ende der Seite kann der Fortschrittsbalken wieder ausgeblendet werden. Features: optionaler Abbrechen-Button; dynamische Änderung von Beschriftung, Farbe, Prozent; freie Größe und Positionierung.</p>
|
|
<p class="unterueberschrift">Systemvoraussetzungen</p>
|
|
<p class="normal">Der Server benötigt PHP 4.x oder höher incl. korrekt installierter aktueller <a href="https://www.garykeith.com/browsers/browscap.asp" target="_blank">browscap.ini</a>. Der Client benötigt den IE 5.x oder höher bzw. Netscape 6.x oder höher. Andere Browser-Hersteller sind nicht getestet. ProgressClass prüft selbständig die Browserversion und zeigt bei zu alter Version keinen Fortschrittsbalken an; eine eigene Browserüberprüfung brauchen Sie nicht zu verwenden.</p>
|
|
<p class="unterueberschrift">Installation</p>
|
|
<p class="normal">Kopieren Sie einfach die Dateien <span class="code">ProgressClass.php</span> und <span class="code">js.inc.php</span> auf ihren Webspace.</p>
|
|
<p class="unterueberschrift">Anwendung</p>
|
|
<p class="normal">ProgressClass ist komplett objektorientiert. Es stellt eine Klasse zum Erzeugen, Bearbeiten und Löschen des Fortschrittsbalkens zur Verfügung. Wenn mehrere Fortschrittsbalken benötigt werden, kann die Klasse auch ohne Probleme mehrmals instanziert werden (auch gleichzeitig). Grundsätzlich stellt sich der Einsatz folgendermaßen dar:</p>
|
|
<ol class="normal">
|
|
<li>Einbinden der Klasse:
|
|
<table width="80%" border="0" bgcolor="#FFE1C4">
|
|
<tr>
|
|
<td class="code">require('ProgressClass.php');</td>
|
|
</tr>
|
|
</table>
|
|
<br>
|
|
</li>
|
|
<li>Erzeugen einer Instanz der Klasse:
|
|
<table width="80%" border="0" bgcolor="#FFE1C4">
|
|
<tr>
|
|
<td class="code">$progress=new ProgressClass();</td>
|
|
</tr>
|
|
</table>
|
|
<br>
|
|
</li>
|
|
<li>Einstellen der gewünschten Optionen (siehe unten). Dieser Schritt ist optional, die Klasse ist mit Standardeinstellungen vorbelegt. Beispiel:
|
|
<table width="80%" border="0" bgcolor="#FFE1C4">
|
|
<tr>
|
|
<td class="code">$progress->setWidth(300);<br>
|
|
$progress->setPosition('center',20);<br>
|
|
... usw.
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<br>
|
|
</li>
|
|
<li>Fortschrittsbalken generieren und ausgeben:
|
|
<table width="80%" border="0" bgcolor="#FFE1C4">
|
|
<tr>
|
|
<td class="code">$progress->make();</td>
|
|
</tr>
|
|
</table>
|
|
<br>
|
|
</li>
|
|
<li>Ändern der Prozentanzeige oder anderer Einstellungen:
|
|
<table width="80%" border="0" bgcolor="#FFE1C4">
|
|
<tr>
|
|
<td class="code">
|
|
<p>$progress->setPercent(10);<br>
|
|
...<br>
|
|
$progress->setPercent(45);<br>
|
|
...<br>
|
|
$progress->setPercent(80);<br>
|
|
$progress->setLabel('Speicher wird aufgeräumt ...');<br>
|
|
...<br>
|
|
$progress->setPercent(100);<br>
|
|
$progress->setLabel('Fertig!');
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<br>
|
|
</li>
|
|
<li>Fortschrittsbalken löschen, so daß er nicht mehr im Browser angezeigt wird:
|
|
<table width="80%" border="0" bgcolor="#FFE1C4">
|
|
<tr>
|
|
<td class="code">$progress->hide();</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ol>
|
|
<p class="unterueberschrift">Beschreibung der Funktionen</p>
|
|
<p class="code"><b>ProgressClass()</b></p>
|
|
<blockquote>
|
|
<p class="normal">Die Funktion wird durch Instanzieren der Klasse aufgerufen und nimmt interne Initialisierungen vor. Sie können beliebig viele Fortschrittsbalken (auch gleichzeitig) durch Instanzieren neuer Klassen erzeugen. Alle Fortschrittsbalken haben voneinander unabhänge Einstellungen und können getrennt angezeigt und geändert werden.</p>
|
|
<p class="normal">Benötigt keine Parameter.</p>
|
|
<table width="80%" border="0" bgcolor="#FFE1C4">
|
|
<tr>
|
|
<td class="code">$progress->new ProgressClass();</td>
|
|
</tr>
|
|
</table>
|
|
</blockquote>
|
|
<p class="code">setWidth($width);</p>
|
|
<blockquote>
|
|
<p class="normal">Definiert die Breite des Fortschrittbalkens (äußerer Rand des Fensters) in Pixeln. Standardeinstellung sind <i>350</i> Pixel.</p>
|
|
<p class="normal">Der Aufruf dieser Funktion nach <span class="code">make()</span> hat keine Wirkung.</p>
|
|
<table width="80%" border="0" bgcolor="#FFE1C4">
|
|
<tr>
|
|
<td class="code">$progress->setWidth(300); </td>
|
|
</tr>
|
|
</table>
|
|
</blockquote>
|
|
<p class="code">setPosition($left=NULL,$top=NULL);</p>
|
|
<blockquote>
|
|
<p class="normal">Definiert die Position (obere linke Ecke) des Fortschrittsbalkens (äußerer Rand des Fensters) innerhalb des angezeigten Dokuments/Frames in Pixeln. Standardeinstellung ist <i>'center','center-65'</i>.</p>
|
|
<p class="normal">Der erste Parameter bezeichnet den Abstand der oberen linken Ecke zum linken Seitenrand, der zweite zum oberen Seitenrand. Sie können auch nur einen der Parameter angeben, der zweite behält dann die Standardeinstellung. Wenn Sie nur den zweiten Parameter angeben möchten, muß der erste <span class="code">NULL</span> sein.</p>
|
|
<p class="normal">Anstelle von absoluten Zahlen können Sie auch <span class="code">'center'</span> angeben, so daß das Fenster zentriert im Anzeigebereich angezeigt wird. Möglich ist sogar eine Kombination z.B. <span class="code">'center-30'</span>.</p>
|
|
<p class="normal">Der Aufruf dieser Funktion nach <span class="code">make()</span> hat keine Wirkung.</p>
|
|
<table width="80%" border="0" bgcolor="#FFE1C4">
|
|
<tr>
|
|
<td class="code">$progress->setPosition(100,30);</td>
|
|
</tr>
|
|
</table>
|
|
<br>
|
|
<table width="80%" border="0" bgcolor="#FFE1C4">
|
|
<tr>
|
|
<td class="code">$progress->setPosition(NULL,30); // Standardeinstellung für $left beibehalten</td>
|
|
</tr>
|
|
</table>
|
|
<br>
|
|
<table width="80%" border="0" bgcolor="#FFE1C4">
|
|
<tr>
|
|
<td class="code">$progress->setPosition(100); // Standardeinstellung für $top beibehalten</td>
|
|
</tr>
|
|
</table>
|
|
<br>
|
|
<table width="80%" border="0" bgcolor="#FFE1C4">
|
|
<tr>
|
|
<td class="code">$progress->setPosition('center','center-30'); // Zentriert, etwas nach oben verschoben</td>
|
|
</tr>
|
|
</table>
|
|
</blockquote>
|
|
<p class="code">setButton($label,$url,$target='_self')</p>
|
|
<blockquote>
|
|
<p class="normal">Fügt dem Fortschrittsbalken einen Button hinzu, auf dessen Klick eine neue Seite geöffnet wird. Der Button kann z.B. mit <i>"Abbrechen"</i> beschriftet werden. Wenn er angeklickt wird, wird eine neue Seite geladen, so daß die Ausführung der aktuellen Seite abgebrochen wird (nur wenn <i>target='_self'</i>).</p>
|
|
<p class="normal">Mit dem ersten Parameter wird die Beschriftung des Buttons, mit dem zweiten die Ziel-URL angegeben. Der optionale dritte Parameter bezeichnet das für den Link verwendete Target.</p>
|
|
<p class="normal">Der Aufruf dieser Funktion nach <span class="code">make()</span> hat keine Wirkung.</p>
|
|
<table width="80%" border="0" bgcolor="#FFE1C4">
|
|
<tr>
|
|
<td class="code">$progress->setButton('Abbrechen','/seiten/abbruch.php');</td>
|
|
</tr>
|
|
</table>
|
|
<br>
|
|
<table width="80%" border="0" bgcolor="#FFE1C4">
|
|
<tr>
|
|
<td class="code">$progress->setButton('Info','info.php','_blank');</td>
|
|
</tr>
|
|
</table>
|
|
</blockquote>
|
|
<p class="code">setPercent($percent)</p>
|
|
<blockquote>
|
|
<p class="normal">Definiert die Prozentanzeige des Fortschrittsbalkens. Standardeinstellung ist <i>0</i>.</p>
|
|
<p class="normal">Der Parameter muß als Zahl, ohne Prozentzeichen angegeben werden.</p>
|
|
<p class="normal">Diese Funktion kann auch nach <span class="code">make()</span> noch öfter aufgerufen werden, um die Prozentanzeige dynamisch zu ändern (DHTML).</p>
|
|
<table width="80%" border="0" bgcolor="#FFE1C4">
|
|
<tr>
|
|
<td class="code">$progress->setPercent(25);</td>
|
|
</tr>
|
|
</table>
|
|
</blockquote>
|
|
<p class="code">setPerX($some,$all)</p>
|
|
<blockquote>
|
|
<p class="normal">Definiert die Prozentanzeige des Fortschrittsbalkens und rechnet dafür die angegebenen Werte in Prozent um.</p>
|
|
<p class="normal">Der erste Parameter stellt die aktuelle Position von insgesamt soviel Positionen, wie der zweite Parameter bezeichnet, dar. Wenn Sie eine Datei oder ein MySQL-Result einlesen, übergeben Sie für <span class="code">$all</span> die Anzahl der Einträge und für <span class="code">$some</span> die aktuelle Position des Dateizeigers/Result-Zeigers.</p>
|
|
<p class="normal">Diese Funktion kann auch nach <span class="code">make()</span> noch öfter aufgerufen werden, um die Prozentanzeige dynamisch zu ändern (DHTML).</p>
|
|
<table width="80%" border="0" bgcolor="#FFE1C4">
|
|
<tr>
|
|
<td class="code">$gesamt=1500;<br>
|
|
for ($i=1;$i<=$gesamt;$i++)<br>
|
|
$progress->setPerX($i,$gesamt);</td>
|
|
</tr>
|
|
</table>
|
|
</blockquote>
|
|
<p class="code">setLabel($label)</p>
|
|
<blockquote>
|
|
<p class="normal">Definiert die Beschriftung des Fortschrittsbalkens. Standardeinstellung ist <i>"Bitte warten ..."</i></p>
|
|
<p class="normal">Diese Funktion kann auch nach <span class="code">make()</span> noch öfter aufgerufen werden, um das Label dynamisch zu ändern (DHTML).</p>
|
|
<table width="80%" border="0" bgcolor="#FFE1C4">
|
|
<tr>
|
|
<td class="code">$progress->setLabel('Seite wird geladen ...');</td>
|
|
</tr>
|
|
</table>
|
|
</blockquote>
|
|
<p class="code">setBarColor($color)</p>
|
|
<blockquote>
|
|
<p class="normal">Definiert die Farbe des Fortschrittsbalkens. Standardeinstellung ist <i>dunkelblau</i>.</p>
|
|
<p class="normal">Die Farbe muß als HTML-Color-Code angegeben werden.</p>
|
|
<p class="normal">Diese Funktion kann auch nach <span class="code">make()</span> noch öfter aufgerufen werden, um die Farbe dynamisch zu ändern (DHTML).</p>
|
|
<table width="80%" border="0" bgcolor="#FFE1C4">
|
|
<tr>
|
|
<td class="code">$progress->setBarColor('#FF0000'); // rot</td>
|
|
</tr>
|
|
</table>
|
|
</blockquote>
|
|
<p class="code">hide()</p>
|
|
<blockquote>
|
|
<p class="normal">Macht den Fortschrittsbalken unsichtbar. Sollte am Ende der Ausgabe aufgerufen werden, damit der Besucher die Seite ohne den Fortschrittsbalken betrachten kann.</p>
|
|
<p class="normal">Benötigt keine Parameter.</p>
|
|
<p class="normal">Diese Funktion sollte nur nach <span class="code">make()</span> aufgerufen werden (DHTML).</p>
|
|
<table width="80%" border="0" bgcolor="#FFE1C4">
|
|
<tr>
|
|
<td class="code">$progress->hide();</td>
|
|
</tr>
|
|
</table>
|
|
</blockquote>
|
|
<p class="code">show()</p>
|
|
<blockquote>
|
|
<p class="normal">Macht den Fortschrittsbalken sichtbar und ist z.B. sinnvoll, wenn vorher make(false) aufgerufen wurde.</p>
|
|
<p class="normal">Benötigt keine Parameter.</p>
|
|
<p class="normal">Diese Funktion sollte nur nach <span class="code">make()</span> aufgerufen werden (DHTML).</p>
|
|
<table width="80%" border="0" bgcolor="#FFE1C4">
|
|
<tr>
|
|
<td class="code">$progress->show();</td>
|
|
</tr>
|
|
</table>
|
|
</blockquote>
|
|
<p class="code"><b>make($show=true)</b></p>
|
|
<blockquote>
|
|
<p class="normal">Erstellt den Fortschrittsbalken und gibt ihn an den Browser aus.</p>
|
|
<p class="normal"><b><font color="#FF0000">Wichtig:</font> Die Funktion darf erst aufgerufen werden, nachdem der <body>-Tag an den Browser gesendet wurde!</b></p>
|
|
<p class="normal">Optional kann durch den Parameter angegeben werden, ob der Fortschrittsbalken auch gleich sichtbar angezeigt wird. Standardeinstellung ist <span class="code">true</span> (= Ja).</p>
|
|
<table width="80%" border="0" bgcolor="#FFE1C4">
|
|
<tr>
|
|
<td class="code">$progress->make();</td>
|
|
</tr>
|
|
</table>
|
|
<br>
|
|
<table width="80%" border="0" bgcolor="#FFE1C4">
|
|
<tr>
|
|
<td class="code">$progress->make(false); // Nur ausgeben, noch nicht anzeigen.</td>
|
|
</tr>
|
|
</table>
|
|
</blockquote>
|
|
<p> </p>
|
|
</body>
|
|
</html>
|