1. class
  2. Biigle
  3. \
  4. Modules
  5. \
  6. Sync
  7. \
  8. Support
  9. \
  10. Import
  11. \
  12. Import

Import

class Import

Properties

protectedstring $path Path to the directory with the import files.

Methods

__construct(string$path)

Create a new instance.

bool
filesMatch()

Check if this import matches to the given import files.

validateFiles()

Check if the files of this import are valid.

array
expectedFiles()

The files expected by this import.

array
files()

Get the basename of each file of this 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.

expectColumnsInCsv(string$file,array$expectation)

Validates a CSV file to contain the expected columns.

Collection
collectJson(string$file)

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

Details

at line23
__construct(string$path)

Create a new instance.

Parameters

string $path Path to the directory with the import files.

at line33
bool filesMatch()

Check if this import matches to the given import files.

Return Value

bool

at line48
validateFiles()

Check if the files of this import are valid.

Exceptions

Exception If any of the import files is invalid.

at line60
protectedarray expectedFiles()

The files expected by this import.

Return Value

array

at line70
protectedarray files()

Get the basename of each file of this import.

Return Value

array

at line84
protected validateFile(string$basename)

Validate a file of this import.

Parameters

string $basename Basename of the file.

Exceptions

Exception If the file is invalid.

at line98
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 If keys are missing.

at line124
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 If columns are missing.

at line148
protectedCollection 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