class BulkLoader_Result implements Countable (View source)

Encapsulates the result of a BulkLoader import (usually through the BulkLoader->processAll() method).

Traits

A class that can be instantiated or replaced via DI

Properties

protected array $created

Stores a map of ID and ClassNames which can be reconstructed to DataObjects.

protected array $updated

see $created

protected array $deleted
protected $lastChange

Stores the last change.

Methods

public static 
create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

public static 
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

public
int
Count()

Returns the count of all objects which were created or updated.

public
int
CreatedCount()

No description

public
int
UpdatedCount()

No description

public
int
DeletedCount()

No description

public
Created()

Returns all created objects. Each object might contain specific importer feedback in the "_BulkLoaderMessage" property.

public
Updated()

No description

public
Deleted()

No description

public
LastChange()

Returns the last change.

public
addCreated($obj, $message = null)

No description

public
addUpdated($obj, $message = null)

No description

public
addDeleted($obj, $message = null)

No description

protected
mapToArrayList(array $arr)

No description

public
merge(BulkLoader_Result $other)

Merges another BulkLoader_Result into this one.

Details

static Injectable create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();

Parameters

mixed ...$args

Return Value

Injectable

static Injectable singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

int Count()

Returns the count of all objects which were created or updated.

Return Value

int

int CreatedCount()

No description

Return Value

int

int UpdatedCount()

No description

Return Value

int

int DeletedCount()

No description

Return Value

int

ArrayList Created()

Returns all created objects. Each object might contain specific importer feedback in the "_BulkLoaderMessage" property.

Return Value

ArrayList

ArrayList Updated()

No description

Return Value

ArrayList

ArrayList Deleted()

No description

Return Value

ArrayList

LastChange()

Returns the last change.

It is in the same format as $created but with an additional key, "ChangeType", which will be set to one of 3 strings: "created", "updated", or "deleted"

addCreated($obj, $message = null)

No description

Parameters

$obj DataObject
$message string

addUpdated($obj, $message = null)

No description

Parameters

$obj DataObject
$message string

addDeleted($obj, $message = null)

No description

Parameters

$obj DataObject
$message string

protected ArrayList mapToArrayList(array $arr)

No description

Parameters

array $arr

containing ID and ClassName maps

Return Value

ArrayList

merge(BulkLoader_Result $other)

Merges another BulkLoader_Result into this one.

Parameters

BulkLoader_Result $other