Testing 2.x.x extension version in projects (composer mode) 

It is already possible to use and test the 2.x version in composer based instances, which is encouraged and feedback of issues not detected by us (or pull-requests).

Your project should configure minimum-stabilty: dev and prefer-stable to allow requiring each extension but still use stable versions over development versions:

composer config minimum-stability "dev" \
&& composer config "prefer-stable" true

and installed with:

composer require \
    'fgtclb/academic-persons':'2.*.*@dev'

Change the templates using TypoScript constants 

As any Extbase based extension, you can find the templates in the directory Resources/Private/.

If you want to change a template, copy the desired files to the directory where you store the templates.

We suggest that you use a sitepackage extension. Learn how to Create a sitepackage extension.

# TypoScript constants
plugin.tx_academicpersons {
    view {
        templateRootPath = EXT:mysitepackage/Resources/Private/Extensions/myextension/Templates/
        partialRootPath = EXT:mysitepackage/Resources/Private/Extensions/myextension/Partials/
        layoutRootPath = EXT:mysitepackage/Resources/Private/Extensions/myextension/Layouts/
    }
}

Also available 

Breaking Changes 

Features 

Deprecation 

Important 

Description 

EXT:academic_persons provided the academic:createprofiles for quite a long time now to create profile automatically for frontend users taking data from TYPO3 fe_users records. That can be extended by extension or projects to get import data from other sources like LDAP or other external identity providers.

To further improve that handling the academic:updateprofiles is now added in a similar way to handle updates of profile data based on the source using the scheduler, for example to update data imported from external LDAP.

import_identifier varchar(170) DEFAULT '' NOT NULL is added to all extension tables and all domain models got extended to have that property along with setter und getter in place. Existing imported profile data needs to be updated in the project to have the identifier in place and custom create/update profile implementation can use that field to flag it with their data.

Further a skip_sync field is added to tx_academicpersons_domain_model_profile defaulting to false ((INT)0). If this field is set to true/1 the update command excludes these records in a early stage and do not call or dispatch any further methods or events.

Breaking Changes 

Features 

Deprecation 

Important 

Description 

ProfilesController::selectedProfilesAction() dispatched the ModifyListProfilesEvent PSR14 event accidentally due to copy&paste when introducing the new plugin and action for 2.0.x. This event is no longer dispatched for this action, instead the new and correct event ModifySelectedProfilesEvent is now dispatched.

Affected Installations 

EXT:academic_partners installations listening to the ModifyListProfilesEvent event.

Migration 

Adapt any listeners/subscribers accordingly to the correct event.

Description 

Some partials got removed as the templating structure has changed.

Impact 

Those partials include:

• Resources/Private/Partials/List/AlphabetPagination.html
• Resources/Private/Partials/List/ListItem.html
• Resources/Private/Partials/List/Pagination.html
• Resources/Private/Partials/SelectedContracts/ListItem.html

Affected Installations 

EXT:academic_partners installations overriding those partials.

Migration 

Adapt overrides accordingly to the new templating structure.

Description 

Using constructor dependency injection in abstract classes defines the constructor as API, which should be avoided by using the inject-method approach and allows to implement classes using constructor DI without the requirement to deal and align with parent (abstract) class constructor and passing it down.

AbstractProfileFactory used constructor DI and therefore violated the above described design pattern.

Constructor DI arguments are now replaced with inject-methods in the abstract FGTCLBAcademicPersonsProfileAbstractProfileFactory.

See Autowiring other Methods (e.g. Setters and Public Typed Properties)

Impact 

AbstractProfileFactory used constructor DI and therefore violated the above described design pattern.

Constructor DI arguments are now replaced with inject-methods in the abstract FGTCLBAcademicPersonsProfileAbstractProfileFactory.

Affected Installations 

Installations using the abstract and defining own constructor DI arguments.

Migration 

Implementation using the abstract and defining own constructor DI arguments needs to remove the removed parent arguments and avoid calling the parent constructor.

Additionally, the SymfonyContractsServiceAttributeRequired attribute is used for the inject methods to tell symfony DI that these inject methods needs to be called and are mandatory - beside having a visually glue for developers.

Description 

EXT:academic_persons provides a command to create profiles for frontend users, extendable by dispatching events to allow devs customizing the profile creation in projects, for example to base it on special needs like retrieving updated user data from LDAP oder other services.

Until now, all frontend users without profiles on any pid has been fetched, which does not respect use-cases where frontend users for dedicated logins are required and profile creation is not wanted, needed or suitable.

This change adds following new options to the provided command vendor/bin/typo3 academic:createprofiles:

• --include-pids: comma-separated list of storage pid's from which frontend users should be fetched (only).
• --exclude-pids: comma-separated list of storage pid's from which frontend users should be ignored (skipped).

Description 

It's possible to set a pageTitleFormat in the plugin settings for plugins using the ProfileController::detailAction(), which is used in ProfileTitleProvider to set the HTML page title for the person profile pages.

This change extends the existing ModifyDetailProfileEvent, which is dispatched in the ProfileController::detailAction(), to make the default and the setting pageTitleFormat changeable using an PSR-14 event listener.

This gives developers the ability to implement a wide range of use-cases in projects, for example adding a prefix to the format based on the site configuration or similar.

New ModifyDetailProfileEvent methods:

• getDefaultPageTitleFormat(): string
• setDefaultPageTitleFormat(string $defaultPageTitleFormat): void
• getSettingsPageTitleFormat(): string
• setSettingsPageTitleFormat(string $settingsPageTitleFormat): void
• getPageTitleFormatToUse(): string

The getPageTitleFormatToUse(): string is a calculated function to get the aggregated format to use, which allows checking the result in event listeners and determine the format finally used as detail view page title.

The original default pageTitleFormat is ProfileTitleProvider::DETAIL_PAGE_TITLE_FORMAT.

Description 

ProfileController::selectedContractsAction() dispatches now the new PSR-14 ModifySelectedContractsEvent.

The event provides following methods:

• getContracts(): QueryResultInterface return current result set.
• setContracts(QueryResultInterface $contracts): void to allow setting a custom resultset.
• getView(): FluidViewInterface|CoreViewInterface return the current view to allow assigning custom values to the view.
• getPluginControllerActionContext(): PluginControllerActionContextInterface to provide more context information

Description 

ProfileController::selectedProfilesAction() dispatches now the new PSR-14 ModifySelectedProfilesEvent instead of erroneous copied listAction event ModifyListProfilesEvent, which is no longer dispatched. That should not be that of an issue for most implementations.

The event provides following methods:

• getProfiles(): QueryResultInterface return current result set.
• setProfiles(QueryResultInterface $profiles): void to allow setting a custom resultset.
• getView(): FluidViewInterface|CoreViewInterface return the current view to allow assigning custom values to the view.
• getPluginControllerActionContext(): PluginControllerActionContextInterface to provide more context information

Description 

It's a valid use-case to use a pageTitleFormat for the person profile detail page view as HTML page title including localized text as placeholders and could be implemented using the PSR-14 event ModifyProfileTitlePlaceholderReplacementEvent dispatched in the ProfileTitleProvider.

Localization is a generic feature and it's most likely that it's use-full for a broader audience this change adds now support for localization placeholder in the format:

%%LLL:EXT:<extension-key>/Resources/.../locallang.xlf:identifier%%

Note that no context fallback detection is made like within fluid templates or extbase context areas and a valid relative path for the default language file within a extension needs to be provided.

Functional tests are added to cover the new feature basically and provide some examples, using a dedicated test fixture extension.

Description 

A new readonly DTO object PluginControllerActionContext is introduced and is attached to dispatched PSR-14 events in ProfileController actions.

Impact 

Following main getters are provided:

• getApplicationType(): ApplicationType to return the TYPO3 application type

for the current request. `getExtbaseRequestParameters(): ?ExtbaseRequestParameters` to retrieve extbase attribute from request as a simple accessor. getRequest(): ServerRequestInterface to return the current request. `getSettings(): array` to retrieve raw plugin settings (TypoScript, FlexForm). getSite(): ?Site to retrieve resolved site configuration. * getLanguage(): ?SiteLanguage to retrieve resolves site language.

Following getters dispatches to ExtbaseRequestParameters methods and returning null in case the request attribute is not set in the request:

• getActionName(): ?string
• getControllerName(): ?string
• getControllerObjectName(): ?string
• getControllerExtensionKey(): ?string
• getControllerExtensionName(): ?string
• getPluginName(): ?string

Description 

With recent changes a series of features has been implemented to make the HTML title tag for person profile pages more flexible, with a placeholder based FlexForm options and also allowing to influence the default and the setting pageTitleFormat.

The used ProfileTitleProvider already looks into the format string and provides the ability to replace placeholders, which matches getters in the profile.

To provide even more flexibility, this change introduces a new PSR-14 Event ModifyProfileTitlePlaceholderReplacementEvent, which is dispatched for each placeholder enriched with quite a handfull of use-full context information.

Following methods are available on the event:

• getPluginControllerActionContext(): PluginControllerActionContextInterface containing the request along with easy access methods to site, siteLanguage and extbase plugin information and the plugin settings.
• getProfile(): Profile the current person profile to display.
• getPlaceholder() the original/raw placeholder identifier.
• getReplacement() the value to replace the placeholder with, which may differ already if a earlier event listener changed the value using setReplacement().
• setReplacement(string $replacement): void to set the value used to replace the placeholder.

This event allows project to implement custom placeholders and the replacement without using old-school xclassing technique.

Description 

It's now possible to define the format used to generate the HTML PageTitle for the detail view of persons in the frontend, using the TYPO3 PageTitle API.

The default format used based on Profile extbase model data is:

%%TITLE%% %%FIRST_NAME%% %%MIDDLE_NAME%% %%LAST_NAME%%

To allow easier customization in project, a new FlexForm option pageTitleFormat has been added to listanddetail plugin and as single new option for the detail plugin, which uses TCA type=input combined with a ValuePicker to allow picking from a list of pre-defined formats while still making it possible to define own custom format directly on plugin usage.

The mapping from placeholder to extbase model is based on transforming the placeholder to camelcase using first character after separators and prefix it with get, and if the getter exists it is called to retrieve the value.

For example:

which calls Profile->getFirstName() to retrieve the replacement value from the detail view profile.

The whole process contains some behaviour, which needs to be kept in mind:

• Leading and trailing spaces are trimmed from each value(placeholder).
• Multiple spaces are removed from the whole format string.
• Leading and trailing spaces are trimmed from the whole format pattern, after placeholder resolving has been processed.

Example for allowed characters as placeholder identifier:

Note that most of them has no handling for matching person profile getters, but are use-full for advanced replacement using the experimental PSR-14 event.

Description 

The default templating now supports basic bootstrap styling and is semantically optimized to also not lack any major accessibility.

Breaking Changes 

Features 

Deprecation 

Important 

Description 

TYPO3 v13 deprecated the tt_content sub-type feature, only used for CType=list sub-typing also known as list_type and mostly used based on old times for extbase based plugins. It has been possible since the very beginning to register Extbase Plugins directly as CType instead of CType=list sub-type, which has now done.

Technically this is a breaking change, and instances upgrading from 1.x version of the plugin needs to update corresponding tt_content records in the database and eventually adopt addition, adjustments or overrides requiring to use the correct CType.

Impact 

The change relates to following plugins:

• academicpersons_detail
• academicpersons_list
• academicpersons_listanddetail
• academicpersons_selectedcontracts
• academicpersons_selectedprofiles

Affected Installations 

All installations using the above listed plugins prior V2.0.

Migration 

A TYPO3 UpgradeWizard academicPersons_pluginUpgradeWizard is provided to migrate plugins from CType=list to dedicated CTypes matching the new registration.

Breaking Changes 

Features 

Deprecations 

Important notes 

Description 

PSR-14 Event FGTCLBAcademicPersonsEventModifyListProfilesEvent got following new methods:

• getProfileDemand(): ProfileDemand
• setProfileDemand(ProfileDemand $profileDemand): void

This gives event listeners the ability to redo a query with the same or further enriched demand object to replace the retrieved profiles result already existing in the event and/or enrich data in the view.