Docs for page core.mysql.php

/web/core/core.mysql.php

Description

Die Datei core.mysql.php baut eine Verbindung zu einer in der CoreConfig festgelegten MySQL-Datebank eine Verbindung auf und stellt dann Funktionen und Klassen bereit um in diese Datenbank zu Schreiben, bzw. zu Lesen.

Einige Beispiele in der Dokumentation der Funktionen und Klassen in diesem Script beziehen sich auf folgende Tabelle:

Tabelle `comupter`: +---+------+-----+--------+ |id |tower |cpu |monitor | +---+------+-----+--------+ |1 |mini |500 |15 | +---+------+-----+--------+ |2 |mini |700 |15 | +---+------+-----+--------+ |3 |midi |900 |17 | +---+------+-----+--------+ |4 |midi |1100 |17 | +---+------+-----+--------+ |5 |big |1300 |19 | +---+------+-----+--------+

license: COPYING
copyright: © 2001-2007 The FLIP Project Team
version: $Id: core.mysql.php 1477 2007-10-14 01:00:51Z scope $
author: Moritz Eysholdt

Classes

Class	Description
MysqlQuery	Die Klasse MysqlQuery kapselt eine - wie der name schon sagt - MySQL-Anfrage.

Includes

require_once ("core/core.config.php") (line 38)

Constants

CORE.MYSQL.PHP = 1 (line 36)

Die Datei nur einmal includen

Functions

MysqlColEnum (line 512)

Gibt ein Array mit den möglichen Werten für eine Spalte (Enum oder Set)

since: 1348 - 26.01.2007

Array MysqlColEnum (String $table, $column, String $col)

String $table: Tabellenname
String $col: Spalte
$column

MysqlDeleteByID (line 422)

Die Funktion MysqlDeleteByID() löscht einen oder mehrere Datensätze anhand ihrer ID

return: Wird kein Datensatz gelöscht, wird false zurückgegeben.

bool MysqlDeleteByID (string $TableName, int $ID)

string $TableName: Der Name der Tabelle in der sich der zu löschende Datensatz befindet.
int $ID: Die ID des zu löschenden Datensatzes

MysqlDeleteByRight (line 444)

void MysqlDeleteByRight ( $TableName, $ID, $RightCols)

$TableName
$ID
$RightCols

MysqlDeleteRow (line 337)

void MysqlDeleteRow ( $Query)

$Query

MysqlError (line 93)

MysqlError() gibt einen Fehler mittels trigger_error() aus und reichert diesen vorher mit Datenbankspezifischen Informationen an.

void MysqlError ($Msg $Msg, [integer $Type = 0])

integer $Type: (E_USER_NOTICE,E_USER_WARNING,E_USER_ERROR) Wenn nicht angegeben, wird der Type automatisch in Abhängigkeit vom Errorcode der DB gesetzt.
$Msg $Msg: Die Fehlernachricht

MysqlGetMaxAllowedPacket (line 480)

void MysqlGetMaxAllowedPacket ()

MysqlReadArea (line 200)

Die Funktion MysqlReadArea() führt eine Lese-Abfrage über beliebig viele Spalten und Zeilen in der Datenbank aus. Das Ergebnis wird als zweidimensionales Array zurückgegeben.

Wird der Parameter $KeyName angegeben, ist die erste Dimension ein assotiatives Array, welches die Werte der duch $KeyName angegebenen Tabellen-Spalte als Keys verwendet. Ist $KeyName nicht angegeben, ist die erste Dimension nicht Assotiativ (d.H. beginnend bei Null nummerisch durchindiziert) In der zweiten Dimension dienen die Spaltennamen als Keys.

Beispiel -
1. print_r(MysqlReadArea("SELECT * FROM `computer`;","cpu"));
3. Ausgabe:
4. Array(
5. 500 => Array("id" => 1, "tower" => "mini", "cpu" => 500 , "monitor" =>15),
6. 700 => Array("id" => 2, "tower" => "mini", "cpu" => 700 , "monitor" =>15),
7. 900 => Array("id" => 3, "tower" => "midi", "cpu" => 900 , "monitor" =>17),
8. 1100 => Array("id" => 4, "tower" => "midi", "cpu" => 1100, "monitor" =>17),
9. 1300 => Array("id" => 5, "tower" => "big" , "cpu" => 1300, "monitor" =>19)
10. );

return: Ein zweidimensionales Array welches das Abfrageergebnis enthält.

array MysqlReadArea (string $Query, [string $KeyName = ""])

string $Query: Der MySQL-Abfragebefehl.
string $KeyName: Der Name der Spalte dessen Werte für die erste Dimension des Abfrageergebnisses als Keys verwendet werden. Achtung: Wenn in dieser Spalte Werte doppelt auftreten, werden sich die einzelnen Zeilen "überschreiben" und somit bei der Abfrage Zeilen verloren gehen.

MysqlReadCol (line 243)

Die Funktion MysqlReadCol() liest eine Spalte einer Tabelle aus der Datenbank aus und gibt as Ergebnis als eindimensionales Array zurück. Wird mit $KeyName eine zweite Spalte angegeben, werden ihre Werte als Keys im Ergebnisarray verwendet.

Beispiel -
1. print_r(MysqlReadCol("SELECT `cpu`,`tower` FROM `computer`;","tower","cpu"));
3. Ausgabe:
4. Array(
5. 500 => "mini",
6. 700 => "mini",
7. 900 => "midi",
8. 1100 => "midi",
9. 1300 => "big"
10. );

return: Ein zweidimensionales Array welches das Abfrageergebnis enthält.

array MysqlReadCol (string $Query, [string $ColName = ""], [string $KeyName = ""])

string $Query: Der MySQL-Abfragebefehl.
string $ColName
string $KeyName: Der Name der Spalte dessen Werte für das Abfrageergebnis als Keys verwendet werden. Achtung: Wenn in dieser Spalte Werte doppelt auftreten, werden sich die einzelnen Zeilen "überschreiben" und somit bei der Abfrage Zeilen verloren gehen.

MysqlReadField (line 309)

Die Funktion MysqlReadField() liest ein Feld aus einer Tabelle der Datenbank aus und gibt dieses als string zurück.

Beispiel -
1. print_r(MysqlReadField("SELECT `id` FROM `computer` WHERE (`cpu`= 900);"));
3. Ausgabe:
4. 3

return: der Wert des abgefragten Feldes.

string MysqlReadField (string $Query, [string $ColName = 0], [ $TryOnly = false])

string $Query: Der MySQL-Abfragebefehl.
string $ColName: Der Name oder der Index Spalte in der sich das abzufragende Feld befindet.
$TryOnly

MysqlReadFieldByID (line 367)

void MysqlReadFieldByID ( $TableName, $FieldName, $ID, [ $TryOnly = false])

$TableName
$FieldName
$ID
$TryOnly

MysqlReadRow (line 281)

Die Funktion MysqlReadRow() liest eine Zeile aus einer Tabelle der Datenbank aus und gibt diese als eindimensionales Array zurück, wobei die Spaltennamen als Keys verwendet werden.

Beispiel -
1. print_r(MysqlReadRow("SELECT * FROM `computer` WHERE (`cpu`= 900);"));
3. Ausgabe:
4. Array(
5. "id" => 3,
6. "tower" => "midi",
7. "cpu" => 900 ,
8. "monitor" =>17
9. );

return: Die erste Zeile des Abfrageergebnisses.

array MysqlReadRow (string $Query, [ $TryOnly = false], [ $ErrorMsg = ""])

string $Query: Der MySQL-Abfragebefehl.
$TryOnly
$ErrorMsg

MysqlReadRowByID (line 362)

Die Funktion MysqlReadRowByID() liest die durch $ID angegebene Zeile der Tabelle $TableName aus der Datenbank aus. Die Rückgabe des Ergebnisses ist identisch mit MysqlReadRow().

Achtung: Diese Funktion kann nur auf Tabellen angewand werden, welche eine Spalte namens `id` besitzen!

return: Die angeforderte Zeile.
see: MysqlReadRow()

array MysqlReadRowByID (string $TableName, integer $ID, [bool $TryOnly = false])

string $TableName: der Name der Tabelle aus der die Zeile ausgelesen werden soll.
integer $ID: Die ID welche die Zeile idetifiziert.
bool $TryOnly: wenn true, wird keine Fehlermeldung ausgegeben sollte der angeforderte Datensatz nicht existieren.

MysqlReadRowByRight (line 440)

void MysqlReadRowByRight ( $TableName, $ID, $RightCols)

$TableName
$ID
$RightCols

MysqlShutdown (line 74)

void MysqlShutdown ()

MysqlWrite (line 331)

Die Funktion MysqlWrite() führt einen MySQL-Schreibbefehl aus. Zu den Schreibbefehlen zählen alle MySQL-Operationen welche den Datenbestand verändern. Z.B. INSERT, UPDTATE, DELETE, usw.

return: TRUE bei erfolg, ansonsten FALSE

bool MysqlWrite (string $Query, [string $ErrOnFail = ""])

string $Query: Der MySQL-Schreibbefehl
string $ErrOnFail: Eine Fehlermeldung welche ausgegeben wird wenn der Schreibbefehl nicht fehlerfrei ausgeführt werden konnte

MysqlWriteByID (line 387)

Die Funktion MysqlWriteByID() speichert einen Datensatz in einer mit $TableName angegebenen Tabelle.

Die zu speichernen Daten enthält das assotiative Array $Values. Der zu änderne Datensatz wird mit $ID angegeben. Wird $ID nicht angegeben wird ein neuer Datensatz erstellt. Achtung: Diese Funktion kann nur auf Tabellen angewand werden, welche eine Spalte namens `id` besitzen!

return: Die ID des geänderten/eingefügten Datensatzes bei Erfolg, ansonsten FALSE

integer MysqlWriteByID (string $TableName, array $Values, [integer $ID = 0], [string $ErrOnFail = ""], [bool $WriteID = false])

string $TableName: Der Name der Tabelle in welcher die Daten gepeichert werden soll.
array $Values
: Die zu speichernden Werte im Format:
1. Array("column1name" => "value1", "column2name" => "value2", ...)
integer $ID: Die ID des zu ändernen Datensatzes oder Null wenn ein neuer Datensatz angelegt werden soll.
string $ErrOnFail: Eine Fehlermeldung welche ausgegeben wird wenn der Schreibbefehl
bool $WriteID: Gibt an, ob $Values[id] auch in die Datenbank geschrieben werden soll. nicht fehlerfrei ausgeführt werden konnte

MysqlWriteByRight (line 448)

void MysqlWriteByRight ( $TableName, $Values, $RightCols, [ $ID = 0], [ $ErrOnFail = ""], [ $WriteID = false])

$TableName
$Values
$RightCols
$ID
$ErrOnFail
$WriteID

TblPrefix (line 499)

void TblPrefix ()

toTimestamp (line 484)

void toTimestamp ( $date)

$date

_MysqlGetRightWhere (line 426)

void _MysqlGetRightWhere ( $ID, $RightCols)

$ID
$RightCols

Documentation generated on Mon, 22 Oct 2007 17:17:19 +0200 by phpDocumentor 1.3.1