Omeka_File_Ingest_AbstractIngest

Package: File\Ingest

class Omeka_File_Ingest_AbstractIngest

An abstract class that handles ingesting files into Omeka and database.

Specific responsibilities handled by this class: - Parsing/validating arbitrary inputs that somehow identify the files to be ingested. - Iterating through the parsed file information, validating, and transferring each file to Omeka. - Inserting a new record into the files table that corresponds to the transferred file’s metadata. - Returning a collection of the records associated with the ingested files.

Typical usage is via the factory() method:

<code> $ingest = Omeka_File_Ingest_AbstractIngest::factory(‘Url’, $item); $fileRecords = $ingest->ingest(’http://www.example.com’); </code>

property _item

protected Item

property _options

protected array

Set of arbitrary options to use when ingesting files.

property mimeType

string

The current validated file MIME type.

setItem(Item $item)

Set the item to use as a target when ingesting files.

Parameters:
factory($adapterName, $item, $options = array())

Factory to retrieve Omeka_File_Ingest_* instances.

Parameters:

  • $adapterName (string) – Ingest adapter.

  • $item (Item) –

  • $options (array) –

Returns:

Omeka_File_Ingest_AbstractIngest

_getOriginalFilename($fileInfo)

Retrieve the original filename of the file.

Parameters:

  • $fileInfo (array) –

Returns:

string

_transferFile($fileInfo, $originalFilename)

Transfer the file to Omeka.

To indicate validation errors, Omeka_File_Ingest_InvalidException can be thrown at any time. To indicate other types of non-recoverable errors related to file ingest, throw Omeka_File_Ingest_Exception.

Parameters:

  • $fileInfo (array) –

  • $originalFilename (string) –

Returns:

string Real path to the transferred file.

_parseFileInfo($files)

Ingest classes receive arbitrary information. This method needs to parse that information into an iterable array so that multiple files can be ingested from a single identifier.

Example use case is Omeka_File_Ingest_Upload.

Parameters:

  • $files (mixed) –

Returns:

array

setOptions($options)

Set options for ingesting files.

Parameters:

  • $options (array) – Available options include: - ‘ignore_invalid_files’: boolean false by default. Determine whether or not to throw exceptions when a file is not valid. This can be based on a number of factors: whether or not the original identifier is valid (i.e. a valid URL), whether or not the file itself is valid (i.e. invalid file extension), or whether the basic algorithm for ingesting the file fails (i.e., files cannot be transferred because the files/ directory is not writeable). This option is primarily useful for skipping known invalid files when ingesting large data sets.

ingest($fileInfo)

Ingest based on arbitrary file identifier info.

If this is an array that has a ‘metadata’ key, that should be an array representing element text metadata to assign to the file. See ActsAsElementText::addElementTextsByArray() for more details.

Parameters:

  • $fileInfo (mixed) – An arbitrary input (array, string, object, etc.) that corresponds to one or more files to be ingested into Omeka.

Returns:

array Ingested file records.

_ignoreIngestErrors()

Determine whether or not to ignore file ingest errors. Based on ‘ignore_invalid_files’, which is false by default.

Returns:

bool

_logException(Exception $e)

Log any exceptions that are thrown as a result of attempting to ingest invalid files.

These are logged as warnings because they are being ignored by the script, so they don’t actually kill the file ingest process.

Parameters:

  • $e (Exception) –

_createFile($newFilePath, $oldFilename, $elementMetadata = array())

Insert a File record corresponding to an ingested file and its metadata.

Parameters:

  • $newFilePath (string) – Path to the file within Omeka.

  • $oldFilename (string) – The original filename for the file. This will usually be displayed to the end user.

  • $elementMetadata (array) – See ActsAsElementText::addElementTextsByArray() for more information about the format of this array.

Returns:

File

_getDestination($fromFilename)

Retrieve the destination path for the file to be transferred.

This will generate an archival filename in order to prevent naming conflicts between ingested files.

This should be used as necessary by Omeka_File_Ingest_AbstractIngest implementations in order to determine where to transfer any given file.

Parameters:

  • $fromFilename (string) – The filename from which to derive the archival filename.

Returns:

string

addValidator(Zend_Validate_Interface $validator)

Add Zend Framework file validators.

Emulates the way Zend Framework adds validators.

Parameters:

  • $validator (Zend_Validate_Interface) –

Returns:

Omeka_File_Ingest_AbstractIngest

_validateFile($filePath, $fileInfo)

Validate a file that has been transferred to Omeka.

Implementations of Omeka_File_Ingest_AbstractIngest should use this to validate the uploaded file based on user-defined security criteria.

Important: $fileInfo may need to contain the following keys in order to work with particular Zend_Validate_File_* validation classes:

  • ‘name’: string filename (for Zend_Validate_File_Extension) If ZF is

unable to determine the file extension when validating, it will check the ‘name’ attribute instead. Current use cases involve saving the file to a temporary location before transferring to Omeka. Most temporary files do not maintain the original file extension. - ‘type’: string MIME type (for Zend_Validate_File_MimeType) If ZF is unable to determine the mime type from the transferred file. Unless the server running Omeka has a mime_magic file or has installed the FileInfo extension, this will be necessary.

Parameters:

  • $filePath (string) – Absolute path to the file. The file should be local and readable, which is required by most (if not all) of the Zend_Validate_File_* classes.

  • $fileInfo (array) – Set of file info that describes a given file being ingested.

Returns:

bool True if valid, otherwise throws an exception.