• Publicity: Public Only All

cookie-consent-procs.tcl

Integration of the Cookie Consent Library into OpenACS The Cookie Consent Library is and Cookie Consent to be free and open sourced library for alerting users about the use of cookies on a website. It is designed to help you comply with the hideous EU Cookie Law and not make you want to kill yourself in the process. So we made it fast, free, and relatively painless. Details: https://cookieconsent.insites.com/ https://github.com/insites/cookieconsent/ This package integrates the Consent Plugin with OpenACS, in particular with OpenACS subsites.

This file defines the following Objects and Classes: ::cookieconsent::CookieConsent[i]

Location:
packages/cookie-consent/tcl/cookie-consent-procs.tcl
Created:
13 Dec 2017
Author:
Gustaf Neumann
CVS Identification:
$Id: cookie-consent-procs.tcl,v 1.12.2.10 2022/09/12 09:15:15 antoniop Exp $

Procedures in this file

Detailed information

Class ::cookieconsent::CookieConsent (public)

 ::nx::Class ::cookieconsent::CookieConsent[i]

Create the Class for configuring the cookie consent widget. This class requires nx from the next-scripting framework. https://next-scripting.org/xowiki/ which is automatically installed for XOTcl2 via https://openacs.org/xowiki/naviserver-openacs

Partial Call Graph (max 5 caller/called nodes):
%3 lang::util::localize lang::util::localize (public) Class ::cookieconsent::CookieConsent Class ::cookieconsent::CookieConsent Class ::cookieconsent::CookieConsent->lang::util::localize

Testcases:
No testcase defined.

cookieconsent::CookieConsent method render_js (public)

 <instance of cookieconsent::CookieConsent[i]> render_js

Perform the actual rendering of the cookie consent widget.

Partial Call Graph (max 5 caller/called nodes):
%3 test_cookie_consent__setup cookie_consent__setup (test cookie-consent) cookieconsent::CookieConsent instproc render_js cookieconsent::CookieConsent instproc render_js test_cookie_consent__setup->cookieconsent::CookieConsent instproc render_js test_create_form_with_form_instance create_form_with_form_instance (test xowiki) test_create_form_with_form_instance->cookieconsent::CookieConsent instproc render_js lang::util::localize lang::util::localize (public) cookieconsent::CookieConsent instproc render_js->lang::util::localize

Testcases:
cookie_consent__setup, create_form_with_form_instance

cookieconsent::add_to_page (public)

 cookieconsent::add_to_page [ -version version ] object

Add the necessary CSS, JavaScript and CSP to the current page.

Switches:
-version
(optional)
Parameters:
object

Partial Call Graph (max 5 caller/called nodes):
%3 test_cookie_consent__setup cookie_consent__setup (test cookie-consent) cookieconsent::add_to_page cookieconsent::add_to_page test_cookie_consent__setup->cookieconsent::add_to_page cookieconsent::resource_info cookieconsent::resource_info (public) cookieconsent::add_to_page->cookieconsent::resource_info security::csp::require security::csp::require (public) cookieconsent::add_to_page->security::csp::require template::add_body_script template::add_body_script (public) cookieconsent::add_to_page->template::add_body_script template::head::add_css template::head::add_css (public) cookieconsent::add_to_page->template::head::add_css template::head::add_javascript template::head::add_javascript (public) cookieconsent::add_to_page->template::head::add_javascript cookieconsent::initialize_widget cookieconsent::initialize_widget (public) cookieconsent::initialize_widget->cookieconsent::add_to_page

Testcases:
cookie_consent__setup

cookieconsent::initialize_widget (public)

 cookieconsent::initialize_widget [ -subsite_id subsite_id ]

Initialize a cookie-consent widget.

Switches:
-subsite_id
(optional)

Partial Call Graph (max 5 caller/called nodes):
%3 test_cookie_consent__setup cookie_consent__setup (test cookie-consent) cookieconsent::initialize_widget cookieconsent::initialize_widget test_cookie_consent__setup->cookieconsent::initialize_widget ad_conn ad_conn (public) cookieconsent::initialize_widget->ad_conn ad_get_cookie ad_get_cookie (public) cookieconsent::initialize_widget->ad_get_cookie cookieconsent::add_to_page cookieconsent::add_to_page (public) cookieconsent::initialize_widget->cookieconsent::add_to_page cookieconsent::get_relevant_subsite cookieconsent::get_relevant_subsite (private) cookieconsent::initialize_widget->cookieconsent::get_relevant_subsite parameter::get parameter::get (public) cookieconsent::initialize_widget->parameter::get callback::subsite::page_plugin::impl::cookie-consent callback::subsite::page_plugin::impl::cookie-consent (private) callback::subsite::page_plugin::impl::cookie-consent->cookieconsent::initialize_widget

Testcases:
cookie_consent__setup

cookieconsent::reset_cookie (public)

 cookieconsent::reset_cookie [ -subsite_id subsite_id ]

Reset the consent cookie.

Switches:
-subsite_id
(optional)

Partial Call Graph (max 5 caller/called nodes):
%3 test_cookie_consent__setup cookie_consent__setup (test cookie-consent) cookieconsent::reset_cookie cookieconsent::reset_cookie test_cookie_consent__setup->cookieconsent::reset_cookie ad_unset_cookie ad_unset_cookie (public) cookieconsent::reset_cookie->ad_unset_cookie cookieconsent::get_relevant_subsite cookieconsent::get_relevant_subsite (private) cookieconsent::reset_cookie->cookieconsent::get_relevant_subsite

Testcases:
cookie_consent__setup

cookieconsent::resource_info (public)

 cookieconsent::resource_info [ -version version ]

Get information about available version(s) of the cookieconsent packages, either from the local filesystem, or from CDN.

Switches:
-version
(optional)
Returns:
dict containing resourceDir, resourceName, cdn, cdnHost, prefix, cssFiles, jsFiles and extraFiles.

Partial Call Graph (max 5 caller/called nodes):
%3 test_cookie_consent__setup cookie_consent__setup (test cookie-consent) cookieconsent::resource_info cookieconsent::resource_info test_cookie_consent__setup->cookieconsent::resource_info acs_package_root_dir acs_package_root_dir (public) cookieconsent::resource_info->acs_package_root_dir cookieconsent::add_to_page cookieconsent::add_to_page (public) cookieconsent::add_to_page->cookieconsent::resource_info packages/cookie-consent/www/sitewide-admin/download.tcl packages/cookie-consent/ www/sitewide-admin/download.tcl packages/cookie-consent/www/sitewide-admin/download.tcl->cookieconsent::resource_info packages/cookie-consent/www/sitewide-admin/index.tcl packages/cookie-consent/ www/sitewide-admin/index.tcl packages/cookie-consent/www/sitewide-admin/index.tcl->cookieconsent::resource_info

Testcases:
cookie_consent__setup
[ show source ]