Migration

PSR-14 event RegisterAdditionalTypePropertiesEvent

The deprecated PSR-14 event RegisterAdditionalTypePropertiesEvent has been removed. As an alternative create a class implementing AdditionalPropertiesInterface (which is available since version 3.10.0), see Register additional properties for details.

Manual instantiation of a type model class

Instantiating a type model class manually with "new" is not supported anymore. The \Brotkrueml\Schema\Type\TypeFactory->create() method should be used instead (which is available since version 3.0.0):

  use Brotkrueml\Schema\Model\Type\Event;
+ use Brotkrueml\Schema\Type\TypeFactory;

  final class MyController
  {
+     public function __construct(
+         private readonly TypeFactory $typeFactory,
+     ) {}

      public function doSomething(): void
      {
          // ...

-         $event = new Event();
+         $event = $this->typeFactory->create('Event');

          // ...
      }
  }

Types and view helpers representing enumerations

Types and view helpers representing enumerations were removed. It is unlikely that they were used as they had no real purpose. Use real enumerations instead which are available since version 3.9.0.

Properties moved from core to pending

Over the time some properties moved from the core vocabulary to pending with newer version of the Schema.org definition (for whatever reason). To avoid breaking, these properties were reapplied to the corresponding type models. Those properties have no been removed. If you need some of them, register them yourself like explained in Register additional properties or install the schema_pending extension.

Type declarations added to TypeInterface

Missing return type declarations and type declarations for the argument of the setId() method have been added. If you do not implement custom type models directly from the \Brotkrueml\Schema\Core\Model\TypeInterface, you are not affected by this change. Otherwise you have to adjust the methods of your type model classes.

However, implementing a type model directly from the interface is discouraged and might not work in the future, extend from \Brotkrueml\Schema\Core\Model\AbstractType instead.

Type model classes

The type models classes were previously registered via a Configuration/TxSchema/TypeModels.php file. This file is not recognised anymore, you have to mark a type model class with the attribute \Brotkrueml\Schema\Attributes\Type now. See the Adding types section for more information.

Additionally, the static property $propertyNames of a type model class is now type-hinted as an array.

+ use Brotkrueml\Schema\Attributes\Type;

+ #[Type('MyCustomType')]
  final class MyCustomType extends AbstractType
  {
-     protected static $propertyNames = [
+     protected static array $propertyNames = [
         // ... the properties ...
      ]
  }

View helpers

Custom view helpers need to specify a property which holds the name of the type:

  final class MyCustomTypeViewHelper extends AbstractTypeViewHelper
  {
+     protected string $type = 'MyCustomType';
  }

Type factory

The call of the static method \Brotkrueml\Schema\Type\TypeFactory::createType() has been deprecated. Instead, inject the TypeFactory into the constructor and use the new create() method:

 <?php

 declare(strict_types=1);

 namespace MyVendor\MyExtension\Controller;

 use Brotkrueml\Schema\Type\TypeFactory;

 final class MyController
 {
+    public function __construct(
+        private readonly TypeFactory $typeFactory,
+    ) {}

     public function doSomething(): void
     {
         // ...

-        $person = TypeFactory::createType('Person');
+        $person = $this->typeFactory->create('Person');

         // ...
     }
 }

Signal/Slots

The signal/slots were removed:

• registerAdditionalTypeProperties
• shouldEmbedMarkup

You can migrate the slots easily to the PSR-14 event listeners:

Previous slot (in ext_localconf.php):

$signalSlotDispatcher = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(
   TYPO3\CMS\Extbase\SignalSlot\Dispatcher::class
);
$signalSlotDispatcher->connect(
   \Brotkrueml\Schema\Core\Model\AbstractType::class,
   'registerAdditionalTypeProperties',
   \MyVendor\MyExtension\EventListener\AdditionalPropertiesForPerson::class,
   '__invoke'
);

PSR-14 event listener (in Configuration/Services.yaml):

services:
   # Place here the default dependency injection configuration

   MyVendor\MyExtension\EventListener\AdditionalPropertiesForPerson:
      tags:
         - name: event.listener
           identifier: 'myAdditionalPropertiesForPerson'

You can find more information about the PSR-14 event listeners in the chapter PSR-14 events.

Removed Deprecations

The following deprecated methods and classes were removed:

• \Brotkrueml\Schema\Core\Model\AbstractType->isEmpty()
• \Brotkrueml\Schema\Manager\SchemaManager->setMainEntityOfWebPage()
• \Brotkrueml\Schema\Provider\TypesProvider

For the migration follow the instructions on the deprecations chapter.

Markup is embedded by default on "noindex" pages

In schema version 1.x the markup was not embedded on "noindex" pages (with installed SEO system extension). In version 2 the markup is embedded by default also on these pages. You can deactivate this behaviour in the extension configuration.

Also in version 1.x a PSR-14 event \Brotkrueml\Schema\Event\ShouldEmbedMarkupEvent was available to change the default behaviour of not embedding the markup on "noindex" pages. With the new configuration option this is not necessary anymore and event listeners for this event must be removed.