Widget_Area.php

<?php // phpcs:ignore WordPress.Files.FileName
/**
 * Migrate arbitrary content to blocks
 *
 * @since 3.0.0
 * @package gridd
 */

namespace Gridd\Upgrades\Block;

/**
 * The block-migrator object.
 *
 * @since 3.0.0
 */
class Widget_Area extends \Gridd\Upgrades\Block_Migrator {

	/**
	 * The widget-area slug.
	 *
	 * @access protected
	 * @since 3.0.0
	 * @var string
	 */
	protected $widget_area_slug;

	/**
	 * An array of our widgets.
	 *
	 * @access protected
	 * @since 3.0.0
	 * @var array
	 */
	protected $widgets;

	/**
	 * Constructor.
	 *
	 * @access public
	 * @param array $args The constructor arguments.
	 * @since 3.0.0
	 */
	public function __construct( $args ) {

		// Set the sidebar title & slug.
		$this->set_object_params( $args );
		parent::__construct();
	}

	/**
	 * Set the object params.
	 *
	 * @access protected
	 * @since 3.0.0
	 * @param array $args The arguments passed-on from the constructor.
	 * @return void
	 */
	public function set_object_params( $args ) {
		$this->widget_area_slug = $args[0];
		$this->widgets          = $args[1];
		$this->slug             = 'gridd-' . str_replace( '_', '-', $this->widget_area_slug );
		$this->title            = 'Gridd: ' . $this->widget_area_slug;
	}

	/**
	 * Get the contents of the block we want to add.
	 *
	 * @access protected
	 * @since 3.0.0
	 * @return string
	 */
	protected function get_content() {
		global $wp_registered_widgets;

		$content = '';

		// Loop widget areas.
		foreach ( $this->widgets as $widget_id ) {

			$class       = $wp_registered_widgets[ $widget_id ]['callback'][0];
			$class_name  = get_class( $class );
			$method_name = 'get_contents_' . strtolower( $class_name );

			if ( is_callable( [ $this, $method_name ] ) ) {
				$content .= $this->$method_name( $widget_id, $class );
			}
		}

		return $content;
	}

	/**
	 * Get the widget title.
	 *
	 * @access protected
	 * @since 3.0.0
	 * @param array $args The widget arguments.
	 * @return string
	 */
	protected function get_widget_title( $args ) {
		if ( isset( $args['title'] ) && ! empty( trim( $args['title'] ) ) ) {
			return '<!-- wp:heading {"level":3} --><h3>' . $args['title'] . '</h3><!-- /wp:heading -->';
		}
		return '';
	}

	/**
	 * Gets the block contents for WP_Widget_Archives.
	 *
	 * @access protected
	 * @since 3.0.0
	 * @param string             $widget_id The widget-ID.
	 * @param WP_Widget_Archives $class     The widget class.
	 * @return string
	 */
	protected function get_contents_wp_widget_archives( $widget_id, $class ) {

		// Get the block settings.
		$settings = $class->get_settings()[ absint( str_replace( 'archives-', '', $widget_id ) ) ];

		// Build the arguments.
		$args = [
			'displayAsDropdown' => ( isset( $settings['dropdown'] ) && $settings['dropdown'] ),
			'showPostCounts'    => ( isset( $settings['count'] ) && $settings['count'] ),
		];

		$content  = $this->get_widget_title( $settings );
		$content .= '<!-- wp:archives ' . wp_json_encode( $args ) . ' /-->';

		return $content;
	}

	/**
	 * Gets the block contents for WP_Widget_Categories.
	 *
	 * @access protected
	 * @since 3.0.0
	 * @param string               $widget_id The widget-ID.
	 * @param WP_Widget_Categories $class     The widget class.
	 * @return string
	 */
	protected function get_contents_wp_widget_categories( $widget_id, $class ) {

		// Get the block settings.
		$settings = $class->get_settings()[ absint( str_replace( 'categories-', '', $widget_id ) ) ];

		// Build the arguments.
		$args = [
			'displayAsDropdown' => ( isset( $settings['dropdown'] ) && $settings['dropdown'] ),
			'showHierarchy'     => ( isset( $settings['hierarchical'] ) && $settings['hierarchical'] ),
			'showPostCounts'    => ( isset( $settings['count'] ) && $settings['count'] ),
		];

		$content  = $this->get_widget_title( $settings );
		$content .= '<!-- wp:categories ' . wp_json_encode( $args ) . ' /-->';

		return $content;
	}

	/**
	 * Gets the block contents for WP_Widget_Media_Audio.
	 *
	 * @access protected
	 * @since 3.0.0
	 * @param string                $widget_id The widget-ID.
	 * @param WP_Widget_Media_Audio $class     The widget class.
	 * @return string
	 */
	protected function get_contents_wp_widget_media_audio( $widget_id, $class ) {

		// Get the block settings.
		$settings = $class->get_settings()[ absint( str_replace( 'media_audio-', '', $widget_id ) ) ];

		$url = false;
		foreach ( [ 'mp3', 'ogg', 'flac', 'm4a', 'wav' ] as $filetype ) {
			if ( isset( $settings[ $filetype ] ) && ! empty( $settings[ $filetype ] ) ) {
				$url = $settings[ $filetype ];
			}
		}

		$content  = $this->get_widget_title( $settings );
		$content .= '<!-- wp:audio {"id":' . $settings['attachment_id'] . '} -->';
		$content .= '<figure class="wp-block-audio">';
		$content .= '<audio controls src="' . $url . '" autoplay';
		if ( isset( $settings['loop'] ) && $settings['loop'] ) {
			$content .= ' loop';
		}
		if ( isset( $settings['preload'] ) ) {
			$content .= ' preload="' . $settings['preload'] . '">';
		}
		$content .= '</audio></figure><!-- /wp:audio -->';

		return $content;
	}

	/**
	 * Gets the block contents for WP_Widget_Calendar.
	 *
	 * @access protected
	 * @since 3.0.0
	 * @param string             $widget_id The widget-ID.
	 * @param WP_Widget_Calendar $class     The widget class.
	 * @return string
	 */
	protected function get_contents_wp_widget_calendar( $widget_id, $class ) {

		// Get the block settings.
		$settings = $class->get_settings()[ absint( str_replace( 'calendar-', '', $widget_id ) ) ];

		$content  = $this->get_widget_title( $settings );
		$content .= '<!-- wp:calendar /-->';

		return $content;
	}

	/**
	 * Gets the block contents for WP_Widget_Custom_HTML.
	 *
	 * @access protected
	 * @since 3.0.0
	 * @param string                $widget_id The widget-ID.
	 * @param WP_Widget_Custom_HTML $class     The widget class.
	 * @return string
	 */
	protected function get_contents_wp_widget_custom_html( $widget_id, $class ) {

		// Get the block settings.
		$settings = $class->get_settings()[ absint( str_replace( 'custom_html-', '', $widget_id ) ) ];

		$content  = $this->get_widget_title( $settings );
		$content .= '<!-- wp:html -->' . $settings['content'] . '<!-- /wp:html -->';

		return $content;
	}

	/**
	 * Gets the block contents for WP_Widget_Media_Gallery.
	 *
	 * @access protected
	 * @since 3.0.0
	 * @param string                  $widget_id The widget-ID.
	 * @param WP_Widget_Media_Gallery $class     The widget class.
	 * @return string
	 */
	protected function get_contents_wp_widget_media_gallery( $widget_id, $class ) {

		// Get the block settings.
		$settings = $class->get_settings()[ absint( str_replace( 'media_gallery-', '', $widget_id ) ) ];

		$content  = $this->get_widget_title( $settings );
		$content .= '<!-- wp:gallery ' . wp_json_encode( [ 'ids' => $settings['ids'] ] ) . ' -->';
		$content .= '<figure class="wp-block-gallery columns-' . $settings['columns'] . ' is-cropped">';
		$content .= '<ul class="blocks-gallery-grid">';
		foreach ( $settings['ids'] as $img_id ) {
			$meta = wp_get_attachment_metadata( $img_id );

			$content .= '<li class="blocks-gallery-item"><figure>';
			$content .= '<img src="' . $meta['sizes'][ $settings['size'] ] . '" alt="" data-id="' . $img_id . '" data-full-url="' . wp_get_attachment_url( $img_id ) . '" data-link="' . wp_get_attachment_url( $img_id ) . '" class="wp-image-' . $img_id . '"/>';
			$content .= '</figure></li>';
		}
		$content .= '</ul></figure><!-- /wp:gallery -->';

		return $content;
	}

	/**
	 * Gets the block contents for WP_Widget_Media_Image.
	 *
	 * @access protected
	 * @since 3.0.0
	 * @param string                $widget_id The widget-ID.
	 * @param WP_Widget_Media_Image $class     The widget class.
	 * @return string
	 */
	protected function get_contents_wp_widget_media_image( $widget_id, $class ) {

		// Get the block settings.
		$settings = $class->get_settings()[ absint( str_replace( 'media_image-', '', $widget_id ) ) ];

		$image_args = [
			'id'       => $settings['attachment_id'],
			'width'    => $settings['width'],
			'height'   => $settings['height'],
			'sizeSlug' => $settings['size'],
		];

		$content  = $this->get_widget_title( $settings );
		$content .= '<!-- wp:image ' . wp_json_encode( $image_args ) . ' -->';
		$content .= '<figure class="wp-block-image size-' . $settings['size'] . ' is-resized">';
		if ( $settings['link_url'] ) {
			$content .= '<a href="' . $settings['link_url'] . '">';
		}
		$content .= '<img src="' . $settings['url'] . '" alt="' . $settings['alt'] . '" class="wp-image-' . $settings['attachment_id'] . '" width="' . $settings['width'] . '" height="' . $settings['height'] . '"/>';
		if ( $settings['link_url'] ) {
			$content .= '</a>';
		}
		if ( $settings['caption'] ) {
			$content .= '<figcaption>' . $settings['caption'] . '</figcaption>';
		}
		$content .= '</figure><!-- /wp:image -->';

		return $content;
	}

	/**
	 * Gets the block contents for WP_Widget_Recent_Comments.
	 *
	 * @access protected
	 * @since 3.0.0
	 * @param string                    $widget_id The widget-ID.
	 * @param WP_Widget_Recent_Comments $class     The widget class.
	 * @return string
	 */
	protected function get_contents_wp_widget_recent_comments( $widget_id, $class ) {

		// Get the block settings.
		$settings = $class->get_settings()[ absint( str_replace( 'recent-comments-', '', $widget_id ) ) ];
		return '<!-- wp:latest-comments {"commentsToShow":' . $settings['number'] . '} /-->';
	}

	/**
	 * Gets the block contents for WP_Widget_RSS.
	 *
	 * @access protected
	 * @since 3.0.0
	 * @param string        $widget_id The widget-ID.
	 * @param WP_Widget_RSS $class     The widget class.
	 * @return string
	 */
	protected function get_contents_wp_widget_rss( $widget_id, $class ) {

		// Get the block settings.
		$settings = $class->get_settings()[ absint( str_replace( 'rss-', '', $widget_id ) ) ];
		$args     = [
			'feedURL'        => $settings['url'],
			'itemsToShow'    => $settings['items'],
			'displayExcerpt' => (bool) $settings['show_summary'],
			'displayAuthor'  => (bool) $settings['show_author'],
			'displayDate'    => (bool) $settings['show_date'],
			'excerptLength'  => 50,
		];
		return '<!-- wp:rss ' . wp_json_encode( $args ) . ' /-->';
	}
}