class UserExport extends Export

Properties

protected array $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.

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

in Export at line 21
__construct(array $ids)

Create a new instance.

Parameters

array $ids

Model IDs

in Export at line 31
string getArchive()

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

Return Value

string

at line 12
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 line 29
string getFileName()

Get the name of the export file.

Return Value

string

in Export at line 80
array getAdditionalExports()

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

Return Value

array

in Export at line 90
addIds(array $ids)

Add more model IDs to this export.

Parameters

array $ids

in Export at line 100
protected addToZip(ZipArchive $zip)

Add the file of this report to a zip.

Parameters

ZipArchive $zip

in Export at line 113
protected cleanUp()

Clean up any temporary files.