Class: Skin

Source Location: /blogs/inc/skins/model/_skin.class.php

Class Skin

Class Overview

Skin Class

Located in /blogs/inc/skins/model/_skin.class.php [line 38]

DataObject
   |
   --Skin

Author(s):

Information Tags:

Version:

beta

Properties

Methods

[ Top ]

Direct descendents

Child Class	Description
intense_Skin	Specific code for this skin.
_sitemap_Skin	Specific code for this skin.
_rss_Skin	Specific code for this skin.
custom_Skin	Specific code for this skin.
pluralism_Skin	Specific code for this skin.
natural_pink_Skin	Specific code for this skin.
_atom_Skin	Specific code for this skin.
evopress_Skin	Specific code for this skin.
_rdf_Skin	Specific code for this skin.
_rss2_Skin	Specific code for this skin.

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties	Inherited Methods	Inherited Constants
Inherited From DataObject DataObject::$allow_ID_insert DataObject::$delete_cascades DataObject::$delete_restrictions DataObject::$ID	Inherited From DataObject DataObject::DataObject() Constructor DataObject::action_icon() Generate requested action icon depending on perm DataObject::action_link() Generate requested action link depending on perm DataObject::check_delete() Check relations for restrictions before deleting DataObject::check_relations() Check relations for restrictions or cascades. DataObject::confirm_delete() Displays form to confirm deletion of this object DataObject::dbchange() Records a change that will need to be updated in the db DataObject::dbdelete() Delete object from DB. DataObject::dbexists() Check existence of specified value in unique field. DataObject::dbinsert() Insert object into DB based on previously recorded changes. DataObject::dbsave() Inserts or Updates depending on object state. DataObject::dbupdate() Update the DB based on previously recorded changes DataObject::dget() Get a ready-to-display member param by its name DataObject::disp() Display a member param by its name DataObject::get() Get a member param by its name DataObject::get_action_title() Generate help title text for action DataObject::history_info_icon() Create icon with dataobject history DataObject::ID() Template function: Displays object ID. DataObject::set() Set param value DataObject::set_from_Request() Set a parameter from a Request form value. DataObject::set_param() Set param value. DataObject::set_string_from_param() Set a string parameter from a Request form value.

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From DataObject

DataObject::$allow_ID_insert

DataObject::$delete_cascades

DataObject::$delete_restrictions

DataObject::$ID

Inherited From DataObject

DataObject::DataObject()

Constructor

DataObject::action_icon()

Generate requested action icon depending on perm

DataObject::action_link()

Generate requested action link depending on perm

DataObject::check_delete()

Check relations for restrictions before deleting

DataObject::check_relations()

Check relations for restrictions or cascades.

DataObject::confirm_delete()

Displays form to confirm deletion of this object

DataObject::dbchange()

Records a change that will need to be updated in the db

DataObject::dbdelete()

Delete object from DB.

DataObject::dbexists()

Check existence of specified value in unique field.

DataObject::dbinsert()

Insert object into DB based on previously recorded changes.

DataObject::dbsave()

Inserts or Updates depending on object state.

DataObject::dbupdate()

Update the DB based on previously recorded changes

DataObject::dget()

Get a ready-to-display member param by its name

DataObject::disp()

Display a member param by its name

DataObject::get()

Get a member param by its name

DataObject::get_action_title()

Generate help title text for action

DataObject::history_info_icon()

Create icon with dataobject history

DataObject::ID()

Template function: Displays object ID.

DataObject::set()

Set param value

DataObject::set_from_Request()

Set a parameter from a Request form value.

DataObject::set_param()

Set param value.

DataObject::set_string_from_param()

Set a string parameter from a Request form value.

[ Top ]

Property Summary

array	$container_list	Lazy filled.
mixed	$folder
mixed	$name
mixed	$type
array	$_trans	The translations keyed by locale. They get loaded through include() of _global.php.

[ Top ]

Method Summary

static void	disp_skinshot()	Display skinshot for skin folder in various places.
Skin	Skin()	Constructor
void	container()	Display a container
boolean	dbinsert()	Insert object into DB based on previously recorded changes.
boolean	dbupdate()	Update the DB based on previously recorded changes
void	dbupdate_settings()	Save skin specific settings for current blgo to DB
void	db_save_containers()	Save containers
void	discover_containers()	Discover containers included in skin file
void	display_init()	Get ready for displaying the skin.
array	get_containers()
void	get_default_name()	Get default name for the skin.
void	get_default_type()	Get default type for the skin.
void	get_name()	Get the customized name for the skin.
void	get_param_definitions()	Get definitions for editable params
string	get_path()	Get current skin path
void	get_setting()	Get a skin specific param value from current Blog
string	get_url()	Get current skin URL
void	install()	Install current skin to DB
boolean	load_from_Request()	Load data from Request form fields.
void	load_params_from_Request()	Load params
void	set_setting()	Set a skin specific param value for current Blog
string	TS_()	Translate and escape single quotes.
string	T_()	Translate a given string, in the Skin's context.

[ Top ]

Properties

array $container_list = NULL [line 48]

Lazy filled.

[ Top ]

mixed $folder [line 41]

[ Top ]

mixed $name [line 40]

[ Top ]

mixed $type [line 42]

[ Top ]

array $_trans = array() [line 55]

The translations keyed by locale. They get loaded through include() of _global.php.

API Tags:

See:

Skin::T_()

[ Top ]

Methods

static method disp_skinshot [line 426]

static void disp_skinshot(

$skin_folder, 
$skin_name, [
$function = NULL], [
$selected = false], [
$select_url = NULL], [
$function_url = NULL] 
)

Display skinshot for skin folder in various places.

Including for NON installed skins.

Parameters:

	$skin_folder:
	$skin_name:
	$function:
	$selected:
	$select_url:
	$function_url:

[ Top ]

Constructor Skin [line 63]

Skin Skin(
[table
$db_row = NULL], [
$skin_folder = NULL] 
)

Constructor

Parameters:

table	$db_row:	Database row
	$skin_folder:

[ Top ]

container [line 177]

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

Display a container

Parameters:

string	$sco_name:
array	$params:

Information Tags:

Todo:

fp> if it doesn't get any skin specific, move it outta here! :P fp> Do we need Skin objects in the frontoffice at all? -- Do we want to include the dispatcher into the Skin object? WARNING: globals fp> We might want to customize the container defaults. -- Per blog or per skin?

[ Top ]

dbinsert [line 359]

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 337]

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 592]

void dbupdate_settings(
)

Save skin specific settings for current blgo to DB

[ Top ]

db_save_containers [line 381]

void db_save_containers(
)

Save containers

to be called by dbinsert / dbupdate

[ Top ]

discover_containers [line 229]

void discover_containers(
)

Discover containers included in skin file

[ Top ]

display_init [line 608]

void display_init(
)

Get ready for displaying the skin.

This may register some CSS or JS...

Redefined in descendants as:

intense_Skin::display_init() : Get ready for displaying the skin.
custom_Skin::display_init() : Get ready for displaying the skin.
evopress_Skin::display_init() : Get ready for displaying the skin.

[ Top ]

get_containers [line 314]

array get_containers(
)

[ Top ]

get_default_name [line 109]

void get_default_name(
)

Get default name for the skin.

Note: the admin can customize it.

Redefined in descendants as:

intense_Skin::get_default_name() : Get default name for the skin.
_sitemap_Skin::get_default_name() : Get default name for the skin.
_rss_Skin::get_default_name() : Get default name for the skin.
custom_Skin::get_default_name() : Get default name for the skin.
pluralism_Skin::get_default_name() : Get default name for the skin.
natural_pink_Skin::get_default_name() : Get default name for the skin.
_atom_Skin::get_default_name() : Get default name for the skin.
evopress_Skin::get_default_name() : Get default name for the skin.
_rdf_Skin::get_default_name() : Get default name for the skin.
_rss2_Skin::get_default_name() : Get default name for the skin.

[ Top ]

get_default_type [line 118]

void get_default_type(
)

Get default type for the skin.

Redefined in descendants as:

intense_Skin::get_default_type() : Get default type for the skin.
_sitemap_Skin::get_default_type() : Get default type for the skin.
_rss_Skin::get_default_type() : Get default type for the skin.
custom_Skin::get_default_type() : Get default type for the skin.
pluralism_Skin::get_default_type() : Get default type for the skin.
natural_pink_Skin::get_default_type() : Get default type for the skin.
_atom_Skin::get_default_type() : Get default type for the skin.
evopress_Skin::get_default_type() : Get default type for the skin.
_rdf_Skin::get_default_type() : Get default type for the skin.
_rss2_Skin::get_default_type() : Get default type for the skin.

[ Top ]

get_name [line 127]

void get_name(
)

Get the customized name for the skin.

[ Top ]

get_param_definitions [line 505]

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 Skin classes

Redefined in descendants as:

intense_Skin::get_param_definitions() : Get definitions for editable params
custom_Skin::get_param_definitions() : Get definitions for editable params
evopress_Skin::get_param_definitions() : Get definitions for editable params

[ Top ]

get_path [line 549]

string get_path(
)

Get current skin path

[ Top ]

get_setting [line 517]

void get_setting(

$parname 
)

Get a skin specific param value from current Blog

Parameters:

$parname:

[ Top ]

get_url [line 561]

string get_url(
)

Get current skin URL

[ Top ]

install [line 95]

void install(
)

Install current skin to DB

[ Top ]

load_from_Request [line 138]

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 155]

void load_params_from_Request(
)

Load params

[ Top ]

set_setting [line 575]

void set_setting(
string
$parname, mixed
$parvalue 
)

Set a skin specific param value for current Blog

Parameters:

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

[ Top ]

TS_ [line 660]

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:	Skin::T_()

Information Tags:

Since:

3.2.0 (after beta)

[ Top ]

T_ [line 632]

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

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

This means, that the translation is obtained from the Skin's "locales" 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:	Skin::T_()
Usedby:	Skin::TS_()
Uses:	Skin::T_()

Information Tags:

Since:

3.2.0 (after beta)

[ Top ]

Multilingual multiuser multiblog engine

Class: Skin

Class Skin

Packages

Classes

Files