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

VolumeExport

class VolumeExport extendsExport

Properties

protectedarray $ids IDs of the models of this export. from Export

Methods

__construct(array$ids)

Create a new instance.

from Export
string
getArchive()

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

from Export
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.

from Export
addToZip(ZipArchive$zip)

Add the file of this report to a zip.

from Export
cleanUp()

Clean up any temporary files.

from Export

Details

inExportat line21
__construct(array$ids)

Create a new instance.

Parameters

array $ids Model IDs

inExportat line31
string getArchive()

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

Return Value

string

at line13
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 line35
string getFileName()

Get the name of the export file.

Return Value

string

at line43
array getAdditionalExports()

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

Return Value

array

inExportat line90
addIds(array$ids)

Add more model IDs to this export.

Parameters

array $ids

inExportat line100
protected addToZip(ZipArchive$zip)

Add the file of this report to a zip.

Parameters

ZipArchive $zip

inExportat line113
protected cleanUp()

Clean up any temporary files.