Class: Base_ThemeCommon

Source Location: /modules/Base/Theme/ThemeCommon_0.php

Class Base_ThemeCommon

Class Overview

This class provides interface for module common.

Located in /modules/Base/Theme/ThemeCommon_0.php [line 24]

ModuleAcl
   |
   --ModulePrimitive
      |
      --ModuleCommon
         |
         --Base_ThemeCommon

Author(s):

Paul Bukowski <pbukowski@telaxus.com>

Information Tags:

Version:	1.0
Copyright:	Copyright © 2006, Telaxus LLC

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From ModuleCommon

ModuleCommon::Instance()

Singleton.

Inherited From ModulePrimitive

ModulePrimitive::__construct()

ModulePrimitive::check_access()

Checks access to function which name is passed as first parameter.

ModulePrimitive::create_data_dir()

Creates default data directory for module. Typical usage: in module installation

ModulePrimitive::get_data_dir()

Returns path to the default data directory for module calling this method.

ModulePrimitive::get_module_dir()

Returns path to the module directory.

ModulePrimitive::get_type()

Returns name(type) of module that called this function.

ModulePrimitive::get_type_with_bt()

ModulePrimitive::remove_data_dir()

Removes default data directory of a module. Typical usage: in module uninstallation

Inherited From ModuleAcl

ModuleAcl::acl_check()

ModuleAcl::add_aco()

ModuleAcl::del_aco()

ModuleAcl::get_type()

[ Top ]

Method Summary

static void	create_cache()	For internal use only.
static void	display_smarty()
static void	get_default_template()
static string	get_template_dir()	Returns path to currently selected theme.
static mixed	get_template_file()	Returns path and filename of a template file using path to currently selected theme.
static string	get_template_filename()	Returns path and filename of a template file.
static void	init_smarty()
static void	install_default_theme()	Performs installation of default theme files for a module.
static bool	load_css()	Loads css file.
static void	uninstall_default_theme()	Removes default theme files for a module.

[ Top ]

Methods

static method create_cache [line 261]

static void create_cache(
)

For internal use only.

API Tags:

Access:

public

[ Top ]

static method display_smarty [line 48]

static void display_smarty(

$smarty, 
$module_name, [
$user_template = null], [
$fullname = false] 
)

Parameters:

	$smarty:
	$module_name:
	$user_template:
	$fullname:

API Tags:

Access:

public

[ Top ]

static method get_default_template [line 38]

static void get_default_template(
)

API Tags:

Access:

public

[ Top ]

static method get_template_dir [line 151]

static string get_template_dir(
)

Returns path to currently selected theme.

API Tags:

Return:	directory in which currently selected theme is placed
Access:	public

[ Top ]

static method get_template_file [line 190]

static mixed get_template_file(
string
$modulename, [string
$filename = null] 
)

Returns path and filename of a template file using path to currently selected theme.

Use this method if you want to get access to a template file of currently installed theme. Files retreived this way are accessible via common file operation functions.

Parameters:

string	$modulename:	module name
string	$filename:	path and filename (path relative to specified module)

API Tags:

Return:	path and name of a file, false if no such file was found
Access:	public

[ Top ]

static method get_template_filename [line 176]

static string get_template_filename(
string
$modulename, string
$filename 
)

Returns path and filename of a template file.

Use this method if you want to pass full path and filename of a template file to another method which specifically accepts such data.

Parameters:

string	$modulename:	module name
string	$filename:	path and filename (path relative to specified module)

API Tags:

Return:	path and name of a file
Access:	public

[ Top ]

static method init_smarty [line 25]

static void init_smarty(
)

API Tags:

Access:

public

[ Top ]

static method install_default_theme [line 108]

static void install_default_theme(
string
$mod_name, [string
$version = 0] 
)

Performs installation of default theme files for a module.

Notice: the path should not contain / on the beginning nor on the end of string

Parameters:

string	$mod_name:	module name
string	$version:	directory in which default theme data for the module is hold (path relative to specified module)

API Tags:

Access:

public

[ Top ]

static method load_css [line 212]

static bool load_css(
string
$module_name, [string
$css_name = 'default'], [bool
$trig_error = true] 
)

Loads css file.

Parameters:

string	$module_name:	module name
string	$css_name:	css file name, 'default' by default
bool	$trig_error:	sets whether there should be an error displayed if css is not present, true by default

API Tags:

Return:	true on success, false otherwise
Access:	public

[ Top ]

static method uninstall_default_theme [line 131]

static void uninstall_default_theme(
string
$mod_name 
)

Removes default theme files for a module.

Parameters:

string

$mod_name:

module name

API Tags:

Access:

public

[ Top ]

Documentation generated on Fri, 26 Dec 2008 21:46:59 -0500 by phpDocumentor 1.4.2

	epesi-base theme

[ class tree: epesi-base ] [ index: epesi-base ] [ all elements ]