Documentation

Import

in package

• Application

Uses UtilsProvider, ImportGroups, ImportSettings, ImportCookies, ImportBlocker, ImportBannerLinks, ImportTcfVendorConfigurations, ImportCustomizeBanner, ImportMessages

Allows to import a JSON string with specific options. If you want to learn more about the scheme, please have a look at the output of the export.

Table of Contents

Constants

IMPORT_POST_STATI  = ['keep', 'publish', 'private', 'draft']

Properties

$mapCookies  : mixed

A map of post_name -> duplicate ID so it can be used for blocker import.

$mapTcfVendorConfigurations  : mixed

A map of post_name -> duplicate ID so it can be used for blocker import.

$blockerSkipExisting  : bool

Skip existing blocker.

$blockerStatus  : string

Force or "keep" a given post status.

$cookieGroup  : int

Default cookie group when it can not be assigned to one.

$cookieSkipExisting  : bool

Skip already existing services.

$cookieStatus  : string

Force or "keep" a given post status.

$json  : mixed

The importing JSON as associative array.

$messages  : mixed

Messages occured while importing.

$tcfVendorConfigurationStatus  : string

Force or "keep" a given post status.

Methods

getBlockerStatus()  : mixed

Get content blocker status.

getCookieGroup()  : mixed

Get cookie group.

getCookieStatus()  : mixed

Get cookie status.

getJSON()  : mixed

Get JSON.

getMessages()  : mixed

Get happened messages.

getPluginConstantPrefix()  : string

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

getTcfVendorConfigurationStatus()  : mixed

Get TCF Vendor configuration status.

import()  : mixed

Import all available settings in the passed JSON. This also respects the correct order of imports.

importBannerLinks()  : mixed

Import banner links.

importBlocker()  : mixed

Import content blocker.

importCookieGroups()  : mixed

Import cookie groups.

importCookies()  : mixed

Import cookies.

importCustomizeBanner()  : mixed

Import customize banner settings.

importSettings()  : mixed

Import settings.

importTcfVendorConfigurations()  : mixed

Import TCF Vendor configurations.

instance()  : mixed

Get singleton instance.

isBlockerSkipExisting()  : mixed

Get blocker skip existing.

isCookieSkipExisting()  : mixed

Get cookie skip existing.

optionsMap()  : mixed

Read all available options.

setBlockerSkipExisting()  : mixed

Set blocker to skip existing.

setBlockerStatus()  : mixed

Set blocker status.

setCookieGroup()  : mixed

Set default cookie group.

setCookieSkipExisting()  : mixed

Set cookies to skip existing.

setCookieStatus()  : mixed

Set service status.

setTcfVendorConfigurationStatus()  : mixed

Set TCF Vendor configuration status.

addMessage()  : mixed

Add a message to the message container.

addMessageBannerLinkPageId()  : mixed

Add message for banner link with configured page ID.

addMessageBlockerVisualMediaThumbnail()  : mixed

Add message for blocker with configured media library item

addMessageCookieAssignFailure()  : mixed

Cookie could not be assigned to cookie.

addMessageCookieGroupUpdatedInfo()  : mixed

Cookie group is not created instead it was updated.

addMessageCookieGroupUpdateFailure()  : mixed

Cookie group could not be updated.

addMessageCreateFailure()  : mixed

`wp_insert_post` failed for given type.

addMessageCreateFailureImportingProInFreeVersion()  : mixed

User is trying to import PRO template in free version.

addMessageCreateFailureImportingTemplateButNoLicenseActive()  : mixed

User is trying to import template without license active, so a synchronization is never possible.

addMessageMissingProperties()  : mixed

A type definition is incorrect.

addMessageOptionMultisite()  : mixed

Multisite options can not be imported due to reference issues.

addMessageOptionOutdated()  : mixed

Option not related to RCB.

addMessageOptionRelatesMedia()  : mixed

An option relates to a media, it can never be imported.

addMessageOptionRelatesPageId()  : mixed

An option relates to a page ID, it can never be imported.

addMessageSkipExistingBannerLink()  : mixed

The banner link got not created because already exists.

addMessageSkipExistingBlocker()  : mixed

The content blocker got not created because already exists.

addMessageSkipExistingCookie()  : mixed

The cookie got not created because already exists.

addMessageSkipExistingTcfVendorConfiguration()  : mixed

The TCF vendor configuration got not created because already exists.

addMessageUpdateOptionFailure()  : mixed

`update_option` failured.

addMessageWrongUsageKey()  : mixed

A top-level cookie type has incorrect scheme.

correctAssociationIdsForBlocker()  : mixed

Fetch the correct cookie / TCF vendor ids for the meta.

doImportBannerLinks()  : mixed

Import banner links from JSON.

doImportBlocker()  : mixed

Import content blocker from JSON.

doImportCookieGroups()  : mixed

Import cookie groups from JSON.

doImportCookies()  : mixed

Import cookies from JSON.

doImportCustomizeBanner()  : mixed

Import customize banner settings from JSON.

doImportSettings()  : mixed

Import settings from JSON.

doImportTcfVendorConfigurations()  : mixed

Import TCF Vendor configurations from JSON.

handleCookieAssign()  : mixed

Assign a created cookie to a given group.

handleCorruptBannerLink()  : mixed

Check missing meta of passed banner link.

handleCorruptBlocker()  : mixed

Check missing meta of passed blocker.

handleCorruptCookie()  : mixed

Check missing meta of passed cookie.

handleCorruptGroup()  : mixed

Check missing meta of passed group.

handleCorruptTcfVendorConfiguration()  : mixed

Check missing meta of passed configuration.

handleGroupCreate()  : mixed

Handle to create a new group.

handleGroupUpdate()  : mixed

Handle to update an existing group instead of creating a new one.

handleSepcialCustomizeBanner()  : mixed

Handle special cases for customize banner settings.

handleSepcialSetting()  : mixed

Handle special cases for settings.

probablyAddMessageBlockerAssociation()  : mixed

Add message for non-associated cookies / TCF vendors.

probablyAddMessageCookieGroupNotFound()  : mixed

The cookie could not be associated to the given group, did fallback.

probablyAddMessageDuplicateBlocker()  : mixed

The content blocker got duplicated.

probablyAddMessageDuplicateCookie()  : mixed

The cookie got duplicated.

probablyAddMessageSettingOnlyPro()  : mixed

A PRO-only setting can not be imported in lite.

__construct()  : mixed

C'tor.