class ServiceAuditFilesNotOnServer in Audit Files 4.x

Providing the service that used in not in database functionality.

Hierarchy

• class \Drupal\auditfiles\ServiceAuditFilesNotOnServer uses MessengerTrait

2 files declare their use of ServiceAuditFilesNotOnServer

AuditFilesNotOnServer.php in src/Form/AuditFilesNotOnServer.php

AuditFilesNotOnServerBatchProcess.php in src/Batch/AuditFilesNotOnServerBatchProcess.php

1 string reference to 'ServiceAuditFilesNotOnServer'

auditfiles.services.yml in ./auditfiles.services.yml

auditfiles.services.yml

1 service uses ServiceAuditFilesNotOnServer

auditfiles.not_on_server in ./auditfiles.services.yml

Drupal\auditfiles\ServiceAuditFilesNotOnServer

File

src/ServiceAuditFilesNotOnServer.php, line 15

Namespace

Drupal\auditfiles

class ServiceAuditFilesNotOnServer {
  use MessengerTrait;

  /**
   * The Translation service.
   *
   * @var \Drupal\Core\StringTranslation\TranslationInterface
   */
  protected $stringTranslation;

  /**
   * The Configuration Factory.
   *
   * @var \Drupal\Core\Config\ConfigFactory
   */
  protected $configFactory;

  /**
   * The database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $connection;

  /**
   * The Date Formatter.
   *
   * @var \Drupal\Core\Datetime\DateFormatter
   */
  protected $dateFormatter;

  /**
   * The File System service.
   *
   * @var \Drupal\Core\File\FileSystemInterface
   */
  protected $fileSystem;

  /**
   * Define constructor for string translation.
   */
  public function __construct(TranslationInterface $translation, ConfigFactory $config_factory, Connection $connection, DateFormatter $date_formatter, FileSystemInterface $file_system) {
    $this->stringTranslation = $translation;
    $this->configFactory = $config_factory;
    $this->connection = $connection;
    $this->dateFormatter = $date_formatter;
    $this->fileSystem = $file_system;
  }

  /**
   * Retrieves the file IDs to operate on.
   *
   * @return array
   *   The file IDs.
   */
  public function auditfilesNotOnServerGetFileList() {
    $config = $this->configFactory
      ->get('auditfiles.settings');
    $file_ids = [];
    $maximum_records = $config
      ->get('auditfiles_report_options_maximum_records') ? $config
      ->get('auditfiles_report_options_maximum_records') : 250;
    $connection = $this->connection;
    $query = $connection
      ->select('file_managed', 'fm');
    $query
      ->orderBy('changed', 'DESC');
    $query
      ->range(0, $maximum_records);
    $query
      ->fields('fm', [
      'fid',
      'uri',
    ]);
    $results = $query
      ->execute()
      ->fetchAll();
    foreach ($results as $result) {
      $target = $this->fileSystem
        ->realpath($result->uri);
      if (!file_exists($target)) {
        $file_ids[] = $result->fid;
      }
    }
    return $file_ids;
  }

  /**
   * Retrieves information about an individual file from the database.
   *
   * @param int $file_id
   *   The ID of the file to prepare for display.
   * @param string $date_format
   *   The Date format to prepair for display.
   *
   * @return array
   *   The row for the table on the report, with the file's
   *   information formatted for display.
   */
  public function auditfilesNotOnServerGetFileData($file_id, $date_format) {
    $connection = $this->connection;
    $query = $connection
      ->select('file_managed', 'fm');
    $query
      ->condition('fm.fid', $file_id);
    $query
      ->fields('fm', [
      'fid',
      'uid',
      'filename',
      'uri',
      'filemime',
      'filesize',
      'created',
      'status',
    ]);
    $results = $query
      ->execute()
      ->fetchAll();
    $file = $results[0];
    return [
      'fid' => $file->fid,
      'uid' => $file->uid,
      'filename' => $file->filename,
      'uri' => $file->uri,
      'path' => $this->fileSystem
        ->realpath($file->uri),
      'filemime' => $file->filemime,
      'filesize' => number_format($file->filesize),
      'datetime' => $this->dateFormatter
        ->format($file->created, $date_format),
      'status' => ($file->status = 1) ? 'Permanent' : 'Temporary',
    ];
  }

  /**
   * Returns the header to use for the display table.
   *
   * @return array
   *   The header to use.
   */
  public function auditfilesNotOnServerGetHeader() {
    return [
      'fid' => [
        'data' => $this->stringTranslation
          ->translate('File ID'),
      ],
      'uid' => [
        'data' => $this->stringTranslation
          ->translate('User ID'),
      ],
      'filename' => [
        'data' => $this->stringTranslation
          ->translate('Name'),
      ],
      'uri' => [
        'data' => $this->stringTranslation
          ->translate('URI'),
      ],
      'path' => [
        'data' => $this->stringTranslation
          ->translate('Path'),
      ],
      'filemime' => [
        'data' => $this->stringTranslation
          ->translate('MIME'),
      ],
      'filesize' => [
        'data' => $this->stringTranslation
          ->translate('Size'),
      ],
      'datetime' => [
        'data' => $this->stringTranslation
          ->translate('When added'),
      ],
      'status' => [
        'data' => $this->stringTranslation
          ->translate('Status'),
      ],
    ];
  }

  /**
   * Creates the batch for deleting files from the database.
   *
   * @param array $fileids
   *   The list of file IDs to be processed.
   *
   * @return array
   *   The definition of the batch.
   */
  public function auditfilesNotOnServerBatchDeleteCreateBatch(array $fileids) {
    $batch['error_message'] = $this->stringTranslation
      ->translate('One or more errors were encountered processing the files.');
    $batch['finished'] = '\\Drupal\\auditfiles\\Batch\\AuditFilesBatchProcess::finishBatch';
    $batch['progress_message'] = $this->stringTranslation
      ->translate('Completed @current of @total operations.');
    $batch['title'] = $this->stringTranslation
      ->translate('Deleting files from the database');
    $operations = [];
    foreach ($fileids as $file_id) {
      if ($file_id != 0) {
        $operations[] = [
          '\\Drupal\\auditfiles\\Batch\\AuditFilesNotOnServerBatchProcess::auditfilesNotOnServerBatchDeleteProcessBatch',
          [
            $file_id,
          ],
        ];
      }
    }
    $batch['operations'] = $operations;
    return $batch;
  }

  /**
   * Deletes the specified file from the database.
   *
   * @param int $file_id
   *   The ID of the file to delete from the database.
   */
  public function auditfilesNotOnServerBatchDeleteProcessFile($file_id) {
    $connection = $this->connection;
    $num_rows = $connection
      ->delete('file_managed')
      ->condition('fid', $file_id)
      ->execute();
    if (empty($num_rows)) {
      $this
        ->messenger()
        ->addWarning($this->stringTranslation
        ->translate('There was a problem deleting the record with file ID %fid from the file_managed table. Check the logs for more information.', [
        '%fid' => $file_id,
      ]));
    }
    else {
      $this
        ->messenger()
        ->addStatus($this->stringTranslation
        ->translate('Sucessfully deleted File ID : %fid from the file_managed table.', [
        '%fid' => $file_id,
      ]));
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
ServiceAuditFilesNotOnServer::$configFactory	protected	property	The Configuration Factory.
ServiceAuditFilesNotOnServer::$connection	protected	property	The database connection.
ServiceAuditFilesNotOnServer::$dateFormatter	protected	property	The Date Formatter.
ServiceAuditFilesNotOnServer::$fileSystem	protected	property	The File System service.
ServiceAuditFilesNotOnServer::$stringTranslation	protected	property	The Translation service.
ServiceAuditFilesNotOnServer::auditfilesNotOnServerBatchDeleteCreateBatch	public	function	Creates the batch for deleting files from the database.
ServiceAuditFilesNotOnServer::auditfilesNotOnServerBatchDeleteProcessFile	public	function	Deletes the specified file from the database.
ServiceAuditFilesNotOnServer::auditfilesNotOnServerGetFileData	public	function	Retrieves information about an individual file from the database.
ServiceAuditFilesNotOnServer::auditfilesNotOnServerGetFileList	public	function	Retrieves the file IDs to operate on.
ServiceAuditFilesNotOnServer::auditfilesNotOnServerGetHeader	public	function	Returns the header to use for the display table.
ServiceAuditFilesNotOnServer::__construct	public	function	Define constructor for string translation.