https://github.com/jako/parsex
Fetch XML files from any location on the web and put its contents into placeholders
https://github.com/jako/parsex
Last synced: 3 months ago
JSON representation
Fetch XML files from any location on the web and put its contents into placeholders
- Host: GitHub
- URL: https://github.com/jako/parsex
- Owner: Jako
- Created: 2024-02-07T12:22:19.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-12-03T14:52:20.000Z (7 months ago)
- Last Synced: 2025-01-30T16:51:38.446Z (5 months ago)
- Language: PHP
- Size: 85 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ParseX
ParseX is an extra for MODX to fetch XML files from any location on the web and
put its contents into placeholders. It works with rss feeds, product lists, race
results or any nested XML format.
## Usage
```
[[!ParseX?
&source=`https://modx.com/feeds/latest.rss`
&tpl=`xmlTpl`
&elements=`item`
&wrapper=`wrapX`
]]
```
In real words:
Please get that feed from modx.com and put all elements that are "item" into
the microtemplate "parsexTpl". And please also embed that mass of items into
the microtemplate "parsexWrapTpl". Set &debugmode=`true` to see all
available elements you can use from your specific feed.
The following snippet properties are available:
| Property | Description | Default |
|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|
| source | Source URL for the XML feed | https://modx.com/feeds/latest.rss |
| elements | XML elements that should be collected for the output | item |
| filter | JSON encoded array of filter clauses (similar to xPDO where clauses) to filter the elements | |
| sortby | JSON encoded array of sortby clauses (at the moment only the first clause is regarded - similar to xPDO sort clauses) to sort the elements | |
| tpl | Template for one element | parsexTpl |
| wrapper | Wrapper template for all elements | parsexWrapTpl |
| outputSeparator | Optional string to separate each tpl instance | "\n" |
| limit | Limits the number of elements returned (0 means no limit) | 0 |
| debugmode | If true output some debug information after the normal output | No |
| cacheData | Amount of time (in seconds) the XML feed will be cached | Not cached |
The filter property could be filled with a JSON encoded array of filters similar
to xPDO where clauses:
```
&filter=`{"requestparam:operator":"value"}`
```
The following filter operators are available: `!=`, `<>`, `>`, `>=`, `<`, `<=`, `LIKE`.
Multiple filter clauses are joined by `AND`.
The snippet ParseXFilter is available in the package to generate the filter
property on base of the value of request parameters.
The following snippet properties are available in this snippet:
| Property | Description | Default |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
| where | JSON encoded xPDO where clause | |
| params | Comma separated list of request parameters. Each request parameter could contain a query operator and query key prefix/suffix, appended colon separated, i.e.: ```¶ms=`requestparam:operator:prefix:suffix` ``` | |
Example:
```
&filter=`[[!ParseXFilter? ¶ms=`requestparam:<>:prefix.:.suffix`]]`
```
will be translated to
```
&filter=`{"prefix.requestparam.suffix:<>":"value"}`
```
if the request parameter `requestparam` is filled.
Installation
------------
MODX Package Management