AbstractCRUD::getSuccessRoute() - Code Metrics - Inspection of "Removed deprecated classes and element options" - fsi-open/admin-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#255)

by Piotr

created 2017-02-09 15:22 UTC

AbstractCRUD::getSuccessRoute() A

↳ Parent: AbstractCRUD

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php

/**
 * (c) FSi sp. z o.o. <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace FSi\Bundle\AdminBundle\Admin\CRUD;

use FSi\Bundle\AdminBundle\Admin\AbstractElement;
use FSi\Bundle\AdminBundle\Exception\RuntimeException;
use FSi\Component\DataGrid\DataGridFactoryInterface;
use FSi\Component\DataGrid\DataGridInterface;
use FSi\Component\DataSource\DataSourceFactoryInterface;
use FSi\Component\DataSource\DataSourceInterface;
use Symfony\Component\Form\FormFactoryInterface;
use Symfony\Component\Form\FormInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;

/**
 * @author Norbert Orzechowicz <[email protected]>
 */
abstract class AbstractCRUD extends AbstractElement implements CRUDElement
{
    /**
     * @var \FSi\Component\DataSource\DataSourceFactoryInterface
     */
    protected $datasourceFactory;

    /**
     * @var \FSi\Component\DataGrid\DataGridFactoryInterface
     */
    protected $datagridFactory;

    /**
     * @var \Symfony\Component\Form\FormFactoryInterface
     */
    protected $formFactory;

    /**
     * {@inheritdoc}
     */
    public function getRoute()
    {
        return 'fsi_admin_list';
    }

    /**
     * {@inheritdoc}
     */
    public function getSuccessRoute()
    {
        return $this->getRoute();
    }

    /**
     * {@inheritdoc}
     */
    public function getSuccessRouteParameters()
    {
        return $this->getRouteParameters();
    }

    /**
     * {@inheritdoc}
     */
    public function setDefaultOptions(OptionsResolver $resolver)
    {
        $resolver->setDefaults(array(
            'allow_delete' => true,
            'allow_add' => true,
            'template_list' => null,
            'template_form' => null
        ));

        $resolver->setAllowedTypes('allow_delete', 'bool');
        $resolver->setAllowedTypes('allow_add', 'bool');
        $resolver->setAllowedTypes('template_list', array('null', 'string'));
        $resolver->setAllowedTypes('template_form', array('null', 'string'));
    }

    /**
     * @inheritdoc
     */
    public function apply($object)
    {
        $this->delete($object);
    }

    /**
     * {@inheritdoc}
     */
    public function setDataGridFactory(DataGridFactoryInterface $factory)
    {
        $this->datagridFactory = $factory;
    }

    /**
     * {@inheritdoc}
     */
    public function setDataSourceFactory(DataSourceFactoryInterface $factory)
    {
        $this->datasourceFactory = $factory;
    }

    /**
     * {@inheritdoc}
     */
    public function setFormFactory(FormFactoryInterface $factory)
    {
        $this->formFactory = $factory;
    }

    /**
     * {@inheritdoc}
     */
    public function createDataGrid()
    {
        $datagrid = $this->initDataGrid($this->datagridFactory);

        if (!is_object($datagrid) || !$datagrid instanceof DataGridInterface) {
            throw new RuntimeException('initDataGrid should return instanceof FSi\\Component\\DataGrid\\DataGridInterface');
        }

        if ($this->options['allow_delete']) {
            if (!$datagrid->hasColumnType('batch')) {
                $datagrid->addColumn('batch', 'batch', array(
                    'actions' => array(
                        'delete' => array(
                            'route_name' => 'fsi_admin_batch',
                            'additional_parameters' => array('element' => $this->getId()),
                            'label' => 'crud.list.batch.delete'
                        )
                    ),
                    'display_order' => -1000
                ));
            }
        }

        return $datagrid;
    }

    /**
     * {@inheritdoc}
     */
    public function createDataSource()
    {
        $datasource = $this->initDataSource($this->datasourceFactory);

        if (!is_object($datasource) || !$datasource instanceof DataSourceInterface) {
            throw new RuntimeException('initDataSource should return instanceof FSi\\Component\\DataSource\\DataSourceInterface');
        }

        return $datasource;
    }

    /**
     * {@inheritdoc}
     */
    public function createForm($data = null)
    {
        $form = $this->initForm($this->formFactory, $data);

        if (!is_object($form) || !$form instanceof FormInterface) {
            throw new RuntimeException('initForm should return instanceof Symfony\\Component\\Form\\FormInterface');
        }

        return $form;
    }

    /**
     * Initialize DataGrid.
     *
     * @param \FSi\Component\DataGrid\DataGridFactoryInterface $factory
     * @return \FSi\Component\DataGrid\DataGridInterface
     */
    abstract protected function initDataGrid(DataGridFactoryInterface $factory);

    /**
     * Initialize DataSource.
     *
     * @param \FSi\Component\DataSource\DataSourceFactoryInterface $factory
     * @return \FSi\Component\DataSource\DataSourceInterface
     */
    abstract protected function initDataSource(DataSourceFactoryInterface $factory);

    /**
     * Initialize create Form. This form will be used in createAction in CRUDController.
     *
     * @param \Symfony\Component\Form\FormFactoryInterface $factory
     * @param mixed $data
     * @return \Symfony\Component\Form\FormInterface
     */
    abstract protected function initForm(FormFactoryInterface $factory, $data = null);
}


1			<?php
2
3			/**
4			* (c) FSi sp. z o.o. <[email protected]>
5			*
6			* For the full copyright and license information, please view the LICENSE
7			* file that was distributed with this source code.
8			*/
9
10			namespace FSi\Bundle\AdminBundle\Admin\CRUD;
11
12			use FSi\Bundle\AdminBundle\Admin\AbstractElement;
13			use FSi\Bundle\AdminBundle\Exception\RuntimeException;
14			use FSi\Component\DataGrid\DataGridFactoryInterface;
15			use FSi\Component\DataGrid\DataGridInterface;
16			use FSi\Component\DataSource\DataSourceFactoryInterface;
17			use FSi\Component\DataSource\DataSourceInterface;
18			use Symfony\Component\Form\FormFactoryInterface;
19			use Symfony\Component\Form\FormInterface;
20			use Symfony\Component\OptionsResolver\OptionsResolver;
21
22			/**
23			* @author Norbert Orzechowicz <[email protected]>
24			*/
25			abstract class AbstractCRUD extends AbstractElement implements CRUDElement
26			{
27			/**
28			* @var \FSi\Component\DataSource\DataSourceFactoryInterface
29			*/
30			protected $datasourceFactory;
31
32			/**
33			* @var \FSi\Component\DataGrid\DataGridFactoryInterface
34			*/
35			protected $datagridFactory;
36
37			/**
38			* @var \Symfony\Component\Form\FormFactoryInterface
39			*/
40			protected $formFactory;
41
42			/**
43			* {@inheritdoc}
44			*/
45			public function getRoute()
46			{
47			return 'fsi_admin_list';
48			}
49
50			/**
51			* {@inheritdoc}
52			*/
53			public function getSuccessRoute()
54			{
55			return $this->getRoute();
56			}
57
58			/**
59			* {@inheritdoc}
60			*/
61			public function getSuccessRouteParameters()
62			{
63			return $this->getRouteParameters();
64			}
65
66			/**
67			* {@inheritdoc}
68			*/
69			public function setDefaultOptions(OptionsResolver $resolver)
70			{
71			$resolver->setDefaults(array(
72			'allow_delete' => true,
73			'allow_add' => true,
74			'template_list' => null,
75			'template_form' => null
76			));
77
78			$resolver->setAllowedTypes('allow_delete', 'bool');
79			$resolver->setAllowedTypes('allow_add', 'bool');
80			$resolver->setAllowedTypes('template_list', array('null', 'string'));
81			$resolver->setAllowedTypes('template_form', array('null', 'string'));
82			}
83
84			/**
85			* @inheritdoc
86			*/
87			public function apply($object)
88			{
89			$this->delete($object);
90			}
91
92			/**
93			* {@inheritdoc}
94			*/
95			public function setDataGridFactory(DataGridFactoryInterface $factory)
96			{
97			$this->datagridFactory = $factory;
98			}
99
100			/**
101			* {@inheritdoc}
102			*/
103			public function setDataSourceFactory(DataSourceFactoryInterface $factory)
104			{
105			$this->datasourceFactory = $factory;
106			}
107
108			/**
109			* {@inheritdoc}
110			*/
111			public function setFormFactory(FormFactoryInterface $factory)
112			{
113			$this->formFactory = $factory;
114			}
115
116			/**
117			* {@inheritdoc}
118			*/
119			public function createDataGrid()
120			{
121			$datagrid = $this->initDataGrid($this->datagridFactory);
122
123			if (!is_object($datagrid) \|\| !$datagrid instanceof DataGridInterface) {
124			throw new RuntimeException('initDataGrid should return instanceof FSi\\Component\\DataGrid\\DataGridInterface');
125			}
126
127			if ($this->options['allow_delete']) {
128			if (!$datagrid->hasColumnType('batch')) {
129			$datagrid->addColumn('batch', 'batch', array(
130			'actions' => array(
131			'delete' => array(
132			'route_name' => 'fsi_admin_batch',
133			'additional_parameters' => array('element' => $this->getId()),
134			'label' => 'crud.list.batch.delete'
135			)
136			),
137			'display_order' => -1000
138			));
139			}
140			}
141
142			return $datagrid;
143			}
144
145			/**
146			* {@inheritdoc}
147			*/
148			public function createDataSource()
149			{
150			$datasource = $this->initDataSource($this->datasourceFactory);
151
152			if (!is_object($datasource) \|\| !$datasource instanceof DataSourceInterface) {
153			throw new RuntimeException('initDataSource should return instanceof FSi\\Component\\DataSource\\DataSourceInterface');
154			}
155
156			return $datasource;
157			}
158
159			/**
160			* {@inheritdoc}
161			*/
162			public function createForm($data = null)
163			{
164			$form = $this->initForm($this->formFactory, $data);
165
166			if (!is_object($form) \|\| !$form instanceof FormInterface) {
167			throw new RuntimeException('initForm should return instanceof Symfony\\Component\\Form\\FormInterface');
168			}
169
170			return $form;
171			}
172
173			/**
174			* Initialize DataGrid.
175			*
176			* @param \FSi\Component\DataGrid\DataGridFactoryInterface $factory
177			* @return \FSi\Component\DataGrid\DataGridInterface
178			*/
179			abstract protected function initDataGrid(DataGridFactoryInterface $factory);
180
181			/**
182			* Initialize DataSource.
183			*
184			* @param \FSi\Component\DataSource\DataSourceFactoryInterface $factory
185			* @return \FSi\Component\DataSource\DataSourceInterface
186			*/
187			abstract protected function initDataSource(DataSourceFactoryInterface $factory);
188
189			/**
190			* Initialize create Form. This form will be used in createAction in CRUDController.
191			*
192			* @param \Symfony\Component\Form\FormFactoryInterface $factory
193			* @param mixed $data
194			* @return \Symfony\Component\Form\FormInterface
195			*/
196			abstract protected function initForm(FormFactoryInterface $factory, $data = null);
197			}
198

fsi-open / admin-bundle

Pull Request — master (#255)

AbstractCRUD::getSuccessRoute() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like