class Plugin
Same name in this branch
- 11.x composer/Plugin/RecipeUnpack/Plugin.php \Drupal\Composer\Plugin\RecipeUnpack\Plugin
- 11.x core/lib/Drupal/Component/Annotation/Plugin.php \Drupal\Component\Annotation\Plugin
- 11.x core/lib/Drupal/Component/Plugin/Attribute/Plugin.php \Drupal\Component\Plugin\Attribute\Plugin
Same name and namespace in other branches
- 10 composer/Plugin/Scaffold/Plugin.php \Drupal\Composer\Plugin\Scaffold\Plugin
- 10 core/lib/Drupal/Component/Annotation/Plugin.php \Drupal\Component\Annotation\Plugin
- 10 core/lib/Drupal/Component/Plugin/Attribute/Plugin.php \Drupal\Component\Plugin\Attribute\Plugin
- 9 composer/Plugin/Scaffold/Plugin.php \Drupal\Composer\Plugin\Scaffold\Plugin
- 9 core/lib/Drupal/Component/Annotation/Plugin.php \Drupal\Component\Annotation\Plugin
- 8.9.x composer/Plugin/Scaffold/Plugin.php \Drupal\Composer\Plugin\Scaffold\Plugin
- 8.9.x core/lib/Drupal/Component/Annotation/Plugin.php \Drupal\Component\Annotation\Plugin
Composer plugin for handling drupal scaffold.
@internal
Hierarchy
- class \Drupal\Composer\Plugin\Scaffold\Plugin implements \Composer\Plugin\PluginInterface, \Composer\EventDispatcher\EventSubscriberInterface, \Composer\Plugin\Capable
Expanded class hierarchy of Plugin
1 file declares its use of Plugin
- Composer.php in core/
lib/ Drupal/ Core/ Composer/ Composer.php
22 string references to 'Plugin'
- Action::create in core/
modules/ system/ src/ Entity/ Action.php - Constructs a new entity object, without permanently saving it.
- ActionValidationTest::testInvalidPluginId in core/
modules/ system/ tests/ src/ Kernel/ Entity/ ActionValidationTest.php - Tests that the action plugin ID is validated.
- block.schema.yml in core/
modules/ block/ config/ schema/ block.schema.yml - core/modules/block/config/schema/block.schema.yml
- BlockCreationTrait::placeBlock in core/
modules/ block/ tests/ src/ Traits/ BlockCreationTrait.php - Creates a block instance based on default settings.
- BlockDependenciesTest::createBlock in core/
modules/ views/ tests/ src/ Kernel/ Plugin/ BlockDependenciesTest.php - Creates a block instance based on default settings.
File
-
composer/
Plugin/ Scaffold/ Plugin.php, line 26
Namespace
Drupal\Composer\Plugin\ScaffoldView source
class Plugin implements PluginInterface, EventSubscriberInterface, Capable {
/**
* The Composer service.
*
* @var \Composer\Composer
*/
protected $composer;
/**
* Composer's I/O service.
*
* @var \Composer\IO\IOInterface
*/
protected $io;
/**
* The Composer Scaffold handler.
*
* @var \Drupal\Composer\Plugin\Scaffold\Handler
*/
protected $handler;
/**
* Record whether the 'require' command was called.
*
* @var bool
*/
protected $requireWasCalled;
/**
* {@inheritdoc}
*/
public function activate(Composer $composer, IOInterface $io) {
$this->composer = $composer;
$this->io = $io;
$this->requireWasCalled = FALSE;
}
/**
* {@inheritdoc}
*/
public function deactivate(Composer $composer, IOInterface $io) {
}
/**
* {@inheritdoc}
*/
public function uninstall(Composer $composer, IOInterface $io) {
}
/**
* {@inheritdoc}
*/
public function getCapabilities() {
return [
CommandProvider::class => ScaffoldCommandProvider::class,
];
}
/**
* {@inheritdoc}
*/
public static function getSubscribedEvents() {
// Important note: We only instantiate our handler on "post" events.
return [
ScriptEvents::POST_UPDATE_CMD => 'postCmd',
ScriptEvents::POST_INSTALL_CMD => 'postCmd',
PackageEvents::POST_PACKAGE_INSTALL => 'postPackage',
PluginEvents::COMMAND => 'onCommand',
ScriptEvents::PRE_AUTOLOAD_DUMP => 'preAutoloadDump',
];
}
/**
* Post command event callback.
*
* @param \Composer\Script\Event $event
* The Composer event.
*/
public function postCmd(Event $event) {
$this->handler()
->scaffold();
}
/**
* Post package event behavior.
*
* @param \Composer\Installer\PackageEvent $event
* Composer package event sent on install/update/remove.
*/
public function postPackage(PackageEvent $event) {
$this->handler()
->onPostPackageEvent($event);
}
/**
* Pre command event callback.
*
* @param \Composer\Plugin\CommandEvent $event
* The Composer command event.
*/
public function onCommand(CommandEvent $event) {
if ($event->getCommandName() == 'require') {
if ($this->handler) {
throw new \Error('Core Scaffold Plugin handler instantiated too early. See https://www.drupal.org/project/drupal/issues/3104922');
}
$this->requireWasCalled = TRUE;
}
}
/**
* Instantiates the handler object upon demand.
*
* It is dangerous to update a Composer plugin if it loads any classes prior
* to the `composer update` operation, and later tries to use them in a
* post-update hook.
*/
protected function handler() {
if (!$this->handler) {
$this->handler = new Handler($this->composer, $this->io);
// On instantiation of our handler, notify it if the 'require' command
// was executed.
if ($this->requireWasCalled) {
$this->handler
->requireWasCalled();
}
}
return $this->handler;
}
/**
* Add vendor classes to Composer's static classmap.
*
* @param \Composer\Script\Event $event
* The event.
*/
public static function preAutoloadDump(Event $event) : void {
// Get the configured vendor directory.
$vendor_dir = $event->getComposer()
->getConfig()
->get('vendor-dir');
// We need the root_package package so we can add our classmaps to its loader.
$package = $event->getComposer()
->getPackage();
// We need the local repository so that we can query and see if it's likely
// that our files are present there.
$repository = $event->getComposer()
->getRepositoryManager()
->getLocalRepository();
// This is, essentially, a null constraint. We only care whether the package
// is present in the vendor directory yet, but findPackage() requires it.
$constraint = new Constraint('>', '');
// It's possible that there is no classmap specified in a custom project
// composer.json file. We need one so we can optimize lookup for some of our
// dependencies.
$autoload = $package->getAutoload();
$autoload['classmap'] ??= [];
// Check for packages used prior to the default classloader being able to
// use APCu and optimize them if they're present.
// @see \Drupal\Core\DrupalKernel::boot()
if ($repository->findPackage('symfony/http-foundation', $constraint)) {
$autoload['classmap'] = array_merge($autoload['classmap'], [
$vendor_dir . '/symfony/http-foundation/Request.php',
$vendor_dir . '/symfony/http-foundation/RequestStack.php',
$vendor_dir . '/symfony/http-foundation/ParameterBag.php',
$vendor_dir . '/symfony/http-foundation/FileBag.php',
$vendor_dir . '/symfony/http-foundation/ServerBag.php',
$vendor_dir . '/symfony/http-foundation/HeaderBag.php',
$vendor_dir . '/symfony/http-foundation/HeaderUtils.php',
]);
}
if ($repository->findPackage('symfony/http-kernel', $constraint)) {
$autoload['classmap'] = array_merge($autoload['classmap'], [
$vendor_dir . '/symfony/http-kernel/HttpKernel.php',
$vendor_dir . '/symfony/http-kernel/HttpKernelInterface.php',
$vendor_dir . '/symfony/http-kernel/TerminableInterface.php',
]);
}
if ($repository->findPackage('symfony/dependency-injection', $constraint)) {
$autoload['classmap'][] = $vendor_dir . '/symfony/dependency-injection/ContainerInterface.php';
}
if ($repository->findPackage('psr/container', $constraint)) {
$autoload['classmap'][] = $vendor_dir . '/psr/container/src/ContainerInterface.php';
}
$filesystem = new Filesystem();
// Do not remove double realpath() calls.
// Fixes failing Windows realpath() implementation.
// See https://bugs.php.net/bug.php?id=72738
$vendor_path = realpath(realpath($vendor_dir));
$filesystem->ensureDirectoryExists($vendor_path . '/drupal');
// Create the Drupal\DrupalInstalled class.
file_put_contents($vendor_path . '/drupal/DrupalInstalled.php', DrupalInstalledTemplate::getCode($package, $repository));
$autoload['classmap'][] = $vendor_dir . '/drupal/DrupalInstalled.php';
$package->setAutoload($autoload);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
Plugin::$composer | protected | property | The Composer service. |
Plugin::$handler | protected | property | The Composer Scaffold handler. |
Plugin::$io | protected | property | Composer's I/O service. |
Plugin::$requireWasCalled | protected | property | Record whether the 'require' command was called. |
Plugin::activate | public | function | |
Plugin::deactivate | public | function | |
Plugin::getCapabilities | public | function | |
Plugin::getSubscribedEvents | public static | function | |
Plugin::handler | protected | function | Instantiates the handler object upon demand. |
Plugin::onCommand | public | function | Pre command event callback. |
Plugin::postCmd | public | function | Post command event callback. |
Plugin::postPackage | public | function | Post package event behavior. |
Plugin::preAutoloadDump | public static | function | Add vendor classes to Composer's static classmap. |
Plugin::uninstall | public | function |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.