| 类 | 说明 |
|---|---|
| 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? |
| 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? |
| CreateLockDirective |
createLock 创建锁指令
参数列表
itemType:锁定项目类型
itemId:锁定项目id
userId:锁定用户id
counter:使用计数器,默认值false:
返回结果
object:SysLock
使用示例
<@tools.createLock itemType='content' itemId='1'
userId='1'>${url}</@tools.createLock>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/createLock? |
| 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? |
| CsrfTokenDirective |
csrfToken 防跨站请求伪造token指令
参数列表
admin:是否后台,默认值false:
返回结果
打印token值
使用示例
<input type="hidden" name="_csrf" value="<@tools.csrfToken/>"/>
|
| DiskDirective |
disk 磁盘空间与路径指令
返回结果
freeSpace:空白空间
totalSpace:总空间
usableSpace:可用空间
rootPath:绝对路径
使用示例
<@tools.disk>${freeSpace}</@tools.disk>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/disk? |
| 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? |
| 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? |
| 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? |
| ExceptionDirective |
exception 异常获取指令
返回结果
object:异常字符串
使用示例
<@tools.exception>${object}</@tools.exception> |
| 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? |
| 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? |
| 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? |
| 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? |
| 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? |
| 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? |
| 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? |
| 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? |
| IncludeLayoutDirective |
includeLayout 包含diy布局指令
参数列表
id:布局id
打印包含结果
使用示例
<@tools.includeLayout
id='00000000-0000-0000-0000-000000000000'>${index},</@tools.includeLayout> |
| IncludePlaceDirective |
includePlace 包含页面片段指令
参数列表
path:路径
打印包含结果
使用示例
<@tools.includePlace path='00000000-0000-0000-0000-000000000000'/>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/includePlace? |
| IncludeRegionDirective |
includeRegion 包含diy区域指令
参数列表
id:布局id
打印包含结果
使用示例
<@tools.includeRegion id='00000000-0000-0000-0000-000000000000'
categoryId=1/> |
| LicenseVerifyDirective |
licenseVerify 授权文件验证指令
参数列表
licenseData:授权文件数据
返回结果
result:验证结果,【true:验证成功,false:验证失败】
使用示例
<@tools.licenseVerify licenseData='content'>${url}</@tools.licenseVerify>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/licenseVerify? |
| MasterSiteDirective |
masterSite 管理站点判断指令
使用示例
<@tools.masterSite>this is a master site</@tools.masterSite>
|
| MemoryDirective |
memory 内存监控指令
返回结果
freeMemory:空闲内存
totalMemory:总内存
maxMemory:最大内存
使用示例
<@tools.memory>${totalMemory}</@tools.memory>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/memory? |
| MetadataDirective |
metadata 模板元数据获取指令
参数列表
path:模板路径
返回结果
object:
元数据CmsPageMetadata
使用示例
<@tools.metadata
path='index.html'>${object.alias}</@tools.metadata>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/metadata? |
| 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? |
| 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/placeMetadata? |
| 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.placeMetadata>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/systemProperties? |
| 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? |
| 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? |
| TemplateResultDirective |
templateResult 模板渲染结果指令
参数列表
parameters:参数map
templateContent:模板内容
打印渲染结果
使用示例
<@tools.templateResult templateContent='${name}' parameters={'name':'value'}/>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/templateResult? |
| 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? |
| ThumbDirective |
thumb 缩略图指令
参数列表
path:文件路径
width:宽度
height:高度
打印结果文件路径
使用示例
<@tools.thumb path='images/logo.jpg' width=100 height=100/>
<script>
$.getJSON('${site.dynamicPath}api/directive/tools/thumb? |
| 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>
|
| 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>
|
工具指令