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

Export

class Export

Properties

protectedarray $ids IDs of the models of this export.

Methods

__construct(array$ids)

Create a new instance.

string
getArchive()

Generate the export archive file and return the temporary file path.

array|string
getContent()

Get the content of the export file. If a string, it is the path to the temporary file containing the content (like a CSV).

string
getFileName()

Get the name of the export file.

array
getAdditionalExports()

Get additional exports that should be included in the export archive.

addIds(array$ids)

Add more model IDs to this export.

addToZip(ZipArchive$zip)

Add the file of this report to a zip.

cleanUp()

Clean up any temporary files.

Details

at line21
__construct(array$ids)

Create a new instance.

Parameters

array $ids Model IDs

at line31
string getArchive()

Generate the export archive file and return the temporary file path.

Return Value

string

at line60
array|string getContent()

Get the content of the export file. If a string, it is the path to the temporary file containing the content (like a CSV).

Return Value

array|string

at line70
string getFileName()

Get the name of the export file.

Return Value

string

at line80
array getAdditionalExports()

Get additional exports that should be included in the export archive.

Return Value

array

at line90
addIds(array$ids)

Add more model IDs to this export.

Parameters

array $ids

at line100
protected addToZip(ZipArchive$zip)

Add the file of this report to a zip.

Parameters

ZipArchive $zip

at line113
protected cleanUp()

Clean up any temporary files.