Class icms_view_template_file_Handler

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

icms_core_ObjectHandler

icms_view_template_file_Handler

Package: View\Template
Category: ICMS
Copyright: Copyright (c) 2000 XOOPS.org
License: LICENSE.txt
Author: Kazumi Ono onokazu@xoops.org
Located at view/template/file/Handler.php

Methods summary
`public object &`	# `create( boolean $isNew = true )` create a new template instance create a new template instance Parameters `$isNew` is the new tempate new?? Returns object icms_view_template_file_Object `icms_view_template_file_Object` reference to the new template See `icms_view_template_file_Object`
`public object &`	# `get( integer $id, boolean $getsource = false )` gets a new template instance gets a new template instance Parameters `$id` ID of the template to get `$getsource` would you like to get the source? Returns object icms_view_template_file_Object `icms_view_template_file_Object` reference to the new template See `icms_view_template_file_Object`
`public boolean`	# `loadSource( object & $tplfile )` Loads Template source from DataBase Loads Template source from DataBase Parameters `$tplfile` `icms_view_template_file_Object` object of the template file to load Returns boolean TRUE on success, FALSE if fail See `icms_view_template_file_Object`
`public boolean`	# `insert( object & $tplfile )` Inserts Template into the DataBase Inserts Template into the DataBase Parameters `$tplfile` `icms_view_template_file_Object` object of the template file to load Returns boolean TRUE on success, FALSE if fail See `icms_view_template_file_Object`
`public boolean`	# `forceUpdate( object & $tplfile )` forces Template source into the DataBase forces Template source into the DataBase Parameters `$tplfile` `icms_view_template_file_Object` object of the template file to load Returns boolean TRUE on success, FALSE if fail
`public boolean`	# `delete( object & $tplfile )` Deletes Template from the DataBase Deletes Template from the DataBase Parameters `$tplfile` `icms_view_template_file_Object` object of the template file to load Returns boolean TRUE on success, FALSE if fail
`public array`	# `getObjects( object $criteria = null, boolean $getsource = false, $id_as_key = false )` retrieve array of `icms_view_template_file_Object`s meeting certain conditions retrieve array of `icms_view_template_file_Object`s meeting certain conditions Parameters `$criteria` `icms_db_criteria_Element` with conditions for the blocks `$getsource` $id_as_key should the tplfile's tpl_id be the key for the returned array? `$id_as_key` Returns array `icms_view_template_file_Object`s matching the conditions
`public integer`	# `getCount( object $criteria = null )` Count some tplfiles Count some tplfiles Parameters `$criteria` `icms_db_criteria_Element` Returns integer
`public array`	# `getModuleTplCount( string $tplset )` Count some tplfiles for a module Count some tplfiles for a module Parameters `$tplset` Template Set Returns array $ret containing number of templates in the tpl_set or empty array if fails
`public array`	# `find( string $tplset = null, string $type = null, integer $refid = null, string $module = null, string $file = null, boolean $getsource = false )` find tplfiles matching criteria find tplfiles matching criteria Parameters `$tplset` template set `$type` template type `$refid` ref id `$module` module `$file` template file `$getsource` = false get source or not Returns array $ret containing number of templates in the tpl_set or empty array if fails
`public boolean`	# `templateExists( string $tplname, string $tplset_name )` Does the template exist in the database in the template set Does the template exist in the database in the template set Parameters `$tplname` template name `$tplset_name` template set name Returns boolean true if exists, false if not
`public boolean`	# `prefetchBlocks( array & $block_arr )` Prefetch blocks to reduce the amount of queries required by Smarty to generate all blocks This function is called exclusively in icms_view_PageBuilder Prefetch blocks to reduce the amount of queries required by Smarty to generate all blocks This function is called exclusively in icms_view_PageBuilder Parameters `$block_arr` array of blocks to prefetch Returns boolean false if there are no blocks to prefetch, otherwise true
`public array`	# `getPrefetchedBlock( str $tplset, str $tpl_name )` Return a prefetched block. This function only works if prefetchBlocks was called in advance. This function is used in the user function smarty_resource_db_tplinfo(). Return a prefetched block. This function only works if prefetchBlocks was called in advance. This function is used in the user function smarty_resource_db_tplinfo(). Parameters `$tplset` template set that's currently in use `$tpl_name` name of the template Returns array array of templates (just one item)

Methods inherited from icms_core_ObjectHandler
`__construct()`

Properties inherited from icms_core_ObjectHandler
`$db`

Packages

Classes

Class icms_view_template_file_Handler

Parameters

Returns

See

Parameters

Returns

See

Parameters

Returns

See

Parameters

Returns

See

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns