Overview

Namespaces

  • None
  • Xmf
    • Database
    • Module
      • Helper
    • Template
  • Xoops
    • Auth
    • Core
      • Cache
      • Database
        • Logging
        • Schema
      • Exception
      • Handler
        • Scheme
      • Kernel
        • Dtype
        • Handlers
        • Model
      • Lists
      • Locale
        • Punic
      • Service
        • Contract
      • Session
      • Text
        • Sanitizer
          • Extensions
      • Theme
        • Plugins
    • Form
    • Html
    • Locale
    • Module
      • Helper
      • Plugin

Classes

  • Assets
  • ComposerUtility
  • Events
  • FilterInput
  • FixedGroups
  • HttpRequest
  • Logger
  • MediaUploader
  • MimeTypes
  • PreloadItem
  • Psr0ClassLoader
  • Psr4ClassLoader
  • Random
  • Registry
  • Request
  • Security
  • XoopsTpl
  • Yaml

Interfaces

  • AttributeInterface
  • Overview
  • Namespace
  • Class
  • Tree

Class XoopsTpl

XOOPS template engine class

Smarty
Extended by Xoops\Core\XoopsTpl

Direct known subclasses

XoopsTpl
Namespace: Xoops\Core
Package: Template
Category: Xoops\Core
Copyright: 2000-2015 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono onokazu@xoops.org
Author: Skalpa Keo skalpa@xoops.org
Author: Taiwen Jiang phppp@users.sourceforge.net
Link: http://xoops.org
Located at oops_lib/Xoops/Core/XoopsTpl.php
Methods summary
public
# __construct( )

XoopsTpl constructor

XoopsTpl constructor
public string
# convertLegacyDelimiters( string $tpl_source, Smarty_Internal_Template $template )

XOOPS legacy used '<{' and '}>' as delimiters rather than using the default '{' and '}'. This prefilter function converts any legacy delimiters to Smarty default delimiters.

XOOPS legacy used '<{' and '}>' as delimiters rather than using the default '{' and '}'. This prefilter function converts any legacy delimiters to Smarty default delimiters.

The intention is to phase out the legacy delimiters entirely.

Parameters

$tpl_source
template source
$template
template object

Returns

string
source with any legacy delimiters converted to standard default delimiters
public boolean
# touch( string $resourceName )

XoopsTpl::touch

XoopsTpl::touch

Parameters

$resourceName
name of resource

Returns

boolean
public
# setCompileId( mixed $module_dirname = null, mixed $theme_set = null, mixed $template_set = null )

XoopsTpl::setCompileId()

XoopsTpl::setCompileId()

Parameters

$module_dirname
module directory
$theme_set
theme set
$template_set
template set
public integer
# clearModuleCompileCache( mixed $module_dirname = null, mixed $theme_set = null, mixed $template_set = null )

XoopsTpl::clearModuleCompileCache()

XoopsTpl::clearModuleCompileCache()

Clean up compiled and cached templates for a module

TODO - handle $use_sub_dirs cases

Parameters

$module_dirname
module directory
$theme_set
theme set
$template_set
template set

Returns

integer
number of deleted cache and compiler files
public integer
# clearCache( string $template_name, string $cache_id = null, string $compile_id = null, integer $exp_time = null, string $type = null )

Empty cache for a specific template

Empty cache for a specific template

This is just a pass-through wrapper with a warning since this method previously existed only in XoopsTpl, but now is also a regular Smarty method.

clearModuleCompileCache() is the replacement for the old clearCache

Parameters

$template_name
template name
$cache_id
cache id
$compile_id
compile id
$exp_time
expiration time
$type
resource type

Returns

integer
number of cache files deleted
Properties summary
public Xoops\Core\Theme\XoopsTheme $currentTheme
# null
API documentation generated by ApiGen