Documentation

BannerLink
in package

Banner links configured in settings.

Table of Contents

Constants

PAGE_TYPE_CANCELLATION_POLICY  = 'cancellationPolicy'
PAGE_TYPE_COOKIE_POLICY  = 'cookiePolicy'
PAGE_TYPE_DATA_PROCESSING_AGREEMENT  = 'dpa'
PAGE_TYPE_DISPUTE_RESOLUTION  = 'disputeResolution'
PAGE_TYPE_GENERAL_TERMS_AND_CONDITIONS  = 'gtc'
PAGE_TYPE_LEGAL_NOTICE  = 'legalNotice'
PAGE_TYPE_OTHER  = 'other'
PAGE_TYPE_PRIVACY_POLICY  = 'privacyPolicy'
PAGE_TYPE_TERMS_OF_USE  = 'tos'

Properties

$hideCookieBanner  : bool
Hide the cookie banner on that site?
$id  : int
ID.
$isExternalUrl  : bool
Is the URL external?
$isTargetBlank  : bool
Open the link in a new window.
$label  : string
Label.
$pageId  : int
Page ID when the link is internal.
$pageType  : string
Page type.
$url  : string
URL.

Methods

fromJson()  : self
Generate a `Blocker` object from an array.
getId()  : mixed
Getter.
getLabel()  : mixed
Getter.
getPageId()  : mixed
Getter.
getPageType()  : mixed
Getter.
getUrl()  : mixed
Getter.
isExternalUrl()  : mixed
Getter.
isHideCookieBanner()  : mixed
Getter.
isTargetBlank()  : mixed
Getter.
setHideCookieBanner()  : mixed
Setter.
setId()  : mixed
Setter.
setIsExternalUrl()  : mixed
Setter.
setIsTargetBlank()  : mixed
Setter.
setLabel()  : mixed
Setter.
setPageId()  : mixed
Setter.
setPageType()  : mixed
Setter.
setUrl()  : mixed
Setter.
toJson()  : mixed
Create a JSON representation of this object.

Constants

PAGE_TYPE_CANCELLATION_POLICY

public mixed PAGE_TYPE_CANCELLATION_POLICY = 'cancellationPolicy'

PAGE_TYPE_COOKIE_POLICY

public mixed PAGE_TYPE_COOKIE_POLICY = 'cookiePolicy'

PAGE_TYPE_DATA_PROCESSING_AGREEMENT

public mixed PAGE_TYPE_DATA_PROCESSING_AGREEMENT = 'dpa'

PAGE_TYPE_DISPUTE_RESOLUTION

public mixed PAGE_TYPE_DISPUTE_RESOLUTION = 'disputeResolution'

PAGE_TYPE_GENERAL_TERMS_AND_CONDITIONS

public mixed PAGE_TYPE_GENERAL_TERMS_AND_CONDITIONS = 'gtc'

PAGE_TYPE_LEGAL_NOTICE

public mixed PAGE_TYPE_LEGAL_NOTICE = 'legalNotice'

PAGE_TYPE_OTHER

public mixed PAGE_TYPE_OTHER = 'other'

PAGE_TYPE_PRIVACY_POLICY

public mixed PAGE_TYPE_PRIVACY_POLICY = 'privacyPolicy'

PAGE_TYPE_TERMS_OF_USE

public mixed PAGE_TYPE_TERMS_OF_USE = 'tos'

Properties

$hideCookieBanner

Hide the cookie banner on that site?

private bool $hideCookieBanner = false

$isExternalUrl

Is the URL external?

private bool $isExternalUrl = false

$isTargetBlank

Open the link in a new window.

private bool $isTargetBlank = false

$pageId

Page ID when the link is internal.

private int $pageId = 0

$pageType

Page type.

private string $pageType = self::PAGE_TYPE_OTHER

Methods

fromJson()

Generate a `Blocker` object from an array.

public static fromJson(array<string|int, mixed> $data) : self
Parameters
$data : array<string|int, mixed>
Return values
self

getId()

Getter.

public getId() : mixed
Tags
codeCoverageIgnore

getLabel()

Getter.

public getLabel() : mixed
Tags
codeCoverageIgnore

getPageId()

Getter.

public getPageId() : mixed
Tags
codeCoverageIgnore

getPageType()

Getter.

public getPageType() : mixed
Tags
codeCoverageIgnore

getUrl()

Getter.

public getUrl() : mixed
Tags
codeCoverageIgnore

isExternalUrl()

Getter.

public isExternalUrl() : mixed
Tags
codeCoverageIgnore

isHideCookieBanner()

Getter.

public isHideCookieBanner() : mixed
Tags
codeCoverageIgnore

isTargetBlank()

Getter.

public isTargetBlank() : mixed
Tags
codeCoverageIgnore

setHideCookieBanner()

Setter.

public setHideCookieBanner(bool $hideCookieBanner) : mixed
Parameters
$hideCookieBanner : bool
Tags
codeCoverageIgnore

setId()

Setter.

public setId(int $id) : mixed
Parameters
$id : int
Tags
codeCoverageIgnore

setIsExternalUrl()

Setter.

public setIsExternalUrl(bool $isExternalUrl) : mixed
Parameters
$isExternalUrl : bool
Tags
codeCoverageIgnore

setIsTargetBlank()

Setter.

public setIsTargetBlank(bool $isTargetBlank) : mixed
Parameters
$isTargetBlank : bool
Tags
codeCoverageIgnore

setLabel()

Setter.

public setLabel(string $label) : mixed
Parameters
$label : string
Tags
codeCoverageIgnore

setPageId()

Setter.

public setPageId(int $pageId) : mixed
Parameters
$pageId : int
Tags
codeCoverageIgnore

setPageType()

Setter.

public setPageType(string $pageType) : mixed
Parameters
$pageType : string
Tags
codeCoverageIgnore

setUrl()

Setter.

public setUrl(string $url) : mixed
Parameters
$url : string
Tags
codeCoverageIgnore

toJson()

Create a JSON representation of this object.

public toJson() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results