class BatchStorage in Drupal 9

Provides a proxy class for \Drupal\Core\Batch\BatchStorage.

Hierarchy

• class \Drupal\Core\ProxyClass\Batch\BatchStorage implements BatchStorageInterface uses DependencySerializationTrait

See also

\Drupal\Component\ProxyBuilder

File

core/lib/Drupal/Core/ProxyClass/Batch/BatchStorage.php, line 15

Namespace

Drupal\Core\ProxyClass\Batch

class BatchStorage implements \Drupal\Core\Batch\BatchStorageInterface {
  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\Batch\BatchStorage
   */
  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 load($id) {
    return $this
      ->lazyLoadItself()
      ->load($id);
  }

  /**
   * {@inheritdoc}
   */
  public function delete($id) {
    return $this
      ->lazyLoadItself()
      ->delete($id);
  }

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

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

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

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

}

Members

Name	Modifiers	Type	Description	Overrides
BatchStorage::$container	protected	property	The service container.
BatchStorage::$drupalProxyOriginalServiceId	protected	property	The id of the original proxied service.
BatchStorage::$service	protected	property	The real proxied service, after it was lazy loaded.
BatchStorage::cleanup	public	function	Cleans up failed or old batches. Overrides BatchStorageInterface::cleanup
BatchStorage::create	public	function	Creates and saves a batch. Overrides BatchStorageInterface::create
BatchStorage::delete	public	function	Deletes a batch. Overrides BatchStorageInterface::delete
BatchStorage::lazyLoadItself	protected	function	Lazy loads the real service from the container.
BatchStorage::load	public	function	Loads a batch. Overrides BatchStorageInterface::load
BatchStorage::schemaDefinition	public	function
BatchStorage::update	public	function	Updates a batch. Overrides BatchStorageInterface::update
BatchStorage::__construct	public	function	Constructs a ProxyClass Drupal proxy object.
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2