class DBLogResource

Same name 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 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.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
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. 3

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