/** * The method defines the correct default settings for the provided FieldDescription * * {@inheritDoc} * * @throws \RuntimeException if the $fieldDescription does not have a type. */ public function fixFieldDescription(AdminInterface $admin, FieldDescriptionInterface $fieldDescription) { $fieldDescription->setAdmin($admin); if ($admin->getModelManager()->hasMetadata($admin->getClass())) { $metadata = $admin->getModelManager()->getMetadata($admin->getClass()); // set the default field mapping if (isset($metadata->fieldMappings[$fieldDescription->getName()])) { $fieldDescription->setFieldMapping($metadata->fieldMappings[$fieldDescription->getName()]); } // set the default association mapping if (isset($metadata->associationMappings[$fieldDescription->getName()])) { $fieldDescription->setAssociationMapping($metadata->associationMappings[$fieldDescription->getName()]); } } if (!$fieldDescription->getType()) { throw new \RuntimeException(sprintf('Please define a type for field `%s` in `%s`', $fieldDescription->getName(), get_class($admin))); } $fieldDescription->setOption('code', $fieldDescription->getOption('code', $fieldDescription->getName())); $fieldDescription->setOption('label', $fieldDescription->getOption('label', $fieldDescription->getName())); if (!$fieldDescription->getTemplate()) { $fieldDescription->setTemplate(sprintf('SonataAdminBundle:CRUD:show_%s.html.twig', $fieldDescription->getType())); if ($fieldDescription->getMappingType() == ClassMetadata::MANY_TO_ONE) { $fieldDescription->setTemplate('SonataAdminBundle:CRUD:show_orm_many_to_one.html.twig'); } if ($fieldDescription->getMappingType() == ClassMetadata::MANY_TO_MANY) { $fieldDescription->setTemplate('SonataAdminBundle:CRUD:show_orm_many_to_many.html.twig'); } } if ($fieldDescription->getMappingType() == ClassMetadata::MANY_TO_ONE) { $admin->attachAdminClass($fieldDescription); } if ($fieldDescription->getMappingType() == ClassMetadata::MANY_TO_MANY) { $admin->attachAdminClass($fieldDescription); } }
/** * {@inheritdoc} */ public function buildActionFieldDescription(FieldDescriptionInterface $fieldDescription) { if (null === $fieldDescription->getTemplate()) { $fieldDescription->setTemplate('NetworkingInitCmsBundle:CRUD:list__action.html.twig'); } if (null === $fieldDescription->getType()) { $fieldDescription->setType('action'); } if (null === $fieldDescription->getOption('name')) { $fieldDescription->setOption('name', 'Action'); } if (null === $fieldDescription->getOption('code')) { $fieldDescription->setOption('code', 'Action'); } if (null !== $fieldDescription->getOption('actions')) { $actions = $fieldDescription->getOption('actions'); foreach ($actions as $k => $action) { if (!isset($action['template'])) { $actions[$k]['template'] = sprintf('NetworkingInitCmsBundle:CRUD:list__action_%s.html.twig', $k); } } $fieldDescription->setOption('actions', $actions); } return $fieldDescription; }
/** * @param \Sonata\AdminBundle\Datagrid\DatagridInterface $datagrid * @param null $type * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $fieldDescription * @param \Sonata\AdminBundle\Admin\AdminInterface $admin * * @return void */ public function addFilter(DatagridInterface $datagrid, $type = null, FieldDescriptionInterface $fieldDescription, AdminInterface $admin) { if ($type == null) { $guessType = $this->guesser->guessType($admin->getClass(), $fieldDescription->getName(), $admin->getModelManager()); $type = $guessType->getType(); $fieldDescription->setType($type); $options = $guessType->getOptions(); foreach ($options as $name => $value) { if (is_array($value)) { $fieldDescription->setOption($name, array_merge($value, $fieldDescription->getOption($name, array()))); } else { $fieldDescription->setOption($name, $fieldDescription->getOption($name, $value)); } } } else { $fieldDescription->setType($type); } $this->fixFieldDescription($admin, $fieldDescription); $admin->addFilterFieldDescription($fieldDescription->getName(), $fieldDescription); $fieldDescription->mergeOption('field_options', array('required' => false)); $filter = $this->filterFactory->create($fieldDescription->getName(), $type, $fieldDescription->getOptions()); if (!$filter->getLabel()) { $filter->setLabel($admin->getLabelTranslatorStrategy()->getLabel($fieldDescription->getName(), 'filter', 'label')); } $datagrid->addFilter($filter); }
/** * @param string $type * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $fieldDescription * * @return array */ public function getDefaultOptions($type, FieldDescriptionInterface $fieldDescription) { $options = array('sonata_field_description' => $fieldDescription); if ($type == 'sonata_type_model' || $type == 'sonata_type_model_list') { if ($fieldDescription->getOption('edit') == 'list') { throw new \LogicException('The ``sonata_type_model`` type does not accept an ``edit`` option anymore, please review the UPGRADE-2.1.md file from the SonataAdminBundle'); } $options['class'] = $fieldDescription->getTargetEntity(); $options['model_manager'] = $fieldDescription->getAdmin()->getModelManager(); } elseif ($type == 'sonata_type_admin') { if (!$fieldDescription->getAssociationAdmin()) { throw new \RuntimeException(sprintf('The current field `%s` is not linked to an admin. Please create one for the target entity : `%s`', $fieldDescription->getName(), $fieldDescription->getTargetEntity())); } $options['data_class'] = $fieldDescription->getAssociationAdmin()->getClass(); $fieldDescription->setOption('edit', $fieldDescription->getOption('edit', 'admin')); } elseif ($type == 'sonata_type_collection') { if (!$fieldDescription->getAssociationAdmin()) { throw new \RuntimeException(sprintf('The current field `%s` is not linked to an admin. Please create one for the target entity : `%s`', $fieldDescription->getName(), $fieldDescription->getTargetEntity())); } $options['type'] = 'sonata_type_admin'; $options['modifiable'] = true; $options['type_options'] = array('sonata_field_description' => $fieldDescription, 'data_class' => $fieldDescription->getAssociationAdmin()->getClass()); } return $options; }
public function getDefaultOptions($type, \Sonata\AdminBundle\Admin\FieldDescriptionInterface $fieldDescription) { $options = array(); $options['sonata_field_description'] = $fieldDescription; if (in_array($type, array('sonata_type_model', 'sonata_type_model_list', 'orangegate_type_image', 'orangegate_type_file', 'sonata_type_model_hidden', 'sonata_type_model_autocomplete'))) { if ($fieldDescription->getOption('edit') == 'list') { throw new \LogicException('The ``sonata_type_model`` type does not accept an ``edit`` option anymore, please review the UPGRADE-2.1.md file from the SonataAdminBundle'); } $options['class'] = $fieldDescription->getTargetEntity(); $options['model_manager'] = $fieldDescription->getAdmin()->getModelManager(); if ($type == 'sonata_type_model_autocomplete') { if (!$fieldDescription->getAssociationAdmin()) { throw new \RuntimeException(sprintf('The current field `%s` is not linked to an admin. Please create one for the target entity: `%s`', $fieldDescription->getName(), $fieldDescription->getTargetEntity())); } } } elseif ($type == 'sonata_type_admin') { if (!$fieldDescription->getAssociationAdmin()) { throw new \RuntimeException(sprintf('The current field `%s` is not linked to an admin. Please create one for the target entity : `%s`', $fieldDescription->getName(), $fieldDescription->getTargetEntity())); } if (!in_array($fieldDescription->getMappingType(), array(ClassMetadataInfo::ONE_TO_ONE, ClassMetadataInfo::MANY_TO_ONE))) { throw new \RuntimeException(sprintf('You are trying to add `sonata_type_admin` field `%s` which is not One-To-One or Many-To-One. Maybe you want `sonata_model_list` instead?', $fieldDescription->getName())); } $options['data_class'] = $fieldDescription->getAssociationAdmin()->getClass(); $fieldDescription->setOption('edit', $fieldDescription->getOption('edit', 'admin')); } elseif ($type == 'sonata_type_collection' || $type == 'orangegate_type_media_collection') { if (!$fieldDescription->getAssociationAdmin()) { throw new \RuntimeException(sprintf('The current field `%s` is not linked to an admin. Please create one for the target entity : `%s`', $fieldDescription->getName(), $fieldDescription->getTargetEntity())); } $options['type'] = 'sonata_type_admin'; $options['modifiable'] = true; $options['type_options'] = array('sonata_field_description' => $fieldDescription, 'data_class' => $fieldDescription->getAssociationAdmin()->getClass()); } return $options; }
/** * {@inheritdoc} */ public function fixFieldDescription(AdminInterface $admin, FieldDescriptionInterface $fieldDescription) { if (null === $fieldDescription->getTemplate()) { $fieldDescription->setTemplate('SonataAdminBundle:CRUD:list__action.html.twig'); } if (null === $fieldDescription->getType()) { $fieldDescription->setType('action'); } if (null === $fieldDescription->getOption('name')) { $fieldDescription->setOption('name', 'Action'); } if (null === $fieldDescription->getOption('code')) { $fieldDescription->setOption('code', 'Action'); } if (null === $fieldDescription->getOption('header_style') && $fieldDescription->getOption('dropdown')) { $fieldDescription->setOption('header_style', 'width:40px'); } if (null !== $fieldDescription->getOption('actions')) { $actions = $fieldDescription->getOption('actions'); foreach ($actions as $k => &$action) { //only set the template if really exists //set to default any template that not exists if (!isset($action['template'])) { if ($fieldDescription->getOption('dropdown')) { $template = sprintf('SonataAdminBundle:CRUD:list__action_dropdown_%s.html.twig', $k); } else { $template = sprintf('SonataAdminBundle:CRUD:list__action_%s.html.twig', $k); } try { $this->twig->loadTemplate($template); } catch (\Twig_Error_Loader $e) { if ($fieldDescription->getOption('dropdown')) { $template = 'YnloAdminBundle::CRUD/list__action_dropdown_default.html.twig'; } else { $template = 'YnloAdminBundle::CRUD/list__action_default.html.twig'; } } $action['template'] = $template; } //set default role if (!isset($action['role'])) { $role = strtoupper($k); $action['role'] = $role === 'SHOW' ? 'VIEW' : $role; } //set default visibility if (!isset($action['visible'])) { $action['visible'] = true; } } $fieldDescription->setOption('actions', $actions); } //hide default label if (in_array($fieldDescription->getOption('label'), ['_action', 'Action'])) { $fieldDescription->setOption('label', ' '); } return $fieldDescription; }
/** * @param \Sonata\AdminBundle\Admin\AdminInterface $admin * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $fieldDescription */ public function fixFieldDescription(AdminInterface $admin, FieldDescriptionInterface $fieldDescription) { $fieldDescription->setAdmin($admin); if (!$fieldDescription->getType()) { throw new \RuntimeException(sprintf('Please define a type for field `%s` in `%s`', $fieldDescription->getName(), get_class($admin))); } // define the template to use if (!$fieldDescription->getTemplate()) { $fieldDescription->setTemplate($this->getTemplate($fieldDescription->getType())); } // define code and label $fieldDescription->setOption('code', $fieldDescription->getOption('code', $fieldDescription->getName())); $fieldDescription->setOption('label', $fieldDescription->getOption('label', $fieldDescription->getName())); }
/** * {@inheritdoc} */ public function fixFieldDescription(AdminInterface $admin, FieldDescriptionInterface $fieldDescription) { if (null === $fieldDescription->getTemplate()) { $fieldDescription->setTemplate('YnloAdminBundle::CRUD/list__details.html.twig'); } if (null === $fieldDescription->getType()) { $fieldDescription->setType('_details'); } if (null === $fieldDescription->getOption('name')) { $fieldDescription->setOption('name', 'Details'); } if (null === $fieldDescription->getOption('header_style')) { $fieldDescription->setOption('header_style', 'width:20px'); } if (null === $fieldDescription->getOption('details_template')) { throw new \LogicException('The option "details_template" is required'); } //encode the template $template = base64_encode($fieldDescription->getOption('details_template')); $fieldDescription->setOption('details_template_encoded', $template); if (null === $fieldDescription->getOption('ajax')) { $fieldDescription->setOption('ajax', false); } if (null === $fieldDescription->getOption('code')) { $fieldDescription->setOption('code', '_details'); } //hide default label if ($fieldDescription->getOption('label') == '_details' || $fieldDescription->getOption('label') == 'Details') { $fieldDescription->setOption('label', ' '); } }
/** * The method defines the correct default settings for the provided FieldDescription. * * {@inheritdoc} * * @throws \RuntimeException if the $fieldDescription does not specify a type. */ public function fixFieldDescription(AdminInterface $admin, FieldDescriptionInterface $fieldDescription) { $metadata = null; if ($admin->getModelManager()->hasMetadata($admin->getClass())) { /** @var \Doctrine\ODM\PHPCR\Mapping\ClassMetadata $metadata */ $metadata = $admin->getModelManager()->getMetadata($admin->getClass()); // set the default field mapping if (isset($metadata->mappings[$fieldDescription->getName()])) { $fieldDescription->setFieldMapping($metadata->mappings[$fieldDescription->getName()]); } // set the default association mapping if ($metadata->hasAssociation($fieldDescription->getName())) { $fieldDescription->setAssociationMapping($metadata->getAssociation($fieldDescription->getName())); } } if (!$fieldDescription->getType()) { throw new \RuntimeException(sprintf('Please define a type for field `%s` in `%s`', $fieldDescription->getName(), get_class($admin))); } $fieldDescription->setAdmin($admin); $fieldDescription->setOption('edit', $fieldDescription->getOption('edit', 'standard')); $mappingTypes = array(ClassMetadata::MANY_TO_ONE, ClassMetadata::MANY_TO_MANY, 'children', 'child', 'parent', 'referrers'); if ($metadata && $metadata->hasAssociation($fieldDescription->getName()) && in_array($fieldDescription->getMappingType(), $mappingTypes)) { $admin->attachAdminClass($fieldDescription); } }
/** * The method defines the correct default settings for the provided FieldDescription * * @param \Sonata\AdminBundle\Admin\AdminInterface $admin * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $fieldDescription * @return void */ public function fixFieldDescription(AdminInterface $admin, FieldDescriptionInterface $fieldDescription) { if ($admin->getModelManager()->hasMetadata($admin->getClass())) { $metadata = $admin->getModelManager()->getMetadata($admin->getClass()); // set the default field mapping if (isset($metadata->fieldMappings[$fieldDescription->getName()])) { $fieldDescription->setFieldMapping($metadata->fieldMappings[$fieldDescription->getName()]); } // set the default association mapping if (isset($metadata->associationMappings[$fieldDescription->getName()])) { $fieldDescription->setAssociationMapping($metadata->associationMappings[$fieldDescription->getName()]); } } if (!$fieldDescription->getType()) { throw new \RuntimeException(sprintf('Please define a type for field `%s` in `%s`', $fieldDescription->getName(), get_class($admin))); } $fieldDescription->setAdmin($admin); $fieldDescription->setOption('edit', $fieldDescription->getOption('edit', 'standard')); if (in_array($fieldDescription->getMappingType(), array(ClassMetadataInfo::ONE_TO_MANY, ClassMetadataInfo::MANY_TO_MANY, ClassMetadataInfo::MANY_TO_ONE, ClassMetadataInfo::ONE_TO_ONE ))) { $admin->attachAdminClass($fieldDescription); } }
/** * @param AdminInterface $admin * @param FieldDescriptionInterface $fieldDescription */ public function fixFieldDescription(AdminInterface $admin, FieldDescriptionInterface $fieldDescription) { $fieldDescription->setAdmin($admin); // filters are not required by default $fieldDescription->mergeOption('field_options', array('required' => false)); // text fields are searchable by default if ($fieldDescription->getType() === 'text') { $fieldDescription->setOption('global_search', $fieldDescription->getOption('global_search', true)); } }
/** * {@inheritdoc} */ public function fixFieldDescription(AdminInterface $admin, FieldDescriptionInterface $fieldDescription) { $fieldDescription->setTemplate('YnloAdminBundle::CRUD/list_enum.html.twig'); /** @var ModelManager $modelManager */ $modelManager = $admin->getModelManager(); if (null === $fieldDescription->getOption('enum_type') && $modelManager->hasMetadata($admin->getClass())) { $mapping = $modelManager->getMetadata($admin->getClass())->getFieldMapping($fieldDescription->getName()); $fieldDescription->setOption('enum_type', $mapping['type']); } }
/** * The method defines the correct default settings for the provided FieldDescription. * * @param \Sonata\AdminBundle\Admin\AdminInterface $admin * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $fieldDescription */ public function fixFieldDescription(AdminInterface $admin, FieldDescriptionInterface $fieldDescription) { $fieldDescription->setAdmin($admin); if ($admin->getModelManager()->hasMetadata($admin->getClass())) { list($metadata, $lastPropertyName, $parentAssociationMappings) = $admin->getModelManager()->getParentMetadataForProperty($admin->getClass(), $fieldDescription->getName()); $fieldDescription->setParentAssociationMappings($parentAssociationMappings); // set the default field mapping if (isset($metadata->fieldMappings[$lastPropertyName])) { $fieldDescription->setFieldMapping($metadata->fieldMappings[$lastPropertyName]); } // set the default association mapping if (isset($metadata->associationMappings[$lastPropertyName])) { $fieldDescription->setAssociationMapping($metadata->associationMappings[$lastPropertyName]); } } if (!$fieldDescription->getType()) { throw new \RuntimeException(sprintf('Please define a type for field `%s` in `%s`', $fieldDescription->getName(), get_class($admin))); } $fieldDescription->setOption('code', $fieldDescription->getOption('code', $fieldDescription->getName())); $fieldDescription->setOption('label', $fieldDescription->getOption('label', $fieldDescription->getName())); if (!$fieldDescription->getTemplate()) { if ($fieldDescription->getType() == 'id') { $fieldDescription->setType('string'); } if ($fieldDescription->getType() == 'int') { $fieldDescription->setType('integer'); } $template = $this->getTemplate($fieldDescription->getType()); if ($template === null) { if ($fieldDescription->getMappingType() == ClassMetadataInfo::ONE) { $template = 'SonataDoctrineMongoDBAdminBundle:CRUD:show_mongo_one.html.twig'; } elseif ($fieldDescription->getMappingType() == ClassMetadataInfo::MANY) { $template = 'SonataDoctrineMongoDBAdminBundle:CRUD:show_mongo_many.html.twig'; } } $fieldDescription->setTemplate($template); } if (in_array($fieldDescription->getMappingType(), array(ClassMetadataInfo::ONE, ClassMetadataInfo::MANY))) { $admin->attachAdminClass($fieldDescription); } }
/** * The method defines the correct default settings for the provided FieldDescription * * @param \Sonata\AdminBundle\Admin\AdminInterface $admin * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $fieldDescription * * @return void */ public function fixFieldDescription(AdminInterface $admin, FieldDescriptionInterface $fieldDescription) { $fieldDescription->setAdmin($admin); if ($admin->getModelManager()->hasMetadata($admin->getClass())) { list($metadata, $lastPropertyName, $parentAssociationMappings) = $admin->getModelManager()->getParentMetadataForProperty($admin->getClass(), $fieldDescription->getName()); $fieldDescription->setParentAssociationMappings($parentAssociationMappings); // set the default field mapping if (isset($metadata->fieldMappings[$lastPropertyName])) { $fieldDescription->setFieldMapping($metadata->fieldMappings[$lastPropertyName]); } // set the default association mapping if (isset($metadata->associationMappings[$lastPropertyName])) { $fieldDescription->setAssociationMapping($metadata->associationMappings[$lastPropertyName]); } } if (!$fieldDescription->getType()) { throw new \RuntimeException(sprintf('Please define a type for field `%s` in `%s`', $fieldDescription->getName(), get_class($admin))); } $fieldDescription->setOption('code', $fieldDescription->getOption('code', $fieldDescription->getName())); $fieldDescription->setOption('label', $fieldDescription->getOption('label', $fieldDescription->getName())); if (!$fieldDescription->getTemplate()) { $fieldDescription->setTemplate($this->getTemplate($fieldDescription->getType())); if (!$fieldDescription->getTemplate()) { switch ($fieldDescription->getMappingType()) { case ClassMetadataInfo::MANY_TO_ONE: $fieldDescription->setTemplate('SonataDoctrineORMAdminBundle:CRUD:show_orm_many_to_one.html.twig'); break; case ClassMetadataInfo::ONE_TO_ONE: $fieldDescription->setTemplate('SonataDoctrineORMAdminBundle:CRUD:show_orm_one_to_one.html.twig'); break; case ClassMetadataInfo::ONE_TO_MANY: $fieldDescription->setTemplate('SonataDoctrineORMAdminBundle:CRUD:show_orm_one_to_many.html.twig'); break; case ClassMetadataInfo::MANY_TO_MANY: $fieldDescription->setTemplate('SonataDoctrineORMAdminBundle:CRUD:show_orm_many_to_many.html.twig'); break; } } } switch ($fieldDescription->getMappingType()) { case ClassMetadataInfo::MANY_TO_ONE: case ClassMetadataInfo::ONE_TO_ONE: case ClassMetadataInfo::ONE_TO_MANY: case ClassMetadataInfo::MANY_TO_MANY: $admin->attachAdminClass($fieldDescription); break; } }
/** * Return xEditable choices based on the field description choices options & catalogue options. * With the following choice options: * ['Status1' => 'Alias1', 'Status2' => 'Alias2'] * The method will return: * [['value' => 'Status1', 'text' => 'Alias1'], ['value' => 'Status2', 'text' => 'Alias2']]. * * @param FieldDescriptionInterface $fieldDescription * * @return array */ public function getXEditableChoices(FieldDescriptionInterface $fieldDescription) { $choices = $fieldDescription->getOption('choices', array()); $catalogue = $fieldDescription->getOption('catalogue'); $xEditableChoices = array(); if (!empty($choices)) { reset($choices); $first = current($choices); // the choices are already in the right format if (is_array($first) && array_key_exists('value', $first) && array_key_exists('text', $first)) { $xEditableChoices = $choices; } else { foreach ($choices as $value => $text) { $text = $catalogue ? $fieldDescription->getAdmin()->trans($text, array(), $catalogue) : $text; $xEditableChoices[] = array('value' => $value, 'text' => $text); } } } return $xEditableChoices; }
/** * Returns the parameters used in the columns header * * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $fieldDescription * @param \Sonata\AdminBundle\Datagrid\DatagridInterface $datagrid * @return string */ public function getSortParameters(FieldDescriptionInterface $fieldDescription, DatagridInterface $datagrid) { $values = $datagrid->getValues(); if ($fieldDescription->getOption('sortable') == $values['_sort_by']) { if ($values['_sort_order'] == 'ASC') { $values['_sort_order'] = 'DESC'; } else { $values['_sort_order'] = 'ASC'; } } else { $values['_sort_order'] = 'ASC'; $values['_sort_by'] = $fieldDescription->getOption('sortable'); } return $values; }
/** * @throws \RunTimeException * * @param mixed $element * @param FieldDescriptionInterface $fieldDescription * * @return mixed */ public function renderRelationElement($element, FieldDescriptionInterface $fieldDescription) { if (!is_object($element)) { return $element; } $propertyPath = $fieldDescription->getOption('associated_property'); if (null === $propertyPath) { // For BC kept associated_tostring option behavior $method = $fieldDescription->getOption('associated_tostring', '__toString'); if (!method_exists($element, $method)) { throw new \RuntimeException(sprintf('You must define an `associated_property` option or create a `%s::__toString` method to the field option %s from service %s is ', get_class($element), $fieldDescription->getName(), $fieldDescription->getAdmin()->getCode())); } return call_user_func(array($element, $method)); } return PropertyAccess::createPropertyAccessor()->getValue($element, $propertyPath); }
/** * {@inheritdoc} */ public function addFilter(DatagridInterface $datagrid, $type, FieldDescriptionInterface $fieldDescription, AdminInterface $admin) { if ($type == null) { $guessType = $this->guesser->guessType($admin->getClass(), $fieldDescription->getName(), $admin->getModelManager()); $type = $guessType->getType(); $fieldDescription->setType($type); $options = $guessType->getOptions(); foreach ($options as $name => $value) { if (is_array($value)) { $fieldDescription->setOption($name, array_merge($value, $fieldDescription->getOption($name, array()))); } else { $fieldDescription->setOption($name, $fieldDescription->getOption($name, $value)); } } } else { $fieldDescription->setType($type); } $this->fixFieldDescription($admin, $fieldDescription); $admin->addFilterFieldDescription($fieldDescription->getName(), $fieldDescription); $fieldDescription->mergeOption('field_options', array('required' => false)); if ($type === 'doctrine_orm_model_autocomplete') { $fieldDescription->mergeOption('field_options', array('class' => $fieldDescription->getTargetEntity(), 'model_manager' => $fieldDescription->getAdmin()->getModelManager(), 'admin_code' => $admin->getCode(), 'context' => 'filter')); } $filter = $this->filterFactory->create($fieldDescription->getName(), $type, $fieldDescription->getOptions()); if (false !== $filter->getLabel() && !$filter->getLabel()) { $filter->setLabel($admin->getLabelTranslatorStrategy()->getLabel($fieldDescription->getName(), 'filter', 'label')); } $datagrid->addFilter($filter); }
/** * return the class associated to a FieldDescription if any defined * * @throws RuntimeException * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $fieldDescription * @return bool|string */ public function getFilterFieldClass(FieldDescriptionInterface $fieldDescription) { if ($fieldDescription->getOption('filter_field_widget', false)) { $class = $fieldDescription->getOption('filter_field_widget', false); } else { $class = array_key_exists($fieldDescription->getType(), $this->filterClasses) ? $this->filterClasses[$fieldDescription->getType()] : false; } if (!class_exists($class)) { throw new \RuntimeException(sprintf('The class `%s` does not exist for field type : `%s` and field name : `%s`', $class, $fieldDescription->getType(), $fieldDescription->getName())); } return $class; }
/** * {@inheritdoc} */ public function getSortParameters(FieldDescriptionInterface $fieldDescription, DatagridInterface $datagrid) { $values = $datagrid->getValues(); if ($fieldDescription->getName() == $values['_sort_by']->getName() || $values['_sort_by']->getName() === $fieldDescription->getOption('sortable')) { if ($values['_sort_order'] == 'ASC') { $values['_sort_order'] = 'DESC'; } else { $values['_sort_order'] = 'ASC'; } } else { $values['_sort_order'] = 'ASC'; } $values['_sort_by'] = is_string($fieldDescription->getOption('sortable')) ? $fieldDescription->getOption('sortable') : $fieldDescription->getName(); return array('filter' => $values); }
/** * render a field element from the FieldDescription * * * @throws InvalidArgumentException * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $fieldDescription * @param \Sumfony\Component\Form\FormView $formView * @param mixed $object * @param array $params * @return string */ public function renderFormElement(FieldDescriptionInterface $fieldDescription, FormView $formView, $object, $params = array()) { if (!$fieldDescription->getFieldName()) { return ''; } if (!$formView->offsetExists($fieldDescription->getFieldName())) { throw new \RuntimeException(sprintf('No child named %s', $fieldDescription->getFieldName())); } $children = $formView->offsetGet($fieldDescription->getFieldName()); if (in_array('hidden', $children->get('types'))) { return ''; } // find the correct edit parameter // edit : standard | inline // inline : natural | table $parentFieldDescription = $fieldDescription->getAdmin()->getParentFieldDescription(); if (!$parentFieldDescription) { $params['edit'] = $fieldDescription->getOption('edit', 'standard'); $params['inline'] = $fieldDescription->getOption('inline', 'natural'); $base_template = sprintf('SonataAdminBundle:CRUD:base_%s_edit_field.html.twig', 'standard'); } else { $params['edit'] = $parentFieldDescription->getOption('edit', 'standard'); $params['inline'] = $parentFieldDescription->getOption('inline', 'natural'); $base_template = sprintf('SonataAdminBundle:CRUD:base_%s_edit_field.html.twig', $params['edit']); } $template = $this->environment->loadTemplate($fieldDescription->getTemplate()); return $this->output($fieldDescription, $template->render(array_merge($params, array('admin' => $fieldDescription->getAdmin(), 'object' => $object, 'field_description' => $fieldDescription, 'value' => $this->getValueFromFieldDescription($object, $fieldDescription, $params), 'field_element' => $children, 'base_template' => $fieldDescription->getOption('base_template', $base_template))))); }
/** * @param $type * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $fieldDescription * @return array */ public function getDefaultOptions($type, FieldDescriptionInterface $fieldDescription) { $options = array(); $options['sonata_field_description'] = $fieldDescription; if ($type == 'doctrine_phpcr_type_tree_model') { $options['class'] = $fieldDescription->getTargetEntity(); $options['model_manager'] = $fieldDescription->getAdmin()->getModelManager(); } if ($type == 'sonata_type_model') { $options['class'] = $fieldDescription->getTargetEntity(); $options['model_manager'] = $fieldDescription->getAdmin()->getModelManager(); switch ($fieldDescription->getMappingType()) { case ClassMetadata::ONE_TO_MANY: case ClassMetadata::MANY_TO_MANY: $options['multiple'] = true; $options['parent'] = 'choice'; break; case ClassMetadata::MANY_TO_ONE: case ClassMetadata::ONE_TO_ONE: break; } if ($fieldDescription->getOption('edit') == 'list') { $options['parent'] = 'text'; if (!array_key_exists('required', $options)) { $options['required'] = false; } } } else { if ($type == 'sonata_type_admin') { // nothing here ... $options['edit'] = 'inline'; } else { if ($type == 'sonata_type_collection') { $options['type'] = 'sonata_type_admin'; $options['modifiable'] = true; $options['type_options'] = array('sonata_field_description' => $fieldDescription, 'data_class' => $fieldDescription->getAssociationAdmin()->getClass()); } } } return $options; }
/** * The method defines the correct default settings for the provided FieldDescription * * @param \Sonata\AdminBundle\Admin\AdminInterface $admin * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $fieldDescription * @param array $options * @return void */ public function fixFieldDescription(AdminInterface $admin, FieldDescriptionInterface $fieldDescription, array $options = array()) { $fieldDescription->mergeOptions($options); if ($admin->getModelManager()->hasMetadata($admin->getClass())) { $metadata = $admin->getModelManager()->getMetadata($admin->getClass()); // set the default field mapping if (isset($metadata->fieldMappings[$fieldDescription->getName()])) { $fieldDescription->setFieldMapping($metadata->fieldMappings[$fieldDescription->getName()]); } // set the default association mapping if (isset($metadata->associationMappings[$fieldDescription->getName()])) { $fieldDescription->setAssociationMapping($metadata->associationMappings[$fieldDescription->getName()]); } } if (!$fieldDescription->getType()) { throw new \RuntimeException(sprintf('Please define a type for field `%s` in `%s`', $fieldDescription->getName(), get_class($admin))); } $fieldDescription->setAdmin($admin); $fieldDescription->setOption('edit', $fieldDescription->getOption('edit', 'standard')); // fix template value for doctrine association fields if (!$fieldDescription->getTemplate()) { $fieldDescription->setTemplate(sprintf('SonataAdminBundle:CRUD:edit_%s.html.twig', $fieldDescription->getType())); } if ($fieldDescription->getType() == ClassMetadataInfo::ONE_TO_ONE) { $fieldDescription->setTemplate('SonataAdminBundle:CRUD:edit_orm_one_to_one.html.twig'); $admin->attachAdminClass($fieldDescription); } if ($fieldDescription->getType() == ClassMetadataInfo::MANY_TO_ONE) { $fieldDescription->setTemplate('SonataAdminBundle:CRUD:edit_orm_many_to_one.html.twig'); $admin->attachAdminClass($fieldDescription); } if ($fieldDescription->getType() == ClassMetadataInfo::MANY_TO_MANY) { $fieldDescription->setTemplate('SonataAdminBundle:CRUD:edit_orm_many_to_many.html.twig'); $admin->attachAdminClass($fieldDescription); } if ($fieldDescription->getType() == ClassMetadataInfo::ONE_TO_MANY) { $fieldDescription->setTemplate('SonataAdminBundle:CRUD:edit_orm_one_to_many.html.twig'); if ($fieldDescription->getOption('edit') == 'inline' && !$fieldDescription->getOption('widget_form_field')) { $fieldDescription->setOption('widget_form_field', 'Bundle\\Sonata\\AdminBundle\\Form\\EditableFieldGroup'); } $admin->attachAdminClass($fieldDescription); } // set correct default value if ($fieldDescription->getType() == 'datetime') { $options = $fieldDescription->getOption('form_field_options', array()); if (!isset($options['years'])) { $options['years'] = range(1900, 2100); } $fieldDescription->setOption('form_field', $options); } }
/** * @throws \RunTimeException * * @param mixed $element * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $fieldDescription * * @return mixed */ public function renderRelationElement($element, FieldDescriptionInterface $fieldDescription) { $method = $fieldDescription->getOption('associated_tostring', '__toString'); if (!is_object($element)) { return $element; } if (!method_exists($element, $method)) { throw new \RunTimeException(sprintf('You must define an `associated_tostring` option or create a `%s::__toString` method to the field option %s from service %s is ', get_class($element), $fieldDescription->getName(), $fieldDescription->getAdmin()->getCode())); } return call_user_func(array($element, $method)); }
/** * @throws \RunTimeException * * @param mixed $element * @param FieldDescriptionInterface $fieldDescription * * @return mixed */ public function renderRelationElement($element, FieldDescriptionInterface $fieldDescription) { if (!is_object($element)) { return $element; } $propertyPath = $fieldDescription->getOption('associated_property'); if (null === $propertyPath) { // For BC kept associated_tostring option behavior $method = $fieldDescription->getOption('associated_tostring'); if ($method) { @trigger_error('Option "associated_tostring" is deprecated since version 2.3. Use "associated_property" instead.', E_USER_DEPRECATED); } else { $method = '__toString'; } if (!method_exists($element, $method)) { throw new \RuntimeException(sprintf('You must define an `associated_property` option or create a `%s::__toString` method to the field option %s from service %s is ', get_class($element), $fieldDescription->getName(), $fieldDescription->getAdmin()->getCode())); } return call_user_func(array($element, $method)); } if (is_callable($propertyPath)) { return $propertyPath($element); } return $this->pool->getPropertyAccessor()->getValue($element, $propertyPath); }
/** * {@inheritdoc} */ public function attachAdminClass(FieldDescriptionInterface $fieldDescription) { $pool = $this->getConfigurationPool(); $adminCode = $fieldDescription->getOption('admin_code'); if ($adminCode !== null) { $admin = $pool->getAdminByAdminCode($adminCode); } else { $admin = $pool->getAdminByClass($fieldDescription->getTargetEntity()); } if (!$admin) { return; } if ($this->hasRequest()) { $admin->setRequest($this->getRequest()); } $fieldDescription->setAssociationAdmin($admin); }
/** * @param \Sonata\AdminBundle\Datagrid\DatagridInterface $datagrid * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $fieldDescription * @return bool */ public function addFilter(DatagridInterface $datagrid, FieldDescriptionInterface $fieldDescription) { if (!$fieldDescription->getType()) { return false; } switch ($fieldDescription->getType()) { case ClassMetadataInfo::MANY_TO_ONE: $options = $fieldDescription->getOption('filter_field_options'); $filter = new \Sonata\AdminBundle\Filter\ORM\IntegerFilter($fieldDescription); break; case ClassMetadataInfo::MANY_TO_MANY: $options = $fieldDescription->getOption('filter_field_options'); $options['choices'] = $this->getChoices($fieldDescription); $fieldDescription->setOption('filter_field_options', $options); $filter = new \Sonata\AdminBundle\Filter\ORM\ChoiceFilter($fieldDescription); break; default: $class = $this->getFilterFieldClass($fieldDescription); $filter = new $class($fieldDescription); } return $datagrid->addFilter($filter); }