WIP: 3.0.0 - new DomainQuery (in the style of WP_Query)

assets/css/DomainMapping.css

@@ -40,5 +40,9 @@
                 }
             }
         }
+
+        & .dmp__domain-table-empty {
+            text-align: center;
+        }
     }
 }

assets/js/components/domain/Table.js

@@ -148,6 +148,13 @@ class Table extends Component {
 						</tr>
 					);
 				} ) }
+				{ 0 === domains.length && (
+					<tr>
+						<td colSpan={ displayFields.length }>
+							<p className="dmp__domain-table-empty">{ __( 'No domains have been added for this site.', 'darkmatterplugin' ) }</p>
+						</td>
+					</tr>
+				) }
 			</tbody>
 		);
 	}

includes/classes/DomainMapping/CLI/Domains.php

@@ -9,12 +9,12 @@
 
 namespace DarkMatter\DomainMapping\CLI;
 
-use DarkMatter\DomainMapping\Manager;
+use DarkMatter\DomainMapping\Data\Domain;
+use DarkMatter\DomainMapping\Data\DomainMapping;
+use DarkMatter\DomainMapping\Data\DomainQuery;
 use WP_CLI;
 use WP_CLI_Command;
 
-// phpcs:disable PHPCompatibility.Keywords.ForbiddenNames.listFound -- Changing CLI for list would introduce backward compatibility (2.x.x) problems for pre-existing users.
-
 /**
  * Class Domains
  *
@@ -72,7 +72,7 @@ public function add( $args, $assoc_args ) {
 
 		$fqdn = $args[0];
 
-		$opts = wp_parse_args(
+		$assoc_args = wp_parse_args(
 			$assoc_args,
 			[
 				'disable' => false,
@@ -83,14 +83,12 @@ public function add( $args, $assoc_args ) {
 			]
 		);
 
-		$type = $this->check_type_opt( $opts['type'] );
+		$assoc_args['blog_id'] = get_current_blog_id();
+		$assoc_args['domain']  = $fqdn;
 
-		/**
-		 * Add the domain.
-		 */
-		$db     = Manager\Domain::instance();
-		$result = $db->add( $fqdn, $opts['primary'], $opts['https'], $opts['force'], ! $opts['disable'], $type );
+		$data = new DomainMapping();
 
+		$result = $data->add( $assoc_args, $assoc_args['force'] );
 		if ( is_wp_error( $result ) ) {
 			$error_msg = $result->get_error_message();
 
@@ -104,30 +102,6 @@ public function add( $args, $assoc_args ) {
 		WP_CLI::success( $fqdn . __( ': was added.', 'dark-matter' ) );
 	}
 
-	/**
-	 * Checks to ensure the value of type is valid and useable.
-	 *
-	 * @param string $type Type value to be checked.
-	 * @return integer Domain type.
-	 *
-	 * @since 2.2.0
-	 */
-	private function check_type_opt( $type = '' ) {
-		/**
-		 * Handle the Media flag.
-		 */
-		$domain_types = [
-			'main'  => DM_DOMAIN_TYPE_MAIN,
-			'media' => DM_DOMAIN_TYPE_MEDIA,
-		];
-
-		if ( array_key_exists( strtolower( $type ), $domain_types ) ) {
-			return $domain_types[ $type ];
-		}
-
-		return DM_DOMAIN_TYPE_MAIN;
-	}
-
 	/**
 	 * Include this CLI amongst the others.
 	 *
@@ -165,12 +139,14 @@ public static function define() {
 	 *
 	 *      wp darkmatter domain list
 	 *
+	 * @subcommand list
+	 *
 	 * @since 2.0.0
 	 *
 	 * @param array $args CLI args.
 	 * @param array $assoc_args CLI args maintaining the flag names from the terminal.
 	 */
-	public function list( $args, $assoc_args ) {
+	public function _list( $args, $assoc_args ) {
 		/**
 		 * Handle and validate the format flag if provided.
 		 */
@@ -187,8 +163,9 @@ public function list( $args, $assoc_args ) {
 		}
 
 		if ( $opts['primary'] ) {
-			$db      = Manager\Primary::instance();
-			$domains = $db->get_all();
+			$query_args = [
+				'is_primary' => true,
+			];
 		} else {
 			/**
 			 * Retrieve the current Blog ID. However this will be set to null if
@@ -200,10 +177,14 @@ public function list( $args, $assoc_args ) {
 				$site_id = null;
 			}
 
-			$db      = Manager\Domain::instance();
-			$domains = $db->get_domains( $site_id );
+			$query_args = [
+				'blog_site' => $site_id,
+				'number'    => 500, // Large number.
+			];
 		}
 
+		$query = new DomainQuery( $query_args );
+
 		/**
 		 * Filter out and format the columns and values appropriately.
 		 */
@@ -234,7 +215,7 @@ function ( $domain ) {
 
 				return $columns;
 			},
-			$domains
+			$query->records
 		);
 
 		/**
@@ -304,13 +285,15 @@ public function remove( $args, $assoc_args ) {
 			]
 		);
 
-		$db = Manager\Domain::instance();
+		$query = new DomainQuery();
+		$domain = $query->get_by_domain( $fqdn );
+		if ( ! $domain instanceof Domain ) {
+			WP_CLI::error( __( 'Domain cannot be found.', 'dark-matter' ) );
+		}
 
-		/**
-		 * Remove the domain.
-		 */
-		$result = $db->delete( $fqdn, $opts['force'] );
+		$data = new DomainMapping();
 
+		$result = $data->delete( $domain->id, $opts['force'] );
 		if ( is_wp_error( $result ) ) {
 			$error_msg = $result->get_error_message();
 
@@ -387,8 +370,12 @@ public function set( $args, $assoc_args ) {
 
 		$fqdn = $args[0];
 
-		$db            = Manager\Domain::instance();
-		$domain_before = $db->get( $fqdn );
+		$query = new DomainQuery();
+
+		$domain_before = $query->get_by_domain( $fqdn );
+		if ( ! $domain_before instanceof Domain ) {
+			WP_CLI::error( __( 'Domain cannot be found.', 'dark-matter' ) );
+		}
 
 		$opts = wp_parse_args(
 			$assoc_args,
@@ -400,6 +387,7 @@ public function set( $args, $assoc_args ) {
 				'use-https' => true,
 				'primary'   => null,
 				'secondary' => null,
+				'type'      => null,
 			]
 		);
 
@@ -449,22 +437,21 @@ public function set( $args, $assoc_args ) {
 			$active = false;
 		}
 
-		/**
-		 * If the type is specified, then validate it to ensure it is correct.
-		 */
-		$type = null;
-		if ( ! empty( $opts['type'] ) ) {
-			$type = $this->check_type_opt( $opts['type'] );
-		}
+		$type = $opts['type'];
 
-		/**
-		 * Update the records.
-		 */
-		$result = $db->update( $fqdn, $is_primary, $is_https, $opts['force'], $active, $type );
+		$data = new DomainMapping();
 
-		/**
-		 * Handle the output for errors and success.
-		 */
+		$result = $data->update(
+			[
+				'id'         => $domain_before->id,
+				'active'     => $active,
+				'domain'     => $fqdn,
+				'is_primary' => $is_primary,
+				'is_https'   => $is_https,
+				'type'       => $type,
+			],
+			$opts['force']
+		);
 		if ( is_wp_error( $result ) ) {
 			$error_msg = $result->get_error_message();
 

includes/classes/DomainMapping/CLI/Restricted.php

@@ -9,7 +9,8 @@
 
 namespace DarkMatter\DomainMapping\CLI;
 
-use \DarkMatter\DomainMapping\Manager;
+use DarkMatter\DomainMapping\Data\RestrictedDomain;
+use DarkMatter\DomainMapping\Data\RestrictedDomainQuery;
 use WP_CLI;
 use WP_CLI_Command;
 
@@ -46,14 +47,20 @@ public function add( $args, $assoc_args ) {
 
 		$fqdn = $args[0];
 
-		$restricted = Manager\Restricted::instance();
-		$result     = $restricted->add( $fqdn );
-
+		$data   = new RestrictedDomain();
+		$result = $data->add(
+			[
+				'domain' => $fqdn,
+			]
+		);
 		if ( is_wp_error( $result ) ) {
 			WP_CLI::error( $result->get_error_message() );
+		} elseif ( $result ) {
+			WP_CLI::success( $fqdn . __( ': is now restricted.', 'dark-matter' ) );
+			return;
 		}
 
-		WP_CLI::success( $fqdn . __( ': is now restricted.', 'dark-matter' ) );
+		WP_CLI::error( __( 'An unknown error has occurred.', 'dark-matter' ) );
 	}
 
 	/**
@@ -88,12 +95,14 @@ public static function define() {
 	 *
 	 *      wp darkmatter restrict list --format=ids
 	 *
+	 * @subcommand list
+	 *
 	 * @since 2.0.0
 	 *
 	 * @param array $args CLI args.
 	 * @param array $assoc_args CLI args maintaining the flag names from the terminal.
 	 */
-	public function list( $args, $assoc_args ) {
+	public function _list( $args, $assoc_args ) {
 		/**
 		 * Handle and validate the format flag if provided.
 		 */
@@ -108,21 +117,23 @@ public function list( $args, $assoc_args ) {
 			$opts['format'] = 'table';
 		}
 
-		$db = Manager\Restricted::instance();
-
-		$restricted = $db->get();
+		$query = new RestrictedDomainQuery(
+			[
+				'number' => 100,
+			]
+		);
 
 		/**
 		 * Only format the return array if "ids" is not specified.
 		 */
 		if ( 'ids' !== $opts['format'] ) {
 			$restricted = array_map(
-				function ( $domain ) {
+				function ( $restricted_domain ) {
 					return array(
-						'F.Q.D.N.' => $domain,
+						'F.Q.D.N.' => $restricted_domain,
 					);
 				},
-				$restricted
+				$query->records
 			);
 		}
 
@@ -160,13 +171,28 @@ public function remove( $args, $assoc_args ) {
 
 		$fqdn = $args[0];
 
-		$restricted = Manager\Restricted::instance();
-		$result     = $restricted->delete( $fqdn );
+		$query     = new RestrictedDomainQuery();
+		$domain_id = $query->get_id_by_domain( $fqdn );
+		if ( empty( $domain_id ) ) {
+			WP_CLI::error(
+				sprintf(
+					/* translators: %s: restricted domain that cannot be found. */
+					__( 'Cannot find domain: %s', 'dark-matter' ),
+					$fqdn
+				)
+			);
+		}
+
+		$data   = new RestrictedDomain();
+		$result = $data->delete( $domain_id );
 
 		if ( is_wp_error( $result ) ) {
 			WP_CLI::error( $result->get_error_message() );
+		} elseif ( $result ) {
+			WP_CLI::success( $fqdn . __( ': is no longer restricted.', 'dark-matter' ) );
+			return;
 		}
 
-		WP_CLI::success( $fqdn . __( ': is no longer restricted.', 'dark-matter' ) );
+		WP_CLI::error( __( 'An unknown error has occurred.', 'dark-matter' ) );
 	}
 }