PHP API

Mit Hilfe der BorlabsCookieHelper()-Funktion können Third-Party Entwickler eigene Content Blocker anlegen und zur Laufzeit Veränderungen an blockierten Inhalten vornehmen. Auch das Blockieren individuellen Inhaltes ist mit Hilfe der Funktion möglich.

addContentBlocker

Fügt einen Content Blocker hinzu. Nutzt das System das Multilanguage Plugin WPML oder Polylang, wird der Content Blocker für alle Sprachen angelegt.

Aufruf

BorlabsCookieHelper()->addContentBlocker($contentBlockerId, $name, $description = '', $privacyPolicyURL = '', $hosts, $previewHTML, $previewCSS = '', $globalJS = '', $initJS = '', $settings = [], $status = false, $undeletable = false);

Argumente

Argument	Type	Beschreibung
$contentBlockerId	String, Pattern: [a-z-_]{3,}	Die ID des Content Blockers. Wenn die ID bereits verwendet wird, wird der Content Blocker nicht angelegt.
$name	String	Name des Content Blockers.
$description	String	Beschreibung des Content Blockers. Wird beim Bearbeiten des Content Blockers als erstes angezeigt. (Optional)
$privacyPolicyURL	String	URL zur Datenschutzerklärung. (Optional)
$hosts	Array	Hosts die diesem Content Blocker zugeordnet werden sollen.
$previewHTML	String	HTML-Code der Vorschau des blockierten Inhaltes.
$previewCSS	String	CSS-Code für den Content Blocker. (Optional)
$globalJS	String	Globales JavaScript. Reines JavaScript verwenden. (Optional)
$initJS	String	Initiales JavaScript. Reines JavaScript verwenden. Die Variable el enthält das entsperrte Objekt. (Optional)
$settings	Array	Zusätzliche Einstellungen für den Content Blocker. (Optional)
$status	Bool	Status des Content Blockers. (Optional) Standard: false
$undeletable	Bool	Content Blocker kann nicht gelöscht werden. (Optional) Standard: false

blockContent

Blockiert den übergebenen Inhalt.

Aufruf

BorlabsCookieHelper()->blockContent($content, $contentBlockerId, $title = '');

Argumente

Argument	Type	Beschreibung
$content	String	Inhalt der blockiert werden soll.
$contentBlockerId	String	Die ID des Content Blockers.
$title	String	Titel. (Optional)

blockCookie

Blockiert den übergebenen Inhalt. Der Inhalt wird entsperrt, wenn es für den Cookie eine Einwilligung gibt.

Aufruf

BorlabsCookieHelper()->blockCookie($content, $cookieId);

Argumente

Argument	Type	Beschreibung
$content	String	Inhalt der blockiert werden soll.
$cookieId	String	Die ID des Cookies.

blockCookieGroup

Blockiert den übergebenen Inhalt. Der Inhalt wird entsperrt, wenn es für die Cookie Gruppe eine Einwilligung gibt.

Aufruf

BorlabsCookieHelper()->blockCookieGroup($content, $cookieGroupId);

Argumente

Argument	Type	Beschreibung
$content	String	Inhalt der blockiert werden soll.
$cookieGroupId	String	Die ID der Cookie Gruppe.

blockIframes

Sucht im übergebenen Inhalt nach Iframes und blockiert diese.

Aufruf

BorlabsCookieHelper()->blockIframes($content);

Argumente

Argument	Type	Beschreibung
$content	String	Inhalt mit Iframes, die blockiert werden sollen.

deleteContentBlocker

Löscht einen Content Blocker.

Aufruf

BorlabsCookieHelper()->deleteContentBlocker($contentBlockerId);

Argumente

Argument	Type	Beschreibung
$contentBlockerId	String	Die ID des Content Blockers.

gaveConsent

Gibt true zurück, wenn für die Cookie ID eine Einwilligung erteilt wurde.

Aufruf

BorlabsCookieHelper()->gaveConsent($cookieId);

Argumente

Argument	Type	Beschreibung
$cookieID	String	Die ID des Cookies.

getContentBlockerData

Gibt alle Informationen zu einem Content Blocker zurück.

Aufruf

BorlabsCookieHelper()->getContentBlockerData($contentBlockerId);

Argumente

Argument	Type	Beschreibung
$contentBlockerId	String	Die ID des Content Blockers.

getContentBlockerDataById

Gibt alle Informationen zu einem Content Blockers anhand der Id (nicht Content Blocker ID) zurück.

Aufruf

BorlabsCookieHelper()->getContentBlockerDataById($id);

Argumente

Argument	Type	Beschreibung
$id	Integer	Die Id (`id`) des Content Blockers. Steht beim Bearbeiten eines Content Blockers im Backend beim Speichern und Validieren zur Verfügung.

getCurrentTitleOfContentBlocker

Gibt den Titel des aktuellen blockierten Inhaltes zurück.

Aufruf

BorlabsCookieHelper()->getCurrentTitleOfContentBlocker();

setCurrentBlockedContent

Überschreibt den Inhalt zu blockierenden Inhalt.

Aufruf

BorlabsCookieHelper()->setCurrentBlockedContent($content);

Argumente

Argument	Type	Beschreibung
$content	String	Inhalt der blockiert werden soll.

updateContentBlockerJavaScript

Überschreibt die Einstellungen und das JavaScript eines Content Blockers zur Laufzeit.

Aufruf

BorlabsCookieHelper()->updateContentBlockerJavaScript($contentBlockerId, $globalJS = '', $initJS = '', $settings = []);

Argumente

Argument	Type	Beschreibung
$contentBlockerId	String	Die ID des Content Blockers.
$globalJS	String	Globales JavaScript. Reines JavaScript verwenden. (Optional)
$initJS	String	Initiales JavaScript. Reines JavaScript verwenden. (Optional)
$settings	Array	Zusätzliche Einstellungen für den Content Blocker.