ZenMagick 0.9.8


org.zenmagick.store.services.themes.ZMThemeInfo
\store\services\themes\ZMThemeInfo.php at line 33

Class ZMThemeInfo

ZMObject
└─ZMThemeInfo

public class ZMThemeInfo
extends ZMObject

Theme info base class.

If a parent is set, configuration, layout and a few other settings will be merged.

Author:
DerManoMann
Version:
$Id: ZMThemeInfo.php 2694 2009-12-03 22:32:18Z dermanomann $

Fields inherited from org.zenmagick.core.ZMObject
properties_
Constructor Summary

ZMThemeInfo(ZMThemeInfo parent)

Create new instance.

Method Summary
string

getAuthor()

Get the theme author.

string

getDefaultLayout()

Get the default layout.

string

getDescription()

Get the theme description.

string

getErrorPage()

Get the error page.

string

getLayoutFor(string page)

Get the layout filename for the given page.

string

getName()

Get the theme name.

string

getPageEventHandler(string event, string page)

Get an event handler for a page.

int

getThemeId()

Get the theme id.

string

getVersion()

Get the theme version.

string

getViewsDir()

Get the views directory.

boolean

hasDefaultLayout()

Check if the theme has a default layout.

string

hasPageEventHandler(mixed event, string page, string even)

Check if a event handler exists for the given event and page.

void

setAuthor(string author)

Set the theme author.

void

setDefaultLayout(string name)

Set the default layout.

void

setDefaultPageEventHandler(string event, string handler)

Set the default page event handler.

void

setDescription(string description)

Set the theme description.

void

setErrorPage(string name)

Set the error page.

void

setLayout(string page, string name)

Set the layout for the given page.

void

setName(string name)

Set the theme name.

void

setPageEventHandler(string event, string page, string handler)

Set an event handler for a particular page.

void

setParent(ZMThemeInfo parent)

Set a parent theme info.

void

setThemeId(int themeId)

Set the theme id.

void

setVersion(string version)

Set the theme version.

void

setViewsDir(string dir)

Set the views directory.

Methods inherited from org.zenmagick.core.ZMObject
attachMethod, get, getAttachedMethods, getPropertyNames, set, singleton

Constructor Detail

\store\services\themes\ZMThemeInfo.php at line 48

ZMThemeInfo

public ZMThemeInfo(ZMThemeInfo parent)

Create new instance.

Parameters:
parent - Optional parent theme info instance.

Method Detail

\store\services\themes\ZMThemeInfo.php at line 130

getAuthor

public string getAuthor()

Get the theme author.

Returns:
The theme author.

\store\services\themes\ZMThemeInfo.php at line 179

getDefaultLayout

public string getDefaultLayout()

Get the default layout.

Returns:
The default layout name.

\store\services\themes\ZMThemeInfo.php at line 144

getDescription

public string getDescription()

Get the theme description.

Returns:
The theme description.

\store\services\themes\ZMThemeInfo.php at line 158

getErrorPage

public string getErrorPage()

Get the error page.

Returns:
The error page.

\store\services\themes\ZMThemeInfo.php at line 223

getLayoutFor

public string getLayoutFor(string page)

Get the layout filename for the given page.

Parameters:
page - The page.
Returns:
The layout name.

\store\services\themes\ZMThemeInfo.php at line 103

getName

public string getName()

Get the theme name.

Returns:
The theme name.

\store\services\themes\ZMThemeInfo.php at line 279

getPageEventHandler

public string getPageEventHandler(string event, string page)

Get an event handler for a page.

Parameters:
event - The event.
page - The page.
Returns:
The handler name or null.
Deprecated.

\store\services\themes\ZMThemeInfo.php at line 96

getThemeId

public int getThemeId()

Get the theme id.

Returns:
The theme id.

\store\services\themes\ZMThemeInfo.php at line 117

getVersion

public string getVersion()

Get the theme version.

Returns:
The theme version.

\store\services\themes\ZMThemeInfo.php at line 215

getViewsDir

public string getViewsDir()

Get the views directory.

Returns:
The views directory name.
Deprecated:
use ZMTheme::getViewsDir() instead

\store\services\themes\ZMThemeInfo.php at line 172

hasDefaultLayout

public boolean hasDefaultLayout()

Check if the theme has a default layout.

Returns:
true if a default layout exists, false if not.

\store\services\themes\ZMThemeInfo.php at line 267

hasPageEventHandler

public string hasPageEventHandler(mixed event, string page, string even)

Check if a event handler exists for the given event and page.

Parameters:
even - The event.
page - The page.
Returns:
The handler name or null.
Deprecated.

\store\services\themes\ZMThemeInfo.php at line 137

setAuthor

public void setAuthor(string author)

Set the theme author.

Parameters:
author - The theme author.

\store\services\themes\ZMThemeInfo.php at line 191

setDefaultLayout

public void setDefaultLayout(string name)

Set the default layout.

Parameters:
name - The default layout name.

\store\services\themes\ZMThemeInfo.php at line 240

setDefaultPageEventHandler

public void setDefaultPageEventHandler(string event, string handler)

Set the default page event handler.

Parameters:
event - The event.
handler - The handler name.
Deprecated.

\store\services\themes\ZMThemeInfo.php at line 151

setDescription

public void setDescription(string description)

Set the theme description.

Parameters:
description - The theme description.

\store\services\themes\ZMThemeInfo.php at line 165

setErrorPage

public void setErrorPage(string name)

Set the error page.

Parameters:
name - The error page.

\store\services\themes\ZMThemeInfo.php at line 199

setLayout

public void setLayout(string page, string name)

Set the layout for the given page.

Parameters:
page - The page name.
name - The layout name.

\store\services\themes\ZMThemeInfo.php at line 110

setName

public void setName(string name)

Set the theme name.

Parameters:
name - The theme name.

\store\services\themes\ZMThemeInfo.php at line 252

setPageEventHandler

public void setPageEventHandler(string event, string page, string handler)

Set an event handler for a particular page.

Parameters:
event - The event.
page - The page to configure.
handler - The event handler.
Deprecated.

\store\services\themes\ZMThemeInfo.php at line 76

setParent

public void setParent(ZMThemeInfo parent)

Set a parent theme info.

This is to allow to use the default theme info configuration.

Parameters:
parent - An optional parent theme info.

\store\services\themes\ZMThemeInfo.php at line 89

setThemeId

public void setThemeId(int themeId)

Set the theme id.

Parameters:
themeId - The new theme id.

\store\services\themes\ZMThemeInfo.php at line 123

setVersion

public void setVersion(string version)

Set the theme version.

Parameters:
version - The theme version.

\store\services\themes\ZMThemeInfo.php at line 207

setViewsDir

public void setViewsDir(string dir)

Set the views directory.

Parameters:
dir - The views directory name.
Deprecated:
no replacement

ZenMagick 0.9.8