Closed kyeno closed 4 years ago
What is the content of App\Admin\CRUD\list_custom.html.twig
, because the error could be in this file.
Children is a Collection
and you may use it as a string.
I literally stripped it down to static text, the error still persists:
{% extends '@SonataAdmin/CRUD/base_list_field.html.twig' %}
{% block field %}
<div>
Static text (for test)
</div>
{% endblock %}
I think I know where you're coming from; looking at the source of base_list_field.html.twig
it indeed tries to access the object alone. What else would I extend?
Deleting the whole extends
line doesn't make the error disappear either.
I also updated my stack to remove core-bundle
and update twig-extensions
to 1.4.1. Nada. :(
Could you provide a repo with the error ? It's hard to blind-debug for me.
If you remove the children
field, no error ?
If you remove the template
option, no error ?
Then if you use a custom template with nothing inside, you get an error ?
Providing the actual repo would be impossible since it's a project I'm doing for someone. Making a special repo just with this error - I could try doing that tomorrow.
Custom, empty template - error persists.
If I remove children
field - no error.
If I remove template
option - no error.
@kyeno Can you use this custom template instead @SonataAdmin/CRUD/base_list_field.html.twig
?
<td>
{% block field %}
Parent template for test.
{% endblock %}
</td>
This will test @SonataAdmin/CRUD/base_list_field.html.twig
.
You can also add __toString()
method to children class or use `{{ dump() }} to debug it.
@wbloszyk I tried, but I came to that literally anything declared as template
option triggers this error. I can use 'template' => 'a'
- boom. Only not having the template set or having 'template' => ''
removes the error.
I added __toString()
magic methods to both the Entity and it's EntityRepository for the sake of testing - no donut.
Maybe small part of my models could help you analyze?
So, here's the Post
entity that's actually connected with SonataNewsBundle
:
<?php
namespace App\Entity;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Validator\Constraints as Assert;
use Sonata\NewsBundle\Entity\BasePost as BasePost;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Gedmo\Timestampable\Traits\TimestampableEntity;
use Gedmo\Blameable\Traits\BlameableEntity;
use Gedmo\IpTraceable\Traits\IpTraceableEntity;
use App\Entity\Traits\SEOTrait;
/**
* News
*
* @ORM\Table(name="post")
* @ORM\Entity(repositoryClass="App\Repository\PostRepository")
*/
class Post extends BasePost
{
/**
* @ORM\Id
* @ORM\Column(type="integer")
* @ORM\GeneratedValue(strategy="AUTO")
*
* @var int $id
*/
protected $id;
/**
* HAS MANY: Child posts (self-referencing) for translations
* @ORM\OneToMany(targetEntity="Post", mappedBy="parent")
*/
protected $children;
/**
* HAS ONE: Parent post (self-referencing) for translations
* @ORM\ManyToOne(targetEntity="Post", inversedBy="children")
* @ORM\JoinColumn(name="parent_id", referencedColumnName="id", nullable=true, onDelete="SET NULL")
*/
protected $parent;
/**
* @ORM\Column(name="language", type="string", length=2, nullable=false)
* @Assert\Choice(callback = {"App\Enumerator\LocaleEnumerator", "getLanguageChoiceKeys"})
*/
protected $language = 'en';
// Include SEO fields and trackable behaviours
use SEOTrait;
//use TimestampableEntity; // NOTE: incompatible with NewsBundle's BasePost
use BlameableEntity;
use IpTraceableEntity;
public function __construct()
{
parent::__construct();
$this->children = new ArrayCollection();
}
public function __toString()
{
return ($this->getTitle()) ?: 'unnamed';
}
/**
* Get id.
*
* @return int $id
*/
public function getId()
{
return $this->id;
}
public function getLanguage(): ?string
{
return $this->language;
}
public function setLanguage(string $language): self
{
$this->language = $language;
return $this;
}
/**
* @return Collection|Post[]
*/
public function getChildren(): Collection
{
return $this->children;
}
public function addChild(Post $child): self
{
if (!$this->children->contains($child)) {
$this->children[] = $child;
$child->setParent($this);
}
return $this;
}
public function removeChild(Post $child): self
{
if ($this->children->contains($child)) {
$this->children->removeElement($child);
// set the owning side to null (unless already changed)
if ($child->getParent() === $this) {
$child->setParent(null);
}
}
return $this;
}
public function getParent(): ?self
{
return $this->parent;
}
public function setParent(?self $parent): self
{
$this->parent = $parent;
return $this;
}
}
Repository is empty, just has the __toString()
magic method, so I won't be pasting it in.
Here are some important parts of sonata_news.yaml
:
sonata_news:
permalink_generator: sonata.news.permalink.collection
db_driver: 'doctrine_orm'
class:
post: App\Entity\Post
comment: App\Entity\Comment
media: App\Entity\Media
user: App\Entity\User
tag: App\Entity\Tag
collection: App\Entity\Collection
# override defaults
admin:
post:
class: App\Admin\PostAdmin
Here are potentially interesting parts of PostAdmin
:
<?php
namespace App\Admin;
// SonataNewsBundle defaults we'll be overriding
use Sonata\NewsBundle\Admin\PostAdmin as AbstractAdmin;
//use Sonata\AdminBundle\Admin\AbstractAdmin;
// Sonata default
use Sonata\AdminBundle\Datagrid\ListMapper;
use Sonata\AdminBundle\Datagrid\DatagridMapper;
use Sonata\AdminBundle\Form\FormMapper;
use Sonata\AdminBundle\Show\ShowMapper;
// SonataFormatterBundle and other field types we might want
use Sonata\FormatterBundle\Form\Type\FormatterType;
use Sonata\AdminBundle\Form\Type\ModelType;
use Sonata\AdminBundle\Form\Type\ModelListType;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// Custom queries
use Sonata\AdminBundle\Datagrid\ProxyQueryInterface;
// Enumeration
use App\Enumerator\LocaleEnumerator;
// Traits
use App\Admin\Traits\SEOAdminTrait;
use App\Admin\Traits\TrackableAdminTrait;
class PostAdmin extends AbstractAdmin
{
use SEOAdminTrait {
SEOAdminTrait::configureFormFields as configureFormFieldsSEO;
}
use TrackableAdminTrait {
TrackableAdminTrait::configureFormFields as configureFormFieldsTrackable;
TrackableAdminTrait::configureDatagridFilters as configureDatagridFiltersTrackable;
}
protected function configureDefaultSortValues(array &$sortValues): void
{
$sortValues['_sort_order'] = 'DESC';
}
/**
* Custom query to select only parent nodes; rule out all child nodes and render them within list
*
* @param ProxyQueryInterface $query
* @return ProxyQueryInterface
*/
protected function configureQuery(ProxyQueryInterface $query): ProxyQueryInterface
{
$query = parent::configureQuery($query);
$query->andWhere(
$query->expr()->isNull($query->getRootAliases()[0] . '.parent')
);
return $query;
}
/**
* @param ListMapper $listMapper
*/
protected function configureListFields(ListMapper $listMapper)
{
parent::configureListFields($listMapper);
// custom stuff
$listMapper
->add('language', 'choice', [
'multiple' => true,
'label' => 'Language',
'choices' => LocaleEnumerator::getLanguageChoices(),
'editable' => false
])
// FIXME: Object of class Doctrine\ORM\PersistentCollection could not be converted to string
//->add('children', 'array', [
->add('children', null, [
'label' => 'Translations',
//'template' => 'App/Admin/CRUD/list_child_posts.html.twig' // NOTE: anything here breaks it
])
->add('_action', null, [
'label' => 'Actions',
'actions' => [
'edit' => [],
'delete' => []
]
])
;
}
public function __toString()
{
//return ($this->getTitle()) ?: 'unnamed';
return $this->getTitle() ?? 'unnamed';
}
What about admin extensions? If you haven't register extensions we can should be able to reproduce it in custom project.
Edit
I think you should use @App/Admin/CRUD/list_child_posts.html.twig
->add('children', null, [
'label' => 'Translations',
'template' => '@App/Admin/CRUD/list_child_posts.html.twig'
])
The error is coming from class SonataAdminExtension
, which is trying to render
@SonataAdmin/CRUD/base_list_field.html.twig
The call is made by the private method render
, which is called by renderListElement
.
This method is looking for the template, thanks to the method getTemplate
.
$templateName = $fieldDescription->getTemplate() ?: $defaultTemplate;
try {
$template = $environment->load($templateName);
} catch (LoaderError $e) {
@trigger_error(sprintf(
'Relying on default template loading on field template loading exception is deprecated since 3.1'
.' and will be removed in 4.0. A %s exception will be thrown instead',
LoaderError::class
), E_USER_DEPRECATED);
$template = $environment->load($defaultTemplate);
if (null !== $this->logger) {
$this->logger->warning(sprintf(
'An error occured trying to load the template "%s" for the field "%s",'
.' the default template "%s" was used instead.',
$templateName,
$fieldDescription->getFieldName(),
$defaultTemplate
), ['exception' => $e]);
}
}
return $template;
There is a fallback is your template is not found. You're just giving a wrong path.
'template' => 'App\Admin\CRUD\list_custom.html.twig'
If the directory are: templates/Admin/CRUD/list_custom.html.twig
, I would use
'template' => 'Admin/CRUD/list_custom.html.twig'
Hey! Thanks for your tips - but that's sadly not the case. I tried variety of path/prefix styling to that template and it simply doesn't work, keeps throwing the very same error. Even setting it to:
'template' => '@SonataAdmin\CRUD\base_list_field.html.twig'
Throws the very same error.
...and honestly I never heard of or used Admin Extensions before. I used Sonata for variety of projects running Symfony2, Symfony3 and now Symfony4.
It seems to work for me.
Look at renderListElement
and the private method render
in the vendor.
In the render
method, replace
$content = $template->render($parameters);
By
try {
$content = $template->render($parameters);
} catch (\Throwable $e) {
dd($template, $parameters);
}
In the renderListElement
, replace
$template = $this->getTemplate(
$fieldDescription,
// NEXT_MAJOR: Remove this line and use commented line below instead
$fieldDescription->getAdmin()->getTemplate('base_list_field'),
//$this->getTemplateRegistry($fieldDescription->getAdmin()->getCode())->getTemplate('base_list_field'),
$environment
);
By
$template = $this->getTemplate(
$fieldDescription,
// NEXT_MAJOR: Remove this line and use commented line below instead
$fieldDescription->getAdmin()->getTemplate('base_list_field'),
//$this->getTemplateRegistry($fieldDescription->getAdmin()->getCode())->getTemplate('base_list_field'),
$environment
);
dump($fieldDescription, $template);
Then go on the page.
You'll see the template he's trying to use (it will be base_list_field
) and you'll the field description related.
Now, you can go in getTemplate
method, and change
try {
$template = $environment->load($templateName);
} catch (LoaderError $e) {
@trigger_error(sprintf(
'Relying on default template loading on field template loading exception is deprecated since 3.1'
.' and will be removed in 4.0. A %s exception will be thrown instead',
LoaderError::class
), E_USER_DEPRECATED);
$template = $environment->load($defaultTemplate);
if (null !== $this->logger) {
$this->logger->warning(sprintf(
'An error occured trying to load the template "%s" for the field "%s",'
.' the default template "%s" was used instead.',
$templateName,
$fieldDescription->getFieldName(),
$defaultTemplate
), ['exception' => $e]);
}
}
By
try {
$template = $environment->load($templateName);
} catch (LoaderError $e) {
dump($templateName);
@trigger_error(sprintf(
'Relying on default template loading on field template loading exception is deprecated since 3.1'
.' and will be removed in 4.0. A %s exception will be thrown instead',
LoaderError::class
), E_USER_DEPRECATED);
$template = $environment->load($defaultTemplate);
if (null !== $this->logger) {
$this->logger->warning(sprintf(
'An error occured trying to load the template "%s" for the field "%s",'
.' the default template "%s" was used instead.',
$templateName,
$fieldDescription->getFieldName(),
$defaultTemplate
), ['exception' => $e]);
}
}
If the template name is dump, it means that he cannot find it.
You tried '@SonataAdmin\CRUD\base_list_field.html.twig'
.
You can see in my example I use /
and not \
. Not sure if it's the reason twig cannot find the template.
Where is your custom template ?
Honestly, first and foremost I'm trying to make it work with whatever custom template, even pre-setting one of the Sonata's CRUD ones. I'm experimenting with SonataAdminExtension
class now. dumping in renderListElement
doesn't change much, I still get the red HTTP500 error with stack trace. Dumping with die()
stops on the very first list element which, of course, is not that one.
I'll try dumping to file in order to debug.
It works well when I try it. So I think my hypothesis is the right one, the template is not found and it use the default one.
Honestly, first and foremost I'm trying to make it work with whatever custom template, even pre-setting one of the Sonata's CRUD ones.
It doesn't matter what you try if you have a mistake in the way you wrote the path. You never answered to me. Where is your custom template @kyeno ?
'@SonataAdmin\CRUD\base_list_field.html.twig'
It obviously won't work if you use this template...
Had to run off for a bit. @VincentLanglet Indeed I skipped answering, but you were right at the very end!
'template' => 'Admin/CRUD/list_custom.html.twig'
did the trick. Amazing. Guess it's my "price to pay" for migration from Symfony3 to Symfony4.
Still the error it renders is at least strange. Maybe worth "enhancing" error catching/throwing logic here in general?
Thank you!
Still the error it renders is at least strange. Maybe worth "enhancing" error catching/throwing logic here in general?
It's a BC-break. You need to wait for 4.0 version. It's already implemented.
5689 # Environment
Sonata packages
Symfony packages
PHP version
Doctrine ORM, MariaDB
Subject
Enabling
template
field inconfigureListFields()
admin class method on self-referencing one-to-many (parent->children) relation causes critical error: Object of class Doctrine\ORM\PersistentCollection could not be converted to stringSteps to reproduce
public function configureListFields(ListMapper $listMapper)
useExpected results
Custom listing for desired field.
Actual results
Object of class Doctrine\ORM\PersistentCollection could not be converted to string
var/cache/dev/twig/94/94258473ddbf71159141a1387431b2f46a425ebb9548c1f00b79de01ac530fc6.php line 218