Frontend-Usage

Last updated Dec 8th, 2019 | Page history | Improve this page | Report an issue

Support the team building MODX with a monthly donation.

The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.

Backers

Budget

$301 per month—let's make that $500!

Learn more

Frontend-Usage¶

Displaying MIGX Items¶

MIGX includes a snippet named getImageList that is used to output information from MIGX TVs. Despite the snippet name, non-images can be retrieved as well. Think of it as the ever-popular snippet getResources but for MIGX.

Here are some sample uses of getImageList:

image galleries
image or HTML sliders
tabular data
CSV or XML output

Let's get to it!

Sample Usage¶

Let's display some images that we input in Step 3. Paste this code wherever you would like to display the images:

<ul>
  [[getImageList?
    &tvname=`myMIGXtv`
    &tpl=`@CODE:<li>[[+idx]]<img src="[[+image]]"/><p>[[+title]]</p></li>
  `]]
</ul>

Let's break this down. The first parameter, &tvname, refers to the name of the MIGX TV that we created in Backend Usage, Step 2. &tpl refers to either a code string for which to use with the MIGX items or the name of a chunk. If you're using a code string, make sure to prepend the code as above with @CODE.

If you're using phpthumbof, you will need to use a chunk and not a code string.

<ul>
  [[getImageList?
    &tvname=`myMIGXtv`
    &tpl=`thumbTpl`]]
</ul>

thumbTpl¶

<li>
  <img src="[[+image:phpthumbof=`w=300&h=300&zc=1`]]" alt="[[+title]]"/>
</li>

Using MIGX with getResources¶

You can call getImageList from getResources to build a gallery of galleries.

<li>
  <a href="[[~[[+id]]]]">[[+pagetitle]]</a>  
  [[getImageList?
    &tvname=`myMIGXtv`
    &tpl=`thumbTpl`
    &limit=`1`
    &docid=`[[+id]]`
  ]]
</li>

… and that's that! You now have your very own MIGX image gallery.

Using getResources values in a MIGX call¶

If you would like to use getResources values in your chunk called by getImageList, you can do so by including them as parameters in the getImageList snippet call and refer to them by the +property placeholder.

Include them in the snippet call:

[[getImageList?
    &tvname=`myMIGXtv`
    &tpl=`thumbTpl2`
    &docid=`[[+id]]`
    &limit=`1`
    &pagetitle=`[[+pagetitle]]`
    &originalResourceId=`[[+id]]`
]]

and then refer to them in the chunk, prepended with "+property.":

  <li>
    <img src="[[+image:phpthumbof=`w=300&h=300&zc=1`]]" alt="[[+title]]" />
    <a href="[[~[[+property.originalResourceId]]]]">See more images from [[+property.pagetitle]]</a>
  </li>

Here's another example from the forum post that lead to the above example.

Properties¶

Name	Description	Default
tvname	the Name of your MIGX-TV
tpl	chunkname to render each record. You can also use @CODE: or @FILE: if empty, getImageList will output an array-string of the records
docid	if you want to show MIGX-records from other resources. Usefull in getResources-tpls with &docid=`[[+id]]`	`[[*id]]`
value	if you want to send your own JSON-string to getImageList instaed of using the TV-output. tvname and docid are ignored then.
limit	If set to non-zero, will only show X number of items.	0
offset	The index to start grabbing from when limiting the number of items.	0
totalVar	the key for the total-placeholder, usefull together with getPage for pagination.	total
randomize	set &randomize=`1` if you want randomized output	0
preselectLimit	together with &randomize, this will preselect items from top to limit, for images you want to see in any case in ranomized output	5
where	filter items. example: `{"active:=":"1","rating:>":"5"}`
sort	sort items by multiple fields. example: `[{"sortby":"age","sortdir":"DESC","sortmode":"numeric"},{"sortby":"name","sortdir":"ASC"}]`
reverse	set &reverse=1 to output everything in reverse order	0
toPlaceholder	outputs to placeholder. example: &toPlaceholder=`MIGX` - get the output by `[[+MIGX]]`
toSeparatePlaceholders	outputs items to seperate placeholders. example: &toSeparatePlaceholders=`MIGX` - get the items by `[[+MIGX.1]]` `[[+MIGX.2]]` ......
placeholdersKeyField	together with &toSeparatePlaceholders. example: &placeholdersKeyField=`title` - get the items by `[[+MIGX.firsttitle]]` `[[+MIGX.thirdtitle]]` ......
outputSeparator	a seperator between items
toJsonPlaceholder	output items as json into a placeholder, usefull when you want for example show randomized items on different places.
example: &toJsonPlaceholder=`jsonoutput` -> [[getImagelist? &value=``[[+jsonoutput]]``................]]
jsonVarKey	example: &jsonVarKey=`migx_json` - this will use the value from $_REQUEST['migx_json'] as value, if any
useful together with the backend-preview-feature	migx_outputvalue

Placeholders¶

Placeholder	Description
`[[+fieldname]]`	replace 'fieldname' with your fieldnames
`[[+idx]]`	the index of each item, begins allways with 1
`[[+_first]]`	returns 1, if in first row
`[[+_last]]`	returns 1, if in last row
`[[+_alt]]`	returns 1 every second row
`[[+total]]`	count of all rows, replace 'total' with your totalVar
`[[+property.name]]`	you can use every script property/param that's set in the actual snippet call, for example if you have &docid=`20` the placeholder `[[+property.docid]]` will return 20

Advanced Usage¶

Switching Template¶

Using &tpl=@FIELD: you can use any field as the template name to switch template from item to item

  [[getImageList?
    &tvname=`myMIGXtv`
    &tpl=`@FIELD:tpl`
  ]]

If you have specified a field name "tpl" from the MIGX TV setup, getImageList will use the value of this field for the items's tpl. The value must be exactly what you would put in the &tpl property - a chunk name, @CODE:... @FILE...