<?php
/**
 * User events module admin schema.
 *
 * @package GTM4WP
 * @author Thomas Geiger
 * @copyright 2013- Geiger Tamás e.v. (Thomas Geiger s.e.)
 * @license GNU General Public License, version 3
 */

namespace GTM4WP\Modules\UserEvents;

use GTM4WP\Module\AdminSchemaInterface;
use GTM4WP\Module\DocumentedSchemaInterface;
use GTM4WP\Options\Field;

defined( 'ABSPATH' ) || exit;

/**
 * Field definitions of the user events module, ported from the 1.x Events tab.
 */
final class AdminSchema implements AdminSchemaInterface, DocumentedSchemaInterface {

	/**
	 * Documentation page of this module on gtm4wp.com. One page covers all four
	 * options, so every field deep links into it by its own option key.
	 */
	private const DOC_PAGE = 'setup-gtm4wp-features/how-to-track-user-logins-registrations-and-form-interactions';

	/**
	 * Module documentation page.
	 *
	 * @return string
	 */
	public function doc_url(): string {
		return self::DOC_PAGE;
	}

	/**
	 * Module title.
	 *
	 * @return string
	 */
	public function title(): string {
		return __( 'User events', 'duracelltomi-google-tag-manager' );
	}

	/**
	 * Module panel introduction.
	 *
	 * @return string
	 */
	public function intro(): string {
		return esc_html__( 'Fire tags in Google Tag Manager on special events on your website', 'duracelltomi-google-tag-manager' );
	}

	/**
	 * Accordion groups.
	 *
	 * @return array<string, string>
	 */
	public function groups(): array {
		return array(
			'events' => __( 'Events', 'duracelltomi-google-tag-manager' ),
		);
	}

	/**
	 * Field definitions.
	 *
	 * @return Field[]
	 */
	public function fields(): array {
		return array(
			new Field(
				key: GTM4WP_OPTION_EVENTS_FORMMOVE,
				type: Field::TYPE_CHECKBOX,
				default_value: false,
				label: __( 'Form fill events', 'duracelltomi-google-tag-manager' ),
				description: esc_html__( 'Check this option to include a Tag Manager event when a visitor moves between elements of a form (comment, contact, etc). Each event describes the field in inputID, inputName and inputClass and its form in formID, formName and formClass, and also populates Google Tag Manager\'s built-in Form variables: Form ID, Form Classes, Form URL (the form\'s action, resolved to an absolute URL) and Form Target. Google publishes no built-in Form Name variable, so the form\'s name attribute stays available on formName only. Note that the keys behind those built-ins are the ones Google Tag Manager\'s Clicks category reads, so on these events Click ID and Click Classes resolve to the form as well. No field value is ever included.', 'duracelltomi-google-tag-manager' ),
				group: 'events',
				doc: self::DOC_PAGE
			),
			new Field(
				key: GTM4WP_OPTION_EVENTS_FORMMOVE_FILLEDONLY,
				type: Field::TYPE_CHECKBOX,
				default_value: false,
				label: __( 'Only report fields the visitor filled in', 'duracelltomi-google-tag-manager' ),
				description: esc_html__( 'Check this option to push gtm4wp.formElementLeave only for a field that was empty when the visitor entered it and holds a value when they leave it, so that tabbing through a form without typing no longer produces an event for every field. Text inputs, textareas and dropdowns are checked this way; checkboxes, radio buttons and buttons are always reported, because they carry no "empty" state. A field that was already filled in when the visitor entered it, for example one your theme pre-fills, reports nothing when they leave it unchanged. gtm4wp.formElementEnter is never affected and keeps firing for every field.', 'duracelltomi-google-tag-manager' ),
				group: 'events',
				phase: Field::PHASE_BETA,
				depends_on: GTM4WP_OPTION_EVENTS_FORMMOVE,
				doc: self::DOC_PAGE
			),
			new Field(
				key: GTM4WP_OPTION_EVENTS_NEWUSERREG,
				type: Field::TYPE_CHECKBOX,
				default_value: false,
				label: __( 'New user registration', 'duracelltomi-google-tag-manager' ),
				description: esc_html__( 'Check this option to include a Tag Manager event when a new user registration has been completed on the frontend of your site (admin events not included)', 'duracelltomi-google-tag-manager' ),
				group: 'events',
				doc: self::DOC_PAGE
			),
			new Field(
				key: GTM4WP_OPTION_EVENTS_USERLOGIN,
				type: Field::TYPE_CHECKBOX,
				default_value: false,
				label: __( 'User logged in', 'duracelltomi-google-tag-manager' ),
				description: esc_html__( 'Check this option to include a Tag Manager event when an existing user has been logged in on the frontend of your site (admin events not included)', 'duracelltomi-google-tag-manager' ),
				group: 'events',
				doc: self::DOC_PAGE
			),
		);
	}

	/**
	 * The user events module is always available.
	 *
	 * @return string
	 */
	public function unavailable_message(): string {
		return '';
	}
}