Package: File\Ingest
An abstract class that handles ingesting files into Omeka and database.
Specific responsibilities handled by this class:
Typical usage is via the factory() method:
$ingest = Omeka_File_Ingest_AbstractIngest::factory('Url', $item); $fileRecords = $ingest->ingest('http://www.example.com');
Set of arbitrary options to use when ingesting files.
Set of validators implementing Zend_Validate_Interface.
The current validated file MIME type.
Set the item to use as a target when ingesting files.
Parameters: |
|
---|---|
Returns: | void |
Factory to retrieve Omeka_File_Ingest_* instances.
Parameters: |
|
---|---|
Returns: | Omeka_File_Ingest_AbstractIngest |
Retrieve the original filename of the file.
Parameters: |
|
---|---|
Returns: | string |
Transfer the file to Omeka.
To indicate validation errors, Omeka_File_Ingest_InvalidException can bethrown at any time. To indicate other types of non-recoverable errorsrelated to file ingest, throw Omeka_File_Ingest_Exception.
Parameters: |
|
---|---|
Returns: | string Real path to the transferred file. |
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: |
|
---|---|
Returns: | array |
Set options for ingesting files.
Parameters: |
|
---|---|
Returns: | void |
Ingest based on arbitrary file identifier info.
If this is an array that has a ‘metadata’ key, that should be an arrayrepresenting element text metadata to assign to the file. SeeActsAsElementText::addElementTextsByArray() for more details.
Parameters: |
|
---|---|
Returns: | array Ingested file records. |
Determine whether or not to ignore file ingest errors. Based on ‘ignore_invalid_files’, which is false by default.
Returns: | boolean |
---|
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: |
|
---|---|
Returns: | void |
Insert a File record corresponding to an ingested file and its metadata.
Parameters: |
|
---|---|
Returns: | File |
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_AbstractIngestimplementations in order to determine where to transfer any given file.
Parameters: |
|
---|---|
Returns: | string |
Add Zend Framework file validators.
Emulates the way Zend Framework adds validators.
Parameters: |
|
---|---|
Returns: | Omeka_File_Ingest_AbstractIngest |
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:
Parameters: |
|
---|---|
Returns: | boolean True if valid, otherwise throws an exception. |