Comments: on this page. Click to read or post your own.

Class BulkLoader_Result

Description
Description | Vars (details) | Methods (details)

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

  • author: Ingo Schommer, Silverstripe Ltd. (<firstname>@silverstripe.com)
  • todo: Refactor to support lazy-loaded DataObjectSets once they are implemented.

Located in /sapphire/dev/BulkLoader.php (line 240) 

Object
   |
   --BulkLoader_Result
Variable Summary
Description | Vars (details) | Methods (details)
array $created
array $deleted
array $updated
Method Summary
Description | Vars (details) | Methods (details)
void addCreated ($obj $obj, [$message $message = null])
void addDeleted ($obj $obj, [$message $message = null])
void addUpdated ($obj $obj, [$message $message = null])
int Count ()
DataObjectSet Created ()
int CreatedCount ()
DataObjectSet Deleted ()
int DeletedCount ()
DataObjectSet mapToDataObjectSet ($arr $arr)
DataObjectSet Updated ()
int UpdatedCount ()
Variables
Description | Vars (details) | Methods (details)
array $created = array() (line 253)
  • var: 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".
  • access: protected
  • example: example not found
array $deleted = array() (line 263)
array $updated = array() (line 258)

Inherited Variables

Inherited from Object

Object::$builtInMethods
 Object::$class
 Object::$classConstructed
 Object::$extensions
 Object::$extension_instances
 Object::$extraMethods
 Object::$extraStatics
 Object::$statics
 Object::$static_cached
Methods
Description | Vars (details) Methods (details)
addCreated (line 324)
  • access: public
void addCreated ($obj $obj, [$message $message = null])
  • $obj $obj: DataObject
  • $message $message: string
addDeleted (line 348)
  • access: public
void addDeleted ($obj $obj, [$message $message = null])
  • $obj $obj: DataObject
  • $message $message: string
addUpdated (line 336)
  • access: public
void addUpdated ($obj $obj, [$message $message = null])
  • $obj $obj: DataObject
  • $message $message: string
Count (line 271)

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

  • access: public
int Count ()
Created (line 302)

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

  • access: public
DataObjectSet Created ()
CreatedCount (line 278)
  • access: public
int CreatedCount ()
Deleted (line 316)
  • access: public
DataObjectSet Deleted ()
DeletedCount (line 292)
  • access: public
int DeletedCount ()
mapToDataObjectSet (line 360)
  • access: protected
DataObjectSet mapToDataObjectSet ($arr $arr)
  • $arr $arr: Array containing ID and ClassName maps
Updated (line 309)
  • access: public
DataObjectSet Updated ()
UpdatedCount (line 285)
  • access: public
int UpdatedCount ()

Inherited Methods

Inherited From Object

Object::__construct()
Object::addMethodsFrom()
Object::addStaticVars()
Object::addWrapperMethod()
Object::add_extension()
Object::allMethodNames()
Object::buildMethodList()
Object::cacheToFile()
Object::cacheToFileWithArgs()
Object::create()
Object::createMethod()
Object::defineMethods()
Object::exists()
Object::extend()
Object::extInstance()
Object::getCustomClass()
Object::hasExtension()
Object::hasMethod()
Object::invokeWithExtensions()
Object::is_a()
Object::loadCache()
Object::parentClass()
Object::sanitiseCachename()
Object::saveCache()
Object::set_stat()
Object::set_uninherited()
Object::stat()
Object::strong_create()
Object::uninherited()
Object::useCustomClass()
Object::__call()
Object::__toString()
blog comments powered by Disqus

Documentation generated on Sun, 19 Oct 2008 06:38:32 +1300 by phpDocumentor 1.3.2