sonata-project / SonataNewsBundle

src/Admin/CommentAdmin.php

<?php

declare(strict_types=1);

/*
 * 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\NewsBundle\Admin;

use Sonata\AdminBundle\Admin\AbstractAdmin;
use Sonata\AdminBundle\Datagrid\DatagridMapper;
use Sonata\AdminBundle\Datagrid\ListMapper;
use Sonata\AdminBundle\Form\FormMapper;
use Sonata\AdminBundle\Form\Type\ModelListType;
use Sonata\Doctrine\Model\ManagerInterface;
use Sonata\NewsBundle\Form\Type\CommentStatusType;
use Sonata\NewsBundle\Model\CommentManagerInterface;
use Symfony\Component\Form\Extension\Core\Type\TextType;

class CommentAdmin extends AbstractAdmin
{
    /**
     * @var CommentManagerInterface
     */
    protected $commentManager;

    public function getBatchActions()
    {
        $actions = parent::getBatchActions();

        $actions['enabled'] = [
            'label' => $this->getLabelTranslatorStrategy()->getLabel('enable', 'batch', 'comment'),
            'translation_domain' => $this->getTranslationDomain(),
            'ask_confirmation' => false,
        ];

        $actions['disabled'] = [
            'label' => $this->getLabelTranslatorStrategy()->getLabel('disable', 'batch', 'comment'),
            'translation_domain' => $this->getTranslationDomain(),
            'ask_confirmation' => false,
        ];

        return $actions;
    }

    public function postPersist($object): void
    {
        $this->updateCountsComment();
    }

    public function postRemove($object): void
    {
        $this->updateCountsComment();
    }

    public function postUpdate($object): void
    {
        $this->updateCountsComment();
    }

    public function setCommentManager(ManagerInterface $commentManager): void
    {
        if (!$commentManager instanceof CommentManagerInterface) {
            @trigger_error(

It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

                'Calling the '.__METHOD__.' method with a Sonata\Doctrine\Model\ManagerInterface is deprecated'
                .' since version 2.4 and will be removed in 3.0.'
                .' Use the new signature with a Sonata\NewsBundle\Model\CommentManagerInterface instead.',
                E_USER_DEPRECATED
            );
        }

        $this->commentManager = $commentManager;

$commentManager is of type object<Sonata\Doctrine\Model\ManagerInterface>, but the property $commentManager was declared to be of type object<Sonata\NewsBundle\Model\CommentManagerInterface>. Are you sure that you always receive this specific sub-class here, or does it make sense to add an instanceof check?

    }

    protected function configureFormFields(FormMapper $formMapper): void
    {
        // define group zoning
        $formMapper
            ->with('group_comment', ['class' => 'col-md-6'])->end()
            ->with('group_general', ['class' => 'col-md-6'])->end()
        ;

        if (!$this->isChild()) {
            $formMapper
                ->with('group_general')
                    ->add('post', ModelListType::class)
                ->end()
            ;
        }

        $formMapper
            ->with('group_general')
                ->add('name')
                ->add('email')
                ->add('url', null, ['required' => false])
            ->end()
            ->with('group_comment')
                ->add('status', CommentStatusType::class, [
                    'expanded' => true,
                    'multiple' => false,
                ])
                ->add('message', null, ['attr' => ['rows' => 6]])
            ->end()
        ;
    }

    protected function configureDatagridFilters(DatagridMapper $datagridMapper): void
    {
        $datagridMapper
            ->add('name')
            ->add('email')
            ->add('message')
        ;
    }

    protected function configureListFields(ListMapper $listMapper): void
    {
        $listMapper
            ->addIdentifier('name')
            ->add('getStatusCode', TextType::class, ['label' => 'status_code', 'sortable' => 'status'])
        ;

        if (!$this->isChild()) {
            $listMapper->add('post');
        }

        $listMapper
            ->add('email')
            ->add('url')
            ->add('message');
    }

    /**
     * Update the count comment.
     */
    private function updateCountsComment(): void
    {
        $this->commentManager->updateCommentsCount();
    }
}