Product_Reviews

Summary

No summary available.

Source

File: src/BigCommerce/Templates/Product_Reviews.php

class Product_Reviews extends Controller {
	const PRODUCT = 'product';

	const HEADER         = 'header';
	const FORM           = 'form';
	const REVIEWS        = 'reviews';
	const FIRST_PAGE_URL = 'first_page_url';
	const NEXT_PAGE_URL  = 'next_page_url';

	protected $template           = 'components/reviews/product-reviews.php';
	protected $wrapper_tag        = 'section';
	protected $wrapper_classes    = [ 'bc-single-product__reviews' ];
	protected $wrapper_attributes = [ 'id' => 'bc-single-product__reviews' ];

	protected function parse_options( array $options ) {
		$defaults = [
			self::PRODUCT        => null,
			self::FIRST_PAGE_URL => '',
			self::NEXT_PAGE_URL  => '',
		];

		return wp_parse_args( $options, $defaults );
	}

	public function get_data() {
		$data = [
			self::REVIEWS        => $this->get_reviews( $this->options[ self::PRODUCT ], $this->options[ self::FIRST_PAGE_URL ], $this->options[ self::NEXT_PAGE_URL ] ),
			self::HEADER         => $this->get_header( $this->options[ self::PRODUCT ] ),
			self::FORM           => $this->get_form( $this->options[ self::PRODUCT ] ),
			self::FIRST_PAGE_URL => $this->options[ self::FIRST_PAGE_URL ],
		];

		return $data;
	}

	protected function get_reviews( Product $product, $first_page, $next_page ) {
		$component = Review_List::factory( [
			Review_List::PRODUCT        => $product,
			Review_List::FIRST_PAGE_URL => $first_page,
			Review_List::NEXT_PAGE_URL  => $next_page,
		] );

		return $component->render();
	}

	protected function get_header( Product $product ) {
		$component = Product_Rating::factory( [
			Product_Rating::PRODUCT => $product,
		], 'components/reviews/product-rating-header.php' );

		return $component->render();
	}

	protected function get_form( Product $product ) {
		/**
		 * Filter whether to show the product review form for a product.
		 *
		 * @param bool $show    Whether to show the form. Defaults to true if the user is logged in, otherwise false.
		 * @param int  $post_id The ID of the product post
		 */
		if ( ! apply_filters( 'bigcommerce/product/reviews/show_form', is_user_logged_in(), $product->post_id() ) ) {
			return '';
		}

		$component = Review_Form::factory( [
			Review_Form::PRODUCT => $product,
		] );

		return $component->render();
	}

}

Methods


User Contributed Notes

You must log in before being able to contribute a note or feedback.