1. class
  2. Concrete
  3. \
  4. Core
  5. \
  6. File
  7. \
  8. Import
  9. \
  10. FileImporter

FileImporter

class FileImporter (View source)

A class to be used to import files into the application file manager.

Properties

protected Application $app

The container instance to be used to build dependencies.
private ProcessorManager $processorManager
private Application $applicationFileService
private Incoming $incoming

Methods

__construct(Application $app, ProcessorManager $processorManager, Application $applicationFileService, Incoming $incoming)

Initialize the instance.

ProcessorManager
getProcessorManager()

Get the processor list manager.

Version
importLocalFile(string $localFilename, string $concreteFilename = '', ImportOptions $options = null)

Import a local file into the application file manager.

Version
importFromIncoming(string $incomingFilename, string $concreteFilename = '', ImportOptions $options = null)

Import a file from the incoming directory into the application file manager.

Version
importUploadedFile(UploadedFile $uploadedFile = null, string $concreteFilename = '', ImportOptions $options = null)

Import a file received via a POST request into the application file manager.

string
generatePrefix()

Generate a file prefix.

Version
import(ImportingFile $importingFile, ImportOptions $options)

Import a file into the application file manager.

applyValidators(ImportingFile $importingFile, ImportOptions $options)

Apply the validators to the file being imported.

applyPreProcessors(ImportingFile $importingFile, ImportOptions $options)

Apply the pre-processors to the file being imported.

Version
save(ImportingFile $importingFile, ImportOptions $options)

Actually import a file into the application file manager.

applyPostProcessors(ImportingFile $importingFile, ImportOptions $options, Version $fileVersion)

Apply the post-processors to the imported file.

string
resolveIncomingFilename(string $incomingFilename, bool $copiedLocally, VolatileDirectory $volatileDirectory = null)

Get the local path of an incoming file (if the incoming file system is not local, we'll create a copy of it in a volatile directory).

Details

at line 54
__construct(Application $app, ProcessorManager $processorManager, Application $applicationFileService, Incoming $incoming)

Initialize the instance.

Parameters

Application $app
ProcessorManager $processorManager
Application $applicationFileService
Incoming $incoming

at line 67
ProcessorManager getProcessorManager()

Get the processor list manager.

Return Value

ProcessorManager

at line 83
Version importLocalFile(string $localFilename, string $concreteFilename = '', ImportOptions $options = null)

Import a local file into the application file manager.

Parameters

string $localFilename

The path to the file
string $concreteFilename

A custom name to give to the file (if empty we'll derive it from $localFilename)
ImportOptions $options

the options to be used to import the file

Return Value

Version

Exceptions

ImportException

at line 113
Version importFromIncoming(string $incomingFilename, string $concreteFilename = '', ImportOptions $options = null)

Import a file from the incoming directory into the application file manager.

Parameters

string $incomingFilename

The path to the file
string $concreteFilename

A custom name to give to the file (if empty we'll derive it from $incomingFilename)
ImportOptions $options

the options to be used to import the file

Return Value

Version

Exceptions

ImportException

at line 147
Version importUploadedFile(UploadedFile $uploadedFile = null, string $concreteFilename = '', ImportOptions $options = null)

Import a file received via a POST request into the application file manager.

Parameters

UploadedFile $uploadedFile

The uploaded file
string $concreteFilename

A custom name to give to the file (if empty we'll derive it from $uploadedFile)
ImportOptions $options

the options to be used to import the file

Return Value

Version

Exceptions

ImportException

Examples

<pre><code>
$app = \Concrete\Core\Support\Facade\Application::getFacadeApplication();
$request = $app->make(\Concrete\Core\Http\Request::class);
$importer = $app->make(\Concrete\Core\File\Import\FileImporter::class);
try {
    $fv = $importer->importUploadedFile($request->files->get('field_name'));
} catch (\Concrete\Core\File\Import\ImportException $x) {
    // Manage the import exception
}
</code></pre>

at line 166
string generatePrefix()

Generate a file prefix.

Return Value

string

at line 183
protected Version import(ImportingFile $importingFile, ImportOptions $options)

Import a file into the application file manager.

Parameters

ImportingFile $importingFile

the file being imported
ImportOptions $options

the options to be used to import the file

Return Value

Version

Exceptions

ImportException

at line 213
protected applyValidators(ImportingFile $importingFile, ImportOptions $options)

Apply the validators to the file being imported.

Parameters

ImportingFile $importingFile
ImportOptions $options

Exceptions

ImportException

at line 228
protected applyPreProcessors(ImportingFile $importingFile, ImportOptions $options)

Apply the pre-processors to the file being imported.

Parameters

ImportingFile $importingFile
ImportOptions $options

at line 247
protected Version save(ImportingFile $importingFile, ImportOptions $options)

Actually import a file into the application file manager.

Parameters

ImportingFile $importingFile

the file being imported
ImportOptions $options

the options to be used to import the file

Return Value

Version

Exceptions

ImportException

at line 315
protected applyPostProcessors(ImportingFile $importingFile, ImportOptions $options, Version $fileVersion)

Apply the post-processors to the imported file.

Parameters

ImportingFile $importingFile
ImportOptions $options
Version $fileVersion

Exceptions

ImportException

at line 335
protected string resolveIncomingFilename(string $incomingFilename, bool $copiedLocally, VolatileDirectory $volatileDirectory = null)

Get the local path of an incoming file (if the incoming file system is not local, we'll create a copy of it in a volatile directory).

Parameters

string $incomingFilename

The file name in the incoming file system
bool $copiedLocally

this output parameter will be set to true if we had to copy the file locally
VolatileDirectory $volatileDirectory

this output parameter will be set to a VolatileDirectory instance if we had to copy the file locally

Return Value

string

Exceptions

ImportException