class ConfigInstaller

Same name in this branch
  1. 9 core/lib/Drupal/Core/Config/ConfigInstaller.php \Drupal\Core\Config\ConfigInstaller
Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/ProxyClass/Config/ConfigInstaller.php \Drupal\Core\ProxyClass\Config\ConfigInstaller
  2. 8.9.x core/lib/Drupal/Core/Config/ConfigInstaller.php \Drupal\Core\Config\ConfigInstaller
  3. 10 core/lib/Drupal/Core/ProxyClass/Config/ConfigInstaller.php \Drupal\Core\ProxyClass\Config\ConfigInstaller
  4. 10 core/lib/Drupal/Core/Config/ConfigInstaller.php \Drupal\Core\Config\ConfigInstaller
  5. 11.x core/lib/Drupal/Core/ProxyClass/Config/ConfigInstaller.php \Drupal\Core\ProxyClass\Config\ConfigInstaller
  6. 11.x core/lib/Drupal/Core/Config/ConfigInstaller.php \Drupal\Core\Config\ConfigInstaller

Provides a proxy class for \Drupal\Core\Config\ConfigInstaller.

Hierarchy

Expanded class hierarchy of ConfigInstaller

See also

\Drupal\Component\ProxyBuilder

File

core/lib/Drupal/Core/ProxyClass/Config/ConfigInstaller.php, line 15

Namespace

Drupal\Core\ProxyClass\Config
View source
class ConfigInstaller implements \Drupal\Core\Config\ConfigInstallerInterface {
    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\Config\ConfigInstaller
     */
    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 installDefaultConfig($type, $name) {
        return $this->lazyLoadItself()
            ->installDefaultConfig($type, $name);
    }
    
    /**
     * {@inheritdoc}
     */
    public function installOptionalConfig(?\Drupal\Core\Config\StorageInterface $storage = NULL, $dependency = array()) {
        return $this->lazyLoadItself()
            ->installOptionalConfig($storage, $dependency);
    }
    
    /**
     * {@inheritdoc}
     */
    public function installCollectionDefaultConfig($collection) {
        return $this->lazyLoadItself()
            ->installCollectionDefaultConfig($collection);
    }
    
    /**
     * {@inheritdoc}
     */
    public function setSourceStorage(\Drupal\Core\Config\StorageInterface $storage) {
        return $this->lazyLoadItself()
            ->setSourceStorage($storage);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getSourceStorage() {
        return $this->lazyLoadItself()
            ->getSourceStorage();
    }
    
    /**
     * {@inheritdoc}
     */
    public function setSyncing($status) {
        return $this->lazyLoadItself()
            ->setSyncing($status);
    }
    
    /**
     * {@inheritdoc}
     */
    public function isSyncing() {
        return $this->lazyLoadItself()
            ->isSyncing();
    }
    
    /**
     * {@inheritdoc}
     */
    public function checkConfigurationToInstall($type, $name) {
        return $this->lazyLoadItself()
            ->checkConfigurationToInstall($type, $name);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConfigInstaller::$container protected property The service container.
ConfigInstaller::$drupalProxyOriginalServiceId protected property The id of the original proxied service.
ConfigInstaller::$service protected property The real proxied service, after it was lazy loaded.
ConfigInstaller::checkConfigurationToInstall public function Checks the configuration that will be installed for an extension. Overrides ConfigInstallerInterface::checkConfigurationToInstall
ConfigInstaller::getSourceStorage public function Gets the configuration storage that provides the default configuration. Overrides ConfigInstallerInterface::getSourceStorage
ConfigInstaller::installCollectionDefaultConfig public function Installs all default configuration in the specified collection. Overrides ConfigInstallerInterface::installCollectionDefaultConfig
ConfigInstaller::installDefaultConfig public function Installs the default configuration of a given extension. Overrides ConfigInstallerInterface::installDefaultConfig
ConfigInstaller::installOptionalConfig public function Installs optional configuration. Overrides ConfigInstallerInterface::installOptionalConfig
ConfigInstaller::isSyncing public function Gets the syncing state. Overrides ConfigInstallerInterface::isSyncing
ConfigInstaller::lazyLoadItself protected function Lazy loads the real service from the container.
ConfigInstaller::setSourceStorage public function Sets the configuration storage that provides the default configuration. Overrides ConfigInstallerInterface::setSourceStorage
ConfigInstaller::setSyncing public function Sets the status of the isSyncing flag. Overrides ConfigInstallerInterface::setSyncing
ConfigInstaller::__construct public function Constructs a ProxyClass Drupal proxy object.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.