GravityKit\GravityExport\Addon\GravityExportAddon
Source: src/Addon/GravityExportAddon.php:15
Details
- Kind:
class - Namespace:
GravityKit\GravityExport\Addon - Extends: GFAddOn
- Implements:
AddonInterface
Properties
| Property | Type | Description |
|---|---|---|
$_path | {@inheritdoc} | |
$foundation | Foundation | The foundation settings instance. |
$logger | Logger | Instance of the Foundation logger class. |
Methods
| Method | Description |
|---|---|
minimum_requirements() | |
__construct() | Creates the instance. |
getLogger() | Returns the logger instance for this plugin. |
get_plugin_setting() | Try foundation settings as backup. |
get_plugin_settings() | Merge foundation settings onto the plugin settings. |
render_uninstall() | |
init() | |
pre_init() | |
update_plugin_setting() | Update a single setting. |
update_plugin_settings() | |
get_menu_icon() | Return the plugin's icon for the plugin/form settings menu. |
uninstall() | Uninstall extension. |
Method Reference
minimum_requirements()
public function minimum_requirements(): array
Returns
array
Since: 1.0
Source: src/Addon/GravityExportAddon.php:90
__construct()
public function __construct()
Creates the instance.
Since: $ver$
Source: src/Addon/GravityExportAddon.php:106
getLogger()
final public static function getLogger(): Logger
Returns the logger instance for this plugin.
Returns
Logger
Since: 1.1.3
Source: src/Addon/GravityExportAddon.php:129
get_plugin_setting()
public function get_plugin_setting( $setting_name )
Try foundation settings as backup.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$setting_name |
Since: $ver$
Source: src/Addon/GravityExportAddon.php:145
get_plugin_settings()
public function get_plugin_settings()
Merge foundation settings onto the plugin settings.
Since: $ver$
Source: src/Addon/GravityExportAddon.php:157
render_uninstall()
public function render_uninstall()
Since: 1.0
Source: src/Addon/GravityExportAddon.php:168
init()
public function init()
Since: 1.1
Source: src/Addon/GravityExportAddon.php:176
pre_init()
public function pre_init(): void
Returns
void
Since: 1.5.0
Source: src/Addon/GravityExportAddon.php:189
update_plugin_setting()
public function update_plugin_setting( $key, $value ): bool
Update a single setting.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$key | string | The key to store. | |
$value | mixed | The value to store for the key |
Returns
boolean— Whether the settings were updated or not
Since: 1.0
Source: src/Addon/GravityExportAddon.php:251
update_plugin_settings()
public function update_plugin_settings( $settings )
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$settings |
Since: 1.0
Source: src/Addon/GravityExportAddon.php:274
get_menu_icon()
public function get_menu_icon(): string
Return the plugin's icon for the plugin/form settings menu.
Returns
string
Since: 1.0
Source: src/Addon/GravityExportAddon.php:382
uninstall()
public function uninstall(): bool
Uninstall extension.
Returns
bool
Since: 1.0
Source: src/Addon/GravityExportAddon.php:393