| 程序包 | 说明 |
|---|---|
| com.publiccms.logic.component.site |
Site component
站点组件
|
| com.publiccms.views.directive.cms |
Cms directive
CMS指令
指令是一种FreeMarker的扩展,既可以在模板中定义指令又可以用java类实现指令,在PublicCMS中对FreeMarker这种指令扩展方式进行了封装和延申。
|
| com.publiccms.views.directive.log |
Log directive
日志指令
|
| com.publiccms.views.directive.oauth |
Oauth directive
OAUTH指令
|
| com.publiccms.views.directive.sys |
System directive
系统指令
|
| com.publiccms.views.directive.tools |
Tools directive
工具指令
|
| com.publiccms.views.directive.trade |
Trade directive
商务指令
|
| com.publiccms.views.directive.visit |
Visit report directive
访问统计指令
|
| 限定符和类型 | 字段和说明 |
|---|---|
private java.util.Map<java.lang.String,AbstractTemplateDirective> |
DirectiveComponent.templateDirectiveMap |
| 限定符和类型 | 方法和说明 |
|---|---|
java.util.Map<java.lang.String,AbstractTemplateDirective> |
DirectiveComponent.getTemplateDirectiveMap() |
| 限定符和类型 | 方法和说明 |
|---|---|
private void |
DirectiveComponent.init(org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer freeMarkerConfigurer,
java.util.List<AbstractTemplateDirective> templateDirectiveList,
java.util.List<AbstractTaskDirective> taskDirectiveList,
java.util.List<BaseMethod> methodList) |
| 限定符和类型 | 类和说明 |
|---|---|
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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>
|
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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>
|
class |
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? |
class |
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? |
class |
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,启用高亮后,
标题、作者、编辑、描述字段应该加? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
class |
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? |
| 限定符和类型 | 类和说明 |
|---|---|
class |
LogLoginListDirective
logLoginList 登录日志列表查询指令
参数列表
userId:用户id
startCreateDate:起始创建日期,【2020-01-01 23:59:59】,【2020-01-01】
endCreateDate:终止创建日期,【2020-01-01 23:59:59】,【2020-01-01】
channel:登录渠道
result:登录结果,【true,false】
name:用户名
ip:IP
orderType:排序类型,【asc:正序,desc:倒序】,默认为倒序
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
LogLogin
使用示例
<@log.loginList pageSize=10><#list page.list as
a>${a.name}<#sep>,</#list></@log.loginList>
<script>
$.getJSON('${site.dynamicPath}api/directive/log/loginList? |
class |
LogOperateDirective
logOperate 操作日志查询指令
参数列表
id:日志id,结果返回object
LogOperate
ids:
多个日志id,逗号或空格间隔,当id为空时生效,结果返回map(id,object)
使用示例
<@log.operate id=1>${object.content}</@log.operate>
<@log.operate ids='1,2,3'><#list map as
k,v>${k}:${v.content}<#sep>,</#list></@log.operate>
<script>
$.getJSON('${site.dynamicPath}api/directive/log/operate? |
class |
LogOperateListDirective
logOperateList 操作日志列表查询指令
参数列表
channel:渠道
operate:操作编码
userId:用户ID
startCreateDate:起始创建日期,【2020-01-01 23:59:59】,【2020-01-01】
endCreateDate:终止创建日期,【2020-01-01 23:59:59】,【2020-01-01】
content:操作内容
name:用户名
ip:IP
orderType:排序类型,【asc:正序,desc:倒序】,默认为倒序
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
LogOperate
使用示例
<@log.operateList pageSize=10><#list page.list as
a>${a.name}<#sep>,</#list></@log.operateList>
<script>
$.getJSON('${site.dynamicPath}api/directive/log/OperateList? |
class |
LogTaskDirective
logTask 任务计划日志查询指令
参数列表
id:日志id,结果返回object
LogTask
ids:
多个日志id,逗号或空格间隔,当id为空时生效,结果返回map(id,object)
使用示例
<@log.task id=1>${object.result}</@log.task>
<@log.task ids='1,2,3'><#list map as
k,v>${k}:${v.result}<#sep>,</#list></@log.task>
<script>
$.getJSON('${site.dynamicPath}api/directive/log/task? |
class |
LogTaskListDirective
logTaskList 任务计划日志列表查询指令
参数列表
taskId:任务计划ID
startCreateDate:起始创建日期,【2020-01-01 23:59:59】,【2020-01-01】
endCreateDate:终止创建日期,【2020-01-01 23:59:59】,【2020-01-01】
success:执行结果,【true,false】
orderType:排序类型,【asc:正序,desc:倒序】,默认为倒序
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
LogTask
使用示例
<@log.taskList pageSize=10><#list page.list as
a>${a.name}<#sep>,</#list></@log.taskList>
<script>
$.getJSON('${site.dynamicPath}api/directive/log/TaskList? |
class |
LogUploadListDirective
logUploadList 文件上传日志列表查询指令
参数列表
fileTypes:文件类型,【image,video,audio,document,other】
image:是否图片,【true,false】
userId:用户ID
channel:渠道
privatefile:私有文件,【true,false】,默认false
originalName:原文件名
filePath:文件路径
orderField:排序字段,[createDate:创建日期,fileSize:文件大小],默认ID倒序
orderType:排序类型,【asc:正序,desc:倒序】,默认为倒序
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
LogUpload
使用示例
<@log.uploadList pageSize=10><#list page.list as
a>${a.name}<#sep>,</#list></@log.uploadList>
<script>
$.getJSON('${site.dynamicPath}api/directive/log/UploadList? |
| 限定符和类型 | 类和说明 |
|---|---|
class |
OauthListDirective
oauthList 账户查询指令
参数列表
返回结果
list登录渠道名称列表
使用示例
<@oauth.list><#list list as a>${a}<#sep>,</#list></@oauth.list>
<script>
$.getJSON('${site.dynamicPath}api/directive/oauth/list', function(data){
console.log(data);
});
</script>
|
| 限定符和类型 | 类和说明 |
|---|---|
class |
SysAppClientDirective
sysAppClient 应用客户端查询指令
参数列表
id:客户端id,结果返回object
SysAppClient
ids:
多个客户端id,逗号或空格间隔,当id为空时生效,结果返回map(id,object)
使用示例
<@sys.appClient id=1>${object.clientVersion}</@sys.appClient>
<@sys.appClient ids='1,2,3'><#list map as
k,v>${k}:${v.clientVersion}<#sep>,</#list></@sys.appClient>
<script>
$.getJSON('${site.dynamicPath}api/directive/sys/appClient? |
class |
SysAppClientListDirective
sysAppClientList 应用客户端列表查询指令
参数列表
advanced:开启高级选项, 默认为false
disabled:高级选项:禁用状态,【true,false】,默认false
channel:渠道
userId:用户id
startLastLoginDate:起始上次登录日期,【2020-01-01
23:59:59】,【2020-01-01】
endLastLoginDate:终止上次登录日期,【2020-01-01 23:59:59】,【2020-01-01】
startCreateDate:起始创建日期,【2020-01-01 23:59:59】,【2020-01-01】
endCreateDate:终止创建日期,【2020-01-01 23:59:59】,【2020-01-01】
orderField
排序字段,[lastLoginDate:上次登录日期,createDate:创建日期],默认创建日期倒序
orderType:排序类型,【asc:正序,desc:倒序】,默认为倒序
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
SysAppClient
使用示例
<@sys.appClientList pageSize=10><#list page.list as
a>${a.uuid}<#sep>,</#list></@sys.appClientList>
<script>
$.getJSON('${site.dynamicPath}api/directive/sys/appClientList? |
class |
SysAppDirective
sysApp 应用查询指令
参数列表
id:应用id,结果返回object
SysApp
ids:
多个应用id,逗号或空格间隔,当id为空时生效,结果返回map(id,object)
使用示例
<@sys.app id=1>${object.channel}</@sys.app>
<@sys.app ids='1,2,3'><#list map as
k,v>${k}:${v.channel}<#sep>,</#list></@sys.app>
<script>
$.getJSON('${site.dynamicPath}api/directive/sys/app? |
class |
SysAppListDirective
sysAppList 应用列表查询指令
参数列表
channel:渠道
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
SysApp
使用示例
<@sys.appList pageSize=10><#list page.list as
a>${a.channel}<#sep>,</#list></@sys.appList> |
class |
SysAppTokenListDirective
sysAppTokenList 应用授权列表查询指令
参数列表
appId:应用id
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
SysAppToken
使用示例
<@sys.appTokenList pageSize=10><#list page.list as
a>${a.authToken}<#sep>,</#list></@sys.appTokenList> |
class |
SysAuthorizedDirective
sysAuthorized 角色url授权查询指令
参数列表
roleIds:多个角色id
url
url,roleIds、url都存在时,结果返回true或false,表示这些角色是否拥有该url的权限
urls
多个url,当roleIds存在,且url为空时生效,结果返回map(url,true或false)
使用示例
<@sys.authorized roleIds='1,2,3'
url='cmsContent/list'>${object}</@sys.authorized>
<@sys.authorized roleIds='1,2,3'
urls='cmsContent/list,cmsCategory/list'><#list map as
k,v>${k}:${v}<#sep>,</#list></@sys.authorized>
<script>
$.getJSON('${site.dynamicPath}api/directive/sys/authorized? |
class |
SysClusterListDirective
sysClusterList 系统节点列表查询指令
参数列表
startHeartbeatDate:起始心跳日期,【2020-01-01 23:59:59】,【2020-01-01】
endHeartbeatDate:终止心跳日期,【2020-01-01 23:59:59】,【2020-01-01】
master:是否主节点,【true,false】,默认false
orderField:排序字段,[createDate:上次登录日期,heartbeatDate:创建日期,id],默认id倒序
orderType:排序类型,【asc:正序,desc:倒序】,默认为倒序
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
SysCluster
使用示例
<@sys.clusterList pageSize=10><#list page.list as
a>${a.uuid}<#sep>,</#list></@sys.clusterList>
<script>
$.getJSON('${site.dynamicPath}api/directive/sys/clusterList? |
class |
SysConfigDataDirective
sysConfigData 配置数据查询指令
参数列表
code:配置编码,结果返回object
SysConfigData
codes:多个配置编码,结果返回map(id,object)
使用示例
<@sys.configData code='site'>${object.register_url}</@sys.configData>
<script>
$.getJSON('${site.dynamicPath}api/directive/sys/configData? |
class |
SysConfigDirective
sysConfig 配置查询指令
参数列表
code:配置编码,结果返回object
ConfigInfo
使用示例
<@sys.config code='site'>${object.description}</@sys.config>
<script>
$.getJSON('${site.dynamicPath}api/directive/sys/config? |
class |
SysConfigFieldListDirective
sysConfigFieldList 配置数据字段列表查询指令
参数列表
code:配置编码
返回结果
list:List类型 查询结果实体列表
SysExtendField
使用示例
<@sys.configFieldList pageSize=10><#list list as
a>${a.name}<#sep>,</#list></@sys.configFieldList>
<script>
$.getJSON('${site.dynamicPath}api/directive/sys/configFieldList? |
class |
SysConfigListDirective
sysConfigList 配置列表查询指令
返回结果
list:List类型 查询结果实体列表
ConfigInfo
使用示例
<@sys.configList><#list list as
a>${a.code}<#sep>,</#list></@sys.configList>
<script>
$.getJSON('${site.dynamicPath}api/directive/sys/configList? |
class |
SysDeptDirective
sysDept 部门查询指令
参数列表
id:部门id,结果返回object
SysDept
ids:
多个部门id,逗号或空格间隔,当id为空时生效,结果返回map(id,object)
使用示例
<@sys.dept id=1>${object.name}</@sys.dept>
<@sys.dept ids='1,2,3'><#list map as
k,v>${k}:${v.name}<#sep>,</#list></@sys.dept>
<script>
$.getJSON('//sys.publicsys.com/api/directive/sys/dept? |
class |
SysDeptItemDirective
sysDeptItem 数据授权查询指令
参数列表
deptId:部门id
ItemId
分类id,deptId、ItemId都存在时,结果返回true或false,表示该部门是否拥有该分类下内容的数据权限
ItemIds
多个分类id,当deptId存在,且ItemId为空时生效,结果返回map(分类id,true或false)
使用示例
<@sys.deptItem deptId=1 ItemId=1>${object}</@sys.deptItem>
<@sys.deptItem deptId=1 ItemIds=1,2,3><#list map as
k,v>${k}:${v}<#sep>,</#list></@sys.deptItem>
<script>
$.getJSON('${site.dynamicPath}api/directive/sys/deptItem? |
class |
SysDeptItemListDirective
sysDeptItemList 部门数据授权列表查询指令
参数列表
deptId:部门id
itemType:项目类型
itemId:项目id
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
SysDeptItem
使用示例
<@sys.deptCategoryList deptId=1 pageSize=10><#list page.list as
a>${a.id.deptId}<#sep>,</#list></@sys.deptCategoryList>
<script>
$.getJSON('${site.dynamicPath}api/directive/sys/deptCategoryList? |
class |
SysDeptListDirective
sysDeptList 部门列表查询指令
参数列表
parentId:父部门id
userId:负责人id
name:名称
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
SysDept
使用示例
<@sys.deptList pageSize=10><#list page.list as
a>${a.name}<#sep>,</#list></@sys.deptList>
<script>
$.getJSON('${site.dynamicPath}api/directive/sys/deptList? |
class |
SysDomainDirective
sysDomain 域名查询指令
参数列表
id:域名,结果返回object
SysDomain
ids:
多个域名,逗号或空格间隔,当id为空时生效,结果返回map(id,object)
使用示例
<@sys.domain id='www.publiccms.com'>${object.name}</@sys.domaing>
<@sys.domain ids='www.publiccms.com,www.sanluan.com'><#list map as
k,v>${k}:${v.name}<#sep>,</#list></@sys.domain>
<script>
$.getJSON('${site.dynamicPath}api/directive/sys/domain? |
class |
SysDomainListDirective
sysDomainList 域名列表查询指令
参数列表
advanced:开启高级选项, 默认为false
siteId:高级选项:站点id
wild:高级选项:通配域名,【true,false】
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
SysDomain
使用示例
<@sys.domainList deptId=1 pageSize=10><#list page.list as
a>${a.name}<#sep>,</#list></@sys.domainList>
<script>
$.getJSON('${site.dynamicPath}api/directive/sys/domainList? |
class |
SysExtendFieldListDirective
sysExtendFieldList 扩展字段列表查询指令
参数列表
extendId:扩展id
inputType:多个输入框类型【text:输入框,number:数字,textarea:多行文本,file:文件,image:图片,video:视频,password:密码,editor:百度编辑器,ckeditor:CK编辑器,tinymce:TinyMCE编辑器,date:日期,datetime:时间,color:颜色,alphaColor:带透明度的颜色,template:模板路径,boolean:是否,user:用户,dept:部门,content:内容,category:分类,dictionary:数据字典,categoryType:分类类型,tagType:标签类型,vote:投票,survey:调查问卷,tag:标签】
searchable:可搜索,【true,false】
返回结果
list:List类型 查询结果实体列表
SysExtendField
使用示例
<@sys.extendFieldList deptId=1 pageSize=10><#list list as
a>${a.name}<#sep>,</#list></@sys.extendFieldList>
<script>
$.getJSON('${site.dynamicPath}api/directive/sys/extendFieldList? |
class |
SysLockDirective
lock 锁查询指令
参数列表
itemType:项目类型
itemId:项目id,结果返回object
SysLock
itemIds
多个项目id,逗号或空格间隔,当id为空时生效,结果返回map(id,object)
使用示例
<@sys.lock id=1>${object.count}</@sys.lock>
<@sys.lock ids='1,2,3'><#list map as
k,v>${k}:${v.count}<#sep>,</#list></@sys.lock>
<script>
$.getJSON('${site.dynamicPath}api/directive/sys/lock? |
class |
SysModuleDirective
sysModule 模块查询指令
参数列表
id:模块id,结果返回object
SysModule
ids:
多个模块id,逗号或空格间隔,当id为空时生效,结果返回map(id,object)
使用示例
<@sys.module id='page'>${object.url}</@sys.module>
<@sys.module ids='page,develop'><#list map as
k,v>${k}:${v.url}<#sep>,</#list></@sys.module>
<script>
$.getJSON('//sys.publicsys.com/api/directive/sys/module? |
class |
SysModuleLangDirective
sysModuleLang 模块语言查询指令
参数列表
moduleId:模块id,结果返回object
SysModule
lang:语言【zh:中文,en:英语,ja:日语】
使用示例
<@sys.moduleLang moduleId='page' lang='zh'>${object}</@sys.moduleLang>
<script>
$.getJSON('//sys.publicsys.com/api/directive/sys/moduleLang? |
class |
SysModuleListDirective
sysModuleList 模块列表查询指令
参数列表
advanced:开启高级选项, 默认为false
menu:高级选项:是否菜单,【true,false】
parentId:父模块id
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
SysModule
使用示例
<@sys.moduleList parentId='page' pageSize=10><#list page.list as
a>${springMacroRequestContext.getMessage('menu.' |
class |
SysRecordDirective
sysRecord 自定义记录查询写入指令
参数列表
code:记录编码,结果返回object
data:记录数据,不为空时记录该数据
SysRecord
codes:多个记录编码,结果返回map(id,object)
使用示例
<@sys.record code='site' data='data'>${object.data}</@sys.record>
<script>
$.getJSON('${site.dynamicPath}api/directive/sys/record? |
class |
SysRecordListDirective
sysRecordList 自定义记录列表查询指令
参数列表
code:编码
startCreateDate:起始创建日期,【2020-01-01 23:59:59】,【2020-01-01】
endCreateDate:终止创建日期,高级选项禁用时不能超过现在,【2020-01-01
23:59:59】,【2020-01-01】
orderField:排序字段,【updateDate:更新日期】默认创建日期倒序
orderType:排序类型,【asc:正序,desc:倒序】,默认为倒序
pageIndex:页码
pageSize:每页条数
返回结果
list:List类型 查询结果实体列表
SysRecord
使用示例
<@sys.recordList><#list list as
a>${a.data}<#sep>,</#list></@sys.recordList>
<script>
$.getJSON('${site.dynamicPath}api/directive/sys/recordList? |
class |
SysRoleDirective
sysRole 角色查询指令
参数列表
id:角色id,结果返回object
SysRole
ids:
多个角色id,逗号或空格间隔,当id为空时生效,结果返回map(id,object)
使用示例
<@sys.role id=1>${object.name}</@sys.role>
<@sys.role ids='1,2,3'><#list map as
k,v>${k}:${v.name}<#sep>,</#list></@sys.role>
<script>
$.getJSON('//sys.publicsys.com/api/directive/sys/role? |
class |
SysRoleListDirective
sysRoleList 角色列表查询指令
参数列表
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
SysRole
使用示例
<@sys.roleList deptId=1 pageSize=10><#list page.list as
a>${a.name}<#sep>,</#list></@sys.roleList>
<script>
$.getJSON('${site.dynamicPath}api/directive/sys/roleList? |
class |
SysRoleModuleDirective
sysRoleModule 角色模块授权查询指令
参数列表
roleIds:多个角色id
moduleId
模块id,roleIds、moduleId都存在时,结果返回true或false,表示这些角色是否拥有该模块的数据权限
moduleIds
多个模块id,当roleIds存在,且moduleId为空时生效,结果返回map(模块id,true或false)
使用示例
<@sys.roleModule roleIds='1,2,3'
modelId='page'>${object}</@sys.roleModule>
<@sys.roleModule roleIds='1,2,3' modelIds='page,content'><#list map
as k,v>${k}:${v}<#sep>,</#list></@sys.roleModule>
<script>
$.getJSON('${site.dynamicPath}api/directive/sys/roleModule? |
class |
SysRoleModuleListDirective
sysRoleModuleList 角色模块映射列表查询指令
参数列表
roleId:角色id
moduleId:模块id
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
SysRoleModule
使用示例
<@sys.roleModuleList roleId=1 pageSize=10><#list page.list as
a>${a.id.roleId}<#sep>,</#list></@sys.roleModuleList>
<script>
$.getJSON('${site.dynamicPath}api/directive/sys/sysDeptCategoryList? |
class |
SysRoleUserListDirective
sysRoleUserList 角色用户列表查询指令
参数列表
roleId:角色id
userId:用户id
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
SysRoleUser
使用示例
<@sys.roleUserList roleId=1 pageSize=10><#list page.list as
a>${a.id.roleId}<#sep>,</#list></@sys.roleUserList>
<script>
$.getJSON('${site.dynamicPath}api/directive/sys/roleUserList? |
class |
SysSiteDirective
sysSite 站点查询指令
参数列表
id:站点id,结果返回object
SysSite
ids:
多个站点id,逗号或空格间隔,当id为空时生效,结果返回map(id,object)
使用示例
<@sys.site id=1>${object.name}</@sys.site>
<@sys.site ids='1,2,3'><#list map as
k,v>${k}:${v.name}<#sep>,</#list></@sys.site>
<script>
$.getJSON('//sys.publicsys.com/api/directive/sys/site? |
class |
SysSiteListDirective
sysSiteList 站点列表查询指令
参数列表
advanced:开启高级选项, 默认为false
disabled:高级选项:已禁用,【true,false】
parentId:父站点id
name:名称
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
SysSite
使用示例
<@sys.siteList pageSize=10><#list page.list as
a>${a.name}<#sep>,</#list></@sys.siteList>
<script>
$.getJSON('${site.dynamicPath}api/directive/sys/siteList? |
class |
SysTaskDirective
sysTask 任务计划查询指令
参数列表
id:任务计划id,结果返回object
SysTask
ids:
多个任务计划id,逗号或空格间隔,当id为空时生效,结果返回map(id,object)
使用示例
<@sys.task id=1>${object.name}</@sys.task>
<@sys.task ids='1,2,3'><#list map as
k,v>${k}:${v.name}<#sep>,</#list></@sys.task>
<script>
$.getJSON('//sys.publicsys.com/api/directive/sys/task? |
class |
SysTaskListDirective
sysTaskList 任务计划列表查询指令
参数列表
status:状态【0:就绪,1:执行中,2:暂停,3:错误】
startUpdateDate:起始更新日期,【2020-01-01 23:59:59】,【2020-01-01】
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
SysTask
使用示例
<@sys.taskList deptId=1 pageSize=10><#list page.list as
a>${a.id.deptId}<#sep>,</#list></@sys.taskList>
<script>
$.getJSON('${site.dynamicPath}api/directive/sys/taskList? |
class |
SysUserDirective
sysUser 用户查询指令
参数列表
id:用户id,结果返回object
SysUser
ids:
多个用户id,逗号或空格间隔,当id为空时生效,结果返回map(id,object)
absoluteURL:cover处理为绝对路径 默认为 true
使用示例
<@sys.user id=1>${object.name}</@sys.user>
<@sys.user ids='1,2,3'><#list map as
k,v>${k}:${v.name}<#sep>,</#list></@sys.user>
<script>
$.getJSON('//sys.publicsys.com/api/directive/sys/user? |
class |
SysUserListDirective
sysUserList 用户列表查询指令
参数列表
advanced:开启高级选项, 默认为false
disabled:高级选项:已禁用,【true,false】, 默认为false
deptId:部门id
startRegisteredDate:起始注册日期,【2020-01-01
23:59:59】,【2020-01-01】
endRegisteredDate:终止注册日期,【2020-01-01 23:59:59】,【2020-01-01】
startLastLoginDate:起始上次登录日期,【2020-01-01
23:59:59】,【2020-01-01】
endLastLoginDate:终止上次登录日期,【2020-01-01 23:59:59】,【2020-01-01】
superuser:管理员,【true,false】
emailChecked:邮箱已验证,【true,false】
name:昵称、用户名、邮箱
orderField
排序字段,【lastLoginDate:上次登录日期,loginCount:登录次数,registeredDate:注册日期,followers:粉丝数】,默认创建日期按orderType排序
orderType:排序类型,【asc:正序,desc:倒序】,默认为倒序
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
SysUser
使用示例
<@sys.userList deptId=1 pageSize=10><#list page.list as
a>${a.nickname}<#sep>,</#list></@sys.userList>
<script>
$.getJSON('${site.dynamicPath}api/directive/sys/userList? |
class |
SysUserTokenListDirective
sysUserTokenList 用户登录授权列表查询指令
参数列表
userId:用户id
channel:渠道
orderField:排序字段,【expiryDate:过期日期,createDate:创建日期,】,默认创建日期按orderType排序
orderType:排序类型,【asc:正序,desc:倒序】,默认为倒序
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
SysUserToken
使用示例
<@sys.userTokenList userId=1 pageSize=10><#list page.list as
a>${a.id.deptId}<#sep>,</#list></@sys.userTokenList>
<script>
$.getJSON('${site.dynamicPath}api/directive/sys/userTokenList? |
| 限定符和类型 | 类和说明 |
|---|---|
class |
CreateCategoryFileDirective
createCategoryFile 创建分类静态文件指令
参数列表
id:分类id
templatePath:模板路径
filePath:静态文件路径
pageIndex:当前页码,默认为1
totalPage:最大页码,为空时则只生成当前页
返回结果
url:静态文件路径
使用示例
<@tools.createCategoryFile id=1 templatePath='category.html' filePath='category/'+1+'.html'>${url}</@tools.createCategoryFile>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/createCategoryFile? |
class |
CreateContentFileDirective
createContentFile 创建内容静态文件指令
参数列表
id:内容id
templatePath:模板路径
filePath:静态文件路径
pageIndex:当前页码,默认为1
返回结果
url:静态文件路径
使用示例
<@tools.createContentFile id=1 templatePath='content.html'
filePath='content/'+1+'.html'>${url}</@tools.createContentFile>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/createContentFile? |
class |
CreateLockDirective
createLock 创建锁指令
参数列表
itemType:锁定项目类型
itemId:锁定项目id
userId:锁定用户id
counter:计数,默认值0:
返回结果
object:SysLock
使用示例
<@tools.createLock itemType='content' itemId='1'
userId='1'>${url}</@tools.createLock>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/createLock? |
class |
CreateTemplateFileDirective
createTemplateFile 创建静态文件指令
参数列表
templatePath:模板路径
filePath:静态文件路径
pageIndex:当前页码,默认为1
parameters:参数map
返回结果
url:静态文件路径
使用示例
<@tools.createTemplateFile templatePath='template.html'
filePath='page/'+1+'.html'
parameters={"parameter1","value1"}>${url}</@tools.createTemplateFile>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/createTemplateFile? |
class |
CsrfTokenDirective
csrfToken 防跨站请求伪造token指令
参数列表
admin:是否后台,默认值false:
返回结果
打印token值
使用示例
<input type="hidden" name="_csrf" value="<@tools.csrfToken/>"/>
|
class |
DiskDirective
disk 磁盘空间与路径指令
返回结果
freeSpace:空白空间
totalSpace:总空间
usableSpace:可用空间
rootPath:绝对路径
使用示例
<@tools.disk>${freeSpace}</@tools.disk>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/disk? |
class |
DiyMetadataDirective
diyMetadata diy元数据获取指令
参数列表
itemType:元数据类型,【region,layout,module】
itemId:元数据id
返回结果
object:diy元数据region:CmsRegion,layout:CmsLayout,module:CmsModule
使用示例
<@tools.diyMetadata itemType='region' itemId='00000000-0000-0000-0000-000000000000'>${object.name}</@tools.diyMetadata>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/diyMetadata? |
class |
DiyMetadataListDirective
diyMetadataList diy元数据列表获取指令
参数列表
itemType:元数据类型,【region,layout,module】
region:区域id,当itemType为layout或module时有效
showGlobal:元数据类型,【true,false】,当itemType为layout或module时有效,默认为true:
返回结果
list:
diy元数据列表region:CmsRegion,layout:CmsLayout,module:CmsModule
使用示例
<@tools.diyMetadataList itemType='region'><#list page.list as
a>${a.name}<#sep>,</#list></@tools.diyMetadataList>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/diyMetadataList? |
class |
DiyRegionDataDirective
regionData diy区域数据获取指令
参数列表
id:区域id
categoryId:分类id
返回结果
object:CmsRegionData
使用示例
<@tools.diyMetadata
id='00000000-0000-0000-0000-000000000000'>${object.id}</@tools.diyMetadata>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/regionData? |
class |
ExceptionDirective
exception 异常获取指令
返回结果
object:异常字符串
使用示例
<@tools.exception>${object}</@tools.exception> |
class |
ExecuteScriptDirective
executeScript 脚本执行指令
参数列表
command:命令【sync.bat,sync.sh,backupdb.bat,backupdb.sh】
parameters:参数数组
打印执行结果
使用示例
<@tools.executeScript command='backupdb.bat'/>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/executeScript? |
class |
FileBackupContentDirective
fileBackupContent 备份文件内容获取指令
参数列表
type:文件类型【file,task,template】,默认template
path:文件路径
返回结果
object:文件内容文本
使用示例
<@tools.fileBackupContent type='file'
path='index.html'>${object}</@tools.fileBackupContent>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/fileBackupContent? |
class |
FileBackupListDirective
fileBackupList 文件回收站列表获取指令
参数列表
type:文件类型【file,task,template】,默认template
path:文件路径
orderField:
排序类型【fileName,fileSize,modifiedDate,createDate】,默认fileName
返回结果
list:文件列表
CmsFileUtils.FileInfo
使用示例
<@tools.fileBackupList path='/'><#list list as
a>${a.fileName}<#sep>,</#list></@tools.fileBackupList>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/fileBackupList? |
class |
FileContentDirective
fileContent 文件内容获取指令
参数列表
type:文件类型【file,task,template】,默认template
path:文件路径
返回结果
object:文件内容文本
使用示例
<@tools.fileContent
path='index.html'>${object}</@tools.fileContent>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/fileContent? |
class |
FileExistDirective
fileExists 文件是否存在指令
参数列表
type:文件类型【file,task,template】,默认template
path:文件路径
返回结果
object:boolean类型文件是否存在
使用示例
<@tools.fileExists type='file' path='/'><#list list as
a>${a}<#sep>,</#list></@tools.fileExists>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/fileExists? |
class |
FileHistoryContentDirective
fileHistoryContent 文件修改历史内容获取指令
参数列表
type:文件类型【file,task,template】,默认template
path:文件路径
返回结果
object:文件内容文本
使用示例
<@tools.fileHistoryContent type='file'
path='index.html/2020-01-01_01-01-000000'>${object}</@tools.fileHistoryContent>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/fileHistoryContent? |
class |
FileHistoryListDirective
fileHistoryList 文件修改历史列表获取指令
参数列表
type:文件类型【file,task,template】,默认template
path:文件路径
orderField:
排序类型【fileName,fileSize,modifiedDate,createDate】,默认fileName
返回结果
list:文件列表
CmsFileUtils.FileInfo
使用示例
<@tools.fileHistoryList path='/'><#list list as
a>${a.fileName}<#sep>,</#list></@tools.fileHistoryList>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/fileHistoryList? |
class |
FileListDirective
fileList 文件列表获取指令
参数列表
type:文件类型【file,task,template】,默认template
path:文件路径
orderField:
排序类型【fileName,fileSize,modifiedDate,createDate】,默认fileName
返回结果
list:文件列表
CmsFileUtils.FileInfo
使用示例
<@tools.fileList path='/'><#list list as
a>${a.fileName}<#sep>,</#list></@tools.fileList>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/fileList? |
class |
IncludeLayoutDirective
includeLayout 包含diy布局指令
参数列表
id:布局id
打印包含结果
使用示例
<@tools.includeLayout
id='00000000-0000-0000-0000-000000000000'>${index},</@tools.includeLayout> |
class |
IncludePlaceDirective
includePlace 包含页面片段指令
参数列表
path:路径
打印包含结果
使用示例
<@tools.includePlace path='00000000-0000-0000-0000-000000000000'/>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/includePlace? |
class |
IncludeRegionDirective
includeRegion 包含diy区域指令
参数列表
id:布局id
打印包含结果
使用示例
<@tools.includeRegion id='00000000-0000-0000-0000-000000000000'
categoryId=1/> |
class |
LicenseVerifyDirective
licenseVerify 授权文件验证指令
参数列表
licenseData:授权文件数据
返回结果
result:验证结果,【true:验证成功,false:验证失败】
使用示例
<@tools.licenseVerify licenseData='content'>${url}</@tools.licenseVerify>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/licenseVerify? |
class |
MasterSiteDirective
masterSite 管理站点判断指令
使用示例
<@tools.masterSite>this is a master site</@tools.masterSite>
|
class |
MemoryDirective
memory 内存监控指令
返回结果
freeMemory:空闲内存
totalMemory:总内存
maxMemory:最大内存
使用示例
<@tools.memory>${totalMemory}</@tools.memory>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/memory? |
class |
MetadataDirective
metadata 模板元数据获取指令
参数列表
path:模板路径
返回结果
object:
元数据CmsPageMetadata
使用示例
<@tools.metadata
path='index.html'>${object.alias}</@tools.metadata>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/metadata? |
class |
PlaceMetadataDirective
placeMetadata 页面片段元数据获取指令
参数列表
path:模板路径
返回结果
object:
元数据CmsPlaceMetadata
使用示例
<@tools.placeMetadata
path='00000000-0000-0000-0000-000000000000'>${object.alias}</@tools.placeMetadata>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/placeMetadata? |
class |
SendEmailDirective
sendEmail 发送邮件指令
参数列表
email:多个邮件地址
cc:多个抄送地址
bcc:多个密送地址
title:标题
templatePath:内容模板路径
content:邮件内容,templatePath为空时有效
fileNames:多个附件名称
filePaths:多个文件路径
parameters:参数map
返回结果
result:是否允许发送,【true,false】
使用示例
<@tools.sendEmail email='master@puliccms.com' title='title'
content='content' parameters={"parameter1":"value1"}/>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/sendEmail? |
class |
SystemPropertiesDirective
systemProperties 服务器参数指令
返回结果
java.version:Java version number
java.vendor:Java vendor specific string
java.vendor.url:Java vendor URL
java.home:Java installation directory
java.class.version:Java class version number
java.class.path:Java classpath
os.name:Operating System Name
os.arch:Operating System Architecture
os.version:Operating System Version
file.separator:File separator (SEPARATOR on Unix)
path.separator:Path separator (":" on Unix)
line.separator:Line separator ("\n" on Unix)
user.name:User account name
user.home:User home directory
user.dir:User's current working directory
使用示例
<@tools.systemProperties>${.vars['java.version']}</@tools.systemProperties>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/systemProperties? |
class |
TemplatePlaceListDirective
templatePlaceList 模板文件页面片段列表获取指令
参数列表
path:文件路径
返回结果
list:文件路径列表
使用示例
<@tools.templatePlaceList path='index.html'><#list list as
a>${a}<#sep>,</#list></@tools.templatePlaceList>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/templatePlaceList? |
class |
TemplateRegionListDirective
templateRegionList 模板文件页面可视化区域列表指令
参数列表
path:文件路径
返回结果
list:可视化区域id列表
使用示例
<@tools.templateRegionList path='index.html'><#list list as
a>${a}<#sep>,</#list></@tools.templateRegionList>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/templateRegionList? |
class |
TemplateResultDirective
templateResult 模板渲染结果指令
参数列表
parameters:参数map
templateContent:模板内容
打印渲染结果
使用示例
<@tools.templateResult templateContent='${name}' parameters={'name':'value'}/>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/templateResult? |
class |
TemplateSearchListDirective
templateSearchList 模板文件搜索列表指令
参数列表
path:文件路径
word:搜索词
返回结果
list:文件列表
CmsFileUtils.FileSearchResult
使用示例
<@tools.templateSearchList path='/' word='script'><#list list as
a>${a.path}<#sep>,</#list></@tools.templateSearchList>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/templateSearchList? |
class |
ThumbDirective
thumb 缩略图指令
参数列表
path:文件路径
width:宽度
height:高度
打印结果文件路径
使用示例
<@tools.thumb path='images/logo.jpg' width=100 height=100/>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/thumb? |
class |
UserAgentDirective
userAgent user agent分析指令
参数列表
userAgent:user agent,为空时取当前请求的user agent
返回结果
object.id:id
object.ip:客户端ip
object.browser:浏览器
object.browserGroup:浏览器分组
object.browserType:浏览器类型
object.browserVersion:浏览器版本
object.operatingSystem:操作系统
object.operatingSystemGroup:操作系统分组
object.deviceType:设备类型
object.userAgent:user agent
使用示例
<@tools.userAgent>${a.deviceType}</@tools.userAgent>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/userAgent', function(data){
console.log(data.deviceType);
});
</script>
|
class |
VersionDirective
version 版本指令
返回结果
cms:cms版本
revision:修订版
authorizationEdition:使用授权
authorizationStartDate:授权起始日期
authorizationEndDate:授权结束日期
authorizationOrganization:授权单位
cluster:节点id
master:是否管理节点【true:管理节点,false:普通节点】
使用示例
<@tools.version path='/'>${a.fileName}</@tools.version>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/version', function(data){
console.log(data.cms);
});
</script>
|
| 限定符和类型 | 类和说明 |
|---|---|
class |
TradeAccountDirective
tradeAccount 账户查询指令
参数列表
id 账户id，结果返回object
TradeAccount
ids
多个账户id，逗号或空格间隔，当id为空时生效，结果返回map(id,object)
使用示例
<@trade.account id=1>${object.amount}</@trade.account>
<@trade.account ids=1,2,3><#list map as
k,v>${k}:${v.amount}<#sep>,</#list></@trade.account>
<script>
$.getJSON('${site.dynamicPath}api/directive/trade/account? |
class |
TradeAccountHistoryDirective
tradeAccountHistory 账户历史查询指令
参数列表
id 账户历史id，结果返回object
TradeAccountHistory
ids 多个账户历史id，逗号或空格间隔，当id为空时生效，结果返回map(id,object)
使用示例
<@trade.accountHistory id=1>${object.balance}</@trade.accountHistory>
<@trade.accountHistory ids=1,2,3><#list map as
k,v>${k}:${v.balance}<#sep>,</#list></@trade.accountHistory>
<script>
$.getJSON('${site.dynamicPath}api/directive/trade/accountHistory? |
class |
TradeAccountHistoryListDirective
tradeAccountHistoryList 账户历史列表查询指令
参数列表
accountId 账户id
userId 操作用户id
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】
orderType 排序类型,【asc:正序,desc:倒叙】,默认为创建日期倒叙
pageIndex 页码
pageSize 每页条数
返回结果
page PageHandler
page.list List类型 查询结果实体列表
TradeAccountHistory
使用示例
<@trade.accountHistoryList pageSize=10><#list page.list as
a>${a.amountChange}<#sep>,</#list></@trade.accountHistoryList>
<script>
$.getJSON('${site.dynamicPath}api/directive/trade/accountHistoryList? |
class |
TradeAccountListDirective
tradeAccountList 账户列表查询指令
参数列表
orderField
排序字段,【amount:金额,updateDate:更新日期】,默认置顶id按orderType排序
orderType 排序类型,【asc:正序,desc:倒叙】,默认为倒叙
pageIndex 页码
pageSize 每页条数
返回结果
page PageHandler
page.list List类型 查询结果实体列表
TradeAccount
使用示例
<@trade.accountList pageSize=10><#list page.list as
a>${a.amount}<#sep>,</#list></@trade.accountList>
<script>
$.getJSON('${site.dynamicPath}api/directive/trade/accountList? |
class |
TradeAddressDirective
TradeAddressDirective
|
class |
TradeAddressListDirective
TradeAddressListDirective
|
class |
TradeOrderDirective
tradeOrder 订单查询指令
参数列表
id 订单id，结果返回object
TradeOrder
ids 多个订单id，逗号或空格间隔，当id为空时生效，结果返回map(id,object)
使用示例
<@trade.order id=1>${object.title}</@trade.order>
<@trade.order ids=1,2,3><#list map as
k,v>${k}:${v.title}<#sep>,</#list></@trade.order>
<script>
$.getJSON('${site.dynamicPath}api/directive/trade/order? |
class |
TradeOrderHistoryDirective
tradeOrderHistory 订单历史查询指令
参数列表
id 订单历史id，结果返回object
TradeOrderHistory
ids 多个订单历史id，逗号或空格间隔，当id为空时生效，结果返回map(id,object)
使用示例
<@trade.orderHistory id=1>${object.amount}</@trade.orderHistory>
<@trade.orderHistory ids=1,2,3><#list map as
k,v>${k}:${v.amount}<#sep>,</#list></@trade.orderHistory>
<script>
$.getJSON('${site.dynamicPath}api/directive/trade/orderHistory? |
class |
TradeOrderHistoryListDirective
tradeOrderHistoryList 订单历史列表查询指令
参数列表
orderId 订单id
startCreateDate 起始创建日期,【2020-01-01 23:59:59】,【2020-01-01】
endCreateDate 终止创建日期,【2020-01-01 23:59:59】,【2020-01-01】
orderType 排序类型,【asc:正序,desc:倒叙】,默认为创建日期倒叙
pageIndex 页码
pageSize 每页条数
返回结果
page PageHandler
page.list List类型 查询结果实体列表
TradeOrderHistory
使用示例
<@trade.orderHistoryList orderId=1 pageSize=10><#list page.list as
a>${a.content}<#sep>,</#list></@trade.orderHistoryList>
<script>
$.getJSON('${site.dynamicPath}api/directive/trade/orderHistoryList? |
class |
TradeOrderListDirective
tradeOrderList 订单列表查询指令
参数列表
userId 用户id
paymentId 付款id
status 状态,【0:待处理,1:无效订单,2:已支付,3:已退款,4:已关闭】
processed 已处理,【true,false】
startCreateDate 起始创建日期,【2020-01-01 23:59:59】,【2020-01-01】
endCreateDate 终止创建日期,【2020-01-01 23:59:59】,【2020-01-01】
orderType 排序类型,【asc:正序,desc:倒叙】,默认为发布日期倒叙
pageIndex 页码
pageSize 每页条数
返回结果
page PageHandler
page.list List类型 查询结果实体列表
TradeOrder
使用示例
<@trade.orderList pageSize=10><#list page.list as
a>${a.amount}<#sep>,</#list></@trade.orderList>
<script>
$.getJSON('${site.dynamicPath}api/directive/trade/orderList? |
class |
TradeOrderProductDirective
tradeOrderProduct 订单产品查询指令
参数列表
id 订单产品id，结果返回object
TradeOrderProduct
ids 多个订单产品id，逗号或空格间隔，当id为空时生效，结果返回map(id,object)
使用示例
<@trade.orderProduct id=1>${object.quantity}</@trade.orderProduct>
<@trade.orderProduct ids=1,2,3><#list map as
k,v>${k}:${v.quantity}<#sep>,</#list></@trade.orderProduct>
<script>
$.getJSON('${site.dynamicPath}api/directive/trade/orderProduct? |
class |
TradeOrderProductListDirective
tradeOrderProductList 订单产品列表查询指令
参数列表
orderId 订单id
pageIndex 页码
pageSize 每页条数
返回结果
page PageHandler
page.list List类型 查询结果实体列表
TradeOrderProduct
使用示例
<@trade.orderProductList orderId=1 pageSize=10><#list page.list as
a>${a.productId}<#sep>,</#list></@trade.orderProductList>
<script>
$.getJSON('${site.dynamicPath}api/directive/trade/orderProductList? |
class |
TradePaymentDirective
tradePayment 支付订单查询指令
参数列表
id 支付订单id，结果返回object
TradePayment
ids 多个支付订单id，逗号或空格间隔，当id为空时生效，结果返回map(id,object)
使用示例
<@trade.payment id=1>${object.amount}</@trade.payment>
<@trade.payment ids=1,2,3><#list map as
k,v>${k}:${v.amount}<#sep>,</#list></@trade.payment>
<script>
$.getJSON('${site.dynamicPath}api/directive/trade/payment? |
class |
TradePaymentHistoryDirective
tradePaymentHistory 支付订单历史查询指令
参数列表
id 支付订单历史id，结果返回object
TradePaymentHistory
ids
多个支付订单历史id，逗号或空格间隔，当id为空时生效，结果返回map(id,object)
使用示例
<@trade.paymentHistory
id=1>${object.content}</@trade.paymentHistory>
<@trade.paymentHistory ids=1,2,3><#list map as
k,v>${k}:${v.content}<#sep>,</#list></@trade.paymentHistory>
<script>
$.getJSON('${site.dynamicPath}api/directive/trade/paymentHistory? |
class |
TradePaymentHistoryListDirective
tradePaymentHistoryList 账户列表查询指令
参数列表
paymentId 付款id
startCreateDate 起始创建日期,【2020-01-01 23:59:59】,【2020-01-01】
endCreateDate 终止创建日期,【2020-01-01 23:59:59】,【2020-01-01】
orderType 排序类型,【asc:正序,desc:倒叙】,默认为创建日期倒叙
pageIndex 页码
pageSize 每页条数
返回结果
page PageHandler
page.list List类型 查询结果实体列表
TradePaymentHistory
使用示例
<@trade.paymentHistory paymentId=1 pageSize=10><#list page.list as
a>${a.content}<#sep>,</#list></@trade.paymentHistory>
<script>
$.getJSON('${site.dynamicPath}api/directive/trade/paymentHistory? |
class |
TradePaymentListDirective
tradePaymentList 支付列表查询指令
参数列表
userId 用户id
tradeType 支付类型,【recharge:充值,product:产品】
serialNumber 流水号
accountType 账户类型,【account:账户,alipay:支付宝,wechat:微信】
accountSerialNumber 账号流水号
status 状态,【0:待支付,1:已支付,2:待退款,3:已退款,4:已关闭】
startCreateDate 起始创建日期,【2020-01-01 23:59:59】,【2020-01-01】
endCreateDate 终止创建日期,【2020-01-01 23:59:59】,【2020-01-01】
orderType 排序类型,【asc:正序,desc:倒叙】,默认为发布日期倒叙
pageIndex 页码
pageSize 每页条数
返回结果
page PageHandler
page.list List类型 查询结果实体列表
TradePayment
使用示例
<@trade.paymentList pageSize=10><#list page.list as
a>${a.amount}<#sep>,</#list></@trade.paymentList>
<script>
$.getJSON('${site.dynamicPath}api/directive/trade/paymentList? |
class |
TradeRefundDirective
tradeRefund 退款查询指令
参数列表
id 退款id，结果返回object
TradeRefund
ids 多个退款id，逗号或空格间隔，当id为空时生效，结果返回map(id,object)
使用示例
<@trade.refund id=1>${object.amount}</@trade.refund>
<@trade.refund ids=1,2,3><#list map as
k,v>${k}:${v.amount}<#sep>,</#list></@trade.refund>
<script>
$.getJSON('${site.dynamicPath}api/directive/trade/refund? |
class |
TradeRefundListDirective
tradeRefundList 退款列表查询指令
参数列表
userId 用户id
paymentId 支付id
refundUserId 退款操作用户id
status 状态,【0:待处理,1:已退款,2:取消,3:拒绝,4:失败】
startCreateDate 起始创建日期,【2020-01-01 23:59:59】,【2020-01-01】
endCreateDate 终止创建日期,【2020-01-01 23:59:59】,【2020-01-01】
orderType 排序类型,【asc:正序,desc:倒叙】,默认为创建日期倒叙
pageIndex 页码
pageSize 每页条数
返回结果
page PageHandler
page.list List类型 查询结果实体列表
TradeRefund
使用示例
<@trade.refundList pageSize=10><#list page.list as
a>${a.amount}<#sep>,</#list></@trade.refundList>
<script>
$.getJSON('${site.dynamicPath}api/directive/trade/refundList? |
| 限定符和类型 | 类和说明 |
|---|---|
class |
VisitDayDirective
visitDay 访问日报表查询指令
参数列表
visitDate:访问日期,【2020-01-01】
visitHour:访问小时,【-1-23】,-1表示整天数据,两个参数都不为空时,结果返回object
VisitDay
使用示例
<@visit.day visitDate='2020-01-01'
visitHour=9>${object.pv}</@visit.day>
<script>
$.getJSON('${site.dynamicPath}api/directive/visit/day? |
class |
VisitDayListDirective
visitDayList 访问日报表列表查询指令
参数列表
startVisitDate:起始访问日期,【2020-01-01 23:59:59】,【2020-01-01】
endVisitDate:终止访问日期,【2020-01-01 23:59:59】,【2020-01-01】
hourAnalytics:小时统计,【true,false】,默认false
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
VisitDay
使用示例
<@visit.dayList hourAnalytics=false><#list page.list as
a>${a.pv}<#sep>,</#list></@visit.dayList>
<script>
$.getJSON('${site.dynamicPath}api/directive/visit/dayList? |
class |
VisitHistoryDirective
visitHistory 访问记录查询指令
参数列表
id:记录id,结果返回object
VisitHistory
ids:
多个记录id,逗号或空格间隔,当id为空时生效,结果返回map(id,object)
使用示例
<@visit.history id=1>${object.title}</@visit.history>
<@visit.history ids='1,2,3'><#list map as
k,v>${k}:${v.title}<#sep>,</#list></@visit.history>
<script>
$.getJSON('${site.dynamicPath}api/directive/visit/history? |
class |
VisitHistoryListDirective
visitHistoryList 访问记录列表查询指令
参数列表
sessionId:会话id
ip:ip
url:url
startCreateDate:起始创建日期,【2020-01-01 23:59:59】,【2020-01-01】
endCreateDate:终止创建日期,【2020-01-01 23:59:59】,【2020-01-01】
orderType:排序类型,【asc:正序,desc:倒序】,默认为创建日期倒序
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
VisitHistory
使用示例
<@visit.historyList hourAnalytics=false><#list page.list as
a>${a.url}<#sep>,</#list></@visit.historyList>
<script>
$.getJSON('${site.dynamicPath}api/directive/visit/historyList? |
class |
VisitItemDirective
visitItem 访问项目报表查询指令
参数列表
visitDate:访问日期,【2020-01-01】
itemType:访问项目类型,【category,content,user等页面统计时中的itemType】
itemId:访问项目id,三个参数都不为空时,结果返回object
VisitItem
使用示例
<@visit.item visitDate='2020-01-01' visitHour=9>${object.pv}</@visit.item>
<script>
$.getJSON('${site.dynamicPath}api/directive/visit/item? |
class |
VisitItemListDirective
visitItemList 访问项目列表查询指令
参数列表
startVisitDate:起始访问日期,【2020-01-01 23:59:59】,【2020-01-01】
endVisitDate:终止访问日期,【2020-01-01 23:59:59】,【2020-01-01】
itemType:项目类型,【category,content,user等页面统计时中的itemType】
itemId:项目id
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
VisitItem
使用示例
<@visit.itemList itemType='content'><#list page.list as
a>${a.pv}<#sep>,</#list></@visit.itemList>
<script>
$.getJSON('${site.dynamicPath}api/directive/visit/itemList? |
class |
VisitSessionDirective
visitSession 访问会话报表查询指令
参数列表
visitDate:访问日期,【2020-01-01】
sessionId:会话id,两个参数都不为空时,结果返回object
VisitSession
使用示例
<@visit.session visitDate='2020-01-01' sessionId='xxxx-xxxx-xxxx'>${object.pv}</@visit.session>
<script>
$.getJSON('${site.dynamicPath}api/directive/visit/session? |
class |
VisitSessionListDirective
visitSessionList 访问会话报表列表查询指令
参数列表
sessionId:会话id
ip:ip
startVisitDate:起始访问日期,【2020-01-01 23:59:59】,【2020-01-01】
endVisitDate:终止访问日期,【2020-01-01 23:59:59】,【2020-01-01】
orderType:排序类型,【asc:正序,desc:倒序】,默认为创建日期倒序
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
VisitSession
使用示例
<@visit.sessionList><#list page.list as
a>${a.pv}<#sep>,</#list></@visit.sessionList>
<script>
$.getJSON('${site.dynamicPath}api/directive/visit/sessionList? |
class |
VisitUrlDirective
visitUrl 访问网址报表查询指令
参数列表
visitDate:访问日期,【2020-01-01】
urlMd5:访问网址md5
urlSha:访问网址sha,三个参数都不为空时,结果返回object
VisitUrl
使用示例
<@visit.url visitDate='2020-01-01' urlMd5='md5' urlSha='sha'>${object.pv}</@visit.url>
<script>
$.getJSON('${site.dynamicPath}api/directive/visit/url? |
class |
VisitUrlListDirective
visitUrlList 访问网址报表列表查询指令
参数列表
url:url
startVisitDate:起始访问日期,【2020-01-01 23:59:59】,【2020-01-01】
endVisitDate:终止访问日期,【2020-01-01 23:59:59】,【2020-01-01】
pageIndex:页码
pageSize:每页条数
返回结果
page:PageHandler
page.list:List类型 查询结果实体列表
VisitUrl
使用示例
<@visit.urlList><#list page.list as
a>${a.pv}<#sep>,</#list></@visit.urlList>
<script>
$.getJSON('${site.dynamicPath}api/directive/visit/urlList? |