4.1.3. Kanonische globale Variablen

Um dieses Problem im Griff zu halten gibt es einige wenige - globale Variablen, die kanonisch sind, und alles andere sollte - anderweitig umhergereicht werden.

Diese Variablen sind im Moment die folgenden neun:

+ dies hat, seit der Einführung, u.a. schon so manche langwierige Bug-Suche verkürzt. + Da globale Variablen aber implizit mit Package angegeben werden, werden + die nicht geprüft, und somit kann sich schnell ein Tippfehler einschleichen.

4.1.3. Kanonische globale Variablen

Um dieses Problem im Griff zu halten gibt es einige wenige + globale Variablen, die kanonisch sind, d.h. sie haben bestimmte vorgegebenen Eigenschaften, + und alles andere sollte anderweitig umhergereicht werden.

Diese Variablen sind im Moment die folgenden neun:

$::form
%::myconfig @@ -58,8 +58,8 @@ $::dispatcher
$::request -

Damit diese nicht als Müllhalde misbrauch werden, im Folgenden - eine kurze Erläuterung was man von denn erwarten kann.

4.1.3.1. $::form

Ist ein Objekt der Klasse +

Damit diese nicht erneut als Müllhalde missbraucht werden, im Folgenden + eine kurze Erläuterung der bestimmten vorgegebenen Eigenschaften (Konventionen):

4.1.3.1. $::form

Ist ein Objekt der Klasse "Form"
Wird nach jedem Request gelöscht
Muss auch in Tests und Konsolenscripts vorhanden sein.
Enthält am Anfang eines Requests die Requestparameter vom User
Kann zwar intern über Requestgrenzen ein Datenbankhandle @@ -67,12 +67,23 @@ $::form wurde unter SQL Ledger™ als Gottobjekt für alles misbraucht. Sämtliche alten Funktionen unter SL/ mutieren $::form, das - heißt, alles was einem lieb ist, sollte man vor einem Aufruf von zum + heißt, alles was einem lieb ist (alle Variablen die einem ans Herz + gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel IS->retrieve_customer() in - Sicherheit bringen.
Das Objekt der Klasse Form hat leider im Moment noch viele - zentrale Funktionen Gdie vom internen Zustand abhängen, deshalb - bitte nie einfach zerstören oder überschreiben. Es geht ziemlich - sicher etwas kaputt.
+ Sicherheit bringen.
+ Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man Berechnung in einem + bestimmten Format durchführt (SL/Form.pm Zeile 3552, Stand version 2.7beta), um + dies hinterher wieder auf den richtigen Wert zu setzen: +
```
+            my $saved_numberformat    = $::myconfig{numberformat};
+            $::myconfig{numberformat} = $numberformat;
+            # (...) div Berechnungen
+            $::myconfig{numberformat} = $saved_numberformat;
+          
```
Das Objekt der Klasse Form hat leider im Moment noch viele + zentrale Funktionen die vom internen Zustand abhängen, deshalb + bitte nie einfach zerstören oder überschreiben (zumindestens nicht kurz + vor einem Release oder in Absprache über bspw. die devel-Liste ;-). + Es geht ziemlich sicher etwas kaputt.
$::form ist gleichzeitig der Standard Scope in den Template::Toolkit™ Templates außerhalb der Controller: der Ausdruck [% var @@ -81,20 +92,46 @@ Zugriff [% FORM.var %]. In Druckvorlagen sind normale Variablen ebenfall im $::form Scope, d.h. <%var%> zeigt auf - $::form->{var}. Innerhalb von Schleifen wird + $::form->{var}. + Nochmal von der anderen Seite erläutert, innerhalb von (Web-)Templates sieht + man häufiger solche Konstrukte: +
```
+            [%- IF business %]
+            # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an
+            [%- END %]
+         
```
+ Entweder wird hier dann $::form->{business} ausgewertet oder aber der Funktion + $form->parse_html_template wird explizit noch ein zusätzlicher Hash + übergeben, der dann auch in den (Web-)Templates zu Verfügung steht, bspw. so: + $form->parse_html_template("is/form_header", \%TMPL_VAR); + + Innerhalb von Schleifen wird $::form->{TEMPLATE_ARRAYS}{var}[$index] - bevorzugt, wenn vorhanden.

`4.1.3.2. %::myconfig`

Das einzige Hash unter den globalen Variablen

Wird spätestens benötigt wenn auf die Datenbank + bevorzugt, wenn vorhanden.


+          Zum Beispiel in SL/DO.pm welche über alle Positionen eines Lieferscheins
+          in Schleife läuft:
+          +            for $i (1 .. $form->{rowcount}) {
+              (...)
+              push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} },   $position;
+              push @{ $form->{TEMPLATE_ARRAYS}{number} },          $form->{"partnumber_$i"};
+              push @{ $form->{TEMPLATE_ARRAYS}{description} },     $form->{"description_$i"};
+

`4.1.3.2. %::myconfig`

Das einzige Hash unter den globalen Variablen
Wird spätestens benötigt wenn auf die Datenbank zugegriffen wird
Wird bei jedem Request neu erstellt.
Enthält die Userdaten des aktuellen Logins
Sollte nicht ohne Filterung irgendwo gedumpt werden oder extern serialisiert werden, weil da auch der Datenbankzugriff - für diesenuser drinsteht.
Enthält unter anderem Listenbegrenzung vclimit, + für diesen user drinsteht.
Enthält unter anderem Listenbegrenzung vclimit, Datumsformat dateformat und Nummernformat numberformat
Enthält Datenbankzugriffinformationen

%::myconfig ist im Moment der Ersatz für ein Userobjekt. Die meisten Funktionen, die etwas anhand des aktuellen Users entscheiden müssen, befragen - %::myconfig.

`4.1.3.3. $::locale`

Objekt der Klasse "Locale"
Wird pro Request erstellt
Muss auch für Tests und Scripte immer verfügbar + %::myconfig. + Innerhalb der Anwendungen sind dies überwiegend die Daten, die sich + unter Programm->Einstellungen befinden, bzw. die Informationen über den + Benutzer die über die Administrator-Schnittstelle (admin.pl) eingegeben wurden. +

`4.1.3.3. $::locale`

Objekt der Klasse "Locale"
Wird pro Request erstellt
Muss auch für Tests und Scripte immer verfügbar sein.
Cached intern über Requestgrenzen hinweg benutzte Locales

Lokalisierung für den aktuellen User. Alle Übersetzungen, - Zahlen- und Datumsformatierungen laufen über dieses Objekt.

`4.1.3.4. $::lxdebug`

Objekt der Klasse "LXDebug"
Wird global gecached
Muss immer verfügbar sein, in nahezu allen + Zahlen- und Datumsformatierungen laufen über dieses Objekt.

`4.1.3.4. $::lxdebug`

Objekt der Klasse "LXDebug"
Wird global gecached
Muss immer verfügbar sein, in nahezu allen Funktionen

$::lxdebug stellt Debuggingfunktionen bereit, wie "enter_sub" und @@ -102,29 +139,37 @@ brauchbares Tracing gebaut ist, "log_time", mit der man die Wallclockzeit seit Requeststart loggen kann, sowie "message" und "dump" mit - denen man flott Informationen ins Log packen kann.

`4.1.3.5. $::auth`

Objekt der Klasse "SL::Auth"
Wird global gecached
Hat eine permanente DB Verbindung zur Authdatenbank
Wird nach jedem Request resettet.

+ denen man flott Informationen ins Log (tmp/lx-office-debug.log) packen kann.


+          Beispielsweise so:
+          +            $main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
+            $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});
+
+

`4.1.3.5. $::auth`

Objekt der Klasse "SL::Auth"
Wird global gecached
Hat eine permanente DB Verbindung zur Authdatenbank
Wird nach jedem Request resettet.

$::auth stellt Funktionen bereit um die Rechte des aktuellen Users abzufragen. Obwohl diese Informationen vom aktuellen User abhängen wird das Objekt aus Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem - Request kurz resettet.

`4.1.3.6. $::lx_office_conf`

Objekt der Klasse + Request kurz resettet.

`4.1.3.6. $::lx_office_conf`

Objekt der Klasse "SL::LxOfficeConf"
Global gecached
Repräsentation der - config/lx_office.conf[.default]-Dateien

Globale Konfiguration. Configdateien werden zum Start gelesen, - und nicht mehr angefasst. Es ist derzeit nicht geplant, dass das - Programm die Konfiguration ändern kann oder sollte.

Für die folgende Konfigurationsdatei:

[debug]
-file = /tmp/lxoffice_debug_log.txt

ist der Key file im Programm als + config/lx_office.conf[.default]-Dateien

Globale Konfiguration. Configdateien werden zum Start gelesen + und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass das + Programm die Konfiguration ändern kann oder sollte.

Beispielsweise ist über den Konfigurationseintrag [debug] + die Debug- und Trace-Log-Datei wie folgt konfiguriert und verfügbar:

[debug]
+file = /tmp/lx-office-debug.log

ist der Key file im Programm als $::lx_office_conf->{debug}{file} erreichbar.

	Warnung
	Zugriff auf die Konfiguration erfolgt im Moment über - Hashkeys, sind also nicht gegen Tippfehler abgesichert.

`4.1.3.7. $::instance_conf`

Objekt der Klasse + Hashkeys, sind also nicht gegen Tippfehler abgesichert.

`4.1.3.7. $::instance_conf`

Objekt der Klasse "SL::InstanceConfiguration"
wird pro Request neu erstellt

Funktioniert wie $::lx_office_conf, speichert aber Daten die von der Instanz abhängig sind. Eine Instanz - ist hier eine Mandantendatenbank. Prominentestes Datum ist "eur", - die Information ob Bilanz oder Einnahmenüberschussrechnung gemacht - wird.

`4.1.3.8. $::dispatcher`

Objekt der Klasse + ist hier eine Mandantendatenbank. + Beispielsweise überprüft +
```
$::instance_conf->get_inventory_system eq 'perpetual'
```
+ ob die berüchtigte Bestandsmethode zur Anwendung kommt.

`4.1.3.8. $::dispatcher`

Objekt der Klasse "SL::Dispatcher"
wird pro Serverprozess erstellt.
enthält Informationen über die technische Verbindung zum Server

Der dritte Punkt ist auch der einzige Grund warum das Objekt global gespeichert wird. Wird vermutlich irgendwann in einem anderen - Objekt untergebracht.

`4.1.3.9. $::request`

Hashref (evtl später Objekt)
Wird pro Request neu initialisiert.
Keine Unterstruktur garantiert.

+ Objekt untergebracht.

`4.1.3.9. $::request`

Hashref (evtl später Objekt)
Wird pro Request neu initialisiert.
Keine Unterstruktur garantiert.

$::request ist ein generischer Platz um Daten "für den aktuellen Request" abzulegen. Sollte nicht für action at a distance benutzt werden, sondern um lokales memoizing zu @@ -134,20 +179,20 @@ file = /tmp/lxoffice_debug_log.txt

ist der Key fil Differentialkriterien sind:

Kommt es vom User, und soll unverändert wieder an den User? Dann $::form, steht da eh schon
Sind es Daten aus der Datenbank, die nur bis zum Ende des Requests gebraucht werden? Dann $::request
Muss ich von anderen Teilen des Programms lesend drauf zugreifen? Dann $::request, aber Zugriff über - Wrappermethode

`4.1.4. Ehemalige globale Variablen`

Die folgenden Variablen waren einmal im Programm, und wurden - entfernt.

`4.1.4.1. $::cgi`

war nötig, weil cookie Methoden nicht als + Wrappermethode

`4.1.4. Ehemalige globale Variablen`

Die folgenden Variablen waren einmal im Programm, und wurden + entfernt.

`4.1.4.1. $::cgi`

war nötig, weil cookie Methoden nicht als Klassenfunktionen funktionieren
Aufruf als Klasse erzeugt Dummyobjekt was im Klassennamespace gehalten wird und über Requestgrenzen leaked
liegt jetzt unter $::request->{cgi} -

`4.1.4.2. $::all_units`

war nötig, weil einige Funktionen in Schleifen zum Teil +

`4.1.4.2. $::all_units`

war nötig, weil einige Funktionen in Schleifen zum Teil ein paar hundert mal pro Request eine Liste der Einheiten brauchen, und de als Parameter durch einen Riesenstack von Funktionen geschleift werden müssten.
Liegt jetzt unter $::request->{cache}{all_units}
Wird nur in AM->retrieve_all_units() gesetzt oder - gelesen.

`4.1.4.3. %::called_subs`

wurde benutzt um callsub deep recursions + gelesen.

`4.1.4.3. %::called_subs`

wurde benutzt um callsub deep recursions abzufangen.
Wurde entfernt, weil callsub nur einen Bruchteil der möglichen Rekursioenen darstellt, und da nie welche auftreten.
komplette recursion protection wurde entfernt.

Zurück		Weiter
3.3. Excel-Vorlagen	Zum Anfang	4.2. Entwicklung unter FastCGI


\ No newline at end of file
diff --git a/doc/html/ch04s03.html b/doc/html/ch04s03.html
index 41d3b50b1..7ff3a83d8 100644
--- a/doc/html/ch04s03.html
+++ b/doc/html/ch04s03.html
@@ -68,6 +68,10 @@
           zuerst nach der Abhängigkeitstiefe (wenn "z" von "y" abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von 2, "y" von 1
           und "x" von 0. "x" würde hier zuerst ausgeführt, dann "y", dann "z"), dann nach der Priorität und bei gleicher Priorität
           alphabetisch nach dem "tag".
+         

+                     ignore
+                  

+          Optional. Falls der Wert auf 1 (true) steht, wird das Skript bei der Anmeldung ignoriert und entsprechend nicht ausgeführt.

`4.3.3. Hilfsscript dbupgrade2_tool.pl`

Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern, existiert ein Hilfsscript namens "scripts/dbupgrade2_tool.pl". Es muss aus dem Lx-Office-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses diff --git a/doc/html/ch04s05.html b/doc/html/ch04s05.html index 442f3e05b..09e575894 100644 --- a/doc/html/ch04s05.html +++ b/doc/html/ch04s05.html @@ -94,7 +94,7 @@ $i = $n; # recover $i

$form->{sum}      = 0;
 $form->{"row_$i"} = $form->{"row_$i"} - 5;
 $some_hash{42}    = 54;

- Die maximale Zeilenlänge ist nicht bescränkt. Zeilenlängen unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber + Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in grossen Tabellen), dann ist Lesbarkeit vorzuziehen.

Als Beispiel sei die Funktion print_options aus bin/mozilla/io.pl angeführt. diff --git a/doc/html/images/skr04-update-3804/konto3804.png b/doc/html/images/skr04-update-3804/konto3804.png deleted file mode 100644 index e66b66a2e..000000000 Binary files a/doc/html/images/skr04-update-3804/konto3804.png and /dev/null differ diff --git a/doc/html/images/skr04-update-3804/konto4315.png b/doc/html/images/skr04-update-3804/konto4315.png deleted file mode 100644 index d9971cfb9..000000000 Binary files a/doc/html/images/skr04-update-3804/konto4315.png and /dev/null differ diff --git a/doc/html/images/skr04-update-3804/steuer3803.png b/doc/html/images/skr04-update-3804/steuer3803.png deleted file mode 100644 index 361c0b3de..000000000 Binary files a/doc/html/images/skr04-update-3804/steuer3803.png and /dev/null differ diff --git a/doc/html/images/skr04-update-3804/steuer3804.png b/doc/html/images/skr04-update-3804/steuer3804.png deleted file mode 100644 index fad59869a..000000000 Binary files a/doc/html/images/skr04-update-3804/steuer3804.png and /dev/null differ diff --git a/doc/html/images/skr04-update-3804/steuerliste.png b/doc/html/images/skr04-update-3804/steuerliste.png deleted file mode 100644 index 2c4945c90..000000000 Binary files a/doc/html/images/skr04-update-3804/steuerliste.png and /dev/null differ diff --git a/doc/html/index.html b/doc/html/index.html index e045d1838..d17af2a5d 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -2,4 +2,4 @@ Lx-Office: Installation, Konfiguration, Entwicklung

Lx-Office: Installation, Konfiguration, Entwicklung
		Weiter

`Lx-Office: Installation, Konfiguration, Entwicklung`

Inhaltsverzeichnis

1. Aktuelle Hinweise

2. Installation und Grundkonfiguration

2.1. Benötigte Software und Pakete

2.1.1. Betriebssystem
2.1.2. Pakete

2.2. Manuelle Installation des Programmpaketes

2.3. Lx-Office-Konfigurationsdatei

2.3.1. Einführung
2.3.2. Abschnitte und Parameter
2.3.3. Versionen vor 2.6.3

2.4. Anpassung der PostgreSQL-Konfiguration

2.4.1. Zeichensätze/die Verwendung von UTF-8
2.4.2. Änderungen an Konfigurationsdateien
2.4.3. Erweiterung für servergespeicherte Prozeduren
2.4.4. Datenbankbenutzer anlegen

2.5. Webserver-Konfiguration

2.5.1. Grundkonfiguration mittels CGI
2.5.2. Konfiguration für FastCGI/FCGI

2.6. Der Task-Server

2.6.1. Verfügbare und notwendige Konfigurationsoptionen
2.6.2. Automatisches Starten des Task-Servers beim Booten
2.6.3. Wie der Task-Server gestartet und beendet wird

2.7. Benutzerauthentifizierung und Administratorpasswort

2.7.1. Grundlagen zur Benutzerauthentifizierung
2.7.2. Administratorpasswort
2.7.3. Authentifizierungsdatenbank
2.7.4. Passwortüberprüfung
2.7.5. Name des Session-Cookies
2.7.6. Anlegen der Authentifizierungsdatenbank

2.8. Benutzer- und Gruppenverwaltung

2.8.1. Zusammenhänge
2.8.2. Datenbanken anlegen
2.8.3. Gruppen anlegen
2.8.4. Benutzer anlegen
2.8.5. Gruppenmitgliedschaften verwalten
2.8.6. Migration alter Installationen

2.9. Drucken mit Lx-Office

2.10. OpenDocument-Vorlagen

2.11. Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung: EUR

2.11.1. Einführung
2.11.2. Konfigurationsparameter
2.11.3. Festlegen der Parameter
2.11.4. Bemerkungen zu Bestandsmethode
2.11.5. Bekannte Probleme

2.12. Lx-Office ERP verwenden

3. Features und Funktionen

3.1. Wiederkehrende Rechnungen

3.1.1. Einführung
3.1.2. Konfiguration
3.1.3. Auflisten
3.1.4. Erzeugung der eigentlichen Rechnungen
3.1.5. Erste Rechnung für aktuellen Monat erstellen

3.2. Dokumentenvorlagen und verfügbare Variablen

3.2.1. Einführung
3.2.2. Variablen ausgeben
3.2.3. Verwendung in Druckbefehlen
3.2.4. Anfang und Ende der Tags verändern
3.2.5. Zuordnung von den Dateinamen zu den Funktionen
3.2.6. Sprache, Drucker und E-Mail
3.2.7. Allgemeine Variablen, die in allen Vorlagen vorhanden sind
3.2.8. Variablen in Rechnungen
3.2.9. Variablen in Mahnungen und Rechnungen über Mahngebühren
3.2.10. Variablen in anderen Vorlagen
3.2.11. Blöcke, bedingte Anweisungen und Schleifen
3.2.12. Markup-Code zur Textformatierung innerhalb von - Formularen

3.3. Excel-Vorlagen

3.3.1. Zusammenfassung
3.3.2. Bedienung
3.3.3. Variablensyntax
3.3.4. Einschränkungen

4. Entwicklerdokumentation

4.1. Globale Variablen

4.1.1. Wie sehen globale Variablen in Perl aus?
4.1.2. Warum sind globale Variablen ein Problem?
4.1.3. Kanonische globale Variablen
4.1.4. Ehemalige globale Variablen

4.2. Entwicklung unter FastCGI

4.2.1. Allgemeines
4.2.2. Programmende und Ausnahmen
4.2.3. Globale Variablen
4.2.4. Performance und Statistiken
4.2.5. Bekannte Probleme

4.3. SQL-Upgradedateien

4.3.1. Einführung
4.3.2. Format der Kontrollinformationen
4.3.3. Hilfsscript dbupgrade2_tool.pl

4.4. Translations and languages

4.4.1. Introduction
4.4.2. File structure

4.5. Stil-Richtlinien

4.6. Dokumentation erstellen

4.6.1. Einführung
4.6.2. Benötigte Software
4.6.3. PDFs und HTML-Seiten erstellen
4.6.4. Einchecken in das Git-Repository

		Weiter
		Kapitel 1. Aktuelle Hinweise


\ No newline at end of file
+        Formularen3.3. Excel-Vorlagen
3.3.1. Zusammenfassung
3.3.2. Bedienung
3.3.3. Variablensyntax
3.3.4. Einschränkungen
4. Entwicklerdokumentation
4.1. Globale Variablen
4.1.1. Wie sehen globale Variablen in Perl aus?
4.1.2. Warum sind globale Variablen ein Problem?
4.1.3. Kanonische globale Variablen
4.1.4. Ehemalige globale Variablen
4.2. Entwicklung unter FastCGI
4.2.1. Allgemeines
4.2.2. Programmende und Ausnahmen
4.2.3. Globale Variablen
4.2.4. Performance und Statistiken
4.2.5. Bekannte Probleme
4.3. SQL-Upgradedateien
4.3.1. Einführung
4.3.2. Format der Kontrollinformationen
4.3.3. Hilfsscript dbupgrade2_tool.pl
4.4. Translations and languages
4.4.1. Introduction
4.4.2. File structure
4.5. Stil-Richtlinien
4.6. Dokumentation erstellen
4.6.1. Einführung
4.6.2. Benötigte Software
4.6.3. PDFs und HTML-Seiten erstellen
4.6.4. Einchecken in das Git-Repository

		Weiter
		Kapitel 1. Aktuelle Hinweise


\ No newline at end of file