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.

XoopsObjectHandler

XoopsTplfileHandler

Package: kernel
Copyright: (c) 2000-2016 XOOPS Project (www.xoops.org)
License: GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono onokazu@xoops.org
Located at ernel/tplfile.php

Methods summary
`public XoopsTplfile`	# `create( boolean $isNew = true )` create a new Tplfile create a new Tplfile Parameters `$isNew` is the new Tplfile new?? Returns `XoopsTplfile` XoopsTplfile reference to the new Tplfile See `XoopsBlock` Overrides `XoopsObjectHandler::create()`
`public object`	# `get( integer $id, boolean $getsource = false )` retrieve a specific `XoopsTplfile` retrieve a specific `XoopsTplfile` Parameters `$id` tpl_id of the block to retrieve `$getsource` Returns object XoopsTplfile reference to the Tplfile See `XoopsBlock` Overrides `XoopsObjectHandler::get()`
`public boolean`	# `loadSource( XoopsObject $tplfile )` Load template source Load template source Parameters `$tplfile` a XoopsTplfile object Returns boolean true on success, otherwise false
`public boolean`	# `insert( XoopsObject $tplfile )` write a new Tplfile into the database write a new Tplfile into the database Parameters `$tplfile` a XoopsTplfile object Returns boolean true on success, otherwise false Overrides `XoopsObjectHandler::insert()`
`public boolean`	# `forceUpdate( XoopsTplfile $tplfile )` Update Tplfile, even if a safe transaction (i.e. http get) Update Tplfile, even if a safe transaction (i.e. http get) Parameters `$tplfile` Returns boolean true on success, otherwise false
`public boolean`	# `delete( XoopsObject $tplfile )` delete a block from the database delete a block from the database Parameters `$tplfile` a XoopsTplfile object Returns boolean true on success, otherwise false Overrides `XoopsObjectHandler::delete()`
`public array`	# `getObjects( CriteriaElement $criteria = null, boolean $getsource = false, boolean $id_as_key = false )` retrieve array of `XoopsBlock`s meeting certain conditions retrieve array of `XoopsBlock`s meeting certain conditions Parameters `$criteria` `CriteriaElement` with conditions for the blocks `$getsource` `$id_as_key` should the blocks' bid be the key for the returned array? Returns array `XoopsBlock`s matching the conditions
`public integer`	# `getCount( CriteriaElement $criteria = null )` Get count Get count Parameters `$criteria` Returns integer
`public array`	# `getModuleTplCount( string $tplset )` getModuleTplCount getModuleTplCount Parameters `$tplset` Returns array
`public object`	# `find( string $tplset = null, string\|array $type = null, string $refid = null, string $module = null, string $file = null, boolean\|string $getsource = false )` Find Template File Find Template File Parameters `$tplset` `$type` `$refid` `$module` `$file` `$getsource` Returns object
`public boolean`	# `templateExists( string $tplname, string $tplset_name )` Template Exists Template Exists Parameters `$tplname` `$tplset_name` Returns boolean true if template exists, otherwise false

Methods inherited from XoopsObjectHandler
`XoopsObjectHandler(), __construct()`

Properties inherited from XoopsObjectHandler
`$db`

Namespaces

Classes

Interfaces

Exceptions

Functions

Class XoopsTplfileHandler

Parameters

Returns

See

Overrides

Parameters

Returns

See

Overrides

Parameters

Returns

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns