Summary: Field | Method | Constr Detail: Field | Method | Constr

org.zenmagick.plugins.types.ZMBoxPlugin

Class ZMBoxPlugin

ZMObject
  |
  +--ZMPlugin
       |
       +--ZMBoxPlugin

public class ZMBoxPlugin
extends ZMPlugin

(Side-)box plugin.

Author:: DerManoMann
Version:: $Id: ZMBoxPlugin.php 2201 2009-05-05 01:37:21Z dermanomann $

Fields inherited from org.zenmagick.plugins.ZMPlugin
KEY_ENABLED_SUFFIX, KEY_ORDER_SUFFIX, KEY_PREFIX, LP_ALL, LP_FOLDER, LP_NONE, LP_PLUGIN, SCOPE_ADMIN, SCOPE_ALL, SCOPE_STORE

Fields inherited from org.zenmagick.ZMObject
properties_

Constructor Summary
ZMBoxPlugin(string title, string description, string version) Create new plugin.

Constructor Summary

ZMBoxPlugin(string title, string description, string version)

Create new plugin.

Method Summary
void	createBoxes() Create zen-cart dummy sideboxes plus default boxes for the default theme.
string	getBoxContents(mixed id) Get the contents for the given box id.
int	getBoxIndex(mixed id) Get the index from the given box id.
array	getBoxNames() Get the ids/names of the boxes supported by this plugin.
void	install() Install this plugin.
void	remove(boolean keepSettings) Remove this plugin.
void	removeBoxes() Remove zen-cart dummy sideboxes plus default boxes for the default theme.

Methods inherited from org.zenmagick.plugins.ZMPlugin
addConfigValue, addMenuItem, get, getConfigPath, getConfigValues, getDescription, getGlobal, getId, getKeys, getLoaderPolicy, getMessages, getName, getPluginDir, getScope, getSortOrder, getType, getVersion, init, install, isEnabled, isInstalled, isTraditional, pluginURL, remove, set, setKeys, setLoaderPolicy, setPluginDir, setPreferredSortOrder, setScope, setSortOrder, setTraditional, setType, zcoSubscribe, zcoUnsubscribe

Methods inherited from org.zenmagick.plugins.ZMPlugin

addConfigValue, addMenuItem, get, getConfigPath, getConfigValues, getDescription, getGlobal, getId, getKeys, getLoaderPolicy, getMessages, getName, getPluginDir, getScope, getSortOrder, getType, getVersion, init, install, isEnabled, isInstalled, isTraditional, pluginURL, remove, set, setKeys, setLoaderPolicy, setPluginDir, setPreferredSortOrder, setScope, setSortOrder, setTraditional, setType, zcoSubscribe, zcoUnsubscribe

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

Constructor Detail

ZMBoxPlugin

public ZMBoxPlugin(string title, string description, string version)

Create new plugin.

Parameters:: title - The title.; description - The description.; version - The version.

Method Detail

createBoxes

public void createBoxes()

Create zen-cart dummy sideboxes plus default boxes for the default theme. /

getBoxContents

public string getBoxContents(mixed id)

Get the contents for the given box id.

Returns:: Contents for the box implementation.

getBoxIndex

public int getBoxIndex(mixed id)

Get the index from the given box id.

This is assuming that the index is the suffix, separated by '_'.

Returns:: The index or 0.

getBoxNames

public array getBoxNames()

Get the ids/names of the boxes supported by this plugin.

Returns:: List of box names.

install

public void install()

Install this plugin. /

remove

public void remove(boolean keepSettings)

Remove this plugin. /

Parameters:: keepSettings - If set to true, the settings will not be removed; default is false.

removeBoxes

public void removeBoxes()

Remove zen-cart dummy sideboxes plus default boxes for the default theme. /

Frames No frames