GravityKit\GravityExport\Save\StorageType\FTP
Storage type that stores to an (s)ftp server.
Since: 1.0
Source: add-ons/save/src/StorageType/FTP.php:16
Details
- Kind:
class - Namespace:
GravityKit\GravityExport\Save\StorageType - Extends:
FlySystemStorageType
Methods
| Method | Description |
|---|---|
__construct() | Creates the storage type. |
getId() | Should return a unique name for the storage type. |
getTitle() | Should return the title of the storage type. |
getIcon() | Should return the icon for the storage method. |
isDisabled() | Should return whether the storage method is properly configured in the global settings. |
getFeedFields() | Should return the field section for this storage type. |
getStorageSettings() | Updates the settings for a storage type. |
Method Reference
__construct()
public function __construct( StorageService $service, PasswordService $password_service, ConnectionManagerService $connection_manager_service )
Creates the storage type.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$service | StorageService | The storage service. | |
$password_service | PasswordService | ||
$connection_manager_service | ConnectionManagerService |
Since: 1.0
Source: add-ons/save/src/StorageType/FTP.php:129
getId()
public function getId(): string
Should return a unique name for the storage type.
Returns
string
Since: 1.0
Source: add-ons/save/src/StorageType/FTP.php:140
getTitle()
public function getTitle(): string
Should return the title of the storage type.
Returns
string
Since: 1.0
Source: add-ons/save/src/StorageType/FTP.php:148
getIcon()
public function getIcon(): string
Should return the icon for the storage method.
In GF 2.4, it must be a FontAwesome CSS class. In GF 2.5, it must be parseable by \GFCommon::get_icon_markup().
Returns
string
Since: 1.0
Source: add-ons/save/src/StorageType/FTP.php:156
isDisabled()
public function isDisabled(): bool
Should return whether the storage method is properly configured in the global settings.
Returns
bool
Source: add-ons/save/src/StorageType/FTP.php:164
getFeedFields()
public function getFeedFields( SaveAddon $addon ): array
Should return the field section for this storage type.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$addon | SaveAddon | ||
$feed | SaveAddon | The storage feed addon. |
Returns
mixed[]— The fields for the storage type.
Since: 1.0
Source: add-ons/save/src/StorageType/FTP.php:172
getStorageSettings()
public function getStorageSettings( array $settings, array $feed ): array
Updates the settings for a storage type.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$settings | mixed[] | The current settings. | |
$feed | mixed[] | The fresh feed settings. |
Returns
mixed[]— The updated settings.
Since: 1.0
Source: add-ons/save/src/StorageType/FTP.php:315