Configuration
This chapter describes the parameters that can be used to configure the Feed/XML connector service.
uri
- Type
- string
- Description
-
URI of the XML file to read. This may be any of the following syntaxes:
- absolute file path:
/var/(within the TYPO3 root path orfoo/ web/ fileadmin/ import/ bar. xml TYPO3_)CONF_ VARS [BE] [lock Root Path] - file path relative to the TYPO3 root:
fileadmin/import/ foo. xml - file path using
EXT::EXT:foo/ Resources/ Private/ Data/ bar. xml - fully qualified URL, e.g.
http://www. example. com/ foo. xml - FAL reference with storage ID and file identifier:
FAL:2:/ foo. xml - custom syntax:
MYKEY:, see Connector Serviceswhatever_ you_ want
- absolute file path:
method
- Type
- string
- Description
- Method used to get the file (GET, POST, or whatever else is relevant). This parameter is optional and the method defaults to GET.
requestOptions
- Type
- array
- Description
-
Key-value pairs of options that can be passed to the request. Any of the request options supported by Guzzle HTTP may be used.
Note
This makes sense only when using fully qualified URLs in the uir parameter.
- Example
-
Passing a "page" information in the body and setting an accepted mime type in the headers.
'requestOptions' => [ 'body' => '{"page": 1}', 'headers' => [ 'Accept' => 'application/xml', ], ],Copied!
headers
- Type
- array
- Description
-
Key-value pairs of headers that should be sent along with the request.
Warning
This parameter has been deprecated. It will be removed in the next major version. Use requestOptions instead.
- Example
-
Example headers for setting an alternate user agent and defining what reponse format to accept.
'headers' => [ 'User-Agent' => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:75.0) Gecko/20100101 Firefox/75.0', 'Accept' => 'application/xml', ]Copied!
encoding
- Type
- string
- Description
-
Encoding of the data found in the file. This value must match any of the encoding values recognized by the PHP libray "mbstring". See https://www.php.net/manual/en/mbstring.supported-encodings.php
It is not necessary to define this parameter if the XML source contains an encoding in its declaration. It will automatically be retrieved. However, if this parameter is defined, it supersedes the encoding from the XML declaration.