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

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

installation\patches\file\ZMEmailPatch.php at line 31

Class ZMEmailPatch

ZMObject
    └─ZMInstallationPatch
       └─ZMFilePatch
          └─ZMEmailPatch

public class ZMEmailPatch
extends ZMFilePatch

Patch to replace zen_mail for supported email types.

Author:: DerManoMann

Field Summary
mixed	$fktFilesCfg_

Method Summary
void	__construct(string id) Create new instance.
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

Field Detail

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

fktFilesCfg_

public mixed $fktFilesCfg_ = array(...)

Method Detail

installation\patches\file\ZMEmailPatch.php at line 38

__construct

public void __construct(string id)

Create new instance.

Parameters:: id - Id of the patch.

installation\patches\file\ZMEmailPatch.php at line 75

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\ZMEmailPatch.php at line 55

isOpen

public boolean isOpen()

Checks if this patch can still be applied.

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

installation\patches\file\ZMEmailPatch.php at line 64

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\ZMEmailPatch.php at line 86

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\ZMEmailPatch.php at line 107

undo

public boolean undo()

Revert the patch.

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

Frames No frames