Home

ScarClick - API

9. July 2008 - 20:44 — Christian Kerl

Über die ScarClick Klasse werden die folgende Funktionen bereit gestellt. Mit Ihnen können alle Relevante Information direkt über PHP auf der Webseite eingebunden werden.

Um die API Funktionen zu nutzen muss die ScarClick Klasse über include(); eingebunden und instanziert werden.

<?php
...
# Beispiel:
include_once("admin/lib/class_scarclick.inc.php");
$scar4u_scarclick = new Scar4U_ScarClick();
?>

Hinweis
Etwas weiter unten wird die alternative Einbindung von Daten über Javascript beschrieben.

jumpTo - Zu einer Seite weiterleiten

Leiter anhand der übergebenen ID direkt zur Ziel-URL. Dabei gehen keine Referer, Formular, .. Informationen verloren. Bei jeder Weiterleitung über diese Methode wird gleichzeitig der Zählerstand um eins erhöht.

<?php
...
# Beispiel:
$scar4u_scarclick->jumpTo(ID);
?>

Für ID muss die Link-ID aus der Administration angegeben werden.

getLink - Informationen eines Links auslesen

Liefert alle Informationen über einen Link in einem Array. Das Array besteht aus folgenden Informationen:

Array-Index - Beschreibung

linkid Enthält nochmals die LinkID aus der Administration die der Methode übergeben wurde.
linkname Enthält die Bezeichnung/Namen.
linkdesc Enthält die Beschreibung.
linkurl Enthält die Ziel-URL.
linkcounter Enthält den aktuellen Zählerstand.
timeadd Enthält die Zeit wann der Link in der Administration hinzugefügt wurde.
Dieser Wert wird als Unix-Timestamp übergeben und kann direkt mittels PHP weiterverarbeitet werden.
Siehe auch http://www.php.net/date

lastclick Enthält die Zeit der letzten Weiterleitung (über die Methode jumpTo).
Dieser Wert wird als Unix-Timestamp übergeben und kann direkt mittels PHP weiterverarbeitet werden.
Siehe auch http://www.php.net/date

<?php
...
# Beispiel:
$link = $scar4u_scarclick->getLink(ID);
echo $link[linkcounter];
?>

Im Beispiel wird der aktuelle Zählerstand ausgegeben. Über "echo $link[ARRAYINDEX];" können auch alle übrigen Informationen einzeln verwendet werden.

Eine Schnellübersicht des Array-Inhaltes (der gelieferten Daten) kann man in PHP durch print_r($link) erhalten.
siehe auch: http://www.php.net/date

getLinkUrl - Ziel Url auslesen

Liefert die Ziel-Url zur Link-ID

<?php
...
Beispiel
echo $scar4u_scarclick->getLinkUrl(ID);
?>

getLinkCounter - Zählerstand abfragen

Liefert den aktuellen Zählerstand zur Link-ID

<?php
...
# Beispiel
echo $scar4u_scarclick->getLinkCounter(ID);
?>