$hasTimeline
$hasTimeline : boolean
Whether this collector has data that can be displayed in the Timeline.
Routes collector
getVarData() : null
Gets a collection of data that should be shown in the 'Vars' tab.
The format is an array of sections, each with their own array of key/value pairs:
$data = [ 'section 1' => [ 'foo' => 'bar, 'bar' => 'baz' ], 'section 2' => [ 'foo' => 'bar, 'bar' => 'baz' ], ];
icon() : string
Display the icon.
Icon from https://icons8.com - 1em package
formatTimelineData() : array
Child classes should implement this to return the timeline data formatted for correct usage.
Timeline data should be formatted into arrays that look like:
[ 'name' => 'Database::Query', 'component' => 'Database', 'start' => 10 // milliseconds 'duration' => 15 // milliseconds ]
<?php
/**
* CodeIgniter
*
* An open source application development framework for PHP
*
* This content is released under the MIT License (MIT)
*
* Copyright (c) 2014-2019 British Columbia Institute of Technology
* Copyright (c) 2019 CodeIgniter Foundation
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
* @package CodeIgniter
* @author CodeIgniter Dev Team
* @copyright 2019 CodeIgniter Foundation
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 4.0.0
* @filesource
*/
namespace CodeIgniter\Debug\Toolbar\Collectors;
use CodeIgniter\Config\Services;
/**
* Routes collector
*/
class Routes extends BaseCollector
{
/**
* Whether this collector has data that can
* be displayed in the Timeline.
*
* @var boolean
*/
protected $hasTimeline = false;
/**
* Whether this collector needs to display
* content in a tab or not.
*
* @var boolean
*/
protected $hasTabContent = true;
/**
* The 'title' of this Collector.
* Used to name things in the toolbar HTML.
*
* @var string
*/
protected $title = 'Routes';
//--------------------------------------------------------------------
/**
* Returns the data of this collector to be formatted in the toolbar
*
* @return array
* @throws \ReflectionException
*/
public function display(): array
{
$rawRoutes = Services::routes(true);
$router = Services::router(null, null, true);
/*
* Matched Route
*/
$route = $router->getMatchedRoute();
// Get our parameters
// Closure routes
if (is_callable($router->controllerName()))
{
$method = new \ReflectionFunction($router->controllerName());
}
else
{
try
{
$method = new \ReflectionMethod($router->controllerName(), $router->methodName());
}
catch (\ReflectionException $e)
{
// If we're here, the method doesn't exist
// and is likely calculated in _remap.
$method = new \ReflectionMethod($router->controllerName(), '_remap');
}
}
$rawParams = $method->getParameters();
$params = [];
foreach ($rawParams as $key => $param)
{
$params[] = [
'name' => $param->getName(),
'value' => $router->params()[$key] ??
'<empty> | default: ' . var_export($param->isDefaultValueAvailable() ? $param->getDefaultValue() : null, true),
];
}
$matchedRoute = [
[
'directory' => $router->directory(),
'controller' => $router->controllerName(),
'method' => $router->methodName(),
'paramCount' => count($router->params()),
'truePCount' => count($params),
'params' => $params ?? [],
],
];
/*
* Defined Routes
*/
$rawRoutes = $rawRoutes->getRoutes();
$routes = [];
foreach ($rawRoutes as $from => $to)
{
$routes[] = [
'from' => $from,
'to' => $to,
];
}
return [
'matchedRoute' => $matchedRoute,
'routes' => $routes,
];
}
//--------------------------------------------------------------------
/**
* Returns a count of all the routes in the system.
*
* @return integer
*/
public function getBadgeValue(): int
{
$rawRoutes = Services::routes(true);
return count($rawRoutes->getRoutes());
}
//--------------------------------------------------------------------
/**
* Display the icon.
*
* Icon from https://icons8.com - 1em package
*
* @return string
*/
public function icon(): string
{
return 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAFDSURBVEhL7ZRNSsNQFIUjVXSiOFEcuQIHDpzpxC0IGYeE/BEInbWlCHEDLsSiuANdhKDjgm6ggtSJ+l25ldrmmTwIgtgDh/t37r1J+16cX0dRFMtpmu5pWAkrvYjjOB7AETzStBFW+inxu3KUJMmhludQpoflS1zXban4LYqiO224h6VLTHr8Z+z8EpIHFF9gG78nDVmW7UgTHKjsCyY98QP+pcq+g8Ku2s8G8X3f3/I8b038WZTp+bO38zxfFd+I6YY6sNUvFlSDk9CRhiAI1jX1I9Cfw7GG1UB8LAuwbU0ZwQnbRDeEN5qqBxZMLtE1ti9LtbREnMIuOXnyIf5rGIb7Wq8HmlZgwYBH7ORTcKH5E4mpjeGt9fBZcHE2GCQ3Vt7oTNPNg+FXLHnSsHkw/FR+Gg2bB8Ptzrst/v6C/wrH+QB+duli6MYJdQAAAABJRU5ErkJggg==';
}
}