IndexedSearchCTypeMigration extends AbstractListTypeToCTypeUpdate

FinalYes

This class can be extended by 3rd party extensions to easily add a custom `list_type` to `CType` update for deprecated "plugin" content element usages.

Internal

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

Tags
since
13.0
Attributes
#[UpgradeWizard]
'indexedSearchCTypeMigration'

Table of Contents

Constants

TABLE_BACKEND_USER_GROUPS  = 'be_groups'
TABLE_CONTENT  = 'tt_content'

Methods

__construct()  : mixed
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?
columnsExistInBackendUserGroupsTable()  : bool
columnsExistInContentTable()  : bool
getBackendUserGroupsToUpdate()  : array<string|int, mixed>
getContentElementsToUpdate()  : array<string|int, mixed>
getListTypeToCTypeMapping()  : array<string, string>
This must return an array containing the "list_type" to "CType" mapping
hasBackendUserGroupsToUpdate()  : bool
hasContentElementsToUpdate()  : bool
hasNoLegacyBackendGroupsExplicitAllowDenyConfiguration()  : bool
Returns true, if no legacy explicit_allowdeny be_groups configuration is found. Note, that we can not rely BackendGroupsExplicitAllowDenyMigration status here, since the update must also be executed for new TYPO3 v13+ installations, where BackendGroupsExplicitAllowDenyMigration is not required.
updateBackendUserGroups()  : void
updateContentElements()  : void

Constants

TABLE_BACKEND_USER_GROUPS

protected mixed TABLE_BACKEND_USER_GROUPS = 'be_groups'

TABLE_CONTENT

protected mixed TABLE_CONTENT = 'tt_content'

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

columnsExistInBackendUserGroupsTable()

protected columnsExistInBackendUserGroupsTable() : bool
Return values
bool

columnsExistInContentTable()

protected columnsExistInContentTable() : bool
Return values
bool

getBackendUserGroupsToUpdate()

protected getBackendUserGroupsToUpdate(string $listType) : array<string|int, mixed>
Parameters
$listType : string
Return values
array<string|int, mixed>

getContentElementsToUpdate()

protected getContentElementsToUpdate(string $listType) : array<string|int, mixed>
Parameters
$listType : string
Return values
array<string|int, mixed>

getListTypeToCTypeMapping()

This must return an array containing the "list_type" to "CType" mapping

protected getListTypeToCTypeMapping() : array<string, string>

Example:

[ 'pi_plugin1' => 'pi_plugin1', 'pi_plugin2' => 'new_content_element', ]

Return values
array<string, string>

hasBackendUserGroupsToUpdate()

protected hasBackendUserGroupsToUpdate() : bool
Return values
bool

hasContentElementsToUpdate()

protected hasContentElementsToUpdate() : bool
Return values
bool

hasNoLegacyBackendGroupsExplicitAllowDenyConfiguration()

Returns true, if no legacy explicit_allowdeny be_groups configuration is found. Note, that we can not rely BackendGroupsExplicitAllowDenyMigration status here, since the update must also be executed for new TYPO3 v13+ installations, where BackendGroupsExplicitAllowDenyMigration is not required.

protected hasNoLegacyBackendGroupsExplicitAllowDenyConfiguration() : bool
Return values
bool

updateBackendUserGroups()

protected updateBackendUserGroups() : void

updateContentElements()

protected updateContentElements() : void 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results