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

  • XoopsBlock
  • XoopsBlockHandler
  • XoopsBlockModuleLink
  • XoopsBlockModuleLinkHandler
  • XoopsConfigHandler
  • XoopsConfigItem
  • XoopsConfigItemHandler
  • XoopsConfigOption
  • XoopsConfigOptionHandler
  • XoopsGroup
  • XoopsGroupHandler
  • XoopsGroupPerm
  • XoopsGroupPermHandler
  • XoopsMemberHandler
  • XoopsMembership
  • XoopsMembershipHandler
  • XoopsModule
  • XoopsModuleHandler
  • XoopsOnline
  • XoopsOnlineHandler
  • XoopsPrivateMessage
  • XoopsPrivateMessageHandler
  • XoopsTplFile
  • XoopsTplFileHandler
  • XoopsTplSet
  • XoopsTplSetHandler
  • XoopsUser
  • XoopsUserHandler
  • Overview
  • Namespace
  • Class
  • Tree

Class XoopsTplFileHandler

XOOPS template file handler class. This class is responsible for providing data access mechanisms to the data source of XOOPS template file class objects.

Xoops\Core\Kernel\XoopsObjectHandler
Extended by Xoops\Core\Kernel\XoopsPersistableObjectHandler
Extended by Xoops\Core\Kernel\Handlers\XoopsTplFileHandler

Direct known subclasses

XoopsTplfileHandler
Namespace: Xoops\Core\Kernel\Handlers
Package: Xoops\Core\Kernel
Category: Xoops\Core\Kernel\XoopsTplFileHandler
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
Link: http://xoops.org
Located at oops_lib/Xoops/Core/Kernel/Handlers/XoopsTplFileHandler.php
Methods summary
public
# __construct( Xoops\Core\Database\Connection $db = null )

Constructor

Constructor

Parameters

$db
database

Overrides

Xoops\Core\Kernel\XoopsPersistableObjectHandler::__construct()
public Xoops\Core\Kernel\Handlers\XoopsTplFile|boolean
# getById( integer $id, boolean $getsource = false )

retrieve a specific XoopsTplFile

retrieve a specific XoopsTplFile

Parameters

$id
tpl_id of the block to retrieve
$getsource
true = also return source

Returns

Xoops\Core\Kernel\Handlers\XoopsTplFile|boolean
public boolean
# loadSource( Xoops\Core\Kernel\Handlers\XoopsTplFile $tplfile )

loadSource

loadSource

Parameters

$tplfile
object

Returns

boolean
public boolean
# insertTpl( Xoops\Core\Kernel\Handlers\XoopsTplFile $tplfile )

write a new TplFile into the database

write a new TplFile into the database

Parameters

$tplfile
object

Returns

boolean
public boolean
# forceUpdate( Xoops\Core\Kernel\Handlers\XoopsTplFile $tplfile )

forceUpdate

forceUpdate

Parameters

$tplfile
object

Returns

boolean
public boolean
# deleteTpl( Xoops\Core\Kernel\Handlers\XoopsTplFile $tplfile )

delete a block from the database

delete a block from the database

Parameters

$tplfile
object

Returns

boolean
public array
# getTplObjects( Xoops\Core\Kernel\CriteriaElement $criteria = null, boolean $getsource = false, boolean $id_as_key = false )

getTplObjects

getTplObjects

Parameters

$criteria
criteria to match
$getsource
include the source
$id_as_key
use the object id as array key

Returns

array
public array
# getModuleTplCount( string $tplset )

getModuleTplCount

getModuleTplCount

Parameters

$tplset
tpl set name

Returns

array
public array
# find( string|null $tplset = null, string|null $type = null, string|null $refid = null, string|null $module = null, string|null $file = null, boolean $getsource = false )

Find Template File

Find Template File

Parameters

$tplset
template set
$type
template type
$refid
reference id
$module
module
$file
file name
$getsource
include template source

Returns

array
public boolean
# templateExists( string $tplname, string $tplset_name )

Template Exists

Template Exists

Parameters

$tplname
template name
$tplset_name
set name

Returns

boolean
Methods inherited from Xoops\Core\Kernel\XoopsPersistableObjectHandler
__call(), cleanOrphan(), create(), delete(), deleteAll(), deleteByLink(), get(), getAll(), getByLink(), getCount(), getCountByLink(), getCounts(), getCountsByLink(), getIds(), getList(), getObjects(), insert(), loadHandler(), setHandler(), synchronization(), updateAll(), updateByLink()
Properties inherited from Xoops\Core\Kernel\XoopsPersistableObjectHandler
$className, $field_link, $field_object, $handler, $identifierName, $keyName, $keyName_link, $table, $table_link
Properties inherited from Xoops\Core\Kernel\XoopsObjectHandler
$db2
API documentation generated by ApiGen