AbstractInitiator
in package
This is the main class. You need to create an own class extending from this one to initiate the ads system. The configuration is done by an abstract schema. That means, all configurations need to be implemented through methods.
Table of Contents
Properties
- $welcomePage : WelcomePage
- Welcome page.
Methods
- getAssetsUrl() : mixed
- Get the external URL to assets. The default implementation relies on "wp-{TD}". Why TD? The text domain is currently always the same as the slug, even if we are using the lite version. Please ensure a trailing slash, if you override it!
- getHeroButton() : array<string|int, string>|null
- Get the hero button link [0] and text [1] for the welcome page.
- getKeyFeatures() : array<string|int, array<string|int, mixed>>
- Get three key features. See example implementation in real plugins for more information.
- getNextRatingPopup() : mixed
- Get the timestamp when the next rating popup should be shown.
- getPluginAssets() : Assets
- Get the plugin's assets instance. It is need to enqueue scripts and styles.
- getPluginBase() : Base
- Get the plugin's base instance. It is needed so our initiator can access dynamically constants and configurations.
- getPluginFile() : mixed
- getPluginSlug() : mixed
- getRateLink() : string
- Get link to rate the plugin.
- getSupportLink() : mixed
- Get support link. Visible in welcome page.
- getWelcomePage() : mixed
- Get welcome page.
- getWelcomePageImageHeight() : int
- Get the image height for the welcome page key features.
- start() : mixed
- Initialize all available things depending on the configuration.
Properties
$welcomePage
Welcome page.
private
WelcomePage
$welcomePage
Methods
getAssetsUrl()
Get the external URL to assets. The default implementation relies on "wp-{TD}". Why TD? The text domain is currently always the same as the slug, even if we are using the lite version. Please ensure a trailing slash, if you override it!
public
getAssetsUrl([string $path = '' ]) : mixed
Parameters
- $path : string = ''
getHeroButton()
Get the hero button link [0] and text [1] for the welcome page.
public
getHeroButton() : array<string|int, string>|null
Tags
Return values
array<string|int, string>|nullgetKeyFeatures()
Get three key features. See example implementation in real plugins for more information.
public
abstract getKeyFeatures() : array<string|int, array<string|int, mixed>>
Return values
array<string|int, array<string|int, mixed>>getNextRatingPopup()
Get the timestamp when the next rating popup should be shown.
public
getNextRatingPopup(bool $isFirstTime) : mixed
Parameters
- $isFirstTime : bool
-
This is true if the popup should be shown the first time
Tags
getPluginAssets()
Get the plugin's assets instance. It is need to enqueue scripts and styles.
public
abstract getPluginAssets() : Assets
Return values
AssetsgetPluginBase()
Get the plugin's base instance. It is needed so our initiator can access dynamically constants and configurations.
public
abstract getPluginBase() : Base
Return values
BasegetPluginFile()
public
getPluginFile() : mixed
getPluginSlug()
public
getPluginSlug() : mixed
getRateLink()
Get link to rate the plugin.
public
abstract getRateLink() : string
Return values
stringgetSupportLink()
Get support link. Visible in welcome page.
public
getSupportLink() : mixed
Tags
getWelcomePage()
Get welcome page.
public
getWelcomePage() : mixed
Tags
getWelcomePageImageHeight()
Get the image height for the welcome page key features.
public
getWelcomePageImageHeight() : int
Tags
Return values
intstart()
Initialize all available things depending on the configuration.
public
start() : mixed