<?php
/**
 * User Columns.
 *
 * WordPress records when every account was created — wp_insert_user() fills user_registered
 * itself — and WP_User_Query can already sort by it. The single-site Users screen simply never
 * shows it; only the multisite network screen does. This adds the column and the sort.
 *
 * One switch, no settings. Nothing here writes to the database: the date is core's own, so it is
 * right for every existing user the moment this is switched on, and switching it off leaves
 * nothing behind.
 *
 * @package Adminkeep
 */

namespace Adminkeep\Feature;

use Adminkeep\Feature;

defined( 'ABSPATH' ) || exit;

/**
 * Adds a sortable Registered column to the Users screen.
 */
class UserColumns implements Feature {

	/**
	 * Column key. Prefixed so it cannot collide with another plugin's "registered" column.
	 */
	const COLUMN = 'adminkeep_registered';

	/**
	 * Feature id.
	 *
	 * @return string
	 */
	public function id() {
		return 'user_columns';
	}

	/**
	 * Label.
	 *
	 * @return string
	 */
	public function label() {
		return __( 'User Registration Date', 'adminkeep' );
	}

	/**
	 * Description.
	 *
	 * @return string
	 */
	public function description() {
		return __( 'Shows when each account was created, as a sortable column on the Users screen. WordPress has always recorded the date; it just does not show it.', 'adminkeep' );
	}

	/**
	 * A word for what this feature is doing right now.
	 *
	 * @return string
	 */
	public function state_label() {
		return __( 'Shown', 'adminkeep' );
	}

	/**
	 * Settings schema. Nothing to decide.
	 *
	 * @return array
	 */
	public function settings_schema() {
		return array();
	}

	/**
	 * No fields, so no labels.
	 *
	 * @param string $key Field key.
	 * @return string
	 */
	public function field_label( $key ) {
		return '';
	}

	/**
	 * What switching this on actually does.
	 *
	 * @return string[]
	 */
	public function how_it_works() {
		return array(
			__( 'Adds a Registered column to Users → All Users, showing the date each account was created.', 'adminkeep' ),
			__( 'Click the column heading to sort, newest accounts first — a quick way to spot a wave of spam signups.', 'adminkeep' ),
			__( 'Hover a date for the exact time. Dates follow your site timezone and date format.', 'adminkeep' ),
			__( 'The date is the one WordPress itself stored when the account was created, so it is already there for every existing user.', 'adminkeep' ),
			__( 'Nothing is written to the database. Switch it off and the column is gone.', 'adminkeep' ),
		);
	}

	/**
	 * Register hooks.
	 *
	 * @param array $settings Resolved settings. Unused — this feature has none.
	 * @return void
	 */
	public function boot( array $settings ) {
		add_filter( 'manage_users_columns', array( $this, 'add_column' ) );
		add_filter( 'manage_users_sortable_columns', array( $this, 'make_sortable' ) );
		add_filter( 'manage_users_custom_column', array( $this, 'render_cell' ), 10, 3 );
		add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_style' ) );
	}

	/**
	 * Append the column.
	 *
	 * @param array $columns Column key => heading.
	 * @return array
	 */
	public function add_column( $columns ) {
		$columns[ self::COLUMN ] = __( 'Registered', 'adminkeep' );

		return $columns;
	}

	/**
	 * Sort through the orderby WP_User_Query already understands.
	 *
	 * The second element is the first-click direction: descending, because the newest accounts
	 * are the ones worth looking at.
	 *
	 * @param array $sortable Column key => sort definition.
	 * @return array
	 */
	public function make_sortable( $sortable ) {
		$sortable[ self::COLUMN ] = array( 'registered', true );

		return $sortable;
	}

	/**
	 * The cell: the date, with the full moment on hover.
	 *
	 * @param string $output  Output so far.
	 * @param string $column  Column key.
	 * @param int    $user_id User id.
	 * @return string
	 */
	public function render_cell( $output, $column, $user_id ) {
		if ( self::COLUMN !== $column ) {
			return $output;
		}

		$user = get_userdata( $user_id );

		// user_registered is stored in UTC. Some importers leave a zero date behind.
		$timestamp = $user ? strtotime( $user->user_registered . ' UTC' ) : false;

		if ( false === $timestamp || $timestamp <= 0 ) {
			return '&mdash;';
		}

		$date_format = get_option( 'date_format' );

		return sprintf(
			'<span title="%1$s">%2$s</span>',
			esc_attr( wp_date( $date_format . ' ' . get_option( 'time_format' ), $timestamp ) ),
			esc_html( wp_date( self::short_date_format( $date_format ), $timestamp ) )
		);
	}

	/**
	 * Keep the column as wide as a date.
	 *
	 * The users table is table-layout: fixed, so a column with no width takes an equal share of
	 * what is left, and max-width does nothing there. Attached to a stylesheet core already
	 * prints on this screen rather than shipping a file for one rule.
	 *
	 * @param string $hook_suffix Current admin page.
	 * @return void
	 */
	public function enqueue_style( $hook_suffix ) {
		if ( 'users.php' !== $hook_suffix ) {
			return;
		}

		wp_add_inline_style( 'list-tables', '.fixed .column-' . self::COLUMN . '{width:120px}' );
	}

	/**
	 * The site's date format with the month name shortened.
	 *
	 * Swapping the one character rather than imposing a format keeps a site's chosen order,
	 * d/m/Y included. A backslash-escaped F is a literal letter, not a month, and is left alone.
	 *
	 * @param string $format A PHP date format.
	 * @return string
	 */
	public static function short_date_format( $format ) {
		return (string) preg_replace( '/(?<!\\\\)F/', 'M', (string) $format );
	}
}