TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter Class Reference

Inheritance diagram for TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter:

Public Member Functions
	injectResourceFactory (ResourceFactory $resourceFactory)
	injectHashService (HashService $hashService)
	injectPersistenceManager (PersistenceManagerInterface $persistenceManager)
AbstractFileFolder Error null	convertFrom ($source, $targetType, array $convertedChildProperties=[], PropertyMappingConfigurationInterface $configuration=null)
‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter
	injectObjectManager (ObjectManagerInterface $objectManager)
string[]	getSupportedSourceTypes ()
string	getSupportedTargetType ()
string	getTargetTypeForSource ($source, string $originalTargetType, PropertyMappingConfigurationInterface $configuration=null)
int	getPriority ()
bool	canConvertFrom ($source, string $targetType)
array	getSourceChildPropertiesToBeConverted ($source)
string	getTypeOfChildProperty (string $targetType, string $propertyName, PropertyMappingConfigurationInterface $configuration)
‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Property\TypeConverterInterface
mixed TYPO3 CMS Extbase Error Error	convertFrom ($source, string $targetType, array $convertedChildProperties=[], PropertyMappingConfigurationInterface $configuration=null)

Public Attributes
const	CONFIGURATION_UPLOAD_FOLDER = 1
const	CONFIGURATION_UPLOAD_CONFLICT_MODE = 2
const	CONFIGURATION_UPLOAD_SEED = 3
const	CONFIGURATION_FILE_VALIDATORS = 4

Protected Member Functions
PseudoFileReference	importUploadedResource (array $uploadInfo, PropertyMappingConfigurationInterface $configuration)
PseudoFileReference	createFileReferenceFromFalFileObject (File $file, int $resourcePointer=null)
PseudoFileReference	createFileReferenceFromFalFileReferenceObject (CoreFileReference $falFileReference, int $resourcePointer=null)
string	getUploadErrorMessage (int $errorCode)
Folder	provideUploadFolder (string $uploadFolderIdentifier)
Folder	provideTargetFolder (Folder $parentFolder, string $folderName)
	provideFolderInitialization (Folder $parentFolder)

Protected Attributes
string	$defaultUploadFolder = '1:/user_upload/'
string	$defaultConflictMode = 'rename'
array	$sourceTypes = array( 'array' )
string	$targetType = PseudoFileReference::class
int	$priority = 12
PseudoFileReference[]	$convertedResources = array( )
TYPO3 CMS Core Resource ResourceFactory	$resourceFactory
TYPO3 CMS Extbase Security Cryptography HashService	$hashService
TYPO3 CMS Extbase Persistence PersistenceManagerInterface	$persistenceManager
‪Protected Attributes inherited from ‪TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter
string[]	$sourceTypes = array( )
string	$targetType = ''
int	$priority
TYPO3 CMS Extbase Object ObjectManagerInterface	$objectManager

Detailed Description

Class UploadedFileReferenceConverter

Scope: frontend

Definition at line 47 of file UploadedFileReferenceConverter.php.

Member Function Documentation

convertFrom()

AbstractFileFolder Error null TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter::convertFrom	(		$source,
			$targetType,
		array	$convertedChildProperties = [],
		PropertyMappingConfigurationInterface	$configuration = null
	)

Actually convert from $source to $targetType, taking into account the fully built $convertedChildProperties and $configuration.

Parameters

array	$source
string	$targetType
array	$convertedChildProperties
PropertyMappingConfigurationInterface	$configuration

Returns

‪AbstractFileFolder|Error|null

Definition at line 148 of file UploadedFileReferenceConverter.php.

References TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\createFileReferenceFromFalFileObject(), TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\createFileReferenceFromFalFileReferenceObject(), TYPO3\CMS\Form\Mvc\Property\Exception\TypeConverterException\getError(), TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\getUploadErrorMessage(), and TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\importUploadedResource().

createFileReferenceFromFalFileObject()

PseudoFileReference TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter::createFileReferenceFromFalFileObject ( File  $file, int  $resourcePointer = null  )

protected

Parameters

File	$file
int	$resourcePointer

Returns

‪PseudoFileReference

Definition at line 256 of file UploadedFileReferenceConverter.php.

References TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\createFileReferenceFromFalFileReferenceObject(), and TYPO3\CMS\Core\Utility\StringUtility\getUniqueId().

Referenced by TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\convertFrom(), and TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\importUploadedResource().

createFileReferenceFromFalFileReferenceObject()

PseudoFileReference TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter::createFileReferenceFromFalFileReferenceObject ( CoreFileReference  $falFileReference, int  $resourcePointer = null  )

protected

In case no $resourcePointer is given a new file reference domain object will be returned. Otherwise the file reference is reconstituted from storage and will be updated(!) with the provided $falFileReference.

Parameters

CoreFileReference	$falFileReference
int	$resourcePointer

Returns

‪PseudoFileReference

Definition at line 280 of file UploadedFileReferenceConverter.php.

References TYPO3\CMS\Extbase\Domain\Model\FileReference\setOriginalResource().

Referenced by TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\convertFrom(), and TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\createFileReferenceFromFalFileObject().

getUploadErrorMessage()

string TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter::getUploadErrorMessage ( int  $errorCode )

protected

Returns a human-readable message for the given PHP file upload error constant.

Parameters

int

$errorCode

Returns

‪string

Definition at line 301 of file UploadedFileReferenceConverter.php.

References TYPO3\CMS\Form\Service\TranslationService\getInstance(), and TYPO3\CMS\Form\Service\TranslationService\translate().

Referenced by TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\convertFrom().

importUploadedResource()

PseudoFileReference TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter::importUploadedResource ( array  $uploadInfo, PropertyMappingConfigurationInterface  $configuration  )

protected

Import a resource and respect configuration given for properties

Parameters

array	$uploadInfo
PropertyMappingConfigurationInterface	$configuration

Returns

‪PseudoFileReference

Definition at line 208 of file UploadedFileReferenceConverter.php.

References TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\$defaultConflictMode, TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\$defaultUploadFolder, $validator, TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\createFileReferenceFromFalFileObject(), TYPO3\CMS\Form\Mvc\Property\Exception\TypeConverterException\fromError(), TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface\getConfigurationValue(), TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\provideTargetFolder(), and TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\provideUploadFolder().

Referenced by TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\convertFrom().

injectHashService()

TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter::injectHashService

(

HashService

$hashService

)

Parameters

\TYPO3\CMS\Extbase\Security\Cryptography\HashService

$hashService

Definition at line 123 of file UploadedFileReferenceConverter.php.

References TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\$hashService.

injectPersistenceManager()

TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter::injectPersistenceManager

(

PersistenceManagerInterface

$persistenceManager

)

Parameters

\TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface

$persistenceManager

Definition at line 132 of file UploadedFileReferenceConverter.php.

References TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\$persistenceManager.

injectResourceFactory()

TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter::injectResourceFactory

(

ResourceFactory

$resourceFactory

)

Parameters

\TYPO3\CMS\Core\Resource\ResourceFactory

$resourceFactory

Definition at line 114 of file UploadedFileReferenceConverter.php.

References TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\$resourceFactory.

provideFolderInitialization()

TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter::provideFolderInitialization ( Folder  $parentFolder )

protected

Creates empty index.html file to avoid directory indexing, in case it does not exist yet.

Parameters

Folder

$parentFolder

Definition at line 372 of file UploadedFileReferenceConverter.php.

References TYPO3\CMS\Core\Resource\Folder\createFile(), and TYPO3\CMS\Core\Resource\Folder\hasFile().

Referenced by TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\provideUploadFolder().

provideTargetFolder()

Folder TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter::provideTargetFolder ( Folder  $parentFolder, string  $folderName  )

protected

Ensures that particular target folder exists, creates it if it does not.

Parameters

Folder	$parentFolder
string	$folderName

Returns

‪Folder

Definition at line 359 of file UploadedFileReferenceConverter.php.

References TYPO3\CMS\Core\Resource\Folder\createFolder(), TYPO3\CMS\Core\Resource\Folder\getSubfolder(), and TYPO3\CMS\Core\Resource\Folder\hasFolder().

Referenced by TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\importUploadedResource(), and TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\provideUploadFolder().

provideUploadFolder()

Folder TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter::provideUploadFolder ( string  $uploadFolderIdentifier )

protected

Ensures that upload folder exists, creates it if it does not.

Parameters

string

$uploadFolderIdentifier

Returns

‪Folder

Definition at line 338 of file UploadedFileReferenceConverter.php.

References TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\provideFolderInitialization(), TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\provideTargetFolder(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\importUploadedResource().

Member Data Documentation

$convertedResources

PseudoFileReference [] TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter::$convertedResources = array( )

protected

Definition at line 96 of file UploadedFileReferenceConverter.php.

$defaultConflictMode

string TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter::$defaultConflictMode = 'rename'

protected

One of 'cancel', 'replace', 'rename'

Definition at line 78 of file UploadedFileReferenceConverter.php.

Referenced by TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\importUploadedResource().

$defaultUploadFolder

string TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter::$defaultUploadFolder = '1:/user_upload/'

protected

Definition at line 72 of file UploadedFileReferenceConverter.php.

Referenced by TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\importUploadedResource().

$hashService

TYPO3 CMS Extbase Security Cryptography HashService TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter::$hashService

protected

Definition at line 104 of file UploadedFileReferenceConverter.php.

Referenced by TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\injectHashService().

$persistenceManager

TYPO3 CMS Extbase Persistence PersistenceManagerInterface TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter::$persistenceManager

protected

Definition at line 108 of file UploadedFileReferenceConverter.php.

Referenced by TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\injectPersistenceManager().

$priority

int TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter::$priority = 12

protected

Take precedence over the available FileReferenceConverter

Definition at line 92 of file UploadedFileReferenceConverter.php.

$resourceFactory

TYPO3 CMS Core Resource ResourceFactory TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter::$resourceFactory

protected

Definition at line 100 of file UploadedFileReferenceConverter.php.

Referenced by TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\injectResourceFactory().

$sourceTypes

array TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter::$sourceTypes = array( 'array' )

protected

Definition at line 82 of file UploadedFileReferenceConverter.php.

$targetType

string TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter::$targetType = PseudoFileReference::class

protected

Definition at line 86 of file UploadedFileReferenceConverter.php.

CONFIGURATION_FILE_VALIDATORS

const TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter::CONFIGURATION_FILE_VALIDATORS = 4

Validator for file types

Definition at line 68 of file UploadedFileReferenceConverter.php.

Referenced by TYPO3\CMS\Form\Mvc\Property\PropertyMappingConfiguration\afterBuildingFinished(), TYPO3\CMS\Form\Tests\Unit\Mvc\Property\PropertyMappingConfigurationTest\afterBuildingFinishedAddsMimeTypeConverter(), TYPO3\CMS\Form\Tests\Unit\Mvc\Property\PropertyMappingConfigurationTest\afterBuildingFinishedCopiesValidators(), and TYPO3\CMS\Form\Tests\Unit\Mvc\Property\PropertyMappingConfigurationTest\afterBuildingFinishedDoesNotCopyNotEmptyValidator().

CONFIGURATION_UPLOAD_CONFLICT_MODE

const TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter::CONFIGURATION_UPLOAD_CONFLICT_MODE = 2

How to handle a upload when the name of the uploaded file conflicts.

Definition at line 58 of file UploadedFileReferenceConverter.php.

Referenced by TYPO3\CMS\Form\Mvc\Property\PropertyMappingConfiguration\afterBuildingFinished().

CONFIGURATION_UPLOAD_FOLDER

const TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter::CONFIGURATION_UPLOAD_FOLDER = 1

Folder where the file upload should go to (including storage).

Definition at line 53 of file UploadedFileReferenceConverter.php.

Referenced by TYPO3\CMS\Form\Mvc\Property\PropertyMappingConfiguration\afterBuildingFinished(), TYPO3\CMS\Form\Tests\Unit\Mvc\Property\PropertyMappingConfigurationTest\afterBuildingFinishedSetsStoragePathToUserUploadIfNeitherSaveToFileMountIsSetNorThereIsAFormDefinitionPath(), TYPO3\CMS\Form\Tests\Unit\Mvc\Property\PropertyMappingConfigurationTest\afterBuildingFinishedSetsUpStoragePathToPropertySaveToFileMountIfItExists(), and TYPO3\CMS\Form\Tests\Unit\Mvc\Property\PropertyMappingConfigurationTest\afterBuildingFinishedSetsUpStoragePathToToFormDefinitionPathIfSaveToFileMountIsNotDefinedAndFormWasNotAddedProgrammatically().

CONFIGURATION_UPLOAD_SEED

const TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter::CONFIGURATION_UPLOAD_SEED = 3

Random seed to be used for deriving storage sub-folders.

Definition at line 63 of file UploadedFileReferenceConverter.php.

Referenced by TYPO3\CMS\Form\Mvc\Property\PropertyMappingConfiguration\adjustPropertyMappingForFileUploadsAtRuntime().