Class BulkLoader_Result

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

Object

BulkLoader_Result

Package: cms\bulkloading
Author: Ingo Schommer, Silverstripe Ltd. (<firstname>@silverstripe.com)
Located at sapphire/dev/BulkLoader.php

Methods summary

`public integer`	# `Count( )` Returns the count of all objects which were created or updated. Returns the count of all objects which were created or updated. Returns `integer` int
`public integer`	# `CreatedCount( )` Returns `integer` int
`public integer`	# `UpdatedCount( )` Returns `integer` int
`public integer`	# `DeletedCount( )` Returns `integer` int
`public DataObjectSet`	# `Created( )` Returns all created objects. Each object might contain specific importer feedback in the "_BulkLoaderMessage" property. Returns all created objects. Each object might contain specific importer feedback in the "_BulkLoaderMessage" property. Returns `DataObjectSet` DataObjectSet
`public DataObjectSet`	# `Updated( )` Returns `DataObjectSet` DataObjectSet
`public DataObjectSet`	# `Deleted( )` Returns `DataObjectSet` DataObjectSet
`public`	# `LastChange( )` Returns the last change. It is in the same format as `BulkLoader_Result::$created` but with an additional key, "ChangeType", which will be set to one of 3 strings: "created", "updated", or "deleted" Returns the last change. It is in the same format as `BulkLoader_Result::$created` but with an additional key, "ChangeType", which will be set to one of 3 strings: "created", "updated", or "deleted"
`public`	# `addCreated( mixed $obj, mixed $message = null )` Parameters `$obj` $obj DataObject `$message` $message string
`public`	# `addUpdated( mixed $obj, mixed $message = null )` Parameters `$obj` $obj DataObject `$message` $message string
`public`	# `addDeleted( mixed $obj, mixed $message = null )` Parameters `$obj` $obj DataObject `$message` $message string
`protected DataObjectSet`	# `mapToDataObjectSet( mixed $arr )` Parameters `$arr` $arr Array containing ID and ClassName maps Returns `DataObjectSet` DataObjectSet

Methods inherited from Object

__call(), __construct(), __toString(), __wakeup(), addMethodsFrom(), addStaticVars(), addWrapperMethod(), add_extension(), add_static_var(), allMethodNames(), cacheToFile(), cacheToFileWithArgs(), clearCache(), combined_static(), create(), createMethod(), create_from_string(), defineMethods(), exists(), extInstance(), extend(), getCustomClass(), getExtensionInstance(), getExtensionInstances(), get_extensions(), get_static(), hasExtension(), hasMethod(), has_extension(), invokeWithExtensions(), is_a(), loadCache(), parentClass(), parse_class_spec(), remove_extension(), sanitiseCachename(), saveCache(), set_stat(), set_static(), set_uninherited(), stat(), strong_create(), uninherited(), uninherited_static(), useCustomClass()

Magic methods summary

Properties summary

`protected array`	`$created`	# Stores a map of ID and ClassNames which can be reconstructed to DataObjects. As imports can get large we just store enough information to reconstruct the objects on demand. Optionally includes a status message specific to the import of this object. This information is stored in a custom object property "_BulkLoaderMessage". Example: array(array('ID'=>1, 'ClassName'=>'Member', 'Message'=>'Updated existing record based on ParentID relation')) Stores a map of ID and ClassNames which can be reconstructed to DataObjects. As imports can get large we just store enough information to reconstruct the objects on demand. Optionally includes a status message specific to the import of this object. This information is stored in a custom object property "_BulkLoaderMessage". Example: array(array('ID'=>1, 'ClassName'=>'Member', 'Message'=>'Updated existing record based on ParentID relation'))
`protected array`	`$updated`	# (see `BulkLoader_Result::$created`) (see `BulkLoader_Result::$created`)
`protected array`	`$deleted`	# (see `BulkLoader_Result::$created`) (see `BulkLoader_Result::$created`)
`protected array`	`$lastChange`	# Stores the last change. It is in the same format as `BulkLoader_Result::$created` but with an additional key, "ChangeType", which will be set to one of 3 strings: "created", "updated", or "deleted" Stores the last change. It is in the same format as `BulkLoader_Result::$created` but with an additional key, "ChangeType", which will be set to one of 3 strings: "created", "updated", or "deleted"

Properties inherited from Object

$class, $extension_instances, $extensions

Packages

Classes

Class BulkLoader_Result

Methods summary

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Parameters

Parameters

Parameters

Returns

Methods inherited from Object

Magic methods summary

Properties summary

Properties inherited from Object