XoopsTplfileHandler Class Reference

Inheritance diagram for XoopsTplfileHandler:

Public Member Functions
	__construct (Connection $db=null)
	deleteTpl (XoopsTplfile &$tplfile)
	find ($tplset=null, $type=null, $refid=null, $module=null, $file=null, $getsource=false)
	forceUpdate (XoopsTplfile &$tplfile)
	getById ($id, $getsource=false)
	getModuleTplCount ($tplset)
	getTplObjects (CriteriaElement $criteria=null, $getsource=false, $id_as_key=false)
	insertTpl (XoopsTplfile &$tplfile)
	loadSource (XoopsTplFile &$tplfile)
	templateExists ($tplname, $tplset_name)
Public Member Functions inherited from Xoops\Core\Kernel\XoopsPersistableObjectHandler
	__call ($name, $args)
	cleanOrphan ($table_link= '', $field_link= '', $field_object= '')
	create ($isNew=true)
	delete (XoopsObject $object, $force=false)
	deleteAll (CriteriaElement $criteria, $force=true, $asObject=false)
	deleteByLink (CriteriaElement $criteria=null)
	get ($id=null, $fields=null)
	getAll (CriteriaElement $criteria=null, $fields=null, $asObject=true, $id_as_key=true)
	getByLink (CriteriaElement $criteria=null, $fields=null, $asObject=true, $field_link=null, $field_object=null)
	getCount (CriteriaElement $criteria=null)
	getCountByLink (CriteriaElement $criteria=null)
	getCounts (CriteriaElement $criteria=null)
	getCountsByLink (CriteriaElement $criteria=null)
	getIds (CriteriaElement $criteria=null)
	getList (CriteriaElement $criteria=null, $limit=0, $start=0)
	getObjects (CriteriaElement $criteria=null, $id_as_key=false, $as_object=true)
	insert (XoopsObject $object, $force=true)
	loadHandler ($name, $args=null)
	setHandler ($handler=null, $args=null, $path=null)
	synchronization ($table_link= '', $field_link= '', $field_object= '')
	updateAll ($fieldname, $fieldvalue, CriteriaElement $criteria, $force=false)
	updateByLink ($data, CriteriaElement $criteria=null)
Public Member Functions inherited from Xoops\Core\Kernel\XoopsObjectHandler
	create ()
	delete (XoopsObject $object, $force=true)
	get ($int_id)
	insert (XoopsObject $object, $force=true)

Additional Inherited Members
Public Attributes inherited from Xoops\Core\Kernel\XoopsPersistableObjectHandler
	$className
	$field_link
	$field_object
	$identifierName
	$keyName
	$keyName_link
	$table
	$table_link
Public Attributes inherited from Xoops\Core\Kernel\XoopsObjectHandler
	$db2
Protected Member Functions inherited from Xoops\Core\Kernel\XoopsPersistableObjectHandler
	__construct (Connection $db=null, $table= '', $className= '', $keyName= '', $identifierName= '')
Protected Member Functions inherited from Xoops\Core\Kernel\XoopsObjectHandler
	__construct (Connection $db=null)
Protected Attributes inherited from Xoops\Core\Kernel\XoopsPersistableObjectHandler
	$handler

Detailed Description

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

Author

Kazumi Ono onoka.nosp@m.zu@x.nosp@m.oops..nosp@m.org

Definition at line 217 of file tplfile.php.

Constructor & Destructor Documentation

XoopsTplfileHandler::__construct

(

Connection

$db = null

)

Constructor

Parameters

Connection | null

$db

Connection

Definition at line 225 of file tplfile.php.

Member Function Documentation

XoopsTplfileHandler::deleteTpl

(

XoopsTplfile &

$tplfile

)

delete a block from the database

Parameters

XoopsTplfile

$tplfile

Returns

bool

Definition at line 433 of file tplfile.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsTplfileHandler::find	(		$tplset = null,
			$type = null,
			$refid = null,
			$module = null,
			$file = null,
			$getsource = false
	)

Find Template File

Parameters

string | null	$tplset	template set
string | null	$type	template type
string | null	$refid	reference id
string | null	$module	module
string | null	$file	file name
bool	$getsource	include template source

Returns

array

Definition at line 532 of file tplfile.php.

References $criteria, $criteria2, $file, $module, $type, and getTplObjects().

Here is the call graph for this function:

XoopsTplfileHandler::forceUpdate

(

XoopsTplfile &

$tplfile

)

forceUpdate

Parameters

XoopsTplfile

$tplfile

Returns

bool

Definition at line 381 of file tplfile.php.

References Xoops\Core\Kernel\XoopsObject\cleanVars(), Xoops\Core\Kernel\XoopsObject\isDirty(), and Xoops\Core\Kernel\XoopsObject\isNew().

Here is the call graph for this function:

XoopsTplfileHandler::getById	(		$id,
			$getsource = false
	)

retrieve a specific XoopsTplfile

Parameters

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

Returns

XoopsTplfile|bool

Definition at line 238 of file tplfile.php.

References $id, and $result.

XoopsTplfileHandler::getModuleTplCount

(

$tplset

)

getModuleTplCount

Parameters

string

$tplset

Returns

array

Definition at line 495 of file tplfile.php.

References $result.

XoopsTplfileHandler::getTplObjects	(	CriteriaElement	$criteria = null,
			$getsource = false,
			$id_as_key = false
	)

getTplObjects

Parameters

CriteriaElement | null	$criteria
bool	$getsource
bool	$id_as_key

Returns

array

Definition at line 452 of file tplfile.php.

References $criteria, and $result.

Referenced by find().

Here is the caller graph for this function:

XoopsTplfileHandler::insertTpl

(

XoopsTplfile &

$tplfile

)

write a new Tplfile into the database

Parameters

XoopsTplfile | XoopsObject

$tplfile

Returns

bool

Definition at line 303 of file tplfile.php.

References Xoops\Core\Kernel\XoopsObject\assignVar(), Xoops\Core\Kernel\XoopsObject\cleanVars(), Xoops\Core\Kernel\XoopsObject\isDirty(), and Xoops\Core\Kernel\XoopsObject\isNew().

Here is the call graph for this function:

XoopsTplfileHandler::loadSource

(

XoopsTplFile &

$tplfile

)

loadSource

Parameters

XoopsTplfile

&$tplfile

Returns

bool

Definition at line 278 of file tplfile.php.

References $result.

XoopsTplfileHandler::templateExists	(		$tplname,
			$tplset_name
	)

Template Exists

Parameters

string	$tplname	template name
string	$tplset_name	set name

Returns

bool

Definition at line 569 of file tplfile.php.

References $criteria, and Xoops\Core\Kernel\XoopsPersistableObjectHandler\getCount().

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• C:/usr64/htdocs/kernel/tplfile.php