developer documentation r17362

fm:GroupList

fm:GroupList allows you to create a list of groups users created on the system.

Example

<fm:GroupList> <fm:Loop> {$$group.name} </fm:Loop> <fm:NoResults> No groups have been created yet. </fm:NoResults> </fm:GroupList>

Supported attributes

NameRequiredDefaultDescription
evenClassOptionalThe contents of this attribute will be placed in the 'loop.evenClass' template variable, only for even row-numbers. This allows you to give every even row a specific css class
moderationStatusOptionalN/AFilter by this moderationstatus. Possible values are "accepted", "denied", "unmoderated", "moderated", "notdenied","all"
oddClassOptionalThe contents of this attribute will be placed in the 'loop.oddClass' template variable, only for odd row-numbers. This allows you to give every odd row a specific css class
pageSizeOptional100Sets the total number of items per page.
parentGroupOptionalN/AGroups support nesting, you can display all sub-groups for a specific parent-group by specifying the id using the attribute
searchQueryOptionalN/ASearches using the Full-text index on title, description, address and city
sortOptionalcreated DESCSets the sort field. Use the format fieldname ASC/DESC. Currently created, memberCount, mediaCount, id and name are supported
startPageOptional0Sets the startpage for this list.

Template variables

NameDescription
loop.hasResultsThe contents of this variable will be either 0 or 1, depending on if there are items in the list.
loop.oddClassThe contents of this variable will reflect the "oddClass" attribute. This will only be set for odd rownumbers.
loop.evenClassThe contents of this variable will reflect the "evenClass" attribute. This will only be set for even rownumbers.
loop.indexThe 0-based index of the item in the loop. (Will contain 0,1,2,3,4, etc.)
loop.currentPageIf a pager is involved in this loop, this will contain the current page number (0-based index). If page information is not available, this will be 0.
loop.currentPage1This value is currentPage + 1. This number can be useful to display the current page number to use user. (people generally count from 1, not 0).
loop.totalPagesTotal number of pages avaiable in this loop. This will be 0 if the loop does not support paging.
loop.totalItemsTotal number of individual items. This will be 0 if the loop does not support paging.
loop.pageSizeTotal number of items on 1 single page. This will be 0 if the loop does not support paging.
group.idGroup id
group.nameGroup name
group.descriptionDescription
group.noteThe note field can be used to specify additional information about the group, generally this is only used within the mediafactory
group.logoThe logo is actually a media-id, use this in conjunction with the mediaviewers.
group.createdThe creation date in YYYY-MM-DD HH:MM:SS format
group.createdbyThis is a user-id
group.memberCountThis variable contains the total number of group members
group.mediaCountThis variable contains the total number of items associated with the group
group.approvedMediaCountThis variable contains the number of media items associated with the group that have been approved
group.notDeniedMediaCountThis variable contains the number of media items associated with the group that have not been denied
group.geo_longitudeThe longitude of the group.
group.geo_latitudeThe latitude of the group.
group.moderationStatusThe current moderation-status for the group. This can be either unmoderated, accepted or denied
group.addressAddress of the group.
group.cityCity the group is in.
group.state2-letter state or province
group.postalcodePostal/zip-code
group.country2-letter country code

See also

<< 7.3.13 fm:GroupInfo 7.3.15 fm:HTMLSanitizer >>