sesam_field_array

(PHP 3 CVS only)

sesam_field_array --  Liefert Meta-Information über einzelne Ergebnisspalten

Beschreibung

array sesam_field_array ( string result_id)

result_id ist eine gültige Ergebniskennung (?) der Funktion sesam_query().

Liefert eine gemischtes assoziativ indiziertes Array (???) mit Meta-Informationen (Spaltenname, Typ, Genauigkeit, ...) über einzelne Ergebnisspalten nach einer mit result_id assoziierten Abfrage.

Tabelle 1. Von sesam_field_array() gelieferter gemischter Ausgabesatz

Array ElementContents
int $arr["count"]Gesamtanzahl von Zeilen im Ausgabesatz (oder NULL bei "immediate" Abfragen). SESAM "multiple fields" sind "inlined" (???) und werden werden wie die entsprechende Anzahl von Spalten behandelt.
string $arr[col]["name"]Spaltenname für column(col), wobei col zwischen 0 und $arr["count"]-1 liegt. Für dynamisch berechnete Spalten kann der gelieferte Wert auch ein Leer-String sein. SESAM "multiple fields" sind "inlined" (???) und werden wie die entsprechende Anzahl von Spalten behandelt , jedes mit dem selben Spaltennamen.
string $arr[col]["count"]"count" ist der Wiederholungsfaktor, wenn die Spalte als "multiple field" definiert wurde (normalerweise 1). Die erste Spalte einer "multiple field"-Spalte enthält dagegen die Anzahl von Wiederholungen (in der zweiten und in allen weiteren Spalten ist "count" 1), was zur Identifikation von "multiple fields" im Ergebnissatz verwendet werden kann. Das Beispiel in der Beschreibung von sesam_query() demonstriert die Anwendung des "count"-Attributes.
string $arr[col]["type"]PHP-Variablentyp der Daten für column(col), wobei col zwischen und $arr["count"]-1 liegt. Der gelieferte Wert kann (abhängig vom SQL-Typ des Ergebnisses) einer der folgenden sein:

  • "integer"

  • "double"

  • "string"

SESAM "multiple fields" sind "inlined" (???) und werden wie die entsprechende Anzahl von Spalten behandelt, jedes mit dem selben PHP-Typ.
string $arr[col]["sqltype"]SQL-Variablentyp der Spaltendaten für column(col), wobei col zwischen 0 und $arr["count"]-1 liegt. Der gelieferte Wert kann abhängig vom SQL-Typ des Ergebnisses einer der folgenden sein:

  • "CHARACTER"

  • "VARCHAR"

  • "NUMERIC"

  • "DECIMAL"

  • "INTEGER"

  • "SMALLINT"

  • "FLOAT"

  • "REAL"

  • "DOUBLE"

  • "DATE"

  • "TIME"

  • "TIMESTAMP"

SESAM "multiple fields" sind "inlined" (???) und werden wie die entsprechende Anzahl von Spalten behandelt, jedes mit dem selben SQL-Typ.
string $arr[col]["length"]Das Attribut "length" der SQL-Variablen in column(col), wobei col zwischen 0 und $arr["count"]-1 liegt. Das "length" Attribut wird in "CHARACTER" und "VARCHAR" SQL-Typen zur Spezifizierung der (maximalen) Länge der Zeichenvariablen verwendet. SESAM "multiple fields" sind "inlined" (???) und werden wie die entsprechende Anzahl von Spalten behandelt, jedes mit dem selben Längenattribut.
string $arr[col]["precision"]Das Attribut "precision" der SQL-Variablen in column(col), wobei col zwischen 0 and $arr["count"]-1 liegt. Das Attribut "precision" wird für numerische und Zeit-Felder verwendet. SESAM "multiple fields" sind "inlined" (???) und werden wie die entsprechende Anzahl von Spalten behandelt, jedes mit dem selben Attribut "precision".
string $arr[col]["scale"]Das Attribut "scale" der SQL-Variablen in column(col), wobei col zwischen 0 and $arr["count"]-1 liegt. Das Attribut "scale" wird für numerische Datentypen verwendet. SESAM "multiple fields" sind "inlined" (???) und werden wie die entsprechende Anzahl von Spalten behandelt, jedes mit dem selben Attribut "scale".

Siehe Beschreibung von sesam_query() für eine beispielhafte Anwendung der Funktion sesam_field_array().