<?php
/**
 * What a compatibility pack provides: fixes for one theme or plugin whose markup
 * Fixlight knows (Divi, Extra, Bloom, Monarch).
 *
 * A pack never runs unless its product is active. It tells the analyzer which
 * elements to record and which text the product hides with its own CSS, then
 * plans fixes on the recorded elements through Compat_Plan.
 *
 * @package Fixlight
 */

namespace Fixlight;

defined( 'ABSPATH' ) || exit;

/**
 * Compatibility pack.
 */
interface Compat_Pack {

	/**
	 * Whether the product is active on this site.
	 *
	 * @return bool
	 */
	public static function active();

	/**
	 * Whether the analyzer should record this element (with all its attributes)
	 * for plan() and problems(). Called for every opening tag, so keep it cheap.
	 *
	 * @param string $tag        Upper-case tag name.
	 * @param string $class_attr Class attribute ('' when none).
	 * @param string $id         Id attribute ('' when none).
	 * @return bool
	 */
	public static function watches( $tag, $class_attr, $id );

	/**
	 * Whether the product's CSS hides this element's content (display:none), so
	 * its text must not count as an accessible name.
	 *
	 * @param string $tag        Upper-case tag name.
	 * @param string $class_attr Class attribute.
	 * @param string $id         Id attribute.
	 * @param array  $parent_tag Parent element: tag, class, id.
	 * @return bool
	 */
	public static function hides_text( $tag, $class_attr, $id, array $parent_tag );

	/**
	 * Plans fixes for the recorded elements.
	 *
	 * @param array       $doc  Analysis result.
	 * @param Compat_Plan $plan Where fixes are added.
	 */
	public static function plan( array $doc, Compat_Plan $plan );

	/**
	 * Problems this pack can see in a page, for the server-side check.
	 *
	 * @param array $doc Analysis result.
	 * @return array<string,string[]> Rule id => one sample per occurrence.
	 */
	public static function problems( array $doc );

	/**
	 * CSS the pack's fixes need on live pages.
	 *
	 * @return string
	 */
	public static function css();
}