程序包 | 说明 |
---|---|
com.publiccms.controller.api |
Interface controller
接口控制器
|
com.publiccms.logic.component.site |
Site component
站点组件
|
com.publiccms.views.method.cms |
Cms method
CMS函数
函数是一种FreeMarker轻量级扩展,也同样支持模板定义和java类实现。
|
com.publiccms.views.method.tools |
Tools method
工具函数
|
限定符和类型 | 字段和说明 |
---|---|
private java.util.Map<java.lang.String,BaseMethod> |
MethodController.methodMap |
限定符和类型 | 字段和说明 |
---|---|
private java.util.Map<java.lang.String,BaseMethod> |
DirectiveComponent.methodMap |
限定符和类型 | 方法和说明 |
---|---|
java.util.Map<java.lang.String,BaseMethod> |
DirectiveComponent.getMethodMap() |
限定符和类型 | 方法和说明 |
---|---|
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 |
GetCategoryAttributeMethod
getCategoryAttribute 获取分类扩展数据
参数列表
分类id
返回结果
attribute :分类扩展数据(字段编码,value )
使用示例
<#assign attribute=getCategoryAttribute(1)/<
${attribute.title!} |
class |
GetCategoryAttributesMethod
getCategoryAttributes 获取多个分类扩展数据
参数列表
多个分类id
返回结果
map (id,attribute :分类扩展数据(字段编码,value ))
使用示例
<#assign attributeMap=getCategoryAttributes('1,2,3,4')/<
${attributeMap['1'].title!} |
class |
GetContentAttributeMethod
getContentAttribute 获取内容扩展数据
参数列表
内容id
返回结果
attribute :内容扩展数据(字段编码,value )
使用示例
<#assign attribute=getContentAttribute(1)/<
${(attribute.text? |
class |
GetContentAttributesMethod
getContentAttributes 获取多个内容扩展数据
参数列表
多个内容id
返回结果
map (id,attribute :内容扩展数据(字段编码,value ))
使用示例
<#assign attributeMap=getContentAttributes('1,2,3,4')/<
${attributeMap['1'].text? |
class |
GetContentPageMethod
getContentPage 获取正文分页结果
参数列表
正文
页码
返回结果
page :PageHandler
text :文章正文
使用示例
<#assign textPage=getContentPage(attribute.text,2)/<
${textPage.text? |
class |
GetPlaceAttributeMethod
getPlaceAttribute 获取推荐位数据扩展数据
参数列表
推荐位数据id
返回结果
attribute :推荐位数据扩展数据(字段编码,value )
使用示例
<#assign attribute=getContentAttribute(1)/<
${(attribute.description)!} |
class |
GetPlaceAttributesMethod
getPlaceAttributes 获取多个推荐位数据扩展数据
参数列表
多个荐位数据id
返回结果
map (id,attribute :推荐位数据扩展数据(字段编码,value ))
使用示例
<#assign attributeMap=getPlaceAttributes('1,2,3,4')/<
${attributeMap['1'].description!} |
限定符和类型 | 类和说明 |
---|---|
class |
GetAbsoluteUrlMethod
getAbsoluteUrl 获取url绝对路径
GetUrlMethod |
class |
GetDateMethod
getDate 获取特定日期
参数列表
日期类型【thisSunday:本周日,thisMonday:本周一,lastMonday:上周一,lastSunday:上周日,nextMonday:下周一,nextSunday:下周日】,默认当前时间
日期,【2020-01-01 23:59:59】,【2020-01-01】,为空则取当前日期
返回结果
date :日期
使用示例
${getDate('thisSunday','2020-01-01')}
<script>
$.getJSON('${site.dynamicPath}api/method/getDate? |
class |
GetDictEnableMethod
getDictEnable 获取词典是否启用
返回结果
boolean 词典是否启用
使用示例
${getDictEnable()}
<script>
$.getJSON('${site.dynamicPath}api/method/getDictEnable', function(data){
console.log(data);
});
</script>
|
class |
GetDictMethod
getDict 获取分词词典
返回结果
string 自定义分词词典
使用示例
${getDict()}
<script>
$.getJSON('${site.dynamicPath}api/method/getDict? |
class |
GetFileUploadPrefixMethod
getFileUploadPrefix 获取
参数列表
返回结果
url :文件上传前缀
使用示例
${getFileUploadPrefix()}
<script>
$.getJSON('${site.dynamicPath}api/method/getFileUploadPrefix', function(data){
console.log(data);
});
</script>
|
class |
GetFontListMethod
getFontList 获取系统字体列表
返回结果
font list :字体名称列表
使用示例
<#list getFontList() as font>${font}</#list>
<script>
$.getJSON('${site.dynamicPath}api/method/getFontList? |
class |
GetHashMethod
getHash 获取哈希值
参数列表
字符串
返回结果
string :哈希值
使用示例
${getHash('aaa')}
<script>
$.getJSON('${site.dynamicPath}api/method/getHash? |
class |
GetHtmlMethod
getHtml 获取远程页面文本
参数列表
url :
参数,map 类型或string 类型,为空时以get方式请求,不为空时以post方式请求
请求头,map 类型
返回结果
html :页面文本
使用示例
${getHtml('https://www.publiccms.com/')}
${getHtml('https://www.publiccms.com/',"body")}
${getHtml('https://www.publiccms.com/',{"parameters1":"value1","parameters2":"value2"},{"headers1":"value1","headers2":"value2"})}
<script>
$.getJSON('${site.dynamicPath}api/method/getHtml? |
class |
GetIpRegionMethod
getIpRegion 获取IP区域信息
返回结果
string ip
使用示例
${getIpRegion('127.0.0.1')}
<script>
$.getJSON('${site.dynamicPath}api/method/getIpRegion? |
class |
GetIpv4NumberMethod
getIpv4Number 获取ip的数字值
参数列表
ip
返回结果
number :数字
使用示例
${getIpv4Number('127.0.0.1')}
<script>
$.getJSON('${site.dynamicPath}api/method/getIpv4Number? |
class |
GetIpv6NumberMethod
getIpv6Number 获取ip的数字值
参数列表
ip
返回结果
number string :字符格式数字
使用示例
${getIpv6Number('FF01:0:0:0:0:0:0:1101')}
<script>
$.getJSON('${site.dynamicPath}api/method/getIpv4Number? |
class |
GetKeywordsMethod
getKeywords 获取分词结果
参数列表
完整语句
返回结果
list (string ):分词结果set
使用示例
<#list getKeywords('这是一段话') as a>${a}<#sep>,</#list><
<script>
$.getJSON('${site.dynamicPath}api/method/getKeywords? |
class |
GetLayoutStyleMethod
getLayoutStyle 布局样式表
参数列表
包含/* selecter */的样式表
被替换的选择器
返回结果
style :替换后的样式表
使用示例
${getLayoutStyle('/* selecter */','.diy-layout')}
<script>
$.getJSON('${site.dynamicPath}api/method/getLayoutStyle? |
class |
GetLicenseDataMethod
getLicenseData 获取授权数据
返回结果
string :base64编码的授权数据
使用示例
${getLicenseData()}
<script>
$.getJSON('${site.dynamicPath}api/method/getLicenseData, function(data){
console.log(data);
});
</script>
|
class |
GetLicenseMethod
getLicense 获取授权
返回结果
license :授权数据License
使用示例
${getLicense().domain}
<script>
$.getJSON('${site.dynamicPath}api/method/getLicense? |
class |
GetMd5Method
getMd5 获取md5值
参数列表
字符串
返回结果
string :md5值
使用示例
${getMd5('aaa')}
<script>
$.getJSON('${site.dynamicPath}api/method/getMd5? |
class |
GetPageMethod
getPage 获取分页url
参数列表
url
pageIndex :页码数字
string :分页参数,动态url分页参数名,为空时返回静态化url分页结果
返回结果
url :带分页的url
使用示例
${getPage('https://www.publiccms.com/introduction/index_3.html',2)}
${getPage('https://search.publiccms.com/? |
class |
GetParameterTypeListMethod
getParameterTypeList 获取参数类型list
返回结果
list :参数类型名称
使用示例
<#list getParameterTypeList() as a>${a}<#sep>,</#list>
<script>
$.getJSON('${site.dynamicPath}api/method/getParameterTypeList? |
class |
GetPrivateUrlMethod
getPrivateUrl 获取私有文件绝对路径
参数列表
url ,文件url
expiryMinutes ,过期分钟数,可以为空
string ,文件名,可以为空
返回结果
url :绝对路径的url
使用示例
${getPrivateUrl('index.html')}
<script>
$.getJSON('${site.dynamicPath}api/method/getPrivateUrl? |
class |
GetRandomMethod
getRandom 获取随机数字
参数列表
number :最大数字,可以为空
返回结果
number :随机数字
使用示例
${getRandom()}
${getRandom(100)}
<script>
$.getJSON('${site.dynamicPath}api/method/getRandom? |
class |
GetSha1Method
getSha1 获取sha1
参数列表
字符串
返回结果
string :sha1值
使用示例
${getSha1('aaa')}
<script>
$.getJSON('${site.dynamicPath}api/method/getSha1? |
class |
GetSha256Method
getSha256 获取sha256
参数列表
字符串
返回结果
string :sha256值
使用示例
${getSha256('aaa')}
<script>
$.getJSON('${site.dynamicPath}api/method/getSha256? |
class |
GetSha2Method
GetSha2 获取sha2
GetSha512Method |
class |
GetSha512Method
getSha512 获取sha512
参数列表
字符串
返回结果
string :sha512值
使用示例
${getSha512('aaa')}
<script>
$.getJSON('${site.dynamicPath}api/method/getSha512? |
class |
GetSitefileMethod
getSitefile 获取站点文件描述
参数列表
文件名
返回结果
sitefile :Sitefile
使用示例
${(getSitefile('aaa-site.zip').name)!} |
class |
GetSkipWordMethod
getSkipWord 获取词典忽略分词
返回结果
string 词典忽略分词
使用示例
${getSkipWord()}
<script>
$.getJSON('${site.dynamicPath}api/method/getRandom? |
class |
GetSleepMethod
getSleep 睡眠一段时间
参数列表
number :睡眠时间0-60秒
返回结果
boolean :是否睡眠
使用示例
${getSleep(5)}
|
class |
GetTemplateResultMethod
getTemplateResult 获取模板解析结果
参数列表
模板内容
返回结果
string :解析结果
使用示例
${getTemplateResult('${.now}')}
<script>
$.getJSON('${site.dynamicPath}api/method/getDate? |
class |
GetTextFromHtmlMethod
getTextFromHtml 获取html中的文本
参数列表
html内容
返回结果
string :文本结果
使用示例
${getTextFromHtml('<a href="http://www.publiccms.com/">publiccms</a>')}
<script>
$.getJSON('${site.dynamicPath}api/method/getTextFromHtml? |
class |
GetUrlMethod
getUrl 获取url绝对路径
参数列表
url前缀
url ,当第二个为空时,将第一个参数当作url
返回结果
url :绝对路径的url
使用示例
${getUrl(site.sitePath,'index.html')} ${getUrl('index.html')}
<script>
$.getJSON('${site.dynamicPath}api/method/getUrl? |
class |
GetUUIDMethod
getUUID 获取UUID
返回结果
string :随机uuid
使用示例
${getUUID()}
<script>
$.getJSON('${site.dynamicPath}api/method/getUUID', function(data){
console.log(data);
});
</script>
|
class |
GetXmlMethod
getXml 获取xml节点
参数列表
string :xml文本
返回结果
xml :xml模型
使用示例
${getXml('<xml><data>value</data></xml>').xml.data}
|