Skip to content

Commit

Permalink
Fix guessing types for filters (#335)
Browse files Browse the repository at this point in the history 
* Fix guessing types for filters

* Trigger deprecations with unexisting types

* Fix test namespace
  • Loading branch information
@franmomu @core23
franmomu authored and core23 committed Dec 15, 2019
1 parent 22b3b67 commit c301dc4
Show file tree
Hide file tree
Showing 6 changed files with 309 additions and 43 deletions.
15 changes: 8 additions & 7 deletions docs/reference/filter_field_definition.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ Filter types available

Some filter types are missing. Contributions are welcome.

- doctrine_mongo_boolean : depends on the ``sonata_type_filter_default`` Form Type, renders yes or no field
- doctrine_mongo_callback : depends on the ``sonata_type_filter_default`` Form Type, types can be configured as needed
- doctrine_mongo_choice : depends on the ``sonata_type_filter_choice`` Form Type, renders yes or no field
- doctrine_mongo_model : depends on the ``sonata_type_filter_number`` Form Type
- doctrine_mongo_string : depends on the ``sonata_type_filter_choice``
- doctrine_mongo_number : depends on the ``sonata_type_filter_choice`` Form Type, renders yes or no field
- ``Sonata\DoctrineMongoDBAdminBundle\Filter\BooleanFilter`` : depends on the ``sonata_type_filter_default`` Form Type, renders yes or no field
- ``Sonata\DoctrineMongoDBAdminBundle\Filter\CallbackFilter`` : depends on the ``sonata_type_filter_default`` Form Type, types can be configured as needed
- ``Sonata\DoctrineMongoDBAdminBundle\Filter\ChoiceFilter`` : depends on the ``sonata_type_filter_choice`` Form Type, renders yes or no field
- ``Sonata\DoctrineMongoDBAdminBundle\Filter\ModelFilter`` : depends on the ``sonata_type_filter_number`` Form Type
- ``Sonata\DoctrineMongoDBAdminBundle\Filter\StringFilter`` : depends on the ``sonata_type_filter_choice``
- ``Sonata\DoctrineMongoDBAdminBundle\Filter\NumberFilter`` : depends on the ``sonata_type_filter_choice`` Form Type, renders yes or no field

Example
-------
Expand Down Expand Up @@ -109,6 +109,7 @@ or not::

use Sonata\AdminBundle\Admin\AbstractAdmin;
use Sonata\AdminBundle\Datagrid\DatagridMapper;
use Sonata\DoctrineMongoDBAdminBundle\Filter\CallbackFilter;

use App\Application\Sonata\NewsBundle\Entity\Comment;

Expand All @@ -121,7 +122,7 @@ or not::
->add('enabled')
->add('tags', null, [], null, ['expanded' => true, 'multiple' => true])
->add('author')
->add('finished', 'doctrine_mongo_callback', [
->add('finished', CallbackFilter::class', [
'callback' => function($queryBuilder, $alias, $field, $value) {
if (!$value) {
return;
Expand Down
2 changes: 1 addition & 1 deletion src/Guesser/AbstractTypeGuesser.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

namespace Sonata\DoctrineMongoDBAdminBundle\Guesser;

use Doctrine\ORM\Mapping\MappingException;
use Doctrine\ODM\MongoDB\Mapping\MappingException;
use Sonata\AdminBundle\Guesser\TypeGuesserInterface;
use Sonata\DoctrineMongoDBAdminBundle\Model\ModelManager;

Expand Down
93 changes: 74 additions & 19 deletions src/Guesser/FilterTypeGuesser.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,19 @@

use Doctrine\Bundle\MongoDBBundle\Form\Type\DocumentType;
use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
use Doctrine\ODM\MongoDB\Types\Type;
use Sonata\AdminBundle\Model\ModelManagerInterface;
use Sonata\DoctrineMongoDBAdminBundle\Filter\BooleanFilter;
use Sonata\DoctrineMongoDBAdminBundle\Filter\DateFilter;
use Sonata\DoctrineMongoDBAdminBundle\Filter\DateTimeFilter;
use Sonata\DoctrineMongoDBAdminBundle\Filter\ModelFilter;
use Sonata\DoctrineMongoDBAdminBundle\Filter\NumberFilter;
use Sonata\DoctrineMongoDBAdminBundle\Filter\StringFilter;
use Sonata\DoctrineMongoDBAdminBundle\Model\MissingPropertyMetadataException;
use Sonata\Form\Type\BooleanType;
use Sonata\Form\Type\EqualType;
use Symfony\Component\Form\Extension\Core\Type\DateTimeType;
use Symfony\Component\Form\Extension\Core\Type\DateType;
use Symfony\Component\Form\Extension\Core\Type\NumberType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\Guess\Guess;
Expand Down Expand Up @@ -62,7 +71,7 @@ public function guessType($class, $property, ModelManagerInterface $modelManager
$options['field_name'] = $mapping['fieldName'];
$options['mapping_type'] = $mapping['type'];

return new TypeGuess('doctrine_mongo_model', $options, Guess::HIGH_CONFIDENCE);
return new TypeGuess(ModelFilter::class, $options, Guess::HIGH_CONFIDENCE);
}
}

Expand All @@ -73,36 +82,82 @@ public function guessType($class, $property, ModelManagerInterface $modelManager
$options['field_name'] = $metadata->fieldMappings[$propertyName]['fieldName'];

switch ($metadata->getTypeOfField($propertyName)) {
case 'boolean':
case Type::BOOL:
case Type::BOOLEAN:
$options['field_type'] = BooleanType::class;
$options['field_options'] = [];

return new TypeGuess('doctrine_mongo_boolean', $options, Guess::HIGH_CONFIDENCE);
// case 'datetime':
// case 'vardatetime':
// case 'datetimetz':
// return new TypeGuess('doctrine_orm_datetime', $options, Guess::HIGH_CONFIDENCE);
// case 'date':
// return new TypeGuess('doctrine_orm_date', $options, Guess::HIGH_CONFIDENCE);
return new TypeGuess(BooleanFilter::class, $options, Guess::HIGH_CONFIDENCE);
case 'datetime':
@trigger_error(
'The datetime type is deprecated since sonata-project/doctrine-mongodb-admin-bundle 3.x, to be removed in 4.0.'.
E_USER_DEPRECATED
);

$options['field_type'] = DateTimeType::class;

return new TypeGuess(DateTimeFilter::class, $options, Guess::HIGH_CONFIDENCE);
case Type::TIMESTAMP:
$options['field_type'] = DateTimeType::class;

return new TypeGuess(DateTimeFilter::class, $options, Guess::HIGH_CONFIDENCE);
case Type::DATE:

// NEXT_MAJOR: Use only the constant when dropping support for doctrine/mongodb-odm 1.3.
// case Type::DATE_IMMUTABLE:
case 'date_immutable':
$options['field_type'] = DateType::class;

return new TypeGuess(DateFilter::class, $options, Guess::HIGH_CONFIDENCE);
case 'decimal':
case 'float':
return new TypeGuess('doctrine_mongo_number', $options, Guess::MEDIUM_CONFIDENCE);
case 'int':
@trigger_error(
'The decimal type is deprecated since sonata-project/doctrine-mongodb-admin-bundle 3.x, to be removed in 4.0.'.
E_USER_DEPRECATED
);

$options['field_type'] = NumberType::class;

return new TypeGuess(NumberFilter::class, $options, Guess::MEDIUM_CONFIDENCE);
case 'bigint':
@trigger_error(
'The bigint type is deprecated since sonata-project/doctrine-mongodb-admin-bundle 3.x, to be removed in 4.0.'.
E_USER_DEPRECATED
);

$options['field_type'] = NumberType::class;

return new TypeGuess(NumberFilter::class, $options, Guess::MEDIUM_CONFIDENCE);
case 'smallint':
@trigger_error(
'The smallint type is deprecated since sonata-project/doctrine-mongodb-admin-bundle 3.x, to be removed in 4.0.'.
E_USER_DEPRECATED
);

$options['field_type'] = NumberType::class;

return new TypeGuess(NumberFilter::class, $options, Guess::MEDIUM_CONFIDENCE);
case Type::FLOAT:
case Type::INT:
case Type::INTEGER:
$options['field_type'] = NumberType::class;

return new TypeGuess('doctrine_mongo_number', $options, Guess::MEDIUM_CONFIDENCE);
case 'id':
case 'string':
return new TypeGuess(NumberFilter::class, $options, Guess::MEDIUM_CONFIDENCE);
case 'text':
@trigger_error(
'The text type is deprecated since sonata-project/doctrine-mongodb-admin-bundle 3.x, to be removed in 4.0.'.
E_USER_DEPRECATED
);

$options['field_type'] = TextType::class;

return new TypeGuess(StringFilter::class, $options, Guess::MEDIUM_CONFIDENCE);
case Type::ID:
case Type::STRING:
$options['field_type'] = TextType::class;

return new TypeGuess('doctrine_mongo_string', $options, Guess::MEDIUM_CONFIDENCE);
case 'time':
return new TypeGuess('doctrine_mongo_time', $options, Guess::HIGH_CONFIDENCE);
return new TypeGuess(StringFilter::class, $options, Guess::MEDIUM_CONFIDENCE);
default:
return new TypeGuess('doctrine_mongo_string', $options, Guess::LOW_CONFIDENCE);
return new TypeGuess(StringFilter::class, $options, Guess::LOW_CONFIDENCE);
}
}
}
76 changes: 67 additions & 9 deletions src/Guesser/TypeGuesser.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
namespace Sonata\DoctrineMongoDBAdminBundle\Guesser;

use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
use Doctrine\ODM\MongoDB\Types\Type;
use Sonata\AdminBundle\Model\ModelManagerInterface;
use Symfony\Component\Form\Guess\Guess;
use Symfony\Component\Form\Guess\TypeGuess;
Expand Down Expand Up @@ -44,31 +45,88 @@ public function guessType($class, $property, ModelManagerInterface $modelManager
}

switch ($metadata->getTypeOfField($propertyName)) {
case 'collection':
case 'hash':
case Type::COLLECTION:
case Type::HASH:
return new TypeGuess('array', [], Guess::HIGH_CONFIDENCE);
case 'array':
return new TypeGuess('array', [], Guess::HIGH_CONFIDENCE);
case 'boolean':
@trigger_error(
'The array type is deprecated since sonata-project/doctrine-mongodb-admin-bundle 3.x, to be removed in 4.0.'.
E_USER_DEPRECATED
);

return new TypeGuess('array', [], Guess::HIGH_CONFIDENCE);
case Type::BOOL:
case Type::BOOLEAN:
return new TypeGuess('boolean', [], Guess::HIGH_CONFIDENCE);
case 'datetime':
@trigger_error(
'The datetime type is deprecated since sonata-project/doctrine-mongodb-admin-bundle 3.x, to be removed in 4.0.'.
E_USER_DEPRECATED
);

return new TypeGuess('datetime', [], Guess::HIGH_CONFIDENCE);
case 'vardatetime':
@trigger_error(
'The vardatetime type is deprecated since sonata-project/doctrine-mongodb-admin-bundle 3.x, to be removed in 4.0.'.
E_USER_DEPRECATED
);

return new TypeGuess('datetime', [], Guess::HIGH_CONFIDENCE);
case 'datetimetz':
case 'timestamp':
@trigger_error(
'The datetimetz type is deprecated since sonata-project/doctrine-mongodb-admin-bundle 3.x, to be removed in 4.0.'.
E_USER_DEPRECATED
);

return new TypeGuess('datetime', [], Guess::HIGH_CONFIDENCE);
case 'date':
case Type::TIMESTAMP:
return new TypeGuess('datetime', [], Guess::HIGH_CONFIDENCE);
case Type::DATE:
// NEXT_MAJOR: Use only the constant when dropping support for doctrine/mongodb-odm 1.3.
// case Type::DATE_IMMUTABLE:
case 'date_immutable':
return new TypeGuess('date', [], Guess::HIGH_CONFIDENCE);
case 'decimal':
case 'float':
@trigger_error(
'The decimal type is deprecated since sonata-project/doctrine-mongodb-admin-bundle 3.x, to be removed in 4.0.'.
E_USER_DEPRECATED
);

return new TypeGuess('number', [], Guess::MEDIUM_CONFIDENCE);
case 'integer':
case Type::FLOAT:
return new TypeGuess('number', [], Guess::MEDIUM_CONFIDENCE);
case Type::INTEGER:
case Type::INT:
return new TypeGuess('integer', [], Guess::MEDIUM_CONFIDENCE);
case 'bigint':
@trigger_error(
'The bigint type is deprecated since sonata-project/doctrine-mongodb-admin-bundle 3.x, to be removed in 4.0.'.
E_USER_DEPRECATED
);

return new TypeGuess('integer', [], Guess::MEDIUM_CONFIDENCE);
case 'smallint':
@trigger_error(
'The smallint type is deprecated since sonata-project/doctrine-mongodb-admin-bundle 3.x, to be removed in 4.0.'.
E_USER_DEPRECATED
);

return new TypeGuess('integer', [], Guess::MEDIUM_CONFIDENCE);
case 'string':
case Type::STRING:
return new TypeGuess('text', [], Guess::MEDIUM_CONFIDENCE);
case 'text':
@trigger_error(
'The text type is deprecated since sonata-project/doctrine-mongodb-admin-bundle 3.x, to be removed in 4.0.'.
E_USER_DEPRECATED
);

return new TypeGuess('textarea', [], Guess::MEDIUM_CONFIDENCE);
case 'time':
@trigger_error(
'The time type is deprecated since sonata-project/doctrine-mongodb-admin-bundle 3.x, to be removed in 4.0.'.
E_USER_DEPRECATED
);

return new TypeGuess('time', [], Guess::HIGH_CONFIDENCE);
default:
return new TypeGuess('text', [], Guess::LOW_CONFIDENCE);
Expand Down
2 changes: 1 addition & 1 deletion tests/Builder/ListBuilderTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
* file that was distributed with this source code.
*/

namespace Sonata\DoctrineORMAdminBundle\Tests\Builder;
namespace Sonata\DoctrineMongoDBAdminBundle\Tests\Builder;

use PHPUnit\Framework\TestCase;
use Prophecy\Argument;
Expand Down
Loading

0 comments on commit c301dc4

Please sign in to comment.