123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336 |
- <?php
- /*
- * This file is part of the Sonata Project package.
- *
- * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Sonata\AdminBundle\Form;
- use Sonata\AdminBundle\Admin\AdminInterface;
- use Sonata\AdminBundle\Builder\FormContractorInterface;
- use Sonata\AdminBundle\Mapper\BaseGroupedMapper;
- use Symfony\Component\Form\FormBuilderInterface;
- /**
- * This class is use to simulate the Form API.
- *
- * @author Thomas Rabaix <thomas.rabaix@sonata-project.org>
- */
- class FormMapper extends BaseGroupedMapper
- {
- /**
- * @var FormBuilderInterface
- */
- protected $formBuilder;
- /**
- * @param FormContractorInterface $formContractor
- * @param FormBuilderInterface $formBuilder
- * @param AdminInterface $admin
- */
- public function __construct(FormContractorInterface $formContractor, FormBuilderInterface $formBuilder, AdminInterface $admin)
- {
- parent::__construct($formContractor, $admin);
- $this->formBuilder = $formBuilder;
- }
- /**
- * {@inheritdoc}
- */
- public function reorder(array $keys)
- {
- $this->admin->reorderFormGroup($this->getCurrentGroupName(), $keys);
- return $this;
- }
- /**
- * @param string $name
- * @param string $type
- * @param array $options
- * @param array $fieldDescriptionOptions
- *
- * @return $this
- */
- public function add($name, $type = null, array $options = array(), array $fieldDescriptionOptions = array())
- {
- if ($this->apply !== null && !$this->apply) {
- return $this;
- }
- if ($name instanceof FormBuilderInterface) {
- $fieldName = $name->getName();
- } else {
- $fieldName = $name;
- }
- // "Dot" notation is not allowed as form name, but can be used as property path to access nested data.
- if (!$name instanceof FormBuilderInterface && !isset($options['property_path'])) {
- $options['property_path'] = $fieldName;
- // fix the form name
- $fieldName = $this->sanitizeFieldName($fieldName);
- }
- // change `collection` to `sonata_type_native_collection` form type to
- // avoid BC break problems
- if ($type === 'collection' || $type === 'Symfony\Component\Form\Extension\Core\Type\CollectionType') {
- // the field name is used to preserve Symfony <2.8 compatibility, the FQCN should be used instead
- $type = 'sonata_type_native_collection';
- }
- $label = $fieldName;
- $group = $this->addFieldToCurrentGroup($label);
- // Try to autodetect type
- if ($name instanceof FormBuilderInterface && null === $type) {
- $fieldDescriptionOptions['type'] = get_class($name->getType()->getInnerType());
- }
- if (!isset($fieldDescriptionOptions['type']) && is_string($type)) {
- $fieldDescriptionOptions['type'] = $type;
- }
- if ($group['translation_domain'] && !isset($fieldDescriptionOptions['translation_domain'])) {
- $fieldDescriptionOptions['translation_domain'] = $group['translation_domain'];
- }
- $fieldDescription = $this->admin->getModelManager()->getNewFieldDescriptionInstance(
- $this->admin->getClass(),
- $name instanceof FormBuilderInterface ? $name->getName() : $name,
- $fieldDescriptionOptions
- );
- // Note that the builder var is actually the formContractor:
- $this->builder->fixFieldDescription($this->admin, $fieldDescription, $fieldDescriptionOptions);
- if ($fieldName != $name) {
- $fieldDescription->setName($fieldName);
- }
- $this->admin->addFormFieldDescription($fieldName, $fieldDescription);
- if ($name instanceof FormBuilderInterface) {
- $this->formBuilder->add($name);
- } else {
- // Note that the builder var is actually the formContractor:
- $options = array_replace_recursive($this->builder->getDefaultOptions($type, $fieldDescription), $options);
- // be compatible with mopa if not installed, avoid generating an exception for invalid option
- // force the default to false ...
- if (!isset($options['label_render'])) {
- $options['label_render'] = false;
- }
- if (!isset($options['label'])) {
- $options['label'] = $this->admin->getLabelTranslatorStrategy()->getLabel($fieldDescription->getName(), 'form', 'label');
- }
- $help = null;
- if (isset($options['help'])) {
- $help = $options['help'];
- unset($options['help']);
- }
- $this->formBuilder->add($fieldDescription->getName(), $type, $options);
- if (null !== $help) {
- $this->admin->getFormFieldDescription($fieldDescription->getName())->setHelp($help);
- }
- }
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function get($name)
- {
- $name = $this->sanitizeFieldName($name);
- return $this->formBuilder->get($name);
- }
- /**
- * {@inheritdoc}
- */
- public function has($key)
- {
- $key = $this->sanitizeFieldName($key);
- return $this->formBuilder->has($key);
- }
- /**
- * {@inheritdoc}
- */
- final public function keys()
- {
- return array_keys($this->formBuilder->all());
- }
- /**
- * {@inheritdoc}
- */
- public function remove($key)
- {
- $key = $this->sanitizeFieldName($key);
- $this->admin->removeFormFieldDescription($key);
- $this->admin->removeFieldFromFormGroup($key);
- $this->formBuilder->remove($key);
- return $this;
- }
- /**
- * Removes a group.
- *
- * @param string $group The group to delete
- * @param string $tab The tab the group belongs to, defaults to 'default'
- * @param bool $deleteEmptyTab Whether or not the Tab should be deleted, when the deleted group leaves the tab empty after deletion
- *
- * @return $this
- */
- public function removeGroup($group, $tab = 'default', $deleteEmptyTab = false)
- {
- $groups = $this->getGroups();
- // When the default tab is used, the tabname is not prepended to the index in the group array
- if ($tab !== 'default') {
- $group = $tab.'.'.$group;
- }
- if (isset($groups[$group])) {
- foreach ($groups[$group]['fields'] as $field) {
- $this->remove($field);
- }
- }
- unset($groups[$group]);
- $tabs = $this->getTabs();
- $key = array_search($group, $tabs[$tab]['groups']);
- if (false !== $key) {
- unset($tabs[$tab]['groups'][$key]);
- }
- if ($deleteEmptyTab && count($tabs[$tab]['groups']) == 0) {
- unset($tabs[$tab]);
- }
- $this->setTabs($tabs);
- $this->setGroups($groups);
- return $this;
- }
- /**
- * @return FormBuilderInterface
- */
- public function getFormBuilder()
- {
- return $this->formBuilder;
- }
- /**
- * @param string $name
- * @param mixed $type
- * @param array $options
- *
- * @return FormBuilderInterface
- */
- public function create($name, $type = null, array $options = array())
- {
- return $this->formBuilder->create($name, $type, $options);
- }
- /**
- * @param array $helps
- *
- * @return FormMapper
- */
- public function setHelps(array $helps = array())
- {
- foreach ($helps as $name => $help) {
- $this->addHelp($name, $help);
- }
- return $this;
- }
- /**
- * @param $name
- * @param $help
- *
- * @return FormMapper
- */
- public function addHelp($name, $help)
- {
- if ($this->admin->hasFormFieldDescription($name)) {
- $this->admin->getFormFieldDescription($name)->setHelp($help);
- }
- return $this;
- }
- /**
- * Symfony default form class sadly can't handle
- * form element with dots in its name (when data
- * get bound, the default dataMapper is a PropertyPathMapper).
- * So use this trick to avoid any issue.
- *
- * @param string $fieldName
- *
- * @return string
- */
- protected function sanitizeFieldName($fieldName)
- {
- return str_replace(array('__', '.'), array('____', '__'), $fieldName);
- }
- /**
- * {@inheritdoc}
- */
- protected function getGroups()
- {
- return $this->admin->getFormGroups();
- }
- /**
- * {@inheritdoc}
- */
- protected function setGroups(array $groups)
- {
- $this->admin->setFormGroups($groups);
- }
- /**
- * {@inheritdoc}
- */
- protected function getTabs()
- {
- return $this->admin->getFormTabs();
- }
- /**
- * {@inheritdoc}
- */
- protected function setTabs(array $tabs)
- {
- $this->admin->setFormTabs($tabs);
- }
- /**
- * {@inheritdoc}
- */
- protected function getName()
- {
- return 'form';
- }
- }
|