Upgrading from 2.4 to 3.0

Version 3.0 replaces the profile editing view in place. The content element keeps its type and its sets, but every Fluid file of the old form flow is gone, and the editor writes through a JSON page type that the site has to deliver. Work through the sections in order. Skip a step that does not apply to the installation.

Before you start

Version 3.0 runs on TYPO3 13.4 from 13.4.35 on and on TYPO3 14.3 from 14.3.7 on, with PHP 8.2 or later.

academic_persons_edit 3.0 declares two new dependencies, typo3/cms-rte-ckeditor and typo3/html-sanitizer , see Important: New dependencies cms-rte-ckeditor and html-sanitizer. Neither adds a package to an installation: academic_persons requires rte_ckeditor already, and the TYPO3 core requires typo3/html-sanitizer . The extension also needs these academic packages. Upgrade them first or in the same deployment, in this order:

fgtclb/environment-state-manager 2.x, in place of 1.x, which academic_base 3.0 and academic_persons 3.0 require. Composer updates it on its own. A classic installation updates environment_state_manager to 2.x before it activates either of them.
fgtclb/academic-base 3.0, the same release as this extension.
fgtclb/academic-persons 3.0, the same release as this extension. Its upgrade chapter has steps of its own, and its database update and its settings migration are due in the same deployment.

academic_persons_sync 3.0 requires this extension and follows it in the same deployment, where installed.

These changes have to ship in the same deployment as the update:

A site package that copied the TypoScript of this extension adds the page type the editor writes through, or the editor cannot save, see The page type of the editor.
Project code that extends or links to a removed class or action of the old form flow goes, see The replaced view and Adapt your code.

The module paths on this page are those of TYPO3 13, where the upgrade runs.

Update TYPO3 first

Update TYPO3 to 13.4.35 or later while the site still runs 2.4, which supports TYPO3 13.4. Version 3.0 no longer installs on TYPO3 12, and Composer and the Extension Manager refuse it next to an older patch release of TYPO3 13.

Stay on TYPO3 13 until the upgrade is complete. The content element wizard academicPersonsEdit_pluginContent of this extension reads the column tt_content.list_type, which TYPO3 14 removes, so it only runs on TYPO3 13. The same holds for the content element wizard of academic_persons, which this extension requires, and for those of academic_jobs and academic_projects when the installation also has them. Move to TYPO3 14.3.7 or later once they have run.

See Breaking: Removed TYPO3 v12 support and Important: TYPO3 13.4.35 or 14.3.7 is required.

Update the package

composer require -W \
    'fgtclb/academic-base':'~3.0.0' \
    'fgtclb/academic-persons':'~3.0.0' \
    'fgtclb/academic-persons-edit':'~3.0.0'

On a classic installation, update environment_state_manager to 2.x from the TER in Admin Tools > Extensions first, then update academic_base, academic_persons and academic_persons_edit there, in this order. Keep rte_ckeditor active, the rich text fields of the editor load CKEditor 5 from it. Run the commands of this page with typo3/sysext/core/bin/typo3 instead of vendor/bin/typo3.

vendor/bin/typo3 cache:flush

Update the database

vendor/bin/typo3 extension:setup

Or apply the changes in Admin Tools > Maintenance > Analyze Database Structure.

Version 3.0 of this extension changes no table. Run the update all the same, it applies the changes of the index definitions TYPO3 13.4.35 and 14.3.7 bring, and academic_persons 3.0 changes its tables, which the upgrade wizards of the next step require. Its upgrade chapter names what has to be checked before.

Run the upgrade wizards

Run the wizards in this order, after the database update, and on TYPO3 13:

academicPersonsEdit_pluginContent, Migrate plugin list element from academic_persons_edit to normal content elements, only if it is still offered.
academicPersonsEdit_repairLocalizedProfileImages, Repair the profile image relations of academic profiles.

vendor/bin/typo3 upgrade:run academicPersonsEdit_pluginContent
vendor/bin/typo3 upgrade:run academicPersonsEdit_repairLocalizedProfileImages

A wizard that TYPO3 recorded as done is offered again once it is marked undone. TYPO3 13 marks a wizard undone with vendor/bin/typo3 upgrade:mark:undone <identifier>. The repair wizard is repeatable and never recorded as done.

The content element wizard

academicPersonsEdit_pluginContent shipped with 2.x already and moves a profile editing content element stored as list with a list_type onto its own CType. An installation that ran it there has nothing more to do. TYPO3 14 no longer has tt_content.list_type, so the wizard has to run on TYPO3 13, before the core update. Replace own TypoScript, TSconfig or SQL that matches on list_type with a condition on CType. See Breaking: Extbase plugins require CType on TYPO3 v14.

The profile image relations

academic_persons 3.0 makes the profile image translatable, and a translation can carry an image of its own. The relations the image upload and the translation synchronisation of 2.x wrote do not always fit that. The wizard Repair the profile image relations of academic profiles, academicPersonsEdit_repairLocalizedProfileImages, is new in 3.0. It reduces duplicate references of a profile, corrects the relation counters, and sets the custom localization state on a translation that carries an image of its own, so that the next synchronisation keeps it. See Important: Repair wizard for profile image relations.

The wizard writes through the DataHandler and deletes no file. It skips workspace versions and acts in the live workspace, so publish a workspace with person records and run the wizard again afterwards. Run it before editors use the new editor of a multilingual site. Prefer the command line over the upgrade module for it.

Adapt the configuration

The upgrade check

The console command academic:upgrade:check of academic_base reads the stored configuration of the installation and reports what no longer reaches the academic extensions. Run it on the staging copy right after the package update, and work through what it reports together with the next steps:

vendor/bin/typo3 academic:upgrade:check

With the extension key and a site it also reports every template override of the site whose file this extension no longer ships, which is every override of the old form flow:

vendor/bin/typo3 academic:upgrade:check academic_persons_edit --site=<site identifier>

Each finding, and what to do about it, is described in the upgrade check of academic_base.

The page type of the editor

The editor writes through a PAGE object with typeNum = 1733735, named academicPersonsProfileEditingAjax. The site set fgtclb/academic-persons-edit-profile-editing, the sets that depend on it and the static templates of this extension deliver it. There was no such page type in 2.4.

A site package that copied the TypoScript of this extension instead of including the set or a static template has no such object. Include the delivered TypoScript, or add the object to the copy. The editor reports a missing page type above itself and in the TYPO3 log, it cannot repair it.
A PageType route enhancer maps typeNum 1733735.
A web application firewall or a reverse proxy lets the page type and the X-Requested-With header through.

See The page type of the JSON endpoints and Important: Profile editing is replaced in place.

The header of the content element

The editor renders no header of its content element, and nothing reads plugin.tx_academicpersonsedit.renderContentElementHeader of 2.4 any more. A site that switched the constant on, because its content element layout renders no header, loses the header and subheader of the content element. Remove the constant, and render the header through a content element layout of the site, as the entry shows. See Breaking: The profile editing plugin renders no content element header.

The constant plugin.tx_academicpersonsedit.view.layoutRootPath is removed as well, the editor renders without a Fluid layout.

The profile image upload

An empty value of plugin.tx_academicpersonsedit.settings.editForm.profileImage.validation.allowedMimeTypes or ...validation.maxFileSize no longer switches the validation off. It falls back to image/jpeg,image/png,image/webp and 2M. A site that emptied a setting to accept every image or every size lists the accepted types and the size explicitly. See Breaking: Profile image upload validation always applies.

The settings of the editor

The editor reads its fields from Configuration/AcademicPersons/Settings.yaml of academic_persons, which version 3.0 builds from sections. The contract form renders the fields of contracts.fields, and the address, email address and phone number forms those of contracts.contactSections.<section>.fields, in the order of the file. A field the file does not declare is neither rendered nor written. A site package with its own settings file declares the contract fields and the contact sections it wants, after the migration the upgrade chapter of academic_persons describes. See Breaking: Contract fields and contacts are configured as a unit and Profile editor and validation.

Extension configuration

profile.autoCreateProfiles and profile.createProfileForUserGroups are removed from the extension configuration of this extension. They have had no effect since 2.1, where academic_persons took them over. Run the wizard academicPersons_MigrateProfileAutoCreateExtensionsConfiguration of academic_persons if it is still offered, it copies the values over, and drop the two options from the deployment configuration afterwards.

Labels

The labels of the old form flow are removed, 149 units of locallang.xlf, and the editor brings its own under the prefix profileEditing.*. An override or a translation of a removed unit has no effect any more. Compare the overrides with the shipped file.

The help texts and the section headings of the editor read their overrides from plugin.tx_academicpersonsedit._LOCAL_LANG. See Important: Label overrides of the profile editor read the paths of the editor and Labels.

Adapt templates and assets

The replaced view

Every Fluid file of the form flow of 2.4 is removed: the layout Layouts/ProfileEdit.html, the templates of the profile, the contract, the email address, the phone number, the address and the profile information below Templates/, and the partials below Partials/Profile/Buttons/, Partials/Profile/Forms/, Partials/Profile/List/, Partials/Profile/Properties/ and Partials/Profile/Show/. Only Templates/Profile/List.html stays, rewritten. The new view is Templates/Profile/Index.html with its partials below Partials/Profile/. See Breaking: Replaced the profile editing view.

An override of a removed file is no longer rendered. Delete it, and re-apply what the project still wants on top of the new files. Overriding templates names the files that carry the hooks the script of the editor binds to.
A link to a removed controller or action answers with an error page. Link to the action index with the argument profileUid, or to the list of profiles.
The editor configuration Resources/Public/JavaScript/frontend/ckeditor.js of 2.4 is removed. The editor loads CKEditor 5 from rte_ckeditor itself.

The upgrade check with the extension key and a site reports every override of a removed file, see The upgrade check.

Classes and styles

The templates carry the speaking ace-* classes the academic extensions share. Only the grid classes, the button classes and visually-hidden of Bootstrap stay. The scripts show and hide markup through the attribute hidden, not the class d-none. An override keeps the data-pe-* attributes and the ace-message of a field. See Breaking: Profile editing templates carry speaking classes and the chapter Styling.

The extension ships no stylesheet, as in 2.4. Only the development versions of 3.0 shipped one for the editor. Some parts of the new editor do not work without rules of the site: the image cropper, the elements hidden with [hidden] where a display utility of Bootstrap outranks the attribute, and the display of the custom elements. Copy those rules from the stylesheet of the development instances, see An example and Breaking: The profile editing plugin ships no stylesheet. On TYPO3 13.4.36, 14.3.8 and later the rich text fields need the interface stylesheet of CKEditor 5 as well, which the site links from EXT:rte_ckeditor, see The rich text editor.

Icons

The editor renders the shared action and state icons of academic_base with its ab:icon ViewHelper. The academic-persons-edit-* identifiers are removed, five of them without a successor, and the content element icon is tx-academicpersonsedit-plugin-profile-editing now. A replacement of an editor icon moves to the Configuration/FrontendIcons.php of the site package, under the tx-academicbase-* identifier. The icons are inlined as <svg>, so a selector such as .t3js-icon img no longer matches. See Breaking: Profile editing renders the shared icon set and Icon identifiers.

Adapt your code

The contract form has no Publish switch any more. ContractFormData loses $publish and isPublish(), and a save that still sends publish is refused with HTTP 422. Drop it from overrides, clients and constructor calls. See Breaking: The contract form has no "Publish" switch.
The five controllers of the contracts, the profile information and the contacts are removed, and ProfileController keeps only the actions of the new editor. AbstractActionController, UserSessionService, AbstractFormDataConverter and the five validators of the contract, address, email, phone number and profile information forms are removed as well, see The replaced view. A project that completes or refuses a write of the editor listens to BeforeProfileEditingWriteEvent, see BeforeProfileEditingWriteEvent.
UnknownValidatorException and UnsuitableValidatorException moved to the namespace \FGTCLB\AcademicBase\Settings\Exception. See Important: Validator exceptions moved to EXT:academic_base.
The listener SyncChangesToTranslations takes its record synchronizer as $recordSynchronizer now. Code that creates it with the named argument recordSyncronizer: changes it, see the breaking change entry of academic_persons.

Check the result

The upgrade check reports no override of a removed file, and exits with 0, without and with the extension key, see The upgrade check.
The new content element wizard offers the content element as Edit Person’s Profiles, see Important: Content elements have new titles and descriptions.
The editor loads without the alert that the profile cannot be saved, a field can be saved, and the browser console shows no failed request to the page type 1733735.
The header of a profile editing content element appears once.
The image cropper can be dragged, and the regions the editor hides stay hidden.
A profile image uploads, and a translated profile shows an image in every language. An upload in one language does not change the image of another.
The rich text fields start the editor, and its toolbar shows small icons in one row.