class DBLogResource

Same name and namespace in other branches
  1. 8.9.x core/modules/dblog/src/Plugin/rest/resource/DBLogResource.php \Drupal\dblog\Plugin\rest\resource\DBLogResource
  2. 10 core/modules/dblog/src/Plugin/rest/resource/DbLogResource.php \Drupal\dblog\Plugin\rest\resource\DbLogResource
  3. 11.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 on git.drupalcode.org
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');
  }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
DBLogResource::get public function Responds to GET requests.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function #[\ReturnTypeWillChange] 2
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
ResourceBase::$logger protected property A logger instance.
ResourceBase::$serializerFormats protected property The available serialization formats.
ResourceBase::availableMethods public function Returns the available HTTP request methods on this plugin. Overrides ResourceInterface::availableMethods 1
ResourceBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 3
ResourceBase::getBaseRoute protected function Gets the base route for a particular method. 2
ResourceBase::getBaseRouteRequirements protected function Gets the base route requirements for a particular method. 1
ResourceBase::permissions public function Implements ResourceInterface::permissions(). Overrides ResourceInterface::permissions 2
ResourceBase::requestMethods protected function Provides predefined HTTP request methods.
ResourceBase::routes public function Returns a collection of routes with URL path information for the resource. Overrides ResourceInterface::routes
ResourceBase::__construct public function Constructs a Drupal\rest\Plugin\ResourceBase object. Overrides PluginBase::__construct 3
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.

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