apiopenstudio / transport_ftp
Transport for ApiOpenStudio output over the FTP protocol.
v1.0.0-BETA
2022-06-21 04:28 UTC
Requires
- league/flysystem-ftp: ^3.0
This package is auto-updated.
Last update: 2024-09-22 02:01:40 UTC
README
Transport for ApiOpenStudio output to a remote server using the FTP protocol.
Adding to your project
Composer
$ composer require apiopenstudio/transport_ftp
Configuration
Add a remote output processor to your resource.
The output section example below will return the output in the response as well as upload the response to a server using FTP:
output:
-
processor: xml_remote
id: example XML Remote output
filename: example.xml
transport: ApiOpenStudio\Plugins\TransportFtp
parameters:
host: 192.168.0.1
root: /home/ftp_user
username: ftp_user
password: secret
port: 21
ssl: true
timeout: 90
utf8: false
passive: troe
transferMode: FTP_BINARY
systemType: unix
ignorePassiveAddress: true
timestampsOnUnixListingsEnabled: false
recurseManually: true
-
response
Note: the value for the transport is the full namespace path.
Parameters
Required
- host - hostname
- root - root path
- username - username
- password - password
Optional
- port
- ssl - true|false
- timeout
- utf8 - true|false
- passive - true|false
- transferMode - PHP constant
- systemType - windows|unix
- ignorePassiveAddress - true|false
- timestampsOnUnixListingsEnabled - true|false
- recurseManually - true|false
Further information
See FlySystem documentation and The League GitHub for more details.