paulgoughbooks_old
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
paulgoughbooks_old / trunk / system / CLI / BaseCommand.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 |
<?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\CLI; use Psr\Log\LoggerInterface; /** * Class BaseCommand * * @property $group * @property $name * @property $description * * @package CodeIgniter\CLI */ abstract class BaseCommand { /** * The group the command is lumped under * when listing commands. * * @var string */ protected $group; /** * The Command's name * * @var string */ protected $name; /** * the Command's usage description * * @var string */ protected $usage; /** * the Command's short description * * @var string */ protected $description; /** * the Command's options description * * @var array */ protected $options = []; /** * the Command's Arguments description * * @var array */ protected $arguments = []; /** * The Logger to use for a command * * @var \Psr\Log\LoggerInterface */ protected $logger; /** * Instance of the CommandRunner controller * so commands can call other commands. * * @var \CodeIgniter\CLI\Commands */ protected $commands; //-------------------------------------------------------------------- /** * BaseCommand constructor. * * @param \Psr\Log\LoggerInterface $logger * @param \CodeIgniter\CLI\Commands $commands */ public function __construct(LoggerInterface $logger, Commands $commands) { $this->logger = $logger; $this->commands = $commands; } //-------------------------------------------------------------------- /** * Actually execute a command. * This has to be over-ridden in any concrete implementation. * * @param array $params */ abstract public function run(array $params); //-------------------------------------------------------------------- /** * Can be used by a command to run other commands. * * @param string $command * @param array $params * * @return mixed * @throws \ReflectionException */ protected function call(string $command, array $params = []) { // The CommandRunner will grab the first element // for the command name. array_unshift($params, $command); return $this->commands->run($command, $params); } //-------------------------------------------------------------------- /** * A simple method to display an error with line/file, * in child commands. * * @param \Exception $e */ protected function showError(\Exception $e) { CLI::newLine(); CLI::error($e->getMessage()); CLI::write($e->getFile() . ' - ' . $e->getLine()); CLI::newLine(); } //-------------------------------------------------------------------- /** * Makes it simple to access our protected properties. * * @param string $key * * @return mixed */ public function __get(string $key) { if (isset($this->$key)) { return $this->$key; } return null; } //-------------------------------------------------------------------- /** * Makes it simple to check our protected properties. * * @param string $key * * @return boolean */ public function __isset(string $key): bool { return isset($this->$key); } //-------------------------------------------------------------------- /** * show Help include (usage,arguments,description,options) */ public function showHelp() { // 4 spaces instead of tab $tab = ' '; CLI::write(lang('CLI.helpDescription'), 'yellow'); CLI::write($tab . $this->description); CLI::newLine(); CLI::write(lang('CLI.helpUsage'), 'yellow'); $usage = empty($this->usage) ? $this->name . ' [arguments]' : $this->usage; CLI::write($tab . $usage); CLI::newLine(); $pad = max($this->getPad($this->options, 6), $this->getPad($this->arguments, 6)); if (! empty($this->arguments)) { CLI::write(lang('CLI.helpArguments'), 'yellow'); foreach ($this->arguments as $argument => $description) { CLI::write($tab . CLI::color(str_pad($argument, $pad), 'green') . $description, 'yellow'); } CLI::newLine(); } if (! empty($this->options)) { CLI::write(lang('CLI.helpOptions'), 'yellow'); foreach ($this->options as $option => $description) { CLI::write($tab . CLI::color(str_pad($option, $pad), 'green') . $description, 'yellow'); } CLI::newLine(); } } //-------------------------------------------------------------------- /** * Get pad for $key => $value array output * * @param array $array * @param integer $pad * * @return integer */ public function getPad(array $array, int $pad): int { $max = 0; foreach ($array as $key => $value) { $max = max($max, strlen($key)); } return $max + $pad; } //-------------------------------------------------------------------- } |
Commits for paulgoughbooks_old/trunk/system/CLI/BaseCommand.php
Revision | Author | Commited | Message |
---|---|---|---|
2 | tporter | Tue 03 Nov, 2020 08:50:21 +0000 | Migration of Paul Goughs Books site to Codeignitor 4 |