Store
in package
Persist cc_import / cc_import_log / cc_object rows.
Session is the matcher; this writes what a finished (or in-flight) session recorded. import_id on cc_object is last-run, not ownership.
Table of Contents
Methods
- deleteObjectsForContext() : void
- Drop matcher rows for this course so the next import is treated as new.
- finishImport() : void
- insertLog() : array<string, mixed>
- insertObject() : array<string, mixed>
- loadImport() : array<string, mixed>|null
- loadObjects() : array<int, array<string, mixed>>
- markDiverged() : bool
- persistSession() : mixed
- startImport() : array<string, mixed>
- touchObjectImport() : void
- Touch last-import on a duplicate match (object already exists).
- decodeObjectRow() : array<string, mixed>
- encodeJson() : string|null
- nullableString() : string|null
Methods
deleteObjectsForContext()
Drop matcher rows for this course so the next import is treated as new.
public
static deleteObjectsForContext(int $context_id) : void
Parameters
- $context_id : int
finishImport()
public
static finishImport(int $import_id, string $status[, array<string, int> $counts = array() ]) : void
Parameters
- $import_id : int
- $status : string
- $counts : array<string, int> = array()
insertLog()
public
static insertLog(int $import_id, array<string, mixed> $row) : array<string, mixed>
Parameters
- $import_id : int
- $row : array<string, mixed>
Return values
array<string, mixed>insertObject()
public
static insertObject(array<string, mixed> $row) : array<string, mixed>
Parameters
- $row : array<string, mixed>
Return values
array<string, mixed>loadImport()
public
static loadImport(int $import_id) : array<string, mixed>|null
Parameters
- $import_id : int
Return values
array<string, mixed>|nullloadObjects()
public
static loadObjects(int $context_id) : array<int, array<string, mixed>>
Parameters
- $context_id : int
Return values
array<int, array<string, mixed>>markDiverged()
public
static markDiverged(int $object_id) : bool
Parameters
- $object_id : int
Return values
boolpersistSession()
public
static persistSession(Session $session[, array<string|int, mixed> $knownObjectIds = array() ]) : mixed
Parameters
- $session : Session
- $knownObjectIds : array<string|int, mixed> = array()
startImport()
public
static startImport(int $context_id, int $user_id[, array<string, mixed> $meta = array() ]) : array<string, mixed>
Parameters
- $context_id : int
- $user_id : int
- $meta : array<string, mixed> = array()
Return values
array<string, mixed>touchObjectImport()
Touch last-import on a duplicate match (object already exists).
public
static touchObjectImport(int $object_id, int $import_id) : void
Parameters
- $object_id : int
- $import_id : int
decodeObjectRow()
private
static decodeObjectRow(array<string, mixed> $row) : array<string, mixed>
Parameters
- $row : array<string, mixed>
Return values
array<string, mixed>encodeJson()
private
static encodeJson(mixed $value) : string|null
Parameters
- $value : mixed
Return values
string|nullnullableString()
private
static nullableString(mixed $value) : string|null
Parameters
- $value : mixed