Add more throws and generics

Author: defunctl

src/Schema/Activation.php

@@ -32,6 +32,8 @@ class Activation {
 	 * Handles the activation of the feature functions.
 	 *
 	 * @since 1.0.0
+	 *
+	 * @throws \StellarWP\DB\Database\Exceptions\DatabaseQueryException If the query fails.
 	 */
 	public static function activate() {
 		$schema_builder = Config::get_container()->get( Builder::class);
@@ -44,6 +46,8 @@ public static function activate() {
 	 * This method will run once a day (using transients).
 	 *
 	 * @since 1.0.0
+	 *
+	 * @throws \StellarWP\DB\Database\Exceptions\DatabaseQueryException If the query fails.
 	 */
 	public static function init() {
 		// Check if we ran recently.

src/Schema/Builder.php

@@ -21,14 +21,14 @@ class Builder {
 	/**
 	 * StellarWP\DB class.
 	 *
-	 * @var string
+	 * @var class-string<\StellarWP\DB\DB>
 	 */
 	protected $db;
 
 	/**
 	 * Constructor.
 	 *
-	 * @param string|null $db StellarWP\DB class.
+	 * @param class-string<\StellarWP\DB\DB>|null $db StellarWP\DB class.
 	 * @param object $container Container instance.
 	 */
 	public function __construct( $db = null, $container = null ) {
@@ -43,6 +43,8 @@ public function __construct( $db = null, $container = null ) {
 	 *
 	 * @since 1.0.0
 	 *
+	 * @throws \StellarWP\DB\Database\Exceptions\DatabaseQueryException If the query fails.
+	 *
 	 * @param string|null $group An optional group name to restrict the check to.
 	 *
 	 * @return bool Whether all custom tables exist or not. Does not check custom fields.
@@ -74,6 +76,8 @@ public function all_tables_exist( $group = null ) {
 	 * Trigger actions to drop the custom tables.
 	 *
 	 * @since 1.0.0
+	 *
+	 * @throws \StellarWP\DB\Database\Exceptions\DatabaseQueryException If the query fails.
 	 */
 	public function down() {
 		/**
@@ -254,6 +258,8 @@ public function register_custom_tables_names() {
 	 *
 	 * @param bool $force Whether to force the creation or update of the tables or not.
 	 *
+	 * @throws \StellarWP\DB\Database\Exceptions\DatabaseQueryException If the query fails.
+	 *
 	 * @return array<mixed> A list of each creation or update result.
 	 */
 	public function up( $force = false ) {
@@ -286,6 +292,8 @@ public function up( $force = false ) {
 	 *
 	 * @since 1.0.0
 	 *
+	 * @throws \StellarWP\DB\Database\Exceptions\DatabaseQueryException If the query fails.
+	 *
 	 * @return array<mixed> A list of each creation or update result.
 	 */
 	public function update_blog_tables() {

src/Schema/Config.php

@@ -15,7 +15,7 @@ class Config {
 	/**
 	 * StellarWP\DB class.
 	 *
-	 * @var string
+	 * @var class-string<\StellarWP\DB\DB>
 	 */
 	private static $db_class;
 
@@ -35,7 +35,7 @@ public static function get_container() : ContainerInterface {
 	/**
 	 * Get the StellarWP\DB class.
 	 *
-	 * @return string
+	 * @return class-string<\StellarWP\DB\DB>
 	 */
 	public static function get_db() : string {
 		if ( self::$db_class === null ) {
@@ -75,7 +75,7 @@ public static function set_container( ContainerInterface $container ) {
 	/**
 	 * Set the StellarWP\DB class.
 	 *
-	 * @param string $db_class StellarWP\DB class.
+	 * @param class-string<\StellarWP\DB\DB> $db_class StellarWP\DB class.
 	 */
 	public static function set_db( string $db_class ) {
 		self::$db_class = $db_class;

src/Schema/Fields/Contracts/Field.php

@@ -20,6 +20,7 @@
  * @package StellarWP\Schema\Fields\Contracts
  */
 abstract class Field implements Schema_Interface {
+
 	/**
 	 * @since 1.0.0
 	 *
@@ -40,7 +41,7 @@ abstract class Field implements Schema_Interface {
 	protected $container;
 
 	/**
-	 * @var string The db class.
+	 * @var class-string<\StellarWP\DB\DB> The db class.
 	 */
 	protected $db;
 
@@ -68,7 +69,7 @@ abstract class Field implements Schema_Interface {
 	 *
 	 * @since 1.0.0
 	 *
-	 * @param string $db StellarWP\DB object.
+	 * @param class-string<\StellarWP\DB\DB>|null $db StellarWP\DB object.
 	 * @param object $container The container to use.
 	 */
 	public function __construct( $db = null, $container = null ) {
@@ -178,10 +179,11 @@ public function drop() {
 	 *
 	 * @since 1.0.0
 	 *
+	 * @throws \StellarWP\DB\Database\Exceptions\DatabaseQueryException If the query fails.
+	 *
 	 * @return bool Whether a set of fields exists in the database or not.
 	 */
 	public function exists() {
-		global $wpdb;
 		$table_schema = $this->table_schema();
 
 		if ( $table_schema === null ) {

src/Schema/Fields/Contracts/Schema_Interface.php

@@ -37,6 +37,8 @@ public function after_update( array $results );
 	 *
 	 * @since 1.0.0
 	 *
+	 * @throws \StellarWP\DB\Database\Exceptions\DatabaseQueryException If the query fails.
+	 *
 	 * @return bool `true` if successful operation, `false` to indicate a failure.
 	 */
 	public function drop();

src/Schema/Register.php

@@ -11,13 +11,16 @@
  * A helper class for registering StellarWP Schema resources.
  */
 class Register {
+
 	/**
 	 * Register a field schema.
 	 *
 	 * @since 1.0.0
 	 *
 	 * @param string|Fields\Contracts\Field $field Field class.
 	 *
+	 * @throws \StellarWP\DB\Database\Exceptions\DatabaseQueryException If the query fails.
+	 *
 	 * @return Fields\Contracts\Schema_Interface
 	 */
 	public static function field( $field ) {
@@ -46,6 +49,8 @@ public static function field( $field ) {
 	 *
 	 * @param array<mixed> $fields Fields to register.
 	 *
+	 * @throws \StellarWP\DB\Database\Exceptions\DatabaseQueryException If the query fails.
+	 *
 	 * @return Fields\Collection
 	 */
 	public static function fields( array $fields ) {
@@ -63,6 +68,8 @@ public static function fields( array $fields ) {
 	 *
 	 * @param string|Fields\Contracts\Schema_Interface $field Field Schema class.
 	 *
+	 * @throws \StellarWP\DB\Database\Exceptions\DatabaseQueryException If the query fails.
+	 *
 	 * @return Fields\Contracts\Schema_Interface
 	 */
 	public static function remove_field( $field ) {
@@ -89,6 +96,8 @@ public static function remove_field( $field ) {
 	 *
 	 * @param string|Tables\Contracts\Schema_Interface $table Table Schema class.
 	 *
+	 * @throws \StellarWP\DB\Database\Exceptions\DatabaseQueryException If the query fails.
+	 *
 	 * @return Tables\Contracts\Schema_Interface
 	 */
 	public static function remove_table( $table ) {
@@ -115,6 +124,8 @@ public static function remove_table( $table ) {
 	 *
 	 * @param string|Tables\Contracts\Table $table Table class.
 	 *
+	 * @throws \StellarWP\DB\Database\Exceptions\DatabaseQueryException If the query fails.
+	 *
 	 * @return Tables\Contracts\Schema_Interface
 	 */
 	public static function table( $table ) {
@@ -143,6 +154,8 @@ public static function table( $table ) {
 	 *
 	 * @param array<mixed> $tables Tables to register.
 	 *
+	 * @throws \StellarWP\DB\Database\Exceptions\DatabaseQueryException If the query fails.
+	 *
 	 * @return Tables\Collection
 	 */
 	public static function tables( array $tables ) {

src/Schema/Tables/Contracts/Table.php

@@ -63,7 +63,7 @@ abstract class Table implements Schema_Interface {
 	 *
 	 * @since 1.0.0
 	 *
-	 * @param class-string<\StellarWP\DB\DB> $db StellarWP\DB object.
+	 * @param class-string<\StellarWP\DB\DB>|null $db StellarWP\DB object.
 	 * @param object $container The container to use.
 	 */
 	public function __construct( $db = null, $container = null ) {