From 26d152efdd436516297eee874baa33bf7fdafc59 Mon Sep 17 00:00:00 2001 From: ADmad Date: Thu, 18 Jul 2019 18:21:53 +0530 Subject: [PATCH 01/91] Update for Cake 4. --- .gitignore | 1 + composer.json | 16 +++++++++------- phpunit.xml.dist | 1 - src/Listener/Traits/FormTypeTrait.php | 2 +- src/Listener/Traits/IndexTypeTrait.php | 2 +- src/Listener/Traits/SidebarNavigationTrait.php | 2 +- src/Listener/Traits/SiteTitleTrait.php | 2 +- src/Listener/Traits/UtilityNavigationTrait.php | 2 +- src/Plugin.php | 8 ++++++++ src/View/CrudView.php | 8 ++++---- src/View/Helper/CrudViewHelper.php | 4 ++-- src/View/Widget/DateTimeWidget.php | 4 ++-- .../TestCase/View/Helper/CrudViewHelperTest.php | 2 +- .../TestCase/View/Widget/DateTimeWidgetTest.php | 2 +- tests/bootstrap.php | 2 +- 15 files changed, 34 insertions(+), 24 deletions(-) create mode 100644 src/Plugin.php diff --git a/.gitignore b/.gitignore index 2e8ba9c3..5209c916 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ phpunit.xml vendor/ composer.lock tmp +.phpunit.result.cache diff --git a/composer.json b/composer.json index df3096e4..97a1a6f3 100644 --- a/composer.json +++ b/composer.json @@ -29,14 +29,14 @@ } ], "require": { - "cakephp/cakephp": "^3.7", - "friendsofcake/crud": "^5.4", - "friendsofcake/bootstrap-ui": "^1.4" + "cakephp/cakephp": "4.x-dev", + "friendsofcake/crud": "dev-cake-4.x", + "friendsofcake/bootstrap-ui": "dev-cake-4-bs-4" }, "require-dev": { - "friendsofcake/cakephp-test-utilities": "^1.0", - "markstory/asset_compress": "^3.2", - "phpunit/phpunit": "^5.7.14|^6.0" + "friendsofcake/cakephp-test-utilities": "dev-cake-4.x", + "markstory/asset_compress": "4.x-dev", + "phpunit/phpunit": "^8.0" }, "autoload": { "psr-4": { @@ -53,5 +53,7 @@ "issues": "https://github.com/FriendsOfCake/crud-view/issues", "wiki": "http://cakephp.nu/cakephp-crud/", "irc": "irc://irc.freenode.org/friendsofcake" - } + }, + "minimum-stability": "dev", + "prefer-stable": true } diff --git a/phpunit.xml.dist b/phpunit.xml.dist index 445791ae..279d1795 100644 --- a/phpunit.xml.dist +++ b/phpunit.xml.dist @@ -3,7 +3,6 @@ colors="true" processIsolation="false" stopOnFailure="false" - syntaxCheck="false" bootstrap="./tests/bootstrap.php" > diff --git a/src/Listener/Traits/FormTypeTrait.php b/src/Listener/Traits/FormTypeTrait.php index f966a13f..a7e40d1c 100644 --- a/src/Listener/Traits/FormTypeTrait.php +++ b/src/Listener/Traits/FormTypeTrait.php @@ -165,5 +165,5 @@ abstract protected function _controller(); /** * {@inheritDoc} */ - abstract protected function _action($name = null); + abstract protected function _action(?string $name = null); } diff --git a/src/Listener/Traits/IndexTypeTrait.php b/src/Listener/Traits/IndexTypeTrait.php index 599ef77d..bb69aaf0 100644 --- a/src/Listener/Traits/IndexTypeTrait.php +++ b/src/Listener/Traits/IndexTypeTrait.php @@ -145,7 +145,7 @@ abstract protected function _controller(); /** * {@inheritDoc} */ - abstract protected function _action($name = null); + abstract protected function _action(?string $name = null); /** * {@inheritDoc} diff --git a/src/Listener/Traits/SidebarNavigationTrait.php b/src/Listener/Traits/SidebarNavigationTrait.php index d4fea72c..24abecc1 100644 --- a/src/Listener/Traits/SidebarNavigationTrait.php +++ b/src/Listener/Traits/SidebarNavigationTrait.php @@ -36,5 +36,5 @@ abstract protected function _controller(); /** * {@inheritDoc} */ - abstract protected function _action($name = null); + abstract protected function _action(?string $name = null); } diff --git a/src/Listener/Traits/SiteTitleTrait.php b/src/Listener/Traits/SiteTitleTrait.php index b1c71187..c55b75e3 100644 --- a/src/Listener/Traits/SiteTitleTrait.php +++ b/src/Listener/Traits/SiteTitleTrait.php @@ -78,5 +78,5 @@ abstract protected function _controller(); /** * {@inheritDoc} */ - abstract protected function _action($name = null); + abstract protected function _action(?string $name = null); } diff --git a/src/Listener/Traits/UtilityNavigationTrait.php b/src/Listener/Traits/UtilityNavigationTrait.php index 147003c0..e4c44ae7 100644 --- a/src/Listener/Traits/UtilityNavigationTrait.php +++ b/src/Listener/Traits/UtilityNavigationTrait.php @@ -44,5 +44,5 @@ abstract protected function _controller(); /** * {@inheritDoc} */ - abstract protected function _action($name = null); + abstract protected function _action(?string $name = null); } diff --git a/src/Plugin.php b/src/Plugin.php new file mode 100644 index 00000000..525b58b9 --- /dev/null +++ b/src/Plugin.php @@ -0,0 +1,8 @@ + 'beforeLayout', @@ -158,7 +158,7 @@ protected function _setupPaths() * @return string default The block content or $default if the block does not exist. * @see ViewBlock::get() */ - public function fetch($name, $default = '') + public function fetch(string $name, string $default = ''): string { $viewblock = ''; $viewblocks = $this->get('viewblocks', []); @@ -178,7 +178,7 @@ public function fetch($name, $default = '') * * @return bool */ - public function exists($name) + public function exists(string $name): bool { $viewblocks = $this->get('viewblocks', []); diff --git a/src/View/Helper/CrudViewHelper.php b/src/View/Helper/CrudViewHelper.php index 4014b8a4..bf0d9e2e 100644 --- a/src/View/Helper/CrudViewHelper.php +++ b/src/View/Helper/CrudViewHelper.php @@ -420,9 +420,9 @@ public function associations() * @param string $key View variable to get. * @return mixed */ - public function getViewVar($key = null) + public function getViewVar($key) { - return Hash::get($this->_View->viewVars, $key); + return $this->_View->get($key); } /** diff --git a/src/View/Widget/DateTimeWidget.php b/src/View/Widget/DateTimeWidget.php index 7602e038..5bde16b8 100644 --- a/src/View/Widget/DateTimeWidget.php +++ b/src/View/Widget/DateTimeWidget.php @@ -19,7 +19,7 @@ class DateTimeWidget extends \Cake\View\Widget\DateTimeWidget * @return string A generated select box. * @throws \RuntimeException When option data is invalid. */ - public function render(array $data, ContextInterface $context) + public function render(array $data, ContextInterface $context): string { $id = $data['id']; $name = $data['name']; @@ -161,7 +161,7 @@ protected function _convertPHPToMomentFormat($format) /** * {@inheritDoc} */ - public function secureFields(array $data) + public function secureFields(array $data): array { if (!isset($data['name']) || $data['name'] === '') { return []; diff --git a/tests/TestCase/View/Helper/CrudViewHelperTest.php b/tests/TestCase/View/Helper/CrudViewHelperTest.php index e22a9b93..81f883d6 100644 --- a/tests/TestCase/View/Helper/CrudViewHelperTest.php +++ b/tests/TestCase/View/Helper/CrudViewHelperTest.php @@ -30,7 +30,7 @@ class CrudViewHelperTest extends TestCase * * @return void */ - public function setUp() + public function setUp(): void { parent::setUp(); diff --git a/tests/TestCase/View/Widget/DateTimeWidgetTest.php b/tests/TestCase/View/Widget/DateTimeWidgetTest.php index 2f73da4d..5ae51c96 100644 --- a/tests/TestCase/View/Widget/DateTimeWidgetTest.php +++ b/tests/TestCase/View/Widget/DateTimeWidgetTest.php @@ -16,7 +16,7 @@ class DateTimeWidgetTest extends TestCase { use CompareTrait; - public function setUp() + public function setUp(): void { parent::setUp(); $this->initComparePath(); diff --git a/tests/bootstrap.php b/tests/bootstrap.php index 4f4d373d..864192e8 100644 --- a/tests/bootstrap.php +++ b/tests/bootstrap.php @@ -23,4 +23,4 @@ chdir($root); require $root . '/vendor/cakephp/cakephp/tests/bootstrap.php'; -Plugin::load('CrudView', ['path' => dirname(dirname(__FILE__)) . DS]); +Plugin::getCollection()->add(new \CrudView\Plugin()); From e61f6e8d12c0aef95b9e39ac4890686e1a97e125 Mon Sep 17 00:00:00 2001 From: ADmad Date: Thu, 18 Jul 2019 18:22:31 +0530 Subject: [PATCH 02/91] Update travis config --- .travis.yml | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/.travis.yml b/.travis.yml index a5a51405..f64431f7 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,10 +1,8 @@ language: php php: - - 5.6 - - 7.0 - - 7.1 - 7.2 + - 7.3 env: global: @@ -15,17 +13,17 @@ matrix: fast_finish: true include: - - php: 7.0 + - php: 7.2 env: PHPCS=1 DEFAULT=0 - - php: 7.0 + - php: 7.2 env: PHPSTAN=1 DEFAULT=0 - + - php: 7.2 env: DEFAULT=1 LOWEST=1 before_script: - - if [[ $TRAVIS_PHP_VERSION != 7.0 ]]; then phpenv config-rm xdebug.ini; fi + - if [[ $TRAVIS_PHP_VERSION != 7.2 ]]; then phpenv config-rm xdebug.ini; fi - if [[ $LOWEST = 0 ]]; then composer install --prefer-dist --no-interaction; fi - if [[ $LOWEST = 1 ]]; then composer update --prefer-lowest --prefer-dist --no-interaction; fi @@ -34,14 +32,14 @@ before_script: - if [[ $PHPSTAN = 1 ]]; then composer require phpstan/phpstan:^0.9; fi script: - - if [[ $DEFAULT = 1 && $TRAVIS_PHP_VERSION != 7.0 ]]; then vendor/bin/phpunit; fi - - if [[ $DEFAULT = 1 && $TRAVIS_PHP_VERSION = 7.0 ]]; then vendor/bin/phpunit --coverage-clover=clover.xml; fi + - if [[ $DEFAULT = 1 && $TRAVIS_PHP_VERSION != 7.2 ]]; then vendor/bin/phpunit; fi + - if [[ $DEFAULT = 1 && $TRAVIS_PHP_VERSION = 7.2 ]]; then vendor/bin/phpunit --coverage-clover=clover.xml; fi - if [[ $PHPCS = 1 ]]; then vendor/bin/phpcs -p --extensions=php --standard=vendor/cakephp/cakephp-codesniffer/CakePHP src/ config/; fi - if [[ $PHPSTAN = 1 ]]; then vendor/bin/phpstan analyse -c phpstan.neon -l 5 src; fi after_success: - - if [[ $DEFAULT = 1 && $TRAVIS_PHP_VERSION = 7.0 ]]; then bash <(curl -s https://codecov.io/bash); fi + - if [[ $DEFAULT = 1 && $TRAVIS_PHP_VERSION = 7.2 ]]; then bash <(curl -s https://codecov.io/bash); fi notifications: email: false From 237dc1463b34408a327c3c89707f527bc7de0576 Mon Sep 17 00:00:00 2001 From: ADmad Date: Thu, 18 Jul 2019 18:35:34 +0530 Subject: [PATCH 03/91] Fix CS errors. --- src/Action/DashboardAction.php | 4 ++- src/Breadcrumb/ActiveBreadcrumb.php | 4 +-- src/Breadcrumb/Breadcrumb.php | 2 ++ src/Dashboard/Dashboard.php | 4 ++- src/Dashboard/Module/ActionLinkItem.php | 4 +-- src/Dashboard/Module/LinkItem.php | 4 ++- .../DeprecatedConfigurationKeyTrait.php | 3 +- src/Listener/Traits/FormTypeTrait.php | 3 ++ src/Listener/Traits/IndexTypeTrait.php | 2 ++ .../Traits/SidebarNavigationTrait.php | 4 ++- src/Listener/Traits/SiteTitleTrait.php | 2 ++ .../Traits/UtilityNavigationTrait.php | 2 ++ src/Listener/ViewListener.php | 36 ++++++++++++------- src/Listener/ViewSearchListener.php | 12 +++---- src/Menu/MenuDivider.php | 2 ++ src/Menu/MenuDropdown.php | 2 ++ src/Menu/MenuItem.php | 2 ++ src/Plugin.php | 2 ++ src/Traits/CrudViewConfigTrait.php | 2 ++ src/View/Cell/DashboardTableCell.php | 2 ++ src/View/Cell/TablesListCell.php | 5 +-- src/View/CrudView.php | 5 +-- src/View/Helper/CrudViewHelper.php | 18 +++++----- src/View/Widget/DateTimeWidget.php | 9 ++--- tests/TestCase/Dashboard/DashboardTest.php | 8 +++-- .../Dashboard/Module/ActionLinkItemTest.php | 2 ++ .../Dashboard/Module/LinkItemTest.php | 2 ++ tests/TestCase/View/CrudViewTest.php | 12 ++++--- .../View/Helper/CrudViewHelperTest.php | 2 ++ .../View/Widget/DateTimeWidgetTest.php | 10 +++--- tests/bootstrap.php | 2 ++ 31 files changed, 116 insertions(+), 57 deletions(-) diff --git a/src/Action/DashboardAction.php b/src/Action/DashboardAction.php index e9f6e534..fd8b12b1 100644 --- a/src/Action/DashboardAction.php +++ b/src/Action/DashboardAction.php @@ -1,9 +1,11 @@ _controller(); $sidebarNavigation = $this->_getSidebarNavigation(); - $controller->set('disableSidebar', ($sidebarNavigation === false) ? true : false); + $controller->set('disableSidebar', $sidebarNavigation === false ? true : false); $controller->set('sidebarNavigation', $sidebarNavigation); } diff --git a/src/Listener/Traits/SiteTitleTrait.php b/src/Listener/Traits/SiteTitleTrait.php index c55b75e3..bc422ba9 100644 --- a/src/Listener/Traits/SiteTitleTrait.php +++ b/src/Listener/Traits/SiteTitleTrait.php @@ -1,4 +1,6 @@ $controller->modelClass, - 'singularHumanName' => Inflector::humanize(Inflector::underscore(Inflector::singularize($controller->modelClass))), + 'singularHumanName' => Inflector::humanize( + Inflector::underscore(Inflector::singularize($controller->modelClass)) + ), 'pluralHumanName' => Inflector::humanize(Inflector::underscore($controller->getName())), 'singularVar' => Inflector::singularize($controller->getName()), 'pluralVar' => Inflector::variable($controller->getName()), @@ -281,7 +284,7 @@ protected function _getPageVariables() if ($scope === 'entity') { $data += [ - 'primaryKeyValue' => $this->_primaryKeyValue() + 'primaryKeyValue' => $this->_primaryKeyValue(), ]; } @@ -310,7 +313,7 @@ protected function _scaffoldFields(array $associations = []) if ($scope === 'entity' && !empty($associations['manyToMany'])) { foreach ($associations['manyToMany'] as $alias => $options) { $cols[sprintf('%s._ids', $options['entities'])] = [ - 'multiple' => true + 'multiple' => true, ]; } } @@ -379,7 +382,7 @@ protected function _getControllerActions() $actions = $this->_getAllowedActions(); foreach ($actions as $actionName => $config) { - list($scope, $actionConfig) = $this->_getControllerActionConfiguration($actionName, $config); + [$scope, $actionConfig] = $this->_getControllerActionConfiguration($actionName, $config); ${$scope}[$actionName] = $actionConfig; } @@ -394,7 +397,7 @@ protected function _getControllerActions() if ($config === null) { $config = []; } - list($scope, $actionConfig) = $this->_getControllerActionConfiguration($actionName, $config); + [$scope, $actionConfig] = $this->_getControllerActionConfiguration($actionName, $config); $realAction = Hash::get($actionConfig, 'url.action', $actionName); if (!isset(${$scope}[$realAction])) { continue; @@ -440,10 +443,12 @@ protected function _getControllerActionConfiguration($actionName, $config) } // apply defaults if necessary - $scope = isset($config['scope']) ? $config['scope'] : 'entity'; - $method = isset($config['method']) ? $config['method'] : 'GET'; + $scope = $config['scope'] ?? 'entity'; + $method = $config['method'] ?? 'GET'; - $title = !empty($config['link_title']) ? $config['link_title'] : Inflector::humanize(Inflector::underscore($actionName)); + $title = !empty($config['link_title']) + ? $config['link_title'] + : Inflector::humanize(Inflector::underscore($actionName)); $url = ['action' => $realAction]; if (isset($config['url'])) { $url = $config['url'] + $url; @@ -456,7 +461,7 @@ protected function _getControllerActionConfiguration($actionName, $config) 'options' => array_diff_key( $config, array_flip(['method', 'scope', 'link_title', 'url', 'scaffold', 'callback']) - ) + ), ]; if (!empty($config['callback'])) { $actionConfig['callback'] = $config['callback']; @@ -556,10 +561,15 @@ protected function _associations(array $whitelist = []) $associationConfiguration[$type][$assocKey]['propertyName'] = $association->getProperty(); $associationConfiguration[$type][$assocKey]['plugin'] = pluginSplit($association->getClassName())[0]; $associationConfiguration[$type][$assocKey]['controller'] = $assocKey; - $associationConfiguration[$type][$assocKey]['entity'] = Inflector::singularize(Inflector::underscore($assocKey)); + $associationConfiguration[$type][$assocKey]['entity'] = Inflector::singularize( + Inflector::underscore($assocKey) + ); $associationConfiguration[$type][$assocKey]['entities'] = Inflector::underscore($assocKey); - $associationConfiguration[$type][$assocKey] = array_merge($associationConfiguration[$type][$assocKey], $this->_action()->getConfig('association.' . $assocKey) ?: []); + $associationConfiguration[$type][$assocKey] = array_merge( + $associationConfiguration[$type][$assocKey], + $this->_action()->getConfig('association.' . $assocKey) ?: [] + ); } return $associationConfiguration; diff --git a/src/Listener/ViewSearchListener.php b/src/Listener/ViewSearchListener.php index 0b01ffd4..19560bf1 100644 --- a/src/Listener/ViewSearchListener.php +++ b/src/Listener/ViewSearchListener.php @@ -1,14 +1,14 @@ true, 'selectize' => true, 'collection' => 'default', - 'fields' => null + 'fields' => null, ]; /** @@ -40,7 +40,7 @@ class ViewSearchListener extends BaseListener public function implementedEvents() { return [ - 'Crud.afterPaginate' => ['callable' => 'afterPaginate'] + 'Crud.afterPaginate' => ['callable' => 'afterPaginate'], ]; } @@ -107,7 +107,7 @@ protected function _deriveFields() $field = $filter->name(); $input = [ 'required' => false, - 'type' => 'text' + 'type' => 'text', ]; if (substr($field, -3) === '_id' && $field !== '_id') { @@ -143,7 +143,7 @@ protected function _deriveFields() $urlArgs = []; - $fieldKeys = isset($input['fields']) ? $input['fields'] : ['id' => $field, 'value' => $field]; + $fieldKeys = $input['fields'] ?? ['id' => $field, 'value' => $field]; if (is_array($fieldKeys)) { foreach ($fieldKeys as $key => $val) { $urlArgs[$key] = $val; diff --git a/src/Menu/MenuDivider.php b/src/Menu/MenuDivider.php index d776cc6b..9903aa8f 100644 --- a/src/Menu/MenuDivider.php +++ b/src/Menu/MenuDivider.php @@ -1,4 +1,6 @@ 'index', 'title' => Inflector::humanize($table), - 'controller' => Inflector::camelize($table) + 'controller' => Inflector::camelize($table), ]; $normal[$table] = $config; diff --git a/src/View/CrudView.php b/src/View/CrudView.php index 280ac13c..428f4eca 100644 --- a/src/View/CrudView.php +++ b/src/View/CrudView.php @@ -1,9 +1,10 @@ [ 'className' => 'BootstrapUI.Form', 'widgets' => [ - 'datetime' => ['CrudView\View\Widget\DateTimeWidget', 'select'] + 'datetime' => ['CrudView\View\Widget\DateTimeWidget', 'select'], ], ], 'Flash' => ['className' => 'BootstrapUI.Flash'], diff --git a/src/View/Helper/CrudViewHelper.php b/src/View/Helper/CrudViewHelper.php index bf0d9e2e..2f5e70c4 100644 --- a/src/View/Helper/CrudViewHelper.php +++ b/src/View/Helper/CrudViewHelper.php @@ -1,8 +1,9 @@ null + 'fieldFormatters' => null, ]; /** @@ -224,7 +224,7 @@ public function formatTime($field, $value, array $options) if ($value === null) { return $this->Html->label(__d('crud', 'N/A'), ['type' => 'info']); } - $format = isset($options['format']) ? $options['format'] : null; + $format = $options['format'] ?? null; if (is_int($value) || is_string($value) || $value instanceof DateTime || $value instanceof DateTimeImmutable) { return $this->Time->nice($value, $format); @@ -293,8 +293,8 @@ public function relation($field) 'plugin' => $details['plugin'], 'controller' => $details['controller'], 'action' => 'view', - $entity->{$details['primaryKey']} - ]) + $entity->{$details['primaryKey']}, + ]), ]; } @@ -329,7 +329,7 @@ public function redirectUrl() 'name' => '_redirect_url', 'value' => $redirectUrl, 'id' => null, - 'secure' => FormHelper::SECURE_SKIP + 'secure' => FormHelper::SECURE_SKIP, ]); } @@ -351,8 +351,8 @@ public function createRelationLink($alias, $relation, $options = []) 'action' => 'add', '?' => [ $relation['foreignKey'] => $this->getViewVar('primaryKeyValue'), - '_redirect_url' => $this->getView()->getRequest()->getUri()->getPath() - ] + '_redirect_url' => $this->getView()->getRequest()->getUri()->getPath(), + ], ], $options ); diff --git a/src/View/Widget/DateTimeWidget.php b/src/View/Widget/DateTimeWidget.php index 5bde16b8..26012270 100644 --- a/src/View/Widget/DateTimeWidget.php +++ b/src/View/Widget/DateTimeWidget.php @@ -1,4 +1,6 @@ format('U'); $dateTimeZone = new DateTimeZone(date_default_timezone_get()); - $timezoneOffset = ($dateTimeZone->getOffset($val) / 60); + $timezoneOffset = $dateTimeZone->getOffset($val) / 60; } $val = $val->format($type === 'date' ? 'Y-m-d' : 'Y-m-d H:i:s'); } diff --git a/tests/TestCase/Dashboard/DashboardTest.php b/tests/TestCase/Dashboard/DashboardTest.php index 3e53eba0..854883ab 100644 --- a/tests/TestCase/Dashboard/DashboardTest.php +++ b/tests/TestCase/Dashboard/DashboardTest.php @@ -1,4 +1,6 @@ assertEquals($expected, $dashboard->get('title')); @@ -38,11 +40,11 @@ public function testInvalidConstruct() public function testColumnChildren() { - $dashboard = new Dashboard; + $dashboard = new Dashboard(); $expected = []; $this->assertEquals($expected, $dashboard->getColumnChildren(1)); - $cell = new DashboardTableCell; + $cell = new DashboardTableCell(); $return = $dashboard->addToColumn($cell); $this->assertEquals($dashboard, $return); $this->assertEquals([$cell], $dashboard->getColumnChildren(1)); diff --git a/tests/TestCase/Dashboard/Module/ActionLinkItemTest.php b/tests/TestCase/Dashboard/Module/ActionLinkItemTest.php index 95140b6f..189718e5 100644 --- a/tests/TestCase/Dashboard/Module/ActionLinkItemTest.php +++ b/tests/TestCase/Dashboard/Module/ActionLinkItemTest.php @@ -1,4 +1,6 @@ [ 'CrudView' => [ 'className' => 'CrudView.CrudView', - 'fieldFormatters' => ['datetime' => 'formatTime'] - ] - ] + 'fieldFormatters' => ['datetime' => 'formatTime'], + ], + ], ] ); diff --git a/tests/TestCase/View/Helper/CrudViewHelperTest.php b/tests/TestCase/View/Helper/CrudViewHelperTest.php index 81f883d6..8cebf7ec 100644 --- a/tests/TestCase/View/Helper/CrudViewHelperTest.php +++ b/tests/TestCase/View/Helper/CrudViewHelperTest.php @@ -1,4 +1,6 @@ 'the-id', 'name' => 'the-name', 'val' => '', 'type' => 'x', 'required' => false] + ['id' => 'the-id', 'name' => 'the-name', 'val' => '', 'type' => 'x', 'required' => false], ], [ 'with-string-value.html', - ['id' => 'the-id', 'name' => 'the-name', 'val' => '2000-01-01', 'type' => 'x', 'required' => false] + ['id' => 'the-id', 'name' => 'the-name', 'val' => '2000-01-01', 'type' => 'x', 'required' => false], ], [ 'with-date-value.html', - ['id' => 'the-id', 'name' => 'the-name', 'val' => (new FrozenTime(strtotime('2000-01-01'))), 'type' => 'x', 'required' => false] - ] + ['id' => 'the-id', 'name' => 'the-name', 'val' => (new FrozenTime(strtotime('2000-01-01'))), 'type' => 'x', 'required' => false], + ], ]; } } diff --git a/tests/bootstrap.php b/tests/bootstrap.php index 864192e8..edfce42b 100644 --- a/tests/bootstrap.php +++ b/tests/bootstrap.php @@ -1,4 +1,6 @@ Date: Thu, 18 Jul 2019 18:45:46 +0530 Subject: [PATCH 04/91] Move/rename template files. --- .../display.ctp => templates/Cell/DashboardTable/display.php | 0 .../display.ctp => templates/Cell/TablesList/display.php | 0 .../action-button.ctp => templates/Element/action-button.php | 0 .../action-groups.ctp => templates/Element/action-groups.php | 0 .../action-header.ctp => templates/Element/action-header.php | 0 src/Template/Element/actions.ctp => templates/Element/actions.php | 0 .../Element/breadcrumbs.ctp => templates/Element/breadcrumbs.php | 0 src/Template/Element/form.ctp => templates/Element/form.php | 0 .../form/buttons.ctp => templates/Element/form/buttons.php | 0 .../Element/form/tabs.ctp => templates/Element/form/tabs.php | 0 .../Element/index/blog.ctp => templates/Element/index/blog.php | 0 .../Element/index/bulk_actions/form_end.php | 0 .../Element/index/bulk_actions/form_start.php | 0 .../record.ctp => templates/Element/index/bulk_actions/record.php | 0 .../table.ctp => templates/Element/index/bulk_actions/table.php | 0 .../Element/index/download_formats.php | 0 .../Element/index/finder_scopes.php | 0 .../index/gallery.ctp => templates/Element/index/gallery.php | 0 .../pagination.ctp => templates/Element/index/pagination.php | 0 .../Element/index/table.ctp => templates/Element/index/table.php | 0 .../Element/index/table_columns.php | 0 .../menu/divider.ctp => templates/Element/menu/divider.php | 0 .../menu/dropdown.ctp => templates/Element/menu/dropdown.php | 0 .../Element/menu/item.ctp => templates/Element/menu/item.php | 0 src/Template/Element/search.ctp => templates/Element/search.php | 0 src/Template/Element/sidebar.ctp => templates/Element/sidebar.php | 0 src/Template/Element/topbar.ctp => templates/Element/topbar.php | 0 .../view/related.ctp => templates/Element/view/related.php | 0 .../has_many.ctp => templates/Element/view/related/has_many.php | 0 .../has_one.ctp => templates/Element/view/related/has_one.php | 0 src/Template/Layout/default.ctp => templates/Layout/default.php | 0 src/Template/Scaffold/add.ctp => templates/Scaffold/add.php | 0 .../Scaffold/dashboard.ctp => templates/Scaffold/dashboard.php | 0 src/Template/Scaffold/edit.ctp => templates/Scaffold/edit.php | 0 src/Template/Scaffold/index.ctp => templates/Scaffold/index.php | 0 src/Template/Scaffold/view.ctp => templates/Scaffold/view.php | 0 36 files changed, 0 insertions(+), 0 deletions(-) rename src/Template/Cell/DashboardTable/display.ctp => templates/Cell/DashboardTable/display.php (100%) rename src/Template/Cell/TablesList/display.ctp => templates/Cell/TablesList/display.php (100%) rename src/Template/Element/action-button.ctp => templates/Element/action-button.php (100%) rename src/Template/Element/action-groups.ctp => templates/Element/action-groups.php (100%) rename src/Template/Element/action-header.ctp => templates/Element/action-header.php (100%) rename src/Template/Element/actions.ctp => templates/Element/actions.php (100%) rename src/Template/Element/breadcrumbs.ctp => templates/Element/breadcrumbs.php (100%) rename src/Template/Element/form.ctp => templates/Element/form.php (100%) rename src/Template/Element/form/buttons.ctp => templates/Element/form/buttons.php (100%) rename src/Template/Element/form/tabs.ctp => templates/Element/form/tabs.php (100%) rename src/Template/Element/index/blog.ctp => templates/Element/index/blog.php (100%) rename src/Template/Element/index/bulk_actions/form_end.ctp => templates/Element/index/bulk_actions/form_end.php (100%) rename src/Template/Element/index/bulk_actions/form_start.ctp => templates/Element/index/bulk_actions/form_start.php (100%) rename src/Template/Element/index/bulk_actions/record.ctp => templates/Element/index/bulk_actions/record.php (100%) rename src/Template/Element/index/bulk_actions/table.ctp => templates/Element/index/bulk_actions/table.php (100%) rename src/Template/Element/index/download_formats.ctp => templates/Element/index/download_formats.php (100%) rename src/Template/Element/index/finder_scopes.ctp => templates/Element/index/finder_scopes.php (100%) rename src/Template/Element/index/gallery.ctp => templates/Element/index/gallery.php (100%) rename src/Template/Element/index/pagination.ctp => templates/Element/index/pagination.php (100%) rename src/Template/Element/index/table.ctp => templates/Element/index/table.php (100%) rename src/Template/Element/index/table_columns.ctp => templates/Element/index/table_columns.php (100%) rename src/Template/Element/menu/divider.ctp => templates/Element/menu/divider.php (100%) rename src/Template/Element/menu/dropdown.ctp => templates/Element/menu/dropdown.php (100%) rename src/Template/Element/menu/item.ctp => templates/Element/menu/item.php (100%) rename src/Template/Element/search.ctp => templates/Element/search.php (100%) rename src/Template/Element/sidebar.ctp => templates/Element/sidebar.php (100%) rename src/Template/Element/topbar.ctp => templates/Element/topbar.php (100%) rename src/Template/Element/view/related.ctp => templates/Element/view/related.php (100%) rename src/Template/Element/view/related/has_many.ctp => templates/Element/view/related/has_many.php (100%) rename src/Template/Element/view/related/has_one.ctp => templates/Element/view/related/has_one.php (100%) rename src/Template/Layout/default.ctp => templates/Layout/default.php (100%) rename src/Template/Scaffold/add.ctp => templates/Scaffold/add.php (100%) rename src/Template/Scaffold/dashboard.ctp => templates/Scaffold/dashboard.php (100%) rename src/Template/Scaffold/edit.ctp => templates/Scaffold/edit.php (100%) rename src/Template/Scaffold/index.ctp => templates/Scaffold/index.php (100%) rename src/Template/Scaffold/view.ctp => templates/Scaffold/view.php (100%) diff --git a/src/Template/Cell/DashboardTable/display.ctp b/templates/Cell/DashboardTable/display.php similarity index 100% rename from src/Template/Cell/DashboardTable/display.ctp rename to templates/Cell/DashboardTable/display.php diff --git a/src/Template/Cell/TablesList/display.ctp b/templates/Cell/TablesList/display.php similarity index 100% rename from src/Template/Cell/TablesList/display.ctp rename to templates/Cell/TablesList/display.php diff --git a/src/Template/Element/action-button.ctp b/templates/Element/action-button.php similarity index 100% rename from src/Template/Element/action-button.ctp rename to templates/Element/action-button.php diff --git a/src/Template/Element/action-groups.ctp b/templates/Element/action-groups.php similarity index 100% rename from src/Template/Element/action-groups.ctp rename to templates/Element/action-groups.php diff --git a/src/Template/Element/action-header.ctp b/templates/Element/action-header.php similarity index 100% rename from src/Template/Element/action-header.ctp rename to templates/Element/action-header.php diff --git a/src/Template/Element/actions.ctp b/templates/Element/actions.php similarity index 100% rename from src/Template/Element/actions.ctp rename to templates/Element/actions.php diff --git a/src/Template/Element/breadcrumbs.ctp b/templates/Element/breadcrumbs.php similarity index 100% rename from src/Template/Element/breadcrumbs.ctp rename to templates/Element/breadcrumbs.php diff --git a/src/Template/Element/form.ctp b/templates/Element/form.php similarity index 100% rename from src/Template/Element/form.ctp rename to templates/Element/form.php diff --git a/src/Template/Element/form/buttons.ctp b/templates/Element/form/buttons.php similarity index 100% rename from src/Template/Element/form/buttons.ctp rename to templates/Element/form/buttons.php diff --git a/src/Template/Element/form/tabs.ctp b/templates/Element/form/tabs.php similarity index 100% rename from src/Template/Element/form/tabs.ctp rename to templates/Element/form/tabs.php diff --git a/src/Template/Element/index/blog.ctp b/templates/Element/index/blog.php similarity index 100% rename from src/Template/Element/index/blog.ctp rename to templates/Element/index/blog.php diff --git a/src/Template/Element/index/bulk_actions/form_end.ctp b/templates/Element/index/bulk_actions/form_end.php similarity index 100% rename from src/Template/Element/index/bulk_actions/form_end.ctp rename to templates/Element/index/bulk_actions/form_end.php diff --git a/src/Template/Element/index/bulk_actions/form_start.ctp b/templates/Element/index/bulk_actions/form_start.php similarity index 100% rename from src/Template/Element/index/bulk_actions/form_start.ctp rename to templates/Element/index/bulk_actions/form_start.php diff --git a/src/Template/Element/index/bulk_actions/record.ctp b/templates/Element/index/bulk_actions/record.php similarity index 100% rename from src/Template/Element/index/bulk_actions/record.ctp rename to templates/Element/index/bulk_actions/record.php diff --git a/src/Template/Element/index/bulk_actions/table.ctp b/templates/Element/index/bulk_actions/table.php similarity index 100% rename from src/Template/Element/index/bulk_actions/table.ctp rename to templates/Element/index/bulk_actions/table.php diff --git a/src/Template/Element/index/download_formats.ctp b/templates/Element/index/download_formats.php similarity index 100% rename from src/Template/Element/index/download_formats.ctp rename to templates/Element/index/download_formats.php diff --git a/src/Template/Element/index/finder_scopes.ctp b/templates/Element/index/finder_scopes.php similarity index 100% rename from src/Template/Element/index/finder_scopes.ctp rename to templates/Element/index/finder_scopes.php diff --git a/src/Template/Element/index/gallery.ctp b/templates/Element/index/gallery.php similarity index 100% rename from src/Template/Element/index/gallery.ctp rename to templates/Element/index/gallery.php diff --git a/src/Template/Element/index/pagination.ctp b/templates/Element/index/pagination.php similarity index 100% rename from src/Template/Element/index/pagination.ctp rename to templates/Element/index/pagination.php diff --git a/src/Template/Element/index/table.ctp b/templates/Element/index/table.php similarity index 100% rename from src/Template/Element/index/table.ctp rename to templates/Element/index/table.php diff --git a/src/Template/Element/index/table_columns.ctp b/templates/Element/index/table_columns.php similarity index 100% rename from src/Template/Element/index/table_columns.ctp rename to templates/Element/index/table_columns.php diff --git a/src/Template/Element/menu/divider.ctp b/templates/Element/menu/divider.php similarity index 100% rename from src/Template/Element/menu/divider.ctp rename to templates/Element/menu/divider.php diff --git a/src/Template/Element/menu/dropdown.ctp b/templates/Element/menu/dropdown.php similarity index 100% rename from src/Template/Element/menu/dropdown.ctp rename to templates/Element/menu/dropdown.php diff --git a/src/Template/Element/menu/item.ctp b/templates/Element/menu/item.php similarity index 100% rename from src/Template/Element/menu/item.ctp rename to templates/Element/menu/item.php diff --git a/src/Template/Element/search.ctp b/templates/Element/search.php similarity index 100% rename from src/Template/Element/search.ctp rename to templates/Element/search.php diff --git a/src/Template/Element/sidebar.ctp b/templates/Element/sidebar.php similarity index 100% rename from src/Template/Element/sidebar.ctp rename to templates/Element/sidebar.php diff --git a/src/Template/Element/topbar.ctp b/templates/Element/topbar.php similarity index 100% rename from src/Template/Element/topbar.ctp rename to templates/Element/topbar.php diff --git a/src/Template/Element/view/related.ctp b/templates/Element/view/related.php similarity index 100% rename from src/Template/Element/view/related.ctp rename to templates/Element/view/related.php diff --git a/src/Template/Element/view/related/has_many.ctp b/templates/Element/view/related/has_many.php similarity index 100% rename from src/Template/Element/view/related/has_many.ctp rename to templates/Element/view/related/has_many.php diff --git a/src/Template/Element/view/related/has_one.ctp b/templates/Element/view/related/has_one.php similarity index 100% rename from src/Template/Element/view/related/has_one.ctp rename to templates/Element/view/related/has_one.php diff --git a/src/Template/Layout/default.ctp b/templates/Layout/default.php similarity index 100% rename from src/Template/Layout/default.ctp rename to templates/Layout/default.php diff --git a/src/Template/Scaffold/add.ctp b/templates/Scaffold/add.php similarity index 100% rename from src/Template/Scaffold/add.ctp rename to templates/Scaffold/add.php diff --git a/src/Template/Scaffold/dashboard.ctp b/templates/Scaffold/dashboard.php similarity index 100% rename from src/Template/Scaffold/dashboard.ctp rename to templates/Scaffold/dashboard.php diff --git a/src/Template/Scaffold/edit.ctp b/templates/Scaffold/edit.php similarity index 100% rename from src/Template/Scaffold/edit.ctp rename to templates/Scaffold/edit.php diff --git a/src/Template/Scaffold/index.ctp b/templates/Scaffold/index.php similarity index 100% rename from src/Template/Scaffold/index.ctp rename to templates/Scaffold/index.php diff --git a/src/Template/Scaffold/view.ctp b/templates/Scaffold/view.php similarity index 100% rename from src/Template/Scaffold/view.ctp rename to templates/Scaffold/view.php From d8708cf32913f1ecac32d66a74f6f064e453659b Mon Sep 17 00:00:00 2001 From: ADmad Date: Thu, 18 Jul 2019 19:11:00 +0530 Subject: [PATCH 05/91] Fix model class usage. --- src/Listener/ViewListener.php | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/src/Listener/ViewListener.php b/src/Listener/ViewListener.php index 3b2892f4..5ede52f5 100644 --- a/src/Listener/ViewListener.php +++ b/src/Listener/ViewListener.php @@ -259,13 +259,14 @@ protected function _blacklist() protected function _getPageVariables() { $table = $this->_table(); + $modelClass = $table->getAlias(); $controller = $this->_controller(); $scope = $this->_action()->getConfig('scope'); $data = [ - 'modelClass' => $controller->modelClass, + 'modelClass' => $modelClass, 'singularHumanName' => Inflector::humanize( - Inflector::underscore(Inflector::singularize($controller->modelClass)) + Inflector::underscore(Inflector::singularize($modelClass)) ), 'pluralHumanName' => Inflector::humanize(Inflector::underscore($controller->getName())), 'singularVar' => Inflector::singularize($controller->getName()), @@ -619,6 +620,7 @@ protected function _displayFieldValue() protected function _deriveFieldFromContext($field) { $controller = $this->_controller(); + $modelClass = $table->getAlias(); $entity = $this->_entity(); $request = $this->_request(); $value = $entity->get($field); @@ -627,12 +629,12 @@ protected function _deriveFieldFromContext($field) return $value; } - $path = "{$controller->modelClass}.{$field}"; + $path = "{$modelClass}.{$field}"; if (!empty($request->getData())) { $value = Hash::get((array)$request->getData(), $path); } - $singularVar = Inflector::variable($controller->modelClass); + $singularVar = Inflector::variable($modelClass); if (!empty($controller->viewVars[$singularVar])) { $value = $entity->get($field); } From cb866ea2f6fa5eb39f9edcf5b425a9aa24538d0d Mon Sep 17 00:00:00 2001 From: ADmad Date: Fri, 19 Jul 2019 00:24:23 +0530 Subject: [PATCH 06/91] Fix typehint --- src/Listener/ViewSearchListener.php | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/Listener/ViewSearchListener.php b/src/Listener/ViewSearchListener.php index 19560bf1..b01deb48 100644 --- a/src/Listener/ViewSearchListener.php +++ b/src/Listener/ViewSearchListener.php @@ -37,7 +37,7 @@ class ViewSearchListener extends BaseListener * * @return array */ - public function implementedEvents() + public function implementedEvents(): array { return [ 'Crud.afterPaginate' => ['callable' => 'afterPaginate'], @@ -50,10 +50,10 @@ public function implementedEvents() * Only after a crud paginate call does this listener do anything. So listen * for that * - * @param \Cake\Event\Event $event Event. + * @param \Cake\Event\EventInterface $event Event. * @return void */ - public function afterPaginate(Event $event) + public function afterPaginate(EventInterface $event) { $event; if (!$this->_table()->behaviors()->has('Search')) { From 3ab3e16d33c25c893bb8f8c073918056344e240f Mon Sep 17 00:00:00 2001 From: ADmad Date: Fri, 19 Jul 2019 00:35:18 +0530 Subject: [PATCH 07/91] Fix variable/property usage. --- src/Listener/ViewListener.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Listener/ViewListener.php b/src/Listener/ViewListener.php index 5ede52f5..c6e87e1e 100644 --- a/src/Listener/ViewListener.php +++ b/src/Listener/ViewListener.php @@ -620,7 +620,7 @@ protected function _displayFieldValue() protected function _deriveFieldFromContext($field) { $controller = $this->_controller(); - $modelClass = $table->getAlias(); + $modelClass = $this->_table()->getAlias(); $entity = $this->_entity(); $request = $this->_request(); $value = $entity->get($field); @@ -635,7 +635,7 @@ protected function _deriveFieldFromContext($field) } $singularVar = Inflector::variable($modelClass); - if (!empty($controller->viewVars[$singularVar])) { + if ($controller->viewBuilder()->getVar($singularVar)) { $value = $entity->get($field); } From 76b65ae9a4fd03a2d19fe940868a6fed7de291b2 Mon Sep 17 00:00:00 2001 From: ADmad Date: Fri, 19 Jul 2019 01:11:44 +0530 Subject: [PATCH 08/91] Fix property visibility. --- src/View/CrudView.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/View/CrudView.php b/src/View/CrudView.php index 428f4eca..66d27fce 100644 --- a/src/View/CrudView.php +++ b/src/View/CrudView.php @@ -24,7 +24,7 @@ class CrudView extends View implements EventListenerInterface * * @var string */ - public $layout = 'CrudView.default'; + protected $layout = 'CrudView.default'; /** * Initialization hook method. From 3cc8470c9faed577a3b1710bf86d725571be490f Mon Sep 17 00:00:00 2001 From: ADmad Date: Fri, 19 Jul 2019 01:20:59 +0530 Subject: [PATCH 09/91] Fix templates path. --- src/View/CrudView.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/View/CrudView.php b/src/View/CrudView.php index 66d27fce..81fb91ba 100644 --- a/src/View/CrudView.php +++ b/src/View/CrudView.php @@ -145,7 +145,7 @@ protected function _setupPaths() if (!empty($extraPaths)) { $paths = array_merge($paths, (array)$extraPaths); } - $paths[] = Plugin::classPath('CrudView') . 'Template' . DS; + $paths[] = Plugin::templatePath('CrudView'); Configure::write('App.paths.templates', $paths); } From 67c07fc12fa94c90c8a11249cd1f6f5560e7e13a Mon Sep 17 00:00:00 2001 From: ADmad Date: Fri, 19 Jul 2019 01:50:36 +0530 Subject: [PATCH 10/91] Fix "use" statement. --- src/Listener/ViewSearchListener.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Listener/ViewSearchListener.php b/src/Listener/ViewSearchListener.php index b01deb48..8daef1b0 100644 --- a/src/Listener/ViewSearchListener.php +++ b/src/Listener/ViewSearchListener.php @@ -3,7 +3,7 @@ namespace CrudView\Listener; -use Cake\Event\Event; +use Cake\Event\EventInterface; use Cake\Routing\Router; use Crud\Listener\BaseListener; From 77a43d268e1413216ee63801698058cbc64d1cb0 Mon Sep 17 00:00:00 2001 From: ADmad Date: Fri, 19 Jul 2019 02:25:40 +0530 Subject: [PATCH 11/91] Update method for template file name. --- src/View/CrudView.php | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/src/View/CrudView.php b/src/View/CrudView.php index 81fb91ba..fe749e64 100644 --- a/src/View/CrudView.php +++ b/src/View/CrudView.php @@ -211,28 +211,29 @@ protected function _createViewblock($data) return $output; } + /** - * Returns filename of given action's template file (.ctp) as a string. + * Returns filename of given action's template file as a string. * * @param string|null $name Controller action to find template filename for. * @return string Template filename * @throws \Cake\View\Exception\MissingTemplateException When a view file could not be found. */ - protected function _getViewFileName($name = null) + protected function _getTemplateFileName(?string $name = null): string { if ($this->templatePath === 'Error') { - return parent::_getViewFileName($name); + return parent::_getTemplateFileName($name); } try { - return parent::_getViewFileName($name); + return parent::_getTemplateFileName($name); } catch (MissingTemplateException $exception) { - $this->subDir = null; + $this->subDir = ''; $this->templatePath = 'Scaffold'; } try { - return parent::_getViewFileName($this->template); + return parent::_getTemplateFileName($this->template); } catch (MissingTemplateException $exception) { - return parent::_getViewFileName($name); + return parent::_getTemplateFileName($name); } } } From 3f090562aca821181c8cd73a46f8c8eef2dd592d Mon Sep 17 00:00:00 2001 From: ADmad Date: Fri, 19 Jul 2019 02:27:07 +0530 Subject: [PATCH 12/91] Fix template folder casing. --- templates/{Cell => cell}/DashboardTable/display.php | 0 templates/{Cell => cell}/TablesList/display.php | 0 templates/{Element => element}/action-button.php | 0 templates/{Element => element}/action-groups.php | 0 templates/{Element => element}/action-header.php | 0 templates/{Element => element}/actions.php | 0 templates/{Element => element}/breadcrumbs.php | 0 templates/{Element => element}/form.php | 0 templates/{Element => element}/form/buttons.php | 0 templates/{Element => element}/form/tabs.php | 0 templates/{Element => element}/index/blog.php | 0 templates/{Element => element}/index/bulk_actions/form_end.php | 0 templates/{Element => element}/index/bulk_actions/form_start.php | 0 templates/{Element => element}/index/bulk_actions/record.php | 0 templates/{Element => element}/index/bulk_actions/table.php | 0 templates/{Element => element}/index/download_formats.php | 0 templates/{Element => element}/index/finder_scopes.php | 0 templates/{Element => element}/index/gallery.php | 0 templates/{Element => element}/index/pagination.php | 0 templates/{Element => element}/index/table.php | 0 templates/{Element => element}/index/table_columns.php | 0 templates/{Element => element}/menu/divider.php | 0 templates/{Element => element}/menu/dropdown.php | 0 templates/{Element => element}/menu/item.php | 0 templates/{Element => element}/search.php | 0 templates/{Element => element}/sidebar.php | 0 templates/{Element => element}/topbar.php | 0 templates/{Element => element}/view/related.php | 0 templates/{Element => element}/view/related/has_many.php | 0 templates/{Element => element}/view/related/has_one.php | 0 templates/{Layout => layout}/default.php | 0 31 files changed, 0 insertions(+), 0 deletions(-) rename templates/{Cell => cell}/DashboardTable/display.php (100%) rename templates/{Cell => cell}/TablesList/display.php (100%) rename templates/{Element => element}/action-button.php (100%) rename templates/{Element => element}/action-groups.php (100%) rename templates/{Element => element}/action-header.php (100%) rename templates/{Element => element}/actions.php (100%) rename templates/{Element => element}/breadcrumbs.php (100%) rename templates/{Element => element}/form.php (100%) rename templates/{Element => element}/form/buttons.php (100%) rename templates/{Element => element}/form/tabs.php (100%) rename templates/{Element => element}/index/blog.php (100%) rename templates/{Element => element}/index/bulk_actions/form_end.php (100%) rename templates/{Element => element}/index/bulk_actions/form_start.php (100%) rename templates/{Element => element}/index/bulk_actions/record.php (100%) rename templates/{Element => element}/index/bulk_actions/table.php (100%) rename templates/{Element => element}/index/download_formats.php (100%) rename templates/{Element => element}/index/finder_scopes.php (100%) rename templates/{Element => element}/index/gallery.php (100%) rename templates/{Element => element}/index/pagination.php (100%) rename templates/{Element => element}/index/table.php (100%) rename templates/{Element => element}/index/table_columns.php (100%) rename templates/{Element => element}/menu/divider.php (100%) rename templates/{Element => element}/menu/dropdown.php (100%) rename templates/{Element => element}/menu/item.php (100%) rename templates/{Element => element}/search.php (100%) rename templates/{Element => element}/sidebar.php (100%) rename templates/{Element => element}/topbar.php (100%) rename templates/{Element => element}/view/related.php (100%) rename templates/{Element => element}/view/related/has_many.php (100%) rename templates/{Element => element}/view/related/has_one.php (100%) rename templates/{Layout => layout}/default.php (100%) diff --git a/templates/Cell/DashboardTable/display.php b/templates/cell/DashboardTable/display.php similarity index 100% rename from templates/Cell/DashboardTable/display.php rename to templates/cell/DashboardTable/display.php diff --git a/templates/Cell/TablesList/display.php b/templates/cell/TablesList/display.php similarity index 100% rename from templates/Cell/TablesList/display.php rename to templates/cell/TablesList/display.php diff --git a/templates/Element/action-button.php b/templates/element/action-button.php similarity index 100% rename from templates/Element/action-button.php rename to templates/element/action-button.php diff --git a/templates/Element/action-groups.php b/templates/element/action-groups.php similarity index 100% rename from templates/Element/action-groups.php rename to templates/element/action-groups.php diff --git a/templates/Element/action-header.php b/templates/element/action-header.php similarity index 100% rename from templates/Element/action-header.php rename to templates/element/action-header.php diff --git a/templates/Element/actions.php b/templates/element/actions.php similarity index 100% rename from templates/Element/actions.php rename to templates/element/actions.php diff --git a/templates/Element/breadcrumbs.php b/templates/element/breadcrumbs.php similarity index 100% rename from templates/Element/breadcrumbs.php rename to templates/element/breadcrumbs.php diff --git a/templates/Element/form.php b/templates/element/form.php similarity index 100% rename from templates/Element/form.php rename to templates/element/form.php diff --git a/templates/Element/form/buttons.php b/templates/element/form/buttons.php similarity index 100% rename from templates/Element/form/buttons.php rename to templates/element/form/buttons.php diff --git a/templates/Element/form/tabs.php b/templates/element/form/tabs.php similarity index 100% rename from templates/Element/form/tabs.php rename to templates/element/form/tabs.php diff --git a/templates/Element/index/blog.php b/templates/element/index/blog.php similarity index 100% rename from templates/Element/index/blog.php rename to templates/element/index/blog.php diff --git a/templates/Element/index/bulk_actions/form_end.php b/templates/element/index/bulk_actions/form_end.php similarity index 100% rename from templates/Element/index/bulk_actions/form_end.php rename to templates/element/index/bulk_actions/form_end.php diff --git a/templates/Element/index/bulk_actions/form_start.php b/templates/element/index/bulk_actions/form_start.php similarity index 100% rename from templates/Element/index/bulk_actions/form_start.php rename to templates/element/index/bulk_actions/form_start.php diff --git a/templates/Element/index/bulk_actions/record.php b/templates/element/index/bulk_actions/record.php similarity index 100% rename from templates/Element/index/bulk_actions/record.php rename to templates/element/index/bulk_actions/record.php diff --git a/templates/Element/index/bulk_actions/table.php b/templates/element/index/bulk_actions/table.php similarity index 100% rename from templates/Element/index/bulk_actions/table.php rename to templates/element/index/bulk_actions/table.php diff --git a/templates/Element/index/download_formats.php b/templates/element/index/download_formats.php similarity index 100% rename from templates/Element/index/download_formats.php rename to templates/element/index/download_formats.php diff --git a/templates/Element/index/finder_scopes.php b/templates/element/index/finder_scopes.php similarity index 100% rename from templates/Element/index/finder_scopes.php rename to templates/element/index/finder_scopes.php diff --git a/templates/Element/index/gallery.php b/templates/element/index/gallery.php similarity index 100% rename from templates/Element/index/gallery.php rename to templates/element/index/gallery.php diff --git a/templates/Element/index/pagination.php b/templates/element/index/pagination.php similarity index 100% rename from templates/Element/index/pagination.php rename to templates/element/index/pagination.php diff --git a/templates/Element/index/table.php b/templates/element/index/table.php similarity index 100% rename from templates/Element/index/table.php rename to templates/element/index/table.php diff --git a/templates/Element/index/table_columns.php b/templates/element/index/table_columns.php similarity index 100% rename from templates/Element/index/table_columns.php rename to templates/element/index/table_columns.php diff --git a/templates/Element/menu/divider.php b/templates/element/menu/divider.php similarity index 100% rename from templates/Element/menu/divider.php rename to templates/element/menu/divider.php diff --git a/templates/Element/menu/dropdown.php b/templates/element/menu/dropdown.php similarity index 100% rename from templates/Element/menu/dropdown.php rename to templates/element/menu/dropdown.php diff --git a/templates/Element/menu/item.php b/templates/element/menu/item.php similarity index 100% rename from templates/Element/menu/item.php rename to templates/element/menu/item.php diff --git a/templates/Element/search.php b/templates/element/search.php similarity index 100% rename from templates/Element/search.php rename to templates/element/search.php diff --git a/templates/Element/sidebar.php b/templates/element/sidebar.php similarity index 100% rename from templates/Element/sidebar.php rename to templates/element/sidebar.php diff --git a/templates/Element/topbar.php b/templates/element/topbar.php similarity index 100% rename from templates/Element/topbar.php rename to templates/element/topbar.php diff --git a/templates/Element/view/related.php b/templates/element/view/related.php similarity index 100% rename from templates/Element/view/related.php rename to templates/element/view/related.php diff --git a/templates/Element/view/related/has_many.php b/templates/element/view/related/has_many.php similarity index 100% rename from templates/Element/view/related/has_many.php rename to templates/element/view/related/has_many.php diff --git a/templates/Element/view/related/has_one.php b/templates/element/view/related/has_one.php similarity index 100% rename from templates/Element/view/related/has_one.php rename to templates/element/view/related/has_one.php diff --git a/templates/Layout/default.php b/templates/layout/default.php similarity index 100% rename from templates/Layout/default.php rename to templates/layout/default.php From 11c891e8befe6d801581bf6d4c95741bec5b9335 Mon Sep 17 00:00:00 2001 From: ADmad Date: Tue, 23 Jul 2019 12:21:03 +0530 Subject: [PATCH 13/91] Add CSS class for button group items. --- templates/element/action-groups.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/element/action-groups.php b/templates/element/action-groups.php index f4142087..47379231 100644 --- a/templates/element/action-groups.php +++ b/templates/element/action-groups.php @@ -25,7 +25,7 @@ $config) : ?> -
  • element('action-button', ['config' => $links[$subaction]]); ?>
    • +
  • element('action-button', ['config' => $links[$subaction]]); ?>
    • From 7ad3621f7f437c52922899b6e27fae5988c35e19 Mon Sep 17 00:00:00 2001 From: ADmad Date: Mon, 19 Aug 2019 18:57:18 +0530 Subject: [PATCH 14/91] Don't auto add "delete" button if it's blacklisted --- src/Listener/Traits/FormTypeTrait.php | 29 +++++++++++++++------------ 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/src/Listener/Traits/FormTypeTrait.php b/src/Listener/Traits/FormTypeTrait.php index 469c9094..e7281bd6 100644 --- a/src/Listener/Traits/FormTypeTrait.php +++ b/src/Listener/Traits/FormTypeTrait.php @@ -130,19 +130,22 @@ protected function _getDefaultExtraLeftButtons() $action = $this->_action(); if ($action instanceof EditAction) { - $buttons[] = [ - 'title' => __d('crud', 'Delete'), - 'url' => ['action' => 'delete'], - 'options' => [ - 'block' => 'form.after_end', - 'class' => 'btn btn-danger btn-delete', - 'confirm' => __d('crud', 'Are you sure you want to delete this record?'), - 'name' => '_delete', - 'style' => 'margin-left: 0', - ], - 'type' => 'postLink', - '_label' => 'delete', - ]; + $blacklist = $action->getConfig('scaffold.actions_blacklist', []); + if (!in_array('delete', $blacklist, true)) { + $buttons[] = [ + 'title' => __d('crud', 'Delete'), + 'url' => ['action' => 'delete'], + 'options' => [ + 'block' => 'form.after_end', + 'class' => 'btn btn-danger btn-delete', + 'confirm' => __d('crud', 'Are you sure you want to delete this record?'), + 'name' => '_delete', + 'style' => 'margin-left: 0', + ], + 'type' => 'postLink', + '_label' => 'delete', + ]; + } } return $buttons; From 90e094804f0e9088138c36b45a86f2d50c139b19 Mon Sep 17 00:00:00 2001 From: ADmad Date: Mon, 9 Sep 2019 18:16:55 +0530 Subject: [PATCH 15/91] Updates as per core changes --- tests/TestCase/Dashboard/DashboardTest.php | 13 ++++----- .../Dashboard/Module/LinkItemTest.php | 27 +++++++++---------- .../View/Widget/DateTimeWidgetTest.php | 20 +++++++------- .../View/Widget/DateTimeWidget/simple.html | 4 +-- .../DateTimeWidget/with-date-value.html | 12 ++++----- .../DateTimeWidget/with-string-value.html | 10 +++---- 6 files changed, 42 insertions(+), 44 deletions(-) diff --git a/tests/TestCase/Dashboard/DashboardTest.php b/tests/TestCase/Dashboard/DashboardTest.php index 854883ab..576e600d 100644 --- a/tests/TestCase/Dashboard/DashboardTest.php +++ b/tests/TestCase/Dashboard/DashboardTest.php @@ -3,6 +3,8 @@ namespace CrudView\Test\TestCase\Dashboard; +use Cake\Http\Response; +use Cake\Http\ServerRequest; use Cake\TestSuite\TestCase; use CrudView\Dashboard\Dashboard; use CrudView\View\Cell\DashboardTableCell; @@ -29,13 +31,12 @@ public function testConstruct() $this->assertEquals($expected, $dashboard->get('title')); } - /** - * @expectedException InvalidArgumentException - * @expectedExceptionMessage Valid columns value must be one of [1, 2, 3, 4, 6, 12] - */ public function testInvalidConstruct() { - $dashboard = new Dashboard(null, 0); + $this->expectException(\InvalidArgumentException::class); + $this->expectExceptionMessage('Valid columns value must be one of [1, 2, 3, 4, 6, 12]'); + + new Dashboard(null, 0); } public function testColumnChildren() @@ -44,7 +45,7 @@ public function testColumnChildren() $expected = []; $this->assertEquals($expected, $dashboard->getColumnChildren(1)); - $cell = new DashboardTableCell(); + $cell = new DashboardTableCell(new ServerRequest(), new Response()); $return = $dashboard->addToColumn($cell); $this->assertEquals($dashboard, $return); $this->assertEquals([$cell], $dashboard->getColumnChildren(1)); diff --git a/tests/TestCase/Dashboard/Module/LinkItemTest.php b/tests/TestCase/Dashboard/Module/LinkItemTest.php index d777532c..2cdeaebd 100644 --- a/tests/TestCase/Dashboard/Module/LinkItemTest.php +++ b/tests/TestCase/Dashboard/Module/LinkItemTest.php @@ -25,31 +25,28 @@ public function testConstruct() $this->assertEquals($expected, $item->get('options')); } - /** - * @expectedException InvalidArgumentException - * @expectedExceptionMessage Missing title for LinkItem action - */ public function testInvalidTitle() { - $item = new LinkItem('', null); + $this->expectException(\InvalidArgumentException::class); + $this->expectExceptionMessage('Missing title for LinkItem action'); + + new LinkItem('', null); } - /** - * @expectedException InvalidArgumentException - * @expectedExceptionMessage Invalid url specified for LinkItem - */ public function testInvalidNullUrl() { - $item = new LinkItem('Title', null); + $this->expectException(\InvalidArgumentException::class); + $this->expectExceptionMessage('Invalid url specified for LinkItem'); + + new LinkItem('Title', null); } - /** - * @expectedException InvalidArgumentException - * @expectedExceptionMessage Invalid url specified for LinkItem - */ public function testInvalidEmptyUrl() { - $item = new LinkItem('Title', ''); + $this->expectException(\InvalidArgumentException::class); + $this->expectExceptionMessage('Invalid url specified for LinkItem'); + + new LinkItem('Title', ''); } public function testOptions() diff --git a/tests/TestCase/View/Widget/DateTimeWidgetTest.php b/tests/TestCase/View/Widget/DateTimeWidgetTest.php index c7d123a3..b576236b 100644 --- a/tests/TestCase/View/Widget/DateTimeWidgetTest.php +++ b/tests/TestCase/View/Widget/DateTimeWidgetTest.php @@ -3,7 +3,7 @@ namespace CrudView\Test\TestCase\View\Widget; -use Cake\I18n\FrozenTime; +use Cake\I18n\FrozenDate; use Cake\TestSuite\TestCase; use Cake\View\Form\ContextInterface; use Cake\View\StringTemplate; @@ -52,17 +52,17 @@ public function testRenderSimple($compareFileName, $data) public function renderProvider() { return [ - [ - 'simple.html', - ['id' => 'the-id', 'name' => 'the-name', 'val' => '', 'type' => 'x', 'required' => false], - ], - [ - 'with-string-value.html', - ['id' => 'the-id', 'name' => 'the-name', 'val' => '2000-01-01', 'type' => 'x', 'required' => false], - ], + // [ + // 'simple.html', + // ['id' => 'the-id', 'name' => 'the-name', 'val' => '', 'type' => 'date', 'required' => false], + // ], + // [ + // 'with-string-value.html', + // ['id' => 'the-id2', 'name' => 'the-name2', 'val' => '2000-01-01', 'type' => 'date', 'required' => false], + // ], [ 'with-date-value.html', - ['id' => 'the-id', 'name' => 'the-name', 'val' => (new FrozenTime(strtotime('2000-01-01'))), 'type' => 'x', 'required' => false], + ['id' => 'the-id3', 'name' => 'the-name3', 'val' => new FrozenDate('2000-01-01'), 'type' => 'date', 'required' => false], ], ]; } diff --git a/tests/comparisons/View/Widget/DateTimeWidget/simple.html b/tests/comparisons/View/Widget/DateTimeWidget/simple.html index b68d94cf..f3d5ea09 100644 --- a/tests/comparisons/View/Widget/DateTimeWidget/simple.html +++ b/tests/comparisons/View/Widget/DateTimeWidget/simple.html @@ -1,5 +1,5 @@
    + class="input-group date"> + data-format="L" />
    From 051a8432918bffb79ad1759637d45368c5fb0a6f Mon Sep 17 00:00:00 2001 From: ADmad Date: Mon, 30 Sep 2019 03:07:48 +0530 Subject: [PATCH 24/91] Move back picker icon to the right --- src/View/Widget/DateTimeWidget.php | 4 ++-- .../View/Widget/DateTimeWidget/simple.html | 16 ++++++++-------- .../Widget/DateTimeWidget/with-date-value.html | 16 ++++++++-------- .../Widget/DateTimeWidget/with-string-value.html | 16 ++++++++-------- 4 files changed, 26 insertions(+), 26 deletions(-) diff --git a/src/View/Widget/DateTimeWidget.php b/src/View/Widget/DateTimeWidget.php index 46b43fcf..260c81e9 100644 --- a/src/View/Widget/DateTimeWidget.php +++ b/src/View/Widget/DateTimeWidget.php @@ -88,10 +88,10 @@ public function render(array $data, ContextInterface $context): string $this->_templates->add([ 'datetimePicker' => '
    ' - . '
    ' + . '{{input}}' + . '
    ' . '' . '
    ' - . '{{input}}' . '
    ', ]); } diff --git a/tests/comparisons/View/Widget/DateTimeWidget/simple.html b/tests/comparisons/View/Widget/DateTimeWidget/simple.html index 93a62658..52d1ebe7 100644 --- a/tests/comparisons/View/Widget/DateTimeWidget/simple.html +++ b/tests/comparisons/View/Widget/DateTimeWidget/simple.html @@ -3,8 +3,15 @@ data-wrap="true" data-date-format="Y-m-d" class="input-group flatpickr"> +
    + class="input-group-append">
    -
    diff --git a/tests/comparisons/View/Widget/DateTimeWidget/with-date-value.html b/tests/comparisons/View/Widget/DateTimeWidget/with-date-value.html index 37f4d7c0..37588e4f 100644 --- a/tests/comparisons/View/Widget/DateTimeWidget/with-date-value.html +++ b/tests/comparisons/View/Widget/DateTimeWidget/with-date-value.html @@ -3,8 +3,15 @@ data-wrap="true" data-date-format="Y-m-d" class="input-group flatpickr"> +
    + class="input-group-append">
    - diff --git a/tests/comparisons/View/Widget/DateTimeWidget/with-string-value.html b/tests/comparisons/View/Widget/DateTimeWidget/with-string-value.html index 8f2bd0f0..f0e47317 100644 --- a/tests/comparisons/View/Widget/DateTimeWidget/with-string-value.html +++ b/tests/comparisons/View/Widget/DateTimeWidget/with-string-value.html @@ -3,8 +3,15 @@ data-wrap="true" data-date-format="Y-m-d" class="input-group flatpickr"> +
    + class="input-group-append">
    - From 90b46ef39c845b6ba1118cfea09f78cecf38e405 Mon Sep 17 00:00:00 2001 From: ADmad Date: Mon, 30 Sep 2019 12:22:30 +0530 Subject: [PATCH 25/91] Add clear button for picker --- src/View/Widget/DateTimeWidget.php | 1 + tests/comparisons/View/Widget/DateTimeWidget/simple.html | 6 ++++++ .../View/Widget/DateTimeWidget/with-date-value.html | 6 ++++++ .../View/Widget/DateTimeWidget/with-string-value.html | 6 ++++++ 4 files changed, 19 insertions(+) diff --git a/src/View/Widget/DateTimeWidget.php b/src/View/Widget/DateTimeWidget.php index 260c81e9..90e15d5f 100644 --- a/src/View/Widget/DateTimeWidget.php +++ b/src/View/Widget/DateTimeWidget.php @@ -91,6 +91,7 @@ public function render(array $data, ContextInterface $context): string . '{{input}}' . '
    ' . '' + . '' . '
    ' . '', ]); diff --git a/tests/comparisons/View/Widget/DateTimeWidget/simple.html b/tests/comparisons/View/Widget/DateTimeWidget/simple.html index 52d1ebe7..0fa0aa51 100644 --- a/tests/comparisons/View/Widget/DateTimeWidget/simple.html +++ b/tests/comparisons/View/Widget/DateTimeWidget/simple.html @@ -18,5 +18,11 @@ class="fa fa-calendar-alt">     + + + + diff --git a/tests/comparisons/View/Widget/DateTimeWidget/with-date-value.html b/tests/comparisons/View/Widget/DateTimeWidget/with-date-value.html index 37588e4f..f9203941 100644 --- a/tests/comparisons/View/Widget/DateTimeWidget/with-date-value.html +++ b/tests/comparisons/View/Widget/DateTimeWidget/with-date-value.html @@ -18,5 +18,11 @@ class="fa fa-calendar-alt">     + + + + diff --git a/tests/comparisons/View/Widget/DateTimeWidget/with-string-value.html b/tests/comparisons/View/Widget/DateTimeWidget/with-string-value.html index f0e47317..fbffeeec 100644 --- a/tests/comparisons/View/Widget/DateTimeWidget/with-string-value.html +++ b/tests/comparisons/View/Widget/DateTimeWidget/with-string-value.html @@ -18,5 +18,11 @@ class="fa fa-calendar-alt">     + + + + From 0eed4823a1c8d9085945d2f9ae15d0ff738d11b5 Mon Sep 17 00:00:00 2001 From: ADmad Date: Mon, 30 Sep 2019 19:28:58 +0530 Subject: [PATCH 26/91] Use button class and fix icon display --- src/View/Widget/DateTimeWidget.php | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/View/Widget/DateTimeWidget.php b/src/View/Widget/DateTimeWidget.php index 90e15d5f..411f317a 100644 --- a/src/View/Widget/DateTimeWidget.php +++ b/src/View/Widget/DateTimeWidget.php @@ -85,16 +85,18 @@ public function render(array $data, ContextInterface $context): string unset($datetimePicker['iconClass']); if ($this->_templates->get('datetimePicker') === null) { + // phpcs:disable $this->_templates->add([ 'datetimePicker' => '
    ' . '{{input}}' . '
    ' - . '' - . '' + . '' + . '' . '
    ' . '
    ', ]); + // phpcs:enable } $data = $this->_templates->addClass($data, 'form-control'); From 767dc7d71a71aea7c0114489a5c8eba97821cd20 Mon Sep 17 00:00:00 2001 From: ADmad Date: Tue, 1 Oct 2019 00:27:23 +0530 Subject: [PATCH 27/91] By default use select2 only for select tags with "multiple" attribute. Default boostrap styled single value selects look good enough and have no usability issues. Devs can turn select2 explicity by using "selec2" class. --- webroot/js/local.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/webroot/js/local.js b/webroot/js/local.js index 1629beac..41b38b1f 100644 --- a/webroot/js/local.js +++ b/webroot/js/local.js @@ -117,7 +117,7 @@ var CrudView = { initialize: function() { this.bulkActionForm('.bulk-actions'); this.datePicker('[role=datetime-picker]'); - this.select2('select:not(.autocomplete, .no-select2)'); + this.select2('select[multiple]:not(.no-select2), .select2'); this.autocomplete('input.autocomplete, select.autocomplete'); this.dirtyForms(); this.dropdown(); From 2d7492e1fac6c601e7bfe4606eb00c059dff2751 Mon Sep 17 00:00:00 2001 From: ADmad Date: Tue, 1 Oct 2019 18:45:42 +0530 Subject: [PATCH 28/91] Fix tests --- src/View/Widget/DateTimeWidget.php | 6 +++--- .../View/Widget/DateTimeWidget/simple.html | 14 ++++++++------ .../Widget/DateTimeWidget/with-date-value.html | 14 ++++++++------ .../Widget/DateTimeWidget/with-string-value.html | 14 ++++++++------ 4 files changed, 27 insertions(+), 21 deletions(-) diff --git a/src/View/Widget/DateTimeWidget.php b/src/View/Widget/DateTimeWidget.php index 411f317a..c649d57f 100644 --- a/src/View/Widget/DateTimeWidget.php +++ b/src/View/Widget/DateTimeWidget.php @@ -75,7 +75,7 @@ public function render(array $data, ContextInterface $context): string $datetimePicker += ['data-enable-seconds' => 'true']; } - $iconClass = 'fa fa-calendar'; + $iconClass = 'fa fa-calendar-alt'; if (isset($datetimePicker['iconClass'])) { $iconClass = $data['iconClass']; } elseif ($data['type'] === 'time') { @@ -91,8 +91,8 @@ public function render(array $data, ContextInterface $context): string '
    ' . '{{input}}' . '
    ' - . '' - . '' + . '' + . '' . '
    ' . '
    ', ]); diff --git a/tests/comparisons/View/Widget/DateTimeWidget/simple.html b/tests/comparisons/View/Widget/DateTimeWidget/simple.html index 0fa0aa51..7e68fff5 100644 --- a/tests/comparisons/View/Widget/DateTimeWidget/simple.html +++ b/tests/comparisons/View/Widget/DateTimeWidget/simple.html @@ -12,17 +12,19 @@ class="form-control"/>
    - + +
    diff --git a/tests/comparisons/View/Widget/DateTimeWidget/with-date-value.html b/tests/comparisons/View/Widget/DateTimeWidget/with-date-value.html index f9203941..2cf1b71c 100644 --- a/tests/comparisons/View/Widget/DateTimeWidget/with-date-value.html +++ b/tests/comparisons/View/Widget/DateTimeWidget/with-date-value.html @@ -12,17 +12,19 @@ class="form-control"/>
    - + +
    diff --git a/tests/comparisons/View/Widget/DateTimeWidget/with-string-value.html b/tests/comparisons/View/Widget/DateTimeWidget/with-string-value.html index fbffeeec..26bd06ee 100644 --- a/tests/comparisons/View/Widget/DateTimeWidget/with-string-value.html +++ b/tests/comparisons/View/Widget/DateTimeWidget/with-string-value.html @@ -12,17 +12,19 @@ class="form-control"/>
    - + +
    From 0f39164e4f64b17a212b2a1c6681b4a423d5eeea Mon Sep 17 00:00:00 2001 From: ADmad Date: Tue, 1 Oct 2019 18:46:48 +0530 Subject: [PATCH 29/91] Fix CS errors --- src/Action/DashboardAction.php | 1 - src/Breadcrumb/ActiveBreadcrumb.php | 1 - src/Breadcrumb/Breadcrumb.php | 1 - src/Dashboard/Dashboard.php | 1 - src/Dashboard/Module/ActionLinkItem.php | 1 - src/Dashboard/Module/LinkItem.php | 1 - src/Listener/Traits/DeprecatedConfigurationKeyTrait.php | 1 - src/Listener/Traits/FormTypeTrait.php | 1 - src/Listener/Traits/IndexTypeTrait.php | 1 - src/Listener/Traits/SidebarNavigationTrait.php | 1 - src/Listener/Traits/SiteTitleTrait.php | 1 - src/Listener/Traits/UtilityNavigationTrait.php | 1 - src/Listener/ViewListener.php | 1 - src/Listener/ViewSearchListener.php | 1 - src/Menu/MenuDivider.php | 1 - src/Menu/MenuDropdown.php | 1 - src/Menu/MenuItem.php | 1 - src/Plugin.php | 1 - src/Traits/CrudViewConfigTrait.php | 1 - src/View/Cell/DashboardTableCell.php | 1 - src/View/Cell/TablesListCell.php | 1 - src/View/CrudView.php | 1 - src/View/Helper/CrudViewHelper.php | 1 - src/View/Widget/DateTimeWidget.php | 8 +++++++- tests/TestCase/Dashboard/DashboardTest.php | 1 - tests/TestCase/Dashboard/Module/ActionLinkItemTest.php | 1 - tests/TestCase/Dashboard/Module/LinkItemTest.php | 1 - tests/TestCase/View/CrudViewTest.php | 1 - tests/TestCase/View/Helper/CrudViewHelperTest.php | 1 - tests/TestCase/View/Widget/DateTimeWidgetTest.php | 1 - tests/bootstrap.php | 1 - 31 files changed, 7 insertions(+), 31 deletions(-) diff --git a/src/Action/DashboardAction.php b/src/Action/DashboardAction.php index ee6427e3..fd8b12b1 100644 --- a/src/Action/DashboardAction.php +++ b/src/Action/DashboardAction.php @@ -1,5 +1,4 @@ Date: Mon, 30 Sep 2019 19:11:31 +0530 Subject: [PATCH 30/91] Don't add margins to all buttons by default. This causes design issue when using additional themes / widgets. Just use whitespace for spacing between action buttons. See https://getbootstrap.com/docs/4.3/components/buttons/ --- templates/element/actions.php | 10 ++++++++-- templates/element/form/buttons.php | 28 ++++++++++++++-------------- webroot/css/local.css | 3 --- 3 files changed, 22 insertions(+), 19 deletions(-) diff --git a/templates/element/actions.php b/templates/element/actions.php index 92f6d951..4a9abcf5 100644 --- a/templates/element/actions.php +++ b/templates/element/actions.php @@ -67,6 +67,7 @@ ?> element('action-button', ['config' => $config]); + $btns[] = $this->element('action-button', ['config' => $config]); } unset($actionGroups['primary']); // render grouped actions -echo $this->element('action-groups', ['groups' => $actionGroups, 'links' => $links]); +$groupedBtns = trim($this->element('action-groups', ['groups' => $actionGroups, 'links' => $links])); +if ($groupedBtns) { + $btns[] = $groupedBtns; +} + +echo implode(' ', $btns); diff --git a/templates/element/form/buttons.php b/templates/element/form/buttons.php index 81690b2d..42e25919 100644 --- a/templates/element/form/buttons.php +++ b/templates/element/form/buttons.php @@ -1,20 +1,20 @@ - +
    Form->button($button['title'], $button['options']); - } elseif ($button['type'] === 'link') { - echo $this->Html->link($button['title'], $button['url'], $button['options']); - } elseif ($button['type'] === 'postLink') { - if (is_array($button['url'])) { - $button['url'][] = $$viewVar->get($primaryKey); - } - echo $this->Form->postLink($button['title'], $button['url'], $button['options']); + $btns = []; + foreach ($formSubmitExtraLeftButtons as $button) { + if ($button['type'] === 'button') { + $btns[] = $this->Form->button($button['title'], $button['options']); + } elseif ($button['type'] === 'link') { + $btns[] = $this->Html->link($button['title'], $button['url'], $button['options']); + } elseif ($button['type'] === 'postLink') { + if (is_array($button['url'])) { + $button['url'][] = $$viewVar->get($primaryKey); } + $btns[] = $this->Form->postLink($button['title'], $button['url'], $button['options']); } } + echo implode(' ', $btns); ?>
    @@ -28,9 +28,9 @@ if (!empty($formSubmitExtraButtons)) { foreach ($formSubmitExtraButtons as $button) { if ($button['type'] === 'button') { - echo $this->Form->button($button['title'], $button['options']); + echo ' ' . $this->Form->button($button['title'], $button['options']); } elseif ($button['type'] === 'link') { - echo $this->Html->link($button['title'], $button['url'], $button['options']); + echo ' ' . $this->Html->link($button['title'], $button['url'], $button['options']); } } } diff --git a/webroot/css/local.css b/webroot/css/local.css index b2b73514..02adaab6 100644 --- a/webroot/css/local.css +++ b/webroot/css/local.css @@ -48,9 +48,6 @@ div.input { margin-bottom: 10px } -.btn { - margin-left: 5px -} h2 .actions { margin-left: 15px; } From ba83561ee9120fd33c4fa9b7cb15e50777781153 Mon Sep 17 00:00:00 2001 From: ADmad Date: Mon, 30 Sep 2019 20:25:51 +0530 Subject: [PATCH 31/91] Fix class in button group dropdown --- templates/element/action-groups.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/element/action-groups.php b/templates/element/action-groups.php index 47379231..044b9f85 100644 --- a/templates/element/action-groups.php +++ b/templates/element/action-groups.php @@ -21,7 +21,7 @@ '#', ['class' => 'btn btn-default dropdown-toggle', 'escape' => false, 'data-toggle' => 'dropdown', 'aria-haspopup' => true, 'aria-expanded' => false] ) ?> -
      +
        $config) : ?> From 1f4ae22b8e49df631ec29ec3cfb7c776b4a82b40 Mon Sep 17 00:00:00 2001 From: ADmad Date: Tue, 1 Oct 2019 23:57:27 +0530 Subject: [PATCH 32/91] Update markup for actions group. See https://getbootstrap.com/docs/4.3/components/dropdowns/#dropdown-options --- templates/element/action-groups.php | 27 +++++++++++++++++---------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/templates/element/action-groups.php b/templates/element/action-groups.php index 044b9f85..344b9f57 100644 --- a/templates/element/action-groups.php +++ b/templates/element/action-groups.php @@ -15,20 +15,27 @@ ?> $group) : ?> -
        - Html->link( - sprintf("%s %s", $key, $this->Html->tag('span', '', ['class' => 'caret'])), - '#', - ['class' => 'btn btn-default dropdown-toggle', 'escape' => false, 'data-toggle' => 'dropdown', 'aria-haspopup' => true, 'aria-expanded' => false] - ) ?> -
          +
          + +
          $config) : ?> - -
        • element('action-button', ['config' => $links[$subaction]]); ?>
          • + + 'dropdown-item', + ]; + } + ?> + element('action-button', ['config' => $links[$subaction]]); ?> -
        +
        Date: Wed, 2 Oct 2019 02:06:38 +0530 Subject: [PATCH 33/91] btn-default is replaced by btn-secondary in BS 4. --- src/Dashboard/Module/ActionLinkItem.php | 2 +- src/Listener/Traits/FormTypeTrait.php | 2 +- templates/element/action-groups.php | 2 +- templates/element/actions.php | 2 +- templates/element/index/finder_scopes.php | 2 +- templates/element/view/related/has_many.php | 8 ++++---- templates/element/view/related/has_one.php | 2 +- tests/TestCase/Dashboard/Module/ActionLinkItemTest.php | 2 +- 8 files changed, 11 insertions(+), 11 deletions(-) diff --git a/src/Dashboard/Module/ActionLinkItem.php b/src/Dashboard/Module/ActionLinkItem.php index 178ab269..2948f585 100644 --- a/src/Dashboard/Module/ActionLinkItem.php +++ b/src/Dashboard/Module/ActionLinkItem.php @@ -39,7 +39,7 @@ public function __construct($title, $url, $options = [], array $actions = []) protected function _setActions($actions) { return (new Collection($actions))->map(function ($value) { - $options = (array)$value->get('options') + ['class' => ['btn btn-default']]; + $options = (array)$value->get('options') + ['class' => ['btn btn-secondary']]; $value->set('options', $options); return $value; diff --git a/src/Listener/Traits/FormTypeTrait.php b/src/Listener/Traits/FormTypeTrait.php index 3b8af217..ecc0df97 100644 --- a/src/Listener/Traits/FormTypeTrait.php +++ b/src/Listener/Traits/FormTypeTrait.php @@ -112,7 +112,7 @@ protected function _getDefaultExtraButtons() 'back' => [ 'title' => __d('crud', 'Back'), 'url' => ['action' => 'index'], - 'options' => ['class' => 'btn btn-default', 'role' => 'button'], + 'options' => ['class' => 'btn btn-secondary', 'role' => 'button'], 'type' => 'link', '_label' => 'back', ], diff --git a/templates/element/action-groups.php b/templates/element/action-groups.php index 344b9f57..4602d2a3 100644 --- a/templates/element/action-groups.php +++ b/templates/element/action-groups.php @@ -16,7 +16,7 @@ $group) : ?>
        -
        diff --git a/templates/element/actions.php b/templates/element/actions.php index 4a9abcf5..fcf5ca8f 100644 --- a/templates/element/actions.php +++ b/templates/element/actions.php @@ -81,7 +81,7 @@ } if (empty($config['options']['class'])) { - $config['options']['class'] = ['btn btn-default']; + $config['options']['class'] = ['btn btn-secondary']; } $btns[] = $this->element('action-button', ['config' => $config]); diff --git a/templates/element/index/finder_scopes.php b/templates/element/index/finder_scopes.php index 61c80f4e..12cd2ce3 100644 --- a/templates/element/index/finder_scopes.php +++ b/templates/element/index/finder_scopes.php @@ -5,7 +5,7 @@ $finder = $this->request->query('finder'); foreach ($indexFinderScopes as $indexFinderScope) { - $scopeOptions = ['class' => 'btn btn-default btn-sm', 'role' => 'button']; + $scopeOptions = ['class' => 'btn btn-secondary btn-sm', 'role' => 'button']; $scopeFinder = $indexFinderScope['finder']; if (empty($finder) && $scopeFinder === 'all') { diff --git a/templates/element/view/related/has_many.php b/templates/element/view/related/has_many.php index 134d34d7..b29f18d0 100644 --- a/templates/element/view/related/has_many.php +++ b/templates/element/view/related/has_many.php @@ -17,7 +17,7 @@

        - CrudView->createRelationLink($alias, $details, array('class' => 'btn btn-default'));?> + CrudView->createRelationLink($alias, $details, array('class' => 'btn btn-secondary'));?>
        {$details['entities']}): @@ -53,9 +53,9 @@ } ?> - Html->link(__d('crud', 'View'), array('plugin' => $details['plugin'], 'controller' => $details['controller'], 'action' => 'view', ${$otherSingularVar}[$details['primaryKey']]), array('class' => 'btn btn-default')); ?> - Html->link(__d('crud', 'Edit'), array('plugin' => $details['plugin'], 'controller' => $details['controller'], 'action' => 'edit', ${$otherSingularVar}[$details['primaryKey']]), array('class' => 'btn btn-default')); ?> - Html->link(__d('crud', 'Delete'), array('plugin' => $details['plugin'], 'controller' => $details['controller'], 'action' => 'delete', ${$otherSingularVar}[$details['primaryKey']]), array('class' => 'btn btn-default')); ?> + Html->link(__d('crud', 'View'), array('plugin' => $details['plugin'], 'controller' => $details['controller'], 'action' => 'view', ${$otherSingularVar}[$details['primaryKey']]), array('class' => 'btn btn-secondary')); ?> + Html->link(__d('crud', 'Edit'), array('plugin' => $details['plugin'], 'controller' => $details['controller'], 'action' => 'edit', ${$otherSingularVar}[$details['primaryKey']]), array('class' => 'btn btn-secondary')); ?> + Html->link(__d('crud', 'Delete'), array('plugin' => $details['plugin'], 'controller' => $details['controller'], 'action' => 'delete', ${$otherSingularVar}[$details['primaryKey']]), array('class' => 'btn btn-secondary')); ?> Html->link( __d('crud', 'View {0}', [Inflector::humanize(Inflector::underscore($alias))]), array('plugin' => $details['plugin'], 'controller' => $details['controller'], 'action' => 'view', ${$viewVar}[$alias][$details['primaryKey']]), - array('class' => 'btn btn-default') + array('class' => 'btn btn-secondary') ); ?>
        diff --git a/tests/TestCase/Dashboard/Module/ActionLinkItemTest.php b/tests/TestCase/Dashboard/Module/ActionLinkItemTest.php index 189718e5..de33ff56 100644 --- a/tests/TestCase/Dashboard/Module/ActionLinkItemTest.php +++ b/tests/TestCase/Dashboard/Module/ActionLinkItemTest.php @@ -42,7 +42,7 @@ public function testActions() $this->assertEquals($expected, $item->get('actions')); $actions = $item->get('actions'); - $expected = ['class' => ['btn btn-default']]; + $expected = ['class' => ['btn btn-secondary']]; $this->assertEquals($expected, $actions[0]->get('options')); } } From c45f078cb5b8fcae2139075ae0219b5567e3dfd2 Mon Sep 17 00:00:00 2001 From: ADmad Date: Wed, 2 Oct 2019 12:46:28 +0530 Subject: [PATCH 34/91] Use standard class instead of custom styling --- templates/element/action-header.php | 2 +- webroot/css/local.css | 4 ---- 2 files changed, 1 insertion(+), 5 deletions(-) diff --git a/templates/element/action-header.php b/templates/element/action-header.php index cd178022..3793fdc8 100644 --- a/templates/element/action-header.php +++ b/templates/element/action-header.php @@ -16,6 +16,6 @@ } ?>

        get('title'); ?>

        -
        +
        fetch('actions'); ?>
        diff --git a/webroot/css/local.css b/webroot/css/local.css index 02adaab6..b9e3f590 100644 --- a/webroot/css/local.css +++ b/webroot/css/local.css @@ -72,10 +72,6 @@ h2 .actions { padding-right:33px; } -div.actions-wrapper { - margin: 10px 0; -} - .text-truncate { white-space: nowrap; overflow: hidden; From 2ac5b5907ed35d1d48a24a5c0e28f63e949798cd Mon Sep 17 00:00:00 2001 From: ADmad Date: Wed, 2 Oct 2019 13:14:33 +0530 Subject: [PATCH 35/91] Fix display of search form. --- templates/element/search.php | 8 +++----- webroot/css/local.css | 17 +++++++++-------- 2 files changed, 12 insertions(+), 13 deletions(-) diff --git a/templates/element/search.php b/templates/element/search.php index 42fa2f2c..dad67386 100644 --- a/templates/element/search.php +++ b/templates/element/search.php @@ -4,7 +4,7 @@ } ?> -
        +
        'form-inline', 'id' => 'searchFilter']; @@ -13,10 +13,8 @@ echo $this->Form->hidden('_search'); ?> -
        - Form->controls($searchInputs, ['fieldset' => false]); ?> - Form->button(__d('crud', 'Filter results'), ['type' => 'submit', 'class' => 'btn btn-primary']); ?> -
        + Form->controls($searchInputs, ['fieldset' => false]); ?> + Form->button(__d('crud', 'Filter results'), ['type' => 'submit', 'class' => 'btn btn-primary']); ?> Form->end(); ?>
        diff --git a/webroot/css/local.css b/webroot/css/local.css index b9e3f590..e6f86a45 100644 --- a/webroot/css/local.css +++ b/webroot/css/local.css @@ -52,20 +52,21 @@ h2 .actions { margin-left: 15px; } -.search-filters .form-inline .form-group { - padding-left:10px; +.search-filters .form-inline .form-group label { + margin-right: .25rem !important; } -.search-filters .form-inline .form-group label { - padding-right:10px; +.search-filters .form-inline .form-group { + margin-right: .5rem !important; } -.search-filters .form-inline .form-control { - min-width:90px !important; +.search-filters .form-inline .form-group, +.search-filters .form-inline button { + margin-bottom: 1rem !important; } -.search-filters .form-inline .form-control input, .search-filters .form-inline .form-control select { - min-width:90px !important; +.search-filters .form-inline .form-control input { + min-width: 90px !important; } .selectize-input.items.full { From cceeff7fd31b972b5a1c9794adc419ca66388800 Mon Sep 17 00:00:00 2001 From: ADmad Date: Wed, 2 Oct 2019 17:26:38 +0530 Subject: [PATCH 36/91] Show "Reset" link for search form. --- src/Listener/ViewSearchListener.php | 5 ++++- templates/element/search.php | 9 +++++++-- webroot/css/local.css | 6 +++--- 3 files changed, 14 insertions(+), 6 deletions(-) diff --git a/src/Listener/ViewSearchListener.php b/src/Listener/ViewSearchListener.php index 8daef1b0..0d851e34 100644 --- a/src/Listener/ViewSearchListener.php +++ b/src/Listener/ViewSearchListener.php @@ -66,7 +66,10 @@ public function afterPaginate(EventInterface $event) } $fields = $this->fields(); - $this->_controller()->set('searchInputs', $fields); + + $this->_controller()->viewBuilder() + ->setVar('searchInputs', $fields) + ->setHelpers(['Search.Search']); } /** diff --git a/templates/element/search.php b/templates/element/search.php index dad67386..990e513d 100644 --- a/templates/element/search.php +++ b/templates/element/search.php @@ -6,7 +6,7 @@
        'form-inline', 'id' => 'searchFilter']; echo $this->Form->create(null, $searchOptions); @@ -14,7 +14,12 @@ ?> Form->controls($searchInputs, ['fieldset' => false]); ?> - Form->button(__d('crud', 'Filter results'), ['type' => 'submit', 'class' => 'btn btn-primary']); ?> +
        + Form->button(__d('crud', 'Filter results'), ['type' => 'submit', 'class' => 'btn btn-primary']); ?> + Search->isSearch()) : ?> + Search->resetLink(__d('crud', 'Reset'), ['class' => 'btn btn-primary']) ?> + +
        Form->end(); ?>
        diff --git a/webroot/css/local.css b/webroot/css/local.css index e6f86a45..569fa920 100644 --- a/webroot/css/local.css +++ b/webroot/css/local.css @@ -52,7 +52,8 @@ h2 .actions { margin-left: 15px; } -.search-filters .form-inline .form-group label { +.search-filters .form-inline .form-group label, +.search-filters .form-inline .btn { margin-right: .25rem !important; } @@ -60,8 +61,7 @@ h2 .actions { margin-right: .5rem !important; } -.search-filters .form-inline .form-group, -.search-filters .form-inline button { +.search-filters .form-inline .form-group { margin-bottom: 1rem !important; } From 9e8e8fb9b17729c756d0198d57c199410bff08a8 Mon Sep 17 00:00:00 2001 From: ADmad Date: Wed, 16 Oct 2019 17:57:40 +0530 Subject: [PATCH 37/91] Redirect back to current page after deleting record. This ensure for e.g. that search filters are retained. --- src/Listener/ViewListener.php | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/src/Listener/ViewListener.php b/src/Listener/ViewListener.php index c6e87e1e..ddd835e3 100644 --- a/src/Listener/ViewListener.php +++ b/src/Listener/ViewListener.php @@ -429,6 +429,12 @@ protected function _getControllerActions() protected function _getControllerActionConfiguration($actionName, $config) { $realAction = Hash::get($config, 'url.action', $actionName); + $url = ['action' => $realAction]; + + if (isset($config['url'])) { + $url = $config['url'] + $url; + } + if ($this->_crud()->isActionMapped($realAction)) { $action = $this->_action($realAction); $class = get_class($action); @@ -436,6 +442,7 @@ protected function _getControllerActionConfiguration($actionName, $config) if ($class === 'DeleteAction') { $config += ['method' => 'DELETE']; + $url['?']['_redirect_url'] = $this->_request()->getRequestTarget(); } if (!isset($config['scope'])) { @@ -450,10 +457,6 @@ protected function _getControllerActionConfiguration($actionName, $config) $title = !empty($config['link_title']) ? $config['link_title'] : Inflector::humanize(Inflector::underscore($actionName)); - $url = ['action' => $realAction]; - if (isset($config['url'])) { - $url = $config['url'] + $url; - } $actionConfig = [ 'title' => $title, From 497308d85f2b5a5ece31a41a2e3f14a3ec88715d Mon Sep 17 00:00:00 2001 From: ADmad Date: Tue, 22 Oct 2019 23:58:24 +0530 Subject: [PATCH 38/91] Fix typehint --- src/Listener/ViewListener.php | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/src/Listener/ViewListener.php b/src/Listener/ViewListener.php index ddd835e3..db1a2a4f 100644 --- a/src/Listener/ViewListener.php +++ b/src/Listener/ViewListener.php @@ -5,7 +5,7 @@ use Cake\Collection\Collection; use Cake\Database\Exception; -use Cake\Event\Event; +use Cake\Event\EventInterface; use Cake\Utility\Hash; use Cake\Utility\Inflector; use Crud\Listener\BaseListener; @@ -35,10 +35,10 @@ class ViewListener extends BaseListener /** * [beforeFind description] * - * @param \Cake\Event\Event $event Event. + * @param \Cake\Event\EventInterface $event Event. * @return void */ - public function beforeFind(Event $event) + public function beforeFind(EventInterface $event) { $related = $this->_getRelatedModels(); if ($related === []) { @@ -55,10 +55,10 @@ public function beforeFind(Event $event) /** * [beforePaginate description] * - * @param \Cake\Event\Event $event Event. + * @param \Cake\Event\EventInterface $event Event. * @return void */ - public function beforePaginate(Event $event) + public function beforePaginate(EventInterface $event) { $related = $this->_getRelatedModels(); if ($related === []) { @@ -75,10 +75,10 @@ public function beforePaginate(Event $event) /** * beforeRender event * - * @param \Cake\Event\Event $event Event. + * @param \Cake\Event\EventInterface $event Event. * @return void */ - public function beforeRender(Event $event) + public function beforeRender(EventInterface $event) { if ($this->_controller()->getName() === 'Error') { return; @@ -123,10 +123,10 @@ public function beforeRender(Event $event) /** * Make sure flash messages are properly handled by BootstrapUI.FlashHelper * - * @param \Cake\Event\Event $event Event. + * @param \Cake\Event\EventInterface $event Event. * @return void */ - public function setFlash(Event $event) + public function setFlash(EventInterface $event) { unset($event->getSubject()->params['class']); $event->getSubject()->element = ltrim($event->getSubject()->type); From ff112d56c208687b0da6a45b0c9de7b3e94da838 Mon Sep 17 00:00:00 2001 From: ADmad Date: Fri, 25 Oct 2019 13:56:25 +0530 Subject: [PATCH 39/91] Add typehints. --- src/Breadcrumb/Breadcrumb.php | 2 +- src/Dashboard/Dashboard.php | 8 +-- src/Dashboard/Module/LinkItem.php | 4 +- .../DeprecatedConfigurationKeyTrait.php | 2 +- src/Listener/Traits/FormTypeTrait.php | 22 ++++---- src/Listener/Traits/IndexTypeTrait.php | 29 +++++----- .../Traits/SidebarNavigationTrait.php | 9 ++-- src/Listener/Traits/SiteTitleTrait.php | 14 ++--- .../Traits/UtilityNavigationTrait.php | 10 ++-- src/Listener/ViewListener.php | 44 +++++++-------- src/Listener/ViewSearchListener.php | 6 +-- src/Menu/MenuDropdown.php | 6 +-- src/Menu/MenuItem.php | 6 +-- src/Traits/CrudViewConfigTrait.php | 2 +- src/View/Cell/DashboardTableCell.php | 2 +- src/View/Cell/TablesListCell.php | 2 +- src/View/CrudView.php | 10 ++-- src/View/Helper/CrudViewHelper.php | 53 ++++++++++--------- src/View/Widget/DateTimeWidget.php | 2 +- 19 files changed, 123 insertions(+), 110 deletions(-) diff --git a/src/Breadcrumb/Breadcrumb.php b/src/Breadcrumb/Breadcrumb.php index 0a540b26..200bc21a 100644 --- a/src/Breadcrumb/Breadcrumb.php +++ b/src/Breadcrumb/Breadcrumb.php @@ -78,7 +78,7 @@ public function getUrl() * * @return array */ - public function getOptions() + public function getOptions(): array { return $this->options; } diff --git a/src/Dashboard/Dashboard.php b/src/Dashboard/Dashboard.php index e387f537..c76cac32 100644 --- a/src/Dashboard/Dashboard.php +++ b/src/Dashboard/Dashboard.php @@ -17,7 +17,7 @@ class Dashboard * @param string $title The name of the group * @param int $columns Number of columns */ - public function __construct($title = null, $columns = 1) + public function __construct(?string $title = null, int $columns = 1) { if ($title === null) { $title = __d('CrudView', 'Dashboard'); @@ -34,7 +34,7 @@ public function __construct($title = null, $columns = 1) * @param int $column a column number * @return array */ - public function getColumnChildren($column) + public function getColumnChildren(int $column): array { $children = $this->get('children'); if (isset($children[$column])) { @@ -51,7 +51,7 @@ public function getColumnChildren($column) * @param int $column a column number * @return $this */ - public function addToColumn(Cell $module, $column = 1) + public function addToColumn(Cell $module, int $column = 1) { $children = $this->get('children'); $children[$column][] = $module; @@ -67,7 +67,7 @@ public function addToColumn(Cell $module, $column = 1) * @return int * @throws \InvalidArgumentException the column count is invalid */ - protected function _setColumns($value) + protected function _setColumns(int $value) { $columnMap = [ 1 => 12, diff --git a/src/Dashboard/Module/LinkItem.php b/src/Dashboard/Module/LinkItem.php index e156af83..eec60d11 100644 --- a/src/Dashboard/Module/LinkItem.php +++ b/src/Dashboard/Module/LinkItem.php @@ -41,7 +41,7 @@ class LinkItem * external URL (starts with http://) * @param array $options Array of options and HTML attributes. */ - public function __construct($title, $url, $options = []) + public function __construct($title, $url, array $options = []) { $this->set('title', $title); $this->set('url', $url); @@ -52,7 +52,7 @@ public function __construct($title, $url, $options = []) * title property setter * * @param string|array|null $title A title for the link - * @return string + * @return string|array */ protected function _setTitle($title) { diff --git a/src/Listener/Traits/DeprecatedConfigurationKeyTrait.php b/src/Listener/Traits/DeprecatedConfigurationKeyTrait.php index 4907d16a..a6fb59aa 100644 --- a/src/Listener/Traits/DeprecatedConfigurationKeyTrait.php +++ b/src/Listener/Traits/DeprecatedConfigurationKeyTrait.php @@ -12,7 +12,7 @@ trait DeprecatedConfigurationKeyTrait * @param string $newKey Name of key that should be used instead of the deprecated key * @return void **/ - protected function deprecatedScaffoldKeyNotice($deprecatedKey, $newKey) + protected function deprecatedScaffoldKeyNotice(string $deprecatedKey, strin $newKey): void { $template = 'The configuration key %s has been deprecated. Use %s instead.'; $message = sprintf($template, $deprecatedKey, $newKey); diff --git a/src/Listener/Traits/FormTypeTrait.php b/src/Listener/Traits/FormTypeTrait.php index ecc0df97..10f16870 100644 --- a/src/Listener/Traits/FormTypeTrait.php +++ b/src/Listener/Traits/FormTypeTrait.php @@ -3,6 +3,8 @@ namespace CrudView\Listener\Traits; +use Cake\Controller\Controller; +use Crud\Action\BaseAction; use Crud\Action\EditAction; trait FormTypeTrait @@ -12,7 +14,7 @@ trait FormTypeTrait * * @return void */ - protected function beforeRenderFormType() + protected function beforeRenderFormType(): void { $controller = $this->_controller(); @@ -28,7 +30,7 @@ protected function beforeRenderFormType() * * @return bool */ - protected function _getFormEnableDirtyCheck() + protected function _getFormEnableDirtyCheck(): bool { $action = $this->_action(); @@ -38,9 +40,9 @@ protected function _getFormEnableDirtyCheck() /** * Get form submit button text. * - * @return bool + * @return string */ - protected function _getFormSubmitButtonText() + protected function _getFormSubmitButtonText(): string { $action = $this->_action(); @@ -52,7 +54,7 @@ protected function _getFormSubmitButtonText() * * @return array */ - protected function _getFormSubmitExtraButtons() + protected function _getFormSubmitExtraButtons(): array { $action = $this->_action(); $buttons = $action->getConfig('scaffold.form_submit_extra_buttons'); @@ -73,7 +75,7 @@ protected function _getFormSubmitExtraButtons() * * @return array */ - protected function _getFormSubmitExtraLeftButtons() + protected function _getFormSubmitExtraLeftButtons(): array { $action = $this->_action(); $buttons = $action->getConfig('scaffold.form_submit_extra_left_buttons'); @@ -94,7 +96,7 @@ protected function _getFormSubmitExtraLeftButtons() * * @return array */ - protected function _getDefaultExtraButtons() + protected function _getDefaultExtraButtons(): array { return [ 'save_and_continue' => [ @@ -124,7 +126,7 @@ protected function _getDefaultExtraButtons() * * @return array */ - protected function _getDefaultExtraLeftButtons() + protected function _getDefaultExtraLeftButtons(): array { $buttons = []; @@ -166,10 +168,10 @@ protected function _getFormUrl() /** * {@inheritDoc} */ - abstract protected function _controller(); + abstract protected function _controller(): Controller; /** * {@inheritDoc} */ - abstract protected function _action(?string $name = null); + abstract protected function _action(?string $name = null): BaseAction; } diff --git a/src/Listener/Traits/IndexTypeTrait.php b/src/Listener/Traits/IndexTypeTrait.php index 471674d4..906bcf71 100644 --- a/src/Listener/Traits/IndexTypeTrait.php +++ b/src/Listener/Traits/IndexTypeTrait.php @@ -3,6 +3,9 @@ namespace CrudView\Listener\Traits; +use Cake\Controller\Controller; +use Cake\ORM\Table; +use Crud\Action\BaseAction; use Crud\Action\IndexAction; trait IndexTypeTrait @@ -12,7 +15,7 @@ trait IndexTypeTrait * * @return void */ - public function beforeRenderIndexType() + public function beforeRenderIndexType(): void { if (!($this->_action() instanceof IndexAction)) { return; @@ -32,9 +35,9 @@ public function beforeRenderIndexType() * Returns a list of finder scopes, where the key is the title * and the value is the finder to link to * - * @return string + * @return array */ - protected function _getIndexFinderScopes() + protected function _getIndexFinderScopes(): array { $action = $this->_action(); @@ -45,9 +48,9 @@ protected function _getIndexFinderScopes() * Returns a list of index formats, where the key is the link title * and the value is the url to route to * - * @return string + * @return array */ - protected function _getIndexFormats() + protected function _getIndexFormats(): array { $action = $this->_action(); @@ -59,7 +62,7 @@ protected function _getIndexFormats() * * @return string */ - protected function _getIndexType() + protected function _getIndexType(): string { $action = $this->_action(); @@ -76,7 +79,7 @@ protected function _getIndexType() * * @return string */ - protected function _getIndexTitleField() + protected function _getIndexTitleField(): string { $action = $this->_action(); @@ -93,7 +96,7 @@ protected function _getIndexTitleField() * * @return string */ - protected function _getIndexBodyField() + protected function _getIndexBodyField(): string { $action = $this->_action(); @@ -110,7 +113,7 @@ protected function _getIndexBodyField() * * @return string */ - protected function _getIndexImageField() + protected function _getIndexImageField(): string { $action = $this->_action(); @@ -127,7 +130,7 @@ protected function _getIndexImageField() * * @return string */ - protected function _getIndexGalleryCssClasses() + protected function _getIndexGalleryCssClasses(): string { $action = $this->_action(); @@ -142,15 +145,15 @@ protected function _getIndexGalleryCssClasses() /** * {@inheritDoc} */ - abstract protected function _controller(); + abstract protected function _controller(): Controller; /** * {@inheritDoc} */ - abstract protected function _action(?string $name = null); + abstract protected function _action(?string $name = null): BaseAction; /** * {@inheritDoc} */ - abstract protected function _table(); + abstract protected function _table(): Table; } diff --git a/src/Listener/Traits/SidebarNavigationTrait.php b/src/Listener/Traits/SidebarNavigationTrait.php index 441866d9..482493c2 100644 --- a/src/Listener/Traits/SidebarNavigationTrait.php +++ b/src/Listener/Traits/SidebarNavigationTrait.php @@ -3,6 +3,9 @@ namespace CrudView\Listener\Traits; +use Cake\Controller\Controller; +use Crud\Action\BaseAction; + trait SidebarNavigationTrait { /** @@ -10,7 +13,7 @@ trait SidebarNavigationTrait * * @return void */ - public function beforeRenderSidebarNavigation() + public function beforeRenderSidebarNavigation(): void { $controller = $this->_controller(); $sidebarNavigation = $this->_getSidebarNavigation(); @@ -33,10 +36,10 @@ protected function _getSidebarNavigation() /** * {@inheritDoc} */ - abstract protected function _controller(); + abstract protected function _controller(): Controller; /** * {@inheritDoc} */ - abstract protected function _action(?string $name = null); + abstract protected function _action(?string $name = null): BaseAction; } diff --git a/src/Listener/Traits/SiteTitleTrait.php b/src/Listener/Traits/SiteTitleTrait.php index bc422ba9..02f236bb 100644 --- a/src/Listener/Traits/SiteTitleTrait.php +++ b/src/Listener/Traits/SiteTitleTrait.php @@ -3,7 +3,9 @@ namespace CrudView\Listener\Traits; +use Cake\Controller\Controller; use Cake\Core\Configure; +use Crud\Action\BaseAction; trait SiteTitleTrait { @@ -12,7 +14,7 @@ trait SiteTitleTrait * * @return void */ - public function beforeRenderSiteTitle() + public function beforeRenderSiteTitle(): void { $controller = $this->_controller(); @@ -26,7 +28,7 @@ public function beforeRenderSiteTitle() * * @return string */ - protected function _getSiteTitle() + protected function _getSiteTitle(): string { $action = $this->_action(); @@ -43,7 +45,7 @@ protected function _getSiteTitle() * * @return string */ - protected function _getSiteTitleLink() + protected function _getSiteTitleLink(): string { $action = $this->_action(); @@ -60,7 +62,7 @@ protected function _getSiteTitleLink() * * @return string */ - protected function _getSiteTitleImage() + protected function _getSiteTitleImage(): string { $action = $this->_action(); @@ -75,10 +77,10 @@ protected function _getSiteTitleImage() /** * {@inheritDoc} */ - abstract protected function _controller(); + abstract protected function _controller(): Controller; /** * {@inheritDoc} */ - abstract protected function _action(?string $name = null); + abstract protected function _action(?string $name = null): BaseAction; } diff --git a/src/Listener/Traits/UtilityNavigationTrait.php b/src/Listener/Traits/UtilityNavigationTrait.php index e36096b4..18ef73ae 100644 --- a/src/Listener/Traits/UtilityNavigationTrait.php +++ b/src/Listener/Traits/UtilityNavigationTrait.php @@ -3,6 +3,8 @@ namespace CrudView\Listener\Traits; +use Cake\Controller\Controller; +use Crud\Action\BaseAction; use CrudView\Menu\MenuItem; trait UtilityNavigationTrait @@ -12,7 +14,7 @@ trait UtilityNavigationTrait * * @return void */ - public function beforeRenderUtilityNavigation() + public function beforeRenderUtilityNavigation(): void { $controller = $this->_controller(); $controller->set('utilityNavigation', $this->_getUtilityNavigation()); @@ -23,7 +25,7 @@ public function beforeRenderUtilityNavigation() * * @return array */ - protected function _getUtilityNavigation() + protected function _getUtilityNavigation(): array { $action = $this->_action(); @@ -41,10 +43,10 @@ protected function _getUtilityNavigation() /** * {@inheritDoc} */ - abstract protected function _controller(); + abstract protected function _controller(): Controller; /** * {@inheritDoc} */ - abstract protected function _action(?string $name = null); + abstract protected function _action(?string $name = null): BaseAction; } diff --git a/src/Listener/ViewListener.php b/src/Listener/ViewListener.php index db1a2a4f..9a8a74bd 100644 --- a/src/Listener/ViewListener.php +++ b/src/Listener/ViewListener.php @@ -38,7 +38,7 @@ class ViewListener extends BaseListener * @param \Cake\Event\EventInterface $event Event. * @return void */ - public function beforeFind(EventInterface $event) + public function beforeFind(EventInterface $event): void { $related = $this->_getRelatedModels(); if ($related === []) { @@ -58,7 +58,7 @@ public function beforeFind(EventInterface $event) * @param \Cake\Event\EventInterface $event Event. * @return void */ - public function beforePaginate(EventInterface $event) + public function beforePaginate(EventInterface $event): void { $related = $this->_getRelatedModels(); if ($related === []) { @@ -78,7 +78,7 @@ public function beforePaginate(EventInterface $event) * @param \Cake\Event\EventInterface $event Event. * @return void */ - public function beforeRender(EventInterface $event) + public function beforeRender(EventInterface $event): void { if ($this->_controller()->getName() === 'Error') { return; @@ -126,7 +126,7 @@ public function beforeRender(EventInterface $event) * @param \Cake\Event\EventInterface $event Event. * @return void */ - public function setFlash(EventInterface $event) + public function setFlash(EventInterface $event): void { unset($event->getSubject()->params['class']); $event->getSubject()->element = ltrim($event->getSubject()->type); @@ -137,7 +137,7 @@ public function setFlash(EventInterface $event) * * @return string */ - protected function _getPageTitle() + protected function _getPageTitle(): string { $action = $this->_action(); @@ -178,7 +178,7 @@ protected function _getPageTitle() * * @return array */ - protected function _getBreadcrumbs() + protected function _getBreadcrumbs(): array { $action = $this->_action(); @@ -197,7 +197,7 @@ protected function _getBreadcrumbs() * @param string[] $associationTypes List of association types. * @return array */ - protected function _getRelatedModels($associationTypes = []) + protected function _getRelatedModels(array $associationTypes = []): array { $models = $this->_action()->getConfig('scaffold.relations'); @@ -246,7 +246,7 @@ protected function _getRelatedModels($associationTypes = []) * * @return array */ - protected function _blacklist() + protected function _blacklist(): array { return (array)$this->_action()->getConfig('scaffold.fields_blacklist'); } @@ -256,7 +256,7 @@ protected function _blacklist() * * @return array */ - protected function _getPageVariables() + protected function _getPageVariables(): array { $table = $this->_table(); $modelClass = $table->getAlias(); @@ -298,7 +298,7 @@ protected function _getPageVariables() * @param array $associations Associations list. * @return array */ - protected function _scaffoldFields(array $associations = []) + protected function _scaffoldFields(array $associations = []): array { $action = $this->_action(); $scaffoldFields = (array)$action->getConfig('scaffold.fields'); @@ -352,7 +352,7 @@ protected function _scaffoldFields(array $associations = []) * * @return string */ - protected function _controllerName() + protected function _controllerName(): string { $inflections = [ 'underscore', @@ -377,7 +377,7 @@ protected function _controllerName() * * @return array */ - protected function _getControllerActions() + protected function _getControllerActions(): array { $table = $entity = []; @@ -426,7 +426,7 @@ protected function _getControllerActions() * @param array $config Config array. * @return array */ - protected function _getControllerActionConfiguration($actionName, $config) + protected function _getControllerActionConfiguration(string $actionName, array $config): array { $realAction = Hash::get($config, 'url.action', $actionName); $url = ['action' => $realAction]; @@ -479,7 +479,7 @@ protected function _getControllerActionConfiguration($actionName, $config) * * @return array */ - protected function _getAllowedActions() + protected function _getAllowedActions(): array { $actions = $this->_action()->getConfig('scaffold.actions'); if ($actions === null) { @@ -516,7 +516,7 @@ protected function _getAllowedActions() * @param array $actions Actions * @return array */ - protected function _normalizeActions($actions) + protected function _normalizeActions(array $actions): array { $normalized = []; foreach ($actions as $key => $config) { @@ -536,7 +536,7 @@ protected function _normalizeActions($actions) * @param array $whitelist Whitelist of associations to return. * @return array Associations for model */ - protected function _associations(array $whitelist = []) + protected function _associations(array $whitelist = []): array { $table = $this->_table(); @@ -608,7 +608,7 @@ protected function _primaryKeyValue() * * @return string|null */ - protected function _displayFieldValue() + protected function _displayFieldValue(): ?string { return $this->_deriveFieldFromContext($this->_table()->getDisplayField()); } @@ -620,7 +620,7 @@ protected function _displayFieldValue() * @param string $field Name of field. * @return mixed */ - protected function _deriveFieldFromContext($field) + protected function _deriveFieldFromContext(string $field) { $controller = $this->_controller(); $modelClass = $this->_table()->getAlias(); @@ -650,7 +650,7 @@ protected function _deriveFieldFromContext($field) * * @return array */ - protected function _getViewBlocks() + protected function _getViewBlocks(): array { $action = $this->_action(); @@ -662,7 +662,7 @@ protected function _getViewBlocks() * * @return array */ - protected function _getBulkActions() + protected function _getBulkActions(): array { $action = $this->_action(); @@ -674,7 +674,7 @@ protected function _getBulkActions() * * @return array */ - protected function _getActionGroups() + protected function _getActionGroups(): array { $action = $this->_action(); $groups = $action->getConfig('scaffold.action_groups') ?: []; @@ -697,7 +697,7 @@ protected function _getActionGroups() * @param array $fields Form fields. * @return array */ - protected function _getFormTabGroups(array $fields = []) + protected function _getFormTabGroups(array $fields = []): array { $action = $this->_action(); $groups = $action->getConfig('scaffold.form_tab_groups'); diff --git a/src/Listener/ViewSearchListener.php b/src/Listener/ViewSearchListener.php index 0d851e34..cb6ca0f9 100644 --- a/src/Listener/ViewSearchListener.php +++ b/src/Listener/ViewSearchListener.php @@ -53,7 +53,7 @@ public function implementedEvents(): array * @param \Cake\Event\EventInterface $event Event. * @return void */ - public function afterPaginate(EventInterface $event) + public function afterPaginate(EventInterface $event): void { $event; if (!$this->_table()->behaviors()->has('Search')) { @@ -77,7 +77,7 @@ public function afterPaginate(EventInterface $event) * * @return array */ - public function fields() + public function fields(): array { return $this->getConfig('fields') ?: $this->_deriveFields(); } @@ -87,7 +87,7 @@ public function fields() * * @return array */ - protected function _deriveFields() + protected function _deriveFields(): array { $config = $this->getConfig(); $table = $this->_table(); diff --git a/src/Menu/MenuDropdown.php b/src/Menu/MenuDropdown.php index 6c366e96..00d16895 100644 --- a/src/Menu/MenuDropdown.php +++ b/src/Menu/MenuDropdown.php @@ -25,7 +25,7 @@ class MenuDropdown * @param string $title The name of the dropdown * @param array $entries Array of MenuDivider|MenuItem entries */ - public function __construct($title, array $entries = []) + public function __construct(string $title, array $entries = []) { $this->title = $title; $this->entries = $entries; @@ -36,7 +36,7 @@ public function __construct($title, array $entries = []) * * @return string */ - public function getTitle() + public function getTitle(): string { return $this->title; } @@ -46,7 +46,7 @@ public function getTitle() * * @return array */ - public function getEntries() + public function getEntries(): array { return $this->entries; } diff --git a/src/Menu/MenuItem.php b/src/Menu/MenuItem.php index 5a5d06f4..0746a141 100644 --- a/src/Menu/MenuItem.php +++ b/src/Menu/MenuItem.php @@ -35,7 +35,7 @@ class MenuItem * external URL (starts with http://) * @param array $options Array of options and HTML attributes. */ - public function __construct($title, $url = null, array $options = []) + public function __construct(string $title, $url = null, array $options = []) { $this->title = $title; $this->url = $url; @@ -47,7 +47,7 @@ public function __construct($title, $url = null, array $options = []) * * @return string */ - public function getTitle() + public function getTitle(): string { return $this->title; } @@ -67,7 +67,7 @@ public function getUrl() * * @return array */ - public function getOptions() + public function getOptions(): array { return $this->options; } diff --git a/src/Traits/CrudViewConfigTrait.php b/src/Traits/CrudViewConfigTrait.php index feac1ce2..1f974a13 100644 --- a/src/Traits/CrudViewConfigTrait.php +++ b/src/Traits/CrudViewConfigTrait.php @@ -14,7 +14,7 @@ trait CrudViewConfigTrait * * @return bool */ - public function ensureConfig() + public function ensureConfig(): bool { $config = Configure::read('CrudView'); if ($config !== null) { diff --git a/src/View/Cell/DashboardTableCell.php b/src/View/Cell/DashboardTableCell.php index b4ca64f0..386ae294 100644 --- a/src/View/Cell/DashboardTableCell.php +++ b/src/View/Cell/DashboardTableCell.php @@ -20,7 +20,7 @@ class DashboardTableCell extends Cell * @param array $links A array of LinkItem objects * @return void */ - public function display($title, array $links = []) + public function display($title, array $links = []): void { if (is_array($title)) { $links = $title; diff --git a/src/View/Cell/TablesListCell.php b/src/View/Cell/TablesListCell.php index 6650ca13..ecf10fdf 100644 --- a/src/View/Cell/TablesListCell.php +++ b/src/View/Cell/TablesListCell.php @@ -16,7 +16,7 @@ class TablesListCell extends Cell * @param array $blacklist Blacklisted tables list. * @return $this */ - public function display($tables = null, $blacklist = null) + public function display(?array $tables = null, ?array $blacklist = null) { if (empty($tables)) { $connection = ConnectionManager::get('default'); diff --git a/src/View/CrudView.php b/src/View/CrudView.php index 4b91aef1..676089c3 100644 --- a/src/View/CrudView.php +++ b/src/View/CrudView.php @@ -63,7 +63,7 @@ public function implementedEvents(): array * * @return void */ - public function beforeLayout() + public function beforeLayout(): void { $this->_loadAssets(); } @@ -75,7 +75,7 @@ public function beforeLayout() * * @return void */ - protected function _loadAssets() + protected function _loadAssets(): void { if (Configure::read('CrudView.useAssetCompress')) { $this->AssetCompress->css('CrudView.crudview', ['block' => true]); @@ -106,7 +106,7 @@ protected function _loadAssets() * * @return void */ - protected function _setupHelpers() + protected function _setupHelpers(): void { $helpers = [ 'Html' => ['className' => 'BootstrapUI.Html'], @@ -137,7 +137,7 @@ protected function _setupHelpers() * * @return void */ - protected function _setupPaths() + protected function _setupPaths(): void { $paths = Configure::read('App.paths.templates'); @@ -193,7 +193,7 @@ public function exists(string $name): bool * * @return string */ - protected function _createViewblock($data) + protected function _createViewblock(array $data): string { $output = ''; foreach ($data as $key => $type) { diff --git a/src/View/Helper/CrudViewHelper.php b/src/View/Helper/CrudViewHelper.php index 2f5e70c4..1bfa976f 100644 --- a/src/View/Helper/CrudViewHelper.php +++ b/src/View/Helper/CrudViewHelper.php @@ -3,6 +3,7 @@ namespace CrudView\View\Helper; +use Cake\Database\Schema\TableSchemaInterface; use Cake\Datasource\EntityInterface; use Cake\Utility\Inflector; use Cake\Utility\Text; @@ -28,7 +29,7 @@ class CrudViewHelper extends Helper /** * Context * - * @var \Cake\Datasource\EntityInterface + * @var \Cake\Datasource\EntityInterface|null */ protected $_context; @@ -47,7 +48,7 @@ class CrudViewHelper extends Helper * @param \Cake\Datasource\EntityInterface $record Entity. * @return void */ - public function setContext(EntityInterface $record) + public function setContext(EntityInterface $record): void { $this->_context = $record; } @@ -55,9 +56,9 @@ public function setContext(EntityInterface $record) /** * Get context * - * @return \Cake\Datasource\EntityInterface + * @return \Cake\Datasource\EntityInterface|null */ - public function getContext() + public function getContext(): ?EntityInterface { return $this->_context; } @@ -70,7 +71,7 @@ public function getContext() * @param array $options Processing options. * @return string|null|array|bool|int */ - public function process($field, EntityInterface $data, array $options = []) + public function process(string $field, EntityInterface $data, array $options = []) { $this->setContext($data); @@ -106,7 +107,7 @@ public function process($field, EntityInterface $data, array $options = []) * @param string $field The field to extract, if null, the field from the entity context is used. * @return mixed */ - public function fieldValue(EntityInterface $data, $field) + public function fieldValue(EntityInterface $data, string $field) { if (empty($data)) { $data = $this->getContext(); @@ -123,7 +124,7 @@ public function fieldValue(EntityInterface $data, $field) * @param array $options Options array. * @return array|bool|null|int|string */ - public function introspect($field, $value, array $options = []) + public function introspect(string $field, $value, array $options = []) { $output = $this->relation($field); if ($output) { @@ -168,7 +169,7 @@ public function introspect($field, $value, array $options = []) * @param string $field Field to get column type for * @return string */ - public function columnType($field) + public function columnType(string $field): string { $schema = $this->schema(); @@ -183,7 +184,7 @@ public function columnType($field) * @param array $options Options array * @return string */ - public function formatBoolean($field, $value, $options) + public function formatBoolean(string $field, $value, array $options): string { return (bool)$value ? $this->Html->label(__d('crud', 'Yes'), ['type' => empty($options['inverted']) ? 'success' : 'danger']) : @@ -198,7 +199,7 @@ public function formatBoolean($field, $value, $options) * @param array $options Options array. * @return string */ - public function formatDate($field, $value, array $options) + public function formatDate(string $field, $value, array $options): string { if ($value === null) { return $this->Html->label(__d('crud', 'N/A'), ['type' => 'info']); @@ -219,7 +220,7 @@ public function formatDate($field, $value, array $options) * @param array $options Options array. * @return string */ - public function formatTime($field, $value, array $options) + public function formatTime(string $field, $value, array $options): string { if ($value === null) { return $this->Html->label(__d('crud', 'N/A'), ['type' => 'info']); @@ -240,7 +241,7 @@ public function formatTime($field, $value, array $options) * @param mixed $value Value of field. * @return string */ - public function formatString($field, $value) + public function formatString(string $field, $value): string { return h(Text::truncate((string)$value, 200)); } @@ -252,7 +253,7 @@ public function formatString($field, $value) * @param array $options Options array. * @return string */ - public function formatDisplayField($value, array $options) + public function formatDisplayField($value, array $options): string { return $this->createViewLink($value, ['escape' => false]); } @@ -263,7 +264,7 @@ public function formatDisplayField($value, array $options) * @param string $field Name of field. * @return mixed Array of data to output, false if no match found */ - public function relation($field) + public function relation(string $field) { $associations = $this->associations(); if (empty($associations['manyToOne'])) { @@ -307,7 +308,7 @@ public function relation($field) * * @return string|null */ - public function redirectUrl() + public function redirectUrl(): ?string { $redirectUrl = $this->getView()->getRequest()->getQuery('_redirect_url'); $redirectUrlViewVar = $this->getViewVar('_redirect_url'); @@ -341,7 +342,7 @@ public function redirectUrl() * @param array $options Options array to be passed to the link function * @return string */ - public function createRelationLink($alias, $relation, $options = []) + public function createRelationLink(string $alias, array $relation, array $options = []): string { return $this->Html->link( __d('crud', 'Add {0}', [Inflector::singularize(Inflector::humanize(Inflector::underscore($alias)))]), @@ -365,7 +366,7 @@ public function createRelationLink($alias, $relation, $options = []) * @param array $options Options array to be passed to the link function * @return string */ - public function createViewLink($title, $options = []) + public function createViewLink(string $title, array $options = []): string { return $this->Html->link( $title, @@ -379,7 +380,7 @@ public function createViewLink($title, $options = []) * * @return string */ - public function currentModel() + public function currentModel(): string { return $this->getViewVar('modelClass'); } @@ -389,7 +390,7 @@ public function currentModel() * * @return \Cake\Database\Schema\TableSchemaInterface */ - public function schema() + public function schema(): TableSchemaInterface { return $this->getViewVar('modelSchema'); } @@ -399,7 +400,7 @@ public function schema() * * @return string */ - public function viewVar() + public function viewVar(): string { return $this->getViewVar('viewVar'); } @@ -409,9 +410,9 @@ public function viewVar() * * @return array List of associations. */ - public function associations() + public function associations(): array { - return $this->getViewVar('associations'); + return $this->getViewVar('associations') ?? []; } /** @@ -420,7 +421,7 @@ public function associations() * @param string $key View variable to get. * @return mixed */ - public function getViewVar($key) + public function getViewVar(string $key) { return $this->_View->get($key); } @@ -430,7 +431,7 @@ public function getViewVar($key) * * @return string */ - public function getCssClasses() + public function getCssClasses(): string { $action = (string)$this->getView()->getRequest()->getParam('action'); $pluralVar = $this->getViewVar('pluralVar'); @@ -438,6 +439,7 @@ public function getCssClasses() $args = func_get_args(); return implode( + ' ', array_unique(array_merge( [ 'scaffold-action', @@ -447,8 +449,7 @@ public function getCssClasses() ], $args, $viewClasses - )), - ' ' + )) ); } } diff --git a/src/View/Widget/DateTimeWidget.php b/src/View/Widget/DateTimeWidget.php index bf2df214..efa16e2f 100644 --- a/src/View/Widget/DateTimeWidget.php +++ b/src/View/Widget/DateTimeWidget.php @@ -144,7 +144,7 @@ public function render(array $data, ContextInterface $context): string * @return string flatpickr date format. * @see https://flatpickr.js.org/formatting/ */ - protected function convertPHPToDatePickerFormat(string $format) + protected function convertPHPToDatePickerFormat(string $format): string { $replacements = [ 's' => 'S', From fe21122ddd5f61c3739a7ca854702a906642d8c5 Mon Sep 17 00:00:00 2001 From: ADmad Date: Fri, 25 Oct 2019 14:10:00 +0530 Subject: [PATCH 40/91] Fix errors reported by phpstan --- phpstan.neon | 2 +- src/View/Helper/CrudViewHelper.php | 6 +++--- tests/TestCase/View/Helper/CrudViewHelperTest.php | 8 +++++++- 3 files changed, 11 insertions(+), 5 deletions(-) diff --git a/phpstan.neon b/phpstan.neon index 9c26a69e..92f663c5 100644 --- a/phpstan.neon +++ b/phpstan.neon @@ -1,5 +1,5 @@ parameters: - level: 5 + level: 7 universalObjectCratesClasses: - Crud\Event\Subject ignoreErrors: diff --git a/src/View/Helper/CrudViewHelper.php b/src/View/Helper/CrudViewHelper.php index 1bfa976f..cc0fa48f 100644 --- a/src/View/Helper/CrudViewHelper.php +++ b/src/View/Helper/CrudViewHelper.php @@ -29,7 +29,7 @@ class CrudViewHelper extends Helper /** * Context * - * @var \Cake\Datasource\EntityInterface|null + * @var \Cake\Datasource\EntityInterface */ protected $_context; @@ -56,9 +56,9 @@ public function setContext(EntityInterface $record): void /** * Get context * - * @return \Cake\Datasource\EntityInterface|null + * @return \Cake\Datasource\EntityInterface */ - public function getContext(): ?EntityInterface + public function getContext(): EntityInterface { return $this->_context; } diff --git a/tests/TestCase/View/Helper/CrudViewHelperTest.php b/tests/TestCase/View/Helper/CrudViewHelperTest.php index 8cebf7ec..70998e9a 100644 --- a/tests/TestCase/View/Helper/CrudViewHelperTest.php +++ b/tests/TestCase/View/Helper/CrudViewHelperTest.php @@ -4,6 +4,7 @@ namespace CrudView\Test\TestCase\View\Helper; use Cake\I18n\FrozenTime; +use Cake\ORM\Entity; use Cake\TestSuite\TestCase; use Cake\View\View; use CrudView\View\Helper\CrudViewHelper; @@ -47,9 +48,14 @@ public function testIntrospect() { $this->CrudView = $this->getMockBuilder(CrudViewHelper::class) ->setConstructorArgs([$this->View]) - ->setMethods(['columnType']) + ->setMethods(['columnType', 'getContext']) ->getMock(); + $this->CrudView + ->expects($this->any()) + ->method('getContext') + ->will($this->returnValue(new Entity())); + $this->CrudView ->expects($this->any()) ->method('columnType') From a6e6ada24429c4a48178cd58ee20894595a55cf8 Mon Sep 17 00:00:00 2001 From: ADmad Date: Fri, 25 Oct 2019 17:28:59 +0530 Subject: [PATCH 41/91] Fix return type --- src/Listener/ViewListener.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Listener/ViewListener.php b/src/Listener/ViewListener.php index 9a8a74bd..3c0c87fe 100644 --- a/src/Listener/ViewListener.php +++ b/src/Listener/ViewListener.php @@ -606,9 +606,9 @@ protected function _primaryKeyValue() * * If no value can be found, NULL is returned * - * @return string|null + * @return string|int|null */ - protected function _displayFieldValue(): ?string + protected function _displayFieldValue() { return $this->_deriveFieldFromContext($this->_table()->getDisplayField()); } From bdcf70639ae6d68242db63329cb09382feb8faa1 Mon Sep 17 00:00:00 2001 From: ADmad Date: Sat, 26 Oct 2019 18:21:14 +0530 Subject: [PATCH 42/91] Implement autocomplete using select2. Removed selectize. --- config/defaults.php | 2 -- webroot/js/local.js | 67 +++++++++++++++++++++++---------------------- 2 files changed, 35 insertions(+), 34 deletions(-) diff --git a/config/defaults.php b/config/defaults.php index 5cacdbd8..85ee57ae 100644 --- a/config/defaults.php +++ b/config/defaults.php @@ -10,7 +10,6 @@ 'css' => [ 'https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.4/css/bootstrap.css', 'https://cdn.jsdelivr.net/npm/flatpickr@4.6.3/dist/flatpickr.min.css', - 'https://cdnjs.cloudflare.com/ajax/libs/selectize.js/0.12.2/css/selectize.bootstrap3.min.css', 'https://cdn.jsdelivr.net/npm/select2@4.0/dist/css/select2.min.css', 'https://cdn.jsdelivr.net/npm/@ttskch/select2-bootstrap4-theme@1.2/dist/select2-bootstrap4.css', 'CrudView.local', @@ -20,7 +19,6 @@ 'https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js', 'https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.4/js/bootstrap.min.js', 'https://cdn.jsdelivr.net/npm/flatpickr@4.6', - 'https://cdnjs.cloudflare.com/ajax/libs/selectize.js/0.12.2/js/standalone/selectize.min.js', 'https://cdn.jsdelivr.net/npm/select2@4.0', 'https://cdn.jsdelivr.net/jquery.dirtyforms/1.2.2/jquery.dirtyforms.min.js', ], diff --git a/webroot/js/local.js b/webroot/js/local.js index f9dd1ef1..19ef8617 100644 --- a/webroot/js/local.js +++ b/webroot/js/local.js @@ -36,41 +36,44 @@ var CrudView = { }, autocomplete: function (selector) { - $(selector).each(function (i, e) { - e = $(e); - e.selectize({ - maxItems: e.data('max-items') || 1, - maxOptions: e.data('max-options') || 10, - hideSelected: e.data('hide-selected'), - closeAfterSelect: e.data('close-after-select'), - create: !e.data('exact-match'), - persist: false, - render: { - 'option_create': function(data, escape) { - return '
        🔍 ' + escape(data.input) + '…
        '; - } - }, - load: function (query, callback) { - var data = {}; + $(selector).each(function (i, ele) { + var $ele = $(ele); - data[e.data('filter-field') || e.attr('name')] = query; + $ele.select2({ + theme: 'bootstrap4', + minimumInputLength: 1, + ajax: { + delay: 250, + url: $ele.data('url'), + dataType: 'json', + data: function (params) { + var query = {}; + query[$ele.data('filter-field') || $ele.attr('name')] = params.term; - if (e.data('dependent-on') && $('#' + e.data('dependent-on')).val()) { - data[e.data('dependent-on-field')] = $('#' + e.data('dependent-on')).val(); - } - $.ajax({ - url: e.data('url'), - dataType: 'json', - data: data, - error: function () { - callback(); - }, - success: function (res) { - callback($.map(res.data, function (name, id) { - return {value: id, text: name}; - })); + if ($ele.data('dependent-on') && $('#' + $ele.data('dependent-on')).val()) { + data[$ele.data('dependent-on-field')] = $('#' + $ele.data('dependent-on')).val(); } - }); + + return query; + }, + processResults: function (data, params) { + var results = []; + + if (data.data) { + $.each(data.data, function(id, text) { + if (text.indexOf(params.term) > -1) { + results.push({ + id: id, + text: text + }); + } + }); + } + + return { + results: results + }; + } } }); }); From d5e901bd47f7f89f6e94e0f3e856ddac1f4e9d3d Mon Sep 17 00:00:00 2001 From: ADmad Date: Sat, 26 Oct 2019 18:32:39 +0530 Subject: [PATCH 43/91] Replace "selectize" with "select2" --- src/Listener/ViewSearchListener.php | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/Listener/ViewSearchListener.php b/src/Listener/ViewSearchListener.php index cb6ca0f9..8c48c388 100644 --- a/src/Listener/ViewSearchListener.php +++ b/src/Listener/ViewSearchListener.php @@ -16,7 +16,7 @@ class ViewSearchListener extends BaseListener * * - `enabled`: Indicates whether is listener is enabled. * - `autocomplete`: Whether to use auto complete for select fields. Default `true`. - * - `selectize`: Whether to use selectize for select fields. Default `true`. + * - `select2`: Whether to use select2 for select fields. Default `true`. * - `collection`: The search behavior collection to use. Default "default". * - `fields`: Config for generating filter controls. If `null` the * filter controls will be derived based on filter collection. You can use @@ -27,7 +27,7 @@ class ViewSearchListener extends BaseListener protected $_defaultConfig = [ 'enabled' => null, 'autocomplete' => true, - 'selectize' => true, + 'select2' => true, 'collection' => 'default', 'fields' => null, ]; @@ -131,8 +131,8 @@ protected function _deriveFields(): array if (!empty($input['options'])) { $input['empty'] = true; - if (empty($input['class']) && !$config['selectize']) { - $input['class'] = 'no-selectize'; + if (empty($input['class']) && !$config['select2']) { + $input['class'] = 'no-select2'; } $fields[$field] = $input; From bef35d9b9cd4edb8de6388b6d441d2d9397a5297 Mon Sep 17 00:00:00 2001 From: ADmad Date: Sun, 27 Oct 2019 09:43:12 +0530 Subject: [PATCH 44/91] Select2 only works with selects. --- src/Listener/ViewSearchListener.php | 8 ++++++++ webroot/js/local.js | 3 ++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/src/Listener/ViewSearchListener.php b/src/Listener/ViewSearchListener.php index 8c48c388..40634239 100644 --- a/src/Listener/ViewSearchListener.php +++ b/src/Listener/ViewSearchListener.php @@ -144,6 +144,14 @@ protected function _deriveFields(): array $input['class'] = 'autocomplete'; } + if ( + strpos($input['class'], 'autocomplete') !== false + && $input['type'] !== 'select' + ) { + $input['data-input-type'] = 'text'; + $input['type'] = 'select'; + } + $urlArgs = []; $fieldKeys = $input['fields'] ?? ['id' => $field, 'value' => $field]; diff --git a/webroot/js/local.js b/webroot/js/local.js index 19ef8617..f35077a3 100644 --- a/webroot/js/local.js +++ b/webroot/js/local.js @@ -58,12 +58,13 @@ var CrudView = { }, processResults: function (data, params) { var results = []; + var inputType = $ele.data('inputType'); if (data.data) { $.each(data.data, function(id, text) { if (text.indexOf(params.term) > -1) { results.push({ - id: id, + id: inputType === 'text' ? text : id, text: text }); } From 94947f41c51063175a92d04c11b7f98c6231168d Mon Sep 17 00:00:00 2001 From: ADmad Date: Sun, 27 Oct 2019 09:59:13 +0530 Subject: [PATCH 45/91] Merge defaults even when "fields" config is set. --- phpstan.neon | 6 ++++ src/Listener/ViewSearchListener.php | 43 ++++++++++------------------- 2 files changed, 21 insertions(+), 28 deletions(-) diff --git a/phpstan.neon b/phpstan.neon index 92f663c5..2dd6ce2e 100644 --- a/phpstan.neon +++ b/phpstan.neon @@ -10,3 +10,9 @@ parameters: - message: '#Call to an undefined method Cake\\ORM\\Table::searchManager\(\)#' path: 'src/Listener/ViewSearchListener.php' + - + message: '#Result of && is always false#' + path: 'src/Listener/ViewSearchListener.php' + - + message: "#Strict comparison using !== between 'select' and 'select' will always evaluate to false#" + path: 'src/Listener/ViewSearchListener.php' diff --git a/src/Listener/ViewSearchListener.php b/src/Listener/ViewSearchListener.php index 40634239..3175c8db 100644 --- a/src/Listener/ViewSearchListener.php +++ b/src/Listener/ViewSearchListener.php @@ -55,7 +55,6 @@ public function implementedEvents(): array */ public function afterPaginate(EventInterface $event): void { - $event; if (!$this->_table()->behaviors()->has('Search')) { return; } @@ -79,35 +78,26 @@ public function afterPaginate(EventInterface $event): void */ public function fields(): array { - return $this->getConfig('fields') ?: $this->_deriveFields(); - } - - /** - * Derive field options for search filter inputs based on filter collection. - * - * @return array - */ - protected function _deriveFields(): array - { + $fields = $this->getConfig('fields') ?: []; $config = $this->getConfig(); - $table = $this->_table(); - if (method_exists($table, 'searchConfiguration')) { - $searchManager = $table->searchConfiguration(); - } else { - $searchManager = $table->searchManager(); - } - - $fields = []; - $schema = $table->getSchema(); + $schema = $this->_table()->getSchema(); $request = $this->_request(); - foreach ($searchManager->getFilters($config['collection']) as $filter) { - if ($filter->getConfig('form') === false) { - continue; + if (!$fields) { + $filters = $this->_table()->searchManager()->getFilters($config['collection']); + + foreach ($filters as $filter) { + $opts = $filter->getConfig('form'); + if ($opts === false) { + continue; + } + + $fields[$filter->name()] = $opts ?: []; } + } - $field = $filter->name(); + foreach ($fields as $field => $opts) { $input = [ 'required' => false, 'type' => 'text', @@ -117,10 +107,7 @@ protected function _deriveFields(): array $input['type'] = 'select'; } - $filterFormConfig = $filter->getConfig('form'); - if (!empty($filterFormConfig)) { - $input = $filterFormConfig + $input; - } + $input = $opts + $input; $input['value'] = $request->getQuery($field); From 84b00256272616e9b930ae877c7e44b81fa60d4d Mon Sep 17 00:00:00 2001 From: ADmad Date: Sun, 27 Oct 2019 15:01:29 +0530 Subject: [PATCH 46/91] Fix return value --- src/Traits/CrudViewConfigTrait.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Traits/CrudViewConfigTrait.php b/src/Traits/CrudViewConfigTrait.php index 1f974a13..40203595 100644 --- a/src/Traits/CrudViewConfigTrait.php +++ b/src/Traits/CrudViewConfigTrait.php @@ -18,7 +18,7 @@ public function ensureConfig(): bool { $config = Configure::read('CrudView'); if ($config !== null) { - return $config; + return true; } return Configure::load('CrudView.defaults'); From f148009ab8e2d1b9865172e5502d9981986a40e1 Mon Sep 17 00:00:00 2001 From: ADmad Date: Sun, 27 Oct 2019 15:14:13 +0530 Subject: [PATCH 47/91] Set min. size for autocomplete --- webroot/css/local.css | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/webroot/css/local.css b/webroot/css/local.css index 569fa920..bd0c1cd4 100644 --- a/webroot/css/local.css +++ b/webroot/css/local.css @@ -69,8 +69,8 @@ h2 .actions { min-width: 90px !important; } -.selectize-input.items.full { - padding-right:33px; +.search-filters .form-inline select.autocomplete { + min-width: 150px; } .text-truncate { From 6b437a702bdbbe4c00962208f7a7a79d3587f40e Mon Sep 17 00:00:00 2001 From: ADmad Date: Sun, 27 Oct 2019 15:14:50 +0530 Subject: [PATCH 48/91] Enable "tags" option to allow adding custom value for autocomplete --- src/Listener/ViewSearchListener.php | 1 + 1 file changed, 1 insertion(+) diff --git a/src/Listener/ViewSearchListener.php b/src/Listener/ViewSearchListener.php index 3175c8db..c921c7af 100644 --- a/src/Listener/ViewSearchListener.php +++ b/src/Listener/ViewSearchListener.php @@ -137,6 +137,7 @@ public function fields(): array ) { $input['data-input-type'] = 'text'; $input['type'] = 'select'; + $input['data-tags'] = 'true'; } $urlArgs = []; From 49e476d4d2e52c7191e44535504047fa5778f387 Mon Sep 17 00:00:00 2001 From: ADmad Date: Sun, 27 Oct 2019 15:19:51 +0530 Subject: [PATCH 49/91] Allow clearing autocomplete input --- src/Listener/ViewSearchListener.php | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/src/Listener/ViewSearchListener.php b/src/Listener/ViewSearchListener.php index c921c7af..b7cefd84 100644 --- a/src/Listener/ViewSearchListener.php +++ b/src/Listener/ViewSearchListener.php @@ -135,9 +135,14 @@ public function fields(): array strpos($input['class'], 'autocomplete') !== false && $input['type'] !== 'select' ) { - $input['data-input-type'] = 'text'; $input['type'] = 'select'; - $input['data-tags'] = 'true'; + + $input += [ + 'data-input-type' => 'text', + 'data-tags' => 'true', + 'data-allow-clear' => 'true', + 'data-placeholder' => '', + ]; } $urlArgs = []; From f13c09b987ce5063b823dfd41d8baf87fd46b34d Mon Sep 17 00:00:00 2001 From: ADmad Date: Sun, 27 Oct 2019 18:38:19 +0530 Subject: [PATCH 50/91] Fix selection of current value for autocomplete --- src/Listener/ViewSearchListener.php | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/Listener/ViewSearchListener.php b/src/Listener/ViewSearchListener.php index b7cefd84..ea3bca04 100644 --- a/src/Listener/ViewSearchListener.php +++ b/src/Listener/ViewSearchListener.php @@ -137,6 +137,10 @@ public function fields(): array ) { $input['type'] = 'select'; + if (!empty($input['value'])) { + $input['options'][$input['value']] = $input['value']; + } + $input += [ 'data-input-type' => 'text', 'data-tags' => 'true', From 30993ba7a44e820f3fcaf3702797133e8a2926e3 Mon Sep 17 00:00:00 2001 From: ADmad Date: Sun, 27 Oct 2019 19:55:51 +0530 Subject: [PATCH 51/91] Normalize search filter fields config --- src/Listener/ViewSearchListener.php | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/Listener/ViewSearchListener.php b/src/Listener/ViewSearchListener.php index ea3bca04..7110cc8e 100644 --- a/src/Listener/ViewSearchListener.php +++ b/src/Listener/ViewSearchListener.php @@ -5,6 +5,7 @@ use Cake\Event\EventInterface; use Cake\Routing\Router; +use Cake\Utility\Hash; use Crud\Listener\BaseListener; class ViewSearchListener extends BaseListener @@ -84,7 +85,9 @@ public function fields(): array $schema = $this->_table()->getSchema(); $request = $this->_request(); - if (!$fields) { + if ($fields) { + $fields = Hash::normalize($fields); + } else { $filters = $this->_table()->searchManager()->getFilters($config['collection']); foreach ($filters as $filter) { @@ -107,7 +110,7 @@ public function fields(): array $input['type'] = 'select'; } - $input = $opts + $input; + $input = (array)$opts + $input; $input['value'] = $request->getQuery($field); From cc76f9067306a29b03ebcefd829c4e1c2752dad6 Mon Sep 17 00:00:00 2001 From: ADmad Date: Mon, 28 Oct 2019 14:11:31 +0530 Subject: [PATCH 52/91] Ensure array key exists --- src/Listener/ViewSearchListener.php | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/Listener/ViewSearchListener.php b/src/Listener/ViewSearchListener.php index 7110cc8e..2ff7fcc1 100644 --- a/src/Listener/ViewSearchListener.php +++ b/src/Listener/ViewSearchListener.php @@ -135,7 +135,8 @@ public function fields(): array } if ( - strpos($input['class'], 'autocomplete') !== false + !empty($input['class']) + && strpos($input['class'], 'autocomplete') !== false && $input['type'] !== 'select' ) { $input['type'] = 'select'; From f8045a6ea2b62b6aeb366804639287aabe8d6cce Mon Sep 17 00:00:00 2001 From: ADmad Date: Tue, 29 Oct 2019 19:02:41 +0530 Subject: [PATCH 53/91] Don't add return typhint for event callback methods --- src/View/CrudView.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/View/CrudView.php b/src/View/CrudView.php index 676089c3..4f0844ab 100644 --- a/src/View/CrudView.php +++ b/src/View/CrudView.php @@ -63,7 +63,7 @@ public function implementedEvents(): array * * @return void */ - public function beforeLayout(): void + public function beforeLayout() { $this->_loadAssets(); } From 0e3da40e8cf6df930144562fe122d9340ebe2c82 Mon Sep 17 00:00:00 2001 From: ADmad Date: Thu, 31 Oct 2019 14:33:46 +0530 Subject: [PATCH 54/91] Use case insensitive match --- webroot/js/local.js | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/webroot/js/local.js b/webroot/js/local.js index f35077a3..f1a2d5fe 100644 --- a/webroot/js/local.js +++ b/webroot/js/local.js @@ -57,12 +57,13 @@ var CrudView = { return query; }, processResults: function (data, params) { - var results = []; - var inputType = $ele.data('inputType'); + var results = [], + inputType = $ele.data('inputType'), + term = params.term.toLowerCase(); if (data.data) { $.each(data.data, function(id, text) { - if (text.indexOf(params.term) > -1) { + if (text.toLowerCase().indexOf(term) > -1) { results.push({ id: inputType === 'text' ? text : id, text: text From b44536b7cbc4ec7b6b60578e99fae7c3c7504dc3 Mon Sep 17 00:00:00 2001 From: ADmad Date: Wed, 6 Nov 2019 17:52:56 +0530 Subject: [PATCH 55/91] Fix paging links --- templates/element/index/pagination.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/element/index/pagination.php b/templates/element/index/pagination.php index 501d77d3..eeceaffe 100644 --- a/templates/element/index/pagination.php +++ b/templates/element/index/pagination.php @@ -5,7 +5,7 @@
        Paginator->hasPage(2)) { - echo $this->Paginator->numbers([ + echo $this->Paginator->links([ 'prev' => true, 'next' => true, ]); From 3395f6b3a49f315b3010c5d6661eda6540e3eb73 Mon Sep 17 00:00:00 2001 From: ADmad Date: Sat, 16 Nov 2019 00:03:08 +0530 Subject: [PATCH 56/91] Update phpstan config --- phpstan.neon | 6 ------ 1 file changed, 6 deletions(-) diff --git a/phpstan.neon b/phpstan.neon index 2dd6ce2e..92f663c5 100644 --- a/phpstan.neon +++ b/phpstan.neon @@ -10,9 +10,3 @@ parameters: - message: '#Call to an undefined method Cake\\ORM\\Table::searchManager\(\)#' path: 'src/Listener/ViewSearchListener.php' - - - message: '#Result of && is always false#' - path: 'src/Listener/ViewSearchListener.php' - - - message: "#Strict comparison using !== between 'select' and 'select' will always evaluate to false#" - path: 'src/Listener/ViewSearchListener.php' From ed7e833d72172b8a8e5e0e359bed6014529d3a74 Mon Sep 17 00:00:00 2001 From: ADmad Date: Sat, 16 Nov 2019 13:44:52 +0530 Subject: [PATCH 57/91] Fix errors reported by psalm --- src/Listener/ViewListener.php | 17 ++++++++++++++--- src/View/CrudView.php | 4 ++-- src/View/Helper/CrudViewHelper.php | 30 +++++++++++++++++++----------- src/View/Widget/DateTimeWidget.php | 5 +++++ 4 files changed, 40 insertions(+), 16 deletions(-) diff --git a/src/Listener/ViewListener.php b/src/Listener/ViewListener.php index 3c0c87fe..5fe85525 100644 --- a/src/Listener/ViewListener.php +++ b/src/Listener/ViewListener.php @@ -28,7 +28,7 @@ class ViewListener extends BaseListener /** * Default associations config * - * @var array + * @var array|null */ protected $associations = null; @@ -161,15 +161,20 @@ protected function _getPageTitle(): string } $primaryKeyValue = $this->_primaryKeyValue(); - if ($primaryKeyValue === null) { + if ($primaryKeyValue === []) { return sprintf('%s %s', $actionName, $controllerName); } $displayFieldValue = $this->_displayFieldValue(); - if ($displayFieldValue === null || $this->_table()->getDisplayField() == $this->_table()->getPrimaryKey()) { + if ( + $displayFieldValue === null + || $this->_table()->getDisplayField() === $this->_table()->getPrimaryKey() + ) { + /** @psalm-var string $primaryKeyValue */ return sprintf('%s %s #%s', $actionName, $controllerName, $primaryKeyValue); } + /** @psalm-var string $primaryKeyValue */ return sprintf('%s %s #%s: %s', $actionName, $controllerName, $primaryKeyValue, $displayFieldValue); } @@ -410,7 +415,9 @@ protected function _getControllerActions(): array } foreach ($actionBlacklist as $actionName) { + /** @psalm-suppress EmptyArrayAccess */ unset($table[$actionName]); + /** @psalm-suppress EmptyArrayAccess */ unset($entity[$actionName]); } @@ -438,6 +445,7 @@ protected function _getControllerActionConfiguration(string $actionName, array $ if ($this->_crud()->isActionMapped($realAction)) { $action = $this->_action($realAction); $class = get_class($action); + /** @psalm-suppress PossiblyFalseOperand */ $class = substr($class, strrpos($class, '\\') + 1); if ($class === 'DeleteAction') { @@ -549,6 +557,7 @@ protected function _associations(array $whitelist = []): array $keys = array_intersect($keys, array_map('strtolower', $whitelist)); } foreach ($keys as $associationName) { + /** @var \Cake\ORM\Association $association */ $association = $associations->get($associationName); $type = $association->type(); @@ -610,6 +619,7 @@ protected function _primaryKeyValue() */ protected function _displayFieldValue() { + /** @psalm-suppress PossiblyInvalidArgument */ return $this->_deriveFieldFromContext($this->_table()->getDisplayField()); } @@ -700,6 +710,7 @@ protected function _getActionGroups(): array protected function _getFormTabGroups(array $fields = []): array { $action = $this->_action(); + /** @var array $groups */ $groups = $action->getConfig('scaffold.form_tab_groups'); if (empty($groups)) { diff --git a/src/View/CrudView.php b/src/View/CrudView.php index 4f0844ab..fd9be6cc 100644 --- a/src/View/CrudView.php +++ b/src/View/CrudView.php @@ -200,9 +200,9 @@ protected function _createViewblock(array $data): string if ($type === 'element') { $output = $this->element($key); } elseif ($type === 'Html::css') { - $output .= $this->Html->css($key); + $output .= (string)$this->Html->css($key); } elseif ($type === 'Html::script') { - $output .= $this->Html->script($key); + $output .= (string)$this->Html->script($key); } else { $output .= $key; } diff --git a/src/View/Helper/CrudViewHelper.php b/src/View/Helper/CrudViewHelper.php index cc0fa48f..6087d129 100644 --- a/src/View/Helper/CrudViewHelper.php +++ b/src/View/Helper/CrudViewHelper.php @@ -9,8 +9,7 @@ use Cake\Utility\Text; use Cake\View\Helper; use Cake\View\Helper\FormHelper; -use DateTime; -use DateTimeImmutable; +use DateTimeInterface; /** * @property \BootstrapUI\View\Helper\FormHelper $Form @@ -103,11 +102,11 @@ public function process(string $field, EntityInterface $data, array $options = [ /** * Get the current field value * - * @param \Cake\Datasource\EntityInterface $data The entity data. + * @param \Cake\Datasource\EntityInterface|null $data The entity data. * @param string $field The field to extract, if null, the field from the entity context is used. * @return mixed */ - public function fieldValue(EntityInterface $data, string $field) + public function fieldValue(?EntityInterface $data, string $field) { if (empty($data)) { $data = $this->getContext(); @@ -135,10 +134,12 @@ public function introspect(string $field, $value, array $options = []) $fieldFormatters = $this->getConfig('fieldFormatters'); if (isset($fieldFormatters[$type])) { + /** @psalm-suppress PossiblyNullArrayOffset */ if (is_callable($fieldFormatters[$type])) { return $fieldFormatters[$type]($field, $value, $this->getContext(), $options, $this->getView()); } + /** @psalm-suppress PossiblyNullArrayOffset */ return $this->{$fieldFormatters[$type]}($field, $value, $options); } @@ -167,9 +168,9 @@ public function introspect(string $field, $value, array $options = []) * Get column type from schema. * * @param string $field Field to get column type for - * @return string + * @return string|null */ - public function columnType(string $field): string + public function columnType(string $field): ?string { $schema = $this->schema(); @@ -205,7 +206,12 @@ public function formatDate(string $field, $value, array $options): string return $this->Html->label(__d('crud', 'N/A'), ['type' => 'info']); } - if (is_int($value) || is_string($value) || $value instanceof DateTime || $value instanceof DateTimeImmutable) { + /** @psalm-suppress ArgumentTypeCoercion */ + if ( + is_int($value) + || is_string($value) + || $value instanceof DateTimeInterface + ) { return $this->Time->timeAgoInWords($value, $options); } @@ -227,7 +233,12 @@ public function formatTime(string $field, $value, array $options): string } $format = $options['format'] ?? null; - if (is_int($value) || is_string($value) || $value instanceof DateTime || $value instanceof DateTimeImmutable) { + /** @psalm-suppress ArgumentTypeCoercion */ + if ( + is_int($value) + || is_string($value) + || $value instanceof DateTimeInterface + ) { return $this->Time->nice($value, $format); } @@ -272,9 +283,6 @@ public function relation(string $field) } $data = $this->getContext(); - if (empty($data)) { - return false; - } foreach ($associations['manyToOne'] as $alias => $details) { if ($field !== $details['foreignKey']) { diff --git a/src/View/Widget/DateTimeWidget.php b/src/View/Widget/DateTimeWidget.php index efa16e2f..9a78326e 100644 --- a/src/View/Widget/DateTimeWidget.php +++ b/src/View/Widget/DateTimeWidget.php @@ -115,6 +115,10 @@ public function render(array $data, ContextInterface $context): string $noWrap = true; } + /** + * @psalm-suppress PossiblyInvalidArrayOffset + * @psalm-suppress PossiblyInvalidArgument + */ $input = $this->_templates->format('input', [ 'name' => $data['name'], 'type' => 'text', @@ -129,6 +133,7 @@ public function render(array $data, ContextInterface $context): string return $input; } + /** @psalm-suppress PossiblyInvalidArrayOffset */ return $this->_templates->format('datetimePicker', [ 'input' => $input, 'iconClass' => $iconClass, From 4373dd2f8e32263829818234df09b485d15f18d1 Mon Sep 17 00:00:00 2001 From: ADmad Date: Sat, 16 Nov 2019 13:56:58 +0530 Subject: [PATCH 58/91] Cleanup code --- src/View/Widget/DateTimeWidget.php | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/src/View/Widget/DateTimeWidget.php b/src/View/Widget/DateTimeWidget.php index 9a78326e..9d1046fc 100644 --- a/src/View/Widget/DateTimeWidget.php +++ b/src/View/Widget/DateTimeWidget.php @@ -42,15 +42,7 @@ public function render(array $data, ContextInterface $context): string 'data-wrap' => 'true', ]; - $data += [ - 'name' => '', - 'val' => null, - 'type' => 'datetime-local', - 'escape' => true, - 'timezone' => null, - 'templateVars' => [], - 'data-input' => '', - ]; + $data = $this->mergeDefaults($data, $context) + ['data-input' => '']; $data['value'] = $this->formatDateTime($data['val'], $data); unset($data['val'], $data['timezone']); From fbc39941d1954241cd47f059dc3e5ea8bbe1907c Mon Sep 17 00:00:00 2001 From: ADmad Date: Wed, 25 Dec 2019 18:42:26 +0530 Subject: [PATCH 59/91] Update dependency constraints --- composer.json | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/composer.json b/composer.json index 97a1a6f3..a19e44c0 100644 --- a/composer.json +++ b/composer.json @@ -29,14 +29,14 @@ } ], "require": { - "cakephp/cakephp": "4.x-dev", - "friendsofcake/crud": "dev-cake-4.x", - "friendsofcake/bootstrap-ui": "dev-cake-4-bs-4" + "cakephp/cakephp": "^4.0", + "friendsofcake/crud": "^6.0", + "friendsofcake/bootstrap-ui": "^3.0" }, "require-dev": { - "friendsofcake/cakephp-test-utilities": "dev-cake-4.x", - "markstory/asset_compress": "4.x-dev", - "phpunit/phpunit": "^8.0" + "friendsofcake/cakephp-test-utilities": "^2.0", + "markstory/asset_compress": "^4.0", + "phpunit/phpunit": "~8.5.0" }, "autoload": { "psr-4": { @@ -54,6 +54,6 @@ "wiki": "http://cakephp.nu/cakephp-crud/", "irc": "irc://irc.freenode.org/friendsofcake" }, - "minimum-stability": "dev", + "minimum-stability": "beta", "prefer-stable": true } From 86c3103bb7ca8518ff71070c0825e4267d4c0987 Mon Sep 17 00:00:00 2001 From: ADmad Date: Wed, 25 Dec 2019 18:45:19 +0530 Subject: [PATCH 60/91] Update phpstan config --- phpstan.neon | 4 ++++ src/Listener/Traits/IndexTypeTrait.php | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/phpstan.neon b/phpstan.neon index 92f663c5..7ee901cb 100644 --- a/phpstan.neon +++ b/phpstan.neon @@ -1,5 +1,6 @@ parameters: level: 7 + checkMissingIterableValueType: false universalObjectCratesClasses: - Crud\Event\Subject ignoreErrors: @@ -10,3 +11,6 @@ parameters: - message: '#Call to an undefined method Cake\\ORM\\Table::searchManager\(\)#' path: 'src/Listener/ViewSearchListener.php' + - + message: '#Method CrudView\\Action\\DashboardAction::_get\(\) should return Cake\\Http\\Response|void but return statement is missing#' + path: 'src/Action/DashboardAction.php' diff --git a/src/Listener/Traits/IndexTypeTrait.php b/src/Listener/Traits/IndexTypeTrait.php index 906bcf71..3fbd5168 100644 --- a/src/Listener/Traits/IndexTypeTrait.php +++ b/src/Listener/Traits/IndexTypeTrait.php @@ -155,5 +155,5 @@ abstract protected function _action(?string $name = null): BaseAction; /** * {@inheritDoc} */ - abstract protected function _table(): Table; + abstract protected function _table(); } From 40ce93178bbb0cd399d1cd12e02021bd672e98bc Mon Sep 17 00:00:00 2001 From: ADmad Date: Wed, 25 Dec 2019 18:51:20 +0530 Subject: [PATCH 61/91] Fix errors reported by psalm --- psalm.xml | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 psalm.xml diff --git a/psalm.xml b/psalm.xml new file mode 100644 index 00000000..048f79f3 --- /dev/null +++ b/psalm.xml @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + + + + + + From a7b2b8a32f45e95798fb3c56e86eca2d8da706d7 Mon Sep 17 00:00:00 2001 From: ADmad Date: Wed, 25 Dec 2019 18:53:29 +0530 Subject: [PATCH 62/91] Update travis config --- .travis.yml | 15 ++++++++------- src/Breadcrumb/ActiveBreadcrumb.php | 3 ++- src/View/Helper/CrudViewHelper.php | 12 ++++++------ 3 files changed, 16 insertions(+), 14 deletions(-) diff --git a/.travis.yml b/.travis.yml index b3780cf2..bf40f66b 100644 --- a/.travis.yml +++ b/.travis.yml @@ -3,6 +3,7 @@ language: php php: - 7.2 - 7.3 + - 7.4 env: global: @@ -17,29 +18,29 @@ matrix: env: PHPCS=1 DEFAULT=0 - php: 7.2 - env: PHPSTAN=1 DEFAULT=0 + env: STATIC_ANALYSIS=1 DEFAULT=0 - php: 7.2 env: DEFAULT=1 LOWEST=1 before_script: - - if [[ $TRAVIS_PHP_VERSION != 7.2 ]]; then phpenv config-rm xdebug.ini; fi + - if [[ $TRAVIS_PHP_VERSION != 7.3 ]]; then phpenv config-rm xdebug.ini; fi - if [[ $LOWEST = 0 ]]; then composer install --prefer-dist --no-interaction; fi - if [[ $LOWEST = 1 ]]; then composer update --prefer-lowest --prefer-dist --no-interaction; fi - if [[ $PHPCS = 1 ]]; then composer require cakephp/cakephp-codesniffer:dev-next; fi - - if [[ $PHPSTAN = 1 ]]; then composer require phpstan/phpstan:^0.11; fi + - if [[ $STATIC_ANALYSIS = 1 ]]; then composer require phpstan/phpstan:^0.12 psalm/phar:^3.7; fi script: - - if [[ $DEFAULT = 1 && $TRAVIS_PHP_VERSION != 7.2 ]]; then vendor/bin/phpunit; fi - - if [[ $DEFAULT = 1 && $TRAVIS_PHP_VERSION = 7.2 ]]; then vendor/bin/phpunit --coverage-clover=clover.xml; fi + - if [[ $DEFAULT = 1 && $TRAVIS_PHP_VERSION != 7.3 ]]; then vendor/bin/phpunit; fi + - if [[ $DEFAULT = 1 && $TRAVIS_PHP_VERSION = 7.3 ]]; then vendor/bin/phpunit --coverage-clover=clover.xml; fi - if [[ $PHPCS = 1 ]]; then vendor/bin/phpcs -p --extensions=php --standard=vendor/cakephp/cakephp-codesniffer/CakePHP src/ config/; fi - - if [[ $PHPSTAN = 1 ]]; then vendor/bin/phpstan analyse src; fi + - if [[ $STATIC_ANALYSIS = 1 ]]; then vendor/bin/phpstan.phar analyse src && vendor/bin/psalm.phar; fi after_success: - - if [[ $DEFAULT = 1 && $TRAVIS_PHP_VERSION = 7.2 ]]; then bash <(curl -s https://codecov.io/bash); fi + - if [[ $DEFAULT = 1 && $TRAVIS_PHP_VERSION = 7.3 ]]; then bash <(curl -s https://codecov.io/bash); fi notifications: email: false diff --git a/src/Breadcrumb/ActiveBreadcrumb.php b/src/Breadcrumb/ActiveBreadcrumb.php index 95c32108..89f70c08 100644 --- a/src/Breadcrumb/ActiveBreadcrumb.php +++ b/src/Breadcrumb/ActiveBreadcrumb.php @@ -6,7 +6,8 @@ class ActiveBreadcrumb extends Breadcrumb { /** - * {@inheritDoc} + * @inheritDoc + * @psalm-suppress MissingParamType */ public function __construct($title, $url = null, array $options = []) { diff --git a/src/View/Helper/CrudViewHelper.php b/src/View/Helper/CrudViewHelper.php index 6087d129..efd04489 100644 --- a/src/View/Helper/CrudViewHelper.php +++ b/src/View/Helper/CrudViewHelper.php @@ -188,8 +188,8 @@ public function columnType(string $field): ?string public function formatBoolean(string $field, $value, array $options): string { return (bool)$value ? - $this->Html->label(__d('crud', 'Yes'), ['type' => empty($options['inverted']) ? 'success' : 'danger']) : - $this->Html->label(__d('crud', 'No'), ['type' => empty($options['inverted']) ? 'danger' : 'success']); + $this->Html->badge(__d('crud', 'Yes'), ['class' => empty($options['inverted']) ? 'success' : 'danger']) : + $this->Html->badge(__d('crud', 'No'), ['class' => empty($options['inverted']) ? 'danger' : 'success']); } /** @@ -203,7 +203,7 @@ public function formatBoolean(string $field, $value, array $options): string public function formatDate(string $field, $value, array $options): string { if ($value === null) { - return $this->Html->label(__d('crud', 'N/A'), ['type' => 'info']); + return $this->Html->badge(__d('crud', 'N/A'), ['class' => 'info']); } /** @psalm-suppress ArgumentTypeCoercion */ @@ -215,7 +215,7 @@ public function formatDate(string $field, $value, array $options): string return $this->Time->timeAgoInWords($value, $options); } - return $this->Html->label(__d('crud', 'N/A'), ['type' => 'info']); + return $this->Html->badge(__d('crud', 'N/A'), ['class' => 'info']); } /** @@ -229,7 +229,7 @@ public function formatDate(string $field, $value, array $options): string public function formatTime(string $field, $value, array $options): string { if ($value === null) { - return $this->Html->label(__d('crud', 'N/A'), ['type' => 'info']); + return $this->Html->badge(__d('crud', 'N/A'), ['class' => 'info']); } $format = $options['format'] ?? null; @@ -242,7 +242,7 @@ public function formatTime(string $field, $value, array $options): string return $this->Time->nice($value, $format); } - return $this->Html->label(__d('crud', 'N/A'), ['type' => 'info']); + return $this->Html->badge(__d('crud', 'N/A'), ['class' => 'info']); } /** From f7b15bb37cf1f3f36c2e84ac4088fab725ce0a18 Mon Sep 17 00:00:00 2001 From: ADmad Date: Wed, 25 Dec 2019 18:56:01 +0530 Subject: [PATCH 63/91] Update readme --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index f7c53299..9929ffe3 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,6 @@ Automated admin backend based on your [Crud](https://github.com/friendsofcake/cr # Installation -For CakePHP 3.x: - ```shell composer require friendsofcake/crud-view ``` From 590e78efb5b6b4a4f983a68db5010d713e4e839c Mon Sep 17 00:00:00 2001 From: ADmad Date: Thu, 26 Dec 2019 12:14:35 +0530 Subject: [PATCH 64/91] Fix CS error --- src/Listener/Traits/IndexTypeTrait.php | 1 - 1 file changed, 1 deletion(-) diff --git a/src/Listener/Traits/IndexTypeTrait.php b/src/Listener/Traits/IndexTypeTrait.php index 3fbd5168..94cbcdc8 100644 --- a/src/Listener/Traits/IndexTypeTrait.php +++ b/src/Listener/Traits/IndexTypeTrait.php @@ -4,7 +4,6 @@ namespace CrudView\Listener\Traits; use Cake\Controller\Controller; -use Cake\ORM\Table; use Crud\Action\BaseAction; use Crud\Action\IndexAction; From 42e2ac1c9900f2e3c7fa0a2031da53f258746451 Mon Sep 17 00:00:00 2001 From: Heath Nail Date: Fri, 27 Dec 2019 18:04:45 -0500 Subject: [PATCH 65/91] Use '?' as array key for lookup query https://book.cakephp.org/4/en/development/routing.html#generating-urls --- src/Listener/ViewSearchListener.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Listener/ViewSearchListener.php b/src/Listener/ViewSearchListener.php index 2ff7fcc1..eac470c8 100644 --- a/src/Listener/ViewSearchListener.php +++ b/src/Listener/ViewSearchListener.php @@ -163,7 +163,7 @@ public function fields(): array } unset($input['fields']); - $url = array_merge(['action' => 'lookup', '_ext' => 'json'], $urlArgs); + $url = array_merge(['action' => 'lookup', '_ext' => 'json'], ['?' => $urlArgs]); $input['data-url'] = Router::url($url); $fields[$field] = $input; From 2cf24c113f178d05ddd468b3a9a4e3481a18d232 Mon Sep 17 00:00:00 2001 From: ADmad Date: Sun, 24 May 2020 02:32:08 +0530 Subject: [PATCH 66/91] Fix CS errors --- .stickler.yml | 7 ++----- src/Breadcrumb/ActiveBreadcrumb.php | 1 + src/Listener/Traits/FormTypeTrait.php | 4 ++-- src/Listener/Traits/IndexTypeTrait.php | 6 +++--- src/Listener/Traits/SidebarNavigationTrait.php | 4 ++-- src/Listener/Traits/SiteTitleTrait.php | 4 ++-- src/Listener/Traits/UtilityNavigationTrait.php | 4 ++-- src/View/CrudView.php | 2 -- 8 files changed, 14 insertions(+), 18 deletions(-) diff --git a/.stickler.yml b/.stickler.yml index 86536856..b8f57db8 100644 --- a/.stickler.yml +++ b/.stickler.yml @@ -1,13 +1,10 @@ --- linters: phpcs: - standard: CakePHP - extensions: 'php,ctp' + standard: CakePHP4 + extensions: 'php' fixer: true -branches: - ignore: ['cake-4.x'] - fixers: enable: true workflow: commit diff --git a/src/Breadcrumb/ActiveBreadcrumb.php b/src/Breadcrumb/ActiveBreadcrumb.php index 89f70c08..22ce1126 100644 --- a/src/Breadcrumb/ActiveBreadcrumb.php +++ b/src/Breadcrumb/ActiveBreadcrumb.php @@ -6,6 +6,7 @@ class ActiveBreadcrumb extends Breadcrumb { /** + * // phpcs:ignore * @inheritDoc * @psalm-suppress MissingParamType */ diff --git a/src/Listener/Traits/FormTypeTrait.php b/src/Listener/Traits/FormTypeTrait.php index 10f16870..5c56b083 100644 --- a/src/Listener/Traits/FormTypeTrait.php +++ b/src/Listener/Traits/FormTypeTrait.php @@ -166,12 +166,12 @@ protected function _getFormUrl() } /** - * {@inheritDoc} + * @inheritDoc */ abstract protected function _controller(): Controller; /** - * {@inheritDoc} + * @inheritDoc */ abstract protected function _action(?string $name = null): BaseAction; } diff --git a/src/Listener/Traits/IndexTypeTrait.php b/src/Listener/Traits/IndexTypeTrait.php index 94cbcdc8..d19dee76 100644 --- a/src/Listener/Traits/IndexTypeTrait.php +++ b/src/Listener/Traits/IndexTypeTrait.php @@ -142,17 +142,17 @@ protected function _getIndexGalleryCssClasses(): string } /** - * {@inheritDoc} + * @inheritDoc */ abstract protected function _controller(): Controller; /** - * {@inheritDoc} + * @inheritDoc */ abstract protected function _action(?string $name = null): BaseAction; /** - * {@inheritDoc} + * @inheritDoc */ abstract protected function _table(); } diff --git a/src/Listener/Traits/SidebarNavigationTrait.php b/src/Listener/Traits/SidebarNavigationTrait.php index 482493c2..37340418 100644 --- a/src/Listener/Traits/SidebarNavigationTrait.php +++ b/src/Listener/Traits/SidebarNavigationTrait.php @@ -34,12 +34,12 @@ protected function _getSidebarNavigation() } /** - * {@inheritDoc} + * @inheritDoc */ abstract protected function _controller(): Controller; /** - * {@inheritDoc} + * @inheritDoc */ abstract protected function _action(?string $name = null): BaseAction; } diff --git a/src/Listener/Traits/SiteTitleTrait.php b/src/Listener/Traits/SiteTitleTrait.php index 02f236bb..38a55a59 100644 --- a/src/Listener/Traits/SiteTitleTrait.php +++ b/src/Listener/Traits/SiteTitleTrait.php @@ -75,12 +75,12 @@ protected function _getSiteTitleImage(): string } /** - * {@inheritDoc} + * @inheritDoc */ abstract protected function _controller(): Controller; /** - * {@inheritDoc} + * @inheritDoc */ abstract protected function _action(?string $name = null): BaseAction; } diff --git a/src/Listener/Traits/UtilityNavigationTrait.php b/src/Listener/Traits/UtilityNavigationTrait.php index 18ef73ae..998a8f7d 100644 --- a/src/Listener/Traits/UtilityNavigationTrait.php +++ b/src/Listener/Traits/UtilityNavigationTrait.php @@ -41,12 +41,12 @@ protected function _getUtilityNavigation(): array } /** - * {@inheritDoc} + * @inheritDoc */ abstract protected function _controller(): Controller; /** - * {@inheritDoc} + * @inheritDoc */ abstract protected function _action(?string $name = null): BaseAction; } diff --git a/src/View/CrudView.php b/src/View/CrudView.php index fd9be6cc..54aae9f6 100644 --- a/src/View/CrudView.php +++ b/src/View/CrudView.php @@ -176,7 +176,6 @@ public function fetch(string $name, string $default = ''): string * Check if a block exists * * @param string $name Name of the block - * * @return bool */ public function exists(string $name): bool @@ -190,7 +189,6 @@ public function exists(string $name): bool * Constructs a ViewBlock from an array of configured data * * @param array $data ViewBlock data - * * @return string */ protected function _createViewblock(array $data): string From fe149efe4f97c0b78b4b12c4da761a0bd819afad Mon Sep 17 00:00:00 2001 From: ADmad Date: Sun, 24 May 2020 02:34:18 +0530 Subject: [PATCH 67/91] Fix trailing # for titles --- src/Listener/ViewListener.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Listener/ViewListener.php b/src/Listener/ViewListener.php index 5fe85525..23ec7612 100644 --- a/src/Listener/ViewListener.php +++ b/src/Listener/ViewListener.php @@ -161,7 +161,7 @@ protected function _getPageTitle(): string } $primaryKeyValue = $this->_primaryKeyValue(); - if ($primaryKeyValue === []) { + if (empty($primaryKeyValue)) { return sprintf('%s %s', $actionName, $controllerName); } From bc57cb4922c010bdf008b3753251d493122fcf84 Mon Sep 17 00:00:00 2001 From: ADmad Date: Wed, 27 May 2020 20:42:01 +0530 Subject: [PATCH 68/91] Update/fix asset URLs --- config/asset_compress.ini | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/config/asset_compress.ini b/config/asset_compress.ini index 24e5f1a4..df092ae6 100644 --- a/config/asset_compress.ini +++ b/config/asset_compress.ini @@ -1,16 +1,17 @@ [crudview.css] -files[]=https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.css -files[]=https://cdn.jsdelivr.net/npm/flatpickr@4.6.3/dist/flatpickr.min.css +files[]=https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@5.13/css/all.min.css +files[]=https://cdn.jsdelivr.net/npm/bootstrap@^4.5/dist/css/bootstrap.min.css +files[]=https://cdn.jsdelivr.net/npm/flatpickr@4.6/dist/flatpickr.min.css files[]=https://cdn.jsdelivr.net/npm/select2@4.0/dist/css/select2.min.css files[]=https://cdn.jsdelivr.net/npm/@ttskch/select2-bootstrap4-theme@1.2/dist/select2-bootstrap4.css files[]=plugin:CrudView:css/local.css [crudview_head.js] -files[]=https://cdnjs.cloudflare.com/ajax/libs/jquery/2.2.4/jquery.min.js -files[]=https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js +files[]=https://cdn.jsdelivr.net/npm/jquery@^3.4/dist/jquery.min.js +files[]=https://cdn.jsdelivr.net/npm/bootstrap@^4.5/dist/js/bootstrap.min.js files[]=https://cdn.jsdelivr.net/npm/flatpickr@4.6 files[]=https://cdn.jsdelivr.net/npm/select2@4.0 -files[]=https://cdn.jsdelivr.net/jquery.dirtyforms/1.2.3/jquery.dirtyforms.min.js +files[]=https://cdn.jsdelivr.net/npm/jquery.dirtyforms@2/jquery.dirtyforms.min.js [crudview.js] files[]=plugin:CrudView:js/local.js From 6a614d941df19de4acf85d8385abcae51ffd8481 Mon Sep 17 00:00:00 2001 From: ADmad Date: Wed, 27 May 2020 20:43:50 +0530 Subject: [PATCH 69/91] Add JS for BS tooltips --- webroot/js/local.js | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/webroot/js/local.js b/webroot/js/local.js index f1a2d5fe..8dff5e56 100644 --- a/webroot/js/local.js +++ b/webroot/js/local.js @@ -98,6 +98,10 @@ var CrudView = { }) }, + tooltip: function () { + $('[data-toggle="tooltip"]').tooltip(); + }, + initialize: function () { this.bulkActionForm('.bulk-actions'); this.flatpickr('.flatpickr'); @@ -105,6 +109,7 @@ var CrudView = { this.autocomplete('input.autocomplete, select.autocomplete'); this.dirtyForms(); this.dropdown(); + this.tooltip(); } }; From ecfcf5063ae1b9857ac9af12d62d4029e801ac78 Mon Sep 17 00:00:00 2001 From: ADmad Date: Wed, 27 May 2020 21:26:38 +0530 Subject: [PATCH 70/91] Fix errors reported by phpstan --- .gitattributes | 3 ++ phpstan-baseline.neon | 72 ++++++++++++++++++++++++++++++ phpstan.neon | 14 ++---- src/View/Widget/DateTimeWidget.php | 5 +-- 4 files changed, 80 insertions(+), 14 deletions(-) create mode 100644 phpstan-baseline.neon diff --git a/.gitattributes b/.gitattributes index 76a35dd6..6d2ed281 100644 --- a/.gitattributes +++ b/.gitattributes @@ -11,3 +11,6 @@ docs export-ignore .github export-ignore .coveralls.yml export-ignore Makefile export-ignore +phpstan.neon export-ignore +phpstan-baseline.neon export-ignore +psalm.xml export-ignore diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon new file mode 100644 index 00000000..fdc99ea6 --- /dev/null +++ b/phpstan-baseline.neon @@ -0,0 +1,72 @@ +parameters: + ignoreErrors: + - + message: "#^Access to an undefined property object\\:\\:\\$query\\.$#" + count: 4 + path: src/Listener/ViewListener.php + + - + message: "#^Access to an undefined property object\\:\\:\\$params\\.$#" + count: 1 + path: src/Listener/ViewListener.php + + - + message: "#^Access to an undefined property object\\:\\:\\$element\\.$#" + count: 1 + path: src/Listener/ViewListener.php + + - + message: "#^Access to an undefined property object\\:\\:\\$type\\.$#" + count: 1 + path: src/Listener/ViewListener.php + + - + message: "#^Parameter \\#2 \\$arr2 of function array_diff_key expects array, array\\|false given\\.$#" + count: 1 + path: src/Listener/ViewListener.php + + - + message: "#^Result of \\|\\| is always false\\.$#" + count: 1 + path: src/Listener/ViewListener.php + + - + message: "#^Cannot unset offset mixed on array\\(\\)\\.$#" + count: 2 + path: src/Listener/ViewListener.php + + - + message: "#^Parameter \\#1 \\$field of method CrudView\\\\Listener\\\\ViewListener\\:\\:_deriveFieldFromContext\\(\\) expects string, array\\\\|string\\|null given\\.$#" + count: 1 + path: src/Listener/ViewListener.php + + - + message: "#^Call to an undefined method Cake\\\\ORM\\\\Table\\:\\:searchManager\\(\\)\\.$#" + count: 1 + path: src/Listener/ViewSearchListener.php + + - + message: "#^Offset 'data\\-wrap' does not exist on array\\(\\?'data\\-enable\\-seconds' \\=\\> 'true', 'data\\-date\\-format' \\=\\> string, \\?'data\\-enable\\-time' \\=\\> 'true', \\?'data\\-alt\\-format' \\=\\> mixed, \\?'data\\-alt\\-input' \\=\\> 'true', \\?'data\\-no\\-calendar' \\=\\> 'true'\\)\\.$#" + count: 1 + path: src/View/Widget/DateTimeWidget.php + + - + message: "#^Binary operation \"\\+\\=\" between array\\\\|string and array\\('data\\-date\\-format' \\=\\> string, \\?'data\\-alt\\-format' \\=\\> mixed, \\?'data\\-alt\\-input' \\=\\> 'true', \\?'data\\-no\\-calendar' \\=\\> 'true', \\?'data\\-enable\\-seconds' \\=\\> 'true', \\?'data\\-enable\\-time' \\=\\> 'true', 'data\\-wrap' \\=\\> mixed\\) results in an error\\.$#" + count: 1 + path: src/View/Widget/DateTimeWidget.php + + - + message: "#^Offset 'name' does not exist on array\\\\|string\\.$#" + count: 1 + path: src/View/Widget/DateTimeWidget.php + + - + message: "#^Offset 'templateVars' does not exist on array\\\\|string\\.$#" + count: 2 + path: src/View/Widget/DateTimeWidget.php + + - + message: "#^Parameter \\#1 \\$options of method Cake\\\\View\\\\StringTemplate\\:\\:formatAttributes\\(\\) expects array\\|null, array\\\\|string given\\.$#" + count: 1 + path: src/View/Widget/DateTimeWidget.php + diff --git a/phpstan.neon b/phpstan.neon index 7ee901cb..5c6d272c 100644 --- a/phpstan.neon +++ b/phpstan.neon @@ -1,16 +1,8 @@ +includes: + - phpstan-baseline.neon + parameters: level: 7 checkMissingIterableValueType: false universalObjectCratesClasses: - Crud\Event\Subject - ignoreErrors: - - '#Parameter \#1 $dateString of method Cake\\View\\Helper\\TimeHelper::nice() expects DateTime|int|string|null, DateTime|DateTimeImmutable|int|string given#' - - - message: '#Result of || is always false#' - path: 'src/Listener/ViewListener.php' - - - message: '#Call to an undefined method Cake\\ORM\\Table::searchManager\(\)#' - path: 'src/Listener/ViewSearchListener.php' - - - message: '#Method CrudView\\Action\\DashboardAction::_get\(\) should return Cake\\Http\\Response|void but return statement is missing#' - path: 'src/Action/DashboardAction.php' diff --git a/src/View/Widget/DateTimeWidget.php b/src/View/Widget/DateTimeWidget.php index 9d1046fc..d4719ab1 100644 --- a/src/View/Widget/DateTimeWidget.php +++ b/src/View/Widget/DateTimeWidget.php @@ -75,13 +75,12 @@ public function render(array $data, ContextInterface $context): string $iconClass = 'fa fa-calendar-alt'; if (isset($datetimePicker['iconClass'])) { - $iconClass = $data['iconClass']; + $iconClass = $datetimePicker['iconClass']; + unset($datetimePicker['iconClass']); } elseif ($data['type'] === 'time') { $iconClass = 'fa fa-clock'; } - unset($datetimePicker['iconClass']); - if ($this->_templates->get('datetimePicker') === null) { // phpcs:disable $this->_templates->add([ From f14533ed22f5b779d275b69b46c9325537a96934 Mon Sep 17 00:00:00 2001 From: ADmad Date: Wed, 27 May 2020 21:27:35 +0530 Subject: [PATCH 71/91] Fix travis config --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index bf40f66b..fcfdfade 100644 --- a/.travis.yml +++ b/.travis.yml @@ -29,7 +29,7 @@ before_script: - if [[ $LOWEST = 0 ]]; then composer install --prefer-dist --no-interaction; fi - if [[ $LOWEST = 1 ]]; then composer update --prefer-lowest --prefer-dist --no-interaction; fi - - if [[ $PHPCS = 1 ]]; then composer require cakephp/cakephp-codesniffer:dev-next; fi + - if [[ $PHPCS = 1 ]]; then composer require cakephp/cakephp-codesniffer:^4.2; fi - if [[ $STATIC_ANALYSIS = 1 ]]; then composer require phpstan/phpstan:^0.12 psalm/phar:^3.7; fi script: From 2b24778f7ff73e692643fcb47852c47eff9303e1 Mon Sep 17 00:00:00 2001 From: ADmad Date: Tue, 30 Jun 2020 01:08:44 +0530 Subject: [PATCH 72/91] Fix CS errors --- templates/Scaffold/dashboard.php | 2 +- templates/Scaffold/index.php | 46 +++++++++---------- templates/Scaffold/view.php | 10 ++-- templates/cell/DashboardTable/display.php | 2 +- templates/element/action-button.php | 2 + templates/element/action-groups.php | 3 +- templates/element/action-header.php | 1 + templates/element/actions.php | 9 ++-- templates/element/breadcrumbs.php | 2 +- .../element/index/bulk_actions/form_end.php | 2 +- .../element/index/bulk_actions/form_start.php | 2 +- templates/element/index/download_formats.php | 2 +- templates/element/index/gallery.php | 12 ++--- templates/element/index/table.php | 10 ++-- templates/element/index/table_columns.php | 2 +- templates/element/sidebar.php | 20 ++++---- templates/element/view/related/has_many.php | 17 ++++--- templates/element/view/related/has_one.php | 12 ++--- templates/layout/default.php | 16 +++---- 19 files changed, 86 insertions(+), 86 deletions(-) diff --git a/templates/Scaffold/dashboard.php b/templates/Scaffold/dashboard.php index 6f08d99b..1b60ab65 100644 --- a/templates/Scaffold/dashboard.php +++ b/templates/Scaffold/dashboard.php @@ -3,7 +3,7 @@
        element('action-header') ?>
        - get('columns')) as $columnNumber): ?> + get('columns')) as $columnNumber) : ?>
        getColumnChildren($columnNumber) as $module) : ?> diff --git a/templates/Scaffold/index.php b/templates/Scaffold/index.php index 48a6e961..9cee9b1c 100644 --- a/templates/Scaffold/index.php +++ b/templates/Scaffold/index.php @@ -20,29 +20,29 @@ element('index/finder_scopes', compact('indexFinderScopes')); ?> $fields, - 'actions' => $actions, - 'bulkActions' => $bulkActions, - 'primaryKey' => $primaryKey, - 'singularVar' => $singularVar, - 'viewVar' => $viewVar, - $viewVar => ${$viewVar}, - ]; - switch ($indexType) { - case 'table': - echo $this->element('index/table', $_data); - break; - case 'gallery': - echo $this->element('index/gallery', $_data); - break; - case 'blog': - echo $this->element('index/blog', $_data); - break; - default: - echo $this->element($indexType, $_data); - break; - } + $_data = [ + 'fields' => $fields, + 'actions' => $actions, + 'bulkActions' => $bulkActions, + 'primaryKey' => $primaryKey, + 'singularVar' => $singularVar, + 'viewVar' => $viewVar, + $viewVar => ${$viewVar}, + ]; + switch ($indexType) { + case 'table': + echo $this->element('index/table', $_data); + break; + case 'gallery': + echo $this->element('index/gallery', $_data); + break; + case 'blog': + echo $this->element('index/blog', $_data); + break; + default: + echo $this->element($indexType, $_data); + break; + } ?> element('index/bulk_actions/form_end', compact('bulkActions')); ?> diff --git a/templates/Scaffold/view.php b/templates/Scaffold/view.php index ec140cee..aed328a5 100644 --- a/templates/Scaffold/view.php +++ b/templates/Scaffold/view.php @@ -1,5 +1,5 @@ extract('foreignKey')->toArray()) : @@ -12,16 +12,16 @@ CrudView->setContext(${$viewVar}); foreach ($fields as $field => $options) { - if (in_array($field, array($primaryKey))) { + if (in_array($field, [$primaryKey], true)) { continue; } echo ''; - printf("%s", array_key_exists($field, $assocMap) ? + printf('%s', array_key_exists($field, $assocMap) ? Inflector::singularize(Inflector::humanize(Inflector::underscore($assocMap[$field]))) : - (isset($options['title']) ? $options['title'] : Inflector::humanize($field))); - printf("%s", $this->CrudView->process($field, ${$viewVar}, $options) ?: " "); + ($options['title'] ?? Inflector::humanize($field))); + printf('%s', $this->CrudView->process($field, ${$viewVar}, $options) ?: ' '); echo ''; } diff --git a/templates/cell/DashboardTable/display.php b/templates/cell/DashboardTable/display.php index 8494fd27..29371c18 100644 --- a/templates/cell/DashboardTable/display.php +++ b/templates/cell/DashboardTable/display.php @@ -5,7 +5,7 @@ - + get('actions')) : ?> diff --git a/templates/element/action-button.php b/templates/element/action-button.php index 93d75df8..2a47c23f 100644 --- a/templates/element/action-button.php +++ b/templates/element/action-button.php @@ -1,11 +1,13 @@ Form->postLink($config['title'], $config['url'], $config['options']); + return; } diff --git a/templates/element/action-groups.php b/templates/element/action-groups.php index 4602d2a3..6ac81752 100644 --- a/templates/element/action-groups.php +++ b/templates/element/action-groups.php @@ -37,5 +37,4 @@ - diff --git a/templates/element/action-header.php b/templates/element/action-header.php index 3793fdc8..6c63b216 100644 --- a/templates/element/action-header.php +++ b/templates/element/action-header.php @@ -5,6 +5,7 @@ 'actions' => $actions['table'], 'singularVar' => false, ]); + // to make sure ${$viewVar} is a single entity, not a collection if (${$viewVar} instanceof \Cake\Datasource\EntityInterface && !${$viewVar}->isNew()) { echo $this->element('actions', [ diff --git a/templates/element/actions.php b/templates/element/actions.php index fcf5ca8f..5f1d425a 100644 --- a/templates/element/actions.php +++ b/templates/element/actions.php @@ -3,7 +3,8 @@ foreach ($actions as $name => $config) { $config += ['method' => 'GET']; - if ((empty($config['url']['controller']) || $this->request->getParam('controller') === $config['url']['controller']) && + if ( + (empty($config['url']['controller']) || $this->request->getParam('controller') === $config['url']['controller']) && (!empty($config['url']['action']) && $this->request->getParam('action') === $config['url']['action']) ) { continue; @@ -17,13 +18,13 @@ if ($config['method'] === 'DELETE') { $linkOptions += [ 'block' => 'action_link_forms', - 'confirm' => __d('crud', 'Are you sure you want to delete record #{0}?', [$singularVar->{$primaryKey}]) + 'confirm' => __d('crud', 'Are you sure you want to delete record #{0}?', [$singularVar->{$primaryKey}]), ]; } if ($config['method'] !== 'GET') { $linkOptions += [ - 'method' => $config['method'] + 'method' => $config['method'], ]; } @@ -61,7 +62,7 @@ 'title' => $config['title'], 'url' => $url, 'options' => $linkOptions, - 'method' => $config['method'] + 'method' => $config['method'], ]; } ?> diff --git a/templates/element/breadcrumbs.php b/templates/element/breadcrumbs.php index 0c73dbe5..5dbb4acd 100644 --- a/templates/element/breadcrumbs.php +++ b/templates/element/breadcrumbs.php @@ -3,7 +3,7 @@ return; } ?> - +Breadcrumbs->add($breadcrumb->getTitle(), $breadcrumb->getUrl(), $breadcrumb->getOptions()); ?> Breadcrumbs->render(); ?> diff --git a/templates/element/index/bulk_actions/form_end.php b/templates/element/index/bulk_actions/form_end.php index 2c47546c..ec8ac0cf 100644 --- a/templates/element/index/bulk_actions/form_end.php +++ b/templates/element/index/bulk_actions/form_end.php @@ -20,6 +20,6 @@ 'select' => '
        ' . $submitButton . '
        ', ], 'type' => 'select', - 'class' => 'no-selectize' + 'class' => 'no-selectize', ]); echo $this->Form->end(); diff --git a/templates/element/index/bulk_actions/form_start.php b/templates/element/index/bulk_actions/form_start.php index edc7ca15..4e758de8 100644 --- a/templates/element/index/bulk_actions/form_start.php +++ b/templates/element/index/bulk_actions/form_start.php @@ -4,5 +4,5 @@ } echo $this->Form->create(null, [ - 'class' => 'bulk-actions form-horizontal' + 'class' => 'bulk-actions form-horizontal', ]); diff --git a/templates/element/index/download_formats.php b/templates/element/index/download_formats.php index 4be547f2..6670556f 100644 --- a/templates/element/index/download_formats.php +++ b/templates/element/index/download_formats.php @@ -7,7 +7,7 @@ : Html->link($indexFormat['title'], $indexFormat['url'], [ - 'target' => '_blank' + 'target' => '_blank', ]); ?> diff --git a/templates/element/index/gallery.php b/templates/element/index/gallery.php index 84647e3f..e86bf683 100644 --- a/templates/element/index/gallery.php +++ b/templates/element/index/gallery.php @@ -25,10 +25,10 @@ ?>
        Html->image($imageContent, $imageOptions + ['alt' => $imageAltContent]); + if (empty($imageContent)) { + $imageContent = 'data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw=='; + } + echo $this->Html->image($imageContent, $imageOptions + ['alt' => $imageAltContent]); ?>

        @@ -37,10 +37,10 @@

        - +

        element('actions', [ 'singularVar' => $singularVar, - 'actions' => $actions['entity'] + 'actions' => $actions['entity'], ]); ?>

        diff --git a/templates/element/index/table.php b/templates/element/index/table.php index 4044bee0..2184d7e8 100644 --- a/templates/element/index/table.php +++ b/templates/element/index/table.php @@ -10,16 +10,16 @@
        - + @@ -33,10 +33,10 @@ element('index/bulk_actions/record', compact('bulkActions', 'primaryKey', 'singularVar')); ?> element('index/table_columns', compact('singularVar')); ?> - + diff --git a/templates/element/index/table_columns.php b/templates/element/index/table_columns.php index 8028a4d6..77505cb5 100644 --- a/templates/element/index/table_columns.php +++ b/templates/element/index/table_columns.php @@ -1,6 +1,6 @@ $options) { - $tdOptions = isset($options['td']) ? $options['td'] : []; + $tdOptions = $options['td'] ?? []; unset($options['td']); echo $this->Html->tag('td', $this->CrudView->process($field, $singularVar, $options), $tdOptions); diff --git a/templates/element/sidebar.php b/templates/element/sidebar.php index b8063350..19da75e6 100644 --- a/templates/element/sidebar.php +++ b/templates/element/sidebar.php @@ -1,8 +1,8 @@ array_merge( (array)Hash::get($actionConfig, 'scaffold.tables_blacklist'), (array)Configure::read('CrudView.tablesBlacklist') - ) + ), ]) ?> element('menu/item', ['item' => $entry]); - } elseif ($entry instanceof MenuDivider) { - echo '
        '; - } else { - throw new \Exception('Invalid Menu Item class'); - } + foreach ($sidebarNavigation as $entry) { + if ($entry instanceof MenuItem) { + echo $this->element('menu/item', ['item' => $entry]); + } elseif ($entry instanceof MenuDivider) { + echo '
        '; + } else { + throw new \Exception('Invalid Menu Item class'); } + } ?> diff --git a/templates/element/view/related/has_many.php b/templates/element/view/related/has_many.php index b29f18d0..211c57c2 100644 --- a/templates/element/view/related/has_many.php +++ b/templates/element/view/related/has_many.php @@ -11,16 +11,16 @@ $relations = array_merge($associations['oneToMany'], $associations['manyToMany']); $i = 0; -foreach ($relations as $alias => $details): +foreach ($relations as $alias => $details) : $otherSingularVar = $details['propertyName']; ?>

        - CrudView->createRelationLink($alias, $details, array('class' => 'btn btn-secondary'));?> + CrudView->createRelationLink($alias, $details, ['class' => 'btn btn-secondary']);?>
        {$details['entities']}): + if (${$viewVar}->{$details['entities']}) : ?>
        Html->link($link->get('title'), $link->get('url'), $link->get('options')) ?> Paginator->sort($field, isset($options['title']) ? $options['title'] : null, $options); + echo $this->Paginator->sort($field, $options['title'] ?? null, $options); } ?>
        element('actions', [ 'singularVar' => $singularVar, - 'actions' => $actions['entity'] + 'actions' => $actions['entity'], ]); ?>
        @@ -33,7 +33,7 @@ } foreach ($otherFields as $field) { - echo ""; + echo ''; } ?> @@ -53,9 +53,9 @@ } ?> - diff --git a/templates/element/view/related/has_one.php b/templates/element/view/related/has_one.php index 59c35f9f..d5954a7e 100644 --- a/templates/element/view/related/has_one.php +++ b/templates/element/view/related/has_one.php @@ -5,7 +5,7 @@ return; } -foreach ($associations['oneToOne'] as $alias => $details): +foreach ($associations['oneToOne'] as $alias => $details) : $alias = $details['propertyName']; ?>
        @@ -14,8 +14,8 @@
        Html->link( __d('crud', 'View {0}', [Inflector::humanize(Inflector::underscore($alias))]), - array('plugin' => $details['plugin'], 'controller' => $details['controller'], 'action' => 'view', ${$viewVar}[$alias][$details['primaryKey']]), - array('class' => 'btn btn-secondary') + ['plugin' => $details['plugin'], 'controller' => $details['controller'], 'action' => 'view', ${$viewVar}[$alias][$details['primaryKey']]], + ['class' => 'btn btn-secondary'] ); ?>
        @@ -24,7 +24,6 @@ ?>
        {$alias}->toArray()); foreach ($otherFields as $field) { ?> @@ -32,11 +31,10 @@
        CrudView->process($field, ${$viewVar}->{$alias}, $details); ?> 
        + ?>
        - diff --git a/templates/layout/default.php b/templates/layout/default.php index bdccb581..bcef44b4 100644 --- a/templates/layout/default.php +++ b/templates/layout/default.php @@ -22,14 +22,14 @@ Html->image($siteTitleImage); - } - if (empty($siteTitleLink)) { - echo $this->Html->tag('span', $siteTitleContent, ['class' => 'navbar-brand', 'escape' => false]); - } else { - echo $this->Html->link($siteTitleContent, $siteTitleLink, ['class' => 'navbar-brand', 'escape' => false]); - } + if (!empty($siteTitleImage)) { + $siteTitleContent = $this->Html->image($siteTitleImage); + } + if (empty($siteTitleLink)) { + echo $this->Html->tag('span', $siteTitleContent, ['class' => 'navbar-brand', 'escape' => false]); + } else { + echo $this->Html->link($siteTitleContent, $siteTitleLink, ['class' => 'navbar-brand', 'escape' => false]); + } ?> From 9349d9665844e57e13774bd7b728b1f6c66b8e1d Mon Sep 17 00:00:00 2001 From: ADmad Date: Tue, 7 Jul 2020 17:39:57 +0530 Subject: [PATCH 73/91] Use more specific selector. --- webroot/js/local.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/webroot/js/local.js b/webroot/js/local.js index 8dff5e56..a3d288e1 100644 --- a/webroot/js/local.js +++ b/webroot/js/local.js @@ -105,7 +105,7 @@ var CrudView = { initialize: function () { this.bulkActionForm('.bulk-actions'); this.flatpickr('.flatpickr'); - this.select2('select[multiple]:not(.no-select2), .select2'); + this.select2('select[multiple]:not(.no-select2), select.select2'); this.autocomplete('input.autocomplete, select.autocomplete'); this.dirtyForms(); this.dropdown(); From 504836816ab820d32dff4e0248d03f12471bf797 Mon Sep 17 00:00:00 2001 From: ADmad Date: Thu, 16 Jul 2020 12:13:22 +0530 Subject: [PATCH 74/91] Remove leftover code. --- webroot/js/local.js | 4 ---- 1 file changed, 4 deletions(-) diff --git a/webroot/js/local.js b/webroot/js/local.js index a3d288e1..ebe5b895 100644 --- a/webroot/js/local.js +++ b/webroot/js/local.js @@ -17,10 +17,6 @@ var CrudView = { $(selector).flatpickr(); }, - selectize: function (selector) { - $(selector).selectize({plugins: ['remove_button']}); - }, - select2: function (selector) { $(selector).each(function () { var $this = $(this), From 2bb4a318765ff19215c21cc7fd78fb727e45cb91 Mon Sep 17 00:00:00 2001 From: ADmad Date: Thu, 16 Jul 2020 17:42:46 +0530 Subject: [PATCH 75/91] Improve flatpickr options juggling --- .editorconfig | 8 ++--- phpstan-baseline.neon | 46 +++++------------------- phpstan.neon | 12 ++++--- src/View/Widget/DateTimeWidget.php | 58 ++++++++++++++++++------------ 4 files changed, 53 insertions(+), 71 deletions(-) diff --git a/.editorconfig b/.editorconfig index 3a050c04..8c863121 100644 --- a/.editorconfig +++ b/.editorconfig @@ -12,12 +12,10 @@ insert_final_newline = true trim_trailing_whitespace = true [*.yml] -indent_style = space indent_size = 2 -[*.js] -indent_style = space -indent_size = 4 - [Makefile] indent_style = tab + +[*.neon] +indent_style = tab diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon index fdc99ea6..e8f069dc 100644 --- a/phpstan-baseline.neon +++ b/phpstan-baseline.neon @@ -1,57 +1,27 @@ parameters: ignoreErrors: - - message: "#^Access to an undefined property object\\:\\:\\$query\\.$#" - count: 4 - path: src/Listener/ViewListener.php - - - - message: "#^Access to an undefined property object\\:\\:\\$params\\.$#" - count: 1 - path: src/Listener/ViewListener.php - - - - message: "#^Access to an undefined property object\\:\\:\\$element\\.$#" - count: 1 - path: src/Listener/ViewListener.php - - - - message: "#^Access to an undefined property object\\:\\:\\$type\\.$#" - count: 1 - path: src/Listener/ViewListener.php - - - - message: "#^Parameter \\#2 \\$arr2 of function array_diff_key expects array, array\\|false given\\.$#" - count: 1 - path: src/Listener/ViewListener.php - - - - message: "#^Result of \\|\\| is always false\\.$#" + message: "#^Offset 'data\\-wrap' does not exist on array\\(\\?'data\\-enable\\-seconds' \\=\\> 'true', 'data\\-date\\-format' \\=\\> string, \\?'data\\-enable\\-time' \\=\\> 'true', \\?'data\\-alt\\-format' \\=\\> mixed, \\?'data\\-alt\\-input' \\=\\> 'true', \\?'data\\-no\\-calendar' \\=\\> 'true'\\)\\.$#" count: 1 - path: src/Listener/ViewListener.php - - - - message: "#^Cannot unset offset mixed on array\\(\\)\\.$#" - count: 2 - path: src/Listener/ViewListener.php + path: src/View/Widget/DateTimeWidget.php - - message: "#^Parameter \\#1 \\$field of method CrudView\\\\Listener\\\\ViewListener\\:\\:_deriveFieldFromContext\\(\\) expects string, array\\\\|string\\|null given\\.$#" + message: "#^Cannot assign offset 'class' to array\\\\|string\\.$#" count: 1 - path: src/Listener/ViewListener.php + path: src/View/Widget/DateTimeWidget.php - - message: "#^Call to an undefined method Cake\\\\ORM\\\\Table\\:\\:searchManager\\(\\)\\.$#" + message: "#^Cannot assign offset 'datetimePicker' to array\\\\|string\\.$#" count: 1 - path: src/Listener/ViewSearchListener.php + path: src/View/Widget/DateTimeWidget.php - - message: "#^Offset 'data\\-wrap' does not exist on array\\(\\?'data\\-enable\\-seconds' \\=\\> 'true', 'data\\-date\\-format' \\=\\> string, \\?'data\\-enable\\-time' \\=\\> 'true', \\?'data\\-alt\\-format' \\=\\> mixed, \\?'data\\-alt\\-input' \\=\\> 'true', \\?'data\\-no\\-calendar' \\=\\> 'true'\\)\\.$#" + message: "#^Binary operation \"\\+\" between string and array\\(\\?'data\\-enable\\-seconds' \\=\\> 'true', 'data\\-date\\-format' \\=\\> string, \\?'data\\-enable\\-time' \\=\\> 'true', \\?'data\\-alt\\-format' \\=\\> mixed, \\?'data\\-alt\\-input' \\=\\> 'true', \\?'data\\-no\\-calendar' \\=\\> 'true', \\?'data\\-alt\\-input\\-class' \\=\\> string, 'class' \\=\\> array\\('input\\-group', 'flatpickr'\\)\\) results in an error\\.$#" count: 1 path: src/View/Widget/DateTimeWidget.php - - message: "#^Binary operation \"\\+\\=\" between array\\\\|string and array\\('data\\-date\\-format' \\=\\> string, \\?'data\\-alt\\-format' \\=\\> mixed, \\?'data\\-alt\\-input' \\=\\> 'true', \\?'data\\-no\\-calendar' \\=\\> 'true', \\?'data\\-enable\\-seconds' \\=\\> 'true', \\?'data\\-enable\\-time' \\=\\> 'true', 'data\\-wrap' \\=\\> mixed\\) results in an error\\.$#" + message: "#^Binary operation \"\\+\\=\" between array\\\\|string and array\\(\\?'data\\-enable\\-seconds' \\=\\> 'true', 'data\\-date\\-format' \\=\\> string, \\?'data\\-enable\\-time' \\=\\> 'true', \\?'data\\-alt\\-format' \\=\\> mixed, \\?'data\\-alt\\-input' \\=\\> 'true', \\?'data\\-no\\-calendar' \\=\\> 'true'\\) results in an error\\.$#" count: 1 path: src/View/Widget/DateTimeWidget.php diff --git a/phpstan.neon b/phpstan.neon index 5c6d272c..8473436d 100644 --- a/phpstan.neon +++ b/phpstan.neon @@ -1,8 +1,10 @@ includes: - - phpstan-baseline.neon + - phpstan-baseline.neon parameters: - level: 7 - checkMissingIterableValueType: false - universalObjectCratesClasses: - - Crud\Event\Subject + level: 7 + checkMissingIterableValueType: false + paths: + - src + universalObjectCratesClasses: + - Crud\Event\Subject diff --git a/src/View/Widget/DateTimeWidget.php b/src/View/Widget/DateTimeWidget.php index d4719ab1..7be993cd 100644 --- a/src/View/Widget/DateTimeWidget.php +++ b/src/View/Widget/DateTimeWidget.php @@ -8,6 +8,19 @@ class DateTimeWidget extends \BootstrapUI\View\Widget\DateTimeWidget { + // phpcs:disable + /** + * @var string + */ + protected $defaultTemplate = '
        ' + . '{{input}}' + . '
        ' + . '' + . '' + . '
        ' + . '
        '; + // phpcs:enable + /** * Render flatpickr * @@ -48,8 +61,7 @@ public function render(array $data, ContextInterface $context): string unset($data['val'], $data['timezone']); // This is the format for value POSTed to server - $datetimePicker['data-date-format'] = $this->formatMap[$data['type']]; - $datetimePicker['data-date-format'] = $this->convertPHPToDatePickerFormat($datetimePicker['data-date-format']); + $datetimePicker['data-date-format'] = $this->convertPHPToDatePickerFormat($this->formatMap[$data['type']]); // This just to allow upgrading easier if (isset($data['data-format'])) { @@ -73,37 +85,33 @@ public function render(array $data, ContextInterface $context): string $datetimePicker += ['data-enable-seconds' => 'true']; } - $iconClass = 'fa fa-calendar-alt'; + $clearIconClass = 'fa fa-times'; + $toggleIconClass = 'fa fa-calendar-alt'; if (isset($datetimePicker['iconClass'])) { - $iconClass = $datetimePicker['iconClass']; + $toggleIconClass = $datetimePicker['iconClass']; unset($datetimePicker['iconClass']); } elseif ($data['type'] === 'time') { - $iconClass = 'fa fa-clock'; + $toggleIconClass = 'fa fa-clock'; } if ($this->_templates->get('datetimePicker') === null) { - // phpcs:disable - $this->_templates->add([ - 'datetimePicker' => - '
        ' - . '{{input}}' - . '
        ' - . '' - . '' - . '
        ' - . '
        ', - ]); - // phpcs:enable + $this->_templates->add(['datetimePicker' => $this->defaultTemplate]); } $data = $this->_templates->addClass($data, 'form-control'); - $noWrap = false; - if ($datetimePicker['data-wrap'] === 'true') { + $wrap = $datetimePicker['data-wrap'] === 'true'; + if ($wrap) { + if (isset($data['class'])) { + $datetimePicker['data-alt-input-class'] = $data['class']; + } $datetimePicker['class'] = ['input-group', 'flatpickr']; + if (isset($data['datetimePicker'])) { + $datetimePicker = $data['datetimePicker'] + $datetimePicker; + unset($data['datetimePicker']); + } } else { $data += $datetimePicker; $data = $this->_templates->addClass($data, 'flatpickr'); - $noWrap = true; } /** @@ -120,16 +128,20 @@ public function render(array $data, ContextInterface $context): string ), ]); - if ($noWrap) { + if (!$wrap) { return $input; } /** @psalm-suppress PossiblyInvalidArrayOffset */ return $this->_templates->format('datetimePicker', [ 'input' => $input, - 'iconClass' => $iconClass, - 'attrs' => $this->_templates->formatAttributes($datetimePicker), + 'toggleIconClass' => $toggleIconClass, + 'clearIconClass' => $clearIconClass, 'templateVars' => $data['templateVars'], + 'attrs' => $this->_templates->formatAttributes( + $datetimePicker, + ['toggleIconClass', 'clearIconClass'] + ), ]); } From 7cc0ecc9c2f484c3ea5f389f6756503f4000a86d Mon Sep 17 00:00:00 2001 From: ADmad Date: Thu, 16 Jul 2020 17:48:11 +0530 Subject: [PATCH 76/91] Cleanup CSS. Remove glyphicons. --- webroot/css/local.css | 43 ++++++++++++++++++++----------------------- 1 file changed, 20 insertions(+), 23 deletions(-) diff --git a/webroot/css/local.css b/webroot/css/local.css index c3ae74f8..94b1ad82 100644 --- a/webroot/css/local.css +++ b/webroot/css/local.css @@ -1,37 +1,28 @@ -/****************************************************************************** - * Use cloudflare's glyphicons - *****************************************************************************/ -@font-face { - font-family: 'Glyphicons Halflings'; - - src: url('https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.4/fonts/glyphicons-halflings-regular.eot'); - src: url('https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.4/fonts/glyphicons-halflings-regular.eot?#iefix') format('embedded-opentype'), - url('https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.4/fonts/glyphicons-halflings-regular.woff2') format('woff2'), - url('https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.4/fonts/glyphicons-halflings-regular.woff') format('woff'), - url('https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.4/fonts/glyphicons-halflings-regular.ttf') format('truetype'), - url('https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.4/fonts/glyphicons-halflings-regular.svg#glyphicons_halflingsregular') format('svg'); -} - - /****************************************************************************** * Generic form hacks *****************************************************************************/ + .bulk-action { width: 32px; } + .bulk-action .checkbox { margin-bottom: 0; } + .bulk-action-submit { width: 50%; } + .bulk-action-submit label { width: auto; } + .bulk-action-submit select { display: inline-block; width: 50%; } + .bulk-action-submit input { width: auto; } @@ -74,36 +65,42 @@ h2 .actions { } .text-truncate { - white-space: nowrap; - overflow: hidden; - text-overflow: ellipsis; + white-space: nowrap; + overflow: hidden; + text-overflow: ellipsis; } + .gallery-content { text-align: center; } + .pagination-wrapper { clear: both; margin: 20px 0; text-align: center; } + .download-links { float: left; } + .pagination-container { float: right } + .pagination-container .pagination { margin: 0; } + table tr td.actions { white-space: nowrap; width: 1px; } .nav > li > .nav-header { - border-radius: 4px; - display: block; - font-weight: bold; - padding: 10px 15px; - position: relative; + border-radius: 4px; + display: block; + font-weight: bold; + padding: 10px 15px; + position: relative; } From 251a89953da146c78d74b7970786c9149f26ca65 Mon Sep 17 00:00:00 2001 From: ADmad Date: Thu, 16 Jul 2020 17:52:20 +0530 Subject: [PATCH 77/91] Use new FontAwesome 5 class. "fa" is deprecated. --- src/View/Widget/DateTimeWidget.php | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/View/Widget/DateTimeWidget.php b/src/View/Widget/DateTimeWidget.php index 7be993cd..3a58e96d 100644 --- a/src/View/Widget/DateTimeWidget.php +++ b/src/View/Widget/DateTimeWidget.php @@ -85,13 +85,13 @@ public function render(array $data, ContextInterface $context): string $datetimePicker += ['data-enable-seconds' => 'true']; } - $clearIconClass = 'fa fa-times'; - $toggleIconClass = 'fa fa-calendar-alt'; + $clearIconClass = 'fas fa-times'; + $toggleIconClass = 'fas fa-calendar-alt'; if (isset($datetimePicker['iconClass'])) { $toggleIconClass = $datetimePicker['iconClass']; unset($datetimePicker['iconClass']); } elseif ($data['type'] === 'time') { - $toggleIconClass = 'fa fa-clock'; + $toggleIconClass = 'fas fa-clock'; } if ($this->_templates->get('datetimePicker') === null) { From c78fe3e8a5a7ddc16880836cc082ab8bec19be8a Mon Sep 17 00:00:00 2001 From: ADmad Date: Sat, 29 Aug 2020 01:05:06 +0530 Subject: [PATCH 78/91] Remove unneeded class existence check --- src/View/CrudView.php | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/src/View/CrudView.php b/src/View/CrudView.php index 54aae9f6..86b77323 100644 --- a/src/View/CrudView.php +++ b/src/View/CrudView.php @@ -118,13 +118,10 @@ protected function _setupHelpers(): void ], 'Flash' => ['className' => 'BootstrapUI.Flash'], 'Paginator' => ['className' => 'BootstrapUI.Paginator'], + 'Breadcrumbs' => ['className' => 'BootstrapUI.Breadcrumbs'], 'CrudView' => ['className' => 'CrudView.CrudView'], ]; - if (class_exists('\Cake\View\Helper\BreadcrumbsHelper')) { - $helpers['Breadcrumbs'] = ['className' => 'BootstrapUI.Breadcrumbs']; - } - if (Configure::read('CrudView.useAssetCompress')) { $helpers['AssetCompress'] = ['className' => 'AssetCompress.AssetCompress']; } From 1a47afea58834b6ca7eb53afcb1e06cdafb7b327 Mon Sep 17 00:00:00 2001 From: ADmad Date: Sat, 29 Aug 2020 01:08:11 +0530 Subject: [PATCH 79/91] Update phpstan's baseline file --- phpstan-baseline.neon | 45 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon index e8f069dc..4886d491 100644 --- a/phpstan-baseline.neon +++ b/phpstan-baseline.neon @@ -1,5 +1,50 @@ parameters: ignoreErrors: + - + message: "#^Access to an undefined property object\\:\\:\\$query\\.$#" + count: 4 + path: src/Listener/ViewListener.php + + - + message: "#^Access to an undefined property object\\:\\:\\$params\\.$#" + count: 1 + path: src/Listener/ViewListener.php + + - + message: "#^Access to an undefined property object\\:\\:\\$element\\.$#" + count: 1 + path: src/Listener/ViewListener.php + + - + message: "#^Access to an undefined property object\\:\\:\\$type\\.$#" + count: 1 + path: src/Listener/ViewListener.php + + - + message: "#^Parameter \\#2 \\$arr2 of function array_diff_key expects array, array\\|false given\\.$#" + count: 1 + path: src/Listener/ViewListener.php + + - + message: "#^Result of \\|\\| is always false\\.$#" + count: 1 + path: src/Listener/ViewListener.php + + - + message: "#^Cannot unset offset mixed on array\\(\\)\\.$#" + count: 2 + path: src/Listener/ViewListener.php + + - + message: "#^Parameter \\#1 \\$field of method CrudView\\\\Listener\\\\ViewListener\\:\\:_deriveFieldFromContext\\(\\) expects string, array\\\\|string\\|null given\\.$#" + count: 1 + path: src/Listener/ViewListener.php + + - + message: "#^Call to an undefined method Cake\\\\ORM\\\\Table\\:\\:searchManager\\(\\)\\.$#" + count: 1 + path: src/Listener/ViewSearchListener.php + - message: "#^Offset 'data\\-wrap' does not exist on array\\(\\?'data\\-enable\\-seconds' \\=\\> 'true', 'data\\-date\\-format' \\=\\> string, \\?'data\\-enable\\-time' \\=\\> 'true', \\?'data\\-alt\\-format' \\=\\> mixed, \\?'data\\-alt\\-input' \\=\\> 'true', \\?'data\\-no\\-calendar' \\=\\> 'true'\\)\\.$#" count: 1 From 196bc5c9f8dbdc555222adac1643e53cec6a0dfd Mon Sep 17 00:00:00 2001 From: ADmad Date: Sat, 29 Aug 2020 01:15:37 +0530 Subject: [PATCH 80/91] Fix test failures --- tests/comparisons/View/Widget/DateTimeWidget/simple.html | 8 +++++--- .../View/Widget/DateTimeWidget/with-date-value.html | 8 +++++--- .../View/Widget/DateTimeWidget/with-string-value.html | 8 +++++--- 3 files changed, 15 insertions(+), 9 deletions(-) diff --git a/tests/comparisons/View/Widget/DateTimeWidget/simple.html b/tests/comparisons/View/Widget/DateTimeWidget/simple.html index 7e68fff5..f9d71e91 100644 --- a/tests/comparisons/View/Widget/DateTimeWidget/simple.html +++ b/tests/comparisons/View/Widget/DateTimeWidget/simple.html @@ -1,5 +1,5 @@
        @@ -13,17 +13,19 @@
        diff --git a/tests/comparisons/View/Widget/DateTimeWidget/with-date-value.html b/tests/comparisons/View/Widget/DateTimeWidget/with-date-value.html index 2cf1b71c..ba1e73f3 100644 --- a/tests/comparisons/View/Widget/DateTimeWidget/with-date-value.html +++ b/tests/comparisons/View/Widget/DateTimeWidget/with-date-value.html @@ -1,5 +1,5 @@
        @@ -13,17 +13,19 @@
        diff --git a/tests/comparisons/View/Widget/DateTimeWidget/with-string-value.html b/tests/comparisons/View/Widget/DateTimeWidget/with-string-value.html index 26bd06ee..5e17c638 100644 --- a/tests/comparisons/View/Widget/DateTimeWidget/with-string-value.html +++ b/tests/comparisons/View/Widget/DateTimeWidget/with-string-value.html @@ -1,5 +1,5 @@
        @@ -13,17 +13,19 @@
        From 39ad1ce55282f912b9865fbb8d5a1c617dabd8d4 Mon Sep 17 00:00:00 2001 From: ADmad Date: Sat, 29 Aug 2020 01:16:28 +0530 Subject: [PATCH 81/91] Fix typo --- src/Listener/Traits/DeprecatedConfigurationKeyTrait.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Listener/Traits/DeprecatedConfigurationKeyTrait.php b/src/Listener/Traits/DeprecatedConfigurationKeyTrait.php index a6fb59aa..81e78aac 100644 --- a/src/Listener/Traits/DeprecatedConfigurationKeyTrait.php +++ b/src/Listener/Traits/DeprecatedConfigurationKeyTrait.php @@ -12,7 +12,7 @@ trait DeprecatedConfigurationKeyTrait * @param string $newKey Name of key that should be used instead of the deprecated key * @return void **/ - protected function deprecatedScaffoldKeyNotice(string $deprecatedKey, strin $newKey): void + protected function deprecatedScaffoldKeyNotice(string $deprecatedKey, string $newKey): void { $template = 'The configuration key %s has been deprecated. Use %s instead.'; $message = sprintf($template, $deprecatedKey, $newKey); From 448dc6442f54a3d7a727f171f4a004e9bd319d4a Mon Sep 17 00:00:00 2001 From: ADmad Date: Sat, 29 Aug 2020 01:17:22 +0530 Subject: [PATCH 82/91] Rename templates/Scaffold to templates/scaffold --- src/View/CrudView.php | 2 +- templates/{Scaffold => scaffold}/add.php | 0 templates/{Scaffold => scaffold}/dashboard.php | 0 templates/{Scaffold => scaffold}/edit.php | 0 templates/{Scaffold => scaffold}/index.php | 0 templates/{Scaffold => scaffold}/view.php | 0 6 files changed, 1 insertion(+), 1 deletion(-) rename templates/{Scaffold => scaffold}/add.php (100%) rename templates/{Scaffold => scaffold}/dashboard.php (100%) rename templates/{Scaffold => scaffold}/edit.php (100%) rename templates/{Scaffold => scaffold}/index.php (100%) rename templates/{Scaffold => scaffold}/view.php (100%) diff --git a/src/View/CrudView.php b/src/View/CrudView.php index 86b77323..a4b827a6 100644 --- a/src/View/CrudView.php +++ b/src/View/CrudView.php @@ -222,7 +222,7 @@ protected function _getTemplateFileName(?string $name = null): string return parent::_getTemplateFileName($name); } catch (MissingTemplateException $exception) { $this->subDir = ''; - $this->templatePath = 'Scaffold'; + $this->templatePath = 'scaffold'; } try { return parent::_getTemplateFileName($this->template); diff --git a/templates/Scaffold/add.php b/templates/scaffold/add.php similarity index 100% rename from templates/Scaffold/add.php rename to templates/scaffold/add.php diff --git a/templates/Scaffold/dashboard.php b/templates/scaffold/dashboard.php similarity index 100% rename from templates/Scaffold/dashboard.php rename to templates/scaffold/dashboard.php diff --git a/templates/Scaffold/edit.php b/templates/scaffold/edit.php similarity index 100% rename from templates/Scaffold/edit.php rename to templates/scaffold/edit.php diff --git a/templates/Scaffold/index.php b/templates/scaffold/index.php similarity index 100% rename from templates/Scaffold/index.php rename to templates/scaffold/index.php diff --git a/templates/Scaffold/view.php b/templates/scaffold/view.php similarity index 100% rename from templates/Scaffold/view.php rename to templates/scaffold/view.php From d8277aac2fa746a1f1cd12fc6b9bffcd59b82532 Mon Sep 17 00:00:00 2001 From: ADmad Date: Wed, 9 Sep 2020 19:11:40 +0530 Subject: [PATCH 83/91] Remove dependency on font awesome --- config/asset_compress.ini | 1 - src/View/Widget/DateTimeWidget.php | 41 +++++++++++++++++++++++------- 2 files changed, 32 insertions(+), 10 deletions(-) diff --git a/config/asset_compress.ini b/config/asset_compress.ini index df092ae6..a54b68e2 100644 --- a/config/asset_compress.ini +++ b/config/asset_compress.ini @@ -1,5 +1,4 @@ [crudview.css] -files[]=https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@5.13/css/all.min.css files[]=https://cdn.jsdelivr.net/npm/bootstrap@^4.5/dist/css/bootstrap.min.css files[]=https://cdn.jsdelivr.net/npm/flatpickr@4.6/dist/flatpickr.min.css files[]=https://cdn.jsdelivr.net/npm/select2@4.0/dist/css/select2.min.css diff --git a/src/View/Widget/DateTimeWidget.php b/src/View/Widget/DateTimeWidget.php index 3a58e96d..37ffd18c 100644 --- a/src/View/Widget/DateTimeWidget.php +++ b/src/View/Widget/DateTimeWidget.php @@ -15,10 +15,33 @@ class DateTimeWidget extends \BootstrapUI\View\Widget\DateTimeWidget protected $defaultTemplate = '
        ' . '{{input}}' . '
        ' - . '' - . '' + . '' + . '' . '
        ' . '
        '; + + /** + * @var string + */ + protected $calendarIcon = '' + . '' + . ''; + + /** + * @var string + */ + protected $clockIcon = '' + . '' + . '' + . ''; + + /** + * @var string + */ + protected $clearIcon = '' + . '' + . '' + . ''; // phpcs:enable /** @@ -85,13 +108,13 @@ public function render(array $data, ContextInterface $context): string $datetimePicker += ['data-enable-seconds' => 'true']; } - $clearIconClass = 'fas fa-times'; - $toggleIconClass = 'fas fa-calendar-alt'; + $clearIcon = $this->clearIcon; + $toggleIcon = $this->calendarIcon; if (isset($datetimePicker['iconClass'])) { - $toggleIconClass = $datetimePicker['iconClass']; + $toggleIcon = $datetimePicker['iconClass']; unset($datetimePicker['iconClass']); } elseif ($data['type'] === 'time') { - $toggleIconClass = 'fas fa-clock'; + $toggleIcon = $this->clockIcon; } if ($this->_templates->get('datetimePicker') === null) { @@ -135,12 +158,12 @@ public function render(array $data, ContextInterface $context): string /** @psalm-suppress PossiblyInvalidArrayOffset */ return $this->_templates->format('datetimePicker', [ 'input' => $input, - 'toggleIconClass' => $toggleIconClass, - 'clearIconClass' => $clearIconClass, + 'toggleIcon' => $toggleIcon, + 'clearIcon' => $clearIcon, 'templateVars' => $data['templateVars'], 'attrs' => $this->_templates->formatAttributes( $datetimePicker, - ['toggleIconClass', 'clearIconClass'] + ['toggleIcon', 'clearIcon'] ), ]); } From 98da929febef8205b99f8af84e1f66c2abc73a40 Mon Sep 17 00:00:00 2001 From: Hans-Joachim Michl Date: Fri, 11 Sep 2020 15:14:40 +0800 Subject: [PATCH 84/91] Fix issue #280 The associations are inflected tabelized, not lowercased. This is a prerequesite and doesn't need to be inflected here: $action->setConfig('scaffold.relations', ['users']); in a Controller throws an exception, 'Users' works. --- src/Listener/ViewListener.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Listener/ViewListener.php b/src/Listener/ViewListener.php index 23ec7612..7f3c0397 100644 --- a/src/Listener/ViewListener.php +++ b/src/Listener/ViewListener.php @@ -554,7 +554,7 @@ protected function _associations(array $whitelist = []): array $keys = $associations->keys(); if (!empty($whitelist)) { - $keys = array_intersect($keys, array_map('strtolower', $whitelist)); + $keys = array_intersect($keys, $whitelist); } foreach ($keys as $associationName) { /** @var \Cake\ORM\Association $association */ From 1e875fd30dff367e9179c553eecc83b76680572e Mon Sep 17 00:00:00 2001 From: ADmad Date: Fri, 11 Sep 2020 13:34:32 +0530 Subject: [PATCH 85/91] Fix tests for changes done in d8277aac2fa746a1f1cd12fc6b9bffcd59b82532. --- .../View/Widget/DateTimeWidget/simple.html | 31 +++++++++++++++---- .../DateTimeWidget/with-date-value.html | 31 +++++++++++++++---- .../DateTimeWidget/with-string-value.html | 31 +++++++++++++++---- 3 files changed, 75 insertions(+), 18 deletions(-) diff --git a/tests/comparisons/View/Widget/DateTimeWidget/simple.html b/tests/comparisons/View/Widget/DateTimeWidget/simple.html index f9d71e91..b1f84ce4 100644 --- a/tests/comparisons/View/Widget/DateTimeWidget/simple.html +++ b/tests/comparisons/View/Widget/DateTimeWidget/simple.html @@ -16,17 +16,36 @@ title="Toggle" type="button" class="btn input-group-text"> - - + + +
        diff --git a/tests/comparisons/View/Widget/DateTimeWidget/with-date-value.html b/tests/comparisons/View/Widget/DateTimeWidget/with-date-value.html index ba1e73f3..1ae26bdb 100644 --- a/tests/comparisons/View/Widget/DateTimeWidget/with-date-value.html +++ b/tests/comparisons/View/Widget/DateTimeWidget/with-date-value.html @@ -16,17 +16,36 @@ title="Toggle" type="button" class="btn input-group-text"> - - + + +
        diff --git a/tests/comparisons/View/Widget/DateTimeWidget/with-string-value.html b/tests/comparisons/View/Widget/DateTimeWidget/with-string-value.html index 5e17c638..f5056d18 100644 --- a/tests/comparisons/View/Widget/DateTimeWidget/with-string-value.html +++ b/tests/comparisons/View/Widget/DateTimeWidget/with-string-value.html @@ -16,17 +16,36 @@ title="Toggle" type="button" class="btn input-group-text"> - - + + + From a7a09ab8a9aeb278cbcaf6bd78d2c47caff91797 Mon Sep 17 00:00:00 2001 From: ADmad Date: Fri, 11 Sep 2020 13:50:55 +0530 Subject: [PATCH 86/91] Update docs --- docs/_partials/fields/field-blacklist.rst | 2 +- docs/_partials/fields/field-settings.rst | 2 +- docs/_partials/fields/formatter-callable.rst | 6 +-- docs/_partials/fields/formatter-element.rst | 4 +- docs/_partials/fields/index.rst | 4 +- docs/_partials/fields/sorting.rst | 2 +- docs/_partials/fields/tab-groups.rst | 4 +- docs/_partials/pages/dashboard/elements.rst | 6 +-- docs/_partials/pages/form/elements.rst | 8 ++-- docs/_partials/pages/form/submission.rst | 2 +- docs/_partials/pages/form/submit-buttons.rst | 14 +++---- docs/_partials/pages/index/bulk-actions.rst | 2 +- docs/_partials/pages/index/buttons.rst | 24 +++++------ .../pages/index/download-format-links.rst | 4 +- docs/_partials/pages/index/filters.rst | 9 ++++- docs/_partials/pages/index/finder-scopes.rst | 4 +- docs/basic-usage.rst | 40 ++++++++++--------- docs/customizing-templates.rst | 6 +-- .../customizing-the-dashboard-page.rst | 4 +- docs/general-configuration/breadcrumbs.rst | 8 ++-- .../sidebar-navigation.rst | 8 ++-- .../site-title-options.rst | 8 ++-- .../utility-navigation.rst | 4 +- docs/index-pages/components/blog.rst | 4 +- docs/index-pages/components/custom.rst | 2 +- docs/index-pages/components/gallery.rst | 12 +++--- docs/index-pages/components/table.rst | 22 +++++----- .../customizing-the-index-page.rst | 2 +- docs/installation.rst | 2 +- docs/quick-start.rst | 19 ++------- 30 files changed, 117 insertions(+), 121 deletions(-) diff --git a/docs/_partials/fields/field-blacklist.rst b/docs/_partials/fields/field-blacklist.rst index 33fa05aa..ca3a2e12 100644 --- a/docs/_partials/fields/field-blacklist.rst +++ b/docs/_partials/fields/field-blacklist.rst @@ -8,4 +8,4 @@ functionality: .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.fields_blacklist', ['created', 'modified']); + $action->setConfig('scaffold.fields_blacklist', ['created', 'modified']); diff --git a/docs/_partials/fields/field-settings.rst b/docs/_partials/fields/field-settings.rst index d60bd357..c2093c10 100644 --- a/docs/_partials/fields/field-settings.rst +++ b/docs/_partials/fields/field-settings.rst @@ -8,7 +8,7 @@ to specify settings for a few of the fields, you can use the .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.field_settings', [ + $action->setConfig('scaffold.field_settings', [ 'title' => [ // options here ] diff --git a/docs/_partials/fields/formatter-callable.rst b/docs/_partials/fields/formatter-callable.rst index 84da1b68..31ecdb75 100644 --- a/docs/_partials/fields/formatter-callable.rst +++ b/docs/_partials/fields/formatter-callable.rst @@ -21,7 +21,7 @@ wanted to also display who approved the article: .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.fields', [ + $action->setConfig('scaffold.fields', [ 'title', 'published_time' => [ 'formatter' => function ($name, $value, $entity) { @@ -37,7 +37,7 @@ only configure the settings for one or two. .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.field_settings', [ + $action->setConfig('scaffold.field_settings', [ 'published_time' => [ 'formatter' => function ($name, Time $value, Entity $entity) { return $value->nice() . sprintf(' (Approved by %s)', $entity->approver->name); @@ -50,7 +50,7 @@ In some cases, it may be useful to access a helper within the callable. For inst .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.fields', [ + $action->setConfig('scaffold.fields', [ 'title', 'external_id' => [ 'formatter' => function ($name, $value, $entity, $options, $View) { diff --git a/docs/_partials/fields/formatter-element.rst b/docs/_partials/fields/formatter-element.rst index 70817440..9dc16c29 100644 --- a/docs/_partials/fields/formatter-element.rst +++ b/docs/_partials/fields/formatter-element.rst @@ -16,7 +16,7 @@ to the same index action by passing some search arguments: .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.fields', [ + $action->setConfig('scaffold.fields', [ 'published_time' => [ 'formatter' => 'element', 'element' => 'search/published_time', @@ -29,7 +29,7 @@ it is just a matter of creating the element file with the right content: .. code-block:: php - // src/Template/Element/search/published_time.ctp + // templates/element/search/published_time.ctp echo $this->Html->link($value->timeAgoInWords(), [ 'action' => $options['action'], diff --git a/docs/_partials/fields/index.rst b/docs/_partials/fields/index.rst index 4189e4e3..f3519b5a 100644 --- a/docs/_partials/fields/index.rst +++ b/docs/_partials/fields/index.rst @@ -8,7 +8,7 @@ in scope. To limit the fields used, simply specify an array of fields. .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.fields', ['title', 'description']); + $action->setConfig('scaffold.fields', ['title', 'description']); You may also specify an options array. For forms, *CrudView* makes use of the ``FormHelper::inputs()`` method and will pass your array values as options when @@ -17,7 +17,7 @@ generating the output. .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.fields', [ + $action->setConfig('scaffold.fields', [ 'title', 'thread_id' => [ 'type' => 'text' diff --git a/docs/_partials/fields/sorting.rst b/docs/_partials/fields/sorting.rst index 52d366b2..f3216b12 100644 --- a/docs/_partials/fields/sorting.rst +++ b/docs/_partials/fields/sorting.rst @@ -8,7 +8,7 @@ the ``disableSort`` option: .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.fields', [ + $action->setConfig('scaffold.fields', [ 'title' => [ 'disableSort' => true, ] diff --git a/docs/_partials/fields/tab-groups.rst b/docs/_partials/fields/tab-groups.rst index 4fc9842e..f23e99a3 100644 --- a/docs/_partials/fields/tab-groups.rst +++ b/docs/_partials/fields/tab-groups.rst @@ -7,7 +7,7 @@ configuration key: .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.form_tab_groups', [ + $action->setConfig('scaffold.form_tab_groups', [ 'First Tab Header' => ['field_1', 'field_2'], 'Second Tab Header' => ['field_3', 'field_4'], ]); @@ -19,4 +19,4 @@ the primary group's name using `scaffold.form_primary_tab` config. .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.form_primary_tab', 'Key Info'); + $action->setConfig('scaffold.form_primary_tab', 'Key Info'); diff --git a/docs/_partials/pages/dashboard/elements.rst b/docs/_partials/pages/dashboard/elements.rst index 81eff7ec..e0c394e3 100644 --- a/docs/_partials/pages/dashboard/elements.rst +++ b/docs/_partials/pages/dashboard/elements.rst @@ -2,15 +2,15 @@ Available Elements ------------------ All the *CrudView* templates are built from several elements that can be -overridden by creating them in your own ``src/Template/Element`` folder. The +overridden by creating them in your own ``templates/element`` folder. The following sections will list all the elements that can be overridden for each type of action. In general, if you want to override a template, it is a good idea to copy the original implementation from -``vendor/friendsofcake/crud-view/src/Template/Element`` +``vendor/friendsofcake/crud-view/templates/element`` action-header - Create ``src/Template/Element/action-header.ctp`` to have full control over + Create ``templates/element/action-header.ctp`` to have full control over what is displayed at the top of the page. This is shared across all page types. diff --git a/docs/_partials/pages/form/elements.rst b/docs/_partials/pages/form/elements.rst index 27d73cd3..fc8bb2dd 100644 --- a/docs/_partials/pages/form/elements.rst +++ b/docs/_partials/pages/form/elements.rst @@ -2,20 +2,20 @@ Available Elements ------------------ All the *CrudView* templates are built from several elements that can be -overridden by creating them in your own ``src/Template/Element`` folder. The +overridden by creating them in your own ``templates/element`` folder. The following sections will list all the elements that can be overridden for each type of action. In general, if you want to override a template, it is a good idea to copy the original implementation from -``vendor/friendsofcake/crud-view/src/Template/Element`` +``vendor/friendsofcake/crud-view/templates/element`` action-header - Create ``src/Template/Element/action-header.ctp`` to have full control over + Create ``templates/element/action-header.ctp`` to have full control over what is displayed at the top of the page. This is shared across all page types. form/buttons - Create ``src/Template/Element/form/buttons.ctp`` to change what is displayed + Create ``templates/element/form/buttons.ctp`` to change what is displayed for form submission. You can expect the ``$formSubmitButtonText`` and ``$formSubmitExtraButtons`` variables to be available diff --git a/docs/_partials/pages/form/submission.rst b/docs/_partials/pages/form/submission.rst index c7e502d9..b6d3781b 100644 --- a/docs/_partials/pages/form/submission.rst +++ b/docs/_partials/pages/form/submission.rst @@ -22,4 +22,4 @@ However, you may force a user prompt by enabling dirty form checks using the .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.form_enable_dirty_check', true); + $action->setConfig('scaffold.form_enable_dirty_check', true); diff --git a/docs/_partials/pages/form/submit-buttons.rst b/docs/_partials/pages/form/submit-buttons.rst index b161026f..4f60e1c6 100644 --- a/docs/_partials/pages/form/submit-buttons.rst +++ b/docs/_partials/pages/form/submit-buttons.rst @@ -10,7 +10,7 @@ You can change the submit button text from it's default using the .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.form_submit_button_text', _('Submit')); + $action->setConfig('scaffold.form_submit_button_text', _('Submit')); Modifying the Default Extra Buttons ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -27,7 +27,7 @@ to true: .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.form_submit_extra_buttons', true); + $action->setConfig('scaffold.form_submit_extra_buttons', true); You can also customize this by using the ``scaffold.form_submit_extra_buttons`` configuration key as follows: @@ -35,7 +35,7 @@ configuration key as follows: .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.form_submit_extra_buttons', [ + $action->setConfig('scaffold.form_submit_extra_buttons', [ [ 'title' => __d('crud', 'Save & continue editing'), 'options' => ['class' => 'btn btn-success btn-save-continue', 'name' => '_edit', 'value' => true], @@ -73,7 +73,7 @@ to true: .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.form_submit_extra_left_buttons', true); + $action->setConfig('scaffold.form_submit_extra_left_buttons', true); You can also customize this by using the ``scaffold.form_submit_extra_left_buttons`` configuration key as follows: @@ -81,7 +81,7 @@ configuration key as follows: .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.form_submit_extra_left_buttons', [ + $action->setConfig('scaffold.form_submit_extra_left_buttons', [ [ 'title' => __d('crud', 'Save & continue editing'), 'options' => ['class' => 'btn btn-success btn-save-continue', 'name' => '_edit', 'value' => true], @@ -98,7 +98,7 @@ completely: .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.form_submit_extra_buttons', false); + $action->setConfig('scaffold.form_submit_extra_buttons', false); Disabling the Default Extra Left Buttons ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -108,4 +108,4 @@ Disabling the default left extra buttons can also be done in a similar fashion: .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.form_submit_extra_left_buttons', false); + $action->setConfig('scaffold.form_submit_extra_left_buttons', false); diff --git a/docs/_partials/pages/index/bulk-actions.rst b/docs/_partials/pages/index/bulk-actions.rst index f4d39dae..e50d5867 100644 --- a/docs/_partials/pages/index/bulk-actions.rst +++ b/docs/_partials/pages/index/bulk-actions.rst @@ -22,6 +22,6 @@ array of key/value pairs, where the key is the url and the value is the title. .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.bulk_actions', [ + $action->setConfig('scaffold.bulk_actions', [ Router::url(['action' => 'deleteAll']) => __('Delete records'), ]); diff --git a/docs/_partials/pages/index/buttons.rst b/docs/_partials/pages/index/buttons.rst index 9c8d8a54..2b053488 100644 --- a/docs/_partials/pages/index/buttons.rst +++ b/docs/_partials/pages/index/buttons.rst @@ -10,12 +10,12 @@ key: $action = $this->Crud->action(); // restrict to just the add button, which will show up globally - $action->config('scaffold.actions', [ + $action->setConfig('scaffold.actions', [ 'add' ]); // restrict to just the delete/edit/view actions, which are scoped to entities - $action->config('scaffold.actions', [ + $action->setConfig('scaffold.actions', [ 'delete', 'edit', 'view', @@ -27,7 +27,7 @@ generating action buttons. .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.actions', [ + $action->setConfig('scaffold.actions', [ 'duplicate' => [ // An alternative title for the action 'link_title' => 'Duplicate this record', @@ -60,7 +60,7 @@ the link by default: // For the PostsController, will generate // /posts/translate/english/1 - $action->config('scaffold.actions', [ + $action->setConfig('scaffold.actions', [ 'translate' => [ 'url' => ['action' => 'translate', 'english'] ] @@ -76,7 +76,7 @@ specified. // For the PostsController, will generate // /posts/translate/1/english - $action->config('scaffold.actions', [ + $action->setConfig('scaffold.actions', [ 'translate' => [ 'url' => ['action' => 'translate', ':primaryKey:', 'english'] ] @@ -92,7 +92,7 @@ Crud action classes are mapped but should not all be shown on the main UI. .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.actions_blacklist', ['add', 'delete']); + $action->setConfig('scaffold.actions_blacklist', ['add', 'delete']); By default, we blacklist the action which is mapped to ``Crud.LookupAction``. As this action is meant to be used solely for autocompletion, it *cannot* be removed @@ -108,8 +108,8 @@ configuration key. .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.actions', ['view', 'edit', 'delete']); - $action->config('scaffold.action_groups', [ + $action->setConfig('scaffold.actions', ['view', 'edit', 'delete']); + $action->setConfig('scaffold.action_groups', [ 'Actions' => [ 'view', 'edit', @@ -125,8 +125,8 @@ You can specify multiple action groups: .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.actions', ['view', 'edit', 'delete', 'disable', 'delete']); - $action->config('scaffold.action_groups', [ + $action->setConfig('scaffold.actions', ['view', 'edit', 'delete', 'disable', 'delete']); + $action->setConfig('scaffold.action_groups', [ 'Actions' => [ 'view', 'edit', @@ -143,8 +143,8 @@ Finally, you can also set configuration for each entry in an action group: .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.actions', ['view', 'edit', 'delete', 'english', 'spanish']); - $action->config('scaffold.action_groups', [ + $action->setConfig('scaffold.actions', ['view', 'edit', 'delete', 'english', 'spanish']); + $action->setConfig('scaffold.action_groups', [ 'Actions' => [ 'view', 'edit', diff --git a/docs/_partials/pages/index/download-format-links.rst b/docs/_partials/pages/index/download-format-links.rst index eba4d217..0c6f0f53 100644 --- a/docs/_partials/pages/index/download-format-links.rst +++ b/docs/_partials/pages/index/download-format-links.rst @@ -17,7 +17,7 @@ Each sub-array should contain ``title`` and ``url`` parameters. // include the querystring argument as specified or you will lose any // currently applied filters $action = $this->Crud->action(); - $action->config('scaffold.index_formats', [ + $action->setConfig('scaffold.index_formats', [ [ 'title' => 'JSON', 'url' => ['_ext' => 'json', '?' => $this->request->getQueryParams()] @@ -83,7 +83,7 @@ can be modified to add a CSV Download Link. $this->set('_extract', ['id', 'active', 'title', 'created']); } - $this->Crud->action()->config('scaffold.index_formats', [ + $this->Crud->action()->setConfig('scaffold.index_formats', [ [ 'title' => 'CSV', 'url' => ['_ext' => 'csv', '?' => $this->request->getQueryParams()] diff --git a/docs/_partials/pages/index/filters.rst b/docs/_partials/pages/index/filters.rst index 574af032..9ef14269 100644 --- a/docs/_partials/pages/index/filters.rst +++ b/docs/_partials/pages/index/filters.rst @@ -8,12 +8,14 @@ to be installed and filters configured for your model using the search manager. .. code-block:: php addBehavior('Search.Search'); $this->searchManager() ->useCollection('default') diff --git a/docs/_partials/pages/index/finder-scopes.rst b/docs/_partials/pages/index/finder-scopes.rst index 05c9f87b..fafbfa71 100644 --- a/docs/_partials/pages/index/finder-scopes.rst +++ b/docs/_partials/pages/index/finder-scopes.rst @@ -12,7 +12,7 @@ Each sub-array should contain ``title`` and ``finder`` parameters. .. code-block:: php - $this->Crud->action()->config('scaffold.index_finder_scopes', [ + $this->Crud->action()->setConfig('scaffold.index_finder_scopes', [ [ 'title' => __('All'), 'finder' => 'all', @@ -54,7 +54,7 @@ result-set. This can be done in the mapped action as follows: public function index() { - $this->Crud->action()->config('scaffold.index_finder_scopes', [ + $this->Crud->action()->setConfig('scaffold.index_finder_scopes', [ [ 'title' => __('All'), 'finder' => 'all', diff --git a/docs/basic-usage.rst b/docs/basic-usage.rst index d860cc87..1abaf988 100644 --- a/docs/basic-usage.rst +++ b/docs/basic-usage.rst @@ -14,7 +14,7 @@ action to the ``Crud`` component and the ``CrudView.View`` as a listener. .. code-block:: php - public function initialize() + public function initialize(): void { $this->loadComponent('Crud.Crud', [ 'actions' => [ @@ -35,6 +35,8 @@ page. .. code-block:: php Crud->action(); // Gets the IndexAction object - debug($action->config()); // Show all configuration related to this action + debug($action->getConfig()); // Show all configuration related to this action return $this->Crud->execute(); } @@ -77,7 +79,7 @@ Fore example you may want to not fetch the ``Authors`` association of the public function index() { $action = $this->Crud->action(); - $action->config('scaffold.relations_blacklist', ['Authors', ...]); + $action->setConfig('scaffold.relations_blacklist', ['Authors', ...]); return $this->Crud->execute(); } @@ -89,7 +91,7 @@ the ``scaffold.relations`` configuration key: public function index() { $action = $this->Crud->action(); - $action->config('scaffold.relations', ['Categories', 'Tags']); + $action->setConfig('scaffold.relations', ['Categories', 'Tags']); return $this->Crud->execute(); } @@ -125,7 +127,7 @@ displayed in the index table: public function index() { $action = $this->Crud->action(); - $action->config('scaffold.fields_blacklist', ['created', 'modified']); + $action->setConfig('scaffold.fields_blacklist', ['created', 'modified']); return $this->Crud->execute(); } @@ -137,7 +139,7 @@ appear in the index table: public function index() { $action = $this->Crud->action(); - $action->config('scaffold.fields', ['title', 'body', 'category', 'published_time']); + $action->setConfig('scaffold.fields', ['title', 'body', 'category', 'published_time']); return $this->Crud->execute(); } @@ -157,7 +159,7 @@ table: public function index() { $action = $this->Crud->action(); - $action->config('scaffold.actions_blacklist', ['delete']); + $action->setConfig('scaffold.actions_blacklist', ['delete']); return $this->Crud->execute(); } @@ -169,7 +171,7 @@ specifically displayed in the index view: public function index() { $action = $this->Crud->action(); - $action->config('scaffold.actions', ['view', 'add', 'edit']); + $action->setConfig('scaffold.actions', ['view', 'add', 'edit']); return $this->Crud->execute(); } @@ -215,7 +217,7 @@ the ``Crud`` component. This is the recommended configuration: .. code-block:: php - public function initialize() + public function initialize(): void { $this->loadComponent('Crud.Crud', [ 'actions' => [ @@ -251,7 +253,7 @@ fields in the form: public function add() { $action = $this->Crud->action(); - $action->config('scaffold.fields_blacklist', ['created', 'modified']); + $action->setConfig('scaffold.fields_blacklist', ['created', 'modified']); return $this->Crud->execute(); } @@ -263,7 +265,7 @@ form by using the ``scaffold.fields`` configuration key: public function edit() { $action = $this->Crud->action(); - $action->config('scaffold.fields', ['title', 'body', 'category_id']); + $action->setConfig('scaffold.fields', ['title', 'body', 'category_id']); return $this->Crud->execute(); } @@ -276,7 +278,7 @@ add the ``placeholder`` property to the ``title`` input: public function add() { $action = $this->Crud->action(); - $action->config('scaffold.fields', [ + $action->setConfig('scaffold.fields', [ 'title' => ['placeholder' => 'Insert a title here'], 'body', 'category_id' @@ -335,7 +337,7 @@ to be saved. For this case, you may use the ``scaffold.relations`` and { $action $this->Crud->action(); // Only fetch association info for Categories and Tags - $action->config('scaffold.relations', ['Categories', 'Tags']); + $action->setConfig('scaffold.relations', ['Categories', 'Tags']); return $this->Crud->execute(); } @@ -348,7 +350,7 @@ specify those association that should not be added to ``contain()``: { $action $this->Crud->action(); // Only fetch association info for Categories and Tags - $action->config('scaffold.relations_blacklist', ['Authors']); + $action->setConfig('scaffold.relations_blacklist', ['Authors']); return $this->Crud->execute(); } @@ -364,7 +366,7 @@ buttons. If you wish to only keep the "Save" button, you set the public function add() { $action = $this->Crud->action(); - $action->config('scaffold.form_submit_extra_buttons', false); + $action->setConfig('scaffold.form_submit_extra_buttons', false); return $this->Crud->execute(); } @@ -410,7 +412,7 @@ displayed in the view table: public function view() { $action = $this->Crud->action(); - $action->config('scaffold.fields_blacklist', ['created', 'modified']); + $action->setConfig('scaffold.fields_blacklist', ['created', 'modified']); return $this->Crud->execute(); } @@ -422,7 +424,7 @@ appear in the index table: public function view() { $action = $this->Crud->action(); - $action->config('scaffold.fields', ['title', 'body', 'category', 'published_time']); + $action->setConfig('scaffold.fields', ['title', 'body', 'category', 'published_time']); return $this->Crud->execute(); } @@ -441,7 +443,7 @@ Fore example you may want to not fetch the ``Authors`` association of the public function view() { $action = $this->Crud->action(); - $action->config('scaffold.relations_blacklist', ['Authors', ...]); + $action->setConfig('scaffold.relations_blacklist', ['Authors', ...]); return $this->Crud->execute(); } @@ -453,7 +455,7 @@ the ``scaffold.relations`` configuration key: public function view() { $action = $this->Crud->action(); - $action->config('scaffold.relations', ['Categories', 'Tags']); + $action->setConfig('scaffold.relations', ['Categories', 'Tags']); return $this->Crud->execute(); } diff --git a/docs/customizing-templates.rst b/docs/customizing-templates.rst index 35475596..0d56f049 100644 --- a/docs/customizing-templates.rst +++ b/docs/customizing-templates.rst @@ -28,7 +28,7 @@ title for any of the fields by using the ``scaffold.fields`` configuration .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.fields', [ + $action->setConfig('scaffold.fields', [ 'author_id' => ['label' => 'Author Name'], // The rest of the fields to display here ]); @@ -66,10 +66,10 @@ Overriding Template Elements ---------------------------- All the *CrudView* templates are built from several elements that can be -overridden by creating them in your own ``src/Template/Element`` folder. The +overridden by creating them in your own ``templates/element`` folder. The following sections will list all the elements that can be overridden for each type of action. In general, if you want to override a template, it is a good idea to copy the original implementation from -``vendor/friendsofcake/crud-view/src/Template/Element`` +``vendor/friendsofcake/crud-view/templates/element`` diff --git a/docs/dashboard-pages/customizing-the-dashboard-page.rst b/docs/dashboard-pages/customizing-the-dashboard-page.rst index d7454e5a..5dc516d2 100644 --- a/docs/dashboard-pages/customizing-the-dashboard-page.rst +++ b/docs/dashboard-pages/customizing-the-dashboard-page.rst @@ -9,7 +9,7 @@ To use the "Dashboard", the custom ``DashboardAction`` needs to be mapped: .. code-block:: php - public function initialize() + public function initialize(): void { parent::initialize(); @@ -91,7 +91,7 @@ show a single subheading for your Dashboard. In addition to showing a title, it is also possible to show a list of links. This can be done by adding a ``links`` key with an array of ``LinkItem`` objects as the value. -Links containing urls for external websites will open in a new window by default. +Links containing urls for external websites will open in a new window by default. .. code-block:: php diff --git a/docs/general-configuration/breadcrumbs.rst b/docs/general-configuration/breadcrumbs.rst index 287d1baf..25653b54 100644 --- a/docs/general-configuration/breadcrumbs.rst +++ b/docs/general-configuration/breadcrumbs.rst @@ -24,7 +24,7 @@ The ``scaffold.breadcrumbs`` configuration key takes an array of use CrudView\Breadcrumb\Breadcrumb; - $this->Crud->action()->config('scaffold.breadcrumbs', [ + $this->Crud->action()->setConfig('scaffold.breadcrumbs', [ new BreadCrumb('Home'), ]); @@ -35,7 +35,7 @@ breadcrumb entries. However, they also take ``url`` and ``options`` arrays: use CrudView\Breadcrumb\Breadcrumb; - $this->Crud->action()->config('scaffold.breadcrumbs', [ + $this->Crud->action()->setConfig('scaffold.breadcrumbs', [ new BreadCrumb('Home', ['controller' => 'Posts', 'action' => 'index'], ['class' => 'derp']), ]); @@ -51,14 +51,14 @@ You may also set any given breadcrumb to "active" by either setting the // Using the "class" option method: use CrudView\Breadcrumb\Breadcrumb; - $this->Crud->action()->config('scaffold.breadcrumbs', [ + $this->Crud->action()->setConfig('scaffold.breadcrumbs', [ new BreadCrumb('Home', '#', ['class' => 'active']), ]); // Using the ActiveBreadCrumb method: use CrudView\Breadcrumb\ActiveBreadCrumb; - $this->Crud->action()->config('scaffold.breadcrumbs', [ + $this->Crud->action()->setConfig('scaffold.breadcrumbs', [ new ActiveBreadCrumb('Home', '#'), ]); diff --git a/docs/general-configuration/sidebar-navigation.rst b/docs/general-configuration/sidebar-navigation.rst index 301ed7f4..a15406e8 100644 --- a/docs/general-configuration/sidebar-navigation.rst +++ b/docs/general-configuration/sidebar-navigation.rst @@ -14,7 +14,7 @@ You can specify the exact tables to show in the sidebar via the .. code-block:: php // only show the posts table - $this->Crud->action()->config('scaffold.tables', ['posts']); + $this->Crud->action()->setConfig('scaffold.tables', ['posts']); Blacklisting tables @@ -27,7 +27,7 @@ the ``scaffold.tables_blacklist`` configuration key to specify tables to .. code-block:: php // do not show the ``phinxlog`` and ``users`` tables - $this->Crud->action()->config('scaffold.tables_blacklist', [ + $this->Crud->action()->setConfig('scaffold.tables_blacklist', [ 'phinxlog', 'users', ]); @@ -47,7 +47,7 @@ The sidebar navigation can also be completely disabled by setting the value to ` .. code-block:: php - $this->Crud->action()->config('scaffold.sidebar_navigation', false); + $this->Crud->action()->setConfig('scaffold.sidebar_navigation', false); Custom Menus ------------ @@ -60,7 +60,7 @@ provide your own menu to be rendered in its place: use CrudView\Menu\MenuDivider; use CrudView\Menu\MenuItem; - $this->Crud->action()->config('scaffold.sidebar_navigation', [ + $this->Crud->action()->setConfig('scaffold.sidebar_navigation', [ new MenuItem('Section Header'), new MenuItem( 'CrudView Docs', diff --git a/docs/general-configuration/site-title-options.rst b/docs/general-configuration/site-title-options.rst index 56ad5dcc..2e9e61e2 100644 --- a/docs/general-configuration/site-title-options.rst +++ b/docs/general-configuration/site-title-options.rst @@ -15,7 +15,7 @@ not set, it will fallback to the following alternative: .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.site_title', 'My Admin Site'); + $action->setConfig('scaffold.site_title', 'My Admin Site'); Site Title Link --------------- @@ -27,7 +27,7 @@ route arrays are supported. .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.site_title_link', '/'); + $action->setConfig('scaffold.site_title_link', '/'); Site Title Image ---------------- @@ -38,7 +38,7 @@ title link. If set, it replaces ``scaffold.site_title``. $action = $this->Crud->action(); // Use an image included in your codebase - $action->config('scaffold.site_title_image', 'site_image.png'); + $action->setConfig('scaffold.site_title_image', 'site_image.png'); // Use an exact url - $action->config('scaffold.site_title_image', 'http://www.google.com/images/logos/google_logo_41.png'); + $action->setConfig('scaffold.site_title_image', 'http://www.google.com/images/logos/google_logo_41.png'); diff --git a/docs/general-configuration/utility-navigation.rst b/docs/general-configuration/utility-navigation.rst index 50ed5279..bc7eb605 100644 --- a/docs/general-configuration/utility-navigation.rst +++ b/docs/general-configuration/utility-navigation.rst @@ -12,7 +12,7 @@ The utility navigation can also be completely disabled by setting the value to ` .. code-block:: php - $this->Crud->action()->config('scaffold.utility_navigation', false); + $this->Crud->action()->setConfig('scaffold.utility_navigation', false); Custom Menus ------------ @@ -27,7 +27,7 @@ provide your own menu to be rendered in its place: use CrudView\Menu\MenuItem; $action = $this->Crud->action(); - $action->config('scaffold.utility_navigation', [ + $action->setConfig('scaffold.utility_navigation', [ new MenuItem( 'CrudView Docs', 'https://crud-view.readthedocs.io/en/latest/contents.html', diff --git a/docs/index-pages/components/blog.rst b/docs/index-pages/components/blog.rst index 24613219..e6a8f392 100644 --- a/docs/index-pages/components/blog.rst +++ b/docs/index-pages/components/blog.rst @@ -19,8 +19,8 @@ The blog index type has two main options: .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.index_title_field', 'name'); - $action->config('scaffold.index_body_field', 'content'); + $action->setConfig('scaffold.index_title_field', 'name'); + $action->setConfig('scaffold.index_body_field', 'content'); Available Variables ------------------- diff --git a/docs/index-pages/components/custom.rst b/docs/index-pages/components/custom.rst index 03531bf3..e76f7e87 100644 --- a/docs/index-pages/components/custom.rst +++ b/docs/index-pages/components/custom.rst @@ -6,7 +6,7 @@ To use a custom index element, you can set the ``scaffold.index_type`` config op .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.index_type', 'an_element'); + $action->setConfig('scaffold.index_type', 'an_element'); Available Variables ------------------- diff --git a/docs/index-pages/components/gallery.rst b/docs/index-pages/components/gallery.rst index 3f051a10..8cf1d516 100644 --- a/docs/index-pages/components/gallery.rst +++ b/docs/index-pages/components/gallery.rst @@ -6,7 +6,7 @@ Render your index page as a gallery. .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.index_type', 'gallery'); + $action->setConfig('scaffold.index_type', 'gallery'); Customizing the Gallery fields ------------------------------ @@ -26,10 +26,10 @@ The gallery index type has several options: .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.index_title_field', 'name'); - $action->config('scaffold.index_image_field', 'image'); - $action->config('scaffold.index_body_field', 'content'); - $action->config('scaffold.index_gallery_css_classes', 'col-sm-4 col-md-2'); + $action->setConfig('scaffold.index_title_field', 'name'); + $action->setConfig('scaffold.index_image_field', 'image'); + $action->setConfig('scaffold.index_body_field', 'content'); + $action->setConfig('scaffold.index_gallery_css_classes', 'col-sm-4 col-md-2'); Customizing Gallery Field Output -------------------------------- @@ -40,7 +40,7 @@ configuration key for formatting each field: .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.fields', [ + $action->setConfig('scaffold.fields', [ 'image' => [ 'width' => '240', 'height' => '240' diff --git a/docs/index-pages/components/table.rst b/docs/index-pages/components/table.rst index 43f9db3a..5124c794 100644 --- a/docs/index-pages/components/table.rst +++ b/docs/index-pages/components/table.rst @@ -15,7 +15,7 @@ config option. .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.fields', ['id', 'title']); + $action->setConfig('scaffold.fields', ['id', 'title']); To specify the title used in the pagination header, you need to set ``scaffold.fields`` to an associative array and use the ``title`` parameter: @@ -23,7 +23,7 @@ To specify the title used in the pagination header, you need to set .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.fields', [ + $action->setConfig('scaffold.fields', [ 'author_id' => ['title' => 'Author Name'], ]); @@ -31,43 +31,43 @@ Index Action Elements --------------------- All the *CrudView* templates are built from several elements that can be -overridden by creating them in your own ``src/Template/Element`` folder. The +overridden by creating them in your own ``templates/element`` folder. The following sections will list all the elements that can be overridden for each type of action. In general, if you want to override a template, it is a good idea to copy the original implementation from -``vendor/friendsofcake/crud-view/src/Template/Element`` +``vendor/friendsofcake/crud-view/templates/element`` search - Create ``src/Template/Element/search.ctp`` for having full control over how + Create ``templates/element/search.ctp`` for having full control over how the search filters are displayed in your pagination table. You can expect the ``$searchInputs`` and ``$searchOptions`` variables to be available index/table - Create ``src/Template/Element/index/table.ctp`` To implement your own + Create ``templates/element/index/table.ctp`` To implement your own table. index/pagination - Create ``src/Template/Element/index/pagination.ctp`` To implement your own + Create ``templates/element/index/pagination.ctp`` To implement your own pagination links and counter. index/bulk_actions/table - Create ``src/Template/Element/index/bulk_actions/table.ctp`` for changing how + Create ``templates/element/index/bulk_actions/table.ctp`` for changing how the bulk action inputs for the whole table. You can expect the ``$bulkActions``, ``$primaryKey`` and ``$singularVar`` variables to be available. index/bulk_actions/record - Create ``src/Template/Element/index/bulk_actions/record.ctp`` for changing how + Create ``templates/element/index/bulk_actions/record.ctp`` for changing how the bulk action inputs for each row are displayed. You can expect the ``$bulkActions``, ``$primaryKey`` and ``$singularVar`` variables to be available. index/bulk_actions/form_start - Create ``src/Template/Element/index/bulk_actions/form_start.ctp`` To customize + Create ``templates/element/index/bulk_actions/form_start.ctp`` To customize the Form create call for bulk actions index/bulk_actions/form_end - Create ``src/Template/Element/index/bulk_actions/form_end.ctp`` To customize + Create ``templates/element/index/bulk_actions/form_end.ctp`` To customize the Form end call for bulk actions diff --git a/docs/index-pages/customizing-the-index-page.rst b/docs/index-pages/customizing-the-index-page.rst index 047d8c7f..ac0b44a5 100644 --- a/docs/index-pages/customizing-the-index-page.rst +++ b/docs/index-pages/customizing-the-index-page.rst @@ -11,7 +11,7 @@ in scope. To limit the fields used, simply specify an array of fields: .. code-block:: php $action = $this->Crud->action(); - $action->config('scaffold.fields', ['title', 'description']); + $action->setConfig('scaffold.fields', ['title', 'description']); .. include:: /_partials/fields/field-settings.rst .. include:: /_partials/fields/field-blacklist.rst diff --git a/docs/installation.rst b/docs/installation.rst index 9135c205..29d79fc6 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -6,7 +6,7 @@ Installing CRUD view requires only a few steps Requirements ------------ -* CakePHP 3.x +* CakePHP 4.x Getting the Code ---------------- diff --git a/docs/quick-start.rst b/docs/quick-start.rst index e96a14c7..7f5c6762 100644 --- a/docs/quick-start.rst +++ b/docs/quick-start.rst @@ -19,13 +19,15 @@ If you haven't configured the CRUD plugin already, add the following lines to yo .. code-block:: php viewBuilder()->getClassName() === null) { $this->viewBuilder()->setClassName('CrudView\View\CrudView'); - } - - // For CakePHP 3.1+ - if ($this->viewBuilder()->className() === null) { - $this->viewBuilder()->className('CrudView\View\CrudView'); - } - - // For CakePHP 3.0 - /* - if ($this->viewClass === null) { - $this->viewClass = 'CrudView\View\CrudView'; } - */ } } From 19e14106fa1396a84ba3ef2f1e8a71ba777593dd Mon Sep 17 00:00:00 2001 From: ADmad Date: Fri, 11 Sep 2020 18:29:23 +0530 Subject: [PATCH 87/91] Update composer config --- composer.json | 1 - 1 file changed, 1 deletion(-) diff --git a/composer.json b/composer.json index a19e44c0..8ac8a0d4 100644 --- a/composer.json +++ b/composer.json @@ -54,6 +54,5 @@ "wiki": "http://cakephp.nu/cakephp-crud/", "irc": "irc://irc.freenode.org/friendsofcake" }, - "minimum-stability": "beta", "prefer-stable": true } From c9387417ad074f2204638a8213afeab440eace8d Mon Sep 17 00:00:00 2001 From: ADmad Date: Fri, 11 Sep 2020 18:31:47 +0530 Subject: [PATCH 88/91] Update config files --- config/forms.php | 2 +- config/paginator.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/config/forms.php b/config/forms.php index 39d3eed4..7c31f88b 100644 --- a/config/forms.php +++ b/config/forms.php @@ -1,5 +1,5 @@ '{{content}}', 'formGroup' => '{{label}}
        {{input}}{{error}}
        ', diff --git a/config/paginator.php b/config/paginator.php index 2ff34dca..b1743001 100644 --- a/config/paginator.php +++ b/config/paginator.php @@ -1,5 +1,5 @@ '', 'prevActive' => '', ]; From 55f269fa44a1dde951f8212394f02a98a4c69ed7 Mon Sep 17 00:00:00 2001 From: ADmad Date: Fri, 11 Sep 2020 18:33:53 +0530 Subject: [PATCH 89/91] Fix CS error --- src/Breadcrumb/ActiveBreadcrumb.php | 1 + 1 file changed, 1 insertion(+) diff --git a/src/Breadcrumb/ActiveBreadcrumb.php b/src/Breadcrumb/ActiveBreadcrumb.php index 22ce1126..fc15cd47 100644 --- a/src/Breadcrumb/ActiveBreadcrumb.php +++ b/src/Breadcrumb/ActiveBreadcrumb.php @@ -5,6 +5,7 @@ class ActiveBreadcrumb extends Breadcrumb { + // phpcs:ignore /** * // phpcs:ignore * @inheritDoc From cde428ee92db2c261a005d01c0ac70ff7d44571f Mon Sep 17 00:00:00 2001 From: ADmad Date: Tue, 22 Sep 2020 23:55:40 +0530 Subject: [PATCH 90/91] Show first/last page links --- templates/element/index/pagination.php | 2 ++ 1 file changed, 2 insertions(+) diff --git a/templates/element/index/pagination.php b/templates/element/index/pagination.php index eeceaffe..54ce66bb 100644 --- a/templates/element/index/pagination.php +++ b/templates/element/index/pagination.php @@ -6,6 +6,8 @@ Paginator->hasPage(2)) { echo $this->Paginator->links([ + 'first' => true, + 'last' => true, 'prev' => true, 'next' => true, ]); From 9808ba4f5cb71d483a1ee7dd19c3d7b6d23386ef Mon Sep 17 00:00:00 2001 From: ADmad Date: Wed, 23 Sep 2020 00:24:14 +0530 Subject: [PATCH 91/91] By default add form tags no non-GET action links into "action_link_forms" block. This avoid nested forms. --- templates/element/actions.php | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/templates/element/actions.php b/templates/element/actions.php index 5f1d425a..5751101f 100644 --- a/templates/element/actions.php +++ b/templates/element/actions.php @@ -25,6 +25,7 @@ if ($config['method'] !== 'GET') { $linkOptions += [ 'method' => $config['method'], + 'block' => 'action_link_forms', ]; } @@ -33,6 +34,11 @@ unset($config['callback']); $config['options'] = $linkOptions; $links[$name] = $callback($config, !empty($singularVar) ? $singularVar : null, $this); + + if ($links[$name]['method'] !== 'GET' && !isset($links[$name]['options']['block'])) { + $links[$name]['options']['block'] = 'action_link_forms'; + } + continue; }
        " . Inflector::humanize($field) . "' . Inflector::humanize($field) . 'Actions - Html->link(__d('crud', 'View'), array('plugin' => $details['plugin'], 'controller' => $details['controller'], 'action' => 'view', ${$otherSingularVar}[$details['primaryKey']]), array('class' => 'btn btn-secondary')); ?> - Html->link(__d('crud', 'Edit'), array('plugin' => $details['plugin'], 'controller' => $details['controller'], 'action' => 'edit', ${$otherSingularVar}[$details['primaryKey']]), array('class' => 'btn btn-secondary')); ?> - Html->link(__d('crud', 'Delete'), array('plugin' => $details['plugin'], 'controller' => $details['controller'], 'action' => 'delete', ${$otherSingularVar}[$details['primaryKey']]), array('class' => 'btn btn-secondary')); ?> + Html->link(__d('crud', 'View'), ['plugin' => $details['plugin'], 'controller' => $details['controller'], 'action' => 'view', ${$otherSingularVar}[$details['primaryKey']]], ['class' => 'btn btn-secondary']); ?> + Html->link(__d('crud', 'Edit'), ['plugin' => $details['plugin'], 'controller' => $details['controller'], 'action' => 'edit', ${$otherSingularVar}[$details['primaryKey']]], ['class' => 'btn btn-secondary']); ?> + Html->link(__d('crud', 'Delete'), ['plugin' => $details['plugin'], 'controller' => $details['controller'], 'action' => 'delete', ${$otherSingularVar}[$details['primaryKey']]], ['class' => 'btn btn-secondary']); ?>