GeminiLabs\SiteReviews\Shortcodes\SiteReviewsSummaryShortcode

Complexity

Total Complexity

15

Size/Duplication

Total Lines	193
Duplicated Lines	0 %

Test Coverage

Coverage

7.64%

Importance

Changes	5
Bugs	1	Features	1

9 Methods

Rating	Name	Duplication	Size	Complexity
A	buildTemplate()	0	17	2
A	buildTemplateTag()	0	9	2
A	description()	0	3	1
A	name()	0	3	1
A	generateSchema()	0	5	2
B	config()	0	105	1
A	normalizeLabels()	0	10	3
A	isEmpty()	0	3	2
A	hideOptions()	0	8	1

<?php

namespace GeminiLabs\SiteReviews\Shortcodes;

use GeminiLabs\SiteReviews\Database\RatingManager;
use GeminiLabs\SiteReviews\Helper;
use GeminiLabs\SiteReviews\Helpers\Cast;
use GeminiLabs\SiteReviews\Modules\Html\Template;
use GeminiLabs\SiteReviews\Modules\Rating;
use GeminiLabs\SiteReviews\Modules\Schema;

class SiteReviewsSummaryShortcode extends Shortcode
{
    /**
     * @var array
     */
    protected $ratings;

    public function buildTemplate(): string
    {
        $this->ratings = glsr(RatingManager::class)->ratings($this->args);
        $this->debug(['ratings' => $this->ratings]);
        if ($this->isEmpty()) {
            return glsr()->filterString('summary/if_empty', '');
        }
        $this->generateSchema();
        return glsr(Template::class)->build('templates/reviews-summary', [
            'args' => $this->args,
            'context' => [
                'class' => 'glsr-summary',
                'id' => '', // @deprecated_5
                'percentages' => $this->buildTemplateTag('percentages'),
                'rating' => $this->buildTemplateTag('rating'),
                'stars' => $this->buildTemplateTag('stars'),
                'text' => $this->buildTemplateTag('text'),
            ],
        ]);
    }

    public function description(): string
    {
        return esc_html_x('Display a rating summary', 'admin-text', 'site-reviews');
    }

    public function name(): string
    {
        return esc_html_x('Rating Summary', 'admin-text', 'site-reviews');
    }

    protected function buildTemplateTag(string $tag): string
    {
        $args = $this->args;
        $className = Helper::buildClassName(['summary', $tag, 'tag'], 'Modules\Html\Tags');
        $className = glsr()->filterString("summary/tag/{$tag}", $className, $this);
        $field = class_exists($className)
            ? glsr($className, compact('tag', 'args'))->handleFor('summary', null, $this->ratings)
            : '';
        return glsr()->filterString("summary/build/{$tag}", $field, $this->ratings, $this);
    }

    protected function config(): array
    {
        return [ // order is intentional
            'assigned_posts' => [
                'group' => 'general',
                'label' => esc_html_x('Limit Reviews by Assigned Pages', 'admin-text', 'site-reviews'),
                'multiple' => true,
                'placeholder' => esc_html_x('Select a Page...', 'admin-text', 'site-reviews'),
                'type' => 'select',
            ],
            'assigned_terms' => [
                'group' => 'general',
                'label' => esc_html_x('Limit Reviews by Assigned Categories', 'admin-text', 'site-reviews'),
                'multiple' => true,
                'placeholder' => esc_html_x('Select a Category...', 'admin-text', 'site-reviews'),
                'type' => 'select',
            ],
            'assigned_users' => [
                'group' => 'general',
                'label' => esc_html_x('Limit Reviews by Assigned Users', 'admin-text', 'site-reviews'),
                'multiple' => true,
                'placeholder' => esc_html_x('Select a User...', 'admin-text', 'site-reviews'),
                'type' => 'select',
            ],
            'author' => [
                'group' => 'general',
                'label' => esc_html_x('Limit Reviews by Review Author', 'admin-text', 'site-reviews'),
                'multiple' => false,
                'placeholder' => esc_html_x('Select a User...', 'admin-text', 'site-reviews'),
                'type' => 'select',
            ],
            'terms' => [
                'group' => 'general',
                'label' => esc_html_x('Limit Reviews by Accepted Terms', 'admin-text', 'site-reviews'),
                'options' => $this->options('terms'),
                'placeholder' => esc_html_x('Select Review Terms...', 'admin-text', 'site-reviews'),
                'type' => 'select',
            ],
            'type' => [
                'group' => 'general',
                'label' => esc_html_x('Limit Reviews by Type', 'admin-text', 'site-reviews'),
                'options' => $this->options('type'),
                'placeholder' => esc_html_x('Select a Review Type...', 'admin-text', 'site-reviews'),
                'type' => 'select',
            ],
            'verified' => [
                'group' => 'general',
                'label' => esc_html_x('Limit Reviews by Verified Status', 'admin-text', 'site-reviews'),
                'options' => $this->options('verified'),
                'placeholder' => esc_html_x('Select Verified Status...', 'admin-text', 'site-reviews'),
                'type' => 'select',
            ],
            'rating' => [
                'default' => (string) Rating::min(),
                'group' => 'display',
                'label' => esc_html_x('Minimum Rating', 'admin-text', 'site-reviews'),
                'max' => Rating::max(),
                'min' => Rating::min(),
                'placeholder' => (string) Rating::min(),
                'type' => 'number',
            ],
            'rating_field' => [
                'description' => sprintf(_x('Use the %s addon to add custom rating fields.', 'admin-text', 'site-reviews'),
                    glsr_premium_link('site-reviews-forms')
                ),
                'group' => 'display',
                'label' => esc_html_x('Custom Rating Field Name', 'admin-text', 'site-reviews'),
                'type' => 'text',
            ],
            'schema' => [
                'description' => esc_html_x('The schema should only be enabled once on your page.', 'admin-text', 'site-reviews'),
                'group' => 'schema',
                'label' => esc_html_x('Enable the schema?', 'admin-text', 'site-reviews'),
                'type' => 'checkbox',
            ],
            'hide' => [
                'group' => 'hide',
                'options' => $this->options('hide'),
                'type' => 'checkbox',
            ],
            'text' => [
                'description' => _x('Use {num} to display the number of reviews, {rating} to display the average rating, and {max} to display the maximum rating value.', 'admin-text', 'site-reviews'),
                'group' => 'text',
                'label' => _x('Summary Text', 'admin-text', 'site-reviews'),
                'placeholder' => _x('{rating} out of {max} stars (based on {num} reviews)', 'admin-text', 'site-reviews'),
                'type' => 'text',
            ],
            'labels' => [
                'description' => _x('Enter custom labels for the percentage bar levels (from high to low) and separate them with a comma.', 'admin-text', 'site-reviews'),
                'group' => 'text',
                'label' => _x('Summary Labels', 'admin-text', 'site-reviews'),
                'placeholder' => implode(', ', Rating::labels()),
                'type' => 'text',
            ],
            'id' => [
                'description' => esc_html_x('This should be a unique value.', 'admin-text', 'site-reviews'),
                'group' => 'advanced',
                'label' => esc_html_x('Custom ID', 'admin-text', 'site-reviews'),
                'type' => 'text',
            ],
            'class' => [
                'description' => esc_html_x('Separate multiple classes with spaces.', 'admin-text', 'site-reviews'),
                'group' => 'advanced',
                'label' => esc_html_x('Additional CSS classes', 'admin-text', 'site-reviews'),
                'type' => 'text',
            ],
        ];
    }

    protected function generateSchema(): void
    {
        if (Cast::toBool($this->args['schema'])) {
            glsr(Schema::class)->store(
                glsr(Schema::class)->buildSummary($this->args, $this->ratings)
            );
        }
    }

    protected function hideOptions(): array
    {
        return [
            'rating' => _x('Hide the rating', 'admin-text', 'site-reviews'),
            'stars' => _x('Hide the stars', 'admin-text', 'site-reviews'),
            'summary' => _x('Hide the summary', 'admin-text', 'site-reviews'),
            'bars' => _x('Hide the percentage bars', 'admin-text', 'site-reviews'),
            'if_empty' => _x('Hide if no reviews are found', 'admin-text', 'site-reviews'),
        ];
    }

    protected function isEmpty(): bool
    {
        return !array_sum($this->ratings) && in_array('if_empty', $this->args['hide']);
    }

    protected function normalizeLabels(string $value): array
    {
        $labels = Rating::labels(); // indexed in DESC order
        $customLabels  = array_map('trim', explode(',', $value));
        foreach ($labels as $index => $label) {
            if (!empty($customLabels[$index])) { // don't allow 0
                $labels[$index] = $customLabels[$index];
            }
        }
        return $labels;
    }
}