ZenMagick 0.9.10


zenmagick.store.admin.installation\ZMInstallationPatch
installation\ZMInstallationPatch.php at line 30

Class ZMInstallationPatch

ZMObject
└─ZMInstallationPatch

public class ZMInstallationPatch
extends ZMObject

Single installation patch.

Author:
DerManoMann

Field Summary
mixed

$id_

mixed

$messages_

Fields inherited from org.zenmagick.core\ZMObject
properties_
Method Summary
void

__construct(string id)

Create new patch.

boolean

canUndo()

Check if this patch supports undo.

array

dependsOn()

Returns a list of other patches it depends on.

string

getGroupId()

Get the patch group id.

string

getId()

Get the patch id.

array

getMessages()

Get optional installation messages.

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 org.zenmagick.core\ZMObject
__construct, attachMethod, get, getAttachedMethods, getProperties, getPropertyNames, set, singleton

Field Detail

installation\ZMInstallationPatch.php at line 31

id_

public mixed $id_ = null

installation\ZMInstallationPatch.php at line 32

messages_

public mixed $messages_ = null

Method Detail

installation\ZMInstallationPatch.php at line 40

__construct

public void __construct(string id)

Create new patch.

Parameters:
id - Id of the patch.

installation\ZMInstallationPatch.php at line 133

canUndo

public boolean canUndo()

Check if this patch supports undo.

Returns:
true if undo is supported, false if not.

installation\ZMInstallationPatch.php at line 67

dependsOn

public array dependsOn()

Returns a list of other patches it depends on.

Returns:
List of patch names.

installation\ZMInstallationPatch.php at line 93

getGroupId

public string getGroupId()

Get the patch group id.

Returns:
The patch group id.

installation\ZMInstallationPatch.php at line 59

getId

public string getId()

Get the patch id.

Returns:
The id of the patch.

installation\ZMInstallationPatch.php at line 113

getMessages

public array getMessages()

Get optional installation messages.

Returns:
List of ZMMessage instances.

installation\ZMInstallationPatch.php at line 104

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\ZMInstallationPatch.php at line 75

isOpen

public boolean isOpen()

Checks if this patch can still be applied.

Returns:
true if this patch can still be applied.

installation\ZMInstallationPatch.php at line 84

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\ZMInstallationPatch.php at line 124

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\ZMInstallationPatch.php at line 142

undo

public boolean undo()

Revert the patch.

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

ZenMagick 0.9.10