BulkWP\BulkDelete\Core\Addon\FeatureAddon

Complexity

Total Complexity

8

Size/Duplication

Total Lines	83
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	register_pages()	0	24	2
A	register()	0	11	4
A	register_modules_in_page()	0	5	2

<?php

namespace BulkWP\BulkDelete\Core\Addon;

use BulkWP\BulkDelete\Core\Base\BasePage;

defined( 'ABSPATH' ) || exit; // Exit if accessed directly.

/**
 * A Feature Add-on.
 *
 * All Feature Add-ons will extend this class.
 * A Feature Add-on contains a bunch of modules and may also have Schedulers.
 *
 * @since 6.0.0
 */
abstract class FeatureAddon extends BaseAddon {
	/**
	 * List of pages that are registered by this add-on.
	 *
	 * @var \BulkWP\BulkDelete\Core\Base\BaseDeletePage[]
	 */
	protected $pages = array();

	/**
	 * List of modules that are registered by this add-on.
	 *
	 * This is an associate array, where the key is the item type and value is the array of modules.
	 * Eg: $modules['item_type'] = array( $module1, $module2 );
	 *
	 * @var array
	 */
	protected $modules = array();

	/**
	 * List of schedulers that are registered by this add-on.
	 *
	 * @var \BulkWP\BulkDelete\Core\Base\BaseScheduler[]
	 */
	protected $schedulers = array();

	// phpcs:ignore Squiz.Commenting.FunctionComment.Missing
	public function register() {
		if ( ! empty( $this->pages ) ) {
			add_filter( 'bd_primary_pages', array( $this, 'register_pages' ) );
		}

		foreach ( array_keys( $this->modules ) as $item_type ) {
			add_action( "bd_after_{$item_type}_modules", array( $this, 'register_modules_in_page' ) );
		}

		foreach ( $this->schedulers as $scheduler ) {
			$scheduler->register();
		}
	}

	/**
	 * Register pages.
	 *
	 * @param \BulkWP\BulkDelete\Core\Base\BaseDeletePage[] $primary_pages List of registered Primary pages.
	 *
	 * @return \BulkWP\BulkDelete\Core\Base\BaseDeletePage[] Modified list of primary pages.
	 */
	public function register_pages( $primary_pages ) {
		foreach ( $this->pages as $page ) {
			/**
			 * After the modules are registered in the delete posts page.
			 *
			 * @since 6.0.0
			 *
			 * @param \BulkWP\BulkDelete\Core\Base\BaseDeletePage $page The page in which the modules are registered.
			 */
			do_action( "bd_after_{$page->get_item_type()}_modules", $page );

			/**
			 * After the modules are registered in a delete page.
			 *
			 * @since 6.0.0
			 *
			 * @param BasePage $posts_page The page in which the modules are registered.
			 */
			do_action( 'bd_after_modules', $page );

			$primary_pages[ $page->get_page_slug() ] = $page;
		}

		return $primary_pages;
	}

	/**
	 * Register modules for a page.
	 *
	 * @param \BulkWP\BulkDelete\Core\Base\BaseDeletePage $page Page.
	 */
	public function register_modules_in_page( $page ) {
		$modules = $this->modules[ $page->get_item_type() ];

		foreach ( $modules as $module ) {
			$page->add_module( $module );
		}
	}
}