SysLogSerializationUpdate implements UpgradeWizardInterface uses LogDataTrait

Internal

This class is only meant to be used within EXT:install and is not part of the TYPO3 Core API.

Attributes
#[UpgradeWizard]
'sysLogSerialization'

Table of Contents

Interfaces

UpgradeWizardInterface
Interface UpgradeWizardInterface

Methods

executeUpdate()  : bool
Execute the update
getDescription()  : string
Return the description for this wizard
getPrerequisites()  : array<string|int, string>
Returns an array of class names of Prerequisite classes
getTitle()  : string
Return the speaking name of this wizard
updateNecessary()  : bool
Is an update necessary?
formatLogDetails()  : string
Replaces a string with placeholders (%s or {myPlaceholder}) with its substitutes.
formatLogDetailsStatic()  : string
Static version for ViewHelpers etc.
getConnectionPool()  : ConnectionPool
getPreparedQueryBuilder()  : QueryBuilder
hasRecordsToUpdate()  : bool
unserializeLogData()  : array<string|int, mixed>|null
Useful for handling old serialized data, which might have been migrated to JSON encoded properties already.

Methods

executeUpdate()

Execute the update

public executeUpdate() : bool

Called when a wizard reports that an update is necessary

Return values
bool

getDescription()

Return the description for this wizard

public getDescription() : string
Return values
string

getPrerequisites()

Returns an array of class names of Prerequisite classes

public getPrerequisites() : array<string|int, string>

This way a wizard can define dependencies like "database up-to-date" or "reference index updated"

Return values
array<string|int, string>

getTitle()

Return the speaking name of this wizard

public getTitle() : string
Return values
string

updateNecessary()

Is an update necessary?

public updateNecessary() : bool

Is used to determine whether a wizard needs to be run. Check if data for migration exists.

Return values
bool

formatLogDetails()

Replaces a string with placeholders (%s or {myPlaceholder}) with its substitutes.

protected formatLogDetails(string $detailString, mixed $substitutes) : string
Parameters
$detailString : string
$substitutes : mixed
Return values
string

formatLogDetailsStatic()

Static version for ViewHelpers etc.

protected static formatLogDetailsStatic(string $detailString, array<string|int, mixed> $substitutes) : string

Replaces a string with placeholders (%s or {myPlaceholder}) with its substitutes.

Parameters
$detailString : string
$substitutes : array<string|int, mixed>
Return values
string

hasRecordsToUpdate()

protected hasRecordsToUpdate() : bool
Return values
bool

unserializeLogData()

Useful for handling old serialized data, which might have been migrated to JSON encoded properties already.

protected unserializeLogData(mixed $logData) : array<string|int, mixed>|null
Parameters
$logData : mixed
Return values
array<string|int, mixed>|null 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results