Exports

An Omeka S module for exporting assets.

Installation

Follow these instructions on how to install the module. On the module configuration page you must set an "Exports directory path". This is the path to the directory where your exports will be built. The path must exist and be writable by the web server.

Export

To export assets, click on the "Exports" link in the side navigation, click on the "Create an export" button, select what you would like to export, configure export options, and initiate the export job by clicking on the "Begin export" button. You can check on the status of the export job by refreshing the page or in the "Details" sidebar.

Once the export job is complete, all exported assets will be available for download within one ZIP file. The download link is available by clicking on the "Download" icon in the export row, or in the "Details" sidebar.

This module comes with one exporter:

• Resources: Export a file containing data about selected resources (CSV or JSON-LD)

The exports browse page contains paginated data about all exports. Each row contains icons that do certain things when clicked:

• "Download": Download the export ZIP file, available once the export job is complete
• "Re-export": Open the export form, populated with the specific configuration options
• "Delete": Delete the export resouce, the export ZIP file, and any leftover server artifacts
• "Details": View the details sidebar, which contains detailed information about the export

For developers

Adding custom exporters

Modules can add custom exporters by registering them as services in module configuration under [exports_module][exporters]. For example, if you want to register a "MyExporter" exporter for your "MyModule" module:

'exports_module' => [
    'exporters' => [
        'invokables' => [
            'my_module_exporter' => \MyModule\Exporter\MyExporter::class,
        ],
    ],
],

The MyExporter class must implement \Exports\Exporter\ExporterInterface:

namespace MyModule\Exporter;

use Exports\Exporter\ExporterInterface;
use Exports\Job\ExportJob;
use Laminas\Form\Fieldset;


class MyExporter implements ExporterInterface
{
    public function getLabel(): string
    {
        return 'My Module Exporter'; // @translate
    }
    public function getDescription(): ?string
    {
        return 'Export text.'; // @translate
    }
    public function prepareForm(PhpRenderer $view): void
    {
        $view->headScript()->appendFile($view->assetUrl('js/my-exporter-form.js', 'MyModule'));
    }
    public function addElements(Fieldset $fieldset): void
    {
        $fieldset->add([
            'type' => 'textarea',
            'name' => 'text',
            'options' => [
                'label' => 'Text', // @translate
            ],
        ]);
    }
    public function export(ExportJob $job): void
    {
        $export = $job->getExport();
        file_put_contents(
            sprintf('%s/%s.txt', $job->getExportDirectoryPath(), $export->name()),
            $export->dataValue('text')
        );
    }
}

If your exporter requires configuration, add form elements to the configuration form using ExporterInterface::addElements(). If your configuration form needs styling or scripting, use ExporterInterface::prepareForm() to append the needed files.

ExporterInterface::export() is where you do the actual export. Prior to calling this method, the export job will create a temporary directory where you should place all exported files and directories. Use $job->getExportDirectoryPath() to get the path to this directory. After work is done, the export job will create the export ZIP file, copy the file to Omeka storage, and delete any leftover server artifacts.

Extending the Resources exporter (CSV)

The Resources exporter allows modules to add columns to a CSV file using the exports.resources.csv.get_field_data event. For example, in Module::attachListeners():

$sharedEventManager->attach(
    '*',
    'exports.resources.csv.get_field_data',
    function (Event $event) {
        $params = $event->getParams();

        $k = $params['k'];
        $v = $params['v'];
        $export = $params['export'];
        $fieldData = $params['field_data'];

        if ('o-module-mymodule:mydata' === $k) {
            // Do any processing to the value and add the header-field pair to
            // the $fieldData ArrayObject.
            $fieldData[] = [$k, $v];
        }
    }
);

The event provides the following parameters:

• k: The JSON-LD key; use to detect relevant values
• v: The JSON-LD value
• export: The export representation; use to get export data if needed
• field_data: An ArrayObject; use to set CSV header-field pair(s)