contenido\classes\class.template.php

Show: inherited

• Classes
  • \Template

Table of Contents

Author

Jan Lengowski  

Con_php_req

5.0  

Copyright

four for business AG  

License

http://www.contenido.org/license/LIZENZ.txt  

Link

http://www.4fb.de  

Link

http://www.contenido.org  

Package

Contenido Backend classes  

Since

file available since contenido release <= 4.6 {@internal created unknown modified 2008-06-30, Frederic Schneider, add security fix modified 2008-09-03 Timo Trautmann, DB Object is only created if necessary modified 2010-02-01 Ingo van Peeren, Removed deprecated functions and arrays because they are not used anymore $Id: class.template.php 1206 2010-09-08 20:29:12Z xmurrix $: }}  

Version

1.2.3  

\Template

jump to top

Package: Default

class Template

Light template mechanism

Author

Jan Lengowski  

Author

Stefan Jelner (Optimizations)  

Copyright

four for business  

Version

1.0  

Properties

array $Dyn_needles = array()

Dyn_Needles (dynamic)

Default valuearray()Details

Type

array

array $Dyn_replacements = array()

Dyn_Replacements (dynamic)

Default valuearray()Details

Type

array

string $_sDomain = "contenido"

gettext domain (default: contenido)

Default value"contenido"Details

Type

string

object $db

Database instance

Details

Type

object

int $dyn_cnt = 0

Dynamic counter

Default value0Details

Type

int

array $needles = array()

Needles (static)

Default valuearray()Details

Type

array

array $replacements = array()

Replacements (static)

Default valuearray()Details

Type

array

array $tags = array('static' => '{%s}', 'start' => '<!-- BEGIN:BLOCK -->', 'end' => '<!-- END:BLOCK -->')

Tags array (for dynamic blocks);

Default valuearray('static' => '{%s}', 'start' => '<!-- BEGIN:BLOCK -->', 'end' => '<!-- END:BLOCK -->')Details

Type

array

Methods

Template( $tags = false) : void

Constructor function

Parameters

Name	Type	Description
$tags

generate( $template,  $return = 0,  $note = 0) : string

Generate the template and print/return it.

(do translations sequentially to save memory!!!)

Parameters

Name	Type	Description
$template		string/file Template
$return		bool Return or print template
$note		bool Echo "Generated by ... " Comment

Returns

Type	Description
string	complete Template string

next() : void

Iterate internal counter by one

replacei18n( $template,  $functionName) : void

replacei18n()

Replaces a named function with the translated variant

Parameters

Name	Type	Description
$template		string Contents of the template to translate (it is reference to save memory!!!)
$functionName		string Name of the translation function (e.g. i18n)

reset() : void

Reset template data

set( $which = 's',  $needle,  $replacement) : void

Set Templates placeholders and values

With this method you can replace the placeholders in the static templates with dynamic data.

Parameters

Name	Type	Description
$which		String 's' for Static or else dynamic
$needle		String Placeholder
$replacement		String Replacement String

setDomain( $sDomain) : \none

setDomain

Sets the gettext domain to use for translations in a template

Parameters

Name	Type	Description
$sDomain		string Sets the domain to use for template translations

Returns

Type	Description
\none

setEncoding( $encoding) : void

Sets an encoding for the template's head block.

Parameters

Name	Type	Description
$encoding		string Encoding to set