incompatibilities-3-1-rc.md

• AddressBundle
• ApiBundle
• ChainProcessor
• ConfigBundle
• CurrencyBundle
• EmailBundle
• EntityBundle
• EntitySerializer
• ImapBundle
• QueryDesignerBundle
• TestUtils

AddressBundle

• The FixAddressesPrimaryAndTypesSubscriber^[?] class was removed.
• The FixAddressesPrimarySubscriber::handlePrimary^[?] method was removed.
• The FixAddressesTypesSubscriber::handleType^[?] method was removed.
• The AbstractAddress::isRegionValid^[?] method was removed.
• The FixAddressesPrimarySubscriber::__construct($addressesProperty)^[?] method was changed to FixAddressesPrimarySubscriber::__construct(string $addressesPropertyPath, PropertyAccessorInterface $propertyAccessor = null)^[?]
• The FixAddressesTypesSubscriber::__construct($addressesProperty)^[?] method was changed to FixAddressesTypesSubscriber::__construct(string $addressesPropertyPath, PropertyAccessorInterface $propertyAccessor = null)^[?]
• The following properties in class FixAddressesPrimarySubscriber^[?] were removed:
  • $addressesProperty^[?]
  • $addressesAccess^[?]
• The following properties in class FixAddressesTypesSubscriber^[?] were removed:
  • $addressesProperty^[?]
  • $addressAccess^[?]

ApiBundle

• The following classes were removed:

  • SetDefaultPaging^[?]
  • AddFieldsFilter^[?]
  • AddIncludeFilter^[?]
  • HandleFieldsFilter^[?]
  • HandleIncludeFilter^[?]
  • SetDefaultPaging^[?]

• The following methods in class AbstractDocumentBuilder^[?] were changed:

  • __construct()^[?]
  • __construct(ValueNormalizer $valueNormalizer, EntityIdTransformerRegistry $entityIdTransformerRegistry, LoggerInterface $logger)^[?]

  • convertToEntityType($entityClass, RequestType $requestType, $throwException = true)^[?]
  • convertToEntityType(string $entityClass, RequestType $requestType, bool $throwException = true)^[?]

• The RestFilterValueAccessor::has($key)^[?] method was changed to RestFilterValueAccessor::has(string $key)^[?]

• The RestDocumentBuilder::convertToEntityType($entityClass, RequestType $requestType, $throwException = true)^[?] method was changed to RestDocumentBuilder::convertToEntityType(string $entityClass, RequestType $requestType, bool $throwException = true)^[?]

• The ErrorCompleter::__construct(ExceptionTextExtractorInterface $exceptionTextExtractor, ValueNormalizer $valueNormalizer)^[?] method was changed to ErrorCompleter::__construct(ExceptionTextExtractorInterface $exceptionTextExtractor, ValueNormalizer $valueNormalizer, FilterNamesRegistry $filterNamesRegistry)^[?]

• The JsonApiDocumentBuilder::convertToEntityType($entityClass, RequestType $requestType, $throwException = true)^[?] method was changed to JsonApiDocumentBuilder::convertToEntityType(string $entityClass, RequestType $requestType, bool $throwException = true)^[?]

• The ResourcesWithoutIdentifierLoader::__construct(ActionProcessorBagInterface $processorBag)^[?] method was changed to ResourcesWithoutIdentifierLoader::__construct(ConfigProvider $configProvider)^[?]

• The MatchApplicableChecker::__construct(array $ignoredAttributes = [ ... ], array $classAttributes = [])^[?] method was changed to MatchApplicableChecker::__construct(array $ignoredAttributes = [ ... ], array $classAttributes = [])^[?]

• The SubresourceContext::setParentMetadata(EntityMetadata $metadata = null)^[?] method was changed to SubresourceContext::setParentMetadata($metadata)^[?]

• The BuildResultDocument::__construct(DocumentBuilderFactory $documentBuilderFactory, ErrorCompleterRegistry $errorCompleterRegistry, LoggerInterface $logger)^[?] method was changed to BuildResultDocument::__construct(ErrorCompleterRegistry $errorCompleterRegistry, LoggerInterface $logger)^[?]

• The HandleMetaPropertyFilter::__construct(ValueNormalizer $valueNormalizer)^[?] method was changed to HandleMetaPropertyFilter::__construct(FilterNamesRegistry $filterNamesRegistry, ValueNormalizer $valueNormalizer)^[?]

• The RegisterDynamicFilters::__construct(FilterFactoryInterface $filterFactory, DoctrineHelper $doctrineHelper, ConfigProvider $configProvider, $filterGroup = null)^[?] method was changed to RegisterDynamicFilters::__construct(FilterFactoryInterface $filterFactory, DoctrineHelper $doctrineHelper, ConfigProvider $configProvider, FilterNamesRegistry $filterNamesRegistry)^[?]

• The SetDefaultPaging::addPageNumberFilter(FilterCollection $filters)^[?] method was changed to SetDefaultPaging::addPageNumberFilter(string $filterName, FilterCollection $filters)^[?]

• The SetDefaultSorting::addSortFilter(FilterCollection $filters, EntityDefinitionConfig $config)^[?] method was changed to SetDefaultSorting::addSortFilter(string $filterName, FilterCollection $filters, EntityDefinitionConfig $config)^[?]

• The ValidateSorting::__construct(DoctrineHelper $doctrineHelper, ConfigProvider $configProvider)^[?] method was changed to ValidateSorting::__construct(DoctrineHelper $doctrineHelper, ConfigProvider $configProvider, FilterNamesRegistry $filterNamesRegistry)^[?]

• The CorrectSortValue::__construct(DoctrineHelper $doctrineHelper, ValueNormalizer $valueNormalizer)^[?] method was changed to CorrectSortValue::__construct(DoctrineHelper $doctrineHelper, ValueNormalizer $valueNormalizer, FilterNamesRegistry $filterNamesRegistry)^[?]

• The MapPrimaryField::updateAssociationData($collection, $dataPropertyPath, $primaryFlagPropertyPath, $primaryValue)^[?] method was changed to MapPrimaryField::updateAssociationData($collection, $primaryValue, EntityDefinitionFieldConfig $association)^[?]

• The SetLocationHeader::__construct(RestRoutes $routes, RouterInterface $router, ValueNormalizer $valueNormalizer, EntityIdTransformerRegistry $entityIdTransformerRegistry)^[?] method was changed to SetLocationHeader::__construct(RestRoutesRegistry $routesRegistry, UrlGeneratorInterface $urlGenerator, ValueNormalizer $valueNormalizer, EntityIdTransformerRegistry $entityIdTransformerRegistry)^[?]

• The FilterHelper::getBooleanFilterValue($fieldName)^[?] method was changed to FilterHelper::getBooleanFilterValue(string $fieldName)^[?]

• The FilterValue::__construct($path, $value, $operator = null)^[?] method was changed to FilterValue::__construct(string $path, $value, string $operator = null)^[?]

• The NullFilterValueAccessor::has($key)^[?] method was changed to NullFilterValueAccessor::has(string $key)^[?]

• The DumpMetadataCommand::getMetadata($entityClass, $version, RequestType $requestType, $action)^[?] method was changed to DumpMetadataCommand::getMetadata($entityClass, $version, RequestType $requestType, $action, $hateoas)^[?]

• The IncludedEntityCollection::setPrimaryEntity($entity)^[?] method was changed to IncludedEntityCollection::setPrimaryEntity($entity, $metadata)^[?]

• The FilterValueAccessorInterface::has($key)^[?] method was changed to FilterValueAccessorInterface::has(string $key)^[?]

• The following methods in class JsonApiDocumentBuilder^[?] were removed:

  • __construct^[?]
  • getEntityIdTransformer^[?]

• The following methods in class SetDefaultPaging^[?] were removed:

  • getPageNumberFilterKey^[?]
  • getPageSizeFilterKey^[?]

• The SetDefaultSorting::getSortFilterKey^[?] method was removed.

• The ValidateSorting::getSortFilterKey^[?] method was removed.

• The FilterValue::setSourceKey^[?] method was removed.

• The following properties in class JsonApiDocumentBuilder^[?] were removed:

  • $valueNormalizer^[?]
  • $entityIdAccessor^[?]

• The BuildResultDocument::$documentBuilderFactory^[?] property was removed. The following methods in interface DocumentBuilderInterface were added (with link)

  • getEntityAlias^[?]
  • getEntityId^[?]
  • setMetadata^[?]
  • addLink^[?]
  • addLinkMetadata^[?] The following methods in interface ContextInterface were added (with link)
  • isMasterRequest^[?]
  • setMasterRequest^[?]
  • isCorsRequest^[?]
  • setCorsRequest^[?]
  • isHateoasEnabled^[?]
  • setHateoas^[?]
  • getInfoRecords^[?]
  • setInfoRecords^[?]

ChainProcessor

• The ProcessorsLoader::loadProcessors(ContainerBuilder $container, $processorTagName)^[?] method was changed to ProcessorsLoader::loadProcessors(ContainerBuilder $container, string $processorTagName)^[?]

ConfigBundle

• The SetDefaultValueForFieldsFilter^[?] class was removed.

CurrencyBundle

• The AclLoadFieldMetadataListener::__construct(ConfigManager $configManager, TranslatorInterface $translator)^[?] method was changed to AclLoadFieldMetadataListener::__construct(ConfigManager $configManager)^[?]
• The AclLoadFieldMetadataListener::$translator^[?] property was removed.

EmailBundle

• The following classes were removed:
  • Decode^[?]
  • Headers^[?]
  • Bcc^[?]
  • Cc^[?]
  • ContentType^[?]
  • HeaderLoader^[?]
  • OptionalAddressList^[?]
• The EmailTemplateRepository::getEntityTemplatesQueryBuilder($entityName, Organization $organization, $includeNonEntity = false, $includeSystemTemplates = true, $visibleOnly = true)^[?] method was changed to EmailTemplateRepository::getEntityTemplatesQueryBuilder($entityName, Organization $organization, $includeNonEntity = false, $includeSystemTemplates = true, $visibleOnly = true, array $excludeNames = [])^[?]

EntityBundle

• The EntityFieldFallbackValue::$specialRelations^[?] property was removed.
• The ValidateEntityFallback::__construct(EntityFallbackResolver $fallbackResolver, ValueNormalizer $valueNormalizer)^[?] method was changed to ValidateEntityFallback::__construct(EntityFallbackResolver $fallbackResolver, PropertyAccessorInterface $propertyAccessor)^[?]

EntitySerializer

• The following methods in class ConfigNormalizer^[?] were removed:
  • applyExcludedFieldsConfig^[?]
  • applyResultNameConfig^[?]
• The EntitySerializer::getRelatedItemsIds($bindings)^[?] method was changed to EntitySerializer::getRelatedItemsIds($bindings, $limit)^[?]

ImapBundle

• The Imap::fetch($items, $from, $to = null)^[?] method was changed to Imap::fetch($items, $from, $to = null, $uid = false)^[?]

QueryDesignerBundle

• The following methods in class DefinitionQueryValidator^[?] were removed:
  • isColumnAvailable^[?]
  • isClassAvailable^[?]
• The DefinitionQueryValidator::__construct(EntityWithFieldsProvider $fieldsProvider)^[?] method was changed to DefinitionQueryValidator::__construct(ConfigProvider $entityConfigProvider, EntityFieldProvider $fieldProvider)^[?]
• The following properties in class DefinitionQueryValidator^[?] were removed:
  • $fieldsProvider^[?]
  • $availableEntityFields^[?]

TestUtils

• The OrmTestCase::__destruct^[?] method was removed.