All Data Structures Functions Variables Pages
Public Member Functions | Static Public Member Functions | Data Fields
ImportRowDataResultsUtil Class Reference

Public Member Functions

 __construct ($id)
 
 getId ()
 
 addMessage ($message)
 
 addMessages ($messages)
 
 getMessages ()
 
 setStatusToUpdated ()
 
 setStatusToCreated ()
 
 setStatusToError ()
 
 getStatus ()
 

Static Public Member Functions

static getStatusLabelByType ($type)
 
static getStatusLabelAndVisualIdentifierContentByType ($type)
 
static getCreatedCount ($tableName)
 
static getUpdatedCount ($tableName)
 
static getErrorCount ($tableName)
 

Data Fields

const UPDATED = 1
 
const CREATED = 2
 
const ERROR = 3
 

Detailed Description

Helper class for working with beans from a temporary table used by the import module.

Definition at line 40 of file ImportRowDataResultsUtil.php.

Constructor & Destructor Documentation

__construct (   $id)

Given an identifier of the row, set this identifier as the id.

Parameters
integer$id

Definition at line 123 of file ImportRowDataResultsUtil.php.

Member Function Documentation

getId ( )
Returns
The row identifier

Definition at line 132 of file ImportRowDataResultsUtil.php.

addMessage (   $message)

Given a message, add it to the messages collection.

Parameters
string$message

Definition at line 141 of file ImportRowDataResultsUtil.php.

addMessages (   $messages)

Set an array of messages for a row.

Parameters
array$messages

Definition at line 151 of file ImportRowDataResultsUtil.php.

getMessages ( )
Returns
An array of messages.

Definition at line 162 of file ImportRowDataResultsUtil.php.

setStatusToUpdated ( )

Sets the status to created, which should be used when a row was successfully updated into an existing model.

Definition at line 171 of file ImportRowDataResultsUtil.php.

setStatusToCreated ( )

Sets the status to created, which should be used when a row was successfully made into a new model.

Definition at line 179 of file ImportRowDataResultsUtil.php.

setStatusToError ( )

Sets the status to created, which should be used when a row had an error when trying to either update or create a model.

Definition at line 189 of file ImportRowDataResultsUtil.php.

getStatus ( )
Returns
status.

Definition at line 197 of file ImportRowDataResultsUtil.php.

static getCreatedCount (   $tableName)
static
Parameters
string$tableName
Returns
int

Definition at line 206 of file ImportRowDataResultsUtil.php.

static getUpdatedCount (   $tableName)
static
Parameters
string$tableName
Returns
int

Definition at line 215 of file ImportRowDataResultsUtil.php.

static getErrorCount (   $tableName)
static
Parameters
string$tableName
Returns
int

Definition at line 224 of file ImportRowDataResultsUtil.php.


The documentation for this class was generated from the following file:
Generated on Sat Jun 6 2020 07:10:51