<?php
namespace Code_Snippets\Admin\Menus\Stats;
use Code_Snippets\Model\Snippet;
use function Code_Snippets\get_snippets;
/**
* Builds aggregate data for the Stats screen.
*/
final class Stats_Summary {
/**
* Display order for snippet types.
*
* @var string[]
*/
private const TYPE_ORDER = [ 'php', 'html', 'css', 'js', 'cond' ];
/**
* Recognised executable locations, in display order. Labels are resolved on
* the front-end, which already maintains these strings for the editor.
*
* @var string[]
*/
private const LOCATION_ORDER = [
'global',
'admin',
'front-end',
'single-use',
'content',
'head-content',
'body-content',
'footer-content',
'admin-css',
'site-css',
'site-head-js',
'site-footer-js',
];
/**
* Build an aggregate of saved snippets for the Stats screen.
*
* @return array{
* active: int,
* inactive: int,
* typeCounts: array<string, array{label: string, count: int}>,
* conditionCounts: array<string, array{label: string, count: int}>,
* locationCounts: array<string, int>,
* tagCounts: array<string, array{label: string, count: int}>
* }
*/
public function get(): array {
return $this->create_summary( get_snippets() );
}
/**
* Create summary data from snippet models.
*
* @param Snippet[] $snippets Snippet models.
*
* @return array{
* active: int,
* inactive: int,
* typeCounts: array<string, array{label: string, count: int}>,
* conditionCounts: array<string, array{label: string, count: int}>,
* locationCounts: array<string, int>,
* tagCounts: array<string, array{label: string, count: int}>
* }
*/
private function create_summary( array $snippets ): array {
$snippets = array_values(
array_filter(
$snippets,
static function ( Snippet $snippet ): bool {
return ! $snippet->trashed;
}
)
);
$active_condition_ids = [];
foreach ( $snippets as $snippet ) {
if ( 'condition' !== $snippet->scope && $snippet->active && $snippet->condition_id ) {
$active_condition_ids[ $snippet->condition_id ] = true;
}
}
$type_counts = array_fill_keys( self::TYPE_ORDER, 0 );
$condition_counts = array_fill_keys( [ 'with', 'without' ], 0 );
$location_counts = array_fill_keys( self::LOCATION_ORDER, 0 );
$tag_counts = [];
$active = 0;
foreach ( $snippets as $snippet ) {
$type = Snippet::get_type_from_scope( $snippet->scope );
if ( isset( $type_counts[ $type ] ) ) {
++$type_counts[ $type ];
}
++$condition_counts[ $snippet->condition_id ? 'with' : 'without' ];
if ( 'condition' === $snippet->scope ) {
$is_active = isset( $active_condition_ids[ $snippet->id ] );
} else {
$is_active = $snippet->active;
if ( isset( $location_counts[ $snippet->scope ] ) ) {
++$location_counts[ $snippet->scope ];
}
}
if ( $is_active ) {
++$active;
}
foreach ( array_unique( $snippet->tags ) as $tag ) {
if ( '' !== $tag ) {
$tag_counts[ $tag ] = ( $tag_counts[ $tag ] ?? 0 ) + 1;
}
}
}
return [
'active' => $active,
'inactive' => count( $snippets ) - $active,
'typeCounts' => $this->create_chart_entries( $type_counts, $this->get_type_labels() ),
'conditionCounts' => $this->create_chart_entries( $condition_counts, $this->get_condition_usage_labels() ),
'locationCounts' => array_filter( $location_counts ),
'tagCounts' => $this->create_tag_chart_entries( $tag_counts ),
];
}
/**
* Convert tag counts into usage-ordered chart entries.
*
* @param array<string, int> $counts Count for each tag.
*
* @return array<string, array{label: string, count: int}>
*/
private function create_tag_chart_entries( array $counts ): array {
uksort(
$counts,
static function ( string $first_tag, string $second_tag ) use ( $counts ): int {
$count_comparison = $counts[ $second_tag ] <=> $counts[ $first_tag ];
if ( 0 !== $count_comparison ) {
return $count_comparison;
}
$label_comparison = strnatcasecmp( $first_tag, $second_tag );
return 0 !== $label_comparison ? $label_comparison : strcmp( $first_tag, $second_tag );
}
);
$entries = [];
foreach ( $counts as $tag => $count ) {
$entries[ $tag ] = [
'label' => $tag,
'count' => $count,
];
}
return $entries;
}
/**
* Convert aggregate counts into labeled chart entries.
*
* @param array<string, int> $counts Count for each type.
* @param array<string, string> $labels Display label for each type.
*
* @return array<string, array{label: string, count: int}>
*/
private function create_chart_entries( array $counts, array $labels ): array {
$entries = [];
foreach ( $counts as $key => $count ) {
if ( isset( $labels[ $key ] ) ) {
$entries[ $key ] = [
'label' => $labels[ $key ],
'count' => $count,
];
}
}
return $entries;
}
/**
* Retrieve display labels for snippet types.
*
* @return array<string, string>
*/
private function get_type_labels(): array {
return [
'php' => __( 'PHP', 'code-snippets' ),
'html' => __( 'HTML', 'code-snippets' ),
'css' => __( 'CSS', 'code-snippets' ),
'js' => __( 'JS', 'code-snippets' ),
'cond' => __( 'Conditions', 'code-snippets' ),
];
}
/**
* Retrieve display labels for condition usage.
*
* @return array<string, string>
*/
private function get_condition_usage_labels(): array {
return [
'with' => __( 'Uses conditions', 'code-snippets' ),
'without' => __( 'Does not use conditions', 'code-snippets' ),
];
}
}