Docs For Class Template

Methods

static method disp_screenshot [line 650]

static void disp_screenshot(

$template_folder, 
$template_name, [
$function = NULL], [
$selected = false], [
$select_url = NULL], [
$function_url = NULL] 
)

Display screenshot for template folder in various places.

Including for NON installed templates.

Parameters:

	$template_folder:
	$template_name:
	$function:
	$selected:
	$select_url:
	$function_url:

[ Top ]

Constructor Template [line 67]

Template Template(
[table
$db_row = NULL], [
$template_folder = NULL] 
)

Constructor

Parameters:

table	$db_row:	Database row
	$template_folder:

[ Top ]

container [line 435]

void container(
string
$sco_name, [array
$params = array()] 
)

Display a container

$params = array_merge( array( // stop annoying validation errors when container is <ul> and empty
'container_start' => '<div id="%sco_name%" class="container">',
'container_end' => '</div>',
), $params );

Parameters:

string	$sco_name:
array	$params:

API Tags:

Usedby:	template_container()
Uses:	ComponentWidget::init_display()
Uses:	ComponentWidget::display()

[ Top ]

CreateDefaultWidgets [line 132]

void CreateDefaultWidgets(
obj
&$edited_Blog 
)

Create default widgets for requested blog

Parameters:

obj

&$edited_Blog:

Blog $edited_Blog

Information Tags:

Todo:

yabs > change this to param array

[ Top ]

dbinsert [line 599]

boolean dbinsert(
)

Insert object into DB based on previously recorded changes.

API Tags:

Return:

true

Redefinition of:

DataObject::dbinsert(): Insert object into DB based on previously recorded changes.

[ Top ]

dbupdate [line 577]

boolean dbupdate(
)

Update the DB based on previously recorded changes

API Tags:

Return:

true

Redefinition of:

DataObject::dbupdate(): Update the DB based on previously recorded changes

[ Top ]

dbupdate_settings [line 792]

void dbupdate_settings(
)

Save template specific settings for current blgo to DB

[ Top ]

db_save_containers [line 621]

void db_save_containers(
)

Save containers

to be called by dbinsert / dbupdate

[ Top ]

discover_containers [line 474]

void discover_containers(
)

Discover containers included in template file

[ Top ]

display_init [line 808]

void display_init(
)

Get ready for displaying the template.

This may register some CSS or JS...

Redefined in descendants as:

basic_Template::display_init() : Get ready for displaying the template.
custom_Template::display_init() : Get ready for displaying the template.
intense_Template::display_init() : Get ready for displaying the skin.

[ Top ]

get_containers [line 554]

array get_containers(
)

[ Top ]

get_default_name [line 320]

void get_default_name(
)

Get default name for the template.

Note: the admin can customize it.

Redefined in descendants as:

asevo_Template::get_default_name() : Get default name for the template, which the admin can customize.
basic_Template::get_default_name() : Get default name for the template, which the admin can customize.
custom_Template::get_default_name() : Get default name for the template, which the admin can customize.
evocamp_Template::get_default_name() : Get default name for the template, which the admin can customize.
evopress_Template::get_default_name() : Get default name for the template, which the admin can customize.
glossyblue_Template::get_default_name() : Get default name for the template, which the admin can customize.
intense_Template::get_default_name() : Get default name for the template, which the admin can customize.
miami_blue_Template::get_default_name() : Get default name for the template, which the admin can customize.
natural_pink_Template::get_default_name() : Get default name for the template, which the admin can customize.
nifty_corners_Template::get_default_name() : Get default name for the template, which the admin can customize.
photoblog_Template::get_default_name() : Get default name for the template, which the admin can customize.
pixelgreen_Template::get_default_name() : Get default name for the template, which the admin can customize.
pluralism_Template::get_default_name() : Get default name for the template, which the admin can customize.
terrafirma_Template::get_default_name() : Get default name for the template, which the admin can customize.
vastitude_Template::get_default_name() : Get default name for the template, which the admin can customize.
_atom_Template::get_default_name() : Get default name for the template, which the admin can customize.
_rdf_Template::get_default_name() : Get default name for the template, which the admin can customize.
_rss_Template::get_default_name() : Get default name for the template, which the admin can customize.
_rss2_Template::get_default_name() : Get default name for the template, which the admin can customize.
_sitemap_Template::get_default_name() : Get default name for the template, which the admin can customize.

[ Top ]

get_default_type [line 329]

void get_default_type(
)

Get default type for the template.

Redefined in descendants as:

asevo_Template::get_default_type() : Get default type for the template.
basic_Template::get_default_type() : Get default type for the template.
custom_Template::get_default_type() : Get default type for the template.
evocamp_Template::get_default_type() : Get default type for the template.
evopress_Template::get_default_type() : Get default type for the template.
glossyblue_Template::get_default_type() : Get default type for the template.
intense_Template::get_default_type() : Get default type for the template.
miami_blue_Template::get_default_type() : Get default type for the template.
natural_pink_Template::get_default_type() : Get default type for the template.
nifty_corners_Template::get_default_type() : Get default type for the template.
photoblog_Template::get_default_type() : Get default type for the template.
pixelgreen_Template::get_default_type() : Get default type for the template.
pluralism_Template::get_default_type() : Get default type for the template.
terrafirma_Template::get_default_type() : Get default type for the template.
vastitude_Template::get_default_type() : Get default type for the template.
_atom_Template::get_default_type() : Get default type for the template.
_rdf_Template::get_default_type() : Get default type for the template.
_rss_Template::get_default_type() : Get default type for the template.
_rss2_Template::get_default_type() : Get default type for the template.
_sitemap_Template::get_default_type() : Get default type for the template.

[ Top ]

get_default_widgets [line 211]

array get_default_widgets(
[
$params = array()] 
)

Get default widgets for new blog

The new blog's template can suggest/select a list of widgets. If it does not a default list is used.

A template can suggest/select any widget by identifying the container, and each widget's code and type. The code can be 'widget' or 'plugin'. If 'plugin' and the plugin is not installed nothing bad happens. I think.

$default_widgets = array(
'Header' => array(),
'Menu' => array(),
'Sidebar' => array(),
);
$default_widgets['Header'][] = array(
'title' => array(
'type' => 'widget',
),
);
$default_widgets['Menu'][] = array(
'menu_link' => array(
'type' => 'widget',
'params' => array(
'link_type'=>'ownercontact',
),
),
);
$default_widgets['Sidebar'][] = array(
'calendar' => array(
'type' => 'plugin',
),
);

A widget installed with only code and type will have default values for any parameters it may have.

Parameters:

$params:

API Tags:

Return:

widgets for each container

Information Tags:

Todo:

(EdB/7618): verify/ensure each widget needs to identify it's own param possibilities

Redefined in descendants as:

photoblog_Template::get_default_widgets()

[ Top ]

get_name [line 338]

void get_name(
)

Get the customized name for the template.

[ Top ]

get_param_definitions [line 729]

void get_param_definitions(
local
$params 
)

Get definitions for editable params

Parameters:

local

$params:

params like 'for_editing' => true

API Tags:

See:

Plugin::GetDefaultSettings()

Information Tags:

Todo:

this is destined to be overridden by derived Template classes

Redefined in descendants as:

basic_Template::get_param_definitions() : Get definitions for editable params
custom_Template::get_param_definitions() : Get definitions for editable params
intense_Template::get_param_definitions() : Get definitions for editable params

[ Top ]

get_setting [line 741]

void get_setting(

$parname 
)

Get a template specific param value from current Blog

Parameters:

$parname:

[ Top ]

get_template_credits [line 375]

array get_template_credits(
)

Get credits for linkback on credits page.

Each template can and should provide an array for credits for domains/authors who created the original design, inspired your design, or ported the template in the following format:

$template_linkbacks = array(
'designer' => array(
'pre' => T_('Design by'),
'text' => 'linked text',
'post' => T_('A reasonably brief summary of the template. A sentence or two should be enough?'),
'url' => 'http://yourdomain.tld/',
'title' => T_('insert creative link title'),
),
);
return $template_linkbacks;

Consider "designer" or "inspired" or "ported" as usual and customary types, and please limit the amount of linkbacks provided in the array. More than 3 will give a warning to the installer that your template might be spam!

'pre' => T_('Design by') or T_('Inspired by') or T_('Ported by') 'text' => the linked text - your name or domain name for example 'post' => can be '' (empty), and can hold HTML if you want. Please keep it reasonably short! 'url' => REQUIRED (of course). Without a URL there is no linkback! 'title' => can be whatever you like, but should never be empty. Use the URL if nothing else.

API Tags:

Return:

The credits array (see above).

Redefined in descendants as:

asevo_Template::get_template_credits() : Get credits for linkback on credits page.
basic_Template::get_template_credits() : Get credits for linkback on credits page.
custom_Template::get_template_credits() : Get credits for linkback on credits page.
evocamp_Template::get_template_credits() : Get credits for linkback on credits page.
evopress_Template::get_template_credits() : Get credits for linkback on credits page.
glossyblue_Template::get_template_credits() : Get credits for linkback on credits page.
intense_Template::get_template_credits() : Get credits for linkback on credits page.
miami_blue_Template::get_template_credits() : Get credits for linkback on credits page.
natural_pink_Template::get_template_credits() : Get credits for linkback on credits page.
nifty_corners_Template::get_template_credits() : Get credits for linkback on credits page.
photoblog_Template::get_template_credits() : Get credits for linkback on credits page.
pixelgreen_Template::get_template_credits() : Get credits for linkback on credits page.
pluralism_Template::get_template_credits() : Get credits for linkback on credits page.
terrafirma_Template::get_template_credits() : Get credits for linkback on credits page.
vastitude_Template::get_template_credits() : Get credits for linkback on credits page.

[ Top ]

install [line 111]

boolean install(
)

Install current template to DB

API Tags:

Return:

True on success, false on failure.

[ Top ]

load_from_Request [line 390]

boolean load_from_Request(
)

Load data from Request form fields.

API Tags:

Return:

true if loaded data seems valid.

[ Top ]

load_params_from_Request [line 407]

void load_params_from_Request(
)

Load params

[ Top ]

set_setting [line 775]

void set_setting(
string
$parname, mixed
$parvalue 
)

Set a template specific param value for current Blog

Parameters:

string	$parname:	parameter name
mixed	$parvalue:	parameter value

[ Top ]

TS_ [line 857]

string TS_(
string
$string, [string
$req_locale = ''] 
)

Translate and escape single quotes.

This is to be used mainly for Javascript strings.

Parameters:

string	$string:	String to translate
string	$req_locale:	Locale to use

API Tags:

Return:	The translated and escaped string.
Uses:	Template::T_()

Information Tags:

Since:

3.2.0 (after beta)

[ Top ]

T_ [line 829]

string T_(
string
$string, [string
$req_locale = ''] 
)

Translate a given string, in the Template's context.

This means, that the translation is obtained from the Template's "po/php" folder.

It uses the global/regular T_() function as a fallback.

Parameters:

string	$string:	The string (english), that should be translated
string	$req_locale:	Requested locale ($current_locale gets used by default)

API Tags:

Return:	The translated string.
Usedby:	Template::TS_()
Usedby:	Template::T_()
Uses:	Template::T_()

Information Tags:

Since:

3.2.0 (after beta)

[ Top ]

	templates

[ class tree: templates ] [ index: templates ] [ all elements ]

Class: Template

Class Template