Files
Bookshelf/umbra-bookshelf/includes/books/class-umbra-series.php
bdm dec732931c Consolidate three plugins into Umbra Bookshelf
Merge BD Bookshelf (0.1.0), BD BookShelfHelper (2.0.0) and BD SimpleEmail
(2.0.0) into a single plugin released as Umbra Bookshelf 1.0.0, with the
BD Bookshelf theme left as a separate, unrenamed artifact.

Modules
  includes/books/    catalogue, ISBN/ASIN, series, retail, ratings, shortcodes,
                     SEO, GDPR, scrapers, admin, CSV/post import
  includes/library/  book post type + series taxonomy, pen names, data entry,
                     shortlinks, reviews, migrate
  includes/email/    subscribers, newsletters, composition, sending

Renamed: plugin headers, text domains (all three -> umbra-bookshelf), classes
(BD_*/BDM_* -> Umbra_*), constants (-> UMBRA_BOOKSHELF_*), asset handles, JS
globals and admin slugs.

Deliberately not renamed -- persisted contract with live installs and with
published post content: table names, option keys, post meta keys, transients,
nonce actions, cron hooks, AJAX actions, shortcodes ([bd-book], [bd-books],
[bdm_signup]), post type `book`, taxonomy `series`, cookies and CSS classes.
BD_BookShelfHelper survives only as a class_alias for the unmodified theme.

Collisions resolved
  * class-umbra-theme-compatibility.php declared BD_BookShelfHelper, the same
    name as the library module's helper. Latent while the plugins were
    separate (only fired when both were active), but an unconditional fatal
    once merged. Renamed to Umbra_Theme_Compatibility with a class_alias.
  * All three modules called add_menu_page. One top-level menu is now
    registered by the bootstrap at admin_menu priority 9.
  * BD Bookshelf and BookShelfHelper both claimed bd-bookshelf-settings, leaving
    one Settings screen unreachable -> umbra-bookshelf-settings and
    umbra-bookshelf-library-settings.
  * Catalogue and library both enqueued bd-bookshelf-admin; the second enqueue
    was silently discarded -> unique handles per module.
  * Umbra_Admin and Umbra_Migration both registered bd_bookshelf_import_csv, so
    one handler silently replaced the other. The import page now lives only in
    Umbra_Admin (the variant wired to the admin JS); Umbra_Migration keeps only
    the preview/run endpoints it uniquely provides.
  * Modules were constructed from an init callback, so their own init
    registrations raced the hook being dispatched. Now constructed on
    plugins_loaded behind a re-entrancy guard.

Also
  * Missing assets created: assets/images/default-cover.png (referenced but
    never committed, so every cover-less book 404'd) and email/assets/js/
    admin.js (enqueued on every email admin page but never committed).
  * Library module's strpos($hook, 'bd-bookshelf') asset check matched every
    catalogue and email screen once slugs shared the umbra-bookshelf- prefix;
    now matched against its own slug list.
  * Consolidated uninstall deduplicates the double drop of bd_books/bd_series.
  * Specs aligned to the new name; pre-merge specs retained under
    spec/archive/ with provenance notes.
  * Tests added: tests/verify_structure.py (static) and tests/smoke_runtime.php
    (WordPress-stub runtime boot, front-end and admin contexts).

Deferred and recorded in docs/KNOWN-ISSUES.md: the catalogue and library
modules still create bd_books and bd_series with two incompatible schemas
(pre-existing, now unconditional), and Goodreads/Amazon scraping is still
implemented twice on shared cron hooks.
2026-10-18 19:55:36 -07:00

147 lines
3.4 KiB
PHP

<?php
// Copyright 2026 Umbra Tools (umbratools.com)
// SPDX-License-Identifier: Apache-2.0
/**
* Series Management class
*
* @package Umbra_Bookshelf
*/
if (!defined('ABSPATH')) {
exit;
}
class Umbra_Series {
/**
* Get all series
*/
public static function get_series($args = []) {
global $wpdb;
$table = Umbra_Database::table('series');
$defaults = [
'number' => 20,
'offset' => 0,
'orderby' => 'name',
'order' => 'ASC',
];
$args = wp_parse_args($args, $defaults);
$order = strtoupper($args['order']) === 'DESC' ? 'DESC' : 'ASC';
$query = $wpdb->prepare(
"SELECT * FROM {$table} ORDER BY {$args['orderby']} {$order} LIMIT %d OFFSET %d",
$args['number'],
$args['offset']
);
return $wpdb->get_results($query);
}
/**
* Get series by ID
*/
public static function get_series_by_id($series_id) {
global $wpdb;
$table = Umbra_Database::table('series');
return $wpdb->get_row(
$wpdb->prepare(
"SELECT * FROM {$table} WHERE id = %d",
$series_id
)
);
}
/**
* Create series
*/
public static function create_series($data) {
global $wpdb;
$table = Umbra_Database::table('series');
$result = $wpdb->insert($table, [
'name' => sanitize_text_field($data['name']),
'description' => wp_kses_post($data['description'] ?? ''),
'cover_image' => esc_url_raw($data['cover_image'] ?? ''),
]);
return $result ? $wpdb->insert_id : false;
}
/**
* Update series
*/
public static function update_series($series_id, $data) {
global $wpdb;
$table = Umbra_Database::table('series');
$update_data = [];
if (isset($data['name'])) {
$update_data['name'] = sanitize_text_field($data['name']);
}
if (isset($data['description'])) {
$update_data['description'] = wp_kses_post($data['description']);
}
if (isset($data['cover_image'])) {
$update_data['cover_image'] = esc_url_raw($data['cover_image']);
}
if (empty($update_data)) {
return false;
}
$result = $wpdb->update(
$table,
$update_data,
['id' => $series_id],
null,
['%d']
);
return $result !== false;
}
/**
* Delete series
*/
public static function delete_series($series_id) {
global $wpdb;
// Unlink books from series
$books_table = Umbra_Database::table('books');
$wpdb->update(
$books_table,
['series_id' => 0],
['series_id' => $series_id],
['%d'],
['%d']
);
// Delete series
$table = Umbra_Database::table('series');
return $wpdb->delete($table, ['id' => $series_id], ['%d']) !== false;
}
/**
* Count series
*/
public static function count_series() {
global $wpdb;
$table = Umbra_Database::table('series');
return $wpdb->get_var("SELECT COUNT(*) FROM {$table}");
}
}