@@ -4,38 +4,38 @@ |
||
| 4 | 4 | |
| 5 | 5 | class YesNo extends Field |
| 6 | 6 | { |
| 7 | - /** |
|
| 8 | - * @return string|void |
|
| 9 | - */ |
|
| 10 | - public function build() |
|
| 11 | - { |
|
| 12 | - $this->builder->tag = 'input'; |
|
| 13 | - $this->mergeFieldArgs(); |
|
| 14 | - return $this->builder->getTag(); |
|
| 15 | - } |
|
| 7 | + /** |
|
| 8 | + * @return string|void |
|
| 9 | + */ |
|
| 10 | + public function build() |
|
| 11 | + { |
|
| 12 | + $this->builder->tag = 'input'; |
|
| 13 | + $this->mergeFieldArgs(); |
|
| 14 | + return $this->builder->getTag(); |
|
| 15 | + } |
|
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * @return array |
|
| 19 | - */ |
|
| 20 | - public static function defaults() |
|
| 21 | - { |
|
| 22 | - return [ |
|
| 23 | - 'class' => 'inline', |
|
| 24 | - ]; |
|
| 25 | - } |
|
| 17 | + /** |
|
| 18 | + * @return array |
|
| 19 | + */ |
|
| 20 | + public static function defaults() |
|
| 21 | + { |
|
| 22 | + return [ |
|
| 23 | + 'class' => 'inline', |
|
| 24 | + ]; |
|
| 25 | + } |
|
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * @return array |
|
| 29 | - */ |
|
| 30 | - public static function required() |
|
| 31 | - { |
|
| 32 | - return [ |
|
| 33 | - 'is_multi' => true, |
|
| 34 | - 'options' => [ |
|
| 35 | - 'no' => __('No', 'site-reviews'), |
|
| 36 | - 'yes' => __('Yes', 'site-reviews'), |
|
| 37 | - ], |
|
| 38 | - 'type' => 'radio', |
|
| 39 | - ]; |
|
| 40 | - } |
|
| 27 | + /** |
|
| 28 | + * @return array |
|
| 29 | + */ |
|
| 30 | + public static function required() |
|
| 31 | + { |
|
| 32 | + return [ |
|
| 33 | + 'is_multi' => true, |
|
| 34 | + 'options' => [ |
|
| 35 | + 'no' => __('No', 'site-reviews'), |
|
| 36 | + 'yes' => __('Yes', 'site-reviews'), |
|
| 37 | + ], |
|
| 38 | + 'type' => 'radio', |
|
| 39 | + ]; |
|
| 40 | + } |
|
| 41 | 41 | } |
@@ -4,13 +4,13 @@ |
||
| 4 | 4 | |
| 5 | 5 | class Number extends Field |
| 6 | 6 | { |
| 7 | - /** |
|
| 8 | - * @return array |
|
| 9 | - */ |
|
| 10 | - public static function defaults() |
|
| 11 | - { |
|
| 12 | - return [ |
|
| 13 | - 'class' => 'small-text', |
|
| 14 | - ]; |
|
| 15 | - } |
|
| 7 | + /** |
|
| 8 | + * @return array |
|
| 9 | + */ |
|
| 10 | + public static function defaults() |
|
| 11 | + { |
|
| 12 | + return [ |
|
| 13 | + 'class' => 'small-text', |
|
| 14 | + ]; |
|
| 15 | + } |
|
| 16 | 16 | } |
@@ -4,23 +4,23 @@ |
||
| 4 | 4 | |
| 5 | 5 | class Checkbox extends Field |
| 6 | 6 | { |
| 7 | - /** |
|
| 8 | - * @return array |
|
| 9 | - */ |
|
| 10 | - public static function defaults() |
|
| 11 | - { |
|
| 12 | - return [ |
|
| 13 | - 'value' => 1, |
|
| 14 | - ]; |
|
| 15 | - } |
|
| 7 | + /** |
|
| 8 | + * @return array |
|
| 9 | + */ |
|
| 10 | + public static function defaults() |
|
| 11 | + { |
|
| 12 | + return [ |
|
| 13 | + 'value' => 1, |
|
| 14 | + ]; |
|
| 15 | + } |
|
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * @return array |
|
| 19 | - */ |
|
| 20 | - public static function required() |
|
| 21 | - { |
|
| 22 | - return [ |
|
| 23 | - 'is_multi' => true, |
|
| 24 | - ]; |
|
| 25 | - } |
|
| 17 | + /** |
|
| 18 | + * @return array |
|
| 19 | + */ |
|
| 20 | + public static function required() |
|
| 21 | + { |
|
| 22 | + return [ |
|
| 23 | + 'is_multi' => true, |
|
| 24 | + ]; |
|
| 25 | + } |
|
| 26 | 26 | } |
@@ -6,73 +6,73 @@ |
||
| 6 | 6 | |
| 7 | 7 | abstract class Field |
| 8 | 8 | { |
| 9 | - /** |
|
| 10 | - * @var Builder |
|
| 11 | - */ |
|
| 12 | - protected $builder; |
|
| 9 | + /** |
|
| 10 | + * @var Builder |
|
| 11 | + */ |
|
| 12 | + protected $builder; |
|
| 13 | 13 | |
| 14 | - public function __construct(Builder $builder) |
|
| 15 | - { |
|
| 16 | - $this->builder = $builder; |
|
| 17 | - } |
|
| 14 | + public function __construct(Builder $builder) |
|
| 15 | + { |
|
| 16 | + $this->builder = $builder; |
|
| 17 | + } |
|
| 18 | 18 | |
| 19 | - /** |
|
| 20 | - * @return string|void |
|
| 21 | - */ |
|
| 22 | - public function build() |
|
| 23 | - { |
|
| 24 | - glsr_log()->error('Build method is not implemented for '.get_class($this)); |
|
| 25 | - } |
|
| 19 | + /** |
|
| 20 | + * @return string|void |
|
| 21 | + */ |
|
| 22 | + public function build() |
|
| 23 | + { |
|
| 24 | + glsr_log()->error('Build method is not implemented for '.get_class($this)); |
|
| 25 | + } |
|
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * @return array |
|
| 29 | - */ |
|
| 30 | - public static function defaults() |
|
| 31 | - { |
|
| 32 | - return []; |
|
| 33 | - } |
|
| 27 | + /** |
|
| 28 | + * @return array |
|
| 29 | + */ |
|
| 30 | + public static function defaults() |
|
| 31 | + { |
|
| 32 | + return []; |
|
| 33 | + } |
|
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * @return array |
|
| 37 | - */ |
|
| 38 | - public static function merge(array $args) |
|
| 39 | - { |
|
| 40 | - $merged = array_merge( |
|
| 41 | - wp_parse_args($args, static::defaults()), |
|
| 42 | - static::required() |
|
| 43 | - ); |
|
| 44 | - $merged['class'] = implode(' ', static::mergedAttribute('class', ' ', $args)); |
|
| 45 | - $merged['style'] = implode(';', static::mergedAttribute('style', ';', $args)); |
|
| 46 | - return $merged; |
|
| 47 | - } |
|
| 35 | + /** |
|
| 36 | + * @return array |
|
| 37 | + */ |
|
| 38 | + public static function merge(array $args) |
|
| 39 | + { |
|
| 40 | + $merged = array_merge( |
|
| 41 | + wp_parse_args($args, static::defaults()), |
|
| 42 | + static::required() |
|
| 43 | + ); |
|
| 44 | + $merged['class'] = implode(' ', static::mergedAttribute('class', ' ', $args)); |
|
| 45 | + $merged['style'] = implode(';', static::mergedAttribute('style', ';', $args)); |
|
| 46 | + return $merged; |
|
| 47 | + } |
|
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * @param string $delimiter |
|
| 51 | - * @param string $key |
|
| 52 | - * @return array |
|
| 53 | - */ |
|
| 54 | - public static function mergedAttribute($key, $delimiter, array $args) |
|
| 55 | - { |
|
| 56 | - return array_filter(array_merge( |
|
| 57 | - explode($delimiter, glsr_get($args, $key)), |
|
| 58 | - explode($delimiter, glsr_get(static::defaults(), $key)), |
|
| 59 | - explode($delimiter, glsr_get(static::required(), $key)) |
|
| 60 | - )); |
|
| 61 | - } |
|
| 49 | + /** |
|
| 50 | + * @param string $delimiter |
|
| 51 | + * @param string $key |
|
| 52 | + * @return array |
|
| 53 | + */ |
|
| 54 | + public static function mergedAttribute($key, $delimiter, array $args) |
|
| 55 | + { |
|
| 56 | + return array_filter(array_merge( |
|
| 57 | + explode($delimiter, glsr_get($args, $key)), |
|
| 58 | + explode($delimiter, glsr_get(static::defaults(), $key)), |
|
| 59 | + explode($delimiter, glsr_get(static::required(), $key)) |
|
| 60 | + )); |
|
| 61 | + } |
|
| 62 | 62 | |
| 63 | - /** |
|
| 64 | - * @return array |
|
| 65 | - */ |
|
| 66 | - public static function required() |
|
| 67 | - { |
|
| 68 | - return []; |
|
| 69 | - } |
|
| 63 | + /** |
|
| 64 | + * @return array |
|
| 65 | + */ |
|
| 66 | + public static function required() |
|
| 67 | + { |
|
| 68 | + return []; |
|
| 69 | + } |
|
| 70 | 70 | |
| 71 | - /** |
|
| 72 | - * @return void |
|
| 73 | - */ |
|
| 74 | - protected function mergeFieldArgs() |
|
| 75 | - { |
|
| 76 | - $this->builder->args = static::merge($this->builder->args); |
|
| 77 | - } |
|
| 71 | + /** |
|
| 72 | + * @return void |
|
| 73 | + */ |
|
| 74 | + protected function mergeFieldArgs() |
|
| 75 | + { |
|
| 76 | + $this->builder->args = static::merge($this->builder->args); |
|
| 77 | + } |
|
| 78 | 78 | } |
@@ -6,29 +6,29 @@ |
||
| 6 | 6 | |
| 7 | 7 | class Rating extends Field |
| 8 | 8 | { |
| 9 | - /** |
|
| 10 | - * @return string|void |
|
| 11 | - */ |
|
| 12 | - public function build() |
|
| 13 | - { |
|
| 14 | - $this->builder->tag = 'select'; |
|
| 15 | - $this->mergeFieldArgs(); |
|
| 16 | - return $this->builder->getTag(); |
|
| 17 | - } |
|
| 9 | + /** |
|
| 10 | + * @return string|void |
|
| 11 | + */ |
|
| 12 | + public function build() |
|
| 13 | + { |
|
| 14 | + $this->builder->tag = 'select'; |
|
| 15 | + $this->mergeFieldArgs(); |
|
| 16 | + return $this->builder->getTag(); |
|
| 17 | + } |
|
| 18 | 18 | |
| 19 | - /** |
|
| 20 | - * @return array |
|
| 21 | - */ |
|
| 22 | - public static function required() |
|
| 23 | - { |
|
| 24 | - $options = ['' => __('Select a Rating', 'site-reviews')]; |
|
| 25 | - foreach (range(glsr()->constant('MAX_RATING', RatingModule::class), 1) as $rating) { |
|
| 26 | - $options[$rating] = sprintf(_n('%s Star', '%s Stars', $rating, 'site-reviews'), $rating); |
|
| 27 | - } |
|
| 28 | - return [ |
|
| 29 | - 'class' => 'glsr-star-rating', |
|
| 30 | - 'options' => $options, |
|
| 31 | - 'type' => 'select', |
|
| 32 | - ]; |
|
| 33 | - } |
|
| 19 | + /** |
|
| 20 | + * @return array |
|
| 21 | + */ |
|
| 22 | + public static function required() |
|
| 23 | + { |
|
| 24 | + $options = ['' => __('Select a Rating', 'site-reviews')]; |
|
| 25 | + foreach (range(glsr()->constant('MAX_RATING', RatingModule::class), 1) as $rating) { |
|
| 26 | + $options[$rating] = sprintf(_n('%s Star', '%s Stars', $rating, 'site-reviews'), $rating); |
|
| 27 | + } |
|
| 28 | + return [ |
|
| 29 | + 'class' => 'glsr-star-rating', |
|
| 30 | + 'options' => $options, |
|
| 31 | + 'type' => 'select', |
|
| 32 | + ]; |
|
| 33 | + } |
|
| 34 | 34 | } |
@@ -6,30 +6,30 @@ |
||
| 6 | 6 | |
| 7 | 7 | class Partial |
| 8 | 8 | { |
| 9 | - /** |
|
| 10 | - * @param string $partialPath |
|
| 11 | - * @return string |
|
| 12 | - */ |
|
| 13 | - public function build($partialPath, array $args = []) |
|
| 14 | - { |
|
| 15 | - $className = glsr(Helper::class)->buildClassName($partialPath, 'Modules\Html\Partials'); |
|
| 16 | - if (!class_exists($className)) { |
|
| 17 | - glsr_log()->error('Partial missing: '.$className); |
|
| 18 | - return; |
|
| 19 | - } |
|
| 20 | - $args = apply_filters('site-reviews/partial/args/'.$partialPath, $args); |
|
| 21 | - $partial = glsr($className)->build($args); |
|
| 22 | - $partial = apply_filters('site-reviews/rendered/partial', $partial, $partialPath, $args); |
|
| 23 | - $partial = apply_filters('site-reviews/rendered/partial/'.$partialPath, $partial, $args); |
|
| 24 | - return $partial; |
|
| 25 | - } |
|
| 9 | + /** |
|
| 10 | + * @param string $partialPath |
|
| 11 | + * @return string |
|
| 12 | + */ |
|
| 13 | + public function build($partialPath, array $args = []) |
|
| 14 | + { |
|
| 15 | + $className = glsr(Helper::class)->buildClassName($partialPath, 'Modules\Html\Partials'); |
|
| 16 | + if (!class_exists($className)) { |
|
| 17 | + glsr_log()->error('Partial missing: '.$className); |
|
| 18 | + return; |
|
| 19 | + } |
|
| 20 | + $args = apply_filters('site-reviews/partial/args/'.$partialPath, $args); |
|
| 21 | + $partial = glsr($className)->build($args); |
|
| 22 | + $partial = apply_filters('site-reviews/rendered/partial', $partial, $partialPath, $args); |
|
| 23 | + $partial = apply_filters('site-reviews/rendered/partial/'.$partialPath, $partial, $args); |
|
| 24 | + return $partial; |
|
| 25 | + } |
|
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * @param string $partialPath |
|
| 29 | - * @return void |
|
| 30 | - */ |
|
| 31 | - public function render($partialPath, array $args = []) |
|
| 32 | - { |
|
| 33 | - echo $this->build($partialPath, $args); |
|
| 34 | - } |
|
| 27 | + /** |
|
| 28 | + * @param string $partialPath |
|
| 29 | + * @return void |
|
| 30 | + */ |
|
| 31 | + public function render($partialPath, array $args = []) |
|
| 32 | + { |
|
| 33 | + echo $this->build($partialPath, $args); |
|
| 34 | + } |
|
| 35 | 35 | } |
@@ -4,36 +4,36 @@ |
||
| 4 | 4 | |
| 5 | 5 | class Form |
| 6 | 6 | { |
| 7 | - /** |
|
| 8 | - * @param string $id |
|
| 9 | - * @return string |
|
| 10 | - */ |
|
| 11 | - public function buildFields($id) |
|
| 12 | - { |
|
| 13 | - return array_reduce($this->getFields($id), function ($carry, $field) { |
|
| 14 | - return $carry.$field; |
|
| 15 | - }); |
|
| 16 | - } |
|
| 7 | + /** |
|
| 8 | + * @param string $id |
|
| 9 | + * @return string |
|
| 10 | + */ |
|
| 11 | + public function buildFields($id) |
|
| 12 | + { |
|
| 13 | + return array_reduce($this->getFields($id), function ($carry, $field) { |
|
| 14 | + return $carry.$field; |
|
| 15 | + }); |
|
| 16 | + } |
|
| 17 | 17 | |
| 18 | - /** |
|
| 19 | - * @param string $id |
|
| 20 | - * @return array |
|
| 21 | - */ |
|
| 22 | - public function getFields($id) |
|
| 23 | - { |
|
| 24 | - $fields = []; |
|
| 25 | - foreach (glsr()->config('forms/'.$id) as $name => $field) { |
|
| 26 | - $fields[] = new Field(wp_parse_args($field, ['name' => $name])); |
|
| 27 | - } |
|
| 28 | - return $fields; |
|
| 29 | - } |
|
| 18 | + /** |
|
| 19 | + * @param string $id |
|
| 20 | + * @return array |
|
| 21 | + */ |
|
| 22 | + public function getFields($id) |
|
| 23 | + { |
|
| 24 | + $fields = []; |
|
| 25 | + foreach (glsr()->config('forms/'.$id) as $name => $field) { |
|
| 26 | + $fields[] = new Field(wp_parse_args($field, ['name' => $name])); |
|
| 27 | + } |
|
| 28 | + return $fields; |
|
| 29 | + } |
|
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * @param string $id |
|
| 33 | - * @return void |
|
| 34 | - */ |
|
| 35 | - public function renderFields($id) |
|
| 36 | - { |
|
| 37 | - echo $this->buildFields($id); |
|
| 38 | - } |
|
| 31 | + /** |
|
| 32 | + * @param string $id |
|
| 33 | + * @return void |
|
| 34 | + */ |
|
| 35 | + public function renderFields($id) |
|
| 36 | + { |
|
| 37 | + echo $this->buildFields($id); |
|
| 38 | + } |
|
| 39 | 39 | } |
@@ -6,17 +6,17 @@ |
||
| 6 | 6 | |
| 7 | 7 | class StarRating implements PartialContract |
| 8 | 8 | { |
| 9 | - /** |
|
| 10 | - * @return void|string |
|
| 11 | - */ |
|
| 12 | - public function build(array $args = []) |
|
| 13 | - { |
|
| 14 | - require_once ABSPATH.'wp-admin/includes/template.php'; |
|
| 15 | - ob_start(); |
|
| 16 | - wp_star_rating($args); |
|
| 17 | - $stars = ob_get_clean(); |
|
| 18 | - return !glsr()->isAdmin() |
|
| 19 | - ? str_replace(['star-rating', 'star star'], ['glsr-stars', 'glsr-star glsr-star'], $stars) |
|
| 20 | - : $stars; |
|
| 21 | - } |
|
| 9 | + /** |
|
| 10 | + * @return void|string |
|
| 11 | + */ |
|
| 12 | + public function build(array $args = []) |
|
| 13 | + { |
|
| 14 | + require_once ABSPATH.'wp-admin/includes/template.php'; |
|
| 15 | + ob_start(); |
|
| 16 | + wp_star_rating($args); |
|
| 17 | + $stars = ob_get_clean(); |
|
| 18 | + return !glsr()->isAdmin() |
|
| 19 | + ? str_replace(['star-rating', 'star star'], ['glsr-stars', 'glsr-star glsr-star'], $stars) |
|
| 20 | + : $stars; |
|
| 21 | + } |
|
| 22 | 22 | } |
@@ -10,191 +10,191 @@ |
||
| 10 | 10 | |
| 11 | 11 | class SiteReviewsSummary |
| 12 | 12 | { |
| 13 | - /** |
|
| 14 | - * @var array |
|
| 15 | - */ |
|
| 16 | - protected $args; |
|
| 17 | - |
|
| 18 | - /** |
|
| 19 | - * @var float |
|
| 20 | - */ |
|
| 21 | - protected $averageRating; |
|
| 22 | - |
|
| 23 | - /** |
|
| 24 | - * @var array |
|
| 25 | - */ |
|
| 26 | - protected $ratingCounts; |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * @return void|string |
|
| 30 | - */ |
|
| 31 | - public function build(array $args = []) |
|
| 32 | - { |
|
| 33 | - $this->args = $args; |
|
| 34 | - $this->ratingCounts = glsr(ReviewManager::class)->getRatingCounts($args); |
|
| 35 | - if (!array_sum($this->ratingCounts) && $this->isHidden('if_empty')) { |
|
| 36 | - return; |
|
| 37 | - } |
|
| 38 | - $this->averageRating = glsr(Rating::class)->getAverage($this->ratingCounts); |
|
| 39 | - $this->generateSchema(); |
|
| 40 | - return glsr(Template::class)->build('templates/reviews-summary', [ |
|
| 41 | - 'context' => [ |
|
| 42 | - 'assigned_to' => $this->args['assigned_to'], |
|
| 43 | - 'category' => $this->args['category'], |
|
| 44 | - 'class' => $this->getClass(), |
|
| 45 | - 'id' => $this->args['id'], |
|
| 46 | - 'percentages' => $this->buildPercentage(), |
|
| 47 | - 'rating' => $this->buildRating(), |
|
| 48 | - 'stars' => $this->buildStars(), |
|
| 49 | - 'text' => $this->buildText(), |
|
| 50 | - ], |
|
| 51 | - ]); |
|
| 52 | - } |
|
| 53 | - |
|
| 54 | - /** |
|
| 55 | - * @return void|string |
|
| 56 | - */ |
|
| 57 | - protected function buildPercentage() |
|
| 58 | - { |
|
| 59 | - if ($this->isHidden('bars')) { |
|
| 60 | - return; |
|
| 61 | - } |
|
| 62 | - $percentages = preg_filter('/$/', '%', glsr(Rating::class)->getPercentages($this->ratingCounts)); |
|
| 63 | - $bars = array_reduce(range(glsr()->constant('MAX_RATING', Rating::class), 1), function ($carry, $level) use ($percentages) { |
|
| 64 | - $label = $this->buildPercentageLabel($this->args['labels'][$level]); |
|
| 65 | - $background = $this->buildPercentageBackground($percentages[$level]); |
|
| 66 | - $count = apply_filters('site-reviews/summary/counts', |
|
| 67 | - $percentages[$level], |
|
| 68 | - $this->ratingCounts[$level] |
|
| 69 | - ); |
|
| 70 | - $percent = $this->buildPercentageCount($count); |
|
| 71 | - return $carry.glsr(Builder::class)->div($label.$background.$percent, [ |
|
| 72 | - 'class' => 'glsr-bar', |
|
| 73 | - ]); |
|
| 74 | - }); |
|
| 75 | - return $this->wrap('percentage', $bars); |
|
| 76 | - } |
|
| 77 | - |
|
| 78 | - /** |
|
| 79 | - * @param string $percent |
|
| 80 | - * @return string |
|
| 81 | - */ |
|
| 82 | - protected function buildPercentageBackground($percent) |
|
| 83 | - { |
|
| 84 | - $backgroundPercent = glsr(Builder::class)->span([ |
|
| 85 | - 'class' => 'glsr-bar-background-percent', |
|
| 86 | - 'style' => 'width:'.$percent, |
|
| 87 | - ]); |
|
| 88 | - return '<span class="glsr-bar-background">'.$backgroundPercent.'</span>'; |
|
| 89 | - } |
|
| 90 | - |
|
| 91 | - /** |
|
| 92 | - * @param string $count |
|
| 93 | - * @return string |
|
| 94 | - */ |
|
| 95 | - protected function buildPercentageCount($count) |
|
| 96 | - { |
|
| 97 | - return '<span class="glsr-bar-percent">'.$count.'</span>'; |
|
| 98 | - } |
|
| 99 | - |
|
| 100 | - /** |
|
| 101 | - * @param string $label |
|
| 102 | - * @return string |
|
| 103 | - */ |
|
| 104 | - protected function buildPercentageLabel($label) |
|
| 105 | - { |
|
| 106 | - return '<span class="glsr-bar-label">'.$label.'</span>'; |
|
| 107 | - } |
|
| 108 | - |
|
| 109 | - /** |
|
| 110 | - * @return void|string |
|
| 111 | - */ |
|
| 112 | - protected function buildRating() |
|
| 113 | - { |
|
| 114 | - if ($this->isHidden('rating')) { |
|
| 115 | - return; |
|
| 116 | - } |
|
| 117 | - return $this->wrap('rating', '<span>'.$this->averageRating.'</span>'); |
|
| 118 | - } |
|
| 119 | - |
|
| 120 | - /** |
|
| 121 | - * @return void|string |
|
| 122 | - */ |
|
| 123 | - protected function buildStars() |
|
| 124 | - { |
|
| 125 | - if ($this->isHidden('stars')) { |
|
| 126 | - return; |
|
| 127 | - } |
|
| 128 | - $stars = glsr_star_rating($this->averageRating); |
|
| 129 | - return $this->wrap('stars', $stars); |
|
| 130 | - } |
|
| 131 | - |
|
| 132 | - /** |
|
| 133 | - * @return void|string |
|
| 134 | - */ |
|
| 135 | - protected function buildText() |
|
| 136 | - { |
|
| 137 | - if ($this->isHidden('summary')) { |
|
| 138 | - return; |
|
| 139 | - } |
|
| 140 | - $count = intval(array_sum($this->ratingCounts)); |
|
| 141 | - if (empty($this->args['text'])) { |
|
| 142 | - // @todo document this change |
|
| 143 | - $this->args['text'] = _nx( |
|
| 144 | - '{rating} out of {max} stars (based on {num} review)', |
|
| 145 | - '{rating} out of {max} stars (based on {num} reviews)', |
|
| 146 | - $count, |
|
| 147 | - 'Do not translate {rating}, {max}, and {num}, they are template tags.', |
|
| 148 | - 'site-reviews' |
|
| 149 | - ); |
|
| 150 | - } |
|
| 151 | - $summary = str_replace( |
|
| 152 | - ['{rating}', '{max}', '{num}'], |
|
| 153 | - [$this->averageRating, glsr()->constant('MAX_RATING', Rating::class), $count], |
|
| 154 | - $this->args['text'] |
|
| 155 | - ); |
|
| 156 | - return $this->wrap('text', '<span>'.$summary.'</span>'); |
|
| 157 | - } |
|
| 158 | - |
|
| 159 | - /** |
|
| 160 | - * @return void |
|
| 161 | - */ |
|
| 162 | - protected function generateSchema() |
|
| 163 | - { |
|
| 164 | - if (!wp_validate_boolean($this->args['schema'])) { |
|
| 165 | - return; |
|
| 166 | - } |
|
| 167 | - glsr(Schema::class)->store( |
|
| 168 | - glsr(Schema::class)->buildSummary($this->args) |
|
| 169 | - ); |
|
| 170 | - } |
|
| 171 | - |
|
| 172 | - /** |
|
| 173 | - * @return string |
|
| 174 | - */ |
|
| 175 | - protected function getClass() |
|
| 176 | - { |
|
| 177 | - return trim('glsr-summary glsr-default '.$this->args['class']); |
|
| 178 | - } |
|
| 179 | - |
|
| 180 | - /** |
|
| 181 | - * @param string $key |
|
| 182 | - * @return bool |
|
| 183 | - */ |
|
| 184 | - protected function isHidden($key) |
|
| 185 | - { |
|
| 186 | - return in_array($key, $this->args['hide']); |
|
| 187 | - } |
|
| 188 | - |
|
| 189 | - /** |
|
| 190 | - * @param string $key |
|
| 191 | - * @param string $value |
|
| 192 | - * @return string |
|
| 193 | - */ |
|
| 194 | - protected function wrap($key, $value) |
|
| 195 | - { |
|
| 196 | - return glsr(Builder::class)->div($value, [ |
|
| 197 | - 'class' => 'glsr-summary-'.$key, |
|
| 198 | - ]); |
|
| 199 | - } |
|
| 13 | + /** |
|
| 14 | + * @var array |
|
| 15 | + */ |
|
| 16 | + protected $args; |
|
| 17 | + |
|
| 18 | + /** |
|
| 19 | + * @var float |
|
| 20 | + */ |
|
| 21 | + protected $averageRating; |
|
| 22 | + |
|
| 23 | + /** |
|
| 24 | + * @var array |
|
| 25 | + */ |
|
| 26 | + protected $ratingCounts; |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * @return void|string |
|
| 30 | + */ |
|
| 31 | + public function build(array $args = []) |
|
| 32 | + { |
|
| 33 | + $this->args = $args; |
|
| 34 | + $this->ratingCounts = glsr(ReviewManager::class)->getRatingCounts($args); |
|
| 35 | + if (!array_sum($this->ratingCounts) && $this->isHidden('if_empty')) { |
|
| 36 | + return; |
|
| 37 | + } |
|
| 38 | + $this->averageRating = glsr(Rating::class)->getAverage($this->ratingCounts); |
|
| 39 | + $this->generateSchema(); |
|
| 40 | + return glsr(Template::class)->build('templates/reviews-summary', [ |
|
| 41 | + 'context' => [ |
|
| 42 | + 'assigned_to' => $this->args['assigned_to'], |
|
| 43 | + 'category' => $this->args['category'], |
|
| 44 | + 'class' => $this->getClass(), |
|
| 45 | + 'id' => $this->args['id'], |
|
| 46 | + 'percentages' => $this->buildPercentage(), |
|
| 47 | + 'rating' => $this->buildRating(), |
|
| 48 | + 'stars' => $this->buildStars(), |
|
| 49 | + 'text' => $this->buildText(), |
|
| 50 | + ], |
|
| 51 | + ]); |
|
| 52 | + } |
|
| 53 | + |
|
| 54 | + /** |
|
| 55 | + * @return void|string |
|
| 56 | + */ |
|
| 57 | + protected function buildPercentage() |
|
| 58 | + { |
|
| 59 | + if ($this->isHidden('bars')) { |
|
| 60 | + return; |
|
| 61 | + } |
|
| 62 | + $percentages = preg_filter('/$/', '%', glsr(Rating::class)->getPercentages($this->ratingCounts)); |
|
| 63 | + $bars = array_reduce(range(glsr()->constant('MAX_RATING', Rating::class), 1), function ($carry, $level) use ($percentages) { |
|
| 64 | + $label = $this->buildPercentageLabel($this->args['labels'][$level]); |
|
| 65 | + $background = $this->buildPercentageBackground($percentages[$level]); |
|
| 66 | + $count = apply_filters('site-reviews/summary/counts', |
|
| 67 | + $percentages[$level], |
|
| 68 | + $this->ratingCounts[$level] |
|
| 69 | + ); |
|
| 70 | + $percent = $this->buildPercentageCount($count); |
|
| 71 | + return $carry.glsr(Builder::class)->div($label.$background.$percent, [ |
|
| 72 | + 'class' => 'glsr-bar', |
|
| 73 | + ]); |
|
| 74 | + }); |
|
| 75 | + return $this->wrap('percentage', $bars); |
|
| 76 | + } |
|
| 77 | + |
|
| 78 | + /** |
|
| 79 | + * @param string $percent |
|
| 80 | + * @return string |
|
| 81 | + */ |
|
| 82 | + protected function buildPercentageBackground($percent) |
|
| 83 | + { |
|
| 84 | + $backgroundPercent = glsr(Builder::class)->span([ |
|
| 85 | + 'class' => 'glsr-bar-background-percent', |
|
| 86 | + 'style' => 'width:'.$percent, |
|
| 87 | + ]); |
|
| 88 | + return '<span class="glsr-bar-background">'.$backgroundPercent.'</span>'; |
|
| 89 | + } |
|
| 90 | + |
|
| 91 | + /** |
|
| 92 | + * @param string $count |
|
| 93 | + * @return string |
|
| 94 | + */ |
|
| 95 | + protected function buildPercentageCount($count) |
|
| 96 | + { |
|
| 97 | + return '<span class="glsr-bar-percent">'.$count.'</span>'; |
|
| 98 | + } |
|
| 99 | + |
|
| 100 | + /** |
|
| 101 | + * @param string $label |
|
| 102 | + * @return string |
|
| 103 | + */ |
|
| 104 | + protected function buildPercentageLabel($label) |
|
| 105 | + { |
|
| 106 | + return '<span class="glsr-bar-label">'.$label.'</span>'; |
|
| 107 | + } |
|
| 108 | + |
|
| 109 | + /** |
|
| 110 | + * @return void|string |
|
| 111 | + */ |
|
| 112 | + protected function buildRating() |
|
| 113 | + { |
|
| 114 | + if ($this->isHidden('rating')) { |
|
| 115 | + return; |
|
| 116 | + } |
|
| 117 | + return $this->wrap('rating', '<span>'.$this->averageRating.'</span>'); |
|
| 118 | + } |
|
| 119 | + |
|
| 120 | + /** |
|
| 121 | + * @return void|string |
|
| 122 | + */ |
|
| 123 | + protected function buildStars() |
|
| 124 | + { |
|
| 125 | + if ($this->isHidden('stars')) { |
|
| 126 | + return; |
|
| 127 | + } |
|
| 128 | + $stars = glsr_star_rating($this->averageRating); |
|
| 129 | + return $this->wrap('stars', $stars); |
|
| 130 | + } |
|
| 131 | + |
|
| 132 | + /** |
|
| 133 | + * @return void|string |
|
| 134 | + */ |
|
| 135 | + protected function buildText() |
|
| 136 | + { |
|
| 137 | + if ($this->isHidden('summary')) { |
|
| 138 | + return; |
|
| 139 | + } |
|
| 140 | + $count = intval(array_sum($this->ratingCounts)); |
|
| 141 | + if (empty($this->args['text'])) { |
|
| 142 | + // @todo document this change |
|
| 143 | + $this->args['text'] = _nx( |
|
| 144 | + '{rating} out of {max} stars (based on {num} review)', |
|
| 145 | + '{rating} out of {max} stars (based on {num} reviews)', |
|
| 146 | + $count, |
|
| 147 | + 'Do not translate {rating}, {max}, and {num}, they are template tags.', |
|
| 148 | + 'site-reviews' |
|
| 149 | + ); |
|
| 150 | + } |
|
| 151 | + $summary = str_replace( |
|
| 152 | + ['{rating}', '{max}', '{num}'], |
|
| 153 | + [$this->averageRating, glsr()->constant('MAX_RATING', Rating::class), $count], |
|
| 154 | + $this->args['text'] |
|
| 155 | + ); |
|
| 156 | + return $this->wrap('text', '<span>'.$summary.'</span>'); |
|
| 157 | + } |
|
| 158 | + |
|
| 159 | + /** |
|
| 160 | + * @return void |
|
| 161 | + */ |
|
| 162 | + protected function generateSchema() |
|
| 163 | + { |
|
| 164 | + if (!wp_validate_boolean($this->args['schema'])) { |
|
| 165 | + return; |
|
| 166 | + } |
|
| 167 | + glsr(Schema::class)->store( |
|
| 168 | + glsr(Schema::class)->buildSummary($this->args) |
|
| 169 | + ); |
|
| 170 | + } |
|
| 171 | + |
|
| 172 | + /** |
|
| 173 | + * @return string |
|
| 174 | + */ |
|
| 175 | + protected function getClass() |
|
| 176 | + { |
|
| 177 | + return trim('glsr-summary glsr-default '.$this->args['class']); |
|
| 178 | + } |
|
| 179 | + |
|
| 180 | + /** |
|
| 181 | + * @param string $key |
|
| 182 | + * @return bool |
|
| 183 | + */ |
|
| 184 | + protected function isHidden($key) |
|
| 185 | + { |
|
| 186 | + return in_array($key, $this->args['hide']); |
|
| 187 | + } |
|
| 188 | + |
|
| 189 | + /** |
|
| 190 | + * @param string $key |
|
| 191 | + * @param string $value |
|
| 192 | + * @return string |
|
| 193 | + */ |
|
| 194 | + protected function wrap($key, $value) |
|
| 195 | + { |
|
| 196 | + return glsr(Builder::class)->div($value, [ |
|
| 197 | + 'class' => 'glsr-summary-'.$key, |
|
| 198 | + ]); |
|
| 199 | + } |
|
| 200 | 200 | } |