Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add return types to bridges #42501

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 13, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions src/Symfony/Bridge/Doctrine/CacheWarmer/ProxyCacheWarmer.php
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,8 @@ public function __construct(ManagerRegistry $registry)

/**
* This cache warmer is not optional, without proxies fatal error occurs!
*
* @return bool
*/
public function isOptional()
public function isOptional(): bool
{
return false;
}
Expand All @@ -46,7 +44,7 @@ public function isOptional()
*
* @return string[] A list of files to preload on PHP 7.4+
*/
public function warmUp(string $cacheDir)
public function warmUp(string $cacheDir): array
{
$files = [];
foreach ($this->registry->getManagers() as $em) {
Expand Down
18 changes: 5 additions & 13 deletions src/Symfony/Bridge/Doctrine/ContainerAwareEventManager.php
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,8 @@ public function __construct(ContainerInterface $container, array $subscriberIds

/**
* {@inheritdoc}
*
* @return void
*/
public function dispatchEvent($eventName, EventArgs $eventArgs = null)
public function dispatchEvent($eventName, EventArgs $eventArgs = null): void
{
if (!$this->initializedSubscribers) {
$this->initializeSubscribers();
Expand All @@ -74,7 +72,7 @@ public function dispatchEvent($eventName, EventArgs $eventArgs = null)
*
* @return object[][]
*/
public function getListeners($event = null)
public function getListeners($event = null): array
{
if (!$this->initializedSubscribers) {
$this->initializeSubscribers();
Expand All @@ -98,10 +96,8 @@ public function getListeners($event = null)

/**
* {@inheritdoc}
*
* @return bool
*/
public function hasListeners($event)
public function hasListeners($event): bool
{
if (!$this->initializedSubscribers) {
$this->initializeSubscribers();
Expand All @@ -112,10 +108,8 @@ public function hasListeners($event)

/**
* {@inheritdoc}
*
* @return void
*/
public function addEventListener($events, $listener)
public function addEventListener($events, $listener): void
{
if (!$this->initializedSubscribers) {
$this->initializeSubscribers();
Expand All @@ -138,10 +132,8 @@ public function addEventListener($events, $listener)

/**
* {@inheritdoc}
*
* @return void
*/
public function removeEventListener($events, $listener)
public function removeEventListener($events, $listener): void
{
if (!$this->initializedSubscribers) {
$this->initializeSubscribers();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -114,15 +114,15 @@ public function getTime()
/**
* {@inheritdoc}
*/
public function getName()
public function getName(): string
{
return 'db';
}

/**
* {@inheritdoc}
*/
protected function getCasters()
protected function getCasters(): array
{
return parent::getCasters() + [
ObjectParameter::class => static function (ObjectParameter $o, array $a, Stub $s): array {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ protected function setMappingDriverConfig(array $mappingConfig, string $mappingN
*
* @return array|false
*/
protected function getMappingDriverBundleConfigDefaults(array $bundleConfig, \ReflectionClass $bundle, ContainerBuilder $container)
protected function getMappingDriverBundleConfigDefaults(array $bundleConfig, \ReflectionClass $bundle, ContainerBuilder $container): array|false
{
$bundleDir = \dirname($bundle->getFileName());

Expand Down Expand Up @@ -261,7 +261,7 @@ protected function assertValidMappingConfiguration(array $mappingConfig, string
*
* @return string|null A metadata driver short name, if one can be detected
*/
protected function detectMetadataDriver(string $dir, ContainerBuilder $container)
protected function detectMetadataDriver(string $dir, ContainerBuilder $container): ?string
{
$configPath = $this->getMappingResourceConfigDirectory();
$extension = $this->getMappingResourceExtension();
Expand Down Expand Up @@ -300,11 +300,9 @@ protected function loadObjectManagerCacheDriver(array $objectManager, ContainerB
/**
* Loads a cache driver.
*
* @return string
*
* @throws \InvalidArgumentException
*/
protected function loadCacheDriver(string $cacheName, string $objectManagerName, array $cacheDriver, ContainerBuilder $container)
protected function loadCacheDriver(string $cacheName, string $objectManagerName, array $cacheDriver, ContainerBuilder $container): string
{
$cacheDriverServiceId = $this->getObjectManagerElementName($objectManagerName.'_'.$cacheName);

Expand Down Expand Up @@ -381,7 +379,7 @@ protected function loadCacheDriver(string $cacheName, string $objectManagerName,
*
* @return array The modified version of $managerConfigs
*/
protected function fixManagersAutoMappings(array $managerConfigs, array $bundles)
protected function fixManagersAutoMappings(array $managerConfigs, array $bundles): array
{
if ($autoMappedManager = $this->validateAutoMapping($managerConfigs)) {
foreach (array_keys($bundles) as $bundle) {
Expand All @@ -405,33 +403,25 @@ protected function fixManagersAutoMappings(array $managerConfigs, array $bundles
* Prefixes the relative dependency injection container path with the object manager prefix.
*
* @example $name is 'entity_manager' then the result would be 'doctrine.orm.entity_manager'
*
* @return string
*/
abstract protected function getObjectManagerElementName(string $name);
abstract protected function getObjectManagerElementName(string $name): string;

/**
* Noun that describes the mapped objects such as Entity or Document.
*
* Will be used for autodetection of persistent objects directory.
*
* @return string
*/
abstract protected function getMappingObjectDefaultName();
abstract protected function getMappingObjectDefaultName(): string;

/**
* Relative path from the bundle root to the directory where mapping files reside.
*
* @return string
*/
abstract protected function getMappingResourceConfigDirectory();
abstract protected function getMappingResourceConfigDirectory(): string;

/**
* Extension used by the mapping files.
*
* @return string
*/
abstract protected function getMappingResourceExtension();
abstract protected function getMappingResourceExtension(): string;

/**
* The class name used by the various mapping drivers.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ public function process(ContainerBuilder $container)
* @throws InvalidArgumentException if non of the managerParameters has a
* non-empty value
*/
protected function getChainDriverServiceName(ContainerBuilder $container)
protected function getChainDriverServiceName(ContainerBuilder $container): string
{
return sprintf($this->driverPattern, $this->getManagerName($container));
}
Expand All @@ -183,7 +183,7 @@ protected function getChainDriverServiceName(ContainerBuilder $container)
*
* @return Definition|Reference the metadata driver to add to all chain drivers
*/
protected function getDriver(ContainerBuilder $container)
protected function getDriver(ContainerBuilder $container): Definition|Reference
{
return $this->driver;
}
Expand Down Expand Up @@ -230,7 +230,7 @@ private function getManagerName(ContainerBuilder $container): string
*
* @return bool whether this compiler pass really should register the mappings
*/
protected function enabled(ContainerBuilder $container)
protected function enabled(ContainerBuilder $container): bool
{
return !$this->enabledParameter || $container->hasParameter($this->enabledParameter);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ interface EntityLoaderInterface
*
* @return array The entities
*/
public function getEntities();
public function getEntities(): array;

/**
* Returns an array of entities matching the given identifiers.
*
* @return array The entities
*/
public function getEntitiesByIds(string $identifier, array $values);
public function getEntitiesByIds(string $identifier, array $values): array;
}
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,15 @@ public function __construct(QueryBuilder $queryBuilder)
/**
* {@inheritdoc}
*/
public function getEntities()
public function getEntities(): array
{
return $this->queryBuilder->getQuery()->execute();
}

/**
* {@inheritdoc}
*/
public function getEntitiesByIds(string $identifier, array $values)
public function getEntitiesByIds(string $identifier, array $values): array
{
if (null !== $this->queryBuilder->getMaxResults() || null !== $this->queryBuilder->getFirstResult()) {
// an offset or a limit would apply on results including the where clause with submitted id values
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class CollectionToArrayTransformer implements DataTransformerInterface
*
* @throws TransformationFailedException
*/
public function transform(mixed $collection)
public function transform(mixed $collection): mixed
{
if (null === $collection) {
return [];
Expand All @@ -54,7 +54,7 @@ public function transform(mixed $collection)
*
* @return Collection A collection of entities
*/
public function reverseTransform(mixed $array)
public function reverseTransform(mixed $array): Collection
{
if ('' === $array || null === $array) {
$array = [];
Expand Down
5 changes: 3 additions & 2 deletions src/Symfony/Bridge/Doctrine/Form/DoctrineOrmExtension.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
use Doctrine\Persistence\ManagerRegistry;
use Symfony\Bridge\Doctrine\Form\Type\EntityType;
use Symfony\Component\Form\AbstractExtension;
use Symfony\Component\Form\FormTypeGuesserInterface;

class DoctrineOrmExtension extends AbstractExtension
{
Expand All @@ -24,14 +25,14 @@ public function __construct(ManagerRegistry $registry)
$this->registry = $registry;
}

protected function loadTypes()
protected function loadTypes(): array
{
return [
new EntityType($this->registry),
];
}

protected function loadTypeGuesser()
protected function loadTypeGuesser(): ?FormTypeGuesserInterface
{
return new DoctrineOrmTypeGuesser($this->registry);
}
Expand Down
8 changes: 4 additions & 4 deletions src/Symfony/Bridge/Doctrine/Form/DoctrineOrmTypeGuesser.php
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public function __construct(ManagerRegistry $registry)
/**
* {@inheritdoc}
*/
public function guessType(string $class, string $property)
public function guessType(string $class, string $property): ?TypeGuess
{
if (!$ret = $this->getMetadata($class)) {
return new TypeGuess('Symfony\Component\Form\Extension\Core\Type\TextType', [], Guess::LOW_CONFIDENCE);
Expand Down Expand Up @@ -94,7 +94,7 @@ public function guessType(string $class, string $property)
/**
* {@inheritdoc}
*/
public function guessRequired(string $class, string $property)
public function guessRequired(string $class, string $property): ?ValueGuess
{
$classMetadatas = $this->getMetadata($class);

Expand Down Expand Up @@ -134,7 +134,7 @@ public function guessRequired(string $class, string $property)
/**
* {@inheritdoc}
*/
public function guessMaxLength(string $class, string $property)
public function guessMaxLength(string $class, string $property): ?ValueGuess
{
$ret = $this->getMetadata($class);
if ($ret && isset($ret[0]->fieldMappings[$property]) && !$ret[0]->hasAssociation($property)) {
Expand All @@ -155,7 +155,7 @@ public function guessMaxLength(string $class, string $property)
/**
* {@inheritdoc}
*/
public function guessPattern(string $class, string $property)
public function guessPattern(string $class, string $property): ?ValueGuess
{
$ret = $this->getMetadata($class);
if ($ret && isset($ret[0]->fieldMappings[$property]) && !$ret[0]->hasAssociation($property)) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
*/
class MergeDoctrineCollectionListener implements EventSubscriberInterface
{
public static function getSubscribedEvents()
public static function getSubscribedEvents(): array
{
// Higher priority than core MergeCollectionListener so that this one
// is called before
Expand Down
9 changes: 2 additions & 7 deletions src/Symfony/Bridge/Doctrine/Form/Type/DoctrineType.php
Original file line number Diff line number Diff line change
Expand Up @@ -229,15 +229,10 @@ public function configureOptions(OptionsResolver $resolver)

/**
* Return the default loader object.
*
* @return EntityLoaderInterface
*/
abstract public function getLoader(ObjectManager $manager, object $queryBuilder, string $class);
abstract public function getLoader(ObjectManager $manager, object $queryBuilder, string $class): EntityLoaderInterface;

/**
* @return string
*/
public function getParent()
public function getParent(): string
{
return ChoiceType::class;
}
Expand Down
6 changes: 2 additions & 4 deletions src/Symfony/Bridge/Doctrine/Form/Type/EntityType.php
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,8 @@ public function configureOptions(OptionsResolver $resolver)
* Return the default loader object.
*
* @param QueryBuilder $queryBuilder
*
* @return ORMQueryBuilderLoader
*/
public function getLoader(ObjectManager $manager, object $queryBuilder, string $class)
public function getLoader(ObjectManager $manager, object $queryBuilder, string $class): ORMQueryBuilderLoader
{
if (!$queryBuilder instanceof QueryBuilder) {
throw new \TypeError(sprintf('Expected an instance of "%s", but got "%s".', QueryBuilder::class, get_debug_type($queryBuilder)));
Expand All @@ -62,7 +60,7 @@ public function getLoader(ObjectManager $manager, object $queryBuilder, string $
/**
* {@inheritdoc}
*/
public function getBlockPrefix()
public function getBlockPrefix(): string
{
return 'entity';
}
Expand Down
8 changes: 2 additions & 6 deletions src/Symfony/Bridge/Doctrine/Logger/DbalLogger.php
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,8 @@ public function __construct(LoggerInterface $logger = null, Stopwatch $stopwatch

/**
* {@inheritdoc}
*
* @return void
*/
public function startQuery($sql, array $params = null, array $types = null)
public function startQuery($sql, array $params = null, array $types = null): void
{
if (null !== $this->stopwatch) {
$this->stopwatch->start('doctrine', 'doctrine');
Expand All @@ -50,10 +48,8 @@ public function startQuery($sql, array $params = null, array $types = null)

/**
* {@inheritdoc}
*
* @return void
*/
public function stopQuery()
public function stopQuery(): void
{
if (null !== $this->stopwatch) {
$this->stopwatch->stop('doctrine');
Expand Down
Loading