Merge pull request #27 from soderlind/feature/use-vmf-addon-base

soderlind · web-flow · commit 5d16d7abf65b · 2026-03-14T16:51:22.000+01:00
Feature/use vmf addon base
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.8.0] - 2026-03-14
+
+### Changed
+
+- Refactored Plugin class to extend `VirtualMediaFolders\Addon\AbstractPlugin` base class
+- Refactored SettingsTab to extend `AbstractSettingsTab`, removed inline enqueue and WP 7 compat logic
+- Removed duplicated singleton boilerplate and manual textdomain loading
+
 ## [1.7.0] - 2026-03-10
 
 ### Added
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "vmfa-editorial-workflow",
-	"version": "1.7.0",
+	"version": "1.8.0",
 	"description": "Role-based folder access, move restrictions, and Inbox workflow for Virtual Media Folders.",
 	"author": "Per Soderlind",
 	"license": "GPL-2.0-or-later",
diff --git a/readme.txt b/readme.txt
@@ -4,7 +4,7 @@ Tags: media, folders, workflow, editorial, permissions
 Requires at least: 6.8
 Tested up to: 7.0
 Requires PHP: 8.3
-Stable tag: 1.7.0
+Stable tag: 1.8.0
 License: GPL-2.0-or-later
 License URI: https://www.gnu.org/licenses/gpl-2.0.html
 
@@ -95,6 +95,11 @@ Existing media is not affected. The workflow only applies to new uploads and exp
 
 == Changelog ==
 
+= 1.8.0 =
+* Changed: Refactored Plugin class to extend VMF core `AbstractPlugin` base class
+* Changed: Refactored SettingsTab to extend `AbstractSettingsTab`
+* Changed: Removed duplicated singleton boilerplate and manual textdomain loading
+
 = 1.7.0 =
 * Added: WP 7.0+ design-token style overrides for settings and review pages
 
diff --git a/src/php/Admin/SettingsTab.php b/src/php/Admin/SettingsTab.php
@@ -11,143 +11,96 @@
 
 namespace VmfaEditorialWorkflow\Admin;
 
-// Prevent direct access.
 defined( 'ABSPATH' ) || exit;
 
+use VirtualMediaFolders\Addon\AbstractSettingsTab;
+
 /**
  * Settings Tab class.
  *
  * Adds a settings tab to VMF settings page.
  */
-class SettingsTab {
-
-	/**
-	 * Tab ID.
-	 *
-	 * @var string
-	 */
-	public const TAB_ID = 'editorial-workflow';
+class SettingsTab extends AbstractSettingsTab {
 
-	/**
-	 * Constructor.
-	 */
-	public function __construct() {
-		$this->init_hooks();
+	/** @inheritDoc */
+	protected function get_tab_slug(): string {
+		return 'editorial-workflow';
 	}
 
-	/**
-	 * Initialize hooks.
-	 *
-	 * @return void
-	 */
-	private function init_hooks(): void {
-		// Register tab with VMF settings.
-		add_filter( 'vmfo_settings_tabs', [ $this, 'register_tab' ] );
-
-		// Enqueue settings assets.
-		add_action( 'vmfo_settings_enqueue_scripts', [ $this, 'enqueue_assets' ], 10, 2 );
+	/** @inheritDoc */
+	protected function get_tab_label(): string {
+		return __( 'Editorial Workflow', 'vmfa-editorial-workflow' );
 	}
 
-	/**
-	 * Register settings tab.
-	 *
-	 * @param array $tabs Existing tabs.
-	 * @return array Modified tabs.
-	 */
-	public function register_tab( array $tabs ): array {
-		$tabs[ self::TAB_ID ] = [
-			'title'    => __( 'Editorial Workflow', 'vmfa-editorial-workflow' ),
-			'callback' => [ $this, 'render_tab' ],
-		];
-
-		return $tabs;
+	/** @inheritDoc */
+	protected function get_text_domain(): string {
+		return 'vmfa-editorial-workflow';
 	}
 
-	/**
-	 * Enqueue assets for settings tab.
-	 *
-	 * @param string $active_tab    Currently active tab.
-	 * @param string $active_subtab Currently active subtab.
-	 * @return void
-	 */
-	public function enqueue_assets( string $active_tab, string $active_subtab ): void {
-		if ( self::TAB_ID !== $active_tab ) {
-			return;
-		}
+	/** @inheritDoc */
+	protected function get_build_path(): string {
+		return VMFA_EDITORIAL_WORKFLOW_PATH . 'build/';
+	}
 
-		$asset_file = VMFA_EDITORIAL_WORKFLOW_PATH . 'build/settings.asset.php';
-		$asset      = file_exists( $asset_file ) ? require $asset_file : [
-			'dependencies' => [ 'wp-element', 'wp-components', 'wp-api-fetch', 'wp-i18n' ],
-			'version'      => VMFA_EDITORIAL_WORKFLOW_VERSION,
-		];
+	/** @inheritDoc */
+	protected function get_build_url(): string {
+		return VMFA_EDITORIAL_WORKFLOW_URL . 'build/';
+	}
 
-		wp_enqueue_style(
-			'vmfa-editorial-workflow-settings',
-			VMFA_EDITORIAL_WORKFLOW_URL . 'build/settings.css',
-			[ 'wp-components' ],
-			$asset[ 'version' ]
-		);
+	/** @inheritDoc */
+	protected function get_languages_path(): string {
+		return VMFA_EDITORIAL_WORKFLOW_PATH . 'languages';
+	}
 
-		wp_enqueue_script(
-			'vmfa-editorial-workflow-settings',
-			VMFA_EDITORIAL_WORKFLOW_URL . 'build/settings.js',
-			$asset[ 'dependencies' ],
-			$asset[ 'version' ],
-			true
-		);
+	/** @inheritDoc */
+	protected function get_plugin_version(): string {
+		return VMFA_EDITORIAL_WORKFLOW_VERSION;
+	}
 
-		wp_set_script_translations(
-			'vmfa-editorial-workflow-settings',
-			'vmfa-editorial-workflow',
-			VMFA_EDITORIAL_WORKFLOW_PATH . 'languages'
-		);
+	/** @inheritDoc */
+	protected function get_localized_name(): string {
+		return 'vmfaSettings';
+	}
 
-		// WP 7+ design-token overrides.
-		if ( function_exists( 'vmfo_is_wp7' ) && vmfo_is_wp7() ) {
-			$wp7_asset_file = VMFA_EDITORIAL_WORKFLOW_PATH . 'build/wp7-compat.asset.php';
-			$wp7_version    = file_exists( $wp7_asset_file )
-				? ( include $wp7_asset_file )['version'] ?? VMFA_EDITORIAL_WORKFLOW_VERSION
-				: VMFA_EDITORIAL_WORKFLOW_VERSION;
+	/** @inheritDoc */
+	protected function get_asset_entry(): string {
+		return 'settings';
+	}
 
-			wp_enqueue_style(
-				'vmfa-editorial-workflow-wp7',
-				VMFA_EDITORIAL_WORKFLOW_URL . 'build/wp7-compat.css',
-				[ 'vmfa-editorial-workflow-settings', 'wp-base-styles' ],
-				$wp7_version
-			);
-		}
+	/** @inheritDoc */
+	protected function get_app_container_id(): string {
+		return 'vmfa-settings-root';
+	}
 
-		wp_localize_script(
-			'vmfa-editorial-workflow-settings',
-			'vmfaSettings',
-			[
-				'restUrl' => rest_url( 'vmfa-editorial/v1' ),
-				'nonce'   => wp_create_nonce( 'wp_rest' ),
-				'roles'   => $this->get_editable_roles(),
-				'folders' => $this->get_folders(),
-				'actions' => $this->get_actions(),
-				'i18n'    => [
-					'title'           => __( 'Editorial Workflow Settings', 'vmfa-editorial-workflow' ),
-					'permissions'     => __( 'Folder Permissions', 'vmfa-editorial-workflow' ),
-					'permissionsDesc' => __( 'Configure which roles can access each folder.', 'vmfa-editorial-workflow' ),
-					'inbox'           => __( 'Inbox Mapping', 'vmfa-editorial-workflow' ),
-					'inboxDesc'       => __( 'Set the default upload folder for each role.', 'vmfa-editorial-workflow' ),
-					'workflow'        => __( 'Workflow Settings', 'vmfa-editorial-workflow' ),
-					'workflowDesc'    => __( 'Configure workflow states and behavior.', 'vmfa-editorial-workflow' ),
-					'enableWorkflow'  => __( 'Enable workflow folders', 'vmfa-editorial-workflow' ),
-					'save'            => __( 'Save Changes', 'vmfa-editorial-workflow' ),
-					'saving'          => __( 'Saving…', 'vmfa-editorial-workflow' ),
-					'saved'           => __( 'Settings saved.', 'vmfa-editorial-workflow' ),
-					'error'           => __( 'Error saving settings.', 'vmfa-editorial-workflow' ),
-					'selectFolder'    => __( 'Select folder…', 'vmfa-editorial-workflow' ),
-					'noInbox'         => __( 'No inbox (use default)', 'vmfa-editorial-workflow' ),
-					'view'            => __( 'View', 'vmfa-editorial-workflow' ),
-					'move'            => __( 'Move to', 'vmfa-editorial-workflow' ),
-					'upload'          => __( 'Upload to', 'vmfa-editorial-workflow' ),
-					'delete'          => __( 'Delete', 'vmfa-editorial-workflow' ),
-				],
-			]
-		);
+	/** @inheritDoc */
+	protected function get_localized_data(): array {
+		return [
+			'restUrl' => rest_url( 'vmfa-editorial/v1' ),
+			'nonce'   => wp_create_nonce( 'wp_rest' ),
+			'roles'   => $this->get_editable_roles(),
+			'folders' => $this->get_folders(),
+			'actions' => $this->get_actions(),
+			'i18n'    => [
+				'title'           => __( 'Editorial Workflow Settings', 'vmfa-editorial-workflow' ),
+				'permissions'     => __( 'Folder Permissions', 'vmfa-editorial-workflow' ),
+				'permissionsDesc' => __( 'Configure which roles can access each folder.', 'vmfa-editorial-workflow' ),
+				'inbox'           => __( 'Inbox Mapping', 'vmfa-editorial-workflow' ),
+				'inboxDesc'       => __( 'Set the default upload folder for each role.', 'vmfa-editorial-workflow' ),
+				'workflow'        => __( 'Workflow Settings', 'vmfa-editorial-workflow' ),
+				'workflowDesc'    => __( 'Configure workflow states and behavior.', 'vmfa-editorial-workflow' ),
+				'enableWorkflow'  => __( 'Enable workflow folders', 'vmfa-editorial-workflow' ),
+				'save'            => __( 'Save Changes', 'vmfa-editorial-workflow' ),
+				'saving'          => __( 'Saving…', 'vmfa-editorial-workflow' ),
+				'saved'           => __( 'Settings saved.', 'vmfa-editorial-workflow' ),
+				'error'           => __( 'Error saving settings.', 'vmfa-editorial-workflow' ),
+				'selectFolder'    => __( 'Select folder…', 'vmfa-editorial-workflow' ),
+				'noInbox'         => __( 'No inbox (use default)', 'vmfa-editorial-workflow' ),
+				'view'            => __( 'View', 'vmfa-editorial-workflow' ),
+				'move'            => __( 'Move to', 'vmfa-editorial-workflow' ),
+				'upload'          => __( 'Upload to', 'vmfa-editorial-workflow' ),
+				'delete'          => __( 'Delete', 'vmfa-editorial-workflow' ),
+			],
+		];
 	}
 
 	/**
@@ -159,7 +112,7 @@ public function enqueue_assets( string $active_tab, string $active_subtab ): voi
 	 */
 	public function render_tab( string $active_tab, string $active_subtab ): void {
 		?>
-		<div id="vmfa-settings-root">
+		<div id="<?php echo esc_attr( $this->get_app_container_id() ); ?>">
 			<p class="description">
 				<?php esc_html_e( 'Loading settings…', 'vmfa-editorial-workflow' ); ?>
 			</p>
@@ -177,19 +130,17 @@ private function get_editable_roles(): array {
 		$wp_roles = wp_roles();
 
 		foreach ( $wp_roles->roles as $role_key => $role_data ) {
-			// Skip administrator - they always have full access.
 			if ( 'administrator' === $role_key ) {
 				continue;
 			}
 
-			// Only include roles that can upload files.
-			if ( ! isset( $role_data[ 'capabilities' ][ 'upload_files' ] ) || ! $role_data[ 'capabilities' ][ 'upload_files' ] ) {
+			if ( ! isset( $role_data['capabilities']['upload_files'] ) || ! $role_data['capabilities']['upload_files'] ) {
 				continue;
 			}
 
 			$roles[] = [
 				'key'  => $role_key,
-				'name' => translate_user_role( $role_data[ 'name' ] ),
+				'name' => translate_user_role( $role_data['name'] ),
 			];
 		}
 
diff --git a/src/php/Plugin.php b/src/php/Plugin.php
diff --git a/vmfa-editorial-workflow.php b/vmfa-editorial-workflow.php

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "vmfa-editorial-workflow",`
`3`		`- "version": "1.7.0",`
	`3`	`+ "version": "1.8.0",`
`4`	`4`	`"description": "Role-based folder access, move restrictions, and Inbox workflow for Virtual Media Folders.",`
`5`	`5`	`"author": "Per Soderlind",`
`6`	`6`	`"license": "GPL-2.0-or-later",`