1. class
  2. Biigle
  3. \
  4. Services
  5. \
  6. Import
  7. \
  8. UserImport

UserImport

class UserImport extends Import

Properties

protected string $path

Path to the directory with the import files.

 from  Import
protected Collection|null $importUsers

Caches the decoded user import file.

Methods

__construct(string $path)

Create a new instance.

from  Import
bool
filesMatch()

Check if this import matches to the given import files.

from  Import
validateFiles()

Check if the files of this import are valid.

from  Import
array
expectedFiles()

The files expected by this import.

array
files()

Get the basename of each file of this import.

from  Import
validateFile(string $basename)

Validate a file of this import.

expectKeysInJson(string $file, array $expectation, bool $array = true)

Validates a JSON file to contain an array of objects, each of which has all the expected keys.

from  Import
expectColumnsInCsv(string $file, array $expectation)

Validates a CSV file to contain the expected columns.

from  Import
Collection
collectJson(string $file)

Read a JSON file containing an array and wrap it in a Laravel collection.

from  Import
array
perform(array $only = null)

Perform the import.

Collection
getImportUsers()

Get the contents of the user import file.

Collection
getUserImportCandidates()

Get users that can be imported.

Collection
getConflicts()

Get import users whose email address matches with an existing user but the UUID doesn't.

Details

in Import at line 23
__construct(string $path)

Create a new instance.

Parameters

string $path

Path to the directory with the import files.

in Import at line 33
bool filesMatch()

Check if this import matches to the given import files.

Return Value

bool

in Import at line 48
validateFiles()

Check if the files of this import are valid.

Exceptions

Exception

at line 96
protected array expectedFiles()

The files expected by this import.

Return Value

array

in Import at line 70
protected array files()

Get the basename of each file of this import.

Return Value

array

at line 104
protected validateFile(string $basename)

Validate a file of this import.

Parameters

string $basename

Basename of the file.

Exceptions

Exception

in Import at line 96
protected expectKeysInJson(string $file, array $expectation, bool $array = true)

Validates a JSON file to contain an array of objects, each of which has all the expected keys.

Parameters

string $file

File name under $this->path
array $expectation

Expected keys.
bool $array

Specifies if the file to validate contains an array or not.

Exceptions

Exception

in Import at line 122
protected expectColumnsInCsv(string $file, array $expectation)

Validates a CSV file to contain the expected columns.

Parameters

string $file

File name under $this->path
array $expectation

Expected columns.

Exceptions

Exception

in Import at line 146
protected Collection collectJson(string $file)

Read a JSON file containing an array and wrap it in a Laravel collection.

Parameters

string $file

File name under $this->path

Return Value

Collection

at line 26
array perform(array $only = null)

Perform the import.

Parameters

array $only

IDs of the import candidates to limit the import to.

Return Value

array

Maps external user IDs (from the import file) to user IDs of the database.

Exceptions

UnprocessableEntityHttpException

at line 70
Collection getImportUsers()

Get the contents of the user import file.

Return Value

Collection

at line 84
Collection getUserImportCandidates()

Get users that can be imported.

Return Value

Collection

at line 126
protected Collection getConflicts()

Get import users whose email address matches with an existing user but the UUID doesn't.

Return Value

Collection