Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)

[2] Fix | Delete

[3] Fix | Delete

[4] Fix | Delete

* Licensed under The MIT License

[5] Fix | Delete

* Redistributions of files must retain the above copyright notice.

[6] Fix | Delete

[7] Fix | Delete

* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)

[8] Fix | Delete

* @link https://cakephp.org CakePHP(tm) Project

[9] Fix | Delete

* @since 3.6.0

[10] Fix | Delete

* @license https://opensource.org/licenses/mit-license.php MIT License

[11] Fix | Delete

[12] Fix | Delete

namespace Cake\Core;

[13] Fix | Delete

[14] Fix | Delete

use InvalidArgumentException;

[15] Fix | Delete

use ReflectionClass;

[16] Fix | Delete

[17] Fix | Delete

/**

[18] Fix | Delete

* Base Plugin Class

[19] Fix | Delete

[20] Fix | Delete

* Every plugin should extends from this class or implement the interfaces and

[21] Fix | Delete

* include a plugin class in it's src root folder.

[22] Fix | Delete

[23] Fix | Delete

class BasePlugin implements PluginInterface

[24] Fix | Delete

{

[25] Fix | Delete

/**

[26] Fix | Delete

* Do bootstrapping or not

[27] Fix | Delete

[28] Fix | Delete

* @var bool

[29] Fix | Delete

[30] Fix | Delete

protected $bootstrapEnabled = true;

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* Load routes or not

[34] Fix | Delete

[35] Fix | Delete

* @var bool

[36] Fix | Delete

[37] Fix | Delete

protected $routesEnabled = true;

[38] Fix | Delete

[39] Fix | Delete

/**

[40] Fix | Delete

* Enable middleware

[41] Fix | Delete

[42] Fix | Delete

* @var bool

[43] Fix | Delete

[44] Fix | Delete

protected $middlewareEnabled = true;

[45] Fix | Delete

[46] Fix | Delete

/**

[47] Fix | Delete

* Console middleware

[48] Fix | Delete

[49] Fix | Delete

* @var bool

[50] Fix | Delete

[51] Fix | Delete

protected $consoleEnabled = true;

[52] Fix | Delete

[53] Fix | Delete

/**

[54] Fix | Delete

* The path to this plugin.

[55] Fix | Delete

[56] Fix | Delete

* @var string

[57] Fix | Delete

[58] Fix | Delete

protected $path;

[59] Fix | Delete

[60] Fix | Delete

/**

[61] Fix | Delete

* The class path for this plugin.

[62] Fix | Delete

[63] Fix | Delete

* @var string

[64] Fix | Delete

[65] Fix | Delete

protected $classPath;

[66] Fix | Delete

[67] Fix | Delete

/**

[68] Fix | Delete

* The config path for this plugin.

[69] Fix | Delete

[70] Fix | Delete

* @var string

[71] Fix | Delete

[72] Fix | Delete

protected $configPath;

[73] Fix | Delete

[74] Fix | Delete

/**

[75] Fix | Delete

* The name of this plugin

[76] Fix | Delete

[77] Fix | Delete

* @var string

[78] Fix | Delete

[79] Fix | Delete

protected $name;

[80] Fix | Delete

[81] Fix | Delete

/**

[82] Fix | Delete

* Constructor

[83] Fix | Delete

[84] Fix | Delete

* @param array $options Options

[85] Fix | Delete

[86] Fix | Delete

public function __construct(array $options = [])

[87] Fix | Delete

{

[88] Fix | Delete

foreach (static::VALID_HOOKS as $key) {

[89] Fix | Delete

if (isset($options[$key])) {

[90] Fix | Delete

$this->{"{$key}Enabled"} = (bool)$options[$key];

[91] Fix | Delete

}

[92] Fix | Delete

}

[93] Fix | Delete

foreach (['name', 'path', 'classPath', 'configPath'] as $path) {

[94] Fix | Delete

if (isset($options[$path])) {

[95] Fix | Delete

$this->{$path} = $options[$path];

[96] Fix | Delete

}

[97] Fix | Delete

}

[98] Fix | Delete

[99] Fix | Delete

$this->initialize();

[100] Fix | Delete

}

[101] Fix | Delete

[102] Fix | Delete

/**

[103] Fix | Delete

* {@inheritdoc}

[104] Fix | Delete

[105] Fix | Delete

public function initialize()

[106] Fix | Delete

{

[107] Fix | Delete

}

[108] Fix | Delete

[109] Fix | Delete

/**

[110] Fix | Delete

* {@inheritDoc}

[111] Fix | Delete

[112] Fix | Delete

public function getName()

[113] Fix | Delete

{

[114] Fix | Delete

if ($this->name) {

[115] Fix | Delete

return $this->name;

[116] Fix | Delete

}

[117] Fix | Delete

$parts = explode('\\', get_class($this));

[118] Fix | Delete

array_pop($parts);

[119] Fix | Delete

$this->name = implode('/', $parts);

[120] Fix | Delete

[121] Fix | Delete

return $this->name;

[122] Fix | Delete

}

[123] Fix | Delete

[124] Fix | Delete

/**

[125] Fix | Delete

* {@inheritDoc}

[126] Fix | Delete

[127] Fix | Delete

public function getPath()

[128] Fix | Delete

{

[129] Fix | Delete

if ($this->path) {

[130] Fix | Delete

return $this->path;

[131] Fix | Delete

}

[132] Fix | Delete

$reflection = new ReflectionClass($this);

[133] Fix | Delete

$path = dirname($reflection->getFileName());

[134] Fix | Delete

[135] Fix | Delete

// Trim off src

[136] Fix | Delete

if (substr($path, -3) === 'src') {

[137] Fix | Delete

$path = substr($path, 0, -3);

[138] Fix | Delete

}

[139] Fix | Delete

$this->path = rtrim($path, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;

[140] Fix | Delete

[141] Fix | Delete

return $this->path;

[142] Fix | Delete

}

[143] Fix | Delete

[144] Fix | Delete

/**

[145] Fix | Delete

* {@inheritDoc}

[146] Fix | Delete

[147] Fix | Delete

public function getConfigPath()

[148] Fix | Delete

{

[149] Fix | Delete

if ($this->configPath) {

[150] Fix | Delete

return $this->configPath;

[151] Fix | Delete

}

[152] Fix | Delete

$path = $this->getPath();

[153] Fix | Delete

[154] Fix | Delete

return $path . 'config' . DIRECTORY_SEPARATOR;

[155] Fix | Delete

}

[156] Fix | Delete

[157] Fix | Delete

/**

[158] Fix | Delete

* {@inheritDoc}

[159] Fix | Delete

[160] Fix | Delete

public function getClassPath()

[161] Fix | Delete

{

[162] Fix | Delete

if ($this->classPath) {

[163] Fix | Delete

return $this->classPath;

[164] Fix | Delete

}

[165] Fix | Delete

$path = $this->getPath();

[166] Fix | Delete

[167] Fix | Delete

return $path . 'src' . DIRECTORY_SEPARATOR;

[168] Fix | Delete

}

[169] Fix | Delete

[170] Fix | Delete

/**

[171] Fix | Delete

* {@inheritdoc}

[172] Fix | Delete

[173] Fix | Delete

public function enable($hook)

[174] Fix | Delete

{

[175] Fix | Delete

$this->checkHook($hook);

[176] Fix | Delete

$this->{"{$hook}Enabled}"} = true;

[177] Fix | Delete

[178] Fix | Delete

return $this;

[179] Fix | Delete

}

[180] Fix | Delete

[181] Fix | Delete

/**

[182] Fix | Delete

* {@inheritdoc}

[183] Fix | Delete

[184] Fix | Delete

public function disable($hook)

[185] Fix | Delete

{

[186] Fix | Delete

$this->checkHook($hook);

[187] Fix | Delete

$this->{"{$hook}Enabled"} = false;

[188] Fix | Delete

[189] Fix | Delete

return $this;

[190] Fix | Delete

}

[191] Fix | Delete

[192] Fix | Delete

/**

[193] Fix | Delete

* {@inheritdoc}

[194] Fix | Delete

[195] Fix | Delete

public function isEnabled($hook)

[196] Fix | Delete

{

[197] Fix | Delete

$this->checkHook($hook);

[198] Fix | Delete

[199] Fix | Delete

return $this->{"{$hook}Enabled"} === true;

[200] Fix | Delete

}

[201] Fix | Delete

[202] Fix | Delete

/**

[203] Fix | Delete

* Check if a hook name is valid

[204] Fix | Delete

[205] Fix | Delete

* @param string $hook The hook name to check

[206] Fix | Delete

* @throws \InvalidArgumentException on invalid hooks

[207] Fix | Delete

* @return void

[208] Fix | Delete

[209] Fix | Delete

protected function checkHook($hook)

[210] Fix | Delete

{

[211] Fix | Delete

if (!in_array($hook, static::VALID_HOOKS)) {

[212] Fix | Delete

throw new InvalidArgumentException(

[213] Fix | Delete

"`$hook` is not a valid hook name. Must be one of " . implode(', ', static::VALID_HOOKS)

[214] Fix | Delete

);

[215] Fix | Delete

}

[216] Fix | Delete

}

[217] Fix | Delete

[218] Fix | Delete

/**

[219] Fix | Delete

* {@inheritdoc}

[220] Fix | Delete

[221] Fix | Delete

public function routes($routes)

[222] Fix | Delete

{

[223] Fix | Delete

$path = $this->getConfigPath() . 'routes.php';

[224] Fix | Delete

if (file_exists($path)) {

[225] Fix | Delete

require $path;

[226] Fix | Delete

}

[227] Fix | Delete

}

[228] Fix | Delete

[229] Fix | Delete

/**

[230] Fix | Delete

* {@inheritdoc}

[231] Fix | Delete

[232] Fix | Delete

public function bootstrap(PluginApplicationInterface $app)

[233] Fix | Delete

{

[234] Fix | Delete

$bootstrap = $this->getConfigPath() . 'bootstrap.php';

[235] Fix | Delete

if (file_exists($bootstrap)) {

[236] Fix | Delete

require $bootstrap;

[237] Fix | Delete

}

[238] Fix | Delete

}

[239] Fix | Delete

[240] Fix | Delete

/**

[241] Fix | Delete

* {@inheritdoc}

[242] Fix | Delete

[243] Fix | Delete

public function console($commands)

[244] Fix | Delete

{

[245] Fix | Delete

return $commands->addMany($commands->discoverPlugin($this->getName()));

[246] Fix | Delete

}

[247] Fix | Delete

[248] Fix | Delete

/**

[249] Fix | Delete

* {@inheritdoc}

[250] Fix | Delete

[251] Fix | Delete

public function middleware($middleware)

[252] Fix | Delete

{

[253] Fix | Delete

return $middleware;

[254] Fix | Delete

}

[255] Fix | Delete

}

[256] Fix | Delete

[257] Fix | Delete