Skip to content

Commit d86d34d

Browse files
committed
Improve documentation of the enricher
1 parent ef48f15 commit d86d34d

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

src/Version10/EnricherPluginInterface.php

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,21 @@
1212
interface EnricherPluginInterface extends ConfigurationPluginInterface
1313
{
1414
/**
15-
* Enriches the configuration of a specific other
15+
* Enriches the configuration of another diagnostics plugin.
16+
*
17+
* The enricher might be used for several plugins and have to handle the plugin depending on its name and version.
18+
*
1619
* @param string $pluginName The name of the plugin which is enriched.
1720
* @param array $pluginConfig The current plugin configuration.
1821
* @param PluginConfigurationInterface $config The configuration of the enricher plugin itself.
22+
*
1923
* @param EnvironmentInterface $environment The environment for the
2024
*
2125
* @return array
2226
*/
2327
public function enrich(
2428
string $pluginName,
29+
string $pluginVersion,
2530
array $pluginConfig,
2631
PluginConfigurationInterface $config,
2732
EnvironmentInterface $environment

src/Version10/EnvironmentInterface.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
namespace Phpcq\PluginApi\Version10;
66

7+
use Phpcq\PluginApi\Version10\Exception\RuntimeException;
78
use Phpcq\PluginApi\Version10\Task\TaskFactoryInterface;
89

910
interface EnvironmentInterface
@@ -32,6 +33,11 @@ public function getBuildTempDir(): string;
3233
/**
3334
* Get the installed directory of the current plugin.
3435
*
36+
* The installed directory is also the home of the plugin specific generated composer.json. Installed composer
37+
* packages will be available in the vendor subdirectory.
38+
*
39+
* The plugin might
40+
*
3541
* @return string
3642
*/
3743
public function getInstalledDir(): string;

0 commit comments

Comments
 (0)