Documentation

CookiePolicy extends AbstractCookiePolicy
in package
Uses UtilsProvider

Cookie policy settings.

Table of Contents

Constants

OPTION_GROUP  = 'options'
SYNC_OPTIONS  = ['page' => ['data' => ['menu_order'], 'taxonomies' => [], 'meta' => ['copy' => [], 'copy-once' => []]]]

Properties

$me  : CookiePolicy
Singleton instance.
$settings  : Settings
See Settings

Methods

display_post_states()  : mixed
Add a "Cookie Policy Page" post state like "Privacy Policy Page" to the created cookie policy.
enableOptionsAutoload()  : mixed
Initially `add_option` to avoid autoloading issues.
getAdditionalContent()  : string
In this text field, you can make additional additions to the cookie policy that do not fit any of the previously mentioned topics.
getContentCookiesOrigin()  : string
Content text for who is setting cookies section.
getContentCookieTechnology()  : string
Content text for cookie and cookie-like technology section.
getContentDiffToPrivacyPolicy()  : string
Content text for diff to privacy policy section.
getContentLegalBasisDsg()  : string
Content text for legal basis section for the DSG (Switzerland).
getContentLegalBasisGdpr()  : string
Content text for legal basis section for the GDPR / ePrivacy Directive.
getContentManageCookies()  : string
Content text for how to manage cookies section.
getContentRightsOfVisitor()  : string
Content text for rights of visitor section.
getContentTypesOfCookies()  : string
Content text for the types of cookies (list categories of cookies like Essential, Marketing, Functional, Statistics, ...).
getControllerOfWebsiteLabels()  : array<string|int, mixed>
Get label texts for the website operator details.
getGridJsLanguageTexts()  : array<string|int, mixed>
Get language texts for the GridJS instance which formats the cookie policy to a nice table.
getHeadlineControllerOfWebsite()  : string
Headline text for the website operator section.
getHeadlineCookieOrigin()  : string
Who can set cookies on websites?
getHeadlineCookieTechnology()  : string
Headline text for explaining cookie and cookie-like technology section.
getHeadlineDiffToPrivacyPolicy()  : string
Headline text for diff to privacy policy section.
getHeadlineLegalBasis()  : string
Legal explanation of cookies.
getHeadlineListOfServices()  : string
List of all services with their details.
getHeadlineManageCookies()  : string
Explanation of how to delete cookies in your browser (including 3rd party cookies that RCB cannot delete; no explanation per browser, but only generally necessary, about the browser manual).
getHeadlineRightsOfTheVisitor()  : string
Information about the rights of the website visitor and function for viewing the history of consent, changing consent and revoking consent.
getHeadlineTableOfContents()  : string
Headline text for the table of contents.
getHeadlineTypesOfCookies()  : string
Types of cookies and their purposes.
getInstance()  : CookiePolicy
Get singleton instance.
getInstructionText()  : string
Instruction text.
getListOfServicesTableColumnLabels()  : array<string|int, mixed>
Get label texts for the table of list of services.
getPluginConstantPrefix()  : string
Get the prefix of this plugin so composer packages can dynamically build other constant values on it.
getSettings()  : mixed
Getter.
isShowCustomGroups()  : bool
When there are custom groups created beside Essential, Marketing, Functional, Statistics, also show a static text about those groups.
isTableDarkMode()  : bool
Render the GridJs table in dark mode.
page_row_actions()  : mixed
Add a link to edit the cookie policy directly in the customizer.
register()  : mixed
Register settings.
setSettings()  : mixed
Setter.
translateString()  : string
Translate a string from the customizer texts.
getCustomizeSetting()  : mixed
Get the a given customize setting by ID.
__construct()  : mixed
C'tor.

Constants

SYNC_OPTIONS

public mixed SYNC_OPTIONS = ['page' => ['data' => ['menu_order'], 'taxonomies' => [], 'meta' => ['copy' => [], 'copy-once' => []]]]

Properties

Methods

display_post_states()

Add a "Cookie Policy Page" post state like "Privacy Policy Page" to the created cookie policy.

public display_post_states(array<string|int, string> $post_states, WP_Post $post) : mixed
Parameters
$post_states : array<string|int, string>
$post : WP_Post

enableOptionsAutoload()

Initially `add_option` to avoid autoloading issues.

public enableOptionsAutoload() : mixed

getAdditionalContent()

In this text field, you can make additional additions to the cookie policy that do not fit any of the previously mentioned topics.

public getAdditionalContent() : string

Use {{dateOfUpdate}} as a placeholder to show date of the cookie policy when it was last changed.

Return values
string

getContentCookiesOrigin()

Content text for who is setting cookies section.

public getContentCookiesOrigin() : string
Return values
string

getContentCookieTechnology()

Content text for cookie and cookie-like technology section.

public getContentCookieTechnology() : string
Return values
string

getContentDiffToPrivacyPolicy()

Content text for diff to privacy policy section.

public getContentDiffToPrivacyPolicy() : string
Return values
string

getContentLegalBasisDsg()

Content text for legal basis section for the DSG (Switzerland).

public getContentLegalBasisDsg() : string
Return values
string

getContentLegalBasisGdpr()

Content text for legal basis section for the GDPR / ePrivacy Directive.

public getContentLegalBasisGdpr() : string
Return values
string

getContentManageCookies()

Content text for how to manage cookies section.

public getContentManageCookies() : string
Return values
string

getContentRightsOfVisitor()

Content text for rights of visitor section.

public getContentRightsOfVisitor() : string
Return values
string

getContentTypesOfCookies()

Content text for the types of cookies (list categories of cookies like Essential, Marketing, Functional, Statistics, ...).

public getContentTypesOfCookies() : string

You should also make use of isShowCustomGroups() to show an extra paragraph for custom groups.

Return values
string

getControllerOfWebsiteLabels()

Get label texts for the website operator details.

public getControllerOfWebsiteLabels() : array<string|int, mixed>
Return values
array<string|int, mixed>

getGridJsLanguageTexts()

Get language texts for the GridJS instance which formats the cookie policy to a nice table.

public getGridJsLanguageTexts() : array<string|int, mixed>
Return values
array<string|int, mixed>

getHeadlineControllerOfWebsite()

Headline text for the website operator section.

public getHeadlineControllerOfWebsite() : string
Return values
string

getHeadlineCookieOrigin()

Who can set cookies on websites?

public getHeadlineCookieOrigin() : string
Return values
string

getHeadlineCookieTechnology()

Headline text for explaining cookie and cookie-like technology section.

public getHeadlineCookieTechnology() : string
Return values
string

getHeadlineDiffToPrivacyPolicy()

Headline text for diff to privacy policy section.

public getHeadlineDiffToPrivacyPolicy() : string
Return values
string

getHeadlineLegalBasis()

Legal explanation of cookies.

public getHeadlineLegalBasis() : string
Return values
string

getHeadlineListOfServices()

List of all services with their details.

public getHeadlineListOfServices() : string
Return values
string

getHeadlineManageCookies()

Explanation of how to delete cookies in your browser (including 3rd party cookies that RCB cannot delete; no explanation per browser, but only generally necessary, about the browser manual).

public getHeadlineManageCookies() : string
Return values
string

getHeadlineRightsOfTheVisitor()

Information about the rights of the website visitor and function for viewing the history of consent, changing consent and revoking consent.

public getHeadlineRightsOfTheVisitor() : string
Return values
string

getHeadlineTableOfContents()

Headline text for the table of contents.

public getHeadlineTableOfContents() : string
Return values
string

getHeadlineTypesOfCookies()

Types of cookies and their purposes.

public getHeadlineTypesOfCookies() : string
Return values
string

getInstructionText()

Instruction text.

public getInstructionText() : string
Return values
string

getListOfServicesTableColumnLabels()

Get label texts for the table of list of services.

public getListOfServicesTableColumnLabels() : array<string|int, mixed>
Return values
array<string|int, mixed>

getPluginConstantPrefix()

Get the prefix of this plugin so composer packages can dynamically build other constant values on it.

public getPluginConstantPrefix() : string
Tags
codeCoverageIgnore

It only returns a string with the constant prefix

Return values
string

getSettings()

Getter.

public getSettings() : mixed
Tags
codeCoverageIgnore

isShowCustomGroups()

When there are custom groups created beside Essential, Marketing, Functional, Statistics, also show a static text about those groups.

public isShowCustomGroups() : bool
Return values
bool

isTableDarkMode()

Render the GridJs table in dark mode.

public isTableDarkMode() : bool
Return values
bool

page_row_actions()

Add a link to edit the cookie policy directly in the customizer.

public page_row_actions(array<string|int, string> $actions, WP_Post $post) : mixed
Parameters
$actions : array<string|int, string>
$post : WP_Post

translateString()

Translate a string from the customizer texts.

public translateString(string $string) : string
Parameters
$string : string
Return values
string

getCustomizeSetting()

Get the a given customize setting by ID.

protected getCustomizeSetting(string $id) : mixed
Parameters
$id : string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results