You are here

class ModuleInstaller in Drupal 9

Same name in this branch
  1. 9 core/lib/Drupal/Core/Extension/ModuleInstaller.php \Drupal\Core\Extension\ModuleInstaller
  2. 9 core/lib/Drupal/Core/ProxyClass/Extension/ModuleInstaller.php \Drupal\Core\ProxyClass\Extension\ModuleInstaller
Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/ProxyClass/Extension/ModuleInstaller.php \Drupal\Core\ProxyClass\Extension\ModuleInstaller

Provides a proxy class for \Drupal\Core\Extension\ModuleInstaller.

Hierarchy

Expanded class hierarchy of ModuleInstaller

See also

\Drupal\Component\ProxyBuilder

File

core/lib/Drupal/Core/ProxyClass/Extension/ModuleInstaller.php, line 15

Namespace

Drupal\Core\ProxyClass\Extension
View source
class ModuleInstaller implements \Drupal\Core\Extension\ModuleInstallerInterface {
  use \Drupal\Core\DependencyInjection\DependencySerializationTrait;

  /**
   * The id of the original proxied service.
   *
   * @var string
   */
  protected $drupalProxyOriginalServiceId;

  /**
   * The real proxied service, after it was lazy loaded.
   *
   * @var \Drupal\Core\Extension\ModuleInstaller
   */
  protected $service;

  /**
   * The service container.
   *
   * @var \Symfony\Component\DependencyInjection\ContainerInterface
   */
  protected $container;

  /**
   * Constructs a ProxyClass Drupal proxy object.
   *
   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
   *   The container.
   * @param string $drupal_proxy_original_service_id
   *   The service ID of the original service.
   */
  public function __construct(\Symfony\Component\DependencyInjection\ContainerInterface $container, $drupal_proxy_original_service_id) {
    $this->container = $container;
    $this->drupalProxyOriginalServiceId = $drupal_proxy_original_service_id;
  }

  /**
   * Lazy loads the real service from the container.
   *
   * @return object
   *   Returns the constructed real service.
   */
  protected function lazyLoadItself() {
    if (!isset($this->service)) {
      $this->service = $this->container
        ->get($this->drupalProxyOriginalServiceId);
    }
    return $this->service;
  }

  /**
   * {@inheritdoc}
   */
  public function addUninstallValidator(\Drupal\Core\Extension\ModuleUninstallValidatorInterface $uninstall_validator) {
    return $this
      ->lazyLoadItself()
      ->addUninstallValidator($uninstall_validator);
  }

  /**
   * {@inheritdoc}
   */
  public function install(array $module_list, $enable_dependencies = true) {
    return $this
      ->lazyLoadItself()
      ->install($module_list, $enable_dependencies);
  }

  /**
   * {@inheritdoc}
   */
  public function uninstall(array $module_list, $uninstall_dependents = true) {
    return $this
      ->lazyLoadItself()
      ->uninstall($module_list, $uninstall_dependents);
  }

  /**
   * {@inheritdoc}
   */
  public function validateUninstall(array $module_list) {
    return $this
      ->lazyLoadItself()
      ->validateUninstall($module_list);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
ModuleInstaller::$container protected property The service container.
ModuleInstaller::$drupalProxyOriginalServiceId protected property The id of the original proxied service.
ModuleInstaller::$service protected property The real proxied service, after it was lazy loaded.
ModuleInstaller::addUninstallValidator public function Adds module a uninstall validator. Overrides ModuleInstallerInterface::addUninstallValidator
ModuleInstaller::install public function Installs a given list of modules. Overrides ModuleInstallerInterface::install
ModuleInstaller::lazyLoadItself protected function Lazy loads the real service from the container.
ModuleInstaller::uninstall public function Uninstalls a given list of modules. Overrides ModuleInstallerInterface::uninstall
ModuleInstaller::validateUninstall public function Determines whether a list of modules can be uninstalled. Overrides ModuleInstallerInterface::validateUninstall
ModuleInstaller::__construct public function Constructs a ProxyClass Drupal proxy object.