ppi /
framework
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like App often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use App, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 32 | class App implements AppInterface |
||
| 33 | { |
||
| 34 | /** |
||
| 35 | * Version string. |
||
| 36 | * |
||
| 37 | * @var string |
||
| 38 | */ |
||
| 39 | const VERSION = '2.1.0-DEV'; |
||
| 40 | |||
| 41 | /** |
||
| 42 | * @var bool |
||
| 43 | */ |
||
| 44 | protected $booted = false; |
||
| 45 | |||
| 46 | /** |
||
| 47 | * @var bool |
||
| 48 | */ |
||
| 49 | protected $debug; |
||
| 50 | |||
| 51 | /** |
||
| 52 | * Application environment: "dev|development" vs "prod|production". |
||
| 53 | * |
||
| 54 | * @var string |
||
| 55 | */ |
||
| 56 | protected $environment; |
||
| 57 | |||
| 58 | /** |
||
| 59 | * @var \Psr\Log\LoggerInterface |
||
| 60 | */ |
||
| 61 | protected $logger; |
||
| 62 | |||
| 63 | /** |
||
| 64 | * Unix timestamp with microseconds. |
||
| 65 | * |
||
| 66 | * @var float |
||
| 67 | */ |
||
| 68 | protected $startTime; |
||
| 69 | |||
| 70 | /** |
||
| 71 | * Configuration loader. |
||
| 72 | * |
||
| 73 | * @var \PPI\Framework\Config\ConfigManager |
||
| 74 | */ |
||
| 75 | protected $configManager; |
||
| 76 | |||
| 77 | /** |
||
| 78 | * The Module Manager. |
||
| 79 | * |
||
| 80 | * @var \Zend\ModuleManager\ModuleManager |
||
| 81 | */ |
||
| 82 | protected $moduleManager; |
||
| 83 | |||
| 84 | /** |
||
| 85 | * @param int $errorReportingLevel The level of error reporting you want |
||
| 86 | */ |
||
| 87 | protected $errorReportingLevel; |
||
| 88 | |||
| 89 | /** |
||
| 90 | * @var null|array |
||
| 91 | */ |
||
| 92 | protected $matchedRoute; |
||
| 93 | |||
| 94 | /** |
||
| 95 | * @var \PPI\Framework\Module\Controller\ControllerResolver |
||
| 96 | */ |
||
| 97 | protected $resolver; |
||
| 98 | |||
| 99 | /** |
||
| 100 | * @var string |
||
| 101 | */ |
||
| 102 | protected $name; |
||
| 103 | |||
| 104 | /** |
||
| 105 | * Path to the application root dir aka the "app" directory. |
||
| 106 | * |
||
| 107 | * @var null|string |
||
| 108 | */ |
||
| 109 | protected $rootDir; |
||
| 110 | |||
| 111 | /** |
||
| 112 | * Service Manager. |
||
| 113 | * |
||
| 114 | * @var \PPI\Framework\ServiceManager\ServiceManager |
||
| 115 | */ |
||
| 116 | protected $serviceManager; |
||
| 117 | |||
| 118 | /** |
||
| 119 | * App constructor. |
||
| 120 | * |
||
| 121 | * @param array $options |
||
| 122 | */ |
||
| 123 | public function __construct(array $options = array()) |
||
| 124 | { |
||
| 125 | // Default options |
||
| 126 | $this->environment = isset($options['environment']) && $options['environment'] ? (string) $options['environment'] : 'prod'; |
||
| 127 | $this->debug = isset($options['debug']) && null !== $options['debug'] ? (boolean) $options['debug'] : false; |
||
| 128 | $this->rootDir = isset($options['rootDir']) && $options['rootDir'] ? (string) $options['rootDir'] : $this->getRootDir(); |
||
| 129 | $this->name = isset($options['name']) && $options['name'] ? (string) $options['name'] : $this->getName(); |
||
| 130 | |||
| 131 | if ($this->debug) { |
||
| 132 | $this->startTime = microtime(true); |
||
| 133 | $this->enableDebug(); |
||
| 134 | } else { |
||
| 135 | ini_set('display_errors', 0); |
||
| 136 | } |
||
| 137 | } |
||
| 138 | |||
| 139 | /** |
||
| 140 | * Set an App option. |
||
| 141 | * |
||
| 142 | * @param $option |
||
| 143 | * @param $value |
||
| 144 | * |
||
| 145 | * @throws \RuntimeException |
||
| 146 | * |
||
| 147 | * @return $this |
||
| 148 | */ |
||
| 149 | public function setOption($option, $value) |
||
| 150 | { |
||
| 151 | if (true === $this->booted) { |
||
| 152 | throw new \RuntimeException('Setting App options after boot() is now allowed'); |
||
| 153 | } |
||
| 154 | |||
| 155 | // "root_dir" to "rootDir" |
||
| 156 | $property = preg_replace('/_(.?)/e', "strtoupper('$1')", $option); |
||
| 157 | if (!property_exists($this, $property)) { |
||
| 158 | throw new \RuntimeException(sprintf('App property "%s" (option "%s") does not exist', $property, $option)); |
||
| 159 | } |
||
| 160 | |||
| 161 | $this->$property = $value; |
||
| 162 | |||
| 163 | return $this; |
||
| 164 | } |
||
| 165 | |||
| 166 | /** |
||
| 167 | * Get an App option. |
||
| 168 | * |
||
| 169 | * @param $option |
||
| 170 | * |
||
| 171 | * @throws \RuntimeException |
||
| 172 | * |
||
| 173 | * @return string |
||
| 174 | */ |
||
| 175 | public function getOption($option) |
||
| 176 | { |
||
| 177 | // "root_dir" to "rootDir" |
||
| 178 | $property = preg_replace('/_(.?)/e', "strtoupper('$1')", $option); |
||
| 179 | if (!property_exists($this, $property)) { |
||
| 180 | throw new \RuntimeException(sprintf('App property "%s" (option "%s") does not exist', $property, $option)); |
||
| 181 | } |
||
| 182 | |||
| 183 | return $property; |
||
| 184 | } |
||
| 185 | |||
| 186 | public function __clone() |
||
| 187 | { |
||
| 188 | if ($this->debug) { |
||
| 189 | $this->startTime = microtime(true); |
||
| 190 | } |
||
| 191 | |||
| 192 | $this->booted = false; |
||
| 193 | $this->serviceManager = null; |
||
| 194 | } |
||
| 195 | |||
| 196 | /** |
||
| 197 | * Run the boot process, load our modules and their dependencies. |
||
| 198 | * |
||
| 199 | * This method is automatically called by dispatch(), but you can use it |
||
| 200 | * to build all services when not handling a request. |
||
| 201 | * |
||
| 202 | * @return $this |
||
| 203 | */ |
||
| 204 | public function boot() |
||
| 205 | { |
||
| 206 | if (true === $this->booted) { |
||
| 207 | return $this; |
||
| 208 | } |
||
| 209 | |||
| 210 | $this->serviceManager = $this->buildServiceManager(); |
||
| 211 | $this->log('debug', sprintf('Booting %s ...', $this->name)); |
||
| 212 | |||
| 213 | // Loading our Modules |
||
| 214 | $this->getModuleManager()->loadModules(); |
||
| 215 | if ($this->debug) { |
||
| 216 | $modules = $this->getModuleManager()->getModules(); |
||
| 217 | $this->log('debug', sprintf('All modules online (%d): "%s"', count($modules), implode('", "', $modules))); |
||
| 218 | } |
||
| 219 | |||
| 220 | // Lets get all the services our of our modules and start setting them in the ServiceManager |
||
| 221 | $moduleServices = $this->serviceManager->get('ModuleDefaultListener')->getServices(); |
||
| 222 | foreach ($moduleServices as $key => $service) { |
||
| 223 | $this->serviceManager->setFactory($key, $service); |
||
| 224 | } |
||
| 225 | |||
| 226 | $this->booted = true; |
||
| 227 | if ($this->debug) { |
||
| 228 | $this->log('debug', sprintf('%s has booted (in %.3f secs)', $this->name, microtime(true) - $this->startTime)); |
||
| 229 | } |
||
| 230 | |||
| 231 | return $this; |
||
| 232 | } |
||
| 233 | |||
| 234 | /** |
||
| 235 | * Run the application and send the response. |
||
| 236 | * |
||
| 237 | * @param HttpRequest|null $request |
||
| 238 | * @param HttpRequest|null $request |
||
| 239 | * @throws \Exception |
||
| 240 | * |
||
| 241 | * @return Response |
||
| 242 | */ |
||
| 243 | public function run(HttpRequest $request = null, HttpResponse $response = null) |
||
| 244 | { |
||
| 245 | if (false === $this->booted) { |
||
| 246 | $this->boot(); |
||
| 247 | } |
||
| 248 | |||
| 249 | $request = $request ?: HttpRequest::createFromGlobals(); |
||
| 250 | $response = $response ?: new HttpResponse(); |
||
| 251 | |||
| 252 | $response = $this->dispatch($request, $response); |
||
|
|
|||
| 253 | $response->send(); |
||
| 254 | |||
| 255 | return $response; |
||
| 256 | } |
||
| 257 | |||
| 258 | /** |
||
| 259 | * Decide on a route to use and dispatch our module's controller action. |
||
| 260 | * |
||
| 261 | * @param HttpRequest $request |
||
| 262 | * @param HttpResponse $response |
||
| 263 | * @throws \Exception |
||
| 264 | * |
||
| 265 | * @return Response |
||
| 266 | */ |
||
| 267 | public function dispatch(HttpRequest $request, HttpResponse $response) |
||
| 268 | { |
||
| 269 | if (false === $this->booted) { |
||
| 270 | $this->boot(); |
||
| 271 | } |
||
| 272 | |||
| 273 | // Routing |
||
| 274 | $routeParams = $this->handleRouting($request); |
||
| 275 | $request->attributes->add($routeParams); |
||
| 276 | |||
| 277 | // Resolve our Controller |
||
| 278 | $resolver = $this->serviceManager->get('ControllerResolver'); |
||
| 279 | if (false === $controller = $resolver->getController($request)) { |
||
| 280 | throw new NotFoundHttpException(sprintf('Unable to find the controller for path "%s".', $request->getPathInfo())); |
||
| 281 | } |
||
| 282 | |||
| 283 | $controllerArguments = $resolver->getArguments($request, $controller); |
||
| 284 | |||
| 285 | $result = call_user_func_array( |
||
| 286 | $controller, |
||
| 287 | $controllerArguments |
||
| 288 | ); |
||
| 289 | |||
| 290 | if ($result === null) { |
||
| 291 | throw new \Exception('Your action returned null. It must always return something'); |
||
| 292 | } elseif (is_string($result)) { |
||
| 293 | $response->setContent($result); |
||
| 294 | } else if ($result instanceof SymfonyResponse || $response instanceof HttpResponse) { |
||
| 295 | $response = $result; |
||
| 296 | } else { |
||
| 297 | throw new \Exception('Invalid response type returned from controller'); |
||
| 298 | } |
||
| 299 | |||
| 300 | $this->response = $response; |
||
| 301 | |||
| 302 | return $response; |
||
| 303 | } |
||
| 304 | |||
| 305 | /** |
||
| 306 | * Gets the name of the application. |
||
| 307 | * |
||
| 308 | * @return string The application name |
||
| 309 | * |
||
| 310 | * @api |
||
| 311 | */ |
||
| 312 | public function getName() |
||
| 313 | { |
||
| 314 | if (null === $this->name) { |
||
| 315 | $this->name = preg_replace('/[^a-zA-Z0-9_]+/', '', basename($this->rootDir)); |
||
| 316 | } |
||
| 317 | |||
| 318 | return $this->name; |
||
| 319 | } |
||
| 320 | |||
| 321 | /** |
||
| 322 | * Gets the version of the application. |
||
| 323 | * |
||
| 324 | * @return string The application version |
||
| 325 | * |
||
| 326 | * @api |
||
| 327 | */ |
||
| 328 | public function getVersion() |
||
| 332 | |||
| 333 | /** |
||
| 334 | * Get the environment mode the application is in. |
||
| 335 | * |
||
| 336 | * @return string The current environment |
||
| 337 | * |
||
| 338 | * @api |
||
| 339 | */ |
||
| 340 | public function getEnvironment() |
||
| 344 | |||
| 345 | /** |
||
| 346 | * @param $env |
||
| 347 | * |
||
| 348 | * @return bool |
||
| 349 | */ |
||
| 350 | public function isEnvironment($env) |
||
| 360 | |||
| 361 | /** |
||
| 362 | * Checks if debug mode is enabled. |
||
| 363 | * |
||
| 364 | * @return bool true if debug mode is enabled, false otherwise |
||
| 365 | * |
||
| 366 | * @api |
||
| 367 | */ |
||
| 368 | public function isDebug() |
||
| 372 | |||
| 373 | /** |
||
| 374 | * Gets the application root dir. |
||
| 375 | * |
||
| 376 | * @return string The application root dir |
||
| 377 | * |
||
| 378 | * @api |
||
| 379 | */ |
||
| 380 | public function getRootDir() |
||
| 388 | |||
| 389 | /** |
||
| 390 | * Get the service manager. |
||
| 391 | * |
||
| 392 | * @return ServiceManager\ServiceManager |
||
| 393 | */ |
||
| 394 | public function getServiceManager() |
||
| 398 | |||
| 399 | /** |
||
| 400 | * @note Added for compatibility with Symfony's HttpKernel\Kernel. |
||
| 401 | * |
||
| 402 | * @return null|ServiceManager\ServiceManager |
||
| 403 | */ |
||
| 404 | public function getContainer() |
||
| 408 | |||
| 409 | /** |
||
| 410 | * Returns the Module Manager. |
||
| 411 | * |
||
| 412 | * @return \Zend\ModuleManager\ModuleManager |
||
| 413 | */ |
||
| 414 | public function getModuleManager() |
||
| 422 | |||
| 423 | /** |
||
| 424 | * Get an array of the loaded modules. |
||
| 425 | * |
||
| 426 | * @return array An array of Module objects, keyed by module name |
||
| 427 | */ |
||
| 428 | public function getModules() |
||
| 432 | |||
| 433 | /** |
||
| 434 | * @see PPI\Framework\Module\ModuleManager::locateResource() |
||
| 435 | * |
||
| 436 | * @param string $name A resource name to locate |
||
| 437 | * @param string $dir A directory where to look for the resource first |
||
| 438 | * @param bool $first Whether to return the first path or paths for all matching bundles |
||
| 439 | * |
||
| 440 | * @throws \InvalidArgumentException if the file cannot be found or the name is not valid |
||
| 441 | * @throws \RuntimeException if the name contains invalid/unsafe |
||
| 442 | * @throws \RuntimeException if a custom resource is hidden by a resource in a derived bundle |
||
| 443 | * |
||
| 444 | * @return string|array The absolute path of the resource or an array if $first is false |
||
| 445 | */ |
||
| 446 | public function locateResource($name, $dir = null, $first = true) |
||
| 450 | |||
| 451 | /** |
||
| 452 | * Gets the request start time (not available if debug is disabled). |
||
| 453 | * |
||
| 454 | * @return int The request start timestamp |
||
| 455 | * |
||
| 456 | * @api |
||
| 457 | */ |
||
| 458 | public function getStartTime() |
||
| 462 | |||
| 463 | /** |
||
| 464 | * Gets the cache directory. |
||
| 465 | * |
||
| 466 | * @return string The cache directory |
||
| 467 | * |
||
| 468 | * @api |
||
| 469 | */ |
||
| 470 | public function getCacheDir() |
||
| 474 | |||
| 475 | /** |
||
| 476 | * Gets the log directory. |
||
| 477 | * |
||
| 478 | * @return string The log directory |
||
| 479 | * |
||
| 480 | * @api |
||
| 481 | */ |
||
| 482 | public function getLogDir() |
||
| 486 | |||
| 487 | /** |
||
| 488 | * Gets the charset of the application. |
||
| 489 | * |
||
| 490 | * @return string The charset |
||
| 491 | * |
||
| 492 | * @api |
||
| 493 | */ |
||
| 494 | public function getCharset() |
||
| 498 | |||
| 499 | /** |
||
| 500 | * Returns a ConfigManager instance. |
||
| 501 | * |
||
| 502 | * @return \PPI\Framework\Config\ConfigManager |
||
| 503 | */ |
||
| 504 | public function getConfigManager() |
||
| 513 | |||
| 514 | /** |
||
| 515 | * Loads a configuration file or PHP array. |
||
| 516 | * |
||
| 517 | * @param $resource |
||
| 518 | * @param null $type |
||
| 519 | * |
||
| 520 | * @return App The current instance |
||
| 521 | */ |
||
| 522 | public function loadConfig($resource, $type = null) |
||
| 528 | |||
| 529 | /** |
||
| 530 | * Returns the application configuration. |
||
| 531 | * |
||
| 532 | * @throws \RuntimeException |
||
| 533 | * |
||
| 534 | * @return array|object |
||
| 535 | */ |
||
| 536 | public function getConfig() |
||
| 544 | |||
| 545 | public function serialize() |
||
| 549 | |||
| 550 | public function unserialize($data) |
||
| 556 | |||
| 557 | /** |
||
| 558 | * Returns the application parameters. |
||
| 559 | * |
||
| 560 | * @return array An array of application parameters |
||
| 561 | */ |
||
| 562 | protected function getAppParameters() |
||
| 577 | |||
| 578 | /** |
||
| 579 | * Gets the environment parameters. |
||
| 580 | * |
||
| 581 | * Only the parameters starting with "PPI__" are considered. |
||
| 582 | * |
||
| 583 | * @return array An array of parameters |
||
| 584 | */ |
||
| 585 | protected function getEnvParameters() |
||
| 596 | |||
| 597 | /** |
||
| 598 | * Creates and initializes a ServiceManager instance. |
||
| 599 | * |
||
| 600 | * @return ServiceManager The compiled service manager |
||
| 601 | */ |
||
| 602 | protected function buildServiceManager() |
||
| 611 | |||
| 612 | /** |
||
| 613 | * Perform the matching of a route and return a set of routing parameters if a valid one is found. |
||
| 614 | * Otherwise exceptions get thrown. |
||
| 615 | * |
||
| 616 | * @param HttpRequest $request |
||
| 617 | * |
||
| 618 | * @throws \Exception |
||
| 619 | * |
||
| 620 | * @return array |
||
| 621 | */ |
||
| 622 | protected function handleRouting(HttpRequest $request) |
||
| 646 | |||
| 647 | /** |
||
| 648 | * Logs with an arbitrary level. |
||
| 649 | * |
||
| 650 | * @param mixed $level |
||
| 651 | * @param string $message |
||
| 652 | * @param array $context |
||
| 653 | */ |
||
| 654 | protected function log($level, $message, array $context = array()) |
||
| 664 | |||
| 665 | /** |
||
| 666 | * Enables the debug tools. |
||
| 667 | * |
||
| 668 | * This method registers an error handler and an exception handler. |
||
| 669 | * |
||
| 670 | * If the Symfony ClassLoader component is available, a special |
||
| 671 | * class loader is also registered. |
||
| 672 | */ |
||
| 673 | protected function enableDebug() |
||
| 689 | } |
||
| 690 |
Loading history...
This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass.
Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type.