Backwards compatibility changes

Changes affecting version compatibility with deprecated ezpublish-kernel version 7.5 (used by eZ Platform 2.5 LTS).

Removed features

Elasticsearch support has been dropped. It supported Elasticsearch 1.x, while the latest Elasticsearch release is 7.0.

The support for this search engine will be provided once again as a separate bundle.
The following Field Types are not supported any more and have been removed:
- ezprice,
- ezpage together with block rendering subsystem,
- ezsrrating.
The following configuration nodes are not available anymore:
- ezpublish.<scope>.ezpage.*
- ezpublish.<scope>.block_view.*
- ezpublish.siteaccess.relation_map has been replaced by getSiteAccessesRelation method from eZ\Publish\Core\MVC\Symfony\SiteAccess\SiteAccessService
REST Client has been dropped.
REST Server implementation and Common namespace have been removed in favor of eZ Platform REST Bundle available via ezsystems/ezplatform-rest package.
Assetic support has been dropped.
Minimal PHP version has been raised to 7.3.
Deprecated method getName from the interface eZ\Publish\SPI\FieldType\FieldType has been changed. Now it accepts two additional parameters: FieldDefinition $fieldDefinition and string $languageCode
Interface eZ\Publish\SPI\FieldType\FieldType has been transformed to abstract class.
Interface eZ\Publish\SPI\FieldType\Nameable has been removed.
ez_trans_prop twig function was removed
ezrichtext Field Type has been completely removed from this package. Use eZ Platform RichText Bundle instead.

It also implies that:
- the semantic configuration available as:
```
ezpublish:
    ezrichtext:
```
  is no longer supported. To upgrade please make ezrichtext the top node:
```
ezrichtext:
```
- the namespace eZ\Publish\Core\FieldType\RichText has been dropped (all classes are available in the mentioned package).
Deprecated hash types constants have been dropped from \eZ\Publish\API\Repository\Values\User\User.
Deprecated eZ\Publish\SPI\FieldType\EventListener interface, eZ\Publish\SPI\FieldType\Event class and eZ\Publish\SPI\FieldType\Events namespace have been dropped.
Deprecated eZ\Publish\Core\MVC\Symfony\Matcher\MatcherInterface interface has been dropped. Deprecated classes relying on that interface have been removed as well:
- eZ\Publish\Core\MVC\Symfony\Matcher\AbstractMatcherFactory
- eZ\Publish\Core\MVC\Symfony\Matcher\ContentBasedMatcherFactory
- eZ\Publish\Core\MVC\Symfony\Matcher\ContentMatcherFactory
- eZ\Publish\Core\MVC\Symfony\Matcher\LocationMatcherFactory
Deprecated Symfony framework templating component integration has been dropped.
Following API methods have been removed:
- \eZ\Publish\API\Repository\ContentService::removeTranslation
- \eZ\Publish\API\Repository\UserService::loadAnonymousUser
- \eZ\Publish\API\Repository\Repository::getCurrentUser
- \eZ\Publish\API\Repository\Repository::getCurrentUserReference
- \eZ\Publish\API\Repository\Repository::setCurrentUser
- \eZ\Publish\API\Repository\Repository::hasAccess
- \eZ\Publish\API\Repository\Repository::canUser
- \eZ\Publish\API\Repository\RoleService::updateRole
- \eZ\Publish\API\Repository\RoleService::addPolicy
- \eZ\Publish\API\Repository\RoleService::deletePolicy
- \eZ\Publish\API\Repository\RoleService::updatePolicy
- \eZ\Publish\API\Repository\RoleService::loadPoliciesByUserId
- \eZ\Publish\API\Repository\RoleService::unassignRoleFromUser
- \eZ\Publish\API\Repository\RoleService::unassignRoleFromUserGroup
- \eZ\Publish\API\Repository\Values\Content\Query\Criterion::createFromQueryBuilder
- \eZ\Publish\API\Repository\Values\Content\Query\Criterion\Ancestor::createFromQueryBuilder
- \eZ\Publish\API\Repository\Values\Content\Query\Criterion\ContentId::createFromQueryBuilder
- \eZ\Publish\API\Repository\Values\Content\Query\Criterion\ContentTypeGroupId::createFromQueryBuilder
- \eZ\Publish\API\Repository\Values\Content\Query\Criterion\ContentTypeId::createFromQueryBuilder
- \eZ\Publish\API\Repository\Values\Content\Query\Criterion\ContentTypeIdentifier::createFromQueryBuilder
- \eZ\Publish\API\Repository\Values\Content\Query\Criterion\FieldRelation::createFromQueryBuilder
- \eZ\Publish\API\Repository\Values\Content\Query\Criterion\FullText::createFromQueryBuilder
- \eZ\Publish\API\Repository\Values\Content\Query\Criterion\LanguageCode::createFromQueryBuilder
- \eZ\Publish\API\Repository\Values\Content\Query\Criterion\LocationId::createFromQueryBuilder
- \eZ\Publish\API\Repository\Values\Content\Query\Criterion\LocationRemoteId::createFromQueryBuilder
- \eZ\Publish\API\Repository\Values\Content\Query\Criterion\MatchAll::createFromQueryBuilder
- \eZ\Publish\API\Repository\Values\Content\Query\Criterion\MatchNone::createFromQueryBuilder
- \eZ\Publish\API\Repository\Values\Content\Query\Criterion\MoreLikeThis::createFromQueryBuilder
- \eZ\Publish\API\Repository\Values\Content\Query\Criterion\ObjectStateId::createFromQueryBuilder
- \eZ\Publish\API\Repository\Values\Content\Query\Criterion\ParentLocationId::createFromQueryBuilder
- \eZ\Publish\API\Repository\Values\Content\Query\Criterion\RemoteId::createFromQueryBuilder
- \eZ\Publish\API\Repository\Values\Content\Query\Criterion\SectionId::createFromQueryBuilder
- \eZ\Publish\API\Repository\Values\Content\Query\Criterion\Subtree::createFromQueryBuilder
- \eZ\Publish\API\Repository\Values\Content\Query\Criterion\Visibility::createFromQueryBuilder
Following SPI methods have been removed:
- \eZ\Publish\SPI\Persistence\Content\Handler::removeTranslationFromContent
The "Setup" folder and Section have been removed from the initial (clean installation) data.
The "Design" Section has been removed from the initial (clean installation) data.
The following obsolete tables have been removed from the database schema:
- ezapprove_items,
- ezbasket,
- ezcollab_group,
- ezcollab_item,
- ezcollab_item_group_link,
- ezcollab_item_message_link,
- ezcollab_item_participant_link,
- ezcollab_item_status,
- ezcollab_notification_rule,
- ezcollab_profile,
- ezcollab_simple_message,
- ezcomment,
- ezcomment_notification,
- ezcomment_subscriber,
- ezcomment_subscription,
- ezcontentbrowserecent,
- ezcurrencydata,
- ezdiscountrule,
- ezdiscountsubrule,
- ezdiscountsubrule_value,
- ezenumobjectvalue,
- ezenumvalue,
- ezforgot_password,
- ezgeneral_digest_user_settings,
- ezinfocollection,
- ezinfocollection_attribute,
- ezisbn_group,
- ezisbn_group_range,
- ezisbn_registrant_range,
- ezm_block,
- ezm_pool,
- ezmessage,
- ezmodule_run,
- ezmultipricedata,
- eznotificationcollection,
- eznotificationcollection_item,
- eznotificationevent,
- ezoperation_memento,
- ezorder,
- ezorder_item,
- ezorder_nr_incr,
- ezorder_status,
- ezorder_status_history,
- ezpaymentobject,
- ezpdf_export,
- ezpending_actions,
- ezprest_authcode,
- ezprest_authorized_clients,
- ezprest_clients,
- ezprest_token,
- ezproductcategory,
- ezproductcollection,
- ezproductcollection_item,
- ezproductcollection_item_opt,
- ezpublishingqueueprocesses,
- ezrss_export,
- ezrss_export_item,
- ezrss_import,
- ezscheduled_script,
- ezsearch_search_phrase,
- ezsession,
- ezstarrating,
- ezstarrating_data,
- ezsubtree_notification_rule,
- eztipafriend_counter,
- eztipafriend_request,
- eztrigger,
- ezuservisit,
- ezuser_discountrule,
- ezvatrule,
- ezvatrule_product_category,
- ezvattype,
- ezview_counter,
- ezwaituntildatevalue,
- ezwishlist,
- ezworkflow,
- ezworkflow_assign,
- ezworkflow_event,
- ezworkflow_group,
- ezworkflow_group_link,
- ezworkflow_process.
If your project doesn't use them, you can drop them from your database by executing the SQL:
```
    DROP TABLE <table_name>;
```
Clean Installer (EzSystems\PlatformInstallerBundle\Installer\CleanInstaller), its service definition (ezplatform.installer.clean_installer), and the ezplatform.installer.clean_installer.class parameter have been dropped. Instead use the EzSystems\DoctrineSchema\API\Event\SchemaBuilderEvents::BUILD_SCHEMA event with an event subscriber, and if needed, additionally with the Core Installer (EzSystems\PlatformInstallerBundle\Installer\CoreInstaller). See eZ Platform Documentation for more details.
The ezplatform.installer.db_based_installer.class and ezplatform.installer.install_command.class parameters have been dropped. The ezplatform.installer.db_based_installer service definition has been dropped as well. Instead, the FQCN-named service EzSystems\PlatformInstallerBundle\Installer\DbBasedInstaller is available.
The EzSystems\PlatformInstallerBundle\Command\InstallPlatformCommand has been marked as final. Overriding it was never supported. Use the SchemaBuilder event-oriented extension point to inject custom behavior into the installation process (see eZ Platform Documentation for more details).
The deprecated Legacy SQL schema files (data/mysql/schema.sql, data/mysql/dfs_schema.sql) have been removed. Use Schema Builder instead.
The obsolete data/demo_data.php file has been removed.
The following deprecated (since v6.11) LegacyStorage Gateways were removed:
- eZ\Publish\Core\FieldType\BinaryFile\BinaryBaseStorage\Gateway\LegacyStorage,
- eZ\Publish\Core\FieldType\BinaryFile\BinaryFileStorage\Gateway\LegacyStorage,
- eZ\Publish\Core\FieldType\MapLocation\MapLocationStorage\Gateway\LegacyStorage,
- eZ\Publish\Core\FieldType\Image\ImageStorage\Gateway\LegacyStorage,
- eZ\Publish\Core\FieldType\Keyword\KeywordStorage\Gateway\LegacyStorage,
- eZ\Publish\Core\FieldType\Media\MediaStorage\Gateway\LegacyStorage,
- eZ\Publish\Core\FieldType\Url\UrlStorage\Gateway\LegacyStorage,
- eZ\Publish\Core\FieldType\User\UserStorage\Gateway\LegacyStorage.
Use DoctrineStorage Gateways from the same namespace instead.
Query Types: Traversing bundles to automatically register a Query Type by the naming convention <Bundle>\QueryType\*QueryType has been dropped. Register your Query Type as a service and explicitly tag that service with ezpublish.query or enable its automatic configuration (autoconfigure: true).
The deprecated Symfony Dependency Injection Container parameters ending with .class have been removed, services relying on them have now their classes defined explicitly. To properly decorate a Symfony service, use the decorates attribute instead. For the full list of the dropped parameters please see the 1.0/dropped-container-parameters.md document.
Deprecated viewLocation and embedLocation actions of ViewController have been dropped, along with related route _ezpublishLocation. As stated in controller, use viewAction in place of viewLocation and embedAction in place of embedLocation.
Obsolete DeferredLegacy Content Type Update handler (eZ\Publish\Core\Persistence\Legacy\Content\Type\Update\Handler\DeferredLegacy) and its optional Symfony Container Service (ezpublish.persistence.legacy.content_type.update_handler.deferred) have been removed. Subscribe to eZ Platform Symfony Events to handle deferring of updating of Content items after their Content Type update instead.
Deprecated UserService::loadUserByCredentials method has been dropped. From now on, we rely on Security package of Symfony framework to provide authenticated user, as it may happen there are different ways of providing users configured in the application (ref.: https://symfony.com/doc/current/security/user_provider.html).
Legacy (SQL) Search Engine will no longer treat deprecated % as a search wildcard. Use * instead.
Dynamic Settings feature has been dropped. It was conceptually not compatible with Symfony's Container. Consider injecting \eZ\Publish\Core\MVC\ConfigResolverInterface instead and using getParameter method to fetch SiteAccess dependent settings.
Field Type External Storage Handlers $context array no longer has the "connection" key. Rely on injected Connection instead.
The deprecated Zeta Components (eZc) Database handler has been dropped. All classes and interfaces from the namespaces eZ\Publish\Core\Persistence\Database and eZ\Publish\Core\Persistence\Doctrine were removed.

Deprecated features

Using SiteAccess-aware pagelayout setting is derecated, use page_layout instead.
View parameter pagelayout set by pagelayout setting is deprecated, use page_layout instead in your Twig templates.
The $context array of \eZ\Publish\SPI\FieldType\FieldStorage methods (storeFieldData, getFieldData, deleteFieldData, getIndexData) is deprecated and will be dropped in the next major version. Rely on injected Connection instead.

Renamed features

ezpublish global twig variable was renamed to ezplatform
ez_is_field_empty twig function was renamed to ez_field_is_empty
ez_first_filled_image_field_identifier twig function was renamed to ez_content_field_identifier_first_filled_image
ez_render_fielddefinition_settings twig function was renamed to ez_render_field_definition_settings
ez_image_asset_content_field_identifier twig function was renamed to ez_content_field_identifier_image_asset
richtext_to_html5 twig filter was renamed to ez_richtext_to_html5
richtext_to_html5_edit twig filter was renamed to ez_richtext_to_html5_edit
\eZ\Bundle\EzPublishIOBundle\ApiLoader\HandlerFactory class was renamed to HandlerRegistry
ezpublish.core.io.metadata_handler.factory service was renamed to ezpublish.core.io.metadata_handler.registry
ezpublish.core.io.binarydata_handler.factory service was renamed to ezpublish.core.io.binarydata_handler.registry

Changed features

The signature of the \eZ\Publish\API\Repository\SearchService::supports method was changed to:
```
public function supports(int $capabilityFlag): bool;
```
The signature of the \eZ\Publish\SPI\Search\Capable::supports method was changed to:
```
public function supports(int $capabilityFlag): bool;
```

The signature of the \eZ\Publish\API\Repository\Values\ValueObject\SiteAccess::__construct method was changed to make name property required:

public function __construct(
    string $name,
    string $matchingType = self::DEFAULT_MATCHING_TYPE,
    $matcher = null,
    ?string $provider = null
);

The signature of the \eZ\Publish\API\Repository\Values\ContentType\ContentType::getFieldDefinitions method was changed to:
```
abstract public function getFieldDefinitions(): FieldDefinitionCollection;
```

The signature of the \eZ\Publish\Core\Persistence\Legacy\URL\Query\CriterionHandler::handle contract accepts now \Doctrine\DBAL\Query\QueryBuilder instead of \eZ\Publish\Core\Persistence\Database\SelectQuery and has the following form:

use \Doctrine\DBAL\Query\QueryBuilder;
use \eZ\Publish\Core\Persistence\Legacy\URL\Query\CriteriaConverter;
use \eZ\Publish\API\Repository\Values\URL\Query\Criterion;

public function handle(CriteriaConverter $converter, QueryBuilder $query, Criterion $criterion);

The signature of the \eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\CriterionHandler::handle contract accepts now \Doctrine\DBAL\Query\QueryBuilder instead of \eZ\Publish\Core\Persistence\Database\SelectQuery and has the following form:

use \Doctrine\DBAL\Query\QueryBuilder;
use \eZ\Publish\API\Repository\Values\Content\Query\Criterion;
use \eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\CriteriaConverter;

abstract public function handle(
    CriteriaConverter $converter,
    QueryBuilder $queryBuilder,
    Criterion $criterion,
    array $languageSettings
);

The signature of the \eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\CriterionHandler\FieldValue\Handler::handle contract accepts now two new arguments of \Doctrine\DBAL\Query\QueryBuilder type instead of \eZ\Publish\Core\Persistence\Database\SelectQuery. The first one is an outer query, to be used only for parameter binding. The second one is a sub-query that can be modified according to a strategy needed by a particular Field Type. This change is necessary due to the nature of Doctrine Query Builder. While sub-queries are used for convenience, in the end, the only query having parameters bound and being executed is the outer query. The sub-query is used just to generate nested SQL for the outer query. The signature has the following form:
```
  use \Doctrine\DBAL\Query\QueryBuilder;
  use \eZ\Publish\API\Repository\Values\Content\Query\Criterion;
  use \Doctrine\DBAL\Query\Expression\CompositeExpression;

  public function handle(
      QueryBuilder $outerQuery,
      QueryBuilder $subQuery,
      Criterion $criterion,
      string $column
  ): CompositeExpression|string;
```
The signature of the \eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\SortClauseHandler::applySelect contract accepts now \Doctrine\DBAL\Query\QueryBuilder instead of \eZ\Publish\Core\Persistence\Database\SelectQuery and has the following form:
```
use \Doctrine\DBAL\Query\QueryBuilder;
use \eZ\Publish\API\Repository\Values\Content\Query\SortClause;

abstract public function applySelect(QueryBuilder $query, SortClause $sortClause, int $number): array;
```

The signature of the \eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\SortClauseHandler::applyJoin contract accepts now \Doctrine\DBAL\Query\QueryBuilder instead of \eZ\Publish\Core\Persistence\Database\SelectQuery and has the following form:

use \Doctrine\DBAL\Query\QueryBuilder;
use \eZ\Publish\API\Repository\Values\Content\Query\SortClause;

public function applyJoin(
        QueryBuilder $query,
        SortClause $sortClause,
        int $number,
        array $languageSettings
): void;

Removed services

ezpublish.field_type_collection.factory has been removed in favor of eZ\Publish\Core\FieldType\FieldTypeRegistry
ezpublish.persistence.external_storage_registry.factory
ezpublish.config.resolver.core has been removed. eZ\Bundle\EzPublishCoreBundle\DependencyInjection\Configuration\ChainConfigResolver should be used instead
ezpublish.api.search_engine.legacy.dbhandler and ezpublish.api.storage_engine.legacy.dbhandler have been removed. Inject \Doctrine\DBAL\Connection via ezpublish.persistence.connection instead.
ezpublish.connection has been removed. Use ezpublish.persistence.connection instead.

Changed behavior

Service based View Matchers now require to be tagged with ezplatform.view.matcher. Moreover now to use it you have to prefix service name with @ sign:

site:
    content_view:
        full:
            home:
                template: "content.html.twig"
                match:
                    '[@App](https://github.com/App)\Matcher\MyMatcher': ~

Service based SiteAccess Matchers now require to be tagged with ezplatform.siteaccess.matcher.
eZ\Bundle\EzPublishCoreBundle\Controller extends Symfony\Bundle\FrameworkBundle\Controller\AbstractController instead of Symfony\Bundle\FrameworkBundle\Controller\Controller which has limited access to the dependency injection container. See https://symfony.com/doc/current/service_container/service_subscribers_locators.html
SiteAccessAware Repository layer is now used by default. If you need to load repository object in all translations, explicitly pass \eZ\Publish\API\Repository\Values\Content\Language::ALL as as prioritized languages list.
Changed $valueFormat type from string to int in \eZ\Publish\API\Repository\Values\Content\Query\Criterion\Operator\Specifications::__construct

Ezplatform Kernel Laravel Package