class BulkLoader_Result implements Countable (View source)

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

Traits

A class that can be instantiated or replaced via DI

Methods

static Injectable
create(array ...$args)

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

static Injectable
singleton(string $class = null)

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

int
Count()

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

int
CreatedCount()

No description

int
UpdatedCount()

No description

int
DeletedCount()

No description

Created()

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

Updated()

No description

Deleted()

No description

LastChange()

Returns the last change.

addCreated($obj, $message = null)

No description

addUpdated($obj, $message = null)

No description

addDeleted($obj, $message = null)

No description

merge(BulkLoader_Result $other)

Merges another BulkLoader_Result into this one.

Details

static Injectable create(array ...$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

array ...$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()

Return Value

int

int UpdatedCount()

Return Value

int

int DeletedCount()

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()

Return Value

ArrayList

ArrayList Deleted()

Return Value

ArrayList

LastChange()

Returns the last change.

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

addCreated($obj, $message = null)

Parameters

$obj

DataObject

$message

string

addUpdated($obj, $message = null)

Parameters

$obj

DataObject

$message

string

addDeleted($obj, $message = null)

Parameters

$obj

DataObject

$message

string

merge(BulkLoader_Result $other)

Merges another BulkLoader_Result into this one.

Parameters

BulkLoader_Result $other