ClanSphere 2010 - Funktionen
Weitere Hilfen
| HTML Funktionen | nach oben |
| Allgemeines zur Schreibweise und Hinweise | |
| Die Variablen in den Klammern sind die Parameter der Funktionen. Nicht alle Parameter müssen an eine Funktion übergeben werden, optionale Parameter sind in eckigen Klammern [ ]. Ist eine Variable optional, hat sie einen Standard Wert. Dieser ist in den Runden Klammern hinter der Variable zu finden. Ist der Standard Wert 0, so heisst das entweder, dass die Variable nicht benutzt wird, oder, dass statt dem übergebenen Parameter eine vordefinierte Variable benutzt wird. Die Variable "Funktion" ist wie "An / Aus" oder "Anfang / Ende". 1 ist dabei an, 0 aus. | |
| cs_html_br(Anzahl) | |
| Diese Funktion gibt "Anzahl" HTML Zeilenumbrüche zurück. | |
| cs_html_hr(Breite) | |
| Diese Funktion gibt eine Trennlinie mit der Breite "Breite" zurück. | |
| cs_html_img(Bildpfad [, Höhe (0) [, Breite (0) [, Mehr (0) [, Alternativ-Text (leer) ] ] ] ]) | |
| -- | |
| cs_html_link(Zieladresse, Anzeige [, Neues Fenster (1) [, Klasse (0) [, Titel (0) ] ] ]) | |
| -- | |
| cs_html_anchor(Name [, Text (leer) [, Mehr (leer) ] ]) | |
| -- | |
| cs_html_option(Name, Wert [, Gewählt (0) [, CSS Style (0) ] ]) | |
| -- | |
| cs_html_underline(Funktion) | |
| Unterstrichene Schrift. | |
| cs_html_big(Funktion) | |
| Fette Schrift. | |
| cs_html_italic(Funktion) | |
| Kursive Schrift. | |
| cs_html_list(Zeichenkette [, CSS Style (0) [, Trennelement ([*]) ] ]) | |
| SQL Funktionen | nach oben |
| Sicherheitsleitfaden | |
| Dieser Abschnitt nannte sich damals "Sicherheitsleitfaden" und ist eigentlich auch einer, da die mitunter meist
ausgenutzte Schwachstelle derzeit in der Kommunikation zwischen Script und Datenbank geschieht indem Befehle an eben diese
manipuliert werden. Um dies zu vermeiden sollte jeder Modul- und/oder Addon-ersteller das folgende Tutorial wie seine
Sicherheitsbibel behandeln und im Zweifelsfall hier nachsehen. Textstellen die farblich Fett oder Farbig hervorgehoben sind sollten dabei besonders beachtet werden, wobei speziell die rote Farbe eine Gefahrenstelle markiert. Dateinamen und Verzeichnisse sind an der cyan Farbe zu erkennen. Die Klammern [ und ] kennzeichnen Optional mögliche Zusätze und sind nicht notwendig, aber oftmals hilfreich. Achtung: Bei roter Hervorhebung besteht die akute Gefahr der SQL-Injektion! Daten aus globalen Arrays wie z.B. $_GET, $_POST, $_REQUEST usw., sowie andere oder auch bereits gespeicherte Benutzer-Eingaben sind hier erst nach Filterung über die Funktion '''cs_sql_escape''' zu verwenden! | |
| cs_sql_connect(array Verbindungsdaten, [int Test]) | |
| Die Verbindungsdaten werden aus der setup.php ausgelesen. Im Regelfall wird hier das Array $cs_db übergeben
und ausgewertet. Diese Funktion wird beim Single-SQL-Server-Betrieb auf den ClanSphere normalerweise ausgelegt ist nur in der Start-Datei wie z.B. der index.php benötigt und dort aufgerufen um die Verbindung zur Datenbank zu initialisieren. Der optionale Parameter Test ist zum Überprüfen von Verbindungen, z.B. bei der Installation, gedacht. Beispiel: $cs_db['con'] = cs_sql_connect($cs_db); Dabei wird das Verbindungsobjekt in die Array-Variable 'con' von $cs_db gesichert. | |
| cs_sql_count(var Datei, var SQL-Tabelle(n), [var Bedingungen, [var Eindeutig]]) ) | |
| Mit dieser Funktion werden Zahlen als Integer abgeholt, z.B. um eine Anzahl oder Existenz von Datensätzen festzustellen.
Als Datei wird im Regelfall nur __FILE__ übergeben, ein in PHP vordefinierter Wert der den Dateinamen weiterreicht um im Fehlerfall den Ursprung zu finden. Die SQL-Tabelle ist ohne Prefix anzugeben, sofern weitere SQL-Tabellen per JOIN folgen sind die folgenden mit dem Prefix anzugeben und zudem für alle SQL-Tabellen Abkürzungen zu definieren, z.B. sqd für {pre}_squads. Bedingungen sind die Entsprechung für die WHERE-Klausel bei normalen SQL-Queries und sind ohne das WHERE anzugeben. Beachtet bei vorhandenen JOINS bei den SQL-Tabellen, hier die Spalten, der Identifikation wegen, mit ihrer Abkürzung anzusprechen, z.B. {pre}_squads.squads_id angeben als sqd.squads_id. Das mitgeben der Option Eindeutig legt fest welche Spalten bei der Abfrage jeweils nur einmal je aufgefundenem Wert berücksichtigt bzw. darüber zusammengefasst werden. Dies erfordert oft ausgibiges Testen um das Ziel zu erreichen. Beispiel: $number_of_squads = cs_sql_count(__FILE__, 'squads'); Liest die Anzahl der in der SQL-Tabelle {pre}_squads eingetragenen Squads aus und liefert das Resultat als Integer | |
| cs_sql_delete(var Datei, var SQL-Tabelle(n), int ID, [var Feldname]]) | |
| Als Datei wird im Regelfall nur __FILE__ übergeben, ein in PHP vordefinierter Wert der den Dateinamen weiterreicht
um im Fehlerfall den Ursprung zu finden. Die SQL-Tabelle ist ohne Prefix anzugeben, sofern weitere SQL-Tabellen per JOIN folgen sind die folgenden mit dem Prefix anzugeben und zudem für alle SQL-Tabellen Abkürzungen zu definieren, z.B. sqd für {pre}_squads. Die ID gibt an welcher Datensatz betroffen ist, wobei der Feldname sich aus der folgenden Option ergibt. Der Feldname ist Standardmäßig die SQL-Tabelle ohne Prefix mit _id dahinter, also bei {pre}_squads würde dies squads_id entsprechen. Um einen anderen Feldnamen anzusprechen bzw. unter verwendung von JOINS bei den SQL-Tabellen ist es hier erforderlich eine Angabe zu machen. Beispiel: cs_sql_delete(FILE, 'squads', 5); Dies würde die ID 5 aus der Tabelle {pre}_squads entfernen | |
| cs_sql_escape(var Daten) | |
| Die Daten werden gegen SQL-Injektion gesichert, indem gefährliche Zeichen durch, für die Datenbank gekennzeichnete,
gleiche Zeichen ersetzt werden. Dies hat im Normalfall keine Auswirkungen auf die Daten an sich, falls doch kann es sein das
die veralteten PHP-Optionen magic_quotes_gpc oder magic_quotes_runtime auf dem Webserver aktiviert sind, unbedingt abschalten
(off)! Solltet ihr keinen Zugriff auf diese Optionen haben, dann bittet euren Provider um die Umstellung. Hinweis: Mit PHP 6 fallen die magic_quotes Funktionen eh weg, falls der Provider sich also weigern sollte diese abzuschalten wird ihn spätestens dieses Argument überzeugen. Zudem ist es unprofessionelle Stützradprogrammierung sich auf diese zu verlassen! Tipp: Achtet darauf das Daten nicht mehrfach abgesichert werden, dies hat ungewollte Nebenwirkungen (z.B. das sich diverse Zeichen öfter als ursprünglich wiederholen)! Beispiel: $secure_string = cs_sql_escape('this is a simple string'); Dies sichert die Daten die der Funktion übergeben werden ab um zu verhindern das diese folgende SQL-Anfragen beeinflussen. | |
| cs_sql_insert (var Datei, var SQL-Tabelle, array Feldnamen, array Werte) | |
| Als Datei wird im Regelfall nur __FILE__ übergeben, ein in PHP vordefinierter Wert der den Dateinamen weiterreicht
um im Fehlerfall den Ursprung zu finden. Die SQL-Tabelle ist ohne Prefix anzugeben. Alle Feldnamen, wobei auch nur einer angegeben werden kann, sind als Array zu liefern. Dieser wird dann in der vorher festgelegten Sortierung abgearbeitet und muss die gleiche Anzahl Array-Elemente enthalten wie der Werte-Array. Mit den Werten verhält es sich genau wie mit den Feldnamen, nur das hier die zu verwendenen Daten enthalten sind. Beispiel: cs_sql_insert(FILE, 'squads', array('squads_name'), array('example_squad')); Dies würde den example_squad in die SQL-Tabelle {pre}_squads eintragen |
|
| cs_sql_insertid (var Datei) | |
| Als Datei wird im Regelfall nur __FILE__ übergeben, ein in PHP vordefinierter Wert der den Dateinamen weiterreicht
um im Fehlerfall den Ursprung zu finden. Liefert die ID der letzten cs_sql_insert Ausführung und sollte möglichst direkt nach diesem Befehl verwendet werden. Diese Funktion wird z.B. verwendet um die Themen-ID des gerade erstellten Themas zu holen um den Benutzer direkt auf dieses Thema weiterzuleiten. Beispiel: $created_squad_id = cs_sql_insertid(); Holt die ID vom zuletzt gespeicherten Datensatz als Integer | |
| cs_sql_option(var Datei, var Modul) | |
| Als Datei wird im Regelfall nur __FILE__ übergeben, ein in PHP vordefinierter Wert der den Dateinamen weiterreicht
um im Fehlerfall den Ursprung zu finden. Das Modul entspricht meistens dem Verzeichnisnamen vom Modul, dessen Optionen als Array abgeholt werden sollen. Tipp: Alle globalen Optionen vom Modul clansphere sind bereits im Array $cs_main verfügbar. Beispiel: $squad_options = cs_sql_option(FILE, 'squads'); Damit wären alle Optionen vom Modul Squads im Array $squads_options vorhanden | |
| cs_sql_query(var Datei, var Anfrage) | |
| Als Datei wird im Regelfall nur __FILE__ übergeben, ein in PHP vordefinierter Wert der den Dateinamen weiterreicht
um im Fehlerfall den Ursprung zu finden. Die Anfrage ist ein vollständiges SQL-Query und sollte daher keine Befehle enthalten die vom SQL-Standard abweichen (SQL 2003 Core bzw. vorher SQL 99). Folgende SQL-Befehle sollten z.B. vermieden werden: ALTER TABLE CHANGE ... , ALTER TABLE ALTER ... Um den Erfolg auszuwerten liefert die Funktion im Fehlerfall den Integer 0 und bei Erfolg einen Array mit dem Element affected_rows zurück in dem als Integer die Anzahl betroffener Datensätze enthalten ist. Beispiel: $query_result = cs_sql_query(FILE, 'UPDATE {pre}_squads SET squads_name = 'test' WHERE squads_id = 3'); Dies setzt den Squadnamen bei dem Squad mit der ID 3 auf den Wert test | |
| cs_sql_select(var Datei, var SQL-Tabelle(n), var Feldnamen, [var Bedingungen, [var Sortierung, [int Anfang, [int Anzahl]]]]) | |
| Als Datei wird im Regelfall nur __FILE__ übergeben, ein in PHP vordefinierter Wert der den Dateinamen weiterreicht
um im Fehlerfall den Ursprung zu finden. Die SQL-Tabelle ist ohne Prefix anzugeben, sofern weitere SQL-Tabellen per JOIN folgen sind die folgenden mit dem Prefix anzugeben und zudem für alle SQL-Tabellen Abkürzungen zu definieren, z.B. sqd für {pre}_squads. Die Feldnamen entsprechen dem SELECT Abschnitt eines SQL-Queries und sind ohne das SELECT zu übergeben. Nur ein * zu übergeben um alle Feldnamen zu selektieren wird aus Geschwindigkeitsgründen nicht empfohlen, da die meisten SQL-Server dann mehr Zeit verbrauchen um die Meta-Tabelle abzufragen welche Feldnamen überhaupt verfügbar sind. Beachtet bei vorhandenen JOINS bei den SQL-Tabellen, hier die Spalten, der Identifikation wegen, mit ihrer Abkürzung anzusprechen, z.B. {pre}_squads.squads_id angeben als sqd.squads_id und zudem ein alias zu setzen um diese in der Ausgabe wie gewohnt benutzen zu können, z.B. sql.squads_id AS squads_id. Bedingungen sind die Entsprechung für die WHERE-Klausel bei normalen SQL-Queries und sind ohne das WHERE anzugeben. Beachtet bei vorhandenen JOINS bei den SQL-Tabellen, hier die Spalten, der Identifikation wegen, mit ihrer Abkürzung anzusprechen, z.B. {pre}_squads.squads_id angeben als sqd.squads_id. Die Sortierung entspricht dem ORDER BY Abschnitt eines SQL-Queries und ist ohne das ORDER BY zu übergeben. Standardmäßig wird vorwärts (ASC) sortiert, dies kann mit dem Anhängen von DESC hinter den Feldnamen umgedreht werden. Beachtet bei vorhandenen JOINS bei den SQL-Tabellen, hier die Spalten, der Identifikation wegen, mit ihrer Abkürzung anzusprechen, z.B. {pre}_squads.squads_id angeben als sqd.squads_id. Der Anfang legt die Treffernummer fest aber der für das Auslesen selektiert wird, wobei es mit 0 los geht und auch 0 der Standardwert ist wenn der Parameter unausgefüllt bleibt. Die Anzahl legt fest wie viele Datensätze ab dem Anfang selektiert werden. Standard ist hier 1 und daher wird dann auch bei Erfolg nur ein eindimensionales Array zurückgeliefert. Bei 0 werden Alle und bei Zahlen über 1 die jeweilige Anzahl selektiert, was dann egal wie viele Treffer es am Ende tatsächlich werden zu einem zweidimensionalen Array ändert. Achtung: Aufgrund der Anzahl und verwundbarkeit der Parameter ist vor allem bei dieser Funktion auf die Sicherheit zu achten! Beispiel: $squad_data = cs_sql_select(FILE, 'squads', 'squads_id, squads_name', 0, 'squads_name DESC', 0, 0); Als Resultat wären alle Squads vorhanden mit ihrer ID und dem Namen, rückwärts nach ihrem Namen sortiert. | |
| cs_sql_update(var Datei, var SQL-Tabelle, array Feldnamen, array Werte, int ID, [var [Bedingungen]) | |
| Als Datei wird im Regelfall nur __FILE__ übergeben, ein in PHP vordefinierter Wert der den Dateinamen weiterreicht
um im Fehlerfall den Ursprung zu finden. Die SQL-Tabelle ist ohne Prefix anzugeben. Alle Feldnamen, wobei auch nur einer angegeben werden kann, sind als Array zu liefern. Dieser wird dann in der vorher festgelegten Sortierung abgearbeitet und muss die gleiche Anzahl Array-Elemente enthalten wie der Werte-Array. Mit den Werten verhält es sich genau wie mit den Feldnamen, nur das hier die zu verwendenen Daten enthalten sind. Die ID gibt an welcher Datensatz betroffen ist, wobei der Feldname sich aus der folgenden Option ergibt. Der Feldname ist Standardmäßig die SQL-Tabelle ohne Prefix mit _id dahinter, also bei {pre}_squads würde dies squads_id entsprechen. Um einen anderen Feldnamen anzusprechen muss als ID 0 und zudem eine Bedingung übergeben werden. Bedingungen sind die Entsprechung für die WHERE-Klausel bei normalen SQL-Queries und sind ohne das WHERE anzugeben. Beispiel: cs_sql_update(FILE, 'squads', array('squads_name'), array('alpha_squad'),4); Setzt bei Squad ID 4 den Squadnamen auf alpha_squad | |
| cs_sql_version(var Datei) | |
| Als Datei wird im Regelfall nur __FILE__ übergeben, ein in PHP vordefinierter Wert der den Dateinamen weiterreicht
um im Fehlerfall den Ursprung zu finden. Liefert einen Array mit folgenden Daten zurück: type, host, client, server. Bei MySQL-Erweiterungen werden auch folgende Elemente genutzt: data_size, index_size, tables. Hinweis: Diese Informationen oft bzw. sogar auf jeder Unterseite abzufragen kann bei MySQL-Erweiterungen zu Geschwindigkeitsverlusten führen. Daher sind diese Informationen für Administratoren zentral unter System -> Software gelistet. Beispiel: $sql_infos = cs_sql_version(FILE); Liest als Array alle zur Datenbank verfügbaren Details aus | |