class-data-collector-manager.php

<?php
/**
 * Data collector manager.
 *
 * @package Progress_Planner
 */

namespace Progress_Planner\Suggested_Tasks\Data_Collector;

use Progress_Planner\Suggested_Tasks\Data_Collector\Yoast_Orphaned_Content;
use Progress_Planner\Suggested_Tasks\Data_Collector\Unpublished_Content;
use Progress_Planner\Suggested_Tasks\Data_Collector\SEO_Plugin;

/**
 * Manages the collection and initialization of data collectors.
 */
class Data_Collector_Manager {

	/**
	 * The data collectors.
	 *
	 * @var array<Base_Data_Collector>
	 */
	protected array $data_collectors = [];

	/**
	 * Files to exclude from automatic loading.
	 *
	 * @var array<string>
	 */
	protected const EXCLUDED_FILES = [
		'class-data-collector-manager.php',
		'class-base-data-collector.php',
	];

	/**
	 * Constructor.
	 */
	public function __construct() {
		$this->load_data_collectors();
		$this->add_plugin_integration();

		// At all all CPTs and taxonomies are initialized, init the data collectors.
		\add_action( 'init', [ $this, 'init' ], 99 ); // Wait for the post types to be initialized.

		// Update the cache once per day.
		\add_action( 'admin_init', [ $this, 'update_data_collectors_cache' ] );
	}

	/**
	 * Load all data collectors from the directory.
	 *
	 * @return void
	 */
	protected function load_data_collectors() {
		$files = \glob( __DIR__ . '/*.php' );

		if ( ! $files ) {
			return;
		}

		foreach ( $files as $file ) {
			if ( $this->should_skip_file( $file ) ) {
				continue;
			}

			$class_name = $this->get_class_name_from_file( $file );
			$collector  = new $class_name();

			if ( ! $collector instanceof Base_Data_Collector ) {
				continue;
			}

			$this->data_collectors[] = $collector;
		}
	}

	/**
	 * Add plugin integration.
	 *
	 * @return void
	 */
	public function add_plugin_integration() {
		// Yoast SEO integration.
		if ( \function_exists( 'YoastSEO' ) ) {
			$this->data_collectors[] = new Yoast_Orphaned_Content();
		}
	}

	/**
	 * Check if a file should be skipped during loading.
	 *
	 * @param string $file_path The full path to the file.
	 * @return bool
	 */
	protected function should_skip_file( string $file_path ) {
		return in_array( \basename( $file_path ), self::EXCLUDED_FILES, true );
	}

	/**
	 * Convert a file path to its corresponding class name.
	 *
	 * @param string $file_path The full path to the file.
	 * @return string The fully qualified class name.
	 */
	protected function get_class_name_from_file( string $file_path ) {
		$class_name = \basename( $file_path );
		$class_name = \str_replace( [ 'class-', '.php' ], '', $class_name );
		$class_name = implode( '_', array_map( 'ucfirst', explode( '-', $class_name ) ) );

		return '\\Progress_Planner\\Suggested_Tasks\\Data_Collector\\' . $class_name;
	}

	/**
	 * Initialize all loaded data collectors.
	 *
	 * @return void
	 */
	public function init() {
		/**
		 * Filter the data collectors.
		 *
		 * @param array $data_collectors The data collectors.
		 */
		$this->data_collectors = \apply_filters( 'progress_planner_data_collectors', $this->data_collectors );

		// Initialize (add hooks) the data collectors.
		foreach ( $this->data_collectors as $data_collector ) {
			$data_collector->init();
		}
	}

	/**
	 * Update the data collectors cache once per day.
	 *
	 * @return void
	 */
	public function update_data_collectors_cache() {
		if ( \progress_planner()->get_utils__cache()->get( 'update_data_collectors_cache' ) ) {
			return;
		}

		foreach ( $this->data_collectors as $collector ) {
			$collector->update_cache();
		}

		\progress_planner()->get_utils__cache()->set( 'update_data_collectors_cache', true, DAY_IN_SECONDS );
	}
}