程序包 com.publiccms.common.base

类 AbstractTemplateDirective

java.lang.Object

com.publiccms.common.directive.BaseTemplateDirective

com.publiccms.common.base.AbstractTemplateDirective

所有已实现的接口:

Directive, HttpDirective, freemarker.template.TemplateDirectiveModel, freemarker.template.TemplateModel

直接已知子类:

CmsCategoryDirective, CmsCategoryListDirective, CmsCategoryModelDirective, CmsCategoryModelListDirective, CmsCategoryTypeDirective, CmsCategoryTypeListDirective, CmsCommentDirective, CmsCommentListDirective, CmsContentDirective, CmsContentFileListDirective, CmsContentListDirective, CmsContentProductDirective, CmsContentProductListDirective, CmsContentQuoteListDirective, CmsContentRelatedListDirective, CmsDictionaryDataDirective, CmsDictionaryDataListDirective, CmsDictionaryDirective, CmsDictionaryExcludeDirective, CmsDictionaryExcludeListDirective, CmsDictionaryExcludeValueDirective, CmsDictionaryListDirective, CmsEditorHistoryDirective, CmsEditorHistoryListDirective, CmsModelDirective, CmsModelListDirective, CmsPlaceDirective, CmsPlaceListDirective, CmsSearchDirective, CmsSurveyDirective, CmsSurveyListDirective, CmsSurveyQuestionDirective, CmsSurveyQuestionItemDirective, CmsSurveyQuestionItemListDirective, CmsSurveyQuestionListDirective, CmsTagDirective, CmsTagListDirective, CmsTagTypeDirective, CmsTagTypeListDirective, CmsUserCollectionDirective, CmsUserCollectionListDirective, CmsUserScoreDirective, CmsUserScoreListDirective, CmsUserSurveyDirective, CmsUserSurveyListDirective, CmsUserSurveyQuestionDirective, CmsUserSurveyQuestionListDirective, CmsUserVoteDirective, CmsUserVoteListDirective, CmsVoteDirective, CmsVoteItemDirective, CmsVoteItemListDirective, CmsVoteListDirective, CmsWordDirective, CmsWordListDirective, CreateCategoryFileDirective, CreateContentFileDirective, CreateLockDirective, CreateTemplateFileDirective, CsrfTokenDirective, DiskDirective, DiyMetadataDirective, DiyMetadataListDirective, DiyRegionDataDirective, ExceptionDirective, ExecuteScriptDirective, FileBackupContentDirective, FileBackupListDirective, FileContentDirective, FileExistDirective, FileHistoryContentDirective, FileHistoryListDirective, FileListDirective, GatewayListDirective, IncludeLayoutDirective, IncludePlaceDirective, IncludeRegionDirective, LicenseVerifyDirective, LogLoginListDirective, LogOperateDirective, LogOperateListDirective, LogTaskDirective, LogTaskListDirective, LogUploadListDirective, MasterSiteDirective, MemoryDirective, MetadataDirective, OauthListDirective, PlaceMetadataDirective, SendEmailDirective, SysAppClientDirective, SysAppClientListDirective, SysAppDirective, SysAppListDirective, SysAppTokenListDirective, SysAuthorizedDirective, SysClusterListDirective, SysConfigDataDirective, SysConfigDirective, SysConfigFieldListDirective, SysConfigListDirective, SysDeptDirective, SysDeptItemDirective, SysDeptItemListDirective, SysDeptListDirective, SysDomainDirective, SysDomainListDirective, SysExtendFieldListDirective, SysLockDirective, SysModuleDirective, SysModuleLangDirective, SysModuleListDirective, SysRecordDirective, SysRecordListDirective, SysRoleDirective, SysRoleListDirective, SysRoleModuleDirective, SysRoleModuleListDirective, SysRoleUserListDirective, SysSiteDirective, SysSiteListDirective, SysTaskDirective, SysTaskListDirective, SystemPropertiesDirective, SysUserDirective, SysUserListDirective, SysUserSettingDirective, SysUserTokenListDirective, SysWorkflowDirective, SysWorkflowListDirective, SysWorkflowProcessDirective, SysWorkflowProcessHistoryListDirective, SysWorkflowProcessItemDirective, SysWorkflowProcessListDirective, SysWorkflowStepDirective, SysWorkflowStepListDirective, TemplatePlaceListDirective, TemplateRegionListDirective, TemplateResultDirective, TemplateSearchListDirective, ThumbDirective, TradeAccountDirective, TradeAccountHistoryDirective, TradeAccountHistoryListDirective, TradeAccountListDirective, TradeAddressDirective, TradeAddressListDirective, TradeOrderDirective, TradeOrderHistoryDirective, TradeOrderHistoryListDirective, TradeOrderListDirective, TradeOrderProductDirective, TradeOrderProductListDirective, TradePaymentDirective, TradePaymentHistoryDirective, TradePaymentHistoryListDirective, TradePaymentListDirective, TradeRefundDirective, TradeRefundListDirective, UserAgentDirective, VersionDirective, VisitDayDirective, VisitDayListDirective, VisitHistoryDirective, VisitHistoryListDirective, VisitItemDirective, VisitItemListDirective, VisitSessionDirective, VisitSessionListDirective, VisitUrlDirective, VisitUrlListDirective, WorkloadDirective

public abstract class AbstractTemplateDirective
extends BaseTemplateDirective

AbstractTemplateDirective 自定义模板指令基类

字段概要

字段

修饰符和类型	字段	说明
static final String	ADVANCED
static final String	APP_TOKEN
private SysAppService	appService
private SysAppTokenService	appTokenService
static final String	AUTH_TOKEN
static final String	AUTH_USER_ID
protected SiteComponent	siteComponent
private SysUserService	sysUserService
private SysUserTokenService	sysUserTokenService

从类继承的字段 com.publiccms.common.directive.BaseTemplateDirective

log

从接口继承的字段 freemarker.template.TemplateModel

NOTHING

构造器概要

构造器

构造器	说明
AbstractTemplateDirective()

方法概要

修饰符和类型	方法	说明
void	execute(org.springframework.http.converter.HttpMessageConverter<Object> httpMessageConverter, org.springframework.http.MediaType mediaType, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
protected void	expose(RenderHandler handler, Map<String,Object> model)
protected boolean	getAdvanced(RenderHandler handler)
protected SysApp	getApp(RenderHandler handler)
protected SysSite	getSite(RenderHandler handler)
protected SysUser	getUser(RenderHandler handler)
protected Long	getUserId(RenderHandler handler, String name)
boolean	needAppToken()
boolean	needUserToken()
boolean	supportAdvanced()

从类继承的方法 com.publiccms.common.directive.BaseTemplateDirective

execute, getName, getNamespace, getShortName, httpEnabled, setName, setNamespace, setShortName

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 com.publiccms.common.directive.Directive

execute

字段详细资料

APP_TOKEN

public static final String APP_TOKEN

另请参阅:

• 常量字段值

AUTH_TOKEN

public static final String AUTH_TOKEN

另请参阅:

• 常量字段值

AUTH_USER_ID

public static final String AUTH_USER_ID

另请参阅:

• 常量字段值

ADVANCED

public static final String ADVANCED

另请参阅:

• 常量字段值

appTokenService

private SysAppTokenService appTokenService

appService

private SysAppService appService

sysUserTokenService

private SysUserTokenService sysUserTokenService

sysUserService

private SysUserService sysUserService

siteComponent

protected SiteComponent siteComponent

构造器详细资料

AbstractTemplateDirective

public AbstractTemplateDirective()

方法详细资料

getSite

protected SysSite getSite(RenderHandler handler)
                   throws freemarker.template.TemplateModelException

参数:

handler -

返回:

site

抛出:

freemarker.template.TemplateModelException

expose

protected void expose(RenderHandler handler,
 Map<String,Object> model)
               throws freemarker.template.TemplateModelException

参数:

handler -

model -

抛出:

freemarker.template.TemplateModelException

getAdvanced

protected boolean getAdvanced(RenderHandler handler)
                       throws freemarker.template.TemplateModelException

抛出:

freemarker.template.TemplateModelException

getUserId

protected Long getUserId(RenderHandler handler,
 String name)
                  throws freemarker.template.TemplateModelException

抛出:

freemarker.template.TemplateModelException

execute

public void execute(org.springframework.http.converter.HttpMessageConverter<Object> httpMessageConverter,
 org.springframework.http.MediaType mediaType,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
             throws freemarker.template.TemplateException,
IOException

参数:

httpMessageConverter -

mediaType -

request -

response -

抛出:

freemarker.template.TemplateException

IOException

getApp

protected SysApp getApp(RenderHandler handler)
                 throws freemarker.template.TemplateModelException

抛出:

freemarker.template.TemplateModelException

getUser

protected SysUser getUser(RenderHandler handler)
                   throws freemarker.template.TemplateModelException

抛出:

freemarker.template.TemplateModelException

supportAdvanced

public boolean supportAdvanced()

返回:

support advanced parameters

needAppToken

public boolean needAppToken()

返回:

whether need the app token

needUserToken

public boolean needUserToken()

返回:

whether need the user token