class DBLogResource

Same name and namespace in other branches
  1. 10 core/modules/dblog/src/Plugin/rest/resource/DbLogResource.php \Drupal\dblog\Plugin\rest\resource\DbLogResource
  2. 11.x core/modules/dblog/src/Plugin/rest/resource/DbLogResource.php \Drupal\dblog\Plugin\rest\resource\DbLogResource
  3. 8.9.x core/modules/dblog/src/Plugin/rest/resource/DBLogResource.php \Drupal\dblog\Plugin\rest\resource\DBLogResource

Provides a resource for database watchdog log entries.

Plugin annotation


@RestResource(
  id = "dblog",
  label = @Translation("Watchdog database log"),
  uri_paths = {
    "canonical" = "/dblog/{id}"
  }
)

Hierarchy

Expanded class hierarchy of DBLogResource

File

core/modules/dblog/src/Plugin/rest/resource/DBLogResource.php, line 22

Namespace

Drupal\dblog\Plugin\rest\resource
View source
class DBLogResource extends ResourceBase {
  
  /**
   * Responds to GET requests.
   *
   * Returns a watchdog log entry for the specified ID.
   *
   * @param int $id
   *   The ID of the watchdog log entry.
   *
   * @return \Drupal\rest\ResourceResponse
   *   The response containing the log entry.
   *
   * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
   *   Thrown when the log entry was not found.
   * @throws \Symfony\Component\HttpKernel\Exception\BadRequestHttpException
   *   Thrown when no log entry was provided.
   */
  public function get($id = NULL) {
    if ($id) {
      $record = Database::getConnection()->query("SELECT * FROM {watchdog} WHERE [wid] = :wid", [
        ':wid' => $id,
      ])
        ->fetchAssoc();
      if (!empty($record)) {
        return new ResourceResponse($record);
      }
      throw new NotFoundHttpException("Log entry with ID '{$id}' was not found");
    }
    throw new BadRequestHttpException('No log entry ID was provided');
  }

}

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