Skip to content

Commit af2055b

Browse files
committed
Update docs.
1 parent c58952b commit af2055b

File tree

3 files changed

+7
-18
lines changed

3 files changed

+7
-18
lines changed

plugins/wpgraphql-logging/docs/how-to/admin_add_view_column.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,15 @@ add_filter( 'wpgraphql_logging_logs_table_column_headers', function( $headers )
3333

3434
### Step 2 — Provide the cell value
3535

36-
Each row item is a `\WPGraphQL\Logging\Logger\Database\DatabaseEntity`. Memory data is stored in `$item->get_extra()['memory_peak_usage']`.
36+
Each row item is a `\WPGraphQL\Logging\Logger\Database\WordPressDatabaseEntity`. Memory data is stored in `$item->get_extra()['memory_peak_usage']`.
3737

3838
```php
3939
add_filter( 'wpgraphql_logging_logs_table_column_value', function( $value, $item, $column_name ) {
4040
if ( 'peak_memory_usage' !== $column_name ) {
4141
return $value;
4242
}
4343

44-
if ( ! $item instanceof \WPGraphQL\Logging\Logger\Database\DatabaseEntity ) {
44+
if ( ! $item instanceof \WPGraphQL\Logging\Logger\Database\WordPressDatabaseEntity ) {
4545
return $value;
4646
}
4747

plugins/wpgraphql-logging/docs/reference/admin.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,7 @@ Filters the rendered value for each column.
304304

305305
Parameters:
306306
- `$value` (mixed)
307-
- `$item` (\WPGraphQL\Logging\Logger\Database\DatabaseEntity)
307+
- `$item` (\WPGraphQL\Logging\Logger\Database\WordPressDatabaseEntity)
308308
- `$column_name` (string)
309309

310310
Returns: mixed
@@ -380,7 +380,7 @@ Filters the CSV column headers.
380380
Parameters:
381381
- `$headers` (array)
382382
- `$log_id` (int)
383-
- `$log` (\WPGraphQL\Logging\Logger\Database\DatabaseEntity)
383+
- `$log` (\WPGraphQL\Logging\Logger\Database\WordPressDatabaseEntity)
384384

385385
Returns: array
386386

@@ -397,7 +397,7 @@ Filters the CSV row values.
397397
Parameters:
398398
- `$content` (array)
399399
- `$log_id` (int)
400-
- `$log` (\WPGraphQL\Logging\Logger\Database\DatabaseEntity)
400+
- `$log` (\WPGraphQL\Logging\Logger\Database\WordPressDatabaseEntity)
401401

402402
Returns: array
403403

plugins/wpgraphql-logging/docs/reference/logging.md

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@ The WPGraphQL Logging subsystem is built on [Monolog](https://github.com/Seldaek
99
- [Logger\Handlers\WordPressDatabaseHandler](#class-loggerhandlerswordpressdatabasehandler)
1010
- [Logger\Processors\RequestHeadersProcessor](#class-loggerprocessorsrequestheadersprocessor)
1111
- [Logger\Processors\DataSanitizationProcessor](#class-loggerprocessorsdatasanitizationprocessor)
12-
- [Logger\Database\DatabaseEntity](#class-loggerdatabasedatabaseentity)
13-
- [Logger\Database\LogsRepository](#class-loggerdatabaselogsrepository)
12+
- [Logger\Database\WordPressDatabaseEntity](#class-loggerdatabasewordpressdatabaseentity)
1413
- [Logger\Scheduler\DataDeletionScheduler](#class-loggerschedulerdatadeletionscheduler)
1514
- [Quick Start](#quick-start)
1615
- [Available Log Levels](#available-log-levels)
@@ -217,7 +216,7 @@ Returns: Monolog\LogRecord
217216

218217
---
219218

220-
### Class: `Logger\Database\DatabaseEntity`
219+
### Class: `Logger\Database\WordPressDatabaseEntity`
221220
Source: <https://github.com/wpengine/hwptoolkit/blob/main/plugins/wpgraphql-logging/src/Logger/Database/DatabaseEntity.php>
222221

223222
Represents a single log entry and provides persistence helpers.
@@ -259,16 +258,6 @@ add_filter( 'wpgraphql_logging_allowed_orderby_columns', function( array $column
259258
**Note:** If an invalid column is requested, the query will fallback to ordering by `id` (default).
260259

261260

262-
---
263-
264-
### Class: `Logger\Database\LogsRepository`
265-
Source: <https://github.com/wpengine/hwptoolkit/blob/main/plugins/wpgraphql-logging/src/Logger/Database/LogsRepository.php>
266-
267-
Query and mutation helpers for log entries.
268-
269-
Hooks: None.
270-
271-
272261
---
273262

274263
### Class: `Logger\Scheduler\DataDeletionScheduler`

0 commit comments

Comments
 (0)