Dateiablage über ein Transfer-Adapter
Überblick
Das Bundle bietet die Möglichkeit, eigene Adapter zum Ablegen von Dateien außerhalb des Dateisystems zu konfigurieren. Damit können Dateien z.B. auf einem SFTP-Server abgelegt werden.
Dies ist vor allem relevant für die Ablage von Assets & JSON-Dateien für den Export.
JSON-Dateien und Assets
Der unter transfer konfigurierte Adapter wird für die Ablage der JSON-Dateien genutzt. Optional kann über asset_transfer ein separater Adapter für die Ablage der Assets konfiguriert werden. Ist asset_transfer nicht konfiguriert, werden auch die Assets über den unter transfer konfigurierten Adapter abgelegt. Ist asset_transfer ohne adapter konfiguriert, wird der NfsTransferAdapter genutzt.
twocream_shopware_connector:
export_targets:
- key: shop_staging
# ...
transfer:
adapter: 'sftp'
parameters:
host: 'sftp.example.com'
username: 'user_name'
password: 'Password123!'
asset_transfer:
adapter: 'nfs'
Bereitgestellte Adapter
Sofern in der Konfiguration kein anderer Adapter konfiguriert ist, wird standardmäßig der NfsTransferAdapter genutzt!
Das Bundle stellt standardmäßig die folgenden Adapter zur Verfügung:
NfsTransferAdapter
Identifier: 'nfs'
Klasse: Twocream\ShopwareConnectorBundle\Service\TransferAdapter\NfsTransferAdapter
Beschreibung: Dies ist der Standard-Adapter, hiermit können Dateien auf dem lokalen Dateisystem abgelegt werden
SftpTransferAdapter
Identifier: 'sftp'
Klasse: Twocream\ShopwareConnectorBundle\Service\TransferAdapter\SftpTransferAdapter
Beschreibung: Dieser Adapter ermöglicht es, Daten auf einem SFTP-Server abzulegen
Für die Nutzung des SftpTransferAdapters muss das Composer-Paket league/flysystem-sftp-v3 installiert sein, siehe: Installation
YAML-Parameter:
| Identifier | Beschreibung |
|---|---|
host | Der Hostname des SFTP-Servers |
username | Der Nutzername zur Authentifizierung auf dem SFTP-Server |
password | Das Passwort zur Authentifizierung auf dem SFTP-Server |
private_key | Der Private-Key zur Authentifizierung auf dem SFTP-Server |
passphrase | Die Passphrase zur Authentifizierung mit dem Private-Key |
port | Der Port, der zur Verbindung genutzt werden soll (Standardmäßig: 22) |
file_permissions | Die Zugriffsrechte für Dateien im oktalen Format, jeweils für public und private (Standardmäßig: public: '0644', private: '0600') |
directory_permissions | Die Zugriffsrechte für Ordner im oktalen Format, jeweils für public und private (Standardmäßig: public: '0755', private: '0700') |
Werden file_permissions bzw. directory_permissions konfiguriert, müssen jeweils beide Werte public und private angegeben werden:
transfer:
adapter: 'sftp'
parameters:
host: 'sftp.example.com'
username: 'user_name'
password: 'Password123!'
file_permissions:
public: '0664'
private: '0600'
directory_permissions:
public: '0775'
private: '0700'
Zur Konfiguration von Parametern, siehe: Konfiguration
PimcoreAssetTransferAdapter
Identifier: 'pimcore_asset'
Klasse: Twocream\ShopwareConnectorBundle\Service\TransferAdapter\PimcoreAssetTransferAdapter
Beschreibung: Dieser Adapter ermöglicht es, Dateien als Assets im Pimcore-Asset-Baum abzulegen. Die konfigurierten Verzeichnisse (z.B. export_directory) entsprechen dabei absoluten Pfaden im Asset-Baum (z.B. /Export/Shop/). Beim Ablegen einer Datei wird die Job-ID des Exports, sofern vorhanden, als Metadatum exportJobId am Asset hinterlegt. Der Adapter ist für die Ablage der JSON-Dateien (transfer) vorgesehen. Für asset_transfer ist er nicht geeignet, da Assets aus dem lokalen Dateisystem kopiert werden
YAML-Parameter: Dieser Adapter benötigt keine Parameter
Eigenen Adapter erstellen
Adapter können durch ihren Identifier über folgende Collection-Klasse bezogen werden: Twocream\ShopwareConnectorBundle\Service\TransferAdapter\TransferAdapterCollector
Interface
Ein TransferAdapter muss das Interface Twocream\ShopwareConnectorBundle\Service\TransferAdapter\TransferAdapterInterface implementieren.
Methoden
Der Adapter muss folgende Methoden implementieren:
| Definition | Argumente | Beschreibung |
|---|---|---|
public static function getIdentifier(): string | Keine Argumente | Rückgabe eines eindeutigen Identifiers für den Adapter (Dies ist der Wert, der in der Konfiguration hinterlegt wird) |
public function __construct(array $config) | $config: Die unter parameters konfigurierten Werte | Erzeugt den Adapter |
public function exists(string $path): bool | $path: Der zu prüfende Pfad | Prüft, ob der gegebene Pfad existiert |
public function isDirectory(string $path): bool | $path: Der zu prüfende Pfad | Prüft, ob es sich bei dem gegebenen Pfad um einen Ordner handelt |
public function isFile(string $path): bool | $path: Der zu prüfende Pfad | Prüft, ob es sich bei dem gegebenen Pfad um eine Datei handelt |
public function isEmptyDirectory(string $path): bool | $path: Der zu prüfende Pfad | Prüft, ob es sich bei dem gegebenen Pfad um einen leeren Ordner handelt |
public function isAbsolutePath(string $path): bool | $path: Der zu prüfende Pfad | Prüft, ob der gegebene Pfad absolut ist |
public function read(string $path): ?string | $path: Der Pfad der einzulesenden Datei | Liest den Inhalt der gegebenen Datei aus und gibt diesen zurück |
public function dumpFile(string $filename, string $content): bool | $filename: Der Pfad zur Datei$content: Der in die Datei zu schreibende inhalt | Schreibt den gegebenen Inhalt in die gegebene Datei |
public function copy(string $source, string $target, bool $overwriteNewerFiles = false): bool | $source: Der Pfad der zu kopierenden Datei$target: Der Pfad, in dem die Datei kopiert werden soll$overwriteNewerFiles: Bestimmt, ob Dateien überschrieben werden sollen | Kopiert die gegebene Datei in den gegebenen Pfad |
public function rename(string $origin, string $target, bool $overwrite = false): bool | $origin: Der Pfad des zu umzubenennenden Ordners bzw. der zu umzubenennenden Datei$target: Der neue Name$overwrite: Bestimmt, ob bestehende Dateien mit dem selben Namen überschrieben werden sollen | Benennt den gegebenen Ordner bzw. die gegebene Datei in den gegebenen Namen um |
public function remove(string $path): bool | $path: Der Pfad der zu löschenden Datei bzw. des zu löschenden Ordners | Löscht die gegebene Datei bzw. den gegebenen Ordner |
public function mkdir(string $dir, int $mode = 0777): bool | $dir: Der zu erstellende Ordner$mode: Zugriffsrechte im oktalen Format | Erstellt den gegebenen Ordner |
public function copyDirectory(string $sourceDir, string $destinationDir): bool | $sourceDir: Der Pfad des zu kopierenden Ordners$destinationDir: Der Pfad, in dem der Ordner kopiert werden soll | Kopiert den gegebenen Ordner in den gegebenen Pfad |
public function findFiles(string $pattern, string $path, ?int $depth = null, bool $sortByModifiedTime = false, bool $ignoreDotFiles = false): array | $pattern: Das Pattern zum Filtern von Dateinamen (RegEx oder Wildcards)$path: Der Pfad zum zu durchsuchenden Ordner$depth: Anzahl an Unterordner-Ebenen, die durchsucht werden sollen$sortByModifiedTime: Bestimmt, ob nach Änderungszeitpunkt sortiert werden soll$ignoreDotFiles: Bestimmt, ob Punktdateien (z.B. ., .., .env) ignoriert werden sollen | Sucht nach Dateien, die den gegebenen Bedingungen entsprechen (Siehe Argumente) und gibt diese als Array zurück |
public function getFileModifiedTime(string $path): ?int | $path: Der Pfad zur Datei | Gibt den Zeitpunkt der letzten Änderung der gegebenen Datei zurück |
Registrierung
Neue Adapter sind über den Parameter twocream_shopware_connector.transfer_adapters in einer Service-Konfigurationsdatei zu registrieren. Der Parameter ordnet jedem Identifier die Adapter-Klasse zu, der Schlüssel muss dem Rückgabewert von getIdentifier() entsprechen. Da der Parameter beim Überschreiben vollständig ersetzt wird, müssen die mitgelieferten Adapter ebenfalls angegeben werden. Der Adapter wird nicht als Service bezogen, sondern vom TransferAdapterCollector mit den unter parameters konfigurierten Werten instanziiert (__construct(array $config)).
parameters:
twocream_shopware_connector.transfer_adapters:
sftp: '\Twocream\ShopwareConnectorBundle\Service\TransferAdapter\SftpTransferAdapter'
nfs: '\Twocream\ShopwareConnectorBundle\Service\TransferAdapter\NfsTransferAdapter'
pimcore_asset: '\Twocream\ShopwareConnectorBundle\Service\TransferAdapter\PimcoreAssetTransferAdapter'
example: '\App\Service\TransferAdapter\ExampleTransferAdapter'