pryley / site-reviews

plugin/Modules/Schema.php

Indentation +271 added lines, -271 removed lines

@@ -12,295 +12,295 @@
 
 class Schema
 {
-    /**
-     * @var array
-     */
-    protected $args;
+	/**
+	 * @var array
+	 */
+	protected $args;
 
-    /**
-     * @var array
-     */
-    protected $ratingCounts;
+	/**
+	 * @var array
+	 */
+	protected $ratingCounts;
 
-    /**
-     * @return array
-     */
-    public function build(array $args = [])
-    {
-        $this->args = $args;
-        $schema = $this->buildSummary($args);
-        $reviews = [];
-        foreach (glsr(ReviewManager::class)->get($this->args) as $review) {
-            // Only include critic reviews that have been directly produced by your site, not reviews from third-party sites or syndicated reviews.
-            // @see https://developers.google.com/search/docs/data-types/review
-            if ('local' != $review->review_type) {
-                continue;
-            }
-            $reviews[] = $this->buildReview($review);
-        }
-        if (!empty($reviews)) {
-            array_walk($reviews, function (&$review) {
-                unset($review['@context']);
-                unset($review['itemReviewed']);
-            });
-            $schema['review'] = $reviews;
-        }
-        return $schema;
-    }
+	/**
+	 * @return array
+	 */
+	public function build(array $args = [])
+	{
+		$this->args = $args;
+		$schema = $this->buildSummary($args);
+		$reviews = [];
+		foreach (glsr(ReviewManager::class)->get($this->args) as $review) {
+			// Only include critic reviews that have been directly produced by your site, not reviews from third-party sites or syndicated reviews.
+			// @see https://developers.google.com/search/docs/data-types/review
+			if ('local' != $review->review_type) {
+				continue;
+			}
+			$reviews[] = $this->buildReview($review);
+		}
+		if (!empty($reviews)) {
+			array_walk($reviews, function (&$review) {
+				unset($review['@context']);
+				unset($review['itemReviewed']);
+			});
+			$schema['review'] = $reviews;
+		}
+		return $schema;
+	}
 
-    /**
-     * @param array|null $args
-     * @return array
-     */
-    public function buildSummary($args = null)
-    {
-        if (is_array($args)) {
-            $this->args = $args;
-        }
-        $buildSummary = glsr(Helper::class)->buildMethodName($this->getSchemaOptionValue('type'), 'buildSummaryFor');
-        $count = array_sum($this->getRatingCounts());
-        $schema = method_exists($this, $buildSummary)
-            ? $this->$buildSummary()
-            : $this->buildSummaryForCustom();
-        if (!empty($count)) {
-            $schema->aggregateRating(
-                $this->getSchemaType('AggregateRating')
-                    ->ratingValue($this->getRatingValue())
-                    ->reviewCount($count)
-                    ->bestRating(glsr()->constant('MAX_RATING', Rating::class))
-                    ->worstRating(glsr()->constant('MIN_RATING', Rating::class))
-            );
-        }
-        $schema = $schema->toArray();
-        return apply_filters('site-reviews/schema/'.$schema['@type'], $schema, $args);
-    }
+	/**
+	 * @param array|null $args
+	 * @return array
+	 */
+	public function buildSummary($args = null)
+	{
+		if (is_array($args)) {
+			$this->args = $args;
+		}
+		$buildSummary = glsr(Helper::class)->buildMethodName($this->getSchemaOptionValue('type'), 'buildSummaryFor');
+		$count = array_sum($this->getRatingCounts());
+		$schema = method_exists($this, $buildSummary)
+			? $this->$buildSummary()
+			: $this->buildSummaryForCustom();
+		if (!empty($count)) {
+			$schema->aggregateRating(
+				$this->getSchemaType('AggregateRating')
+					->ratingValue($this->getRatingValue())
+					->reviewCount($count)
+					->bestRating(glsr()->constant('MAX_RATING', Rating::class))
+					->worstRating(glsr()->constant('MIN_RATING', Rating::class))
+			);
+		}
+		$schema = $schema->toArray();
+		return apply_filters('site-reviews/schema/'.$schema['@type'], $schema, $args);
+	}
 
-    /**
-     * @return void
-     */
-    public function render()
-    {
-        if (empty(glsr()->schemas)) {
-            return;
-        }
-        printf('<script type="application/ld+json">%s</script>', json_encode(
-            apply_filters('site-reviews/schema/all', glsr()->schemas),
-            JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES
-        ));
-    }
+	/**
+	 * @return void
+	 */
+	public function render()
+	{
+		if (empty(glsr()->schemas)) {
+			return;
+		}
+		printf('<script type="application/ld+json">%s</script>', json_encode(
+			apply_filters('site-reviews/schema/all', glsr()->schemas),
+			JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES
+		));
+	}
 
-    /**
-     * @return void
-     */
-    public function store(array $schema)
-    {
-        $schemas = glsr()->schemas;
-        $schemas[] = $schema;
-        glsr()->schemas = array_map('unserialize', array_unique(array_map('serialize', $schemas)));
-    }
+	/**
+	 * @return void
+	 */
+	public function store(array $schema)
+	{
+		$schemas = glsr()->schemas;
+		$schemas[] = $schema;
+		glsr()->schemas = array_map('unserialize', array_unique(array_map('serialize', $schemas)));
+	}
 
-    /**
-     * @param Review $review
-     * @return array
-     */
-    protected function buildReview($review)
-    {
-        $schema = $this->getSchemaType('Review')
-            ->doIf(!in_array('title', $this->args['hide']), function ($schema) use ($review) {
-                $schema->name($review->title);
-            })
-            ->doIf(!in_array('excerpt', $this->args['hide']), function ($schema) use ($review) {
-                $schema->reviewBody($review->content);
-            })
-            ->datePublished(( new DateTime($review->date)))
-            ->author($this->getSchemaType('Person')->name($review->author))
-            ->itemReviewed($this->getSchemaType()->name($this->getSchemaOptionValue('name')));
-        if (!empty($review->rating)) {
-            $schema->reviewRating(
-                $this->getSchemaType('Rating')
-                    ->ratingValue($review->rating)
-                    ->bestRating(glsr()->constant('MAX_RATING', Rating::class))
-                    ->worstRating(glsr()->constant('MIN_RATING', Rating::class))
-            );
-        }
-        return apply_filters('site-reviews/schema/review', $schema->toArray(), $review, $this->args);
-    }
+	/**
+	 * @param Review $review
+	 * @return array
+	 */
+	protected function buildReview($review)
+	{
+		$schema = $this->getSchemaType('Review')
+			->doIf(!in_array('title', $this->args['hide']), function ($schema) use ($review) {
+				$schema->name($review->title);
+			})
+			->doIf(!in_array('excerpt', $this->args['hide']), function ($schema) use ($review) {
+				$schema->reviewBody($review->content);
+			})
+			->datePublished(( new DateTime($review->date)))
+			->author($this->getSchemaType('Person')->name($review->author))
+			->itemReviewed($this->getSchemaType()->name($this->getSchemaOptionValue('name')));
+		if (!empty($review->rating)) {
+			$schema->reviewRating(
+				$this->getSchemaType('Rating')
+					->ratingValue($review->rating)
+					->bestRating(glsr()->constant('MAX_RATING', Rating::class))
+					->worstRating(glsr()->constant('MIN_RATING', Rating::class))
+			);
+		}
+		return apply_filters('site-reviews/schema/review', $schema->toArray(), $review, $this->args);
+	}
 
-    /**
-     * @param mixed $schema
-     * @return mixed
-     */
-    protected function buildSchemaValues($schema, array $values = [])
-    {
-        foreach ($values as $value) {
-            $option = $this->getSchemaOptionValue($value);
-            if (empty($option)) {
-                continue;
-            }
-            $schema->$value($option);
-        }
-        return $schema;
-    }
+	/**
+	 * @param mixed $schema
+	 * @return mixed
+	 */
+	protected function buildSchemaValues($schema, array $values = [])
+	{
+		foreach ($values as $value) {
+			$option = $this->getSchemaOptionValue($value);
+			if (empty($option)) {
+				continue;
+			}
+			$schema->$value($option);
+		}
+		return $schema;
+	}
 
-    /**
-     * @return mixed
-     */
-    protected function buildSummaryForCustom()
-    {
-        return $this->buildSchemaValues($this->getSchemaType(), [
-            'description', 'image', 'name', 'url',
-        ]);
-    }
+	/**
+	 * @return mixed
+	 */
+	protected function buildSummaryForCustom()
+	{
+		return $this->buildSchemaValues($this->getSchemaType(), [
+			'description', 'image', 'name', 'url',
+		]);
+	}
 
-    /**
-     * @return mixed
-     */
-    protected function buildSummaryForLocalBusiness()
-    {
-        return $this->buildSchemaValues($this->buildSummaryForCustom(), [
-            'address', 'priceRange', 'telephone',
-        ]);
-    }
+	/**
+	 * @return mixed
+	 */
+	protected function buildSummaryForLocalBusiness()
+	{
+		return $this->buildSchemaValues($this->buildSummaryForCustom(), [
+			'address', 'priceRange', 'telephone',
+		]);
+	}
 
-    /**
-     * @return mixed
-     */
-    protected function buildSummaryForProduct()
-    {
-        $offerType = $this->getSchemaOption('offerType', 'AggregateOffer');
-        $offers = $this->buildSchemaValues($this->getSchemaType($offerType), [
-            'highPrice', 'lowPrice', 'price', 'priceCurrency',
-        ]);
-        return $this->buildSummaryForCustom()
-            ->doIf(!empty($offers->getProperties()), function ($schema) use ($offers) {
-                $schema->offers($offers);
-            })
-            ->setProperty('@id', $this->getSchemaOptionValue('url').'#product');
-    }
+	/**
+	 * @return mixed
+	 */
+	protected function buildSummaryForProduct()
+	{
+		$offerType = $this->getSchemaOption('offerType', 'AggregateOffer');
+		$offers = $this->buildSchemaValues($this->getSchemaType($offerType), [
+			'highPrice', 'lowPrice', 'price', 'priceCurrency',
+		]);
+		return $this->buildSummaryForCustom()
+			->doIf(!empty($offers->getProperties()), function ($schema) use ($offers) {
+				$schema->offers($offers);
+			})
+			->setProperty('@id', $this->getSchemaOptionValue('url').'#product');
+	}
 
-    /**
-     * @return array
-     */
-    protected function getRatingCounts()
-    {
-        if (!isset($this->ratingCounts)) {
-            $this->ratingCounts = glsr(ReviewManager::class)->getRatingCounts($this->args);
-        }
-        return $this->ratingCounts;
-    }
+	/**
+	 * @return array
+	 */
+	protected function getRatingCounts()
+	{
+		if (!isset($this->ratingCounts)) {
+			$this->ratingCounts = glsr(ReviewManager::class)->getRatingCounts($this->args);
+		}
+		return $this->ratingCounts;
+	}
 
-    /**
-     * @return int|float
-     */
-    protected function getRatingValue()
-    {
-        return glsr(Rating::class)->getAverage($this->getRatingCounts());
-    }
+	/**
+	 * @return int|float
+	 */
+	protected function getRatingValue()
+	{
+		return glsr(Rating::class)->getAverage($this->getRatingCounts());
+	}
 
-    /**
-     * @param string $option
-     * @param string $fallback
-     * @return string
-     */
-    protected function getSchemaOption($option, $fallback)
-    {
-        $option = strtolower($option);
-        if ($schemaOption = trim((string) get_post_meta(intval(get_the_ID()), 'schema_'.$option, true))) {
-            return $schemaOption;
-        }
-        $setting = glsr(OptionManager::class)->get('settings.schema.'.$option);
-        if (is_array($setting)) {
-            return $this->getSchemaOptionDefault($setting, $fallback);
-        }
-        return !empty($setting)
-            ? $setting
-            : $fallback;
-    }
+	/**
+	 * @param string $option
+	 * @param string $fallback
+	 * @return string
+	 */
+	protected function getSchemaOption($option, $fallback)
+	{
+		$option = strtolower($option);
+		if ($schemaOption = trim((string) get_post_meta(intval(get_the_ID()), 'schema_'.$option, true))) {
+			return $schemaOption;
+		}
+		$setting = glsr(OptionManager::class)->get('settings.schema.'.$option);
+		if (is_array($setting)) {
+			return $this->getSchemaOptionDefault($setting, $fallback);
+		}
+		return !empty($setting)
+			? $setting
+			: $fallback;
+	}
 
-    /**
-     * @param string $fallback
-     * @return string
-     */
-    protected function getSchemaOptionDefault(array $setting, $fallback)
-    {
-        $setting = wp_parse_args($setting, [
-            'custom' => '',
-            'default' => $fallback,
-        ]);
-        return 'custom' != $setting['default']
-            ? $setting['default']
-            : $setting['custom'];
-    }
+	/**
+	 * @param string $fallback
+	 * @return string
+	 */
+	protected function getSchemaOptionDefault(array $setting, $fallback)
+	{
+		$setting = wp_parse_args($setting, [
+			'custom' => '',
+			'default' => $fallback,
+		]);
+		return 'custom' != $setting['default']
+			? $setting['default']
+			: $setting['custom'];
+	}
 
-    /**
-     * @param string $option
-     * @param string $fallback
-     * @return void|string
-     */
-    protected function getSchemaOptionValue($option, $fallback = 'post')
-    {
-        $value = $this->getSchemaOption($option, $fallback);
-        if ($value != $fallback) {
-            return $value;
-        }
-        if (!is_single() && !is_page()) {
-            return;
-        }
-        $method = glsr(Helper::class)->buildMethodName($option, 'getThing');
-        if (method_exists($this, $method)) {
-            return $this->$method();
-        }
-    }
+	/**
+	 * @param string $option
+	 * @param string $fallback
+	 * @return void|string
+	 */
+	protected function getSchemaOptionValue($option, $fallback = 'post')
+	{
+		$value = $this->getSchemaOption($option, $fallback);
+		if ($value != $fallback) {
+			return $value;
+		}
+		if (!is_single() && !is_page()) {
+			return;
+		}
+		$method = glsr(Helper::class)->buildMethodName($option, 'getThing');
+		if (method_exists($this, $method)) {
+			return $this->$method();
+		}
+	}
 
-    /**
-     * @param string|null $type
-     * @return mixed
-     */
-    protected function getSchemaType($type = null)
-    {
-        if (!is_string($type)) {
-            $type = $this->getSchemaOption('type', 'LocalBusiness');
-        }
-        $className = glsr(Helper::class)->buildClassName($type, 'Modules\Schema');
-        return class_exists($className)
-            ? new $className()
-            : new UnknownType($type);
-    }
+	/**
+	 * @param string|null $type
+	 * @return mixed
+	 */
+	protected function getSchemaType($type = null)
+	{
+		if (!is_string($type)) {
+			$type = $this->getSchemaOption('type', 'LocalBusiness');
+		}
+		$className = glsr(Helper::class)->buildClassName($type, 'Modules\Schema');
+		return class_exists($className)
+			? new $className()
+			: new UnknownType($type);
+	}
 
-    /**
-     * @return string
-     */
-    protected function getThingDescription()
-    {
-        $post = get_post();
-        if (!($post instanceof WP_Post)) {
-            return '';
-        }
-        $text = strip_shortcodes(wp_strip_all_tags($post->post_excerpt));
-        return wp_trim_words($text, apply_filters('excerpt_length', 55));
-    }
+	/**
+	 * @return string
+	 */
+	protected function getThingDescription()
+	{
+		$post = get_post();
+		if (!($post instanceof WP_Post)) {
+			return '';
+		}
+		$text = strip_shortcodes(wp_strip_all_tags($post->post_excerpt));
+		return wp_trim_words($text, apply_filters('excerpt_length', 55));
+	}
 
-    /**
-     * @return string
-     */
-    protected function getThingImage()
-    {
-        return (string) get_the_post_thumbnail_url(null, 'large');
-    }
+	/**
+	 * @return string
+	 */
+	protected function getThingImage()
+	{
+		return (string) get_the_post_thumbnail_url(null, 'large');
+	}
 
-    /**
-     * @return string
-     */
-    protected function getThingName()
-    {
-        return get_the_title();
-    }
+	/**
+	 * @return string
+	 */
+	protected function getThingName()
+	{
+		return get_the_title();
+	}
 
-    /**
-     * @return string
-     */
-    protected function getThingUrl()
-    {
-        return (string) get_the_permalink();
-    }
+	/**
+	 * @return string
+	 */
+	protected function getThingUrl()
+	{
+		return (string) get_the_permalink();
+	}
 }

plugin/Modules/Validator/ValidationRules.php

Indentation +113 added lines, -113 removed lines

@@ -9,126 +9,126 @@
  */
 trait ValidationRules
 {
-    /**
-     * Get the size of an attribute.
-     * @param string $attribute
-     * @param mixed $value
-     * @return mixed
-     */
-    abstract protected function getSize($attribute, $value);
+	/**
+	 * Get the size of an attribute.
+	 * @param string $attribute
+	 * @param mixed $value
+	 * @return mixed
+	 */
+	abstract protected function getSize($attribute, $value);
 
-    /**
-     * Replace all placeholders.
-     * @param string $message
-     * @return string
-     */
-    protected function replace($message, array $parameters)
-    {
-        if (false === strpos($message, '%s')) {
-            return $message;
-        }
-        return preg_replace_callback('/(%s)/', function () use (&$parameters) {
-            foreach ($parameters as $key => $value) {
-                return array_shift($parameters);
-            }
-        }, $message);
-    }
+	/**
+	 * Replace all placeholders.
+	 * @param string $message
+	 * @return string
+	 */
+	protected function replace($message, array $parameters)
+	{
+		if (false === strpos($message, '%s')) {
+			return $message;
+		}
+		return preg_replace_callback('/(%s)/', function () use (&$parameters) {
+			foreach ($parameters as $key => $value) {
+				return array_shift($parameters);
+			}
+		}, $message);
+	}
 
-    /**
-     * Validate that an attribute was "accepted".
-     * This validation rule implies the attribute is "required".
-     * @param string $attribute
-     * @param mixed $value
-     * @return bool
-     */
-    public function validateAccepted($value)
-    {
-        $acceptable = ['yes', 'on', '1', 1, true, 'true'];
-        return $this->validateRequired($value) && in_array($value, $acceptable, true);
-    }
+	/**
+	 * Validate that an attribute was "accepted".
+	 * This validation rule implies the attribute is "required".
+	 * @param string $attribute
+	 * @param mixed $value
+	 * @return bool
+	 */
+	public function validateAccepted($value)
+	{
+		$acceptable = ['yes', 'on', '1', 1, true, 'true'];
+		return $this->validateRequired($value) && in_array($value, $acceptable, true);
+	}
 
-    /**
-     * Validate the size of an attribute is between a set of values.
-     * @param string $attribute
-     * @param mixed $value
-     * @return bool
-     */
-    public function validateBetween($value, $attribute, array $parameters)
-    {
-        $this->requireParameterCount(2, $parameters, 'between');
-        $size = $this->getSize($attribute, $value);
-        return $size >= $parameters[0] && $size <= $parameters[1];
-    }
+	/**
+	 * Validate the size of an attribute is between a set of values.
+	 * @param string $attribute
+	 * @param mixed $value
+	 * @return bool
+	 */
+	public function validateBetween($value, $attribute, array $parameters)
+	{
+		$this->requireParameterCount(2, $parameters, 'between');
+		$size = $this->getSize($attribute, $value);
+		return $size >= $parameters[0] && $size <= $parameters[1];
+	}
 
-    /**
-     * Validate that an attribute is a valid e-mail address.
-     * @param mixed $value
-     * @return bool
-     */
-    public function validateEmail($value)
-    {
-        return false !== filter_var($value, FILTER_VALIDATE_EMAIL);
-    }
+	/**
+	 * Validate that an attribute is a valid e-mail address.
+	 * @param mixed $value
+	 * @return bool
+	 */
+	public function validateEmail($value)
+	{
+		return false !== filter_var($value, FILTER_VALIDATE_EMAIL);
+	}
 
-    /**
-     * Validate the size of an attribute is less than a maximum value.
-     * @param string $attribute
-     * @param mixed $value
-     * @return bool
-     */
-    public function validateMax($value, $attribute, array $parameters)
-    {
-        $this->requireParameterCount(1, $parameters, 'max');
-        return $this->getSize($attribute, $value) <= $parameters[0];
-    }
+	/**
+	 * Validate the size of an attribute is less than a maximum value.
+	 * @param string $attribute
+	 * @param mixed $value
+	 * @return bool
+	 */
+	public function validateMax($value, $attribute, array $parameters)
+	{
+		$this->requireParameterCount(1, $parameters, 'max');
+		return $this->getSize($attribute, $value) <= $parameters[0];
+	}
 
-    /**
-     * Validate the size of an attribute is greater than a minimum value.
-     * @param string $attribute
-     * @param mixed $value
-     * @return bool
-     */
-    public function validateMin($value, $attribute, array $parameters)
-    {
-        $this->requireParameterCount(1, $parameters, 'min');
-        return $this->getSize($attribute, $value) >= $parameters[0];
-    }
+	/**
+	 * Validate the size of an attribute is greater than a minimum value.
+	 * @param string $attribute
+	 * @param mixed $value
+	 * @return bool
+	 */
+	public function validateMin($value, $attribute, array $parameters)
+	{
+		$this->requireParameterCount(1, $parameters, 'min');
+		return $this->getSize($attribute, $value) >= $parameters[0];
+	}
 
-    /**
-     * Validate that an attribute is numeric.
-     * @param mixed $value
-     * @return bool
-     */
-    public function validateNumber($value)
-    {
-        return is_numeric($value);
-    }
+	/**
+	 * Validate that an attribute is numeric.
+	 * @param mixed $value
+	 * @return bool
+	 */
+	public function validateNumber($value)
+	{
+		return is_numeric($value);
+	}
 
-    /**
-     * Validate that a required attribute exists.
-     * @param mixed $value
-     * @return bool
-     */
-    public function validateRequired($value)
-    {
-        return is_null($value)
-            || (is_string($value) && '' === trim($value))
-            || (is_array($value) && count($value) < 1)
-            ? false
-            : true;
-    }
+	/**
+	 * Validate that a required attribute exists.
+	 * @param mixed $value
+	 * @return bool
+	 */
+	public function validateRequired($value)
+	{
+		return is_null($value)
+			|| (is_string($value) && '' === trim($value))
+			|| (is_array($value) && count($value) < 1)
+			? false
+			: true;
+	}
 
-    /**
-     * Require a certain number of parameters to be present.
-     * @param int $count
-     * @param string $rule
-     * @return void
-     * @throws InvalidArgumentException
-     */
-    protected function requireParameterCount($count, array $parameters, $rule)
-    {
-        if (count($parameters) < $count) {
-            throw new InvalidArgumentException("Validation rule $rule requires at least $count parameters.");
-        }
-    }
+	/**
+	 * Require a certain number of parameters to be present.
+	 * @param int $count
+	 * @param string $rule
+	 * @return void
+	 * @throws InvalidArgumentException
+	 */
+	protected function requireParameterCount($count, array $parameters, $rule)
+	{
+		if (count($parameters) < $count) {
+			throw new InvalidArgumentException("Validation rule $rule requires at least $count parameters.");
+		}
+	}
 }

plugin/Modules/Validator/ValidateReview.php

Indentation +241 added lines, -241 removed lines

@@ -12,265 +12,265 @@
 
 class ValidateReview
 {
-    const RECAPTCHA_ENDPOINT = 'https://www.google.com/recaptcha/api/siteverify';
+	const RECAPTCHA_ENDPOINT = 'https://www.google.com/recaptcha/api/siteverify';
 
-    const RECAPTCHA_DISABLED = 0;
-    const RECAPTCHA_EMPTY = 1;
-    const RECAPTCHA_FAILED = 2;
-    const RECAPTCHA_INVALID = 3;
-    const RECAPTCHA_VALID = 4;
+	const RECAPTCHA_DISABLED = 0;
+	const RECAPTCHA_EMPTY = 1;
+	const RECAPTCHA_FAILED = 2;
+	const RECAPTCHA_INVALID = 3;
+	const RECAPTCHA_VALID = 4;
 
-    const VALIDATION_RULES = [
-        'content' => 'required',
-        'email' => 'required|email',
-        'name' => 'required',
-        'rating' => 'required|number|between:1,5',
-        'terms' => 'accepted',
-        'title' => 'required',
-    ];
+	const VALIDATION_RULES = [
+		'content' => 'required',
+		'email' => 'required|email',
+		'name' => 'required',
+		'rating' => 'required|number|between:1,5',
+		'terms' => 'accepted',
+		'title' => 'required',
+	];
 
-    /**
-     * @var string|void
-     */
-    public $error;
+	/**
+	 * @var string|void
+	 */
+	public $error;
 
-    /**
-     * @var string
-     */
-    public $form_id;
+	/**
+	 * @var string
+	 */
+	public $form_id;
 
-    /**
-     * @var bool
-     */
-    public $recaptchaIsUnset = false;
+	/**
+	 * @var bool
+	 */
+	public $recaptchaIsUnset = false;
 
-    /**
-     * @var array
-     */
-    public $request;
+	/**
+	 * @var array
+	 */
+	public $request;
 
-    /**
-     * @var array
-     */
-    protected $options;
+	/**
+	 * @var array
+	 */
+	protected $options;
 
-    /**
-     * @return static
-     */
-    public function validate(array $request)
-    {
-        $this->form_id = $request['form_id'];
-        $this->options = glsr(OptionManager::class)->all();
-        $this->request = $this->validateRequest($request);
-        $this->validateCustom();
-        $this->validateHoneyPot();
-        $this->validateBlacklist();
-        $this->validateAkismet();
-        $this->validateRecaptcha();
-        if (!empty($this->error)) {
-            $this->setSessionValues('message', $this->error);
-        }
-        return $this;
-    }
+	/**
+	 * @return static
+	 */
+	public function validate(array $request)
+	{
+		$this->form_id = $request['form_id'];
+		$this->options = glsr(OptionManager::class)->all();
+		$this->request = $this->validateRequest($request);
+		$this->validateCustom();
+		$this->validateHoneyPot();
+		$this->validateBlacklist();
+		$this->validateAkismet();
+		$this->validateRecaptcha();
+		if (!empty($this->error)) {
+			$this->setSessionValues('message', $this->error);
+		}
+		return $this;
+	}
 
-    /**
-     * @param string $path
-     * @param mixed $fallback
-     * @return mixed
-     */
-    protected function getOption($path, $fallback = '')
-    {
-        return glsr(Helper::class)->dataGet($this->options, $path, $fallback);
-    }
+	/**
+	 * @param string $path
+	 * @param mixed $fallback
+	 * @return mixed
+	 */
+	protected function getOption($path, $fallback = '')
+	{
+		return glsr(Helper::class)->dataGet($this->options, $path, $fallback);
+	}
 
-    /**
-     * @return int
-     */
-    protected function getRecaptchaStatus()
-    {
-        if (!glsr(OptionManager::class)->isRecaptchaEnabled()) {
-            return static::RECAPTCHA_DISABLED;
-        }
-        if (empty($this->request['_recaptcha-token'])) {
-            return $this->request['_counter'] < intval(apply_filters('site-reviews/recaptcha/timeout', 5))
-                ? static::RECAPTCHA_EMPTY
-                : static::RECAPTCHA_FAILED;
-        }
-        return $this->getRecaptchaTokenStatus();
-    }
+	/**
+	 * @return int
+	 */
+	protected function getRecaptchaStatus()
+	{
+		if (!glsr(OptionManager::class)->isRecaptchaEnabled()) {
+			return static::RECAPTCHA_DISABLED;
+		}
+		if (empty($this->request['_recaptcha-token'])) {
+			return $this->request['_counter'] < intval(apply_filters('site-reviews/recaptcha/timeout', 5))
+				? static::RECAPTCHA_EMPTY
+				: static::RECAPTCHA_FAILED;
+		}
+		return $this->getRecaptchaTokenStatus();
+	}
 
-    /**
-     * @return int
-     */
-    protected function getRecaptchaTokenStatus()
-    {
-        $endpoint = add_query_arg([
-            'remoteip' => glsr(Helper::class)->getIpAddress(),
-            'response' => $this->request['_recaptcha-token'],
-            'secret' => $this->getOption('settings.submissions.recaptcha.secret'),
-        ], static::RECAPTCHA_ENDPOINT);
-        if (is_wp_error($response = wp_remote_get($endpoint))) {
-            glsr_log()->error($response->get_error_message());
-            return static::RECAPTCHA_FAILED;
-        }
-        $response = json_decode(wp_remote_retrieve_body($response));
-        if (!empty($response->success)) {
-            return boolval($response->success)
-                ? static::RECAPTCHA_VALID
-                : static::RECAPTCHA_INVALID;
-        }
-        foreach ($response->{'error-codes'} as $error) {
-            glsr_log()->error('reCAPTCHA error: '.$error);
-        }
-        return static::RECAPTCHA_INVALID;
-    }
+	/**
+	 * @return int
+	 */
+	protected function getRecaptchaTokenStatus()
+	{
+		$endpoint = add_query_arg([
+			'remoteip' => glsr(Helper::class)->getIpAddress(),
+			'response' => $this->request['_recaptcha-token'],
+			'secret' => $this->getOption('settings.submissions.recaptcha.secret'),
+		], static::RECAPTCHA_ENDPOINT);
+		if (is_wp_error($response = wp_remote_get($endpoint))) {
+			glsr_log()->error($response->get_error_message());
+			return static::RECAPTCHA_FAILED;
+		}
+		$response = json_decode(wp_remote_retrieve_body($response));
+		if (!empty($response->success)) {
+			return boolval($response->success)
+				? static::RECAPTCHA_VALID
+				: static::RECAPTCHA_INVALID;
+		}
+		foreach ($response->{'error-codes'} as $error) {
+			glsr_log()->error('reCAPTCHA error: '.$error);
+		}
+		return static::RECAPTCHA_INVALID;
+	}
 
-    /**
-     * @return array
-     */
-    protected function getValidationRules(array $request)
-    {
-        $rules = array_intersect_key(
-            apply_filters('site-reviews/validation/rules', static::VALIDATION_RULES, $request),
-            array_flip($this->getOption('settings.submissions.required', []))
-        );
-        $excluded = explode(',', glsr_get($request, 'excluded'));
-        return array_diff_key($rules, array_flip($excluded));
-    }
+	/**
+	 * @return array
+	 */
+	protected function getValidationRules(array $request)
+	{
+		$rules = array_intersect_key(
+			apply_filters('site-reviews/validation/rules', static::VALIDATION_RULES, $request),
+			array_flip($this->getOption('settings.submissions.required', []))
+		);
+		$excluded = explode(',', glsr_get($request, 'excluded'));
+		return array_diff_key($rules, array_flip($excluded));
+	}
 
-    /**
-     * @return bool
-     */
-    protected function isRequestValid(array $request)
-    {
-        $rules = $this->getValidationRules($request);
-        $errors = glsr(Validator::class)->validate($request, $rules);
-        if (empty($errors)) {
-            return true;
-        }
-        $this->setSessionValues('errors', $errors);
-        $this->setSessionValues('values', $request);
-        return false;
-    }
+	/**
+	 * @return bool
+	 */
+	protected function isRequestValid(array $request)
+	{
+		$rules = $this->getValidationRules($request);
+		$errors = glsr(Validator::class)->validate($request, $rules);
+		if (empty($errors)) {
+			return true;
+		}
+		$this->setSessionValues('errors', $errors);
+		$this->setSessionValues('values', $request);
+		return false;
+	}
 
-    /**
-     * @param string $type
-     * @param mixed $value
-     * @param string $loggedMessage
-     * @return void
-     */
-    protected function setSessionValues($type, $value, $loggedMessage = '')
-    {
-        glsr(Session::class)->set($this->form_id.$type, $value);
-        if (!empty($loggedMessage)) {
-            glsr_log()->warning($loggedMessage)->debug($this->request);
-        }
-    }
+	/**
+	 * @param string $type
+	 * @param mixed $value
+	 * @param string $loggedMessage
+	 * @return void
+	 */
+	protected function setSessionValues($type, $value, $loggedMessage = '')
+	{
+		glsr(Session::class)->set($this->form_id.$type, $value);
+		if (!empty($loggedMessage)) {
+			glsr_log()->warning($loggedMessage)->debug($this->request);
+		}
+	}
 
-    /**
-     * @return void
-     */
-    protected function validateAkismet()
-    {
-        if (!empty($this->error)) {
-            return;
-        }
-        if (!glsr(Akismet::class)->isSpam($this->request)) {
-            return;
-        }
-        $this->setSessionValues('errors', [], 'Akismet caught a spam submission (consider adding the IP address to the blacklist):');
-        $this->error = __('This review has been flagged as possible spam and cannot be submitted.', 'site-reviews');
-    }
+	/**
+	 * @return void
+	 */
+	protected function validateAkismet()
+	{
+		if (!empty($this->error)) {
+			return;
+		}
+		if (!glsr(Akismet::class)->isSpam($this->request)) {
+			return;
+		}
+		$this->setSessionValues('errors', [], 'Akismet caught a spam submission (consider adding the IP address to the blacklist):');
+		$this->error = __('This review has been flagged as possible spam and cannot be submitted.', 'site-reviews');
+	}
 
-    /**
-     * @return void
-     */
-    protected function validateBlacklist()
-    {
-        if (!empty($this->error)) {
-            return;
-        }
-        if (!glsr(Blacklist::class)->isBlacklisted($this->request)) {
-            return;
-        }
-        $blacklistAction = $this->getOption('settings.submissions.blacklist.action');
-        if ('reject' == $blacklistAction) {
-            $this->setSessionValues('errors', [], 'Blacklisted submission detected:');
-            $this->error = __('Your review cannot be submitted at this time.', 'site-reviews');
-            return;
-        }
-        $this->request['blacklisted'] = true;
-    }
+	/**
+	 * @return void
+	 */
+	protected function validateBlacklist()
+	{
+		if (!empty($this->error)) {
+			return;
+		}
+		if (!glsr(Blacklist::class)->isBlacklisted($this->request)) {
+			return;
+		}
+		$blacklistAction = $this->getOption('settings.submissions.blacklist.action');
+		if ('reject' == $blacklistAction) {
+			$this->setSessionValues('errors', [], 'Blacklisted submission detected:');
+			$this->error = __('Your review cannot be submitted at this time.', 'site-reviews');
+			return;
+		}
+		$this->request['blacklisted'] = true;
+	}
 
-    /**
-     * @return void
-     */
-    protected function validateCustom()
-    {
-        if (!empty($this->error)) {
-            return;
-        }
-        $validated = apply_filters('site-reviews/validate/custom', true, $this->request);
-        if (true === $validated) {
-            return;
-        }
-        $this->setSessionValues('errors', []);
-        $this->setSessionValues('values', $this->request);
-        $this->error = is_string($validated)
-            ? $validated
-            : __('The review submission failed. Please notify the site administrator.', 'site-reviews');
-    }
+	/**
+	 * @return void
+	 */
+	protected function validateCustom()
+	{
+		if (!empty($this->error)) {
+			return;
+		}
+		$validated = apply_filters('site-reviews/validate/custom', true, $this->request);
+		if (true === $validated) {
+			return;
+		}
+		$this->setSessionValues('errors', []);
+		$this->setSessionValues('values', $this->request);
+		$this->error = is_string($validated)
+			? $validated
+			: __('The review submission failed. Please notify the site administrator.', 'site-reviews');
+	}
 
-    /**
-     * @return void
-     */
-    protected function validateHoneyPot()
-    {
-        if (!empty($this->error)) {
-            return;
-        }
-        if (empty($this->request['gotcha'])) {
-            return;
-        }
-        $this->setSessionValues('errors', [], 'The Honeypot caught a bad submission:');
-        $this->error = __('The review submission failed. Please notify the site administrator.', 'site-reviews');
-    }
+	/**
+	 * @return void
+	 */
+	protected function validateHoneyPot()
+	{
+		if (!empty($this->error)) {
+			return;
+		}
+		if (empty($this->request['gotcha'])) {
+			return;
+		}
+		$this->setSessionValues('errors', [], 'The Honeypot caught a bad submission:');
+		$this->error = __('The review submission failed. Please notify the site administrator.', 'site-reviews');
+	}
 
-    /**
-     * @return void
-     */
-    protected function validateRecaptcha()
-    {
-        if (!empty($this->error)) {
-            return;
-        }
-        $status = $this->getRecaptchaStatus();
-        if (in_array($status, [static::RECAPTCHA_DISABLED, static::RECAPTCHA_VALID])) {
-            return;
-        }
-        if ($status == static::RECAPTCHA_EMPTY) {
-            $this->setSessionValues('recaptcha', 'unset');
-            $this->recaptchaIsUnset = true;
-            return;
-        }
-        $this->setSessionValues('errors', []);
-        $this->setSessionValues('recaptcha', 'reset');
-        $errors = [
-            static::RECAPTCHA_FAILED => __('The reCAPTCHA failed to load, please refresh the page and try again.', 'site-reviews'),
-            static::RECAPTCHA_INVALID => __('The reCAPTCHA verification failed, please try again.', 'site-reviews'),
-        ];
-        $this->error = $errors[$status];
-    }
+	/**
+	 * @return void
+	 */
+	protected function validateRecaptcha()
+	{
+		if (!empty($this->error)) {
+			return;
+		}
+		$status = $this->getRecaptchaStatus();
+		if (in_array($status, [static::RECAPTCHA_DISABLED, static::RECAPTCHA_VALID])) {
+			return;
+		}
+		if ($status == static::RECAPTCHA_EMPTY) {
+			$this->setSessionValues('recaptcha', 'unset');
+			$this->recaptchaIsUnset = true;
+			return;
+		}
+		$this->setSessionValues('errors', []);
+		$this->setSessionValues('recaptcha', 'reset');
+		$errors = [
+			static::RECAPTCHA_FAILED => __('The reCAPTCHA failed to load, please refresh the page and try again.', 'site-reviews'),
+			static::RECAPTCHA_INVALID => __('The reCAPTCHA verification failed, please try again.', 'site-reviews'),
+		];
+		$this->error = $errors[$status];
+	}
 
-    /**
-     * @return array
-     */
-    protected function validateRequest(array $request)
-    {
-        if (!$this->isRequestValid($request)) {
-            $this->error = __('Please fix the submission errors.', 'site-reviews');
-            return $request;
-        }
-        return array_merge(glsr(ValidateReviewDefaults::class)->defaults(), $request);
-    }
+	/**
+	 * @return array
+	 */
+	protected function validateRequest(array $request)
+	{
+		if (!$this->isRequestValid($request)) {
+			$this->error = __('Please fix the submission errors.', 'site-reviews');
+			return $request;
+		}
+		return array_merge(glsr(ValidateReviewDefaults::class)->defaults(), $request);
+	}
 }

plugin/Modules/Rating.php

Indentation +190 added lines, -190 removed lines

@@ -4,206 +4,206 @@
 
 class Rating
 {
-    /**
-     * The more sure we are of the confidence interval (the higher the confidence level), the less
-     * precise the estimation will be as the margin for error will be higher.
-     * @see http://homepages.math.uic.edu/~bpower6/stat101/Confidence%20Intervals.pdf
-     * @see https://www.thecalculator.co/math/Confidence-Interval-Calculator-210.html
-     * @see https://www.youtube.com/watch?v=grodoLzThy4
-     * @see https://en.wikipedia.org/wiki/Standard_score
-     * @var array
-     */
-    const CONFIDENCE_LEVEL_Z_SCORES = [
-        50 => 0.67449,
-        70 => 1.04,
-        75 => 1.15035,
-        80 => 1.282,
-        85 => 1.44,
-        90 => 1.64485,
-        92 => 1.75,
-        95 => 1.95996,
-        96 => 2.05,
-        97 => 2.17009,
-        98 => 2.326,
-        99 => 2.57583,
-        '99.5' => 2.81,
-        '99.8' => 3.08,
-        '99.9' => 3.29053,
-    ];
+	/**
+	 * The more sure we are of the confidence interval (the higher the confidence level), the less
+	 * precise the estimation will be as the margin for error will be higher.
+	 * @see http://homepages.math.uic.edu/~bpower6/stat101/Confidence%20Intervals.pdf
+	 * @see https://www.thecalculator.co/math/Confidence-Interval-Calculator-210.html
+	 * @see https://www.youtube.com/watch?v=grodoLzThy4
+	 * @see https://en.wikipedia.org/wiki/Standard_score
+	 * @var array
+	 */
+	const CONFIDENCE_LEVEL_Z_SCORES = [
+		50 => 0.67449,
+		70 => 1.04,
+		75 => 1.15035,
+		80 => 1.282,
+		85 => 1.44,
+		90 => 1.64485,
+		92 => 1.75,
+		95 => 1.95996,
+		96 => 2.05,
+		97 => 2.17009,
+		98 => 2.326,
+		99 => 2.57583,
+		'99.5' => 2.81,
+		'99.8' => 3.08,
+		'99.9' => 3.29053,
+	];
 
-    /**
-     * @var int
-     */
-    const MAX_RATING = 5;
+	/**
+	 * @var int
+	 */
+	const MAX_RATING = 5;
 
-    /**
-     * @var int
-     */
-    const MIN_RATING = 1;
+	/**
+	 * @var int
+	 */
+	const MIN_RATING = 1;
 
-    /**
-     * @param int $roundBy
-     * @return float
-     */
-    public function getAverage(array $ratingCounts, $roundBy = 1)
-    {
-        $average = array_sum($ratingCounts);
-        if ($average > 0) {
-            $average = round($this->getTotalSum($ratingCounts) / $average, intval($roundBy));
-        }
-        return floatval(apply_filters('site-reviews/rating/average', $average, $ratingCounts));
-    }
+	/**
+	 * @param int $roundBy
+	 * @return float
+	 */
+	public function getAverage(array $ratingCounts, $roundBy = 1)
+	{
+		$average = array_sum($ratingCounts);
+		if ($average > 0) {
+			$average = round($this->getTotalSum($ratingCounts) / $average, intval($roundBy));
+		}
+		return floatval(apply_filters('site-reviews/rating/average', $average, $ratingCounts));
+	}
 
-    /**
-     * Get the lower bound for up/down ratings
-     * Method receives an up/down ratings array: [1, -1, -1, 1, 1, -1].
-     * @see http://www.evanmiller.org/how-not-to-sort-by-average-rating.html
-     * @see https://news.ycombinator.com/item?id=10481507
-     * @see https://dataorigami.net/blogs/napkin-folding/79030467-an-algorithm-to-sort-top-comments
-     * @see http://julesjacobs.github.io/2015/08/17/bayesian-scoring-of-ratings.html
-     * @param int $confidencePercentage
-     * @return int|float
-     */
-    public function getLowerBound(array $upDownCounts = [0, 0], $confidencePercentage = 95)
-    {
-        $numRatings = array_sum($upDownCounts);
-        if ($numRatings < 1) {
-            return 0;
-        }
-        $z = static::CONFIDENCE_LEVEL_Z_SCORES[$confidencePercentage];
-        $phat = 1 * $upDownCounts[1] / $numRatings;
-        return ($phat + $z * $z / (2 * $numRatings) - $z * sqrt(($phat * (1 - $phat) + $z * $z / (4 * $numRatings)) / $numRatings)) / (1 + $z * $z / $numRatings);
-    }
+	/**
+	 * Get the lower bound for up/down ratings
+	 * Method receives an up/down ratings array: [1, -1, -1, 1, 1, -1].
+	 * @see http://www.evanmiller.org/how-not-to-sort-by-average-rating.html
+	 * @see https://news.ycombinator.com/item?id=10481507
+	 * @see https://dataorigami.net/blogs/napkin-folding/79030467-an-algorithm-to-sort-top-comments
+	 * @see http://julesjacobs.github.io/2015/08/17/bayesian-scoring-of-ratings.html
+	 * @param int $confidencePercentage
+	 * @return int|float
+	 */
+	public function getLowerBound(array $upDownCounts = [0, 0], $confidencePercentage = 95)
+	{
+		$numRatings = array_sum($upDownCounts);
+		if ($numRatings < 1) {
+			return 0;
+		}
+		$z = static::CONFIDENCE_LEVEL_Z_SCORES[$confidencePercentage];
+		$phat = 1 * $upDownCounts[1] / $numRatings;
+		return ($phat + $z * $z / (2 * $numRatings) - $z * sqrt(($phat * (1 - $phat) + $z * $z / (4 * $numRatings)) / $numRatings)) / (1 + $z * $z / $numRatings);
+	}
 
-    /**
-     * @return int|float
-     */
-    public function getOverallPercentage(array $ratingCounts)
-    {
-        return round($this->getAverage($ratingCounts) * 100 / glsr()->constant('MAX_RATING'), 2);
-    }
+	/**
+	 * @return int|float
+	 */
+	public function getOverallPercentage(array $ratingCounts)
+	{
+		return round($this->getAverage($ratingCounts) * 100 / glsr()->constant('MAX_RATING'), 2);
+	}
 
-    /**
-     * @return array
-     */
-    public function getPercentages(array $ratingCounts)
-    {
-        $total = array_sum($ratingCounts);
-        foreach ($ratingCounts as $index => $count) {
-            if (empty($count)) {
-                continue;
-            }
-            $ratingCounts[$index] = $count / $total * 100;
-        }
-        return $this->getRoundedPercentages($ratingCounts);
-    }
+	/**
+	 * @return array
+	 */
+	public function getPercentages(array $ratingCounts)
+	{
+		$total = array_sum($ratingCounts);
+		foreach ($ratingCounts as $index => $count) {
+			if (empty($count)) {
+				continue;
+			}
+			$ratingCounts[$index] = $count / $total * 100;
+		}
+		return $this->getRoundedPercentages($ratingCounts);
+	}
 
-    /**
-     * @return float
-     */
-    public function getRanking(array $ratingCounts)
-    {
-        return floatval(apply_filters('site-reviews/rating/ranking',
-            $this->getRankingUsingImdb($ratingCounts),
-            $ratingCounts,
-            $this
-        ));
-    }
+	/**
+	 * @return float
+	 */
+	public function getRanking(array $ratingCounts)
+	{
+		return floatval(apply_filters('site-reviews/rating/ranking',
+			$this->getRankingUsingImdb($ratingCounts),
+			$ratingCounts,
+			$this
+		));
+	}
 
-    /**
-     * Get the bayesian ranking for an array of reviews
-     * This formula is the same one used by IMDB to rank their top 250 films.
-     * @see https://www.xkcd.com/937/
-     * @see https://districtdatalabs.silvrback.com/computing-a-bayesian-estimate-of-star-rating-means
-     * @see http://fulmicoton.com/posts/bayesian_rating/
-     * @see https://stats.stackexchange.com/questions/93974/is-there-an-equivalent-to-lower-bound-of-wilson-score-confidence-interval-for-va
-     * @param int $confidencePercentage
-     * @return int|float
-     */
-    public function getRankingUsingImdb(array $ratingCounts, $confidencePercentage = 70)
-    {
-        $avgRating = $this->getAverage($ratingCounts);
-        // Represents a prior (your prior opinion without data) for the average star rating. A higher prior also means a higher margin for error.
-        // This could also be the average score of all items instead of a fixed value.
-        $bayesMean = ($confidencePercentage / 100) * glsr()->constant('MAX_RATING'); // prior, 70% = 3.5
-        // Represents the number of ratings expected to begin observing a pattern that would put confidence in the prior.
-        $bayesMinimal = 10; // confidence
-        $numOfReviews = array_sum($ratingCounts);
-        return $avgRating > 0
-            ? (($bayesMinimal * $bayesMean) + ($avgRating * $numOfReviews)) / ($bayesMinimal + $numOfReviews)
-            : 0;
-    }
+	/**
+	 * Get the bayesian ranking for an array of reviews
+	 * This formula is the same one used by IMDB to rank their top 250 films.
+	 * @see https://www.xkcd.com/937/
+	 * @see https://districtdatalabs.silvrback.com/computing-a-bayesian-estimate-of-star-rating-means
+	 * @see http://fulmicoton.com/posts/bayesian_rating/
+	 * @see https://stats.stackexchange.com/questions/93974/is-there-an-equivalent-to-lower-bound-of-wilson-score-confidence-interval-for-va
+	 * @param int $confidencePercentage
+	 * @return int|float
+	 */
+	public function getRankingUsingImdb(array $ratingCounts, $confidencePercentage = 70)
+	{
+		$avgRating = $this->getAverage($ratingCounts);
+		// Represents a prior (your prior opinion without data) for the average star rating. A higher prior also means a higher margin for error.
+		// This could also be the average score of all items instead of a fixed value.
+		$bayesMean = ($confidencePercentage / 100) * glsr()->constant('MAX_RATING'); // prior, 70% = 3.5
+		// Represents the number of ratings expected to begin observing a pattern that would put confidence in the prior.
+		$bayesMinimal = 10; // confidence
+		$numOfReviews = array_sum($ratingCounts);
+		return $avgRating > 0
+			? (($bayesMinimal * $bayesMean) + ($avgRating * $numOfReviews)) / ($bayesMinimal + $numOfReviews)
+			: 0;
+	}
 
-    /**
-     * The quality of a 5 star rating depends not only on the average number of stars but also on
-     * the number of reviews. This method calculates the bayesian ranking of a page by its number
-     * of reviews and their rating.
-     * @see http://www.evanmiller.org/ranking-items-with-star-ratings.html
-     * @see https://stackoverflow.com/questions/1411199/what-is-a-better-way-to-sort-by-a-5-star-rating/1411268
-     * @see http://julesjacobs.github.io/2015/08/17/bayesian-scoring-of-ratings.html
-     * @param int $confidencePercentage
-     * @return float
-     */
-    public function getRankingUsingZScores(array $ratingCounts, $confidencePercentage = 90)
-    {
-        $ratingCountsSum = array_sum($ratingCounts) + glsr()->constant('MAX_RATING');
-        $weight = $this->getWeight($ratingCounts, $ratingCountsSum);
-        $weightPow2 = $this->getWeight($ratingCounts, $ratingCountsSum, true);
-        $zScore = static::CONFIDENCE_LEVEL_Z_SCORES[$confidencePercentage];
-        return $weight - $zScore * sqrt(($weightPow2 - pow($weight, 2)) / ($ratingCountsSum + 1));
-    }
+	/**
+	 * The quality of a 5 star rating depends not only on the average number of stars but also on
+	 * the number of reviews. This method calculates the bayesian ranking of a page by its number
+	 * of reviews and their rating.
+	 * @see http://www.evanmiller.org/ranking-items-with-star-ratings.html
+	 * @see https://stackoverflow.com/questions/1411199/what-is-a-better-way-to-sort-by-a-5-star-rating/1411268
+	 * @see http://julesjacobs.github.io/2015/08/17/bayesian-scoring-of-ratings.html
+	 * @param int $confidencePercentage
+	 * @return float
+	 */
+	public function getRankingUsingZScores(array $ratingCounts, $confidencePercentage = 90)
+	{
+		$ratingCountsSum = array_sum($ratingCounts) + glsr()->constant('MAX_RATING');
+		$weight = $this->getWeight($ratingCounts, $ratingCountsSum);
+		$weightPow2 = $this->getWeight($ratingCounts, $ratingCountsSum, true);
+		$zScore = static::CONFIDENCE_LEVEL_Z_SCORES[$confidencePercentage];
+		return $weight - $zScore * sqrt(($weightPow2 - pow($weight, 2)) / ($ratingCountsSum + 1));
+	}
 
-    /**
-     * @param int $target
-     * @return array
-     */
-    protected function getRoundedPercentages(array $percentages, $totalPercent = 100)
-    {
-        array_walk($percentages, function (&$percent, $index) {
-            $percent = [
-                'index' => $index,
-                'percent' => floor($percent),
-                'remainder' => fmod($percent, 1),
-            ];
-        });
-        $indexes = glsr_array_column($percentages, 'index');
-        $remainders = glsr_array_column($percentages, 'remainder');
-        array_multisort($remainders, SORT_DESC, SORT_STRING, $indexes, SORT_DESC, $percentages);
-        $i = 0;
-        if (array_sum(glsr_array_column($percentages, 'percent')) > 0) {
-            while (array_sum(glsr_array_column($percentages, 'percent')) < $totalPercent) {
-                ++$percentages[$i]['percent'];
-                ++$i;
-            }
-        }
-        array_multisort($indexes, SORT_DESC, $percentages);
-        return array_combine($indexes, glsr_array_column($percentages, 'percent'));
-    }
+	/**
+	 * @param int $target
+	 * @return array
+	 */
+	protected function getRoundedPercentages(array $percentages, $totalPercent = 100)
+	{
+		array_walk($percentages, function (&$percent, $index) {
+			$percent = [
+				'index' => $index,
+				'percent' => floor($percent),
+				'remainder' => fmod($percent, 1),
+			];
+		});
+		$indexes = glsr_array_column($percentages, 'index');
+		$remainders = glsr_array_column($percentages, 'remainder');
+		array_multisort($remainders, SORT_DESC, SORT_STRING, $indexes, SORT_DESC, $percentages);
+		$i = 0;
+		if (array_sum(glsr_array_column($percentages, 'percent')) > 0) {
+			while (array_sum(glsr_array_column($percentages, 'percent')) < $totalPercent) {
+				++$percentages[$i]['percent'];
+				++$i;
+			}
+		}
+		array_multisort($indexes, SORT_DESC, $percentages);
+		return array_combine($indexes, glsr_array_column($percentages, 'percent'));
+	}
 
-    /**
-     * @return int
-     */
-    protected function getTotalSum(array $ratingCounts)
-    {
-        return array_reduce(array_keys($ratingCounts), function ($carry, $index) use ($ratingCounts) {
-            return $carry + ($index * $ratingCounts[$index]);
-        });
-    }
+	/**
+	 * @return int
+	 */
+	protected function getTotalSum(array $ratingCounts)
+	{
+		return array_reduce(array_keys($ratingCounts), function ($carry, $index) use ($ratingCounts) {
+			return $carry + ($index * $ratingCounts[$index]);
+		});
+	}
 
-    /**
-     * @param int|float $ratingCountsSum
-     * @param bool $powerOf2
-     * @return float
-     */
-    protected function getWeight(array $ratingCounts, $ratingCountsSum, $powerOf2 = false)
-    {
-        return array_reduce(array_keys($ratingCounts),
-            function ($count, $rating) use ($ratingCounts, $ratingCountsSum, $powerOf2) {
-                $ratingLevel = $powerOf2
-                    ? pow($rating, 2)
-                    : $rating;
-                return $count + ($ratingLevel * ($ratingCounts[$rating] + 1)) / $ratingCountsSum;
-            }
-        );
-    }
+	/**
+	 * @param int|float $ratingCountsSum
+	 * @param bool $powerOf2
+	 * @return float
+	 */
+	protected function getWeight(array $ratingCounts, $ratingCountsSum, $powerOf2 = false)
+	{
+		return array_reduce(array_keys($ratingCounts),
+			function ($count, $rating) use ($ratingCounts, $ratingCountsSum, $powerOf2) {
+				$ratingLevel = $powerOf2
+					? pow($rating, 2)
+					: $rating;
+				return $count + ($ratingLevel * ($ratingCounts[$rating] + 1)) / $ratingCountsSum;
+			}
+		);
+	}
 }

plugin/Application.php

Indentation +255 added lines, -255 removed lines

@@ -7,283 +7,283 @@
 
 final class Application extends Container
 {
-    const CAPABILITY = 'edit_others_posts';
-    const CRON_EVENT = 'site-reviews/schedule/session/purge';
-    const ID = 'site-reviews';
-    const PAGED_QUERY_VAR = 'reviews-page';
-    const POST_TYPE = 'site-review';
-    const PREFIX = 'glsr_';
-    const TAXONOMY = 'site-review-category';
+	const CAPABILITY = 'edit_others_posts';
+	const CRON_EVENT = 'site-reviews/schedule/session/purge';
+	const ID = 'site-reviews';
+	const PAGED_QUERY_VAR = 'reviews-page';
+	const POST_TYPE = 'site-review';
+	const PREFIX = 'glsr_';
+	const TAXONOMY = 'site-review-category';
 
-    public $defaults;
-    public $deprecated = [];
-    public $file;
-    public $languages;
-    public $mceShortcodes = []; //defined elsewhere
-    public $name;
-    public $reviewTypes;
-    public $schemas = []; //defined elsewhere
-    public $version;
+	public $defaults;
+	public $deprecated = [];
+	public $file;
+	public $languages;
+	public $mceShortcodes = []; //defined elsewhere
+	public $name;
+	public $reviewTypes;
+	public $schemas = []; //defined elsewhere
+	public $version;
 
-    public function __construct()
-    {
-        static::$instance = $this;
-        $this->file = realpath(trailingslashit(dirname(__DIR__)).static::ID.'.php');
-        $plugin = get_file_data($this->file, [
-            'languages' => 'Domain Path',
-            'name' => 'Plugin Name',
-            'version' => 'Version',
-        ], 'plugin');
-        array_walk($plugin, function ($value, $key) {
-            $this->$key = $value;
-        });
-    }
+	public function __construct()
+	{
+		static::$instance = $this;
+		$this->file = realpath(trailingslashit(dirname(__DIR__)).static::ID.'.php');
+		$plugin = get_file_data($this->file, [
+			'languages' => 'Domain Path',
+			'name' => 'Plugin Name',
+			'version' => 'Version',
+		], 'plugin');
+		array_walk($plugin, function ($value, $key) {
+			$this->$key = $value;
+		});
+	}
 
-    /**
-     * @return void
-     */
-    public function activate()
-    {
-        $this->make(DefaultsManager::class)->set();
-        $this->scheduleCronJob();
-        $this->upgrade();
-    }
+	/**
+	 * @return void
+	 */
+	public function activate()
+	{
+		$this->make(DefaultsManager::class)->set();
+		$this->scheduleCronJob();
+		$this->upgrade();
+	}
 
-    /**
-     * @return void
-     */
-    public function catchFatalError()
-    {
-        $error = error_get_last();
-        if (E_ERROR !== $error['type'] || false === strpos($error['message'], $this->path())) {
-            return;
-        }
-        glsr_log()->error($error['message']);
-    }
+	/**
+	 * @return void
+	 */
+	public function catchFatalError()
+	{
+		$error = error_get_last();
+		if (E_ERROR !== $error['type'] || false === strpos($error['message'], $this->path())) {
+			return;
+		}
+		glsr_log()->error($error['message']);
+	}
 
-    /**
-     * @param string $name
-     * @return array
-     */
-    public function config($name)
-    {
-        $configFile = $this->path('config/'.$name.'.php');
-        $config = file_exists($configFile)
-            ? include $configFile
-            : [];
-        return apply_filters('site-reviews/config/'.$name, $config);
-    }
+	/**
+	 * @param string $name
+	 * @return array
+	 */
+	public function config($name)
+	{
+		$configFile = $this->path('config/'.$name.'.php');
+		$config = file_exists($configFile)
+			? include $configFile
+			: [];
+		return apply_filters('site-reviews/config/'.$name, $config);
+	}
 
-    /**
-     * @param string $property
-     * @return string
-     */
-    public function constant($property, $className = 'static')
-    {
-        $constant = $className.'::'.$property;
-        return defined($constant)
-            ? apply_filters('site-reviews/const/'.$property, constant($constant))
-            : '';
-    }
+	/**
+	 * @param string $property
+	 * @return string
+	 */
+	public function constant($property, $className = 'static')
+	{
+		$constant = $className.'::'.$property;
+		return defined($constant)
+			? apply_filters('site-reviews/const/'.$property, constant($constant))
+			: '';
+	}
 
-    /**
-     * @return void
-     */
-    public function deactivate()
-    {
-        $this->unscheduleCronJob();
-    }
+	/**
+	 * @return void
+	 */
+	public function deactivate()
+	{
+		$this->unscheduleCronJob();
+	}
 
-    /**
-     * @param string $view
-     * @return void|string
-     */
-    public function file($view)
-    {
-        $view .= '.php';
-        $filePaths = [];
-        if (glsr(Helper::class)->startsWith('templates/', $view)) {
-            $filePaths[] = $this->themePath(glsr(Helper::class)->removePrefix('templates/', $view));
-        }
-        $filePaths[] = $this->path($view);
-        $filePaths[] = $this->path('views/'.$view);
-        foreach ($filePaths as $file) {
-            if (!file_exists($file)) {
-                continue;
-            }
-            return $file;
-        }
-    }
+	/**
+	 * @param string $view
+	 * @return void|string
+	 */
+	public function file($view)
+	{
+		$view .= '.php';
+		$filePaths = [];
+		if (glsr(Helper::class)->startsWith('templates/', $view)) {
+			$filePaths[] = $this->themePath(glsr(Helper::class)->removePrefix('templates/', $view));
+		}
+		$filePaths[] = $this->path($view);
+		$filePaths[] = $this->path('views/'.$view);
+		foreach ($filePaths as $file) {
+			if (!file_exists($file)) {
+				continue;
+			}
+			return $file;
+		}
+	}
 
-    /**
-     * @return array
-     */
-    public function getDefaults()
-    {
-        if (empty($this->defaults)) {
-            $this->defaults = $this->make(DefaultsManager::class)->get();
-            $this->upgrade();
-        }
-        return apply_filters('site-reviews/get/defaults', $this->defaults);
-    }
+	/**
+	 * @return array
+	 */
+	public function getDefaults()
+	{
+		if (empty($this->defaults)) {
+			$this->defaults = $this->make(DefaultsManager::class)->get();
+			$this->upgrade();
+		}
+		return apply_filters('site-reviews/get/defaults', $this->defaults);
+	}
 
-    /**
-     * @return bool
-     */
-    public function getPermission($page = '')
-    {
-        $permissions = [
-            'addons' => 'install_plugins',
-            'settings' => 'manage_options',
-        ];
-        return glsr_get($permissions, $page, $this->constant('CAPABILITY'));
-    }
+	/**
+	 * @return bool
+	 */
+	public function getPermission($page = '')
+	{
+		$permissions = [
+			'addons' => 'install_plugins',
+			'settings' => 'manage_options',
+		];
+		return glsr_get($permissions, $page, $this->constant('CAPABILITY'));
+	}
 
-    /**
-     * @return bool
-     */
-    public function hasPermission($page = '')
-    {
-        $isAdmin = $this->isAdmin();
-        return !$isAdmin || ($isAdmin && current_user_can($this->getPermission($page)));
-    }
+	/**
+	 * @return bool
+	 */
+	public function hasPermission($page = '')
+	{
+		$isAdmin = $this->isAdmin();
+		return !$isAdmin || ($isAdmin && current_user_can($this->getPermission($page)));
+	}
 
-    /**
-     * @return void
-     */
-    public function init()
-    {
-        $this->make(Actions::class)->run();
-        $this->make(Filters::class)->run();
-    }
+	/**
+	 * @return void
+	 */
+	public function init()
+	{
+		$this->make(Actions::class)->run();
+		$this->make(Filters::class)->run();
+	}
 
-    /**
-     * @return bool
-     */
-    public function isAdmin()
-    {
-        return is_admin() && !wp_doing_ajax();
-    }
+	/**
+	 * @return bool
+	 */
+	public function isAdmin()
+	{
+		return is_admin() && !wp_doing_ajax();
+	}
 
-    /**
-     * @param string $file
-     * @return string
-     */
-    public function path($file = '', $realpath = true)
-    {
-        $path = plugin_dir_path($this->file);
-        if (!$realpath) {
-            $path = trailingslashit(WP_PLUGIN_DIR).basename(dirname($this->file));
-        }
-        $path = trailingslashit($path).ltrim(trim($file), '/');
-        return apply_filters('site-reviews/path', $path, $file);
-    }
+	/**
+	 * @param string $file
+	 * @return string
+	 */
+	public function path($file = '', $realpath = true)
+	{
+		$path = plugin_dir_path($this->file);
+		if (!$realpath) {
+			$path = trailingslashit(WP_PLUGIN_DIR).basename(dirname($this->file));
+		}
+		$path = trailingslashit($path).ltrim(trim($file), '/');
+		return apply_filters('site-reviews/path', $path, $file);
+	}
 
-    /**
-     * @return void
-     */
-    public function registerAddons()
-    {
-        do_action('site-reviews/addon/register', $this);
-    }
+	/**
+	 * @return void
+	 */
+	public function registerAddons()
+	{
+		do_action('site-reviews/addon/register', $this);
+	}
 
-    /**
-     * @return void
-     */
-    public function registerLanguages()
-    {
-        load_plugin_textdomain(static::ID, false,
-            trailingslashit(plugin_basename($this->path()).'/'.$this->languages)
-        );
-    }
+	/**
+	 * @return void
+	 */
+	public function registerLanguages()
+	{
+		load_plugin_textdomain(static::ID, false,
+			trailingslashit(plugin_basename($this->path()).'/'.$this->languages)
+		);
+	}
 
-    /**
-     * @return void
-     */
-    public function registerReviewTypes()
-    {
-        $types = apply_filters('site-reviews/addon/types', []);
-        $this->reviewTypes = wp_parse_args($types, [
-            'local' => __('Local', 'site-reviews'),
-        ]);
-    }
+	/**
+	 * @return void
+	 */
+	public function registerReviewTypes()
+	{
+		$types = apply_filters('site-reviews/addon/types', []);
+		$this->reviewTypes = wp_parse_args($types, [
+			'local' => __('Local', 'site-reviews'),
+		]);
+	}
 
-    /**
-     * @param string $view
-     * @return void
-     */
-    public function render($view, array $data = [])
-    {
-        $view = apply_filters('site-reviews/render/view', $view, $data);
-        $file = apply_filters('site-reviews/views/file', $this->file($view), $view, $data);
-        if (!file_exists($file)) {
-            glsr_log()->error('File not found: '.$file);
-            return;
-        }
-        $data = apply_filters('site-reviews/views/data', $data, $view);
-        extract($data);
-        include $file;
-    }
+	/**
+	 * @param string $view
+	 * @return void
+	 */
+	public function render($view, array $data = [])
+	{
+		$view = apply_filters('site-reviews/render/view', $view, $data);
+		$file = apply_filters('site-reviews/views/file', $this->file($view), $view, $data);
+		if (!file_exists($file)) {
+			glsr_log()->error('File not found: '.$file);
+			return;
+		}
+		$data = apply_filters('site-reviews/views/data', $data, $view);
+		extract($data);
+		include $file;
+	}
 
-    /**
-     * @return void
-     */
-    public function scheduleCronJob()
-    {
-        if (wp_next_scheduled(static::CRON_EVENT)) {
-            return;
-        }
-        wp_schedule_event(time(), 'twicedaily', static::CRON_EVENT);
-    }
+	/**
+	 * @return void
+	 */
+	public function scheduleCronJob()
+	{
+		if (wp_next_scheduled(static::CRON_EVENT)) {
+			return;
+		}
+		wp_schedule_event(time(), 'twicedaily', static::CRON_EVENT);
+	}
 
-    /**
-     * @param string $file
-     * @return string
-     */
-    public function themePath($file = '')
-    {
-        return get_stylesheet_directory().'/'.static::ID.'/'.ltrim(trim($file), '/');
-    }
+	/**
+	 * @param string $file
+	 * @return string
+	 */
+	public function themePath($file = '')
+	{
+		return get_stylesheet_directory().'/'.static::ID.'/'.ltrim(trim($file), '/');
+	}
 
-    /**
-     * @return void
-     */
-    public function unscheduleCronJob()
-    {
-        wp_unschedule_event(intval(wp_next_scheduled(static::CRON_EVENT)), static::CRON_EVENT);
-    }
+	/**
+	 * @return void
+	 */
+	public function unscheduleCronJob()
+	{
+		wp_unschedule_event(intval(wp_next_scheduled(static::CRON_EVENT)), static::CRON_EVENT);
+	}
 
-    /**
-     * @return void
-     */
-    public function upgrade()
-    {
-        $this->make(Upgrader::class)->run();
-    }
+	/**
+	 * @return void
+	 */
+	public function upgrade()
+	{
+		$this->make(Upgrader::class)->run();
+	}
 
-    /**
-     * @param mixed $upgrader
-     * @return void
-     * @action upgrader_process_complete
-     */
-    public function upgraded($upgrader, array $data)
-    {
-        if (array_key_exists('plugins', $data)
-            && in_array(plugin_basename($this->file), $data['plugins'])
-            && 'update' === $data['action']
-            && 'plugin' === $data['type']
-        ) {
-            $this->upgrade();
-        }
-    }
+	/**
+	 * @param mixed $upgrader
+	 * @return void
+	 * @action upgrader_process_complete
+	 */
+	public function upgraded($upgrader, array $data)
+	{
+		if (array_key_exists('plugins', $data)
+			&& in_array(plugin_basename($this->file), $data['plugins'])
+			&& 'update' === $data['action']
+			&& 'plugin' === $data['type']
+		) {
+			$this->upgrade();
+		}
+	}
 
-    /**
-     * @param string $path
-     * @return string
-     */
-    public function url($path = '')
-    {
-        $url = esc_url(plugin_dir_url($this->file).ltrim(trim($path), '/'));
-        return apply_filters('site-reviews/url', $url, $path);
-    }
+	/**
+	 * @param string $path
+	 * @return string
+	 */
+	public function url($path = '')
+	{
+		$url = esc_url(plugin_dir_url($this->file).ltrim(trim($path), '/'));
+		return apply_filters('site-reviews/url', $url, $path);
+	}
 }

plugin/Contracts/ShortcodeContract.php

Indentation +5 added lines, -5 removed lines

@@ -4,9 +4,9 @@
 
 interface ShortcodeContract
 {
-    /**
-     * @params string|array $atts
-     * @return string
-     */
-    public function buildShortcode($atts = []);
+	/**
+	 * @params string|array $atts
+	 * @return string
+	 */
+	public function buildShortcode($atts = []);
 }

plugin/Contracts/HooksContract.php

Indentation +4 added lines, -4 removed lines

@@ -4,8 +4,8 @@
 
 interface HooksContract
 {
-    /**
-     * @return void
-     */
-    public function run();
+	/**
+	 * @return void
+	 */
+	public function run();
 }

plugin/Contracts/PartialContract.php

Indentation +4 added lines, -4 removed lines

@@ -4,8 +4,8 @@
 
 interface PartialContract
 {
-    /**
-     * @return void|string
-     */
-    public function build(array $args = []);
+	/**
+	 * @return void|string
+	 */
+	public function build(array $args = []);
 }

plugin/Contracts/ProviderContract.php

Indentation +4 added lines, -4 removed lines

@@ -6,8 +6,8 @@
 
 interface ProviderContract
 {
-    /**
-     * @return void
-     */
-    public function register(Application $app);
+	/**
+	 * @return void
+	 */
+	public function register(Application $app);
 }