You are here

class AuditFilesMergeFileReferencesBatchProcess in Audit Files 8.3

Process batch files.

@todo Refactor to make a Factory Worker class.

Hierarchy

Expanded class hierarchy of AuditFilesMergeFileReferencesBatchProcess

File

src/Batch/AuditFilesMergeFileReferencesBatchProcess.php, line 14

Namespace

Drupal\auditfiles\Batch
View source
class AuditFilesMergeFileReferencesBatchProcess {

  /**
   * The File entity ID to delete.
   *
   * @var int
   */
  protected $fileId;

  /**
   * The File entity IDs to merge.
   *
   * @var array
   */
  protected $fileIds;

  /**
   * ManagedNotUsed service.
   *
   * @var \Drupal\auditfiles\ServiceAuditFilesMergeFileReferences
   */
  protected $mergeFileReferences;

  /**
   * Class constructor.
   *
   * @param \Drupal\auditfiles\ServiceAuditFilesMergeFileReferences $merge_file_references
   *   Injected ServiceAuditFilesManagedNotUsed service.
   * @param int $file_being_kept
   *   File entity ID to delete.
   * @param array $files_being_merged
   *   File IDs to merge.
   */
  public function __construct(ServiceAuditFilesMergeFileReferences $merge_file_references, $file_being_kept, array $files_being_merged) {
    $this->mergeFileReferences = $merge_file_references;
    $this->fileId = $file_being_kept;
    $this->fileIds = $files_being_merged;
  }

  /**
   * The batch process for deleting the file.
   *
   * @param int $file_being_kept
   *   The file ID of the file to merge the other into.
   * @param array $files_being_merged
   *   The file ID of the files to merge.
   * @param array $context
   *   Used by the Batch API to keep track of and pass data from one operation
   *   to the next.
   */
  public static function auditfilesMergeFileReferencesBatchMergeProcessBatch($file_being_kept, array $files_being_merged, array &$context) {
    $mergeFileReferences = \Drupal::service('auditfiles.merge_file_references');
    $worker = new static($mergeFileReferences, $file_being_kept, $files_being_merged);
    $worker
      ->dispatch($context);
  }

  /**
   * Processes the file IDs to delete and merge.
   *
   * @param array $context
   *   Batch context.
   */
  protected function dispatch(array &$context) {
    $this->mergeFileReferences
      ->auditfilesMergeFileReferencesBatchMergeProcessFile($this->fileId, $this->fileIds);
    $context['results'][] = Html::escape($this->fileId);
    $context['results'][] = Html::escape($this->filesIds);
    $context['message'] = new TranslatableMarkup('Merged file ID %file_being_merged into file ID %file_being_kept.', [
      '%file_being_kept' => $this->fileId,
      '%file_being_merged' => $this->fileIds,
    ]);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AuditFilesMergeFileReferencesBatchProcess::$fileId protected property The File entity ID to delete.
AuditFilesMergeFileReferencesBatchProcess::$fileIds protected property The File entity IDs to merge.
AuditFilesMergeFileReferencesBatchProcess::$mergeFileReferences protected property ManagedNotUsed service.
AuditFilesMergeFileReferencesBatchProcess::auditfilesMergeFileReferencesBatchMergeProcessBatch public static function The batch process for deleting the file.
AuditFilesMergeFileReferencesBatchProcess::dispatch protected function Processes the file IDs to delete and merge.
AuditFilesMergeFileReferencesBatchProcess::__construct public function Class constructor.