CSMigrationResult
in package
Defines an object to store the result of the migration script.
It provides getter method to receive information of the migration result.
Tags
Table of Contents
- __construct() : mixed
- Initializes a migration result object.
- getErrorCode() : int
- Returns the error code.
- getErrorMessage() : string
- Returns the error message.
- getResultType() : int
- Returns the result type of the migration result.
- hasError() : bool
- Checks whether an error occurred while executing the migration script,
- setError() : void
- Sets an error message and code to the result.
Methods
__construct()
Initializes a migration result object.
public
__construct([int $iResultType = CSMigration::RESULT_TYPE_SUCCESS ]) : mixed
Parameters
- $iResultType : int = CSMigration::RESULT_TYPE_SUCCESS
-
The result type of the migration result. Please see the constants CSMigration::RESULT_TYPE_*
Tags
Return values
mixed —getErrorCode()
Returns the error code.
public
getErrorCode() : int
Tags
Return values
int —getErrorMessage()
Returns the error message.
public
getErrorMessage() : string
Tags
Return values
string —getResultType()
Returns the result type of the migration result.
public
getResultType() : int
Please see the constants CSMigration::RESULT_TYPE_* for possible values.
Tags
Return values
int —hasError()
Checks whether an error occurred while executing the migration script,
public
hasError() : bool
Tags
Return values
bool —setError()
Sets an error message and code to the result.
public
setError(string $sMessage, int $iCode) : void
Parameters
- $sMessage : string
-
The error message for the result.
- $iCode : int
-
The error code for the result.