‪TYPO3CMS  10.4
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate Class Reference
Inheritance diagram for TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate:
TYPO3\CMS\Install\Updates\ChattyInterface TYPO3\CMS\Install\Updates\UpgradeWizardInterface

Public Member Functions

string getIdentifier ()
 
string getTitle ()
 
string getDescription ()
 
string[] getPrerequisites ()
 
 setOutput (OutputInterface $output)
 
bool updateNecessary ()
 
bool executeUpdate ()
 

Protected Member Functions

array getFormDefinitionsInformation ()
 
array getFormDefinitionsInformationFromStorages ()
 
array getFormDefinitionsInformationFromExtensions ()
 
array setFormDefinitionInformationData (string $persistenceIdentifier, array $formDefinition, File $file, string $location)
 
array enrichFormDefinitionsInformationWithDataFromReferences (array $formDefinitionsInformation)
 
array getSheetIdentifiersWhichNeedsUpdate (array $flexform, array $formDefinitionsInformation, string $targetPersistenceIdentifier, string $possibleOldReferencedPersistenceIdentifier, string $possibleNewReferencedPersistenceIdentifier)
 
array getSheetIdentifiersForFinisherOverrides (array $flexform)
 
array getFinisherSheetsFromFlexform (array $flexform)
 
string getPersistenceIdentifierFromFlexform (array $flexform)
 
string generateNewFlexformForReference (array $referenceData, array $sheetIdentifiersWhichNeedsUpdate, string $newPersistenceIdentifier='')
 
bool hasNewFileExtension (string $persistenceIdentifier)
 
bool looksLikeAFormDefinition (array $formDefinition)
 
string getOldPersistenceIdentifier (string $persistenceIdentifier)
 
string getNewPersistenceIdentifier (string $persistenceIdentifier)
 
string buildExpectedSheetIdentifier (string $persistenceIdentifier, string $prototypeName, string $formIdentifier, string $finisherIdentifier)
 
array getFormDefinition (File $file)
 
array extractMetaDataFromCouldBeFormDefinition (string $maybeRawFormDefinition)
 
array getAllFlexformFieldsFromFormPlugins ()
 
 updateContentReference (int $uid, string $flexform, bool $updateRefindex=false)
 
ObjectManager getObjectManager ()
 

Protected Attributes

OutputInterface $output
 
FormPersistenceManager $persistenceManager
 
ResourceFactory $resourceFactory
 
ReferenceIndex $referenceIndex
 
FlexFormTools $flexFormTools
 
Connection $connection
 

Detailed Description

Update wizard to migrate all forms currently in use to new ending

Definition at line 45 of file FormFileExtensionUpdate.php.

Member Function Documentation

◆ buildExpectedSheetIdentifier()

string TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::buildExpectedSheetIdentifier ( string  $persistenceIdentifier,
string  $prototypeName,
string  $formIdentifier,
string  $finisherIdentifier 
)
protected
Parameters
string$persistenceIdentifier
string$prototypeName
string$formIdentifier
string$finisherIdentifier
Returns
‪string

Definition at line 706 of file FormFileExtensionUpdate.php.

Referenced by TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getSheetIdentifiersWhichNeedsUpdate().

◆ enrichFormDefinitionsInformationWithDataFromReferences()

array TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::enrichFormDefinitionsInformationWithDataFromReferences ( array  $formDefinitionsInformation)
protected
Parameters
array$formDefinitionsInformation
Returns
‪array

Definition at line 458 of file FormFileExtensionUpdate.php.

References TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getAllFlexformFieldsFromFormPlugins(), TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getNewPersistenceIdentifier(), TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getOldPersistenceIdentifier(), TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getPersistenceIdentifierFromFlexform(), TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getSheetIdentifiersWhichNeedsUpdate(), TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\hasNewFileExtension(), and TYPO3\CMS\Core\Utility\GeneralUtility\xml2array().

Referenced by TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getFormDefinitionsInformation().

◆ executeUpdate()

bool TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::executeUpdate ( )

Performs the accordant updates.

Returns
‪bool Whether everything went smoothly or not

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 195 of file FormFileExtensionUpdate.php.

References $GLOBALS, TYPO3\CMS\Form\Slot\FilePersistenceSlot\COMMAND_FILE_RENAME, TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\generateNewFlexformForReference(), TYPO3\CMS\Extbase\Object\ObjectManager\get(), TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getFormDefinitionsInformation(), TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getNewPersistenceIdentifier(), TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getObjectManager(), TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getSheetIdentifiersWhichNeedsUpdate(), TYPO3\CMS\Core\Utility\PathUtility\pathinfo(), TYPO3\CMS\Core\Resource\DuplicationBehavior\RENAME, and TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\updateContentReference().

◆ extractMetaDataFromCouldBeFormDefinition()

array TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::extractMetaDataFromCouldBeFormDefinition ( string  $maybeRawFormDefinition)
protected
Parameters
string$maybeRawFormDefinition
Returns
‪array

Definition at line 746 of file FormFileExtensionUpdate.php.

Referenced by TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getFormDefinition().

◆ generateNewFlexformForReference()

string TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::generateNewFlexformForReference ( array  $referenceData,
array  $sheetIdentifiersWhichNeedsUpdate,
string  $newPersistenceIdentifier = '' 
)
protected
Parameters
array$referenceData
array$sheetIdentifiersWhichNeedsUpdate
string$newPersistenceIdentifier
Returns
‪string

Definition at line 633 of file FormFileExtensionUpdate.php.

Referenced by TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\executeUpdate().

◆ getAllFlexformFieldsFromFormPlugins()

array TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::getAllFlexformFieldsFromFormPlugins ( )
protected
Returns
‪array

Definition at line 774 of file FormFileExtensionUpdate.php.

Referenced by TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\enrichFormDefinitionsInformationWithDataFromReferences().

◆ getDescription()

string TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::getDescription ( )

Return the description for this wizard

Returns
‪string

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 97 of file FormFileExtensionUpdate.php.

◆ getFinisherSheetsFromFlexform()

array TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::getFinisherSheetsFromFlexform ( array  $flexform)
protected
Parameters
array$flexform
Returns
‪array

Definition at line 603 of file FormFileExtensionUpdate.php.

Referenced by TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getSheetIdentifiersForFinisherOverrides().

◆ getFormDefinition()

array TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::getFormDefinition ( File  $file)
protected
Parameters
File$file
Returns
‪array

Definition at line 726 of file FormFileExtensionUpdate.php.

References TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\extractMetaDataFromCouldBeFormDefinition(), TYPO3\CMS\Core\Resource\File\getContents(), and TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\looksLikeAFormDefinition().

Referenced by TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getFormDefinitionsInformationFromExtensions(), and TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getFormDefinitionsInformationFromStorages().

◆ getFormDefinitionsInformation()

array TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::getFormDefinitionsInformation ( )
protected
Returns
‪array

Definition at line 356 of file FormFileExtensionUpdate.php.

References TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\enrichFormDefinitionsInformationWithDataFromReferences(), TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getFormDefinitionsInformationFromExtensions(), and TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getFormDefinitionsInformationFromStorages().

Referenced by TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\executeUpdate(), and TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\updateNecessary().

◆ getFormDefinitionsInformationFromExtensions()

array TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::getFormDefinitionsInformationFromExtensions ( )
protected
Returns
‪array

Definition at line 397 of file FormFileExtensionUpdate.php.

References TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getFormDefinition(), and TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\setFormDefinitionInformationData().

Referenced by TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getFormDefinitionsInformation().

◆ getFormDefinitionsInformationFromStorages()

array TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::getFormDefinitionsInformationFromStorages ( )
protected
Returns
‪array

Definition at line 371 of file FormFileExtensionUpdate.php.

References TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getFormDefinition(), and TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\setFormDefinitionInformationData().

Referenced by TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getFormDefinitionsInformation().

◆ getIdentifier()

string TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::getIdentifier ( )

Return the identifier for this wizard This should be the same string as used in the ext_localconf class registration

Returns
‪string

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 77 of file FormFileExtensionUpdate.php.

◆ getNewPersistenceIdentifier()

string TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::getNewPersistenceIdentifier ( string  $persistenceIdentifier)
protected
Parameters
string$persistenceIdentifier
Returns
‪string

Definition at line 690 of file FormFileExtensionUpdate.php.

Referenced by TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\enrichFormDefinitionsInformationWithDataFromReferences(), and TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\executeUpdate().

◆ getObjectManager()

ObjectManager TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::getObjectManager ( )
protected
Returns
‪ObjectManager

Definition at line 826 of file FormFileExtensionUpdate.php.

Referenced by TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\executeUpdate(), and TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\updateNecessary().

◆ getOldPersistenceIdentifier()

string TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::getOldPersistenceIdentifier ( string  $persistenceIdentifier)
protected
Parameters
string$persistenceIdentifier
Returns
‪string

Definition at line 676 of file FormFileExtensionUpdate.php.

Referenced by TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\enrichFormDefinitionsInformationWithDataFromReferences().

◆ getPersistenceIdentifierFromFlexform()

string TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::getPersistenceIdentifierFromFlexform ( array  $flexform)
protected
Parameters
array$flexform
Returns
‪string

Definition at line 622 of file FormFileExtensionUpdate.php.

Referenced by TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\enrichFormDefinitionsInformationWithDataFromReferences().

◆ getPrerequisites()

string [] TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::getPrerequisites ( )

Returns an array of class names of Prerequisite classes This way a wizard can define dependencies like "database up-to-date" or "reference index updated"

Returns
‪string[]

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 110 of file FormFileExtensionUpdate.php.

◆ getSheetIdentifiersForFinisherOverrides()

array TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::getSheetIdentifiersForFinisherOverrides ( array  $flexform)
protected
Parameters
array$flexform
Returns
‪array

Definition at line 583 of file FormFileExtensionUpdate.php.

References TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getFinisherSheetsFromFlexform().

Referenced by TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getSheetIdentifiersWhichNeedsUpdate().

◆ getSheetIdentifiersWhichNeedsUpdate()

array TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::getSheetIdentifiersWhichNeedsUpdate ( array  $flexform,
array  $formDefinitionsInformation,
string  $targetPersistenceIdentifier,
string  $possibleOldReferencedPersistenceIdentifier,
string  $possibleNewReferencedPersistenceIdentifier 
)
protected
Parameters
array$flexform
array$formDefinitionsInformation
string$targetPersistenceIdentifier
string$possibleOldReferencedPersistenceIdentifier
string$possibleNewReferencedPersistenceIdentifier
Returns
‪array

Definition at line 543 of file FormFileExtensionUpdate.php.

References TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\buildExpectedSheetIdentifier(), and TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getSheetIdentifiersForFinisherOverrides().

Referenced by TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\enrichFormDefinitionsInformationWithDataFromReferences(), and TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\executeUpdate().

◆ getTitle()

string TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::getTitle ( )

Return the speaking name of this wizard

Returns
‪string

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 87 of file FormFileExtensionUpdate.php.

◆ hasNewFileExtension()

bool TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::hasNewFileExtension ( string  $persistenceIdentifier)
protected
Parameters
string$persistenceIdentifier
Returns
‪bool

Definition at line 655 of file FormFileExtensionUpdate.php.

References TYPO3\CMS\Core\Utility\StringUtility\endsWith(), and TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager\FORM_DEFINITION_FILE_EXTENSION.

Referenced by TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\enrichFormDefinitionsInformationWithDataFromReferences(), and TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\setFormDefinitionInformationData().

◆ looksLikeAFormDefinition()

bool TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::looksLikeAFormDefinition ( array  $formDefinition)
protected
Parameters
array$formDefinition
Returns
‪bool

Definition at line 667 of file FormFileExtensionUpdate.php.

Referenced by TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getFormDefinition().

◆ setFormDefinitionInformationData()

array TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::setFormDefinitionInformationData ( string  $persistenceIdentifier,
array  $formDefinition,
File  $file,
string  $location 
)
protected
Parameters
string$persistenceIdentifier
array$formDefinition
File$file
string$location
Returns
‪array

Definition at line 432 of file FormFileExtensionUpdate.php.

References TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\hasNewFileExtension().

Referenced by TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getFormDefinitionsInformationFromExtensions(), and TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getFormDefinitionsInformationFromStorages().

◆ setOutput()

TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::setOutput ( OutputInterface  $output)

Setter injection for output into upgrade wizards

Parameters
OutputInterface$output

Implements TYPO3\CMS\Install\Updates\ChattyInterface.

Definition at line 118 of file FormFileExtensionUpdate.php.

References TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\$output.

◆ updateContentReference()

TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::updateContentReference ( int  $uid,
string  $flexform,
bool  $updateRefindex = false 
)
protected
Parameters
int$uid
string$flexform
bool$updateRefindex

Definition at line 802 of file FormFileExtensionUpdate.php.

Referenced by TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\executeUpdate().

◆ updateNecessary()

bool TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::updateNecessary ( )

Checks whether updates are required.

Returns
‪bool Whether an update is required (TRUE) or not (FALSE)

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 128 of file FormFileExtensionUpdate.php.

References TYPO3\CMS\Extbase\Object\ObjectManager\get(), TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getFormDefinitionsInformation(), and TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\getObjectManager().

Member Data Documentation

◆ $connection

Connection TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::$connection
protected

Definition at line 69 of file FormFileExtensionUpdate.php.

◆ $flexFormTools

FlexFormTools TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::$flexFormTools
protected

Definition at line 65 of file FormFileExtensionUpdate.php.

◆ $output

OutputInterface TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::$output
protected

Definition at line 49 of file FormFileExtensionUpdate.php.

Referenced by TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\setOutput().

◆ $persistenceManager

FormPersistenceManager TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::$persistenceManager
protected

Definition at line 53 of file FormFileExtensionUpdate.php.

◆ $referenceIndex

ReferenceIndex TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::$referenceIndex
protected

Definition at line 61 of file FormFileExtensionUpdate.php.

◆ $resourceFactory

ResourceFactory TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate::$resourceFactory
protected

Definition at line 57 of file FormFileExtensionUpdate.php.