XoopsTplfileHandler Class Reference

Inheritance diagram for XoopsTplfileHandler:

Collaboration diagram for XoopsTplfileHandler:

Public Member Functions
	create ($isNew=true)
	get ($id, $getsource=false)
	loadSource (XoopsObject $tplfile)
	insert (XoopsObject $tplfile)
	forceUpdate (XoopsTplfile $tplfile)
	delete (XoopsObject $tplfile)
	getObjects (CriteriaElement $criteria=null, $getsource=false, $id_as_key=false)
	getCount (CriteriaElement $criteria=null)
	getModuleTplCount ($tplset)
	find ($tplset=null, $type=null, $refid=null, $module=null, $file=null, $getsource=false)
	templateExists ($tplname, $tplset_name)
Public Member Functions inherited from XoopsObjectHandler
	__construct (XoopsDatabase $db)
	XoopsObjectHandler ($db)
	create ()
	get ($id)
	insert (XoopsObject $object)
	delete (XoopsObject $object)

Additional Inherited Members
Data Fields inherited from XoopsObjectHandler
	$db

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

Todo:

this is not a XoopsPersistableObjectHandler?

Member Function Documentation

create()

create

(

$isNew = true

)

create a new Tplfile

See also

XoopsBlock

Parameters

bool

$isNew

is the new Tplfile new??

Returns

XoopsTplfile XoopsTplfile reference to the new Tplfile

delete()

delete

(

XoopsObject

$tplfile

)

delete a block from the database

Parameters

XoopsObject | XoopsTplfile

$tplfile

a XoopsTplfile object

Returns

bool true on success, otherwise false

Reimplemented from XoopsObjectHandler.

find()

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

Find Template File

Parameters

string	$tplset
string | array	$type
string	$refid
string	$module
string	$file
bool | string	$getsource

Returns

object

Here is the call graph for this function:

forceUpdate()

forceUpdate

(

XoopsTplfile

$tplfile

)

Update Tplfile, even if a safe transaction (i.e. http get)

Parameters

XoopsTplfile

$tplfile

Returns

bool true on success, otherwise false

Here is the call graph for this function:

get()

get	(		$id,
			$getsource = false
	)

retrieve a specific XoopsTplfile

See also

XoopsBlock

Parameters

int	$id	tpl_id of the block to retrieve
bool	$getsource

Returns

object XoopsTplfile reference to the Tplfile

getCount()

getCount

(

CriteriaElement

$criteria = null

)

Get count

Parameters

CriteriaElement | CriteriaCompo

$criteria

Returns

int

Here is the caller graph for this function:

getModuleTplCount()

getModuleTplCount

(

$tplset

)

getModuleTplCount

Parameters

string

$tplset

Returns

array

getObjects()

getObjects	(	CriteriaElement	$criteria = null,
			$getsource = false,
			$id_as_key = false
	)

retrieve array of XoopsBlocks meeting certain conditions

Parameters

CriteriaElement | CriteriaCompo	$criteria	CriteriaElement with conditions for the blocks
bool	$getsource
bool	$id_as_key	should the blocks' bid be the key for the returned array?

Returns

array XoopsBlocks matching the conditions

Here is the caller graph for this function:

insert()

insert

(

XoopsObject

$tplfile

)

write a new Tplfile into the database

Parameters

XoopsObject | XoopsTplfile

$tplfile

a XoopsTplfile object

Returns

bool true on success, otherwise false

Reimplemented from XoopsObjectHandler.

Here is the call graph for this function:

loadSource()

loadSource

(

XoopsObject

$tplfile

)

Load template source

Parameters

XoopsObject | XoopsTplfile

$tplfile

a XoopsTplfile object

Returns

bool true on success, otherwise false

Here is the call graph for this function:

templateExists()

templateExists	(		$tplname,
			$tplset_name
	)

Template Exists

Parameters

string	$tplname
string	$tplset_name

Returns

bool true if template exists, otherwise false

Here is the call graph for this function:

---

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

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