ListBuilder.php 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168
  1. <?php
  2. /*
  3. * This file is part of the Sonata package.
  4. *
  5. * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Sonata\AdminBundle\Builder\ORM;
  11. use Sonata\AdminBundle\Admin\FieldDescriptionInterface;
  12. use Sonata\AdminBundle\Model\ModelManagerInterface;
  13. use Sonata\AdminBundle\Admin\AdminInterface;
  14. use Sonata\AdminBundle\Admin\FieldDescriptionCollection;
  15. use Sonata\AdminBundle\Builder\ListBuilderInterface;
  16. use Sonata\AdminBundle\Guesser\TypeGuesserInterface;
  17. use Doctrine\ORM\Mapping\ClassMetadataInfo;
  18. class ListBuilder implements ListBuilderInterface
  19. {
  20. protected $guesser;
  21. public function __construct(TypeGuesserInterface $guesser)
  22. {
  23. $this->guesser = $guesser;
  24. }
  25. public function getBaseList(array $options = array())
  26. {
  27. return new FieldDescriptionCollection;
  28. }
  29. public function addField(FieldDescriptionCollection $list, $type = null, FieldDescriptionInterface $fieldDescription, AdminInterface $admin)
  30. {
  31. if ($type == null) {
  32. $guessType = $this->guesser->guessType($admin->getClass(), $fieldDescription->getName());
  33. $fieldDescription->setType($guessType->getType());
  34. } else {
  35. $fieldDescription->setType($type);
  36. }
  37. $fieldDescription->setType($type);
  38. $this->fixFieldDescription($admin, $fieldDescription);
  39. $admin->addListFieldDescription($fieldDescription->getName(), $fieldDescription);
  40. return $list->add($fieldDescription);
  41. }
  42. /**
  43. * The method defines the correct default settings for the provided FieldDescription
  44. *
  45. * @param \Sonata\AdminBundle\Admin\AdminInterface $admin
  46. * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $fieldDescription
  47. * @return void
  48. */
  49. public function fixFieldDescription(AdminInterface $admin, FieldDescriptionInterface $fieldDescription)
  50. {
  51. if ($fieldDescription->getName() == '_action') {
  52. $this->buildActionFieldDescription($fieldDescription);
  53. }
  54. $fieldDescription->setAdmin($admin);
  55. if ($admin->getModelManager()->hasMetadata($admin->getClass())) {
  56. $metadata = $admin->getModelManager()->getMetadata($admin->getClass());
  57. // set the default field mapping
  58. if (isset($metadata->fieldMappings[$fieldDescription->getName()])) {
  59. $fieldDescription->setFieldMapping($metadata->fieldMappings[$fieldDescription->getName()]);
  60. if ($fieldDescription->getOption('sortable') !== false) {
  61. $fieldDescription->setOption('sortable', $fieldDescription->getOption('sortable', $fieldDescription->getName()));
  62. }
  63. }
  64. // set the default association mapping
  65. if (isset($metadata->associationMappings[$fieldDescription->getName()])) {
  66. $fieldDescription->setAssociationMapping($metadata->associationMappings[$fieldDescription->getName()]);
  67. }
  68. $fieldDescription->setOption('_sort_order', $fieldDescription->getOption('_sort_order', 'ASC'));
  69. }
  70. if (!$fieldDescription->getType()) {
  71. throw new \RuntimeException(sprintf('Please define a type for field `%s` in `%s`', $fieldDescription->getName(), get_class($admin)));
  72. }
  73. $fieldDescription->setOption('code', $fieldDescription->getOption('code', $fieldDescription->getName()));
  74. $fieldDescription->setOption('label', $fieldDescription->getOption('label', $fieldDescription->getName()));
  75. if (!$fieldDescription->getTemplate()) {
  76. $fieldDescription->setTemplate(sprintf('SonataAdminBundle:CRUD:list_%s.html.twig', $fieldDescription->getType()));
  77. if ($fieldDescription->getMappingType() == ClassMetadataInfo::MANY_TO_ONE) {
  78. $fieldDescription->setTemplate('SonataAdminBundle:CRUD:list_orm_many_to_one.html.twig');
  79. }
  80. if ($fieldDescription->getMappingType() == ClassMetadataInfo::ONE_TO_ONE) {
  81. $fieldDescription->setTemplate('SonataAdminBundle:CRUD:list_orm_one_to_one.html.twig');
  82. }
  83. if ($fieldDescription->getMappingType() == ClassMetadataInfo::ONE_TO_MANY) {
  84. $fieldDescription->setTemplate('SonataAdminBundle:CRUD:list_orm_one_to_many.html.twig');
  85. }
  86. if ($fieldDescription->getMappingType() == ClassMetadataInfo::MANY_TO_MANY) {
  87. $fieldDescription->setTemplate('SonataAdminBundle:CRUD:list_orm_many_to_many.html.twig');
  88. }
  89. }
  90. if ($fieldDescription->getMappingType() == ClassMetadataInfo::MANY_TO_ONE) {
  91. $admin->attachAdminClass($fieldDescription);
  92. }
  93. if ($fieldDescription->getMappingType() == ClassMetadataInfo::ONE_TO_ONE) {
  94. $admin->attachAdminClass($fieldDescription);
  95. }
  96. if ($fieldDescription->getMappingType() == ClassMetadataInfo::ONE_TO_MANY) {
  97. $admin->attachAdminClass($fieldDescription);
  98. }
  99. if ($fieldDescription->getMappingType() == ClassMetadataInfo::MANY_TO_MANY) {
  100. $admin->attachAdminClass($fieldDescription);
  101. }
  102. }
  103. /**
  104. * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $fieldDescription
  105. * @return \Sonata\AdminBundle\Admin\FieldDescriptionInterface
  106. */
  107. public function buildActionFieldDescription(FieldDescriptionInterface $fieldDescription)
  108. {
  109. if (null === $fieldDescription->getTemplate()) {
  110. $fieldDescription->setTemplate('SonataAdminBundle:CRUD:list__action.html.twig');
  111. }
  112. if (null === $fieldDescription->getType()) {
  113. $fieldDescription->setType('action');
  114. }
  115. if (null === $fieldDescription->getOption('name')) {
  116. $fieldDescription->setOption('name', 'Action');
  117. }
  118. if (null === $fieldDescription->getOption('code')) {
  119. $fieldDescription->setOption('code', 'Action');
  120. }
  121. if (null !== $fieldDescription->getOption('actions')) {
  122. $actions = $fieldDescription->getOption('actions');
  123. foreach ($actions as $k => $action) {
  124. if (!isset($action['template'])) {
  125. $actions[$k]['template'] = sprintf('SonataAdminBundle:CRUD:list__action_%s.html.twig', $k);
  126. }
  127. }
  128. $fieldDescription->setOption('actions', $actions);
  129. }
  130. return $fieldDescription;
  131. }
  132. }