Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add ability to filter plugin routes in routes tab #851

Merged
merged 11 commits into from
Dec 13, 2021
Merged

add ability to filter plugin routes in routes tab #851

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
6918583
add ability to filter plugin routes in routes tab
LordSimal Dec 11, 2021
12c38e1
added missing space for app route count
LordSimal Dec 11, 2021
5e6ba41
Fixing style errors.
stickler-ci Dec 11, 2021
d65a58b
fix sticker CI problems
LordSimal Dec 11, 2021
03ed29d
fix sticker CI problems and converted variables to camelBacked names
LordSimal Dec 11, 2021
c3adb8a
Fixing style errors.
stickler-ci Dec 11, 2021
f8767b1
rename more camelBacked variables
LordSimal Dec 11, 2021
b3b1949
Fixing style errors.
stickler-ci Dec 11, 2021
1a36c5f
improve route amount calculation
LordSimal Dec 11, 2021
00476b3
fix stickler ci
LordSimal Dec 11, 2021
e5b3c27
replace regex with Text::slug() method
LordSimal Dec 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 72 additions & 15 deletions templates/element/routes_panel.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,44 @@
* @var \Cake\Routing\Route\Route[] $routes
* @var string $matchedRoute
*/

use Cake\Core\Plugin as CorePlugin;
use Cake\Utility\Hash;
use Cake\Utility\Text;

$routes = Cake\Routing\Router::routes();

$amountOfRoutesPerGroup = [];
foreach ($routes as $route) {
$group = $route->defaults['plugin'] ?? 'app';
if (!array_key_exists($group, $amountOfRoutesPerGroup)) {
$amountOfRoutesPerGroup[$group] = 0;
}
$amountOfRoutesPerGroup[$group]++;
}

$pluginNames = [];
foreach (CorePlugin::loaded() as $pluginName) {
if (!empty($amountOfRoutesPerGroup[$pluginName])) {
$name = sprintf('%s (%s)', $pluginName, $amountOfRoutesPerGroup[$pluginName]);
$pluginNames[$name] = Text::slug($pluginName);
}
}

?>
<button type="button" class="btn-primary" id="toggle-debugkit-routes">
<?= __d('debug_kit', 'Toggle debugkit internal routes') ?>
</button>
<div class="debugkit-plugin-routes-button-wrapper">
<button type="button" class="btn-primary js-debugkit-toggle-plugin-route" data-plugin=".route-entry--app">
<?= __d('debug_kit', 'App') ?>
<?= !empty($amountOfRoutesPerGroup['app']) ? ' (' . $amountOfRoutesPerGroup['app'] . ')' : '' ?>
</button>
<?php foreach ($pluginNames as $pluginName => $parsedName) : ?>
<button type="button" class="btn-primary js-debugkit-toggle-plugin-route
<?= strpos($pluginName, 'DebugKit') === 0 ? ' toggle-plugin-route-active' : '' ?>"
data-plugin=".route-entry--plugin-<?= $parsedName ?>">
<?= $pluginName ?>
</button>
<?php endforeach; ?>
</div>
<table cellspacing="0" cellpadding="0" class="debug-table">
<thead>
<tr>
Expand All @@ -19,14 +50,26 @@
</tr>
</thead>
<tbody>
<?php foreach ($routes as $route): ?>
<?php
<?php foreach ($routes as $route) : ?>
<?php
$class = '';
if ($matchedRoute === $route->template):
$class = 'highlighted';
elseif ($route->defaults['plugin'] === 'DebugKit'):
$class = 'debugkit-route hidden';
if (empty($route->defaults['plugin'])) :
$class = 'route-entry route-entry--app';
else :
$class = 'route-entry route-entry--plugin route-entry--plugin-' .
Text::slug($route->defaults['plugin']);

// Hide DebugKit internal routes by default
if ($route->defaults['plugin'] === 'DebugKit') {
$class .= ' hidden';
}
endif;

// Highlight current route
if ($matchedRoute === $route->template) {
$class .= ' highlighted';
}

?>
<tr class="<?= $class ?>">
<td><?= h(Hash::get($route->options, '_name', $route->getName())) ?></td>
Expand All @@ -38,11 +81,25 @@
</table>

<script>
$(document).ready(function() {
$('#toggle-debugkit-routes').on('click', function (event) {
event.preventDefault();
var routes = $('.debugkit-route');
routes.toggleClass('hidden');
$(document).ready(function() {
$('#toggle-debugkit-routes').on('click', function (event) {
event.preventDefault();
var routes = $('.debugkit-route');
routes.toggleClass('hidden');
});

$('.js-debugkit-toggle-plugin-route').on('click', function (event) {
var $this = $(this);
var plugin = $this.attr('data-plugin');

if($this.hasClass('toggle-plugin-route-active')) {
$this.removeClass('toggle-plugin-route-active');
$('.route-entry' + plugin).removeClass('hidden');
} else {
$this.addClass('toggle-plugin-route-active');
$('.route-entry' + plugin).addClass('hidden');
}

});
});
});
</script>
16 changes: 15 additions & 1 deletion webroot/css/toolbar.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -512,10 +512,13 @@ pre,
position: relative;
top: 2px;
}

.btn-primary:hover {
cursor:pointer;
}
.toggle-plugin-route-active {
background-color: #fff;
color: #2a6496;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure I love these colours in this context but I can fiddle with it afterwards.

}

#loader {
background: rgba(255, 255, 255, 0.7);
Expand Down Expand Up @@ -613,3 +616,14 @@ pre,
.terminal .success-message {
color: #42bd41;
}

.debugkit-plugin-routes-button-wrapper {
display: flex;
flex-wrap: wrap;
justify-content: center;
margin: 0 -5px;
}

.debugkit-plugin-routes-button-wrapper button {
margin: 5px;
}