请参阅: 说明
| 类 | 说明 |
|---|---|
| CmsCategoryDirective |
category 分类查询指令
参数列表
id:分类id,结果返回object
CmsCategory
code:分类编码,当id为空时生效,结果返回object
absoluteURL:url处理为绝对路径 默认为true
containsAttribute默认为false,http请求时为高级选项,为true时object.attribute为分类扩展数据map(字段编码,value)
ids:
多个分类id,逗号或空格间隔,当id或code为空时生效,结果返回map(id,object)
使用示例
<@cms.category id=1>${object.name}</@cms.category>
<@cms.category ids=1,2,3><#list map as
k,v>${k}:${v.name}<#sep>,</#list></@cms.category>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/category? |
| CmsCategoryListDirective |
categoryList 分类列表查询指令
参数列表
parentId:父分类id
typeId:分类类型id
absoluteURL:url处理为绝对路径, 默认为 true
queryAll:查询全部,【true,false】,parentId为空时有效
advanced:开启高级选项, 默认为false
containsAttribute默认为true,http请求时为高级选项,为true时category.attribute为分类扩展数据map(字段编码,value)
disabled:高级选项:禁用状态, 默认为false
hidden:高级选项:隐藏,【true,false】
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表,顺序排序正序,id倒序
CmsCategory
使用示例
<@cms.categoryList pageSize=10><#list page.list as
a>${a.name}<#sep>,</#list></@cms.categoryList>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/categoryList? |
| CmsCategoryModelDirective |
categoryModel 分类内容模型映射查询指令
参数列表
categoryId:分类id,结果返回object
CmsCategoryModel
modelId:内容模型id,当id为空时生效,结果返回object
modelIds
多个内容模型id,当categoryId存在,且modelId为空时生效,结果返回map(内容模型id,object)
categoryIds
多个分类id,当categoryId不存在,且modelId存在时生效,结果返回map(分类id,object)
使用示例
<@cms.categoryModel categoryId=1
modelId='article'>${object.templatePath}</@cms.categoryModel>
<@cms.categoryModel categoryIds=1,2,3 modelId='article'><#list map as
k,v>${k}:${v.templatePath}<#sep>,</#list></@cms.categoryModel>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/categoryModel? |
| CmsCategoryModelListDirective |
categoryModelList 分类模型映射列表查询指令
参数列表
modelId:内容模型id
categoryId:分类id
返回结果
list:List类型 查询结果实体列表
CmsCategoryModel
使用示例
<@cms.categoryModelList modelId='article'><#list list as
a>${a.templatePath}<#sep>,</#list></@cms.categoryModelList>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/categoryModelList? |
| CmsCategoryTypeDirective |
categoryType 分类类型查询指令
参数列表
id:分类id,结果返回object
CmsCategoryType
ids:
多个分类id,逗号或空格间隔,当id或code为空时生效,结果返回map(id,object)
使用示例
<@cms.categoryType id=1>${object.name}</@cms.categoryType>
<@cms.categoryType ids=1,2,3><#list map as
k,v>${k}:${v.name}<#sep>,</#list></@cms.categoryType>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/categoryType? |
| CmsCategoryTypeListDirective |
categoryTypeList 分类类型列表查询指令
没有可用于查询得参数,该指令固定返回所有结果,不可分页查询
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
CmsCategoryType
使用示例
<@cms.categoryTypeList><#list page.list as
a>${a.name}<#sep>,</#list></@cms.categoryTypeList>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/categoryTypeList', function(data){
console.log(data.page.totalCount);
});
</script>
|
| CmsCommentDirective |
comment 评论查询指令
参数列表
id:评论id,结果返回object
CmsComment
ids:
多个评论id,逗号或空格间隔,当id为空时生效,结果返回map(id,object)
使用示例
<@cms.comment id=1>${object.text}</@cms.comment>
<@cms.comment ids=1,2,3><#list map as
k,v>${k}:${v.text}<#sep>,</#list></@cms.comment>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/comment? |
| CmsCommentListDirective |
commentList 评论列表查询指令
参数列表
userId:发布评论用户id
replyId:被回复评论id
contentId:内容id
emptyReply:回复id是否为空, replyId为空时有效,默认为false
replyUserId:被回复用户id
advanced:开启高级选项, 默认为false
status:高级选项:评论状态,【1:已发布,2:待审核】
checkUserId:高级选项:审核用户id
disabled:高级选项:评论已删除,【true,false】
orderField
排序字段,【replies:回复数,scores:评分,checkDate:审核日期,updateDate:更新日期,createDate:创建日期】,默认置顶id按orderType排序
orderType:排序类型,【asc:正序,desc:倒序】,默认为倒序
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
CmsComment
使用示例
<@cms.commentList contentId=1 pageSize=10><#list page.list as
a>${a.text}<#sep>,</#list></@cms.commentList>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/commentList? |
| CmsContentDirective |
content 内容查询指令
参数列表
id
内容id,结果返回objectCmsContent
absoluteURL:url处理为绝对路径 默认为 true
absoluteId:id处理为引用内容的ID 默认为 true
containsAttribute
默认为false,http请求时为高级选项,为true时object.attribute为内容扩展数据map(字段编码,value)
ids:
多个内容id,逗号或空格间隔,当id为空时生效,结果返回map(id,object)
使用示例
<@cms.content id=1>${object.title}</@cms.content>
<@cms.content ids=1,2,3><#list map as
k,v>${k}:${v.title}<#sep>,</#list></@cms.content>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/content? |
| CmsContentFileListDirective |
categoryFileList 内容附件列表查询指令
参数列表
fileTypes:文件类型,【image:图片,video:视频,audio:音频,other:其他】
image:是否图片,当fileTypes为空时有效,【true,false】
contentId:内容id
userId:用户id
absoluteURL:url处理为绝对路径 默认为true
orderField:排序字段,【size:文件大小,clicks:点击数】,默认排序正序、id正序
orderType:排序类型,【asc:正序,desc:倒序】,默认为倒序
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
CmsContentFile
使用示例
<@cms.contentFileList contentId=1 pageSize=10><#list page.list as
a>${a.filePath}<#sep>,</#list></@cms.contentFileList>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/contentFileList? |
| CmsContentListDirective |
contentList 内容列表查询指令
参数列表
categoryId:分类id,当parentId为空时有效
containChild:是否包含子分类,【true,false】
categoryIds:多个分类id,当categoryId为空时有效
modelId:多个模型id
parentId:父内容id
onlyUrl:外链,【true,false】
hasImages:拥有图片列表,【true,false】
hasFiles:拥有附件列表,【true,false】
hasProducts:拥有产品列表,【true,false】
hasCover:拥有封面图,【true,false】
userId:发布用户id
startPublishDate:起始发布日期,【2020-01-01 23:59:59】,【2020-01-01】
endPublishDate:终止发布日期,高级选项禁用时不能超过现在,【2020-01-01
23:59:59】,【2020-01-01】
advanced:开启高级选项, 默认为false
status:高级选项:内容状态,【0:操作,1:已发布,2:待审核,3:驳回】
disabled:高级选项:禁用状态,默认为false
emptyParent:高级选项:父内容id是否为空,【true,false】,当parentId为空时有效
title:高级选项:标题
absoluteURL:url处理为绝对路径 默认为true
absoluteId:id处理为引用内容的ID 默认为true
containsAttribute默认为false,http请求时为高级选项,为true时content.attribute为内容扩展数据map(字段编码,value)
orderField
排序字段,【score:评分,comments:评论数,clicks:点击数,collections收藏数,publishDate:发布日期,updateDate:更新日期,checkDate:审核日期】,默认置顶级别倒序、发布日期按orderType排序
orderType:排序类型,【asc:正序,desc:倒序】,默认为倒序
firstResult:开始位置,从1开始
pageIndex:页码,firstResult不存在时有效
pageSize:每页条数
maxResults:最大结果数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
CmsContent
使用示例
<@cms.contentList pageSize=10><#list page.list as
a>${a.title}<#sep>,</#list></@cms.contentList>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/contentList? |
| CmsContentProductDirective |
contentProduct 产品查询指令
参数列表
id:内容id,结果返回objectCmsContentProduct
absoluteURL:cover处理为绝对路径 默认为 true
ids:多个内容id,逗号或空格间隔,当id为空时生效,结果返回map(id,object)
使用示例
<@cms.contentProduct id=1>${object.title}</@cms.contentProduct>
<@cms.contentProduct ids=1,2,3><#list map as
k,v>${k}:${v.title}<#sep>,</#list></@cms.contentProduct>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/contentProduct? |
| CmsContentProductListDirective |
contentProductList 产品列表查询指令
参数列表
contentId:内容id
userId:发布产品用户id
title:标题
startPrice:开始价格
endPrice:结束价格
absoluteURL:封面图处理为绝对路径 默认为true
orderField
排序字段,【price:价格,inventory:库存,sales:销量】,默认置顶id按orderType排序
orderType:排序类型,【asc:正序,desc:倒序】,默认为倒序
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
CmsContentProduct
使用示例
<@cms.contentProductList contentId=1 pageSize=10><#list page.list as
a>${a.title}<#sep>,</#list></@cms.contentProductList>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/contentProductList? |
| CmsContentQuoteListDirective |
contentQuoteList 内容引用列表查询指令
参数列表
quoteId:引用内容id
返回结果:
list:List类型 查询结果实体列表
CmsContent
使用示例
<@cms.contentQuoteList contentId=1 pageSize=10><#list list as
a>${a.title}<#sep>,</#list></@cms.contentQuoteList>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/contentQuoteList? |
| CmsContentRelatedListDirective |
contentRelatedList 内容推荐列表查询指令
参数列表
contentId:内容id
relatedContentId:被推荐内容id
relationType:关系类型
relation:关系
orderField:排序字段,【clicks:点击数】,默认排序正序、id正序
orderType:排序类型,【asc:正序,desc:倒序】,默认为倒序
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
CmsContentRelated
使用示例
<@cms.contentRelatedList contentId=1 pageSize=10><#list page.list as
a>${a.title}<#sep>,</#list></@cms.contentRelatedList>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/contentRelatedList? |
| CmsDictionaryDataDirective |
dictionaryData 数据字典数据查询指令
参数列表
dictionaryId:数据字典id
value
值,结果返回objectCmsDictionaryData
values
多个值,逗号或空格间隔,当value为空时生效,结果返回map(id,object)
使用示例
<@cms.dictionaryData dictionaryId='data'
value='1'>${object.text}</@cms.dictionaryData>
<@cms.dictionaryData dictionaryId values='1,2,3'><#list map as
k,v>${k}:${v.text}<#sep>,</#list></@cms.dictionaryData>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/dictionaryData? |
| CmsDictionaryDataListDirective |
dictionaryDataList 数据字典数据列表
参数列表
dictionaryId:字典id,为空时返回空结果
parentValue:父节点值
返回结果
list:List类型 查询结果实体列表
CmsDictionaryData
使用示例
<@cms.dictionaryDataList dictionaryId='data'><#list list as
a>${a.text}<#sep>,</#list></@cms.dictionaryDataList>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/dictionaryDataList? |
| CmsDictionaryDirective |
dictionary 数据字典查询指令
参数列表
id:值,结果返回objectCmsDictionary
ids:多个值,逗号或空格间隔,当id为空时生效,结果返回map(id,object)
使用示例
<@cms.dictionary id='data'>${object.name}</@cms.dictionary>
<@cms.dictionary values='data,data2'><#list map as
k,v>${k}:${v.name}<#sep>,</#list></@cms.dictionary>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/dictionary? |
| CmsDictionaryExcludeDirective |
dictionaryExclude 数据字典排除规则查询指令
参数列表
dictionaryId:数据字典id
excludeDictionaryId
排除的字典,结果返回objectCmsDictionaryExclude
excludeDictionaryIds
多个排除的字典,逗号或空格间隔,当excludeDictionaryId为空时生效,结果返回map(id,object)
使用示例
<@cms.dictionaryExclude dictionaryId='data'
excludeDictionaryId='data1'>${object.id.excludeDictionaryId}</@cms.dictionaryExclude>
<@cms.dictionaryExclude dictionaryId='data'
excludeDictionaryIds='data1,data2'><#list map as
k,v>${k}:${v.id.excludeDictionaryId}<#sep>,</#list></@cms.dictionaryExclude>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/dictionaryExclude? |
| CmsDictionaryExcludeListDirective |
dictionaryExcludeList 数据字典数据列表
参数列表
dictionaryId:字典id
excludeDictionaryId:排除数据字典id
返回结果
list:List类型 查询结果实体列表
CmsDictionaryExclude
使用示例
<@cms.dictionaryExcludeList dictionaryId='data'><#list list as
a>${a.id.excludeDictionaryId}<#sep>,</#list></@cms.dictionaryExcludeList>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/dictionaryExcludeList? |
| CmsDictionaryExcludeValueDirective |
dictionaryExcludeValue 数据字典排除值查询指令
参数列表
dictionaryId:数据字典id
excludeDictionaryId:排除的字典
value
字典值,结果返回objectCmsDictionaryExcludeValue
values
多个的字典值,逗号或空格间隔,当value为空时生效,结果返回map(id,object)
使用示例
<@cms.dictionaryExcludeValue dictionaryId='data' excludeDictionaryId='data1'
value='data1'>${object.excludeValues}</@cms.dictionaryExcludeValue>
<@cms.dictionaryExcludeValue dictionaryId='data' excludeDictionaryId='data1'
values='1,2'><#list map as
k,v>${k}:${v.excludeValues}<#sep>,</#list></@cms.dictionaryExcludeValue>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/dictionaryExcludeValue? |
| CmsDictionaryListDirective |
dictionaryList 数据字典列表
参数列表
name:字典名称
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
CmsDictionary
使用示例
<@cms.dictionaryList name='data'><#list page.list as
a>${a.name}<#sep>,</#list></@cms.dictionaryList>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/dictionaryList? |
| CmsEditorHistoryDirective |
editorHistory 正文历史查询指令
参数列表
id:id,结果返回object
CmsEditorHistory
ids:
多个id,逗号或空格间隔,当id为空时生效,结果返回map(id,object)
使用示例
<@cms.editorHistory id=1>${object.text}</@cms.editorHistory>
<@cms.editorHistory ids=1,2,3><#list map as
k,v>${k}:${v.text}<#sep>,</#list></@cms.editorHistory>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/editorHistory? |
| CmsEditorHistoryListDirective |
editorHistoryList 内容正文历史列表查询指令
参数列表
itemType:项目类型
itemId:项目id
fieldName:字段名
userId:用户id
orderType:排序类型,【asc:正序,desc:倒序】,默认为发布日期倒序
pageIndex:页码
pageSize:每页条数
返回结果page子属性:
page:PageHandler
page.list:List类型 查询结果实体列表
CmsEditorHistory
使用示例
<@cms.editorHistoryList contentId=1 fieldName='text'
pageSize=10><#list page.list as
a>${a.text}<#sep>,</#list></@cms.editorHistoryList>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/editorHistoryList? |
| CmsFacetSearchDirective |
facetSearch 内容列表查询指令
参数列表
CmsSearchDirective
返回结果
page
分面搜索结果FacetPageHandler
page.list:List类型 查询结果实体列表
CmsContent
使用示例
<@cms.facetSearch word='cms' pageSize=10>
<p> category: <#list page.facetMap.categoryId as k,v><@cms.category id=k>${object.name}</@cms.category>(${v})</#list></p>
<p> model: <#list page.facetMap.modelId as k,v><@cms.model id=k>${object.name}</@cms.model>(${v})</#list></p>
<#list page.list as a><p>${a.title}</p></#list>
</@cms.facetSearch>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/facetSearch? |
| CmsModelDirective |
model 页面片段数据查询指令
参数列表
id:内容模型id,结果返回object
CmsModel
ids:
多个内容模型id,逗号或空格间隔,当id为空时生效,结果返回map(id,object)
使用示例
<@cms.model id='article'>${object.name}</@cms.model>
<@cms.model ids='article,link,picture'><#list map as
k,v>${k}:${v.name}<#sep>,</#list></@cms.model>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/model? |
| CmsModelListDirective |
modelList 内容模型列表查询指令
参数列表
parentId:父内容模型id
queryAll:查询所有模型,parentId为空时有效,【true,false】,默认false
hasChild:拥有子模型,【true,false】
onlyUrl:外链,【true,false】
hasImages:拥有图片列表,【true,false】
hasFiles:拥有文件列表,【true,false】
返回结果
list:List类型 查询结果实体列表
CmsModel
使用示例
<@cms.modelList><#list page.list as
a>${a.name}<#sep>,</#list></@cms.modelList>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/modelList', function(data){
console.log(data.page.totalCount);
});
</script>
|
| CmsPlaceDirective |
place 推荐位查询指令
参数列表
id:推荐位id,结果返回object
CmsPlace
absoluteURL:url处理为绝对路径 默认为 true
containsAttribute:默认为false,为true时object.attribute为推荐位扩展数据map(字段编码,value)
ids:
多个推荐位id,逗号或空格间隔,当id为空时生效,结果返回map(id,object)
使用示例
<@cms.place id=1>${object.title}</@cms.place>
<@cms.place ids='1,2,3'><#list map as
k,v>${k}:${v.title}<#sep>,</#list></@cms.place>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/place? |
| CmsPlaceListDirective |
placeList 推荐位列表查询指令
参数列表
path:页面片段路径
userId:发布用户id
advanced:开启高级选项, 默认为false
status:高级选项:数据状态,【0:操作,1:已发布,2:待审核】
disabled:高级选项:禁用状态,默认为false
startPublishDate:起始发布日期,【2020-01-01 23:59:59】,【2020-01-01】
endPublishDate:终止发布日期,高级选项禁用时不能超过现在,【2020-01-01
23:59:59】,【2020-01-01】
itemType:数据项类型,【content:内容,category:分类,custom:自定义】
itemId:数据项id
absoluteURL:url、封面图处理为绝对路径 默认为true
containsAttribute:默认为false,http请求时为高级选项,为true时place.attribute为推荐位扩展数据map(字段编码,value)
orderField
排序字段,【createDate:创建日期,clicks:点击数】,默认发布日期按orderType排序
orderType:排序类型,【asc:正序,desc:倒序】,默认为倒序
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
CmsPlace
使用示例
<@cms.placeList path='/1.html' pageSize=10><#list page.list as
a>${a.title}<#sep>,</#list></@cms.placeList>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/placeList? |
| CmsSearchDirective |
search 内容列表查询指令
参数列表
word:搜索词,多个搜索词时取并集结果
exclude:排除词汇
tagIds:多个标签id,多个标签时取并集结果
userId:用户id
parentId:父内容id
categoryId:分类id
containChild:包含子分类,当categoryId不为空时有效
categoryIds:多个分类id,当categoryId为空时有效
modelIds:多个模型id
extendsValues
多个全文搜索字段值,格式：[字段编码]:字段值],例如:extendsValues='isbn:value1,unicode:value2'
dictionaryValues
多个字典搜索字段值,只有数据字典父级值时包含所有子级结果,格式：[字段编码]_[字段值],例如:dictionaryValues='extend1_value1,extend1_value2'
dictionaryUnion
取数据字典并集结果,dictionaryUnion不为空时有效,【true,false】,默认为交集结果
highlight:高亮关键词,【true,false】,默认为false,启用高亮后,
标题、作者、编辑、描述字段应该加? |
| CmsSurveyDirective |
survey 调查问卷查询指令
参数列表
id:调查问卷id,结果返回object
CmsSurvey
ids:
多个调查问卷id,逗号或空格间隔,当id为空时生效,结果返回map(id,object)
使用示例
<@cms.survey id=1>${object.title}</@cms.survey>
<@cms.survey ids='1,2,3'><#list map as
k,v>${k}:${v.title}<#sep>,</#list></@cms.survey>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/survey? |
| CmsSurveyListDirective |
surveyList 问卷调查列表查询指令
参数列表
userId:发布用户id
surveyType:问卷类型,【exam:考试,survey:问卷调查】
startStartDate:起始开始日期,【2020-01-01 23:59:59】,【2020-01-01】
endStartDate:终止开始日期,【2020-01-01 23:59:59】,【2020-01-01】
startEndDate:起始结束日期,【2020-01-01 23:59:59】,【2020-01-01】
endEndDate:终止结束日期,【2020-01-01 23:59:59】,【2020-01-01】
title:标题
disabled:已禁用,默认为false
orderField
排序字段,【votes:参与人数,startDate:开始日期,endDate:结束日期,createTime:创建日期】,默认id按orderType排序
orderType:排序类型,【asc:正序,desc:倒序】,默认为倒序
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
CmsSurvey
使用示例
<@cms.surveyList pageSize=10><#list page.list as
a>${a.title}<#sep>,</#list></@cms.surveyList>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/surveyList? |
| CmsSurveyQuestionDirective |
surveyQuestion 调查问卷问题查询指令
参数列表
id:调查问卷问题id,结果返回object
CmsSurveyQuestion
ids:
多个调查问卷问题id,逗号或空格间隔,当id为空时生效,结果返回map(id,object)
absoluteURL:封面图处理为绝对路径 默认为true
advanced:开启高级选项, 默认为false
使用示例
<@cms.surveyQuestion id=1>${object.title}</@cms.surveyQuestion>
<@cms.surveyQuestion ids='1,2,3'><#list map as
k,v>${k}:${v.title}<#sep>,</#list></@cms.surveyQuestion>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/surveyQuestion? |
| CmsSurveyQuestionItemDirective |
surveyQuestionItem 调查问卷问题选项查询指令
参数列表
id:调查问卷问题id,结果返回object
CmsSurveyQuestionItem
ids:
多个调查问卷问题id,逗号或空格间隔,当id为空时生效,结果返回map(id,object)
使用示例
<@cms.surveyQuestionItem id=1>${object.title}</@cms.surveyQuestionItem>
<@cms.surveyQuestionItem ids='1,2,3'><#list map as
k,v>${k}:${v.title}<#sep>,</#list></@cms.surveyQuestionItem>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/surveyQuestionItem? |
| CmsSurveyQuestionItemListDirective |
surveyQuestionItemList 问卷调查问题选项列表查询指令
参数列表
questionId:问题id
orderField:排序字段,【votes:得票数量】,默认sort按顺序
orderType:排序类型,【asc:正序,desc:倒序】,默认为倒序
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
CmsSurveyQuestionItem
使用示例
<@cms.surveyQuestionItemList questionId=1 pageSize=10><#list
page.list as
a>${a.title}<#sep>,</#list></@cms.surveyQuestionItemList>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/surveyQuestionItemList? |
| CmsSurveyQuestionListDirective |
surveyQuestionList 问卷调查问题列表查询指令
参数列表
surveyId:问卷调查id
questionTypes
多个问题类型,【radio:单选,select:下拉选择,checkbox:复选框,text:文字,file:文件,picture:图片】
absoluteURL:封面图处理为绝对路径 默认为true
advanced:开启高级选项, 默认为false
orderType:排序类型,【asc:正序,desc:倒序】,默认为排序顺序
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
CmsSurveyQuestion
使用示例
<@cms.surveyQuestionList surveyId=1 pageSize=10><#list page.list as
a>${a.title}<#sep>,</#list></@cms.surveyQuestionList>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/surveyQuestionList? |
| CmsTagDirective |
tag 标签查询指令
参数列表
id:标签id,结果返回object
CmsTag
ids:
多个标签id,逗号或空格间隔,当id为空时生效,结果返回map(id,object)
使用示例
<@cms.tag id=1>${object.name}</@cms.tag>
<@cms.tag ids='1,2,3'><#list map as
k,v>${k}:${v.name}<#sep>,</#list></@cms.tag>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/tag? |
| CmsTagListDirective |
tagList 标签列表查询指令
参数列表
typeId:标签类型id
name:标签名
advanced:开启高级选项, 默认为false
orderField:高级选项:排序字段,【searchCount:搜索次数】,默认searchCount按orderType排序
orderType:排序类型,【asc:正序,desc:倒序】,默认为倒序
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
CmsTag
使用示例
<@cms.tagList pageSize=10><#list page.list as
a>${a.name}<#sep>,</#list></@cms.tagList>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/tagList? |
| CmsTagTypeDirective |
tagType 标签类型查询指令
参数列表
id:标签类型id,结果返回object
CmsTagType
ids:
多个标签类型id,逗号或空格间隔,当id为空时生效,结果返回map(id,object)
使用示例
<@cms.tagType id=1>${object.name}</@cms.tagType>
<@cms.tagType ids='1,2,3'><#list map as
k,v>${k}:${v.name}<#sep>,</#list></@cms.tagType>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/tagType? |
| CmsTagTypeListDirective |
tagTypeList 标签类型列表查询指令
参数列表
name:标签名
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
CmsTagType
使用示例
<@cms.tagTypeList pageSize=10><#list page.list as
a>${a.name}<#sep>,</#list></@cms.tagTypeList>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/tagTypeList? |
| CmsUserCollectionDirective |
userCollection 用户收藏查询指令
参数列表
userId:用户id
contentId:内容id,结果返回object
CmsUserCollection
contentIds
多个项目id,逗号或空格间隔,当contentId为空时生效,结果返回map(contentId,object)
使用示例
<@cms.userCollection userId=1
contentId=1>${object.scores}</@cms.userCollection>
<@cms.userCollection userId=1 contentIds='1,2,3'><#list map as
k,v>${k}:${v.contentId}<#sep>,</#list></@cms.userCollection>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/userCollection? |
| CmsUserCollectionListDirective |
userCollectionList 用户评分列表查询指令
参数列表
userId:用户id
contentId:内容id
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
CmsUserCollection
使用示例
<@cms.userCollectionList userId=1 pageSize=10><#list page.list as
a>${a.scores}<#sep>,</#list></@cms.userCollectionList>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/userCollectionList? |
| CmsUserScoreDirective |
userScore 用户评分查询指令
参数列表
userId:用户id
itemType:项目类型
itemId:项目id,结果返回object
CmsUserScore
itemIds
多个项目id,逗号或空格间隔,当itemId为空时生效,结果返回map(itemId,object)
使用示例
<@cms.userScore userId=1 itemType="content" itemId=1>${object.scores}</@cms.userScore>
<@cms.userScore userId=1 itemType="content" itemIds='1,2,3'><#list map as
k,v>${k}:${v.scores}<#sep>,</#list></@cms.userScore>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/userScore? |
| CmsUserScoreListDirective |
userScoreList 用户评分列表查询指令
参数列表
userId:用户id
itemType:项目类型
itemId:项目id
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
CmsUserScore
使用示例
<@cms.userScoreList userId=1 pageSize=10><#list page.list as
a>${a.scores}<#sep>,</#list></@cms.userScoreList>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/userScoreList? |
| CmsUserSurveyDirective |
userSurvey 用户问卷回答查询指令
参数列表
userId:用户id
surveyId:问卷id,结果返回object
CmsUserSurvey
surveyIds
多个问卷id,逗号或空格间隔,当surveyId为空且userId不为空时生效,结果返回map(surveyId,object)
userIds
多个用户id,逗号或空格间隔,当userId为空且surveyId不为空时生效,结果返回map(userId,object)
使用示例
<@cms.userSurvey id=1>${object.score}</@cms.userSurvey>
<@cms.userSurvey ids='1,2,3'><#list map as
k,v>${k}:${v.score}<#sep>,</#list></@cms.userSurvey>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/userSurvey? |
| CmsUserSurveyListDirective |
userSurveyList 用户问卷回答列表查询指令
参数列表
userId:用户id
surveyId:问卷id
orderField:排序字段,【score:评分,createDate:创建日期】,默认createDate按orderType排序
orderType:排序类型,【asc:正序,desc:倒序】,默认为倒序
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
CmsUserSurvey
使用示例
<@cms.userSurveyList userId=1 pageSize=10><#list page.list as
a>${a.score}<#sep>,</#list></@cms.userSurveyList>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/userSurveyList? |
| CmsUserSurveyQuestionDirective |
userSurveyQuestion 用户问卷问题解答查询指令
参数列表
userId:用户id
questionId:问题id,结果返回object
CmsUserSurveyQuestion
questionIds
多个问题id,逗号或空格间隔,当questionId为空且userId不为空时生效,结果返回map(questionId,object)
userIds
多个用户id,逗号或空格间隔,当userId为空且questionId不为空时生效,结果返回map(userId,object)
使用示例
<@cms.userSurveyQuestion id=1>${object.answer}</@cms.userSurveyQuestion>
<@cms.userSurveyQuestion ids='1,2,3'><#list map as
k,v>${k}:${v.answer}<#sep>,</#list></@cms.userSurveyQuestion>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/userSurveyQuestion? |
| CmsUserSurveyQuestionListDirective |
userSurveyQuestionList 用户问卷问题解答列表查询指令
参数列表
userId:用户id
questionId:问题id
surveyId:问卷id
orderField:排序字段,【score:评分,createDate:创建日期】,默认createDate按orderType排序
orderType:排序类型,【asc:正序,desc:倒序】,默认为倒序
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
CmsUserSurveyQuestion
使用示例
<@cms.userSurveyQuestionList userId=1 pageSize=10><#list page.list as
a>${a.answer}<#sep>,</#list></@cms.userSurveyQuestionList>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/userSurveyQuestionList? |
| CmsUserVoteDirective |
userVote 用户投票查询指令
参数列表
userId:用户id
voteId:投票id,结果返回object
CmsUserVote
voteIds
多个投票id,逗号或空格间隔,当voteId为空时生效,结果返回map(voteId,object)
使用示例
<@cms.userVote id=1>${object.itemId}</@cms.userVote>
<@cms.userVote ids='1,2,3'><#list map as
k,v>${k}:${v.itemId}<#sep>,</#list></@cms.userVote>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/userVote? |
| CmsUserVoteListDirective |
userVoteList 用户投票列表查询指令
参数列表
userId:用户id
voteId:投票id
orderType:排序类型,【asc:正序,desc:倒序】,默认为创建日期倒序
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
CmsUserVote
使用示例
<@cms.userVoteList userId=1 pageSize=10><#list page.list as
a>${a.ip}<#sep>,</#list></@cms.userVoteList>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/userVoteList? |
| CmsVoteDirective |
vote 投票查询指令
参数列表
id:投票id,结果返回object
CmsVote
ids:
多个投票id,逗号或空格间隔,当id为空时生效,结果返回map(id,object)
使用示例
<@cms.vote id=1>${object.title}</@cms.vote>
<@cms.vote ids='1,2,3'><#list map as
k,v>${k}:${v.title}<#sep>,</#list></@cms.vote>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/vote? |
| CmsVoteItemDirective |
voteItem 投票选项查询指令
参数列表
id:投票选项id,结果返回object
CmsVoteItem
ids:
多个投票选项id,逗号或空格间隔,当id为空时生效,结果返回map(id,object)
使用示例
<@cms.voteItem id=1>${object.title}</@cms.voteItem>
<@cms.voteItem ids='1,2,3'><#list map as
k,v>${k}:${v.title}<#sep>,</#list></@cms.voteItem>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/voteItem? |
| CmsVoteItemListDirective |
voteItemList 投票选项列表查询指令
参数列表
voteId:投票id
orderField:排序字段,【votes:投票人数,sort:排序正序】,默认sort按正序
orderType:排序类型,【asc:正序,desc:倒序】,默认为倒序
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
CmsVoteItem
使用示例
<@cms.voteItemList voteId=1 pageSize=10><#list page.list as
a>${a.title}<#sep>,</#list></@cms.voteItemList>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/voteItemList? |
| CmsVoteListDirective |
voteList 投票列表查询指令
参数列表
startStartDate:起始开始日期,【2020-01-01 23:59:59】,【2020-01-01】
endStartDate:终止开始日期,【2020-01-01 23:59:59】,【2020-01-01】
startEndDate:起始结束日期,【2020-01-01 23:59:59】,【2020-01-01】
endEndDate:终止结束日期,【2020-01-01 23:59:59】,【2020-01-01】
advanced:开启高级选项, 默认为false
disabled:高级选项:禁用状态,默认为false
title:高级选项:标题
orderField:排序字段,【startDate:开始日期,endDate:结束,votes:投票人数,createDate:创建日期】,默认id按orderType排序
orderType:排序类型,【asc:正序,desc:倒序】,默认为倒序
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
CmsVote
使用示例
<@cms.voteList pageSize=10><#list page.list as
a>${a.title}<#sep>,</#list></@cms.voteList>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/voteList? |
| CmsWordDirective |
word 搜索词查询指令
参数列表
id:搜索词id,结果返回object
CmsWord
ids:
多个搜索词id,逗号或空格间隔,当id为空时生效,结果返回map(id,object)
使用示例
<@cms.word id=1>${object.name}</@cms.word>
<@cms.word ids='1,2,3'><#list map as
k,v>${k}:${v.name}<#sep>,</#list></@cms.word>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/word? |
| CmsWordListDirective |
wordList 用户投票列表查询指令
参数列表
startCreateDate:起始创建日期,【2020-01-01 23:59:59】,【2020-01-01】
endCreateDate:终止创建日期,【2020-01-01 23:59:59】,【2020-01-01】
advanced:开启高级选项, 默认为false
hidden:高级选项:禁用状态,默认为false
name:高级选项:名称
orderField
高级选项:排序,【searchCount:搜索次数,createDate:创建日期,id:id】默认为searchCount按orderType排序
orderType:排序类型,【asc:正序,desc:倒序】,默认为创建日期倒序
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
CmsWord
使用示例
<@cms.wordList userId=1 pageSize=10><#list page.list as
a>${a.ip}<#sep>,</#list></@cms.wordList>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/wordList? |
| WorkloadDirective |
wordload 工作量查询指令
参数列表
status:多个内容状态,【0:草稿,1:已发布,2:待审核,3:驳回】
startCreateDate:起始创建日期,【2020-01-01 23:59:59】,【2020-01-01】
endCreateDate:终止创建日期,【2020-01-01 23:59:59】,【2020-01-01】
workloadType:工作量类型【dept:部门,user:用户】,默认部门
dateField:日期字段【createDate:创建日期,publishDate:发布日期】,默认创建日期
返回结果
list:List类型 查询结果实体列表
Workload
使用示例
<@cms.wordload pageSize=10><#list page.list as
a>${a.name}<#sep>,</#list></@cms.wordload>
<script>
$.getJSON('${site.dynamicPath}api/directive/cms/wordload? |
CMS指令 指令是一种FreeMarker的扩展,既可以在模板中定义指令又可以用java类实现指令,在PublicCMS中对FreeMarker这种指令扩展方式进行了封装和延申。
这些指令和函数既支持在模板中调用,也支持http方式请求调用,参数规则也保持一致,实现httpEnabled方法返回false可以禁用http方式,实现needAppToken方法返回true可以启用安全验证,只有后台维护->应用授权中授权的应用通过其token才可请求。