Coupons & Fees - Relationship Table

src/Tickets/Order_Modifiers/Controller.php

@@ -12,6 +12,7 @@
 use TEC\Common\StellarWP\Schema\Register as Schema_Register;
 use TEC\Common\StellarWP\Schema\Config as Schema_Config;
 use TEC\Common\StellarWP\DB\DB;
+use TEC\Tickets\Order_Modifiers\Custom_Tables\Order_Modifier_Relationships;
 use TEC\Tickets\Order_Modifiers\Custom_Tables\Order_Modifiers;
 use TEC\Tickets\Order_Modifiers\Custom_Tables\Order_Modifiers_Meta;
 use TEC\Tickets\Order_Modifiers\Modifiers\Coupon;
@@ -60,7 +61,7 @@ public function do_register(): void {
 	 * @since TBD
 	 */
 	protected function hook() {
-		tribe( Modifier_Settings::class )->register();
+		tribe( Modifier_Admin_Handler::class )->register();
 	}
 
 	/**
@@ -84,6 +85,7 @@ public function unregister(): void {
 	public function register_tables(): void {
 		$this->container->singleton( Order_Modifiers::class, Schema_Register::table( Order_Modifiers::class ) );
 		$this->container->singleton( Order_Modifiers_Meta::class, Schema_Register::table( Order_Modifiers_Meta::class ) );
+		$this->container->singleton( Order_Modifier_Relationships::class, Schema_Register::table( Order_Modifier_Relationships::class ) );
 	}
 
 	/**

src/Tickets/Order_Modifiers/Custom_Tables/Order_Modifier_Relationships.php

@@ -0,0 +1,160 @@
+<?php
+/**
+ * Order Modifiers Relationships custom table logic.
+ *
+ * @package TEC\Tickets\Order_Modifiers\Custom_Tables;
+ */
+
+namespace TEC\Tickets\Order_Modifiers\Custom_Tables;
+
+use TEC\Common\StellarWP\Schema\Tables\Contracts\Table;
+use wpdb;
+
+/**
+ * Class Orders_Modifiers.
+ *
+ * @since TBD
+ *
+ * @package TEC\Tickets\Order_Modifiers\Custom_Tables;
+ */
+class Order_Modifier_Relationships extends Table {
+	/**
+	 * @since TBD
+	 *
+	 * @var string|null The version number for this schema definition.
+	 */
+	public const SCHEMA_VERSION = '1.0.0';
+
+	/**
+	 * @since TBD
+	 *
+	 * @var string The base table name.
+	 */
+	protected static $base_table_name = 'tec_order_modifier_relationships';
+
+	/**
+	 * @since TBD
+	 *
+	 * @var string The organizational group this table belongs to.
+	 */
+	protected static $group = 'tec_order_modifiers_group';
+
+	/**
+	 * @since TBD
+	 *
+	 * @var string|null The slug used to identify the custom table.
+	 */
+	protected static $schema_slug = 'tec-order-modifiers-relationships';
+
+	/**
+	 * @since TBD
+	 *
+	 * @var string The field that uniquely identifies a row in the table.
+	 */
+	protected static $uid_column = 'object_id';
+
+	/**
+	 * Returns the table creation SQL in the format supported
+	 * by the `dbDelta` function.
+	 *
+	 * @since TBD
+	 *
+	 * @return string The table creation SQL, in the format supported
+	 *                by the `dbDelta` function.
+	 */
+	protected function get_definition() {
+		global $wpdb;
+		$table_name        = self::table_name( true );
+		$charset_collate   = $wpdb->get_charset_collate();
+		$parent_table_name = Order_Modifiers::table_name();
+		$parent_table_uid  = Order_Modifiers::uid_column();
+		$wp_posts_table    = $wpdb->posts;
+
+		return "
+			CREATE TABLE `$table_name` (
+				`object_id` BIGINT UNSIGNED NOT NULL AUTO_INCREMENT,
+				`modifier_id` BIGINT UNSIGNED NOT NULL,
+				`post_id`  BIGINT UNSIGNED NOT NULL,
+				`post_type` VARCHAR(20) NOT NULL,
+				PRIMARY KEY (`object_id`),
+				FOREIGN KEY (`modifier_id`) REFERENCES $parent_table_name($parent_table_uid)ON DELETE CASCADE,
+    			CONSTRAINT `fk_post_id` FOREIGN KEY (`post_id`) REFERENCES `$wp_posts_table` (`ID`) ON DELETE CASCADE
+			) $charset_collate;
+		";
+	}
+
+	/**
+	 * Allows extending classes that require it to run some methods
+	 * immediately after the table creation or update.
+	 *
+	 * @since TBD
+	 *
+	 * @param array<string,string> $results A map of results in the format
+	 *                                      returned by the `dbDelta` function.
+	 *
+	 * @return array<string,string> A map of results in the format returned by
+	 *                              the `dbDelta` function.
+	 */
+	protected function after_update( array $results ): array {
+		// If nothing was changed by dbDelta(), bail.
+		if ( ! count( $results ) ) {
+			return $results;
+		}
+
+		global $wpdb;
+		$table_name = self::table_name( true );
+
+		// Check if the table exists first.
+		if ( ! $this->exists() ) {
+			return $results;
+		}
+
+		// Helper method to check and add indexes.
+		$results = $this->check_and_add_index( $wpdb, $results, $table_name, 'tec_order_modifier_relationship_indx_modifier_id', 'modifier_id' );
+		$results = $this->check_and_add_index( $wpdb, $results, $table_name, 'tec_order_modifier_relationship_indx_post_type', 'post_id,post_type' );
+		$results = $this->check_and_add_index( $wpdb, $results, $table_name, 'tec_order_modifier_relationship_indx_composite_join', 'modifier_id, post_id, post_type' );
+
+		return $results;
+	}
+
+	/**
+	 * Helper method to check and add an index to a table.
+	 *
+	 * @since TBD
+	 *
+	 * @param wpdb   $wpdb The WordPress database global.
+	 * @param array  $results The results array to track changes.
+	 * @param string $table_name The name of the table.
+	 * @param string $index_name The name of the index.
+	 * @param string $columns The columns to index.
+	 *
+	 * @return array The updated results array.
+	 */
+	protected function check_and_add_index( wpdb $wpdb, array $results, string $table_name, string $index_name, string $columns ): array {
+		// Escape table name and columns for safety.
+		$table_name = esc_sql( $table_name );
+		$columns    = esc_sql( $columns );
+
+		// Add index only if it does not exist.
+		if ( ! $this->has_index( $index_name ) ) {
+			// Prepare the SQL for adding an index.
+			$sql = $wpdb->prepare(
+				"ALTER TABLE `$table_name` ADD INDEX `%s` ( $columns )",
+				$index_name
+			);
+
+			// phpcs:ignore WordPress.DB.DirectDatabaseQuery,WordPress.DB.PreparedSQL.NotPrepared
+			$updated = $wpdb->query( $sql );
+
+			if ( $updated ) {
+				$message = sprintf( 'Added index to the %s table on %s.', $table_name, $columns );
+			} else {
+				$message = sprintf( 'Failed to add an index on the %s table for %s.', $table_name, $columns );
+			}
+
+			$results[ "{$table_name}.{$columns}" ] = $message;
+		}
+
+		return $results;
+	}
+}

src/Tickets/Order_Modifiers/Custom_Tables/Order_Modifiers.php

@@ -70,7 +70,6 @@ protected function get_definition() {
 		return "
 			CREATE TABLE `$table_name` (
 				`id` BIGINT UNSIGNED NOT NULL AUTO_INCREMENT,
-				`post_id` BIGINT UNSIGNED NOT NULL,
 				`modifier_type` VARCHAR(255) NOT NULL,
 				`sub_type` VARCHAR(255) NOT NULL,
 				`fee_amount_cents` INT NOT NULL,
@@ -113,9 +112,7 @@ protected function after_update( array $results ): array {
 		}
 
 		// Helper method to check and add indexes.
-		$results = $this->check_and_add_index( $wpdb, $results, $table_name, 'tec_order_modifier_indx_post_id', 'post_id' );
 		$results = $this->check_and_add_index( $wpdb, $results, $table_name, 'tec_order_modifier_indx_slug', 'slug' );
-		$results = $this->check_and_add_index( $wpdb, $results, $table_name, 'tec_order_modifier_indx_post_id_status', 'post_id, status' );
 		$results = $this->check_and_add_index( $wpdb, $results, $table_name, 'tec_order_modifier_indx_status_modifier_type_slug', 'status, modifier_type, slug' );
 		$results = $this->check_and_add_index( $wpdb, $results, $table_name, 'tec_order_modifier_indx_type_display_name', 'modifier_type, display_name' );
 

src/Tickets/Order_Modifiers/Data_Transfer_Objects/Order_Modifier_DTO.php

@@ -30,15 +30,6 @@ class Order_Modifier_DTO extends DataTransferObject {
 	 */
 	protected int $id;
 
-	/**
-	 * The associated post ID.
-	 *
-	 * @since TBD
-	 *
-	 * @var int
-	 */
-	protected int $post_id;
-
 	/**
 	 * The modifier type (coupon, fee).
 	 *
@@ -133,7 +124,6 @@ public static function fromObject( $object ): self {
 		$self = new self();
 
 		$self->id               = $object->id;
-		$self->post_id          = $object->post_id;
 		$self->modifier_type    = $object->modifier_type;
 		$self->sub_type         = $object->sub_type;
 		$self->fee_amount_cents = $object->fee_amount_cents;

src/Tickets/Order_Modifiers/Data_Transfer_Objects/Order_Modifier_Relationships_DTO.php

@@ -0,0 +1,102 @@
+<?php
+/**
+ * The data transfer object for the Order Modifier Relationship model.
+ *
+ * @since TBD
+ *
+ * @package TEC\Tickets\Order_Modifiers\Data_Transfer_Objects;
+ */
+
+namespace TEC\Tickets\Order_Modifiers\Data_Transfer_Objects;
+
+use TEC\Common\StellarWP\Models\DataTransferObject;
+use TEC\Tickets\Order_Modifiers\Models\Order_Modifier_Relationships;
+
+/**
+ * Class Order_Modifier_Relationships_DTO.
+ *
+ * @since TBD
+ *
+ * @package TEC\Tickets\Order_Modifiers\Data_Transfer_Objects;
+ */
+class Order_Modifier_Relationships_DTO extends DataTransferObject {
+
+	/**
+	 * The primary key of the relationship.
+	 *
+	 * @since TBD
+	 *
+	 * @var int
+	 */
+	protected int $object_id;
+
+	/**
+	 * The modifier ID.
+	 *
+	 * @since TBD
+	 *
+	 * @var int
+	 */
+	protected int $modifier_id;
+
+	/**
+	 * The post ID.
+	 *
+	 * @since TBD
+	 *
+	 * @var int
+	 */
+	protected int $post_id;
+
+	/**
+	 * The post type.
+	 *
+	 * @since TBD
+	 *
+	 * @var string
+	 */
+	protected string $post_type;
+
+	/**
+	 * The post title (optional, for clarity when rendering data).
+	 *
+	 * @since TBD
+	 *
+	 * @var string|null
+	 */
+	protected ?string $post_title = null;
+
+	/**
+	 * Builds a new DTO from an object.
+	 *
+	 * @since TBD
+	 *
+	 * @param object $object The object to build the DTO from.
+	 *
+	 * @return Order_Modifier_Relationships_DTO The DTO instance.
+	 */
+	public static function fromObject( $object ): self {
+		$self = new self();
+
+		$self->object_id   = $object->object_id;
+		$self->modifier_id = $object->modifier_id;
+		$self->post_id     = $object->post_id;
+		$self->post_type   = $object->post_type;
+		$self->post_title  = $object->post_title ?? null;
+
+		return $self;
+	}
+
+	/**
+	 * Builds a model instance from the DTO.
+	 *
+	 * @since TBD
+	 *
+	 * @return Order_Modifier_Relationships The model instance.
+	 */
+	public function toModel(): Order_Modifier_Relationships {
+		$attributes = get_object_vars( $this );
+
+		return new Order_Modifier_Relationships( $attributes );
+	}
+}

src/Tickets/Order_Modifiers/Models/Order_Modifier.php

@@ -24,7 +24,6 @@
  * @package TEC\Tickets\Order_Modifiers\Models;
  *
  * @property int    $id              The Order Modifier ID.
- * @property int    $post_id         Associated post ID.
  * @property string $modifier_type   The type of modifier (coupon, fee).
  * @property string $sub_type        The sub-type of modifier (percentage, flat).
  * @property int    $fee_amount_cents Amount of fee in cents.
@@ -42,7 +41,6 @@ class Order_Modifier extends Model implements ModelCrud, ModelFromQueryBuilderOb
 	 */
 	protected $properties = [
 		'id'               => 'int',
-		'post_id'          => 'int',
 		'modifier_type'    => 'string',
 		'sub_type'         => 'string',
 		'fee_amount_cents' => 'int',