pgleadershipbook
This repository has no backups
This repository's network speed is throttled to 100KB/sec
Upgrade your account to fix these warnings, or use backups.vc for automated backups
@ 2
pgleadershipbook / trunk / system / Debug / Toolbar / Collectors / BaseCollector.php
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 |
<?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-2020 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-2020 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\Debug\Exceptions; /** * Base Toolbar collector */ class 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 = false; /** * Whether this collector needs to display * a label or not. * * @var boolean */ protected $hasLabel = false; /** * Whether this collector has data that * should be shown in the Vars tab. * * @var boolean */ protected $hasVarData = false; /** * The 'title' of this Collector. * Used to name things in the toolbar HTML. * * @var string */ protected $title = ''; //-------------------------------------------------------------------- /** * Gets the Collector's title. * * @param boolean $safe * @return string */ public function getTitle(bool $safe = false): string { if ($safe) { return str_replace(' ', '-', strtolower($this->title)); } return $this->title; } //-------------------------------------------------------------------- /** * Returns any information that should be shown next to the title. * * @return string */ public function getTitleDetails(): string { return ''; } //-------------------------------------------------------------------- /** * Does this collector need it's own tab? * * @return boolean */ public function hasTabContent(): bool { return (bool) $this->hasTabContent; } //-------------------------------------------------------------------- /** * Does this collector have a label? * * @return boolean */ public function hasLabel(): bool { return (bool) $this->hasLabel; } //-------------------------------------------------------------------- /** * Does this collector have information for the timeline? * * @return boolean */ public function hasTimelineData(): bool { return (bool) $this->hasTimeline; } //-------------------------------------------------------------------- /** * Grabs the data for the timeline, properly formatted, * or returns an empty array. * * @return array */ public function timelineData(): array { if (! $this->hasTimeline) { return []; } return $this->formatTimelineData(); } //-------------------------------------------------------------------- /** * Does this Collector have data that should be shown in the * 'Vars' tab? * * @return boolean */ public function hasVarData(): bool { return (bool) $this->hasVarData; } //-------------------------------------------------------------------- /** * 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' * ], * ]; * * @return null */ public function getVarData() { return null; } //-------------------------------------------------------------------- /** * 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 * ] * * @return array */ protected function formatTimelineData(): array { return []; } //-------------------------------------------------------------------- /** * Returns the data of this collector to be formatted in the toolbar * * @return array|string */ public function display() { return []; } //-------------------------------------------------------------------- /** * Clean Path * * This makes nicer looking paths for the error output. * * @param string $file * * @return string */ public function cleanPath(string $file): string { return Exceptions::cleanPath($file); } /** * Gets the "badge" value for the button. * * @return null */ public function getBadgeValue() { return null; } /** * Does this collector have any data collected? * * If not, then the toolbar button won't get shown. * * @return boolean */ public function isEmpty(): bool { return false; } /** * Returns the HTML to display the icon. Should either * be SVG, or a base-64 encoded. * * Recommended dimensions are 24px x 24px * * @return string */ public function icon(): string { return ''; } /** * Return settings as an array. * * @return array */ public function getAsArray(): array { return [ 'title' => $this->getTitle(), 'titleSafe' => $this->getTitle(true), 'titleDetails' => $this->getTitleDetails(), 'display' => $this->display(), 'badgeValue' => $this->getBadgeValue(), 'isEmpty' => $this->isEmpty(), 'hasTabContent' => $this->hasTabContent(), 'hasLabel' => $this->hasLabel(), 'icon' => $this->icon(), 'hasTimelineData' => $this->hasTimelineData(), 'timelineData' => $this->timelineData(), ]; } } |
Commits for pgleadershipbook/trunk/system/Debug/Toolbar/Collectors/BaseCollector.php
Revision | Author | Commited | Message |
---|---|---|---|
2 | tporter | Thu 04 Feb, 2021 09:33:04 +0000 | PG Leadership book initial commit |