Merge pull request #603 from ProgressPlanner/ari/phpstan-level-9

PHPStan: Increase checks to level 9

Author: aristath

classes/actions/class-content.php

@@ -207,10 +207,7 @@ private function is_there_recent_activity( $post, $type ) {
 		}
 
 		// Check if there is an activity for this post.
-		$existing = \progress_planner()->get_activities__query()->query_activities(
-			$query_args,
-			'RAW'
-		);
+		$existing = \progress_planner()->get_activities__query()->query_activities_get_raw( $query_args );
 
 		// If there is an activity for this post, bail.
 		return ! empty( $existing ) ? true : false;
@@ -228,13 +225,12 @@ private function add_post_activity( $post, $type ) {
 		// Post was updated to publish for the first time, ie draft was published.
 		if ( 'update' === $type && 'publish' === $post->post_status ) {
 			// Check if there is a publish activity for this post.
-			$existing = \progress_planner()->get_activities__query()->query_activities(
+			$existing = \progress_planner()->get_activities__query()->query_activities_get_raw(
 				[
 					'category' => 'content',
 					'type'     => 'publish',
 					'data_id'  => (string) $post->ID,
-				],
-				'RAW'
+				]
 			);
 
 			// If there is no publish activity for this post, add it.
@@ -247,14 +243,13 @@ private function add_post_activity( $post, $type ) {
 		// Post was updated, but it was published previously.
 		if ( 'update' === $type ) {
 			// Check if there are any activities for this post, on this date.
-			$existing = \progress_planner()->get_activities__query()->query_activities(
+			$existing = \progress_planner()->get_activities__query()->query_activities_get_raw(
 				[
 					'category'   => 'content',
 					'data_id'    => (string) $post->ID,
 					'start_date' => \progress_planner()->get_utils__date()->get_datetime_from_mysql_date( $post->post_modified )->modify( '-12 hours' ),
 					'end_date'   => \progress_planner()->get_utils__date()->get_datetime_from_mysql_date( $post->post_modified )->modify( '+12 hours' ),
-				],
-				'RAW'
+				]
 			);
 
 			// If there are activities for this post, on this date, bail.
@@ -268,13 +263,12 @@ private function add_post_activity( $post, $type ) {
 		// Update the badges.
 		if ( 'publish' === $type ) {
 			// Check if there is a publish activity for this post.
-			$existing = \progress_planner()->get_activities__query()->query_activities(
+			$existing = \progress_planner()->get_activities__query()->query_activities_get_raw(
 				[
 					'category' => 'content',
 					'type'     => 'publish',
 					'data_id'  => (string) $post->ID,
-				],
-				'RAW'
+				]
 			);
 
 			// If there is no publish activity for this post, add it.

classes/activities/class-activity.php

@@ -76,16 +76,15 @@ class Activity {
 	 * @return void
 	 */
 	public function save() {
-		$existing = \progress_planner()->get_activities__query()->query_activities(
+		$existing = \progress_planner()->get_activities__query()->query_activities_get_raw(
 			[
 				'category' => $this->category,
 				'type'     => $this->type,
 				'data_id'  => (string) $this->data_id,
-			],
-			'RAW'
+			]
 		);
 		if ( ! empty( $existing ) ) {
-			\progress_planner()->get_activities__query()->update_activity( $existing[0]->id, $this );
+			\progress_planner()->get_activities__query()->update_activity( $existing[0]->id, $this ); // @phpstan-ignore-line property.nonObject
 			return;
 		}
 		\progress_planner()->get_activities__query()->insert_activity( $this );

classes/activities/class-maintenance.php

@@ -44,17 +44,16 @@ public function save() {
 		$this->date    = new \DateTime();
 		$this->user_id = \get_current_user_id();
 
-		$existing = \progress_planner()->get_activities__query()->query_activities(
+		$existing = \progress_planner()->get_activities__query()->query_activities_get_raw(
 			[
 				'category'   => $this->category,
 				'type'       => $this->type,
 				'data_id'    => $this->data_id,
 				'start_date' => $this->date,
-			],
-			'RAW'
+			]
 		);
 		if ( ! empty( $existing ) ) {
-			\progress_planner()->get_activities__query()->update_activity( $existing[0]->id, $this );
+			\progress_planner()->get_activities__query()->update_activity( $existing[0]->id, $this ); // @phpstan-ignore-line property.nonObject
 			return;
 		}
 		\progress_planner()->get_activities__query()->insert_activity( $this );

classes/activities/class-query.php

@@ -55,7 +55,7 @@ public function create_tables() {
 	private function create_activities_table() {
 		global $wpdb;
 
-		$table_name      = $wpdb->prefix . static::TABLE_NAME;
+		$table_name      = $wpdb->prefix . static::TABLE_NAME; // @phpstan-ignore-line property.nonObject
 		$charset_collate = $wpdb->get_charset_collate();
 
 		/**
@@ -84,12 +84,22 @@ private function create_activities_table() {
 	/**
 	 * Query the database for activities.
 	 *
-	 * @param array  $args        The arguments for the query.
-	 * @param string $return_type The type of the return value. Can be "RAW" or "ACTIVITIES".
+	 * @param array $args The arguments for the query.
+	 *
+	 * @return \Progress_Planner\Activities\Activity[] The activities.
+	 */
+	public function query_activities( $args ) {
+		return $this->get_activities_from_results( $this->query_activities_get_raw( $args ) );
+	}
+
+	/**
+	 * Query the database for activities.
+	 *
+	 * @param array $args        The arguments for the query.
 	 *
 	 * @return array The activities.
 	 */
-	public function query_activities( $args, $return_type = 'ACTIVITIES' ) {
+	public function query_activities_get_raw( $args ) {
 		global $wpdb;
 
 		$defaults = [
@@ -147,7 +157,7 @@ public function query_activities( $args, $return_type = 'ACTIVITIES' ) {
 			$results = ( empty( $where_args ) )
 				// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery
 				? $wpdb->get_results(
-					$wpdb->prepare( 'SELECT * FROM %i ORDER BY date', $wpdb->prefix . static::TABLE_NAME )
+					$wpdb->prepare( 'SELECT * FROM %i ORDER BY date', $wpdb->prefix . static::TABLE_NAME ) // @phpstan-ignore-line property.nonObject
 				)
 				// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery
 				: $wpdb->get_results(
@@ -158,7 +168,7 @@ public function query_activities( $args, $return_type = 'ACTIVITIES' ) {
 							\implode( ' AND ', $where_args )
 						),
 						\array_merge(
-							[ $wpdb->prefix . static::TABLE_NAME ],
+							[ $wpdb->prefix . static::TABLE_NAME ], // @phpstan-ignore-line property.nonObject
 							$prepare_args
 						)
 					)
@@ -174,19 +184,15 @@ public function query_activities( $args, $return_type = 'ACTIVITIES' ) {
 		// Remove duplicates. This could be removed in a future release.
 		$results_unique = [];
 		foreach ( $results as $key => $result ) {
-			$result_key = $result->category . $result->type . $result->data_id . $result->date;
+			$result_key = $result->category . $result->type . $result->data_id . $result->date; // @phpstan-ignore-line property.nonObject
 			// Cleanup any duplicates that may exist.
 			if ( isset( $results_unique[ $result_key ] ) ) {
-				$this->delete_activity_by_id( $result->id );
+				$this->delete_activity_by_id( $result->id ); // @phpstan-ignore-line property.nonObject
 				continue;
 			}
-			$results_unique[ $result->category . $result->type . $result->data_id . $result->date ] = $result;
+			$results_unique[ $result->category . $result->type . $result->data_id . $result->date ] = $result; // @phpstan-ignore-line property.nonObject
 		}
-		$results = \array_values( $results_unique );
-
-		return 'RAW' === $return_type
-			? $results
-			: $this->get_activities_from_results( $results );
+		return \array_values( $results_unique );
 	}
 
 	/**
@@ -223,7 +229,7 @@ public function insert_activity( $activity ) {
 
 		// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery
 		$result = $wpdb->insert(
-			$wpdb->prefix . static::TABLE_NAME,
+			$wpdb->prefix . static::TABLE_NAME, // @phpstan-ignore-line property.nonObject
 			[
 				'date'     => $activity->date ? $activity->date->format( 'Y-m-d H:i:s' ) : ( new \DateTime() )->format( 'Y-m-d H:i:s' ),
 				'category' => $activity->category,
@@ -246,7 +252,7 @@ public function insert_activity( $activity ) {
 
 		\wp_cache_flush_group( static::CACHE_GROUP );
 
-		return (int) $wpdb->insert_id;
+		return (int) $wpdb->insert_id; // @phpstan-ignore-line property.nonObject
 	}
 
 	/**
@@ -259,7 +265,7 @@ public function insert_activity( $activity ) {
 	private function get_activities_from_results( $results ) {
 		$activities = [];
 		foreach ( $results as $result ) {
-			$class_name         = $this->get_activity_class_name( $result->category );
+			$class_name         = $this->get_activity_class_name( $result->category ); // @phpstan-ignore-line property.nonObject
 			$activity           = new $class_name();
 			$activity->date     = new \DateTime( $result->date ); // @phpstan-ignore-line property.notFound
 			$activity->category = $result->category; // @phpstan-ignore-line property.notFound
@@ -286,7 +292,7 @@ public function update_activity( $id, $activity ) {
 
 		// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery
 		$wpdb->update(
-			$wpdb->prefix . static::TABLE_NAME,
+			$wpdb->prefix . static::TABLE_NAME, // @phpstan-ignore-line property.nonObject
 			[
 				'date'     => $activity->date ? $activity->date->format( 'Y-m-d H:i:s' ) : ( new \DateTime() )->format( 'Y-m-d H:i:s' ),
 				'category' => $activity->category,
@@ -344,7 +350,7 @@ public function delete_activity_by_id( $id ) {
 
 		// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery
 		$wpdb->delete(
-			$wpdb->prefix . static::TABLE_NAME,
+			$wpdb->prefix . static::TABLE_NAME, // @phpstan-ignore-line property.nonObject
 			[ 'id' => $id ],
 			[ '%d' ]
 		);
@@ -364,7 +370,7 @@ public function delete_category_activities( $category ) {
 
 		// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery
 		$wpdb->delete(
-			$wpdb->prefix . static::TABLE_NAME,
+			$wpdb->prefix . static::TABLE_NAME, // @phpstan-ignore-line property.nonObject
 			[ 'category' => $category ],
 			[ '%s' ]
 		);
@@ -386,7 +392,7 @@ public function get_latest_activities( $limit = 5 ) {
 		$results = $wpdb->get_results(
 			$wpdb->prepare(
 				'SELECT * FROM %i ORDER BY date DESC LIMIT %d',
-				$wpdb->prefix . static::TABLE_NAME,
+				$wpdb->prefix . static::TABLE_NAME, // @phpstan-ignore-line property.nonObject
 				$limit
 			)
 		);
@@ -410,15 +416,15 @@ public function get_oldest_activity() {
 		$result = $wpdb->get_row(
 			$wpdb->prepare(
 				'SELECT * FROM %i ORDER BY date ASC LIMIT 1',
-				$wpdb->prefix . static::TABLE_NAME
+				$wpdb->prefix . static::TABLE_NAME // @phpstan-ignore-line property.nonObject
 			)
 		);
 
 		if ( ! $result ) {
 			return null;
 		}
 
-		$class_name         = $this->get_activity_class_name( $result->category );
+		$class_name         = $this->get_activity_class_name( $result->category ); // @phpstan-ignore-line property.nonObject
 		$activity           = new $class_name();
 		$activity->date     = new \DateTime( $result->date ); // @phpstan-ignore-line property.notFound
 		$activity->category = $result->category; // @phpstan-ignore-line property.notFound
@@ -488,10 +494,10 @@ private function maybe_upgrade() {
 	private function upgrade_20241011() {
 		global $wpdb;
 
-		$table_name = $wpdb->prefix . static::TABLE_NAME;
+		$table_name = $wpdb->prefix . static::TABLE_NAME; // @phpstan-ignore-line property.nonObject
 
 		foreach ( $wpdb->get_results( "DESCRIBE $table_name" ) as $column ) {
-			if ( 'data_id' === $column->Field && \str_contains( \strtolower( $column->Type ), 'int' ) ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+			if ( 'data_id' === $column->Field && \str_contains( \strtolower( $column->Type ), 'int' ) ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase, @phpstan-ignore-line property.nonObject
 				$wpdb->query( "ALTER TABLE $table_name CHANGE COLUMN data_id data_id VARCHAR(255)" );
 			}
 		}

classes/admin/class-page.php

@@ -63,7 +63,7 @@ public function get_widgets() {
 		 *
 		 * @return array<\Progress_Planner\Admin\Widgets\Widget>
 		 */
-		return \apply_filters( 'progress_planner_admin_widgets', $widgets );
+		return \apply_filters( 'progress_planner_admin_widgets', $widgets ); // @phpstan-ignore-line parameter.phpDocType
 	}
 
 	/**

classes/admin/widgets/class-activity-scores.php

@@ -70,11 +70,8 @@ public function get_color( $number, $date ) {
 	 */
 	public function get_score() {
 		$activities = \progress_planner()->get_activities__query()->query_activities(
-			[
-				// Use 31 days to take into account
-				// the activities score decay from previous activities.
-				'start_date' => new \DateTime( '-31 days' ),
-			]
+			// Use 31 days to take into account the activities score decay from previous activities.
+			[ 'start_date' => new \DateTime( '-31 days' ) ]
 		);
 
 		$score        = 0;

classes/class-badges.php

@@ -117,8 +117,7 @@ public function clear_monthly_progress( $activity_id ) {
 				'category' => 'suggested_task',
 				'type'     => 'completed',
 				'data_id'  => (string) $activity_id,
-			],
-			'ACTIVITIES'
+			]
 		);
 
 		if ( empty( $activities ) ) {

classes/class-base.php

@@ -43,6 +43,18 @@
  * @method \Progress_Planner\Plugin_Installer get_plugin_installer()
  * @method \Progress_Planner\Admin\Widgets\Badge_Streak_Content get_admin__widgets__badge_streak_content()
  * @method \Progress_Planner\Admin\Widgets\Badge_Streak_Maintenance get_admin__widgets__badge_streak_maintenance()
+ * @method \Progress_Planner\Admin\Enqueue get_admin__enqueue()
+ * @method \Progress_Planner\Admin\Widgets\Whats_New get_admin__widgets__whats_new()
+ * @method \Progress_Planner\Admin\Widgets\ToDo get_admin__widgets__todo()
+ * @method \Progress_Planner\Admin\Widgets\Monthly_Badges get_admin__widgets__monthly_badges()
+ * @method \Progress_Planner\UI\Popover get_ui__popover()
+ * @method \Progress_Planner\Admin\Widgets\Latest_Badge get_admin__widgets__latest_badge()
+ * @method \Progress_Planner\Admin\Widgets\Content_Activity get_admin__widgets__content_activity()
+ * @method \Progress_Planner\UI\Chart get_ui__chart()
+ * @method \Progress_Planner\Activities\Content_Helpers get_activities__content_helpers()
+ * @method \Progress_Planner\Admin\Widgets\Challenge get_admin__widgets__challenge()
+ * @method \Progress_Planner\Admin\Widgets\Activity_Scores get_admin__widgets__activity_scores()
+ * @method \Progress_Planner\Utils\Date get_utils__date()
  */
 class Base {
 

classes/class-page-types.php

@@ -520,13 +520,13 @@ private function get_posts_by_title( $title ) {
 		// Cache the query.
 		$posts     = $wpdb->get_results( // phpcs:ignore WordPress.DB.DirectDatabaseQuery
 			$wpdb->prepare(
-				"SELECT ID FROM $wpdb->posts WHERE post_type = 'page' AND post_status != 'trash' AND post_title LIKE %s",
+				"SELECT ID FROM $wpdb->posts WHERE post_type = 'page' AND post_status != 'trash' AND post_title LIKE %s", // @phpstan-ignore-line property.nonObject
 				'%' . $wpdb->esc_like( $title ) . '%'
 			)
 		);
 		$posts_ids = [];
 		foreach ( $posts as $post ) {
-			$posts_ids[] = (int) $post->ID;
+			$posts_ids[] = (int) $post->ID; // @phpstan-ignore-line property.nonObject
 		}
 		\wp_cache_set( $cache_key, $posts_ids, $cache_group );
 		return $posts_ids;

classes/class-suggested-tasks-db.php

@@ -203,7 +203,7 @@ public function update_recommendation( $id, $data ) {
 
 		if ( ! empty( $update_terms ) ) {
 			foreach ( $update_terms as $taxonomy => $term ) {
-				$update_results[] = (bool) \wp_set_object_terms( $id, $term->slug, $taxonomy );
+				$update_results[] = (bool) \wp_set_object_terms( $id, $term->slug, $taxonomy ); // @phpstan-ignore-line property.nonObject
 			}
 		}