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

zenmagick.store.admin.installation.patches.file\ZMSideboxDummyPatch

installation\patches\file\ZMSideboxDummyPatch.php at line 32

Class ZMSideboxDummyPatch

ZMObject
    └─ZMInstallationPatch
       └─ZMFilePatch
          └─ZMSideboxDummyPatch

public class ZMSideboxDummyPatch
extends ZMFilePatch

Patch to create dummy sidebox files for zen-cart.

Author:: DerManoMann

Method Summary
void	__construct(string id) Create new instance.
string	getGroupId() Get the patch group id.
protected void	getMissingZCSideboxes() Builds a list of all ZenMagick theme sideboxes that do not have zen-cart sidebox dummies.
string	getPreconditionsMessage() Get the precondition message.
boolean	isOpen() Checks if this patch can still be applied.
boolean	isReady() Checks if this patch is ready to be applied.
boolean	patch(boolean force) Execute this patch.
boolean	undo() Revert the patch.

Methods inherited from zenmagick.store.admin.installation.patches\ZMFilePatch
__construct, getFileLines, getGroupId, isFilesFktOpen, patchFilesFkt, putFileLines, readFile, undoFilesFkt, writeFile

Methods inherited from zenmagick.store.admin.installation\ZMInstallationPatch
__construct, canUndo, dependsOn, getGroupId, getId, getMessages, getPreconditionsMessage, isOpen, isReady, patch, undo

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

Method Detail

installation\patches\file\ZMSideboxDummyPatch.php at line 37

__construct

public void __construct(string id)

Create new instance.

Parameters:: id - Id of the patch.

installation\patches\file\ZMSideboxDummyPatch.php at line 72

getGroupId

public string getGroupId()

Get the patch group id.

Returns:: The patch group id.

installation\patches\file\ZMSideboxDummyPatch.php at line 164

getMissingZCSideboxes

protected void getMissingZCSideboxes()

Builds a list of all ZenMagick theme sideboxes that do not have zen-cart sidebox dummies. return array List of sideboxes that need zen-cart dummies.

installation\patches\file\ZMSideboxDummyPatch.php at line 83

getPreconditionsMessage

public string getPreconditionsMessage()

Get the precondition message.

This will return an empty string when isReady() returns true.

Returns:: The preconditions message or an empty string.

installation\patches\file\ZMSideboxDummyPatch.php at line 54

isOpen

public boolean isOpen()

Checks if this patch can still be applied.

Returns:: true if this patch can still be applied.

installation\patches\file\ZMSideboxDummyPatch.php at line 63

isReady

public boolean isReady()

Checks if this patch is ready to be applied.

Returns:: true if this patch is ready and all preconditions are met.

installation\patches\file\ZMSideboxDummyPatch.php at line 94

patch

public boolean patch(boolean force)

Execute this patch.

Parameters:: force - If set to true it will force patching even if disabled as per settings.
Returns:: true if patching was successful, false if not.

installation\patches\file\ZMSideboxDummyPatch.php at line 127

undo

public boolean undo()

Revert the patch.

Returns:: true if patching was successful, false if not.

Frames No frames