API Documentation
\
DevOwl
Freemium
RealProductManagerWpClient
announcement
client
license
rest
view
RealUtils
cross
view
MatthiasWeb
RealMediaLibrary
api
attachment
base
comp
complexquery
exception
folder
lite
comp
folder
order
rest
usersettings
metadata
order
overrides
interfce
comp
folder
order
rest
usersettings
rest
usersettings
view
Utils

\DevOwl\RealProductManagerWpClientAbstractInitiator

This is the main class. You need to create an own class extending from this one to initiate the client. The configuration is done by an abstract schema. That means, all configurations need to be implemented through methods.

Summary

Methods
Properties
Constants
getPluginBase()
getProductAndVariant()
getPluginAssets()
getPrivacyPolicy()
isExternalUpdateEnabled()
isAutoUpdatesEnabled()
isTelemetryEnabled()
isAdminNoticeLicenseVisible()
isLocalAnnouncementVisible()
isNewsletterEnabled()
buildTelemetryData()
isMultisiteLicensed()
getPluginUpdater()
getMigrationOption()
getHost()
getAccountSiteUrl()
getLicenseKeyHelpUrl()
getPrivacyProvider()
start()
getPluginSlug()
getPluginFile()
getPluginVersion()
getPluginName()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$pluginUpdate
N/A

Properties

Methods

getPluginBase()

getPluginBase(): \MatthiasWeb\Utils\Base

Get the plugin's base instance. It is needed so our initiator can access dynamically constants and configurations.

Returns

\MatthiasWeb\Utils\Base

getProductAndVariant()

getProductAndVariant(): array<mixed,integer>

Get the plugin's product ID and product variant ID.

Returns

array<mixed,integer>

getPluginAssets()

getPluginAssets(): \MatthiasWeb\Utils\Assets

Get the plugin's assets instance. It is need to enqueue scripts and styles.

Returns

\MatthiasWeb\Utils\Assets

getPrivacyPolicy()

getPrivacyPolicy(): string

Get the link to the privacy policy.

Returns

string

isExternalUpdateEnabled()

isExternalUpdateEnabled(): boolean

Return `true` if you want to enable external updates instead of wordpress.org.

Returns

boolean

isAutoUpdatesEnabled()

isAutoUpdatesEnabled(): boolean

Returns `true` if the current WordPress installations allows automatic updates for this plugin.

Returns false if the current plugin is already enabled for auto updates.

Attention: We have implemented to only update minor and patch versions, no major versions!

Returns

boolean

isTelemetryEnabled()

isTelemetryEnabled(): boolean

Return `false` if you want to disable sending telemetry data.

Returns

boolean

isAdminNoticeLicenseVisible()

isAdminNoticeLicenseVisible(): boolean

Return `true` if you want to show a notice in the current admin page when the plugin is not fully licensed. There are multiple texts depending on the day since the first initialization. See also `PluginUpdateView#getAdminNoticeLicenseText`.

Returns

boolean

isLocalAnnouncementVisible()

isLocalAnnouncementVisible(): boolean

Return `true` if you want to show a local announcement on the current page.

Returns

boolean

isNewsletterEnabled()

isNewsletterEnabled(): boolean

Return `false` if you want to disable sending newsletter signup.

Returns

boolean

isMultisiteLicensed()

isMultisiteLicensed(): boolean

Return `false` if you want to disable license per site in multisite.

For wordpress.org plugins (free) the multisite-license is disabled.

Returns

boolean

getMigrationOption()

getMigrationOption(): null|string

Get the option value if we want to migrate a plugin. Please override with your implementation and simply return the "old" used license key.

Returns

null|string

getHost()

getHost()

getAccountSiteUrl()

getAccountSiteUrl()

getLicenseKeyHelpUrl()

getLicenseKeyHelpUrl()

getPrivacyProvider()

getPrivacyProvider(): string

Get the privacy provider.

Returns

string

start()

start()

Initialize all available things depending on the configuration.

getPluginSlug()

getPluginSlug()

getPluginFile()

getPluginFile()

getPluginVersion()

getPluginVersion()

getPluginName()

getPluginName()