Docs For Class Skin

Class Overview

Skin Class

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

DataObject
   |
   --Skin

Author(s):

Information Tags:

Version:

beta

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties	Inherited Methods	Inherited Constants
Inherited From DataObject DataObject::$delete_cascades DataObject::$delete_restrictions DataObject::$ID	Inherited From DataObject DataObject::DataObject() Constructor 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::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::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.

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From DataObject

DataObject::$delete_cascades

DataObject::$delete_restrictions

DataObject::$ID

Inherited From DataObject

DataObject::DataObject()

Constructor

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::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::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.

[ Top ]

Property Summary

array	$container_list	Lazy filled.
mixed	$folder
mixed	$name
mixed	$type

[ 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	db_save_containers()	Save containers
void	discover_containers()	Discover containers included in skin file
array	get_containers()
void	get_default_name()	Get default name for the skin.
void	get_name()	Get the customized name for the skin.
void	install()	Install a skin
boolean	load_from_Request()	Load data from Request form fields.

[ Top ]

Properties

array $container_list = NULL [line 44]

Lazy filled.

[ Top ]

mixed $folder [line 37]

[ Top ]

mixed $name [line 36]

[ Top ]

mixed $type [line 38]

[ Top ]

Methods

static method disp_skinshot [line 357]

static void disp_skinshot(

$skin_folder, [
$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:
	$function:
	$selected:
	$select_url:
	$function_url:

[ Top ]

Constructor Skin [line 52]

Skin Skin(
[table
$db_row = NULL] 
)

Constructor

Parameters:

table

$db_row:

Database row

[ Top ]

container [line 147]

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

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

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 ]

db_save_containers [line 328]

void db_save_containers(
)

Save containers

to be called by dbinsert / dbupdate

[ Top ]

discover_containers [line 178]

void discover_containers(
)

Discover containers included in skin file

Information Tags:

Todo:

browse all *.tpl.php

[ Top ]

get_containers [line 261]

array get_containers(
)

[ Top ]

get_default_name [line 105]

void get_default_name(
)

Get default name for the skin.

Note: the admin can customize it.

[ Top ]

get_name [line 113]

void get_name(
)

Get the customized name for the skin.

[ Top ]

install [line 87]

void install(
string
$skin_folder, [string
$name = NULL] 
)

Install a skin

Parameters:

string	$skin_folder:
string	$name:	NULL for default (used by installer; TODO: override with class for Atom ans RSS 2.0)

Information Tags:

Todo:

do not install if skin doesn't exist. Important for upgrade. Need to NOT fail if ZERO skins installed though :/

[ Top ]

load_from_Request [line 123]

boolean load_from_Request(
)

Load data from Request form fields.

API Tags:

Return:

true if loaded data seems valid.

[ Top ]

Multilingual multiuser multiblog engine

Class: Skin

Class Skin

Packages

Classes

Files