Weitere Informationen zum Relaunch von Rostock.de
Weitere Informationen zum Relaunch von Rostock.de Weiter zu rostock.de

Funktionsbibliothek

In diesem Abschnitt erhalten Sie einen Überblick über die im System enthaltenen Funktionen, Klassen und Methoden. Aufgeführt werden (sofern verfügbar) neben den Namen der pro Datei verfügbaren Funktionen zusätzliche Beschreibungstexte und die jeweils zum Aufruf der Funktionen erforderlichen Parameter. Abhängig von der genutzten Lizenz müssen nicht alle der hier gelisteten Dateien und Funktionen vorhanden sein.

Weitere Seiten: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102

Datei "/config.dir.php"

Funktionen in der Datei "/config.dir.php" (Name der Funktion, Beschreibung, Parameter):

config_error() Liefert eine Fehlermeldung aus, wenn die Datenbank und/oder das Vorlagenset nicht erreichbar sind. $type

Kommentieren Kommentieren (0 Kommentare)

Datei "/functions.php"

Funktionen in der Datei "/functions.php" (Name der Funktion, Beschreibung, Parameter):

__get() Startet die Initialisierung eines Modules bei Bedarf, sofern dieses noch nicht geladen wurde. Kein manueller Aufruf erforderlich. $module
admin_actions() Erstellt eine ein- oder mehrzeilige horizontale Navigation mit Titel und Beschreibung zum Springen in Unterseiten.
Aufruf: $GLOBALS["cpmodule"]->admin_actions(array("[ARRAY]"));
$array, $return = "0"
admin_box_break() Fügt in eine Box einen Unterbrechung inkl. optionalem Text ein, um die Übersichtlichkeit zu erhöhen.
Aufruf: $GLOBALS["cpmodule"]->admin_box_break("[COMMENT]", "[PADDING]");
$comment = "", $padding = "1"
admin_box_start() Zeigt den Anfang einer Box im Administrationsbereich an.
Aufruf: $GLOBALS["cpmodule"]->admin_box_start("[TITLE]", "[CLEANUP]", "[TYPE]", "[EDIT_CONTROL]", "[REFRESH_CONTROL]", "[REFRESH_URL]", "[CUSTOM_CONTROLS]");
$title = "", $cleanup = "1", $type = "1", $edit_control = "", $refresh_control = "", $refresh_url = "", $custom_controls = ""
admin_box_stop() Zeigt das Ende einer Box im Administrationsbereich an.
Aufruf: $GLOBALS["cpmodule"]->admin_box_stop();
admin_change_message() Zeigt einen Hinweis über eine erfolgreich durchgeführte Operation im Administrationsbereich an.
Aufruf: $GLOBALS["cpmodule"]->admin_change_message("[MESSAGE]", "[TITLE]", "[RETURN]");
$message, $title = "", $return = "0"
admin_empty_message() Zeigt einen Hinweis über ein leeres Ergebnis im Administrationsbereich an (für Übersichten / Suchanfragen).
Aufruf: $GLOBALS["cpmodule"]->admin_empty_message("[MESSAGE]", "[RETURN]");
$message = "", $return = "0"
admin_entry_navigation() Erstellt die Navigation beim Bearbeiten von Einträgen mit den Vor-/Zurück-Links und der aktuellen Position in den Einträgen.
Aufruf: $GLOBALS["cpmodule"]->admin_entry_navigation("[TABLE]", "[NUMBER]", "[URL]", "[QUERY]", "[FIELD]", "[TEXT]");
$table, $number, $url, $query = "", $field = "number", $text = "", $return = "0"
admin_jump_navigation() Erstellt eine einzeilige, horizontale Navigation zum Springen zwischen Bereichen auf längeren Seiten.
Aufruf: $GLOBALS["cpmodule"]->admin_jump_navigation(array("[ARRAY]"));
$array, $return = "0"
admin_legend() Liefert die Legende für Icons in den Übersichten und Formularen im Administrationsbereich zurück.
Aufruf: $GLOBALS["cpmodule"]->admin_legend(array("[OPTIONS]"), "[RETURN]");
$array, $return = "0"
admin_meta_selection() Erstellt eine Mehrfachauswahl für Einträge unterhalb einer Tabelle.
Aufruf: $GLOBALS["cpmodule"]->admin_meta_selection("[ELEMENT]", "[RETURN]");
$element, $return = "0"
admin_pagination() Erstellt die Blätternavigation unterhalb einer Tabelle, "[ID]" in der URL wird durch die jeweilige Seitennummer ersetzt.
Aufruf: $GLOBALS["cpmodule"]->admin_pagination("[URL]", "[TITLE]", "[CURRENT]", "[SHOW_MAX]", "[RETURN]");
$url, $total, $current = 1, $show_max = 8, $return = "0"
admin_standard_message() Zeigt einen Hinweis über eine erforderliche Operation im Administrationsbereich an (z.B. über ein notwendiges Update).
Aufruf: $GLOBALS["cpmodule"]->admin_standard_message("[MESSAGE]", "[TITLE]", "[RETURN]");
$message, $title = "", $return = "0"
admin_warning_message() Zeigt einen Hinweis über eine nicht erfolgreich durchgeführte Operation bzw. eine Warnung im Administrationsbereich an.
Aufruf: $GLOBALS["cpmodule"]->admin_warning_message("[MESSAGE]", "[TITLE]");
$message, $title = "", $return = "0"
breadcrumb() Liefert die Breadcrumb-Navigation im Frontend in verschiedenen Modulen zurück.
Aufruf: $GLOBALS["cpmodule"]->breadcrumb(array("[ARRAY]"), "[SHOW_BASE]", "[RETURN]");
$array, $show_base = "1", $return = "0"
change_language() Zeigt die Flaggen für den Wechsel zwischen den Sprachen an. $mode = ""
cp_array_average() Ermittelt den Durchschnitt der Zahlenwerte in einem Array. $array, $start = "", $stop = ""
cp_array_structure() Zeigt ein Array in einer Baumstruktur an. $array, $level = "0"
cp_array_sum() Summiert die Zahlenwerte in einem Array. $array, $start = "", $stop = ""
cp_compress() Führt die Komprimierung und optimierte Auslieferung der Seiten durch. $level = "5", $debug = "0", $contents = ""
cp_compress_gzip() Überprüft die für die GZIP-Komprimierung erforderlichen Einstellungen.
cp_container_cache() Erzeugt einen temporären Dateinamen für einen Container. $form
cp_content_cache() Liest einen Inhalt von einer URL ein und legt diesen im Cache ab bzw. liefert den Inhalt direkt aus dem Cache, sofern noch aktuell. $url, $time_max = "3600", $directory = "", $prefix = ""
cp_currency_info() Liefert ein Array der Währungen nach ISO 4217 zurück. $string = ""
cp_delete_cache() Löscht eine temporäre Datei aus dem Cache. $path, $filename
cp_download_file() Lädt eine via $filename übermittelte Datei herunter. $filename, $file_length = "", $mime_type = "application/octet-stream", $cache = "1"
cp_error_log() Fängt Fehlermeldungen des Systems ab und setzt einen neuen Logeintrag. $errno, $errmsg, $filename, $linenum
cp_escape_array() Überprüft die Angaben in einem Array vor der Übergabe in die Datenbank. $array
cp_file_type_image() Gibt das zugehörige Bild für einen Dateityp zurück. $type
cp_file_upload() Lädt eine einzelne Datei auf dem Server in einen angegebenen Ordner. $path, $file
cp_form_tunnel() Erstellt einen Form-Tunnel für die Übergabe von Variablen. $type, $params
cp_form_tunnel_breaks() Reinigt die Variablen für die Übermittelung mittels eines Form-Tunnels. $string
cp_form_tunnel_clean() Passt die über einen Form-Tunnel übermittelten Variablen an. $string
cp_get_cache() Liest den Status einer temporären Datei im Cache. $path, $filename, $time_max = "3600", $delete_oldfile = "1"
cp_get_country() Liefert eine Angabe zu einem einzelnen Land zurück (Domainkürzel, Titel). $number, $field = "title"
cp_header_cget() Setzt den ETag-Header für das Datum der letzten Änderung der Seite. $timestamp
cp_include() Bindet eine Text-, HTML- oder PHP-Datei ein. $url, $type = ""
cp_is_editable() Überprüft, ob Dateityp in der Dateiverwaltung bearbeitet werden kann. $file_type
cp_is_inside() Überprüft, ob sich ein Aufruf innerhalb des Systems befindet. $string
cp_key_exists() Überprüft, ob ein Schlüssel in einem Array vorhanden ist. $array, $key
cp_lang_info() Liefert ein Array der Sprachen nach ISO 639-1 zurück. $string = ""
cp_magic_metatags() Erstellt automatisch Schlüsselwörter für die Metatags aus einem Text. $content, $max_metatags = ""
cp_main_header() Erzeugt die obere Breadcrumb-Navigation für ein Modul. $basics, $array
cp_meta_tags() Sorgt für die richtige Verwendung der im System allgemein bzw. für die Module hinterlegten Metatags. $content
cp_mime_info() Liefert Informationen über den MIME-Typ eines Dateiformates zurück. $string = ""
cp_module_exists() Überprüft, ob ein Modul im System vorhanden ist. $name
cp_php_version() Ermittelt die auf dem Server zur Verfügung stehende PHP-Version.
cp_print_r() Funktions-Wrapper für die Standard-Funktion print_r(). $array, $key = ""
cp_random_string() Erzeugt einen zufallsgenerierten String beliebiger Länge. $length
cp_read_cache() Lädt eine temporäre Datei aus dem Cache. $path, $filename, $return = "0"
cp_return_request() Wechselt nach dem Aufruf einer Funktion auf eine bestimmte URL, sofern der Parameter "cleanajax" in der URL fehlt. $url, $http_status = ""
cp_set_cache() Schreibt eine temporäre Datei in den Cache. $content, $path, $filename
cp_set_log() Fügt einen neuen Eintrag zum Log des Systems hinzu (z.B. Fehler- und Statusmeldungen). $name, $message = "", $module = "", $number = "", $user = ""
cp_siteinfo() Liefert Informationen über einen Mandanten anhand des internen Namens zurück. $name, $field
cp_sql_split() Zerteilt eine angelieferte Datei in die einzelnen SQL-Befehle. $string
cp_string_format() Konvertiert Sonderzeichen in das Unicode-Format. $text, $specialchars = "1"
cp_urlencode_array() URL-kodiert die Angaben in einem Array vor der Übergabe per URL. $array
cp_validate_color() Validiert eine Farbangabe im Standardformat (z.B. "#FFFFFF"). $query
cp_validate_email() Validiert eine Email-Adresse im Standardformat. $string
cp_validate_number() Überprüft, ob der übergebene Wert eine Zahl ist. $number
cp_validate_string() Überprüft, ob der übergebene Wert den Kriterien entspricht. $string, $min = "", $max = ""
cp_word_shorten() Verkürzt die maximale Länge von Worten in einem Text. $string, $length = "50"
database_in() Überprüft einen Text, bevor dieser in die Datenbank eingefügt wird. $text, $options = array()
form_file() Zeigt das Formularelement für den Dateiupload an. Parameter: "action", "method", "name" $action, $method = "post", $name = "form_standard", $onsubmit = ""
form_hidden() Zeigt ein verstecktes Formularelement an. Parameter: "name", "value", "id" $name, $value, $id = ""
form_moveonsite() Zeigt das Formularelement für einen Button zum Wechsel auf eine neue Seite an. Parameter "target", "text", "relocate", "onclick" $target, $value, $relocate = "1", $onclick = "", $class = "inputsubmit"
form_send() Zeigt das Formularelement zum Abschicken des Formulars an. Parameter: "onclick", "button", "value" $onclick = "", $button = "", $value = ""
form_start() Wrapper-Funktionen für die Generierung von Formularelementen. $action, $method = "post", $name = "form_standard", $onsubmit = ""
form_start_wysiwyg() Wrapper-Funktionen für die Generierung von Formularelementen mit einem WYSIWYG-Editor. $action, $method = "post", $name = "form_standard", $enctype = ""
form_stop() Schließt ein über form_start() bzw. form_start_wysiwyg() geöffnetes Formular ab.
form_text() Zeigt das Formularelement für die Eingabe eines einzeiligen Textes an. Parameter: "name", "class", "value", "length", "id", "disabled" $name, $class, $value, $length, $id = "", $disabled = "", $tabindex = "", $placeholder = ""
form_textarea() Zeigt das Formularelement für die Eingabe eines mehrzeiligen Textes an. Parameter "name", "class", "rows", "value", "id", "disabled" $name, $class, $rows, $value, $id = "", $disabled = ""
form_url() Passt einzelne Zeichen in einer URL für XHTML an. $string
form_wysiwyg() Zeigt das Formularelement für den WYSIWYG-Editor an. Parameter: "options", "name", "force_textarea" $options, $name, $force_textarea = "0"
form_wysiwyg_clean() Säubert die per WYSIWYG-Editor generierten Inhalte. $string
get_dir() Ermittelt die Dateien in einem einzelnen Ordner. $sPath, $var, $return = ""
get_random() Ermittelt zufällig einen Eintrag aus der Datenbanktabelle "*_random". $type
image_nav() Generiert eine Navigation auf der Basis einer Grafik. $quality = "75"
initialize_module() Lädt bei Bedarf automatisch ein bestimmtes Modul, sobald auf eine Methode des Modules zugegriffen wird. Kein manueller Aufruf erforderlich. $module
js_check() Erzeugt eine Javascript-Funktion zur Formular-Validierung. $form, $fields, $alert, $function_name = "check_form", $return = "", $return_string = "", $insert_after = "", $insert_before = "", $insert_last = ""
linkshyper() Nimmt Formatierungen an einem Text vor (Links und Emails markieren etc.). $text, $mode
mod_rewrite_name() Erzeugt einen für mod_rewrite geeigneten Dateinamen. $number, $title, $module = "article", $onlyname = ""
mod_rewrite_string() Erzeugt einen für mod_rewrite geeigneten Dateinamen. $string
module_access_restricted() Gibt eine Fehlermeldung bei unberechtigtem Zugriff aus.
module_language() Lädt die Sprachdatei zu einem gewünschten Modul. $module = ""
pagination() Liefert die Blätternavigation im Frontend in verschiedenen Modulen zurück.
Aufruf: $GLOBALS["cpmodule"]->pagination(array("[ARRAY]"), "[RETURN]");
$array, $return = "0"
revert_htmlspecialchars() Kehrt die Wirkungsweise der PHP-Funktion htmlspecialchars() um. $string
sendsql() Übermittelt SQL-Befehle an die Datenbank. $type, $filename
simplexml2array() Wandelt ein SimpleXML-Objekt in ein Array um. $xml
simplexml2load() Lädt eine XML-Datei und liefert diese als Array zurück. $file, $cache = "0", $is_string = "0"
tablefooter() Erstellt das Ende einer Tabelle auf der Basis einer Vorlage. $title = ""
tabletop() Erstellt den Beginn einer Tabelle auf der Basis einer Vorlage. $title = "", $cleanup = "1", $type = "1", $edit_control = "", $refresh_control = "", $refresh_url = "", $custom_controls = ""
tools_getmicrotime() Timer-Funktionen für die Überprüfung der zur Generierung der Seite benötigten Zeit.
tools_timerStart() Startet den Timer für die Überprüfung der zur Generierung der Seite benötigten Zeit.
tools_timerStop() Stopt den Timer für die Überprüfung der zur Generierung der Seite benötigten Zeit. $decimals = "4"
validate_email() Überprüfung des Formats einer Email-Adresse. $address
visitorsonline() Ermittelt die Anzahl der momentanen Besucher auf der Seite. $seconds = 1800

Kommentieren Kommentieren (0 Kommentare)

Datei "/install.php"

Funktionen in der Datei "/install.php" (Name der Funktion, Beschreibung, Parameter):

install_check() - Keine Beschreibung verfügbar. - $type
install_connect() - Keine Beschreibung verfügbar. - $form
install_db() - Keine Beschreibung verfügbar. - $error = "", $data = ""
install_error() - Keine Beschreibung verfügbar. - $error
install_get_db() - Keine Beschreibung verfügbar. - $path
install_license() - Keine Beschreibung verfügbar. -
install_main() - Keine Beschreibung verfügbar. - $error = "", $data = ""
install_setup() - Keine Beschreibung verfügbar. - $contents, $form
install_step_1() - Keine Beschreibung verfügbar. - $form
install_step_2() - Keine Beschreibung verfügbar. - $form
install_step_3() - Keine Beschreibung verfügbar. -
install_step_4() - Keine Beschreibung verfügbar. - $form
install_step_5() - Keine Beschreibung verfügbar. -

Kommentieren Kommentieren (0 Kommentare)

Datei "/update.php"

Funktionen in der Datei "/update.php" (Name der Funktion, Beschreibung, Parameter):

changes() - Keine Beschreibung verfügbar. - $old_file, $new_file
check_errors() - Keine Beschreibung verfügbar. - $file, $file_title, $array
compare() - Keine Beschreibung verfügbar. - $old_file, $new_file, $linepadding = null
create_directory() - Keine Beschreibung verfügbar. - $directory
db_connect() - Keine Beschreibung verfügbar. - $server, $user = "", $password = "", $port = "", $socket = ""
db_escape_string() - Keine Beschreibung verfügbar. - $string
db_fetch_array() - Keine Beschreibung verfügbar. - $query, $type = "both"
db_fetch_object() - Keine Beschreibung verfügbar. - $query
db_num_rows() - Keine Beschreibung verfügbar. - $query
db_query() - Keine Beschreibung verfügbar. - $query, $connection = ""
db_select_db() - Keine Beschreibung verfügbar. - $query, $connection = ""
db_split() Zerteilt eine angelieferte Datei in die einzelnen SQL-Befehle. $string
flush() - Keine Beschreibung verfügbar. -
form_button() - Keine Beschreibung verfügbar. - $name, $title, $query = "", $update_options = array()
form_checkbox() - Keine Beschreibung verfügbar. - $name, $id, $value, $checked, $string, $type = ""
form_start() - Keine Beschreibung verfügbar. - $name
form_stop() - Keine Beschreibung verfügbar. - $name, $title, $count = ""
format() - Keine Beschreibung verfügbar. - $code
format_line() - Keine Beschreibung verfügbar. - $string
format_number() Erzeugt die einheitliche Formatierung für eine Zahl. $number, $decimals = 0
get_cpforms() Liefert die CP::Forms-Module innerhalb der Installation zurück.
get_database_fields() Liefert die Felder innerhalb einer Datenbanktabelle des Systems zurück. $table, $sql = "", $connection = ""
get_database_tables() Liefert die Datenbanktabellen innerhalb der Datenbank des Systems zurück. $sql = "", $database = "", $connection = ""
get_directories() - Keine Beschreibung verfügbar. - $directory = ".", $array = array()
get_files() - Keine Beschreibung verfügbar. - $directory = "."
get_languages() Liefert die Sprachen in der Installation zurück.
get_sites() Liefert die Mandanten in der Installation zurück.
hide_message() - Keine Beschreibung verfügbar. - $name
layout_footer() - Keine Beschreibung verfügbar. -
layout_header() - Keine Beschreibung verfügbar. - $options = array()
show_config() - Keine Beschreibung verfügbar. - $array
show_message() - Keine Beschreibung verfügbar. - $string, $type = "", $name = ""
showline() - Keine Beschreibung verfügbar. - $line
simplexml2array() Wandelt ein SimpleXML-Objekt in ein Array um. $xml
simplexml2load() Lädt eine XML-Datei und liefert diese als Array zurück. $file
template_replace_rewrite() - Keine Beschreibung verfügbar. - $directory
wrap() - Keine Beschreibung verfügbar. - $old_file, $new_file

Kommentieren Kommentieren (0 Kommentare)

Datei "/database/db.mysql.php"

Funktionen in der Datei "/database/db.mysql.php" (Name der Funktion, Beschreibung, Parameter):

db_close() - Keine Beschreibung verfügbar. - $db_link
db_connect() - Keine Beschreibung verfügbar. - $database, $server, $user = "", $password = "", $port = "", $socket = ""
db_create_db() - Keine Beschreibung verfügbar. - $query, $db_link
db_delete() - Keine Beschreibung verfügbar. - $query
db_drop_db() - Keine Beschreibung verfügbar. - $query
db_escape_string() - Keine Beschreibung verfügbar. - $string
db_fetch_array() - Keine Beschreibung verfügbar. - $query, $type = "both"
db_fetch_object() - Keine Beschreibung verfügbar. - $query
db_fetch_row() - Keine Beschreibung verfügbar. - $query
db_field_flags() - Keine Beschreibung verfügbar. - $query, $i
db_field_len() - Keine Beschreibung verfügbar. - $query, $i
db_field_name() - Keine Beschreibung verfügbar. - $query, $i
db_field_type() - Keine Beschreibung verfügbar. - $query, $i
db_free_result() - Keine Beschreibung verfügbar. - $query
db_insert() - Keine Beschreibung verfügbar. - $query
db_last_id() - Keine Beschreibung verfügbar. - $result = ""
db_list_dbs() - Keine Beschreibung verfügbar. - $connection
db_list_tables() - Keine Beschreibung verfügbar. - $query, $connection
db_num_fields() - Keine Beschreibung verfügbar. - $query
db_num_rows() - Keine Beschreibung verfügbar. - $query
db_optimize() - Keine Beschreibung verfügbar. - $query
db_select() - Keine Beschreibung verfügbar. - $query
db_select_db() - Keine Beschreibung verfügbar. - $query, $db_link = ""
db_show_error() - Keine Beschreibung verfügbar. - $error, $error_number, $query
db_update() - Keine Beschreibung verfügbar. - $query
db_version() - Keine Beschreibung verfügbar. -

Kommentieren Kommentieren (0 Kommentare)

Weitere Seiten: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102

<< zurück zur Startseite der Dokumentation

Hier finden Sie die eBusiness-/eCommerce-Spezialisten von sandoba.de:
https://www.sandoba.de/dokumentation/kategorien/funktionsbibliothek-87/