[class tree: bigace-classes] [index: bigace-classes] [all elements]

Class: SmartyService

Source Location: /CORE/system/classes/smarty/SmartyService.php

Class SmartyService

Class Overview

The SmartyService is capable for writing and reading Smarty Objects.

Located in /CORE/system/classes/smarty/SmartyService.php [line 41]

Author(s):

Kevin Papst

Information Tags:

Version:	$Id: SmartyService.php,v 1.10 2008/06/09 20:32:55 kpapst Exp $
Copyright:	Copyright (C) Kevin Papst
License:	GNU Public License

Methods

[ Top ]

Method Summary

int	countDesignUsage()	Counts how often a Design is used by Menus.
int	countStylesheetUsage()	Counts how often a Stylesheet is used in Designs.
int	countTemplateUsage()	Counts how often a Template is used in Designs.
void	createDesign()	Creates a new Design.
void	createStylesheet()	Creates a new Stylesheet.
void	createTemplate()	Creates a new Template.
void	deleteDesign()	Delete the given Design.
void	deleteStylesheet()	Delete the given Stylesheet.
void	deleteTemplate()	Delete the given Template.
array	getAllDesigns()	Fetches all Designs as an array of SmartyDesign Objects.
array	getAllStylesheets()	Fetches all Stylesheets as an array of SmartyStylesheet Objects.
void	getAllTemplates()
void	parseName()	Creates a valid (and useful) Filename from any String.
void	setContents()	Sets which contents are available for a design.
void	setPortlets()	Sets which portlet columns are availbale for the given design
void	updateDesign()	Name is not updateable!
void	updateStylesheet()	Name is not updateable yet!
void	updateTemplate()	Name is not updateable yet!

[ Top ]

Methods

countDesignUsage [line 106]

int countDesignUsage(

$name 
)

Counts how often a Design is used by Menus.

Parameters:

$name:

API Tags:

Return:

the amount of how often the Design is in use

[ Top ]

countStylesheetUsage [line 92]

int countStylesheetUsage(

$name 
)

Counts how often a Stylesheet is used in Designs.

Parameters:

$name:

API Tags:

Return:

the amount of how often the Stylesheet is in use

[ Top ]

countTemplateUsage [line 77]

int countTemplateUsage(

$name 
)

Counts how often a Template is used in Designs.

Parameters:

$name:

API Tags:

Return:

the amount of how often the Template is in use

[ Top ]

createDesign [line 132]

void createDesign(

$name, 
$description, 
$template, 
$stylesheet, 
$portlets 
)

Creates a new Design.

Parameters:

	$name:
	$description:
	$template:
	$stylesheet:
	$portlets:

[ Top ]

createStylesheet [line 168]

void createStylesheet(

$name, 
$description, 
$content, 
$editorcss 
)

Creates a new Stylesheet.

The Filename is built by calling

SmartyService::parseName($name)

Parameters:

	$name:
	$description:
	$content:
	$editorcss:

[ Top ]

createTemplate [line 148]

void createTemplate(

$name, 
$description, 
$content, [
$include = false], [
$inwork = true] 
)

Creates a new Template.

The Filename is built by calling

SmartyService::parseName($name)

Parameters:

	$name:
	$description:
	$content:
	$include:
	$inwork:

[ Top ]

deleteDesign [line 301]

void deleteDesign(

$name 
)

Delete the given Design.

Parameters:

$name:

[ Top ]

deleteStylesheet [line 278]

void deleteStylesheet(

$name 
)

Delete the given Stylesheet.

Parameters:

$name:

[ Top ]

deleteTemplate [line 259]

void deleteTemplate(

$name 
)

Delete the given Template.

Parameters:

$name:

[ Top ]

getAllDesigns [line 335]

array getAllDesigns(
)

Fetches all Designs as an array of SmartyDesign Objects.

API Tags:

Return:

all available Designs

[ Top ]

getAllStylesheets [line 353]

array getAllStylesheets(
)

Fetches all Stylesheets as an array of SmartyStylesheet Objects.

API Tags:

Return:

all available Designs

[ Top ]

getAllTemplates [line 316]

void getAllTemplates(
[
$showIncludes = true] 
)

Parameters:

$showIncludes:

[ Top ]

parseName [line 125]

void parseName(

$name 
)

Creates a valid (and useful) Filename from any String.

It cuts off all Character except: a - z A - Z

and the two separator character '_' and '-'.

Parameters:

$name:

[ Top ]

setContents [line 393]

void setContents(
string
$design, array
$columnNameArray 
)

Sets which contents are available for a design.

Parameters:

string	$design:
array	$columnNameArray:

[ Top ]

setPortlets [line 373]

void setPortlets(
string
$design, array
$columnNameArray 
)

Sets which portlet columns are availbale for the given design

Parameters:

string	$design:
array	$columnNameArray:

[ Top ]

updateDesign [line 242]

void updateDesign(

$name, 
$description, 
$template, 
$stylsheet, 
$portlets 
)

Name is not updateable!

Parameters:

	$name:
	$description:
	$template:
	$stylsheet:
	$portlets:

[ Top ]

updateStylesheet [line 218]

void updateStylesheet(

$id, 
$name, 
$description, 
$content, 
$editorcss 
)

Name is not updateable yet!

Parameters:

	$id:
	$name:
	$description:
	$content:
	$editorcss:

[ Top ]

updateTemplate [line 196]

void updateTemplate(

$id, 
$name, 
$description, 
$content, 
$inwork, 
$include 
)

Name is not updateable yet!

Parameters:

	$id:
	$name:
	$description:
	$content:
	$inwork:
	$include:

[ Top ]