diff --git a/.travis.yml b/.travis.yml index 3b0677ff..fb1dde56 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,25 +1,23 @@ language: php php: - - 5.6 - - 7.0 + - 7.2 + - 7.3 matrix: include: - - php: 5.6 + - php: 7.2 env: | - SYMFONY_VERSION=2.7.* - - php: 5.6 - env: | - SYMFONY_VERSION=2.8.* - - php: 7.1 + SYMFONY_VERSION=^3.0 + - php: 7.2 env: | SYMFONY_VERSION=^4.0 before_install: + - echo "extension = mongodb.so" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini - | if [ "${SYMFONY_VERSION}" != "" ]; then - packages="form dependency-injection config http-foundation http-kernel options-resolver security serializer" + packages="form dependency-injection config http-foundation http-kernel options-resolver security-guard serializer" devpackages="framework-bundle browser-kit templating expression-language" for package in $packages do @@ -31,10 +29,6 @@ before_install: done fi; - -before_script: - - echo "extension=mongodb.so" >> `php --ini | grep "Loaded Configuration" | sed -e "s|.*:\s*||"` - install: - travis_retry composer self-update - COMPOSER_MEMORY_LIMIT=-1 travis_retry composer update ${COMPOSER_FLAGS} --no-interaction @@ -46,4 +40,4 @@ script: - php vendor/bin/phpunit -c phpunit.xml.dist after_success: - - php vendor/bin/coveralls + - php vendor/bin/php-coveralls diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php index ac12a86e..4118b062 100644 --- a/DependencyInjection/Configuration.php +++ b/DependencyInjection/Configuration.php @@ -17,8 +17,8 @@ class Configuration implements ConfigurationInterface */ public function getConfigTreeBuilder() { - $treeBuilder = new TreeBuilder(); - $rootNode = $treeBuilder->root('apy_data_grid'); + $treeBuilder = new TreeBuilder('apy_data_grid'); + $rootNode = $treeBuilder->getRootNode(); $rootNode ->children() @@ -32,7 +32,7 @@ public function getConfigTreeBuilder() ->prototype('scalar')->end() ->end() ->booleanNode('persistence')->defaultFalse()->end() - ->scalarNode('theme')->defaultValue('APYDataGridBundle::blocks.html.twig')->end() + ->scalarNode('theme')->defaultValue('@APYDataGrid/blocks.html.twig')->end() ->scalarNode('no_data_message')->defaultValue('No data')->end() ->scalarNode('no_result_message')->defaultValue('No result')->end() ->scalarNode('actions_columns_size')->defaultValue(-1)->end() diff --git a/Grid/Column/Column.php b/Grid/Column/Column.php index 7dd4b56d..ba82a031 100644 --- a/Grid/Column/Column.php +++ b/Grid/Column/Column.php @@ -687,7 +687,7 @@ public function getFilters($source) { $filters = []; - if (isset($this->data) && $this->hasOperator($this->data['operator'])) { + if (isset($this->data['operator']) && $this->hasOperator($this->data['operator'])) { if ($this instanceof ArrayColumn && in_array($this->data['operator'], [self::OPERATOR_EQ, self::OPERATOR_NEQ])) { $filters[] = new Filter($this->data['operator'], $this->data['from']); } else { diff --git a/Grid/Export/Export.php b/Grid/Export/Export.php index 19326355..a4782760 100644 --- a/Grid/Export/Export.php +++ b/Grid/Export/Export.php @@ -19,7 +19,7 @@ abstract class Export implements ExportInterface, ContainerAwareInterface { - const DEFAULT_TEMPLATE = 'APYDataGridBundle::blocks.html.twig'; + const DEFAULT_TEMPLATE = '@APYDataGrid/blocks.html.twig'; protected $title; @@ -459,7 +459,7 @@ protected function getTemplatesFromString($theme) $templates = []; $template = $this->twig->loadTemplate($theme); - while ($template instanceof \Twig_Template) { + while ($template instanceof TemplateWrapper) { $templates[] = $template; $template = $template->getParent([]); } diff --git a/Grid/Grid.php b/Grid/Grid.php index efe3b505..6ebba593 100644 --- a/Grid/Grid.php +++ b/Grid/Grid.php @@ -26,6 +26,7 @@ use Symfony\Component\HttpFoundation\RedirectResponse; use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpFoundation\Response; +use Twig\TemplateWrapper; class Grid implements GridInterface { @@ -359,8 +360,10 @@ public function initialize() $this->setPersistence($config->isPersisted()); // Route parameters - $routeParameters = $config->getRouteParameters(); - if (!empty($routeParameters)) { + $routeParameters = []; + $parameters = $config->getRouteParameters(); + if (!empty($parameters)) { + $routeParameters = $parameters; foreach ($routeParameters as $parameter => $value) { $this->setRouteParameter($parameter, $value); } @@ -1135,7 +1138,7 @@ protected function set($key, $data) protected function saveSession() { - if (!empty($this->sessionData)) { + if (!empty($this->sessionData) && !empty($this->hash)) { $this->session->set($this->hash, $this->sessionData); } } @@ -1395,12 +1398,11 @@ public function getRowActions() public function setTemplate($template) { if ($template !== null) { - if ($template instanceof \Twig_Template) { + if ($template instanceof TemplateWrapper) { $template = '__SELF__' . $template->getTemplateName(); } elseif (!is_string($template)) { throw new \Exception(self::TWIG_TEMPLATE_LOAD_EX_MSG); } - $this->set(self::REQUEST_QUERY_TEMPLATE, $template); $this->saveSession(); } @@ -2147,7 +2149,7 @@ public function getGridResponse($param1 = null, $param2 = null, Response $respon if ($view === null) { return $parameters; } else { - return $this->container->get('templating')->renderResponse($view, $parameters, $response); + return new Response($this->container->get('twig')->render($view, $parameters, $response)); } } } diff --git a/Grid/GridManager.php b/Grid/GridManager.php index 271f301d..454eccd0 100644 --- a/Grid/GridManager.php +++ b/Grid/GridManager.php @@ -193,7 +193,15 @@ public function getGridManagerResponse($param1 = null, $param2 = null, Response return $parameters; } - return $this->container->get('templating')->renderResponse($view, $parameters, $response); + $content = $this->container->get('twig')->render($view, $parameters); + + if (null === $response) { + $response = new Response(); + } + + $response->setContent($content); + + return $response; } } diff --git a/README.md b/README.md index b9ee207d..503a98f0 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,32 @@ -Datagrid for Symfony inspired by Zfdatagrid and Magento Grid. -This bundle was initiated by Stanislav Turza (Sorien). -[![Build Status](https://secure.travis-ci.org/APY/APYDataGridBundle.png?branch=master)](http://travis-ci.org/APY/APYDataGridBundle) -[![Coverage Status](https://coveralls.io/repos/github/APY/APYDataGridBundle/badge.svg?branch=test-improvement)](https://coveralls.io/github/APY/APYDataGridBundle?branch=test-improvement) -[![Stories in Ready](https://badge.waffle.io/APY/APYDataGridBundle.svg?label=ready&title=Ready)](http://waffle.io/APY/APYDataGridBundle) -[![Gitter](https://badges.gitter.im/APY/APYDataGridBundle.svg)](https://gitter.im/APY/APYDataGridBundle?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) +# APYDataGrid Bundle -See [CHANGELOG](https://github.com/APY/APYDataGridBundle/blob/master/CHANGELOG.md) and [UPGRADE 2.0](https://github.com/APY/APYDataGridBundle/blob/master/UPGRADE-2.0.md) +This **Symfony Bundle** allows you to create wonderful grid based on data or entities of your projet. -## Features +[![Build Status](https://secure.travis-ci.org/APY/APYDataGridBundle.png?branch=master)](http://travis-ci.org/APY/APYDataGridBundle) [![Coverage Status](https://coveralls.io/repos/github/APY/APYDataGridBundle/badge.svg?branch=test-improvement)](https://coveralls.io/github/APY/APYDataGridBundle?branch=test-improvement) -- Supports Entity (ORM), Document (ODM) and Vector (Array) sources -- Sortable and Filterable with operators (Comparison operators, range, starts/ends with, (not) contains, is (not) defined, regex) +## Features +This bundle allow you to create listing with many features that you can expect : +- Various data sources : supports **Entity** (ORM), **Document** (ODM) and **Vector** (Array) sources +- Data manipulation : **Sortable** and **Filterable** with many operators - Auto-typing columns (Text, Number, Boolean, Array, DateTime, Date, ...) -- Locale support for DateTime, Date and Number columns (Decimal, Currency, Percent, Duration, Scientific, Spell out) +- Locale support for columns and data (DateTime, Date and Number columns) - Input, Select, checkbox and radio button filters filled with the data of the grid or an array of values - Export (CSV, Excel, _PDF_, XML, JSON, HTML, ...) -- Mass actions -- Row actions +- Mass actions, Row actions - Supports mapped fields with Entity source - Securing the columns, actions and export with security roles - Annotations and PHP configuration - External filters box - Ajax loading - Pagination (You can also use Pagerfanta) -- Column width and column align -- Prefix translated titles - Grid manager for multi-grid on the same page - Groups configuration for ORM and ODM sources -- Easy templates overriding (twig) +- Easy templates overriding (Twig) - Custom columns and filters creation -- ... +- *and many more* -## Documentation +## Installation, documentation See the [summary](https://github.com/APY/APYDataGridBundle/blob/master/Resources/doc/summary.md). @@ -44,17 +38,13 @@ Full example with this [CSS style file](https://github.com/APY/APYDataGridBundle Simple example with the external filter box in english: -![test](https://github.com/APY/APYDataGridBundle/blob/master/Resources/doc/images/screenshot_en.png?raw=true) +![test](https://github.com/APY/APYDataGridBundle/blob/master/Resources/doc/images/screenshot_en.png) Same example in french: ![test](https://github.com/APY/APYDataGridBundle/blob/master/Resources/doc/images/screenshot_fr.png?raw=true) -Data used in these screenshots (this is a phpMyAdmin screenshot): - -![test](https://github.com/APY/APYDataGridBundle/blob/master/Resources/doc/images/screenshot_database.png?raw=true) - -## Simple grid with an ORM source +## Example of a simple grid with an ORM source ```php %apy_data_grid.actions_columns_title% + + + diff --git a/Resources/views/blocks.html.twig b/Resources/views/blocks.html.twig index 5d816126..d1b8d50e 100644 --- a/Resources/views/blocks.html.twig +++ b/Resources/views/blocks.html.twig @@ -43,7 +43,7 @@ {% block grid_no_data %}

{{ grid.noDataMessage|default('No data')|trans|raw }}

{% endblock grid_no_data %} {# --------------------------------------------------- grid_no_result ------------------------------------------------- #} {% block grid_no_result %} -{% spaceless %} +{% apply spaceless %} {% set nbColumns = 0 %} {% for column in grid.columns %} {% if column.visible(grid.isReadyForExport) %} @@ -53,7 +53,7 @@ {{ grid.noResultMessage|default('No result')|trans|raw }} -{% endspaceless %} +{% endapply %} {% endblock grid_no_result %} {# --------------------------------------------------- grid_titles -------------------------------------------------- #} {% block grid_titles %} @@ -62,7 +62,7 @@ {% set translation_domain = column.translationDomain %} {% if column.visible(grid.isReadyForExport) %} -1) %} style="width:{{ column.size }}px;"{% endif %}> - {%- spaceless %} + {% apply spaceless %} {% if column.type == 'massaction' %} {% else %} @@ -88,7 +88,7 @@ {{ columnTitle }} {% endif %} {% endif %} - {% endspaceless -%} + {% endapply -%} {% endif %} {% endfor %} @@ -128,7 +128,7 @@ {% block grid_rows %} {% for row in grid.rows %} {% set last_row = loop.last %} - {% spaceless %} + {% apply spaceless %} {% set gridColumns %} {% for column in grid.columns %} {% if column.visible(grid.isReadyForExport) %} @@ -138,7 +138,7 @@ {% endset %} {{ gridColumns }} - {% endspaceless %} + {% endapply %} {% else %} {{ grid_no_result(grid) }} @@ -158,16 +158,16 @@ {% endblock grid_pager %} {# ---------------------------------------------------- grid_pager_totalcount -------------------------------------------------- #} {% block grid_pager_totalcount %} -{{ '%count% Results, ' | transchoice(grid.totalCount, {'%count%': grid.totalCount}) }} +{{ '%count% Results, ' | trans({'%count%': grid.totalCount}) }} {% endblock grid_pager_totalcount %} {# ---------------------------------------------------- grid_pager_selectpage -------------------------------------------------- #} {% block grid_pager_selectpage %} {{ 'Page'|trans }} -{% spaceless %} +{% apply spaceless %} = grid.pageCount-1 %}disabled="disabled"{% endif %} onclick="return {{ grid.hash }}_nextPage();"/> {{ 'of %count%'|trans({ '%count%' : grid.pageCount }) }} -{% endspaceless %} +{% endapply %} {% endblock grid_pager_selectpage %} {# ---------------------------------------------------- grid_pager_results_perpage -------------------------------------------------- #} {% block grid_pager_results_perpage %} @@ -188,7 +188,7 @@ {{ 'Deselect all'|trans }} - {% spaceless %} + {% apply spaceless %}
{{ 'Action'|trans }} @@ -200,13 +200,13 @@
- {% endspaceless %} + {% endapply %} {% endblock grid_actions %} {# --------------------------------------------------- grid_exports ------------------------------------------------- #} {% block grid_exports %}
- {% spaceless %} + {% apply spaceless %} {{ 'Export'|trans }} - {% endspaceless %} + {% endapply %}
{% endblock grid_exports %} {# --------------------------------------------------- grid_tweaks ------------------------------------------------- #} {% block grid_tweaks %}
- {% spaceless %} + {% apply spaceless %} {{ 'Tweaks'|trans }} - {% endspaceless %} + {% endapply %}
{% endblock grid_tweaks %} {# ------------------------------------------------ grid_column_actions_cell --------------------------------------------- #} @@ -299,7 +299,7 @@ {% endblock grid_column_type_simple_array_cell %} {# ------------------------------------------- grid_column_cell ---------------------------------------- #} {% block grid_column_cell %} -{%- spaceless %} +{% apply spaceless %} {% if column.filterable and column.searchOnClick %} {% set sourceValue = sourceValue is defined ? sourceValue : row.field(column.id) %} {{ value }} @@ -308,7 +308,7 @@ {% else %} {{ value|escape(column.safe)|raw }} {% endif %} -{% endspaceless -%} +{% endapply -%} {% endblock grid_column_cell %} {# -------------------------------------------- grid_column_operator --------------------------------------- #} {% block grid_column_operator %} @@ -328,9 +328,15 @@ {% set btweOperator = constant('APY\\DataGridBundle\\Grid\\Column\\Column::OPERATOR_BTWE') %} {% set isNullOperator = constant('APY\\DataGridBundle\\Grid\\Column\\Column::OPERATOR_ISNULL') %} {% set isNotNullOperator = constant('APY\\DataGridBundle\\Grid\\Column\\Column::OPERATOR_ISNOTNULL') %} -{% set op = column.data.operator is defined ? column.data.operator : column.defaultOperator %} -{% set from = column.data.from is defined ? column.data.from : null %} -{% set to = column.data.to is defined ? column.data.to : null %} +{% if column %} + {% set op = column.defaultOperator %} + {% set from = null %} + {% set to = null %} +{% else %} + {% set op = column.data.operator is defined ? column.data.operator : column.defaultOperator %} + {% set from = column.data.from is defined ? column.data.from : null %} + {% set to = column.data.to is defined ? column.data.to : null %} +{% endif %} {{ grid_column_operator(column, grid, op, submitOnChange) }} @@ -345,9 +351,15 @@ {% set btweOperator = constant('APY\\DataGridBundle\\Grid\\Column\\Column::OPERATOR_BTWE') %} {% set isNullOperator = constant('APY\\DataGridBundle\\Grid\\Column\\Column::OPERATOR_ISNULL') %} {% set isNotNullOperator = constant('APY\\DataGridBundle\\Grid\\Column\\Column::OPERATOR_ISNOTNULL') %} -{% set op = column.data.operator is defined ? column.data.operator : column.defaultOperator %} -{% set from = column.data.from is defined ? column.data.from : null %} -{% set to = column.data.to is defined ? column.data.to : null %} +{% if column %} + {% set op = column.defaultOperator %} + {% set from = null %} + {% set to = null %} +{% else %} + {% set op = column.data.operator is defined ? column.data.operator : column.defaultOperator %} + {% set from = column.data.from is defined ? column.data.from : null %} + {% set to = column.data.to is defined ? column.data.to : null %} +{% endif %} {% set multiple = column.selectMulti %} {% set expanded = column.selectExpanded %} diff --git a/Tests/Action/MassActionTest.php b/Tests/Action/MassActionTest.php index 71da8c44..de93769c 100644 --- a/Tests/Action/MassActionTest.php +++ b/Tests/Action/MassActionTest.php @@ -1,6 +1,6 @@ getContainer(); + //$container = self::$container; + //$this->container = $container; + $self = $this; + $this->container = $this->createMock(Container::class); + $this->container->expects($this->any()) + ->method('get') + ->will($this->returnCallback(function ($param) use ($self) { + switch ($param) { + case 'router': + return $self->createMock(RouterInterface::class); + break; + case 'request_stack': + $request = new Request([], [], ['key' => 'value']); + $session = new Session(); + $request->setSession($session); + $requestStack = new RequestStack(); + $requestStack->push($request); + return $requestStack; + break; + case 'security.authorization_checker': + return $self->createMock(AuthorizationCheckerInterface::class); + break; + } + })); + + $this->factory = $this->createMock(GridFactoryInterface::class); + $this->builder = new GridBuilder($this->container, $this->factory, 'name'); + } + public function testAddUnexpectedType() { $this->expectException(UnexpectedTypeException::class); @@ -140,38 +186,6 @@ public function testGetGrid() $this->assertInstanceOf(Grid::class, $this->builder->getGrid()); } - /** - * {@inheritdoc} - */ - protected function setUp() - { - $self = $this; - - $this->container = $this->createMock(Container::class); - $this->container->expects($this->any()) - ->method('get') - ->will($this->returnCallback(function ($param) use ($self) { - switch ($param) { - case 'router': - return $self->createMock(RouterInterface::class); - break; - case 'request_stack': - $request = new Request([], [], ['key' => 'value']); - $requestStack = new RequestStack(); - $requestStack->push($request); - - return $requestStack; - break; - case 'security.authorization_checker': - return $self->createMock(AuthorizationCheckerInterface::class); - break; - } - })); - - $this->factory = $this->createMock(GridFactoryInterface::class); - $this->builder = new GridBuilder($this->container, $this->factory, 'name'); - } - protected function tearDown() { $this->factory = null; diff --git a/Tests/Grid/GridConfigBuilderTest.php b/Tests/Grid/GridConfigBuilderTest.php index 1092b68c..38511baa 100644 --- a/Tests/Grid/GridConfigBuilderTest.php +++ b/Tests/Grid/GridConfigBuilderTest.php @@ -1,6 +1,6 @@ 'value']); + $session = new Session(); + $request->setSession($session); $requestStack = new RequestStack(); $requestStack->push($request); diff --git a/Tests/Grid/GridManagerTest.php b/Tests/Grid/GridManagerTest.php index 4c03200d..c6a77d06 100644 --- a/Tests/Grid/GridManagerTest.php +++ b/Tests/Grid/GridManagerTest.php @@ -1,14 +1,13 @@ router ->method('generate') - ->with($route, null) + ->with($route, []) ->willReturn($url); $this->grid->initialize(); @@ -737,9 +738,8 @@ public function testGetRowActions() public function testSetExportTwigTemplateInstance() { $templateName = 'templateName'; - $template = $this - ->getMockBuilder(\Twig_Template::class) + ->getMockBuilder(TemplateWrapper::class) ->disableOriginalConstructor() ->getMock(); $template @@ -767,6 +767,10 @@ public function testSetExportStringTemplate() ->method('set') ->with($this->anything(), [Grid::REQUEST_QUERY_TEMPLATE => $template]); + + $this->arrangeGridSourceDataLoadedWithEmptyRows(); + $this->arrangeGridPrimaryColumn(); + $this->grid->handleRequest($this->request); $this->grid->setTemplate($template); } @@ -800,7 +804,7 @@ public function testReturnTwigTemplate() $templateName = 'templateName'; $template = $this - ->getMockBuilder(\Twig_Template::class) + ->getMockBuilder(TemplateWrapper::class) ->disableOriginalConstructor() ->getMock(); $template @@ -2593,6 +2597,9 @@ public function testRaiseExceptionIfGetNonExistentTweak() $tweakId = 'aValidTweakId'; $tweak = ['filters' => [], 'order' => 'columnId', 'page' => 1, 'limit' => 50, 'export' => 1, 'massAction' => 1]; + $routeUrl = 'http://www.foo.com'; + $this->grid->setRouteUrl($routeUrl); + $this->grid->addTweak('title', $tweak, $tweakId, 'group'); $this->grid->getTweak($nonExistentTweak); @@ -2603,8 +2610,12 @@ public function testGetTweak() $title = 'aTweak'; $id = 'aValidTweakId'; $group = 'tweakGroup'; + + $routeUrl = 'http://www.foo.com'; + $this->grid->setRouteUrl($routeUrl); + $tweak = ['filters' => [], 'order' => 'columnId', 'page' => 1, 'limit' => 50, 'export' => 1, 'massAction' => 1]; - $tweakUrl = sprintf('?[%s]=%s', Grid::REQUEST_QUERY_TWEAK, $id); + $tweakUrl = $routeUrl.sprintf('?[%s]=%s', Grid::REQUEST_QUERY_TWEAK, $id); $this->grid->addTweak($title, $tweak, $id, $group); @@ -2615,11 +2626,14 @@ public function testGetTweak() public function testGetTweaksByGroupExcludingThoseWhoDoNotHaveTheGroup() { + $routeUrl = 'http://www.foo.com'; + $this->grid->setRouteUrl($routeUrl); + $title = 'aTweak'; $id = 'aValidTweakId'; $group = 'tweakGroup'; $tweak = ['filters' => [], 'order' => 'columnId', 'page' => 1, 'limit' => 50, 'export' => 1, 'massAction' => 1]; - $tweakUrl = sprintf('?[%s]=%s', Grid::REQUEST_QUERY_TWEAK, $id); + $tweakUrl = $routeUrl.sprintf('?[%s]=%s', Grid::REQUEST_QUERY_TWEAK, $id); $tweakResult = [$id => array_merge(['title' => $title, 'id' => $id, 'group' => $group, 'url' => $tweakUrl], $tweak)]; $this->grid->addTweak($title, $tweak, $id, $group); diff --git a/Tests/Grid/Mapping/ColumnTest.php b/Tests/Grid/Mapping/ColumnTest.php index 1a875e8e..a1b9b89e 100644 --- a/Tests/Grid/Mapping/ColumnTest.php +++ b/Tests/Grid/Mapping/ColumnTest.php @@ -1,6 +1,6 @@ method('getQuery') ->willReturn($query); - + $this ->manager ->method('createQueryBuilder') @@ -1529,4 +1529,4 @@ public function getSubCol() { return $this->subCol; } -} \ No newline at end of file +} diff --git a/Tests/Grid/Source/VectorTest.php b/Tests/Grid/Source/VectorTest.php index 1d77d829..639a2fc4 100644 --- a/Tests/Grid/Source/VectorTest.php +++ b/Tests/Grid/Source/VectorTest.php @@ -1,6 +1,6 @@ */ -class DataGridExtension extends Twig_Extension implements Twig_Extension_GlobalsInterface +class DataGridExtension extends AbstractExtension implements GlobalsInterface { const DEFAULT_TEMPLATE = 'APYDataGridBundle::blocks.html.twig'; /** - * @var Twig_Template[] + * @var TemplateWrapper[] */ protected $templates = []; @@ -90,7 +91,7 @@ public function setPagerFanta(array $def) /** * @return array */ - public function getGlobals() + public function getGlobals(): array { return [ 'grid' => null, @@ -112,41 +113,41 @@ public function getGlobals() public function getFunctions() { return [ - new Twig_SimpleFunction('grid', [$this, 'getGrid'], [ + new TwigFunction('grid', [$this, 'getGrid'], [ 'needs_environment' => true, 'is_safe' => ['html'], ]), - new Twig_SimpleFunction('grid_html', [$this, 'getGridHtml'], [ + new TwigFunction('grid_html', [$this, 'getGridHtml'], [ 'needs_environment' => true, 'is_safe' => ['html'], ]), - new Twig_SimpleFunction('grid_url', [$this, 'getGridUrl'], [ + new TwigFunction('grid_url', [$this, 'getGridUrl'], [ 'is_safe' => ['html'], ]), - new Twig_SimpleFunction('grid_filter', [$this, 'getGridFilter'], [ + new TwigFunction('grid_filter', [$this, 'getGridFilter'], [ 'needs_environment' => true, 'is_safe' => ['html'], ]), - new Twig_SimpleFunction('grid_column_operator', [$this, 'getGridColumnOperator'], [ + new TwigFunction('grid_column_operator', [$this, 'getGridColumnOperator'], [ 'needs_environment' => true, 'is_safe' => ['html'], ]), - new Twig_SimpleFunction('grid_cell', [$this, 'getGridCell'], [ + new TwigFunction('grid_cell', [$this, 'getGridCell'], [ 'needs_environment' => true, 'is_safe' => ['html'], ]), - new Twig_SimpleFunction('grid_search', [$this, 'getGridSearch'], [ + new TwigFunction('grid_search', [$this, 'getGridSearch'], [ 'needs_environment' => true, 'is_safe' => ['html'], ]), - new Twig_SimpleFunction('grid_pager', [$this, 'getGridPager'], [ + new TwigFunction('grid_pager', [$this, 'getGridPager'], [ 'needs_environment' => true, 'is_safe' => ['html'], ]), - new Twig_SimpleFunction('grid_pagerfanta', [$this, 'getPagerfanta'], [ + new TwigFunction('grid_pagerfanta', [$this, 'getPagerfanta'], [ 'is_safe' => ['html'], ]), - new Twig_SimpleFunction('grid_*', [$this, 'getGrid_'], [ + new TwigFunction('grid_*', [$this, 'getGrid_'], [ 'needs_environment' => true, 'is_safe' => ['html'], ]), @@ -171,14 +172,14 @@ public function initGrid($grid, $theme = null, $id = '', array $params = []) /** * Render grid block. * - * @param Twig_Environment $environment - * @param \APY\DataGridBundle\Grid\Grid $grid - * @param string $theme - * @param string $id + * @param Environment $environment + * @param Grid $grid + * @param string $theme + * @param string $id * * @return string */ - public function getGrid(Twig_Environment $environment, $grid, $theme = null, $id = '', array $params = [], $withjs = true) + public function getGrid(Environment $environment, $grid, $theme = null, $id = '', array $params = [], $withjs = true) { $this->initGrid($grid, $theme, $id, $params); @@ -191,37 +192,37 @@ public function getGrid(Twig_Environment $environment, $grid, $theme = null, $id /** * Render grid block (html only). * - * @param Twig_Environment $environment - * @param \APY\DataGridBundle\Grid\Grid $grid - * @param string $theme - * @param string $id + * @param Environment $environment + * @param Grid $grid + * @param string $theme + * @param string $id * * @return string */ - public function getGridHtml(Twig_Environment $environment, $grid, $theme = null, $id = '', array $params = []) + public function getGridHtml(Environment $environment, $grid, $theme = null, $id = '', array $params = []) { return $this->getGrid($environment, $grid, $theme, $id, $params, false); } /** - * @param Twig_Environment $environment + * @param Environment $environment * @param string $name * @param unknown $grid * * @return string */ - public function getGrid_(Twig_Environment $environment, $name, $grid) + public function getGrid_(Environment $environment, $name, $grid) { return $this->renderBlock($environment, 'grid_' . $name, ['grid' => $grid]); } /** - * @param Twig_Environment $environment + * @param Environment $environment * @param unknown $grid * * @return string */ - public function getGridPager(Twig_Environment $environment, $grid) + public function getGridPager(Environment $environment, $grid) { return $this->renderBlock($environment, 'grid_pager', ['grid' => $grid, 'pagerfanta' => $this->pagerFantaDefs['enable']]); } @@ -229,14 +230,14 @@ public function getGridPager(Twig_Environment $environment, $grid) /** * Cell Drawing override. * - * @param Twig_Environment $environment - * @param \APY\DataGridBundle\Grid\Column\Column $column + * @param Environment $environment + * @param Column $column * @param \APY\DataGridBundle\Grid\Row $row - * @param \APY\DataGridBundle\Grid\Grid $grid + * @param Grid $grid * * @return string */ - public function getGridCell(Twig_Environment $environment, $column, $row, $grid) + public function getGridCell(Environment $environment, $column, $row, $grid) { $value = $column->renderCell($row->getField($column->getId()), $row, $this->router); @@ -264,13 +265,13 @@ public function getGridCell(Twig_Environment $environment, $column, $row, $grid) /** * Filter Drawing override. * - * @param Twig_Environment $environment - * @param \APY\DataGridBundle\Grid\Column\Column $column - * @param \APY\DataGridBundle\Grid\Grid $grid + * @param Environment $environment + * @param Column $column + * @param Grid $grid * * @return string */ - public function getGridFilter(Twig_Environment $environment, $column, $grid, $submitOnChange = true) + public function getGridFilter(Environment $environment, $column, $grid, $submitOnChange = true) { $id = $this->names[$grid->getHash()]; @@ -294,21 +295,21 @@ public function getGridFilter(Twig_Environment $environment, $column, $grid, $su /** * Column Operator Drawing override. * - * @param Twig_Environment $environment - * @param \APY\DataGridBundle\Grid\Column\Column $column - * @param \APY\DataGridBundle\Grid\Grid $grid + * @param Environment $environment + * @param Column $column + * @param Grid $grid * * @return string */ - public function getGridColumnOperator(Twig_Environment $environment, $column, $grid, $operator, $submitOnChange = true) + public function getGridColumnOperator(Environment $environment, $column, $grid, $operator, $submitOnChange = true) { return $this->renderBlock($environment, 'grid_column_operator', ['grid' => $grid, 'column' => $column, 'submitOnChange' => $submitOnChange, 'op' => $operator]); } /** - * @param string $section - * @param \APY\DataGridBundle\Grid\Grid $grid - * @param \APY\DataGridBundle\Grid\Column\Column $param + * @param string $section + * @param Grid $grid + * @param Column $param * * @return string */ @@ -335,7 +336,7 @@ public function getGridUrl($section, $grid, $param = null) } /** - * @param Twig_Environment $environment + * @param Environment $environment * @param unknown $grid * @param unknown $theme * @param string $id @@ -343,7 +344,7 @@ public function getGridUrl($section, $grid, $param = null) * * @return string */ - public function getGridSearch(\Twig_Environment $environment, $grid, $theme = null, $id = '', array $params = []) + public function getGridSearch(Environment $environment, $grid, $theme = null, $id = '', array $params = []) { $this->initGrid($grid, $theme, $id, $params); @@ -375,7 +376,7 @@ public function getPagerfanta($grid) /** * Render block. * - * @param Twig_Environment $environment + * @param Environment $environment * @param string $name * @param array $parameters * @@ -383,7 +384,7 @@ public function getPagerfanta($grid) * * @return string */ - protected function renderBlock(Twig_Environment $environment, $name, $parameters) + protected function renderBlock(Environment $environment, $name, $parameters) { foreach ($this->getTemplates($environment) as $template) { if ($template->hasBlock($name, [])) { @@ -397,12 +398,12 @@ protected function renderBlock(Twig_Environment $environment, $name, $parameters /** * Has block. * - * @param Twig_Environment $environment + * @param Environment $environment * @param $name string * * @return bool */ - protected function hasBlock(Twig_Environment $environment, $name) + protected function hasBlock(Environment $environment, $name) { foreach ($this->getTemplates($environment) as $template) { /** @var $template Twig_Template */ @@ -417,18 +418,18 @@ protected function hasBlock(Twig_Environment $environment, $name) /** * Template Loader. * - * @param Twig_Environment $environment + * @param Environment $environment * * @throws \Exception * - * @return Twig_Template[] + * @return TemplateWrapper[] */ - protected function getTemplates(Twig_Environment $environment) + protected function getTemplates(Environment $environment) { if (empty($this->templates)) { - if ($this->theme instanceof Twig_Template) { + if ($this->theme instanceof TemplateWrapper) { $this->templates[] = $this->theme; - $this->templates[] = $environment->loadTemplate($this->defaultTemplate); + $this->templates[] = $environment->load($this->defaultTemplate); } elseif (is_string($this->theme)) { $this->templates = $this->getTemplatesFromString($environment, $this->theme); } elseif ($this->theme === null) { @@ -442,20 +443,17 @@ protected function getTemplates(Twig_Environment $environment) } /** - * @param Twig_Environment $environment - * @param unknown $theme + * @param Environment $environment + * @param string $theme * - * @return array|Twig_Template[] + * @return array */ - protected function getTemplatesFromString(Twig_Environment $environment, $theme) + protected function getTemplatesFromString(Environment $environment, $theme) { $this->templates = []; - $template = $environment->loadTemplate($theme); - while ($template instanceof \Twig_Template) { - $this->templates[] = $template; - $template = $template->getParent([]); - } + $template = $environment->load($theme); + $this->templates[] = $template; return $this->templates; } diff --git a/composer.json b/composer.json index d0038c62..8cf3b915 100644 --- a/composer.json +++ b/composer.json @@ -17,30 +17,34 @@ { "name": "Evan Owens", "email": "eaowens@gmail.com" + }, + { + "name": "Nicolas Potier", + "email": "contact@acseo.fr" } ], "require": { - "php": ">=5.6", - "symfony/form": "~2.8|~3.0|^4.0", - "symfony/dependency-injection": "~2.8|~3.0|^4.0", - "symfony/config": "~2.8|~3.0|^4.0", - "symfony/http-foundation": "~2.8|~3.0|^4.0", - "symfony/http-kernel": "~2.8|~3.0|^4.0", - "symfony/options-resolver": "~2.8|~3.0|^4.0", - "symfony/security": "~2.8|~3.0|^4.0", - "symfony/serializer": "~2.8|~3.0|^4.0", - "twig/twig": ">=1.5.0" + "php": ">=7.2", + "symfony/form": "~3.0|^4.0|^5.0", + "symfony/dependency-injection": "~3.0|^4.0|^5.0", + "symfony/config": "~3.0|^4.0|^5.0", + "symfony/http-foundation": "~3.0|^4.0|^5.0", + "symfony/http-kernel": "~3.0|^4.0|^5.0", + "symfony/options-resolver": "~3.0|^4.0|^5.0", + "symfony/security-guard": "~3.0|^4.0|^5.0", + "symfony/serializer": "~3.0|^4.0|^5.0", + "twig/twig": "^2.10" }, "require-dev": { - "symfony/framework-bundle": "~2.8|~3.0|^4.0", - "symfony/browser-kit": "~2.8|~3.0|^4.0", - "symfony/templating": "~2.8|~3.0|^4.0", - "symfony/expression-language": "~2.8|~3.0|^4.0", + "symfony/framework-bundle": "~3.0|^4.0|^5.0", + "symfony/browser-kit": "~3.0|^4.0|^5.0", + "symfony/templating": "~3.0|^4.0|^5.0", + "symfony/expression-language": "~3.0|^4.0|^5.0", "phpunit/phpunit": "~5.7", "friendsofphp/php-cs-fixer": "^2.0", - "satooshi/php-coveralls": "^1.0", + "php-coveralls/php-coveralls": "^2.0", "doctrine/orm": "~2.4,>=2.4.5", - "doctrine/mongodb-odm": "^1.1.5" + "doctrine/mongodb-odm": "^2.0" }, "suggest": { "ext-intl": "Translate the grid",