theme Class Reference

the primitive theme class More...

Inheritance diagram for theme:

Public Member Functions
	__construct ($theme_name)
	Constructs a theme object.
	cssPath ()
	Returns the absolute path of the theme css folder.
	dftCssPath ()
	Returns the absolute path of the default theme css folder.
	dftPath ()
	Returns the default theme absolute path.
	dftViewPath ()
	Returns the absolute path of the default theme view folder.
	getCss ()
	Returns the list of css to be included in the document.
	getJs ()
	Returns the list of js to be included in the document.
	getTemplate ()
	Getter method for the $_tpl member.
	name ()
	Returns the theme name.
	path ()
	Returns the theme absolute path.
	setTpl ($tpl)
	Sets the document template to render.
	viewPath ()
	Returns the absolute path of the theme view folder.
Protected Attributes
	$_dft_theme = 'default'
	the name of the default theme
	$_name
	the theme name
	$_registry
	the registry singleton instance
	$_tpl
	the template object
	$_tpl_name
	the document template name

---

Detailed Description

the primitive theme class

A Jeff theme is a module composed by views, css, img, locales, js, template files and a class file.
The class which takes its name from the theme name extends this theme class (which then acts like a super class) and implements the theme interface.

Jeff has a default and complete theme. It's the base theme that all others theme extends (not at class level). That is every template file, css, localized string, js, img which is not founded in the used theme module is taken from the default one, so that it's not necessary to overwrite every single aspect of the default theme to create a new custom one, but you may only overwrite that features that you want to change.

Author:

abidibo abidi.nosp@m.bo@g.nosp@m.mail..nosp@m.com

Version:

0.99

Date:

2011-2012

Copyright:

Otto srl MIT License

Definition at line 31 of file theme.class.php.

---

Constructor & Destructor Documentation

theme::__construct

(

$

theme_name

)

Constructs a theme object.

Parameters:

string

$theme_name

the theme name

Returns:

void

Definition at line 64 of file theme.class.php.

Here is the call graph for this function:

---

Member Function Documentation

theme::cssPath

(

)

Returns the absolute path of the theme css folder.

Returns:

the absolute path of the theme css folder

Definition at line 129 of file theme.class.php.

theme::dftCssPath

(

)

Returns the absolute path of the default theme css folder.

Returns:

the absolute path of the default theme css folder

Definition at line 140 of file theme.class.php.

theme::dftPath

(

)

Returns the default theme absolute path.

Returns:

the default theme absolute path

Definition at line 96 of file theme.class.php.

Here is the caller graph for this function:

theme::dftViewPath

(

)

Returns the absolute path of the default theme view folder.

Returns:

the absolute path of the default theme view folder

Definition at line 118 of file theme.class.php.

theme::getCss

(

)

Returns the list of css to be included in the document.

Returns:

the array containing the theme css to include in the document

Definition at line 182 of file theme.class.php.

Here is the call graph for this function:

theme::getJs

(

)

Returns the list of js to be included in the document.

Returns:

the array containing the theme js to include in the document

Definition at line 205 of file theme.class.php.

Here is the call graph for this function:

theme::getTemplate

(

)

Getter method for the $_tpl member.

Returns:

the template object property

Definition at line 151 of file theme.class.php.

theme::name

(

)

Returns the theme name.

Returns:

the theme name

Definition at line 74 of file theme.class.php.

theme::path

(

)

Returns the theme absolute path.

Returns:

the theme absolute path

Definition at line 85 of file theme.class.php.

Here is the caller graph for this function:

theme::setTpl

(

$

tpl

)

Sets the document template to render.

Parameters:

string

$tpl

the template name

Returns:

the template instance if the template file exists, null otherwise.

Definition at line 163 of file theme.class.php.

Here is the call graph for this function:

theme::viewPath

(

)

Returns the absolute path of the theme view folder.

Returns:

the absolute path of the theme view folder

Definition at line 107 of file theme.class.php.

---

Field Documentation

theme::$_dft_theme = 'default' [protected]

the name of the default theme

Definition at line 56 of file theme.class.php.

theme::$_name [protected]

the theme name

Definition at line 41 of file theme.class.php.

theme::$_registry [protected]

the registry singleton instance

Definition at line 36 of file theme.class.php.

theme::$_tpl [protected]

the template object

Definition at line 51 of file theme.class.php.

theme::$_tpl_name [protected]

the document template name

Definition at line 46 of file theme.class.php.

---

The documentation for this class was generated from the following file:

• core/theme/theme.class.php