Affiliat*r

1. Was ist Affiliat*r?

Affiliat*r ist ein kleines Script zur Verwaltung von Affiliates/ Links/ Partnerseiten einer Webseite. Wer irgendwann mal mit dem Script Affiliationally gearbeitet hat, der weiß von was die Rede ist. Affiliat*r vereinfacht die dabei die Handhabung von mehreren Kategorien und die Verwaltung der Seiten an sich.

2. Warum gibt es Affiliat*r?

Affiliat*r ist entstanden, da Affiliationally zwar an sich gut ist, aber schon seit langem keine Weiterentwicklung mehr stattfindet. Mangels Spam-Schutz ist Affiliationally zudem sehr Anfällig für Spam und die Konfiguration/ Einrichtung z. T. auch nicht so einfach.

Systemvoraussetzungen

  • PHP: Version 5.3.3 oder neuer
    • aktive PDO Erweiterung
    • aktives furl_allow_open (optional, aber empfohlen)
  • MySQL: Version 5.1 oder neuer
  • Speicher: ca. 1 MB freier Speicherplatz für Installation + Platz für Dateiuploads

3. Download

Affiliat*r steht unter der GPLv3 und kann entsprechend frei verwendet und ggf. angepasst werden. Jedoch möchte ich an der Stelle wieder darum bitten, bei Bugfixes, o. ä. mir die Änderungen zukommen zu lassen, so dass diese mit in die Hauptentwicklung einfließen kann 🙂

4. Installation

  1. Lade das Installationspaket herunter.
  2. Entpacke die zip-Datei.
  3. Lade den Ordner „affiliat_r“ auf deinen Webspace.
  4. Rufe nun deine-url.xyz/affiliat_r/install auf. (passe die URL ggf. an deine Umgebung an)
  5. Der Installationsassistent fragt nun nach den Zugangsdaten für die Datenbank sowie einigen Informationen zur Konfiguration.
  6. Nach Abschluss der Installation kannst du dich im ACP einloggen.
  7. Legen nun zuerst Kategorien an, anschließend kannst du manuell Affiliates einpflegen und/oder sich Seiten bewerben.

5. Versions-Update

Von Zeit zu Zeit gibt es auch für Affiliat*r Updates, die Bugs beheben, neue Funktionen einfügen, etc. Bestehende Installationen können i. d. R. über die Auto-Update-Funktion aktualisiert werden. Ihr bekommt dann eine entsprechende Benachrichtigung das eine neue Version vorhanden ist.

Sollte das Update einmal nicht funktionieren oder euer Host keine Verbindungen zu anderen Servern zulassen (bspw. bplaced ohne bplaced pro), so wird euch bei Verfügbarkeit eines Updates eine ZIP-Datei zum Download angeboten. Für die Aktualisierung gehe wie folgt vor:

  1. Lade das Updatepkate herunter.
  2. Entpacke die zip-Datei.
  3. Lade den Ordner „affiliat_r“ bzw. dessen auf deinen Webspace und ersetze die vorhandenen Dateien auf dem Server.
  4. Rufe anschließend deine.url/affiliat_r/index.php?module=system/update auf. Hierdurch werden ggf. nötig Änderungen an der Datenbank, etc. vorgenommen.
  5. Wird im Header die neue Version von Affiliat*r angezeigt, so war das Update erfolgreich.

Schritt 5 kann man auch bei Verwendung des Auto-Updaters ausführen, wenn hier einmal Probleme auftreten sollten.

6. FAQ

1) Private Kategorien

Kategorien können als „Privat“ markiert werden. In diesem Fall können sie mit in der Affiliate-Ansicht ausgegeben werden, über das Bewerbungsformular kann man sich jedoch nicht auf diese Kategorie bewerben.

2) Integration via iframe

Soll Affiliat*r über iframes verwendet werden, so gibt in der Konfiguration im ACP die URL zu deiner CSS-Datei an und verlinke folgende Dateien:

  • affiliates.php: Ausgabe der Affiliates, die Kategorien sind nach Ihrer ID sortiert.
  • apply.php: Formular um sich als Affiliate zu bewerben.
  • linkbanner.php: Eigene Link-Buttons/ Banner anzeigen

Seit Version 1.1.108 von Affiliat*r kann man auch bei dieser Methode einige Sachen besser konfigurieren. Hängt dazu einfach einen oder mehrere der folgenden Paramater an die URL zur affiliates.php an. (mehrere Paramater können via „&“ getrennt werden)

  • category: ID der Kategorien
  • acceptedonly: nur akzeptierte Affiliates anzeigen
  • textonly: nur Affiliates anzeigen, die keinen Button gesetzt haben
  • openblank: Affiliate-Links in neuem Fenster öffnen

3) Integration via phpinclude

Die Integration via phpinclude ist etwas aufwändiger, dafür aber via flexibler.

  • Include die Datei affiliatr_functions.php in deiner Seite. Ggf. musst du hier den Pfad entsprechend deiner Ordnerstruktur anpassen.
<?php require_once 'affiliat_r/affiliatr_functions.php'; ?>
  • Um Affiliates einer bestimmten Kategorie anzuzeigen, rufe die Funktion affiliatr::showAffiliates(); auf. Dieser kannst du mehrere Parameter übergeben. (die Standardwerte findest du unten)
    • $categoryId: ID der Kategorien
    • $acceptedOnly: nur akzeptierte Affiliates anzeigen
    • $textOnly: nur Affiliates anzeigen, die keinen Button gesetzt haben
    • $openBlank: Affiliate-Links in neuem Fenster öffnen
    • $view: Name eines eigenen Ausgabetemplates
    • $isNotUtf8: ist Aufgabe im UTF-8-Format. Setzte dies auf „true“, wenn in der Ausgabe Sonderzeichen falsch dargestellt werden.
<?php affiliatr::showAffiliates($categoryId, $acceptedOnly = true, $textOnly = 0, $openBlank = false, $view = null, $isNotUtf8 = false); ?>
  • Um das Bewerbungsformular anzuzeigen, rufe die Funktion affiliatr::applyForm(); auf. Dieser kannst du den obigen Parameter „$isNotUtf8“ übergeben.
<?php affiliatr::applyForm($isNotUtf8 = false); ?>
  • Um die Button-/ Bannerliste anzuzeigen, rufe die Funktion affiliatr::showLinkbanner(); auf. Diese erwartet zwei optionale Parameter
    • $isNotUtf8: ist Aufgabe im UTF-8-Format. Setzte dies auf „true“, wenn in der Ausgabe Sonderzeichen falsch dargestellt werden.
    • $maxSize: Maximale Breite bzw. Höhe der anzuzeigenden Banner. Siehe Hinweis beim WordPress-Plugin.
<?php affiliatr::showLinkbanner($isNotUtf8 = false, $maxSize = array('width' => '', 'height' => '')); ?>

4) Integration in WordPress

Für WordPress gibt es ein Plugin, welches die Integration von Affiliat*r stark vereinfacht. Dies könnt ihr aktuell hier herunterladen.

WordPress Plugin Download
(Version 1.2.128 von 02.12.2015)

Zur Installation entpackt ihr nach dem Download die ZIP-Datei und ladet den enthaltenen Ordner im WordPress-Verzeichnis in den ordner wp-content/plugins. Anschließend taucht das Plugin im WordPress-ACP unter Plugins > Installierte Plugins auf, wo ihr es aktivieren könnt.

Um eine Kategorie anzuzeigen, fügt in einen Post/eine Seite einfach folgenden Text ein. (die Syntax hat sich mit Plugin-Version 1.2.120 geändert!)

[affiliatr action="showAffiliates" category="<ID>" acceptedonly="0" textonly="0|1|2" openblank="0" isnotutf8="0"]

Bis auf „category“ sind alle weiteren Parameter optional.

Um das Bewerbungsformular anzuzeigen, fügt in einen Post/eine Seite einfach folgenden Text ein.

[affiliatr action="showApplyForm" isnotutf8="0"]

Der Parameter „isNotUtf8“ ist optional.

Um die Buttonliste anzuzeigen, fügt in einen Post/eine Seite einfach folgenden Text ein.

[affiliatr action="showBannerList" maxWidth="100" maxHeight="35" isnotutf8="0"]

Die Parameter „maxWidth“, „maxHeight“ und „isNotUtf8“ sind optional.

Die Buttonliste nutzt für die angezeigten Buttons nur die maximal Breite ODER Höhe, aber nicht beides. So könnt ihr bspw. Buttons in 100×35 Pixel von Bannern in 460×68 Pixel trennen.