[FEATURE] Announcements

phpstan.neon.dist

@@ -6,6 +6,7 @@ parameters:
 		- wp-content/mu-plugins/
 	excludePaths:
 		- vendor
+		- wp-content/themes/core/dist/ (?)
 	bootstrapFiles:
 		- vendor/php-stubs/wordpress-stubs/wordpress-stubs.php
 		- vendor/php-stubs/acf-pro-stubs/acf-pro-stubs.php

wp-content/plugins/core/src/Blocks/Blocks_Definer.php

@@ -42,6 +42,8 @@ class Blocks_Definer implements Definer_Interface {
 	public function define(): array {
 		return [
 			self::TYPES           => DI\add( [
+				'tribe/announcement-renderer',
+				'tribe/announcements',
 				'tribe/carousel',
 				'tribe/carousel-slide',
 				'tribe/copyright',

wp-content/plugins/core/src/Components/Announcements/Announcement_Controller.php

@@ -0,0 +1,109 @@
+<?php declare(strict_types=1);
+
+namespace Tribe\Plugin\Components\Announcements;
+
+use Tribe\Plugin\Components\Abstract_Controller;
+use Tribe\Plugin\Components\Announcements\Rules\Front_Page_Rule;
+use Tribe\Plugin\Components\Announcements\Rules\Page_Visibility_Rule;
+use Tribe\Plugin\Components\Announcements\Rules\Placement_Rule;
+use Tribe\Plugin\Components\Announcements\Rules\Rule_Interface;
+use Tribe\Plugin\Components\Announcements\Rules\Scheduling_Rule;
+use Tribe\Plugin\Post_Types\Announcement\Announcement;
+
+class Announcement_Controller extends Abstract_Controller {
+
+	private const int QUERY_LIMIT = 50;
+
+	/**
+	 * @var \Tribe\Plugin\Components\Announcements\Rules\Rule_Interface[]
+	 */
+	private array $rules = [];
+
+	/**
+	 * @var string[]|int[]|bool[]
+	 */
+	private array $context = [];
+
+	public function __construct() {
+		$this->add_rule( new Placement_Rule() );
+		$this->add_rule( new Front_Page_Rule() );
+		$this->add_rule( new Page_Visibility_Rule() );
+		$this->add_rule( new Scheduling_Rule() );
+	}
+
+	/**
+	 * Get announcements for a specific placement
+	 *
+	 * @param string $placement The placement location (above_header|below_header)
+	 * @param array  $context   Additional context for rule processing
+	 *
+	 * @return \WP_Post[]
+	 */
+	public function get_announcement_for_placement( string $placement, array $context = [] ): array {
+		$this->context = array_merge( $context, [
+			'placement'       => $placement,
+			'current_post_id' => get_queried_object_id(),
+			'is_home'         => is_home(),
+			'is_front_page'   => is_front_page(),
+			'is_single'       => is_single(),
+			'is_page'         => is_page(),
+			'is_category'     => is_category(),
+			'is_tag'          => is_tag(),
+			'is_tax'          => is_tax(),
+			'is_archive'      => is_archive(),
+			'current_time'    => current_time( 'U' ),
+		] );
+
+		$announcements = $this->get_all_announcements();
+
+		return $this->process_pipeline( $announcements );
+	}
+
+	/**
+	 * Add a rule to the processing pipeline
+	 *
+	 * @param \Tribe\Plugin\Components\Announcements\Rules\Rule_Interface $rule
+	 */
+	public function add_rule( Rule_Interface $rule ): self {
+		$this->rules[] = $rule;
+
+		return $this;
+	}
+
+	/**
+	 * Process announcements through the rule pipeline
+	 *
+	 * @param \WP_Post[] $announcements
+	 *
+	 * @return \WP_Post[]
+	 */
+	private function process_pipeline( array $announcements ): array {
+		foreach ( $this->rules as $rule ) {
+			$announcements = array_filter( $announcements, function ( $announcement ) use ( $rule ) {
+				return $rule->passes( $announcement, $this->context );
+			} );
+		}
+
+		return $announcements;
+	}
+
+	/**
+	 * Get all published announcements
+	 *
+	 * @return \WP_Post[]
+	 */
+	private function get_all_announcements(): array {
+		$query = new \WP_Query( [
+			'post_type'      => Announcement::NAME,
+			'post_status'    => 'publish',
+			'posts_per_page' => self::QUERY_LIMIT,
+			'orderby'        => [
+				'menu_order' => 'ASC',
+				'date'       => 'DESC',
+			],
+		] );
+
+		return $query->posts;
+	}
+
+}

wp-content/plugins/core/src/Components/Announcements/Announcement_Renderer.php

@@ -0,0 +1,96 @@
+<?php declare(strict_types=1);
+
+namespace Tribe\Plugin\Components\Announcements;
+
+use Tribe\Plugin\Object_Meta\Post_Types\Announcement_Meta;
+
+class Announcement_Renderer {
+
+	private Announcement_Controller $controller;
+
+	public function __construct( Announcement_Controller $controller ) {
+		$this->controller = $controller;
+	}
+
+	/**
+	 * Render Announcements for a specific placement as block markup
+	 *
+	 * @param string $placement
+	 * @param array $context
+	 */
+	public function render_announcements( string $placement, array $context = [] ): string {
+		$announcements = $this->controller->get_announcement_for_placement( $placement, $context );
+
+		if ( empty( $announcements ) ) {
+			return '';
+		}
+
+		$output = '';
+
+		foreach ( $announcements as $announcement ) {
+			$output .= $this->render_announcement_block( $announcement );
+		}
+
+		return $output;
+	}
+
+	/**
+	 * Render a single announcement as a block with JSON attributes
+	 *
+	 * @param \WP_Post $announcement
+	 */
+	public function render_announcement_block( \WP_Post $announcement ): string {
+		$attributes      = $this->get_announcement_attributes( $announcement );
+		$json_attributes = wp_json_encode( $attributes, JSON_UNESCAPED_SLASHES );
+
+		return sprintf( '<!-- wp:tribe/announcements %s /-->', $json_attributes );
+	}
+
+	/**
+	 * Parse and render block markup
+	 *
+	 * @param string $placement
+	 * @param array $context
+	 *
+	 * @return string Rendered HTML
+	 */
+	public function parse_and_render( string $placement, array $context = [] ): string {
+		$block_markup = $this->render_announcements( $placement, $context );
+
+		if ( empty( $block_markup ) ) {
+			return '';
+		}
+
+		// Parse the blocks and render them
+		$blocks = parse_blocks( $block_markup );
+		$output = '';
+
+		foreach ( $blocks as $block ) {
+			$output .= render_block( $block );
+		}
+
+		return $output;
+	}
+
+	/**
+	 * Get announcement data as block attributes
+	 *
+	 * @param \WP_Post $announcement
+	 */
+	private function get_announcement_attributes( \WP_Post $announcement ): array {
+		$link = get_field( Announcement_Meta::CTA_LINK, $announcement->ID ) ?? [];
+
+		return [
+			'announcementId' => $announcement->ID,
+			'heading'        => get_field( Announcement_Meta::HEADING, $announcement->ID ) ?? '',
+			'body'           => get_field( Announcement_Meta::BODY, $announcement->ID ) ?? '',
+			'ctaLabel'       => $link['title'] ?? null,
+			'ctaLink'        => $link['url'] ?? null,
+			'ctaStyle'       => get_field( Announcement_Meta::CTA_STYLE, $announcement->ID ) ?? 'outlined',
+			'align'          => get_field( Announcement_Meta::ALIGNMENT, $announcement->ID ) ?? 'center',
+			'theme'          => get_field( Announcement_Meta::COLOR_THEME, $announcement->ID ) ?? 'brand',
+			'dismissible'    => (bool) get_field( Announcement_Meta::DISMISSIBLE, $announcement->ID ),
+		];
+	}
+
+}

wp-content/plugins/core/src/Components/Announcements/Rules/Front_Page_Rule.php

@@ -0,0 +1,38 @@
+<?php declare(strict_types=1);
+
+namespace Tribe\Plugin\Components\Announcements\Rules;
+
+use Tribe\Plugin\Object_Meta\Post_Types\Announcement_Meta;
+
+class Front_Page_Rule implements Rule_Interface {
+
+	public function passes( \WP_Post $announcement, array $context ): bool {
+		$is_front_page = $context['is_front_page'] ?? is_front_page();
+
+		if ( ! $is_front_page ) {
+			return true;
+		}
+
+		$display_type        = get_field( Announcement_Meta::FIELD_RULES_DISPLAY_TYPE, $announcement->ID );
+		$apply_to_front_page = get_field( Announcement_Meta::FIELD_RULES_APPLY_TO_FRONT_PAGE, $announcement->ID );
+
+		// If not applying rules to front page, always show.
+		if ( ! $apply_to_front_page ) {
+			return true;
+		}
+
+		// If set to show everywhere, always show.
+		if ( $display_type === Announcement_Meta::OPTION_EVERY_PAGE ) {
+			return true;
+		}
+
+		// For include rule: show on front page
+		// For exclude rule: don't show on front page
+		return $display_type === Announcement_Meta::OPTION_INCLUDE;
+	}
+
+	public function get_name(): string {
+		return 'front_page';
+	}
+
+}