pryley / site-reviews

plugin/Controllers/PublicController.php

Indentation +71 added lines, -71 removed lines

@@ -13,81 +13,81 @@
 
 class PublicController extends Controller
 {
-    /**
-     * @return void
-     * @action wp_enqueue_scripts
-     */
-    public function enqueueAssets()
-    {
-        (new EnqueuePublicAssets())->handle();
-    }
+	/**
+	 * @return void
+	 * @action wp_enqueue_scripts
+	 */
+	public function enqueueAssets()
+	{
+		(new EnqueuePublicAssets())->handle();
+	}
 
-    /**
-     * @param string $tag
-     * @param string $handle
-     * @return string
-     * @filter script_loader_tag
-     */
-    public function filterEnqueuedScripts($tag, $handle)
-    {
-        $scripts = [Application::ID.'/google-recaptcha'];
-        if (in_array($handle, apply_filters('site-reviews/async-scripts', $scripts))) {
-            $tag = str_replace(' src=', ' async src=', $tag);
-        }
-        if (in_array($handle, apply_filters('site-reviews/defer-scripts', $scripts))) {
-            $tag = str_replace(' src=', ' defer src=', $tag);
-        }
-        return $tag;
-    }
+	/**
+	 * @param string $tag
+	 * @param string $handle
+	 * @return string
+	 * @filter script_loader_tag
+	 */
+	public function filterEnqueuedScripts($tag, $handle)
+	{
+		$scripts = [Application::ID.'/google-recaptcha'];
+		if (in_array($handle, apply_filters('site-reviews/async-scripts', $scripts))) {
+			$tag = str_replace(' src=', ' async src=', $tag);
+		}
+		if (in_array($handle, apply_filters('site-reviews/defer-scripts', $scripts))) {
+			$tag = str_replace(' src=', ' defer src=', $tag);
+		}
+		return $tag;
+	}
 
-    /**
-     * @return array
-     * @filter site-reviews/config/forms/submission-form
-     */
-    public function filterFieldOrder(array $config)
-    {
-        $order = (array) apply_filters('site-reviews/submission-form/order', array_keys($config));
-        return array_intersect_key(array_merge(array_flip($order), $config), $config);
-    }
+	/**
+	 * @return array
+	 * @filter site-reviews/config/forms/submission-form
+	 */
+	public function filterFieldOrder(array $config)
+	{
+		$order = (array) apply_filters('site-reviews/submission-form/order', array_keys($config));
+		return array_intersect_key(array_merge(array_flip($order), $config), $config);
+	}
 
-    /**
-     * @param string $view
-     * @return string
-     * @filter site-reviews/render/view
-     */
-    public function filterRenderView($view)
-    {
-        return glsr(Style::class)->filterView($view);
-    }
+	/**
+	 * @param string $view
+	 * @return string
+	 * @filter site-reviews/render/view
+	 */
+	public function filterRenderView($view)
+	{
+		return glsr(Style::class)->filterView($view);
+	}
 
-    /**
-     * @return void
-     * @action site-reviews/builder
-     */
-    public function modifyBuilder(Builder $instance)
-    {
-        call_user_func_array([glsr(Style::class), 'modifyField'], [$instance]);
-    }
+	/**
+	 * @return void
+	 * @action site-reviews/builder
+	 */
+	public function modifyBuilder(Builder $instance)
+	{
+		call_user_func_array([glsr(Style::class), 'modifyField'], [$instance]);
+	}
 
-    /**
-     * @return void
-     * @action wp_footer
-     */
-    public function renderSchema()
-    {
-        glsr(Schema::class)->render();
-    }
+	/**
+	 * @return void
+	 * @action wp_footer
+	 */
+	public function renderSchema()
+	{
+		glsr(Schema::class)->render();
+	}
 
-    /**
-     * @return CreateReview
-     */
-    public function routerSubmitReview(array $request)
-    {
-        $validated = glsr(ValidateReview::class)->validate($request);
-        $command = new CreateReview($validated->request);
-        if (empty($validated->error) && !$validated->recaptchaIsUnset) {
-            $this->execute($command);
-        }
-        return $command;
-    }
+	/**
+	 * @return CreateReview
+	 */
+	public function routerSubmitReview(array $request)
+	{
+		$validated = glsr(ValidateReview::class)->validate($request);
+		$command = new CreateReview($validated->request);
+		if (empty($validated->error) && !$validated->recaptchaIsUnset) {
+			$this->execute($command);
+		}
+		return $command;
+	}
 }

plugin/Database/Cache.php

Indentation +57 added lines, -57 removed lines

@@ -6,63 +6,63 @@
 
 class Cache
 {
-    /**
-     * @return array
-     */
-    public function getCloudflareIps()
-    {
-        if (false === ($ipAddresses = get_transient(Application::ID.'_cloudflare_ips'))) {
-            $ipAddresses = array_fill_keys(['v4', 'v6'], []);
-            foreach (array_keys($ipAddresses) as $version) {
-                $url = 'https://www.cloudflare.com/ips-'.$version;
-                $response = wp_remote_get($url, ['sslverify' => false]);
-                if (is_wp_error($response)) {
-                    glsr_log()->error($response->get_error_message());
-                    continue;
-                }
-                if ('200' != ($statusCode = wp_remote_retrieve_response_code($response))) {
-                    glsr_log()->error('Unable to connect to '.$url.' ['.$statusCode.']');
-                    continue;
-                }
-                $ipAddresses[$version] = array_filter(
-                    (array) preg_split('/\R/', wp_remote_retrieve_body($response))
-                );
-            }
-            set_transient(Application::ID.'_cloudflare_ips', $ipAddresses, WEEK_IN_SECONDS);
-        }
-        return $ipAddresses;
-    }
+	/**
+	 * @return array
+	 */
+	public function getCloudflareIps()
+	{
+		if (false === ($ipAddresses = get_transient(Application::ID.'_cloudflare_ips'))) {
+			$ipAddresses = array_fill_keys(['v4', 'v6'], []);
+			foreach (array_keys($ipAddresses) as $version) {
+				$url = 'https://www.cloudflare.com/ips-'.$version;
+				$response = wp_remote_get($url, ['sslverify' => false]);
+				if (is_wp_error($response)) {
+					glsr_log()->error($response->get_error_message());
+					continue;
+				}
+				if ('200' != ($statusCode = wp_remote_retrieve_response_code($response))) {
+					glsr_log()->error('Unable to connect to '.$url.' ['.$statusCode.']');
+					continue;
+				}
+				$ipAddresses[$version] = array_filter(
+					(array) preg_split('/\R/', wp_remote_retrieve_body($response))
+				);
+			}
+			set_transient(Application::ID.'_cloudflare_ips', $ipAddresses, WEEK_IN_SECONDS);
+		}
+		return $ipAddresses;
+	}
 
-    /**
-     * @param string $metaKey
-     * @return array
-     */
-    public function getReviewCountsFor($metaKey)
-    {
-        $counts = wp_cache_get(Application::ID, $metaKey.'_count');
-        if (false === $counts) {
-            $counts = [];
-            $results = glsr(SqlQueries::class)->getReviewCountsFor($metaKey);
-            foreach ($results as $result) {
-                $counts[$result->name] = $result->num_posts;
-            }
-            wp_cache_set(Application::ID, $counts, $metaKey.'_count');
-        }
-        return $counts;
-    }
+	/**
+	 * @param string $metaKey
+	 * @return array
+	 */
+	public function getReviewCountsFor($metaKey)
+	{
+		$counts = wp_cache_get(Application::ID, $metaKey.'_count');
+		if (false === $counts) {
+			$counts = [];
+			$results = glsr(SqlQueries::class)->getReviewCountsFor($metaKey);
+			foreach ($results as $result) {
+				$counts[$result->name] = $result->num_posts;
+			}
+			wp_cache_set(Application::ID, $counts, $metaKey.'_count');
+		}
+		return $counts;
+	}
 
-    /**
-     * @return string
-     */
-    public function getRemotePostTest()
-    {
-        if (false === ($test = get_transient(Application::ID.'_remote_post_test'))) {
-            $response = wp_remote_post('https://api.wordpress.org/stats/php/1.0/');
-            $test = !is_wp_error($response) && in_array($response['response']['code'], range(200, 299))
-                ? 'Works'
-                : 'Does not work';
-            set_transient(Application::ID.'_remote_post_test', $test, WEEK_IN_SECONDS);
-        }
-        return $test;
-    }
+	/**
+	 * @return string
+	 */
+	public function getRemotePostTest()
+	{
+		if (false === ($test = get_transient(Application::ID.'_remote_post_test'))) {
+			$response = wp_remote_post('https://api.wordpress.org/stats/php/1.0/');
+			$test = !is_wp_error($response) && in_array($response['response']['code'], range(200, 299))
+				? 'Works'
+				: 'Does not work';
+			set_transient(Application::ID.'_remote_post_test', $test, WEEK_IN_SECONDS);
+		}
+		return $test;
+	}
 }

plugin/Defaults/CreateReviewDefaults.php

Indentation +36 added lines, -36 removed lines

@@ -6,41 +6,41 @@
 
 class CreateReviewDefaults extends Defaults
 {
-    /**
-     * @var array
-     */
-    protected $guarded = [
-        'assigned_to',
-        'content',
-        'date',
-        'pinned',
-        'response',
-        'review_id',
-        'review_type',
-        'title',
-    ];
+	/**
+	 * @var array
+	 */
+	protected $guarded = [
+		'assigned_to',
+		'content',
+		'date',
+		'pinned',
+		'response',
+		'review_id',
+		'review_type',
+		'title',
+	];
 
-    /**
-     * @return array
-     */
-    protected function defaults()
-    {
-        return [
-            'assigned_to' => '',
-            'author' => '',
-            'avatar' => '',
-            'content' => '',
-            'custom' => '',
-            'date' => '',
-            'email' => '',
-            'ip_address' => '',
-            'pinned' => false,
-            'rating' => '',
-            'response' => '',
-            'review_id' => md5(time().mt_rand()),
-            'review_type' => 'local',
-            'title' => '',
-            'url' => '',
-        ];
-    }
+	/**
+	 * @return array
+	 */
+	protected function defaults()
+	{
+		return [
+			'assigned_to' => '',
+			'author' => '',
+			'avatar' => '',
+			'content' => '',
+			'custom' => '',
+			'date' => '',
+			'email' => '',
+			'ip_address' => '',
+			'pinned' => false,
+			'rating' => '',
+			'response' => '',
+			'review_id' => md5(time().mt_rand()),
+			'review_type' => 'local',
+			'title' => '',
+			'url' => '',
+		];
+	}
 }

plugin/Defaults/ValidateReviewDefaults.php

Indentation +18 added lines, -18 removed lines

@@ -6,22 +6,22 @@
 
 class ValidateReviewDefaults extends Defaults
 {
-    /**
-     * @return array
-     */
-    protected function defaults()
-    {
-        return [
-            'assign_to' => '',
-            'category' => '',
-            'content' => '',
-            'email' => '',
-            'form_id' => '',
-            'ip_address' => '',
-            'name' => '',
-            'rating' => '0',
-            'terms' => '',
-            'title' => '',
-        ];
-    }
+	/**
+	 * @return array
+	 */
+	protected function defaults()
+	{
+		return [
+			'assign_to' => '',
+			'category' => '',
+			'content' => '',
+			'email' => '',
+			'form_id' => '',
+			'ip_address' => '',
+			'name' => '',
+			'rating' => '0',
+			'terms' => '',
+			'title' => '',
+		];
+	}
 }

plugin/Modules/Console.php

Indentation +433 added lines, -433 removed lines

@@ -10,437 +10,437 @@
 
 class Console
 {
-    const DEBUG = 0;      // Detailed debug information
-    const INFO = 1;       // Interesting events
-    const NOTICE = 2;     // Normal but significant events
-    const WARNING = 4;    // Exceptional occurrences that are not errors
-    const ERROR = 8;      // Runtime errors that do not require immediate action
-    const CRITICAL = 16;  // Critical conditions
-    const ALERT = 32;     // Action must be taken immediately
-    const EMERGENCY = 64; // System is unusable
-
-    protected $file;
-    protected $log;
-    protected $logOnceKey = 'glsr_log_once';
-
-    public function __construct()
-    {
-        $this->file = glsr()->path('console.log');
-        $this->log = file_exists($this->file)
-            ? file_get_contents($this->file)
-            : '';
-        $this->reset();
-    }
-
-    /**
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->get();
-    }
-
-    /**
-     * Action must be taken immediately
-     * Example: Entire website down, database unavailable, etc. This should trigger the SMS alerts and wake you up.
-     * @param mixed $message
-     * @param array $context
-     * @return static
-     */
-    public function alert($message, array $context = [])
-    {
-        return $this->log(static::ALERT, $message, $context);
-    }
-
-    /**
-     * @return void
-     */
-    public function clear()
-    {
-        $this->log = '';
-        file_put_contents($this->file, $this->log);
-    }
-
-    /**
-     * Critical conditions
-     * Example: Application component unavailable, unexpected exception.
-     * @param mixed $message
-     * @param array $context
-     * @return static
-     */
-    public function critical($message, array $context = [])
-    {
-        return $this->log(static::CRITICAL, $message, $context);
-    }
-
-    /**
-     * Detailed debug information.
-     * @param mixed $message
-     * @param array $context
-     * @return static
-     */
-    public function debug($message, array $context = [])
-    {
-        return $this->log(static::DEBUG, $message, $context);
-    }
-
-    /**
-     * System is unusable.
-     * @param mixed $message
-     * @param array $context
-     * @return static
-     */
-    public function emergency($message, array $context = [])
-    {
-        return $this->log(static::EMERGENCY, $message, $context);
-    }
-
-    /**
-     * Runtime errors that do not require immediate action but should typically be logged and monitored.
-     * @param mixed $message
-     * @param array $context
-     * @return static
-     */
-    public function error($message, array $context = [])
-    {
-        return $this->log(static::ERROR, $message, $context);
-    }
-
-    /**
-     * @return string
-     */
-    public function get()
-    {
-        return empty($this->log)
-            ? __('Console is empty', 'site-reviews')
-            : $this->log;
-    }
-
-    /**
-     * @return int
-     */
-    public function getLevel()
-    {
-        return intval(apply_filters('site-reviews/console/level', static::INFO));
-    }
-
-    /**
-     * @return array
-     */
-    public function getLevels()
-    {
-        $constants = (new ReflectionClass(__CLASS__))->getConstants();
-        return array_map('strtolower', array_flip($constants));
-    }
-
-    /**
-     * @return string
-     */
-    public function humanLevel()
-    {
-        $level = $this->getLevel();
-        return sprintf('%s (%d)', strtoupper(Arr::get($this->getLevels(), $level, 'unknown')), $level);
-    }
-
-    /**
-     * @param string|null $valueIfEmpty
-     * @return string
-     */
-    public function humanSize($valueIfEmpty = null)
-    {
-        $bytes = $this->size();
-        if (empty($bytes) && is_string($valueIfEmpty)) {
-            return $valueIfEmpty;
-        }
-        $exponent = floor(log(max($bytes, 1), 1024));
-        return round($bytes / pow(1024, $exponent), 2).' '.['bytes', 'KB', 'MB', 'GB'][$exponent];
-    }
-
-    /**
-     * Interesting events
-     * Example: User logs in, SQL logs.
-     * @param mixed $message
-     * @param array $context
-     * @return static
-     */
-    public function info($message, array $context = [])
-    {
-        return $this->log(static::INFO, $message, $context);
-    }
-
-    /**
-     * @param int $level
-     * @param mixed $message
-     * @param array $context
-     * @param string $backtraceLine
-     * @return static
-     */
-    public function log($level, $message, $context = [], $backtraceLine = '')
-    {
-        if (empty($backtraceLine)) {
-            $backtraceLine = $this->getBacktraceLine();
-        }
-        if ($this->canLogEntry($level, $backtraceLine)) {
-            $levelName = Arr::get($this->getLevels(), $level);
-            $context = Arr::consolidateArray($context);
-            $backtraceLine = $this->normalizeBacktraceLine($backtraceLine);
-            $message = $this->interpolate($message, $context);
-            $entry = $this->buildLogEntry($levelName, $message, $backtraceLine);
-            file_put_contents($this->file, $entry.PHP_EOL, FILE_APPEND | LOCK_EX);
-            apply_filters('console', $message, $levelName, $backtraceLine); // Show in Blackbar plugin if installed
-            $this->reset();
-        }
-        return $this;
-    }
-
-    /**
-     * @return void
-     */
-    public function logOnce()
-    {
-        $once = Arr::consolidateArray(glsr()->{$this->logOnceKey});
-        $levels = $this->getLevels();
-        foreach ($once as $entry) {
-            $levelName = Arr::get($entry, 'level');
-            if (!in_array($levelName, $levels)) {
-                continue;
-            }
-            $level = Arr::get(array_flip($levels), $levelName);
-            $message = Arr::get($entry, 'message');
-            $backtraceLine = Arr::get($entry, 'backtrace');
-            $this->log($level, $message, [], $backtraceLine);
-        }
-        glsr()->{$this->logOnceKey} = [];
-    }
-
-    /**
-     * Normal but significant events.
-     * @param mixed $message
-     * @param array $context
-     * @return static
-     */
-    public function notice($message, array $context = [])
-    {
-        return $this->log(static::NOTICE, $message, $context);
-    }
-
-    /**
-     * @param string $levelName
-     * @param string $handle
-     * @param mixed $data
-     * @return void
-     */
-    public function once($levelName, $handle, $data)
-    {
-        $once = Arr::consolidateArray(glsr()->{$this->logOnceKey});
-        $filtered = array_filter($once, function ($entry) use ($levelName, $handle) {
-            return Arr::get($entry, 'level') == $levelName
-                && Arr::get($entry, 'handle') == $handle;
-        });
-        if (!empty($filtered)) {
-            return;
-        }
-        $once[] = [
-            'backtrace' => $this->getBacktraceLineFromData($data),
-            'handle' => $handle,
-            'level' => $levelName,
-            'message' => '[RECURRING] '.$this->getMessageFromData($data),
-        ];
-        glsr()->{$this->logOnceKey} = $once;
-    }
-
-    /**
-     * @return int
-     */
-    public function size()
-    {
-        return file_exists($this->file)
-            ? filesize($this->file)
-            : 0;
-    }
-
-    /**
-     * Exceptional occurrences that are not errors
-     * Example: Use of deprecated APIs, poor use of an API, undesirable things that are not necessarily wrong.
-     * @param mixed $message
-     * @param array $context
-     * @return static
-     */
-    public function warning($message, array $context = [])
-    {
-        return $this->log(static::WARNING, $message, $context);
-    }
-
-    /**
-     * @param array $backtrace
-     * @param int $index
-     * @return string
-     */
-    protected function buildBacktraceLine($backtrace, $index)
-    {
-        return sprintf('%s:%s',
-            Arr::get($backtrace, $index.'.file'), // realpath
-            Arr::get($backtrace, $index.'.line')
-        );
-    }
-
-    /**
-     * @param string $levelName
-     * @param mixed $message
-     * @param string $backtraceLine
-     * @return string
-     */
-    protected function buildLogEntry($levelName, $message, $backtraceLine = '')
-    {
-        return sprintf('[%s] %s [%s] %s',
-            current_time('mysql'),
-            strtoupper($levelName),
-            $backtraceLine,
-            $message
-        );
-    }
-
-    /**
-     * @param int $level
-     * @return bool
-     */
-    protected function canLogEntry($level, $backtraceLine)
-    {
-        $levelExists = array_key_exists($level, $this->getLevels());
-        if (!Str::contains($backtraceLine, glsr()->path())) {
-            return $levelExists; // ignore level restriction if triggered outside of the plugin
-        }
-        return $levelExists && $level >= $this->getLevel();
-    }
-
-    /**
-     * @return void|string
-     */
-    protected function getBacktraceLine()
-    {
-        $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 6);
-        $search = array_search('glsr_log', glsr_array_column($backtrace, 'function'));
-        if (false !== $search) {
-            return $this->buildBacktraceLine($backtrace, (int) $search);
-        }
-        $search = array_search('log', glsr_array_column($backtrace, 'function'));
-        if (false !== $search) {
-            $index = '{closure}' == Arr::get($backtrace, ($search + 2).'.function')
-                ? $search + 4
-                : $search + 1;
-            return $this->buildBacktraceLine($backtrace, $index);
-        }
-        return 'Unknown';
-    }
-
-    /**
-     * @param mixed $data
-     * @return string
-     */
-    protected function getBacktraceLineFromData($data)
-    {
-        $backtrace = $data instanceof Throwable
-            ? $data->getTrace()
-            : debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);
-        return $this->buildBacktraceLine($backtrace, 0);
-    }
-
-    /**
-     * @param mixed $data
-     * @return string
-     */
-    protected function getMessageFromData($data)
-    {
-        return $data instanceof Throwable
-            ? $this->normalizeThrowableMessage($data->getMessage())
-            : print_r($data, 1);
-    }
-
-    /**
-     * Interpolates context values into the message placeholders.
-     * @param mixed $message
-     * @param array $context
-     * @return string
-     */
-    protected function interpolate($message, $context = [])
-    {
-        if ($this->isObjectOrArray($message) || !is_array($context)) {
-            return print_r($message, true);
-        }
-        $replace = [];
-        foreach ($context as $key => $value) {
-            $replace['{'.$key.'}'] = $this->normalizeValue($value);
-        }
-        return strtr($message, $replace);
-    }
-
-    /**
-     * @param mixed $value
-     * @return bool
-     */
-    protected function isObjectOrArray($value)
-    {
-        return is_object($value) || is_array($value);
-    }
-
-    /**
-     * @param string $backtraceLine
-     * @return string
-     */
-    protected function normalizeBacktraceLine($backtraceLine)
-    {
-        $search = [
-            glsr()->path('plugin/'),
-            glsr()->path('plugin/', false),
-            trailingslashit(glsr()->path()),
-            trailingslashit(glsr()->path('', false)),
-            WP_CONTENT_DIR,
-            ABSPATH,
-        ];
-        return str_replace(array_unique($search), '', $backtraceLine);
-    }
-
-    /**
-     * @param string $message
-     * @return string
-     */
-    protected function normalizeThrowableMessage($message)
-    {
-        $calledIn = strpos($message, ', called in');
-        return false !== $calledIn
-            ? substr($message, 0, $calledIn)
-            : $message;
-    }
-
-    /**
-     * @param mixed $value
-     * @return string
-     */
-    protected function normalizeValue($value)
-    {
-        if ($value instanceof DateTime) {
-            $value = $value->format('Y-m-d H:i:s');
-        } elseif ($this->isObjectOrArray($value)) {
-            $value = json_encode($value);
-        }
-        return (string) $value;
-    }
-
-    /**
-     * @return void
-     */
-    protected function reset()
-    {
-        if ($this->size() <= pow(1024, 2) / 8) {
-            return;
-        }
-        $this->clear();
-        file_put_contents(
-            $this->file,
-            $this->buildLogEntry(
-                static::NOTICE,
-                __('Console was automatically cleared (128 KB maximum size)', 'site-reviews')
-            )
-        );
-    }
+	const DEBUG = 0;      // Detailed debug information
+	const INFO = 1;       // Interesting events
+	const NOTICE = 2;     // Normal but significant events
+	const WARNING = 4;    // Exceptional occurrences that are not errors
+	const ERROR = 8;      // Runtime errors that do not require immediate action
+	const CRITICAL = 16;  // Critical conditions
+	const ALERT = 32;     // Action must be taken immediately
+	const EMERGENCY = 64; // System is unusable
+
+	protected $file;
+	protected $log;
+	protected $logOnceKey = 'glsr_log_once';
+
+	public function __construct()
+	{
+		$this->file = glsr()->path('console.log');
+		$this->log = file_exists($this->file)
+			? file_get_contents($this->file)
+			: '';
+		$this->reset();
+	}
+
+	/**
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return $this->get();
+	}
+
+	/**
+	 * Action must be taken immediately
+	 * Example: Entire website down, database unavailable, etc. This should trigger the SMS alerts and wake you up.
+	 * @param mixed $message
+	 * @param array $context
+	 * @return static
+	 */
+	public function alert($message, array $context = [])
+	{
+		return $this->log(static::ALERT, $message, $context);
+	}
+
+	/**
+	 * @return void
+	 */
+	public function clear()
+	{
+		$this->log = '';
+		file_put_contents($this->file, $this->log);
+	}
+
+	/**
+	 * Critical conditions
+	 * Example: Application component unavailable, unexpected exception.
+	 * @param mixed $message
+	 * @param array $context
+	 * @return static
+	 */
+	public function critical($message, array $context = [])
+	{
+		return $this->log(static::CRITICAL, $message, $context);
+	}
+
+	/**
+	 * Detailed debug information.
+	 * @param mixed $message
+	 * @param array $context
+	 * @return static
+	 */
+	public function debug($message, array $context = [])
+	{
+		return $this->log(static::DEBUG, $message, $context);
+	}
+
+	/**
+	 * System is unusable.
+	 * @param mixed $message
+	 * @param array $context
+	 * @return static
+	 */
+	public function emergency($message, array $context = [])
+	{
+		return $this->log(static::EMERGENCY, $message, $context);
+	}
+
+	/**
+	 * Runtime errors that do not require immediate action but should typically be logged and monitored.
+	 * @param mixed $message
+	 * @param array $context
+	 * @return static
+	 */
+	public function error($message, array $context = [])
+	{
+		return $this->log(static::ERROR, $message, $context);
+	}
+
+	/**
+	 * @return string
+	 */
+	public function get()
+	{
+		return empty($this->log)
+			? __('Console is empty', 'site-reviews')
+			: $this->log;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getLevel()
+	{
+		return intval(apply_filters('site-reviews/console/level', static::INFO));
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getLevels()
+	{
+		$constants = (new ReflectionClass(__CLASS__))->getConstants();
+		return array_map('strtolower', array_flip($constants));
+	}
+
+	/**
+	 * @return string
+	 */
+	public function humanLevel()
+	{
+		$level = $this->getLevel();
+		return sprintf('%s (%d)', strtoupper(Arr::get($this->getLevels(), $level, 'unknown')), $level);
+	}
+
+	/**
+	 * @param string|null $valueIfEmpty
+	 * @return string
+	 */
+	public function humanSize($valueIfEmpty = null)
+	{
+		$bytes = $this->size();
+		if (empty($bytes) && is_string($valueIfEmpty)) {
+			return $valueIfEmpty;
+		}
+		$exponent = floor(log(max($bytes, 1), 1024));
+		return round($bytes / pow(1024, $exponent), 2).' '.['bytes', 'KB', 'MB', 'GB'][$exponent];
+	}
+
+	/**
+	 * Interesting events
+	 * Example: User logs in, SQL logs.
+	 * @param mixed $message
+	 * @param array $context
+	 * @return static
+	 */
+	public function info($message, array $context = [])
+	{
+		return $this->log(static::INFO, $message, $context);
+	}
+
+	/**
+	 * @param int $level
+	 * @param mixed $message
+	 * @param array $context
+	 * @param string $backtraceLine
+	 * @return static
+	 */
+	public function log($level, $message, $context = [], $backtraceLine = '')
+	{
+		if (empty($backtraceLine)) {
+			$backtraceLine = $this->getBacktraceLine();
+		}
+		if ($this->canLogEntry($level, $backtraceLine)) {
+			$levelName = Arr::get($this->getLevels(), $level);
+			$context = Arr::consolidateArray($context);
+			$backtraceLine = $this->normalizeBacktraceLine($backtraceLine);
+			$message = $this->interpolate($message, $context);
+			$entry = $this->buildLogEntry($levelName, $message, $backtraceLine);
+			file_put_contents($this->file, $entry.PHP_EOL, FILE_APPEND | LOCK_EX);
+			apply_filters('console', $message, $levelName, $backtraceLine); // Show in Blackbar plugin if installed
+			$this->reset();
+		}
+		return $this;
+	}
+
+	/**
+	 * @return void
+	 */
+	public function logOnce()
+	{
+		$once = Arr::consolidateArray(glsr()->{$this->logOnceKey});
+		$levels = $this->getLevels();
+		foreach ($once as $entry) {
+			$levelName = Arr::get($entry, 'level');
+			if (!in_array($levelName, $levels)) {
+				continue;
+			}
+			$level = Arr::get(array_flip($levels), $levelName);
+			$message = Arr::get($entry, 'message');
+			$backtraceLine = Arr::get($entry, 'backtrace');
+			$this->log($level, $message, [], $backtraceLine);
+		}
+		glsr()->{$this->logOnceKey} = [];
+	}
+
+	/**
+	 * Normal but significant events.
+	 * @param mixed $message
+	 * @param array $context
+	 * @return static
+	 */
+	public function notice($message, array $context = [])
+	{
+		return $this->log(static::NOTICE, $message, $context);
+	}
+
+	/**
+	 * @param string $levelName
+	 * @param string $handle
+	 * @param mixed $data
+	 * @return void
+	 */
+	public function once($levelName, $handle, $data)
+	{
+		$once = Arr::consolidateArray(glsr()->{$this->logOnceKey});
+		$filtered = array_filter($once, function ($entry) use ($levelName, $handle) {
+			return Arr::get($entry, 'level') == $levelName
+				&& Arr::get($entry, 'handle') == $handle;
+		});
+		if (!empty($filtered)) {
+			return;
+		}
+		$once[] = [
+			'backtrace' => $this->getBacktraceLineFromData($data),
+			'handle' => $handle,
+			'level' => $levelName,
+			'message' => '[RECURRING] '.$this->getMessageFromData($data),
+		];
+		glsr()->{$this->logOnceKey} = $once;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function size()
+	{
+		return file_exists($this->file)
+			? filesize($this->file)
+			: 0;
+	}
+
+	/**
+	 * Exceptional occurrences that are not errors
+	 * Example: Use of deprecated APIs, poor use of an API, undesirable things that are not necessarily wrong.
+	 * @param mixed $message
+	 * @param array $context
+	 * @return static
+	 */
+	public function warning($message, array $context = [])
+	{
+		return $this->log(static::WARNING, $message, $context);
+	}
+
+	/**
+	 * @param array $backtrace
+	 * @param int $index
+	 * @return string
+	 */
+	protected function buildBacktraceLine($backtrace, $index)
+	{
+		return sprintf('%s:%s',
+			Arr::get($backtrace, $index.'.file'), // realpath
+			Arr::get($backtrace, $index.'.line')
+		);
+	}
+
+	/**
+	 * @param string $levelName
+	 * @param mixed $message
+	 * @param string $backtraceLine
+	 * @return string
+	 */
+	protected function buildLogEntry($levelName, $message, $backtraceLine = '')
+	{
+		return sprintf('[%s] %s [%s] %s',
+			current_time('mysql'),
+			strtoupper($levelName),
+			$backtraceLine,
+			$message
+		);
+	}
+
+	/**
+	 * @param int $level
+	 * @return bool
+	 */
+	protected function canLogEntry($level, $backtraceLine)
+	{
+		$levelExists = array_key_exists($level, $this->getLevels());
+		if (!Str::contains($backtraceLine, glsr()->path())) {
+			return $levelExists; // ignore level restriction if triggered outside of the plugin
+		}
+		return $levelExists && $level >= $this->getLevel();
+	}
+
+	/**
+	 * @return void|string
+	 */
+	protected function getBacktraceLine()
+	{
+		$backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 6);
+		$search = array_search('glsr_log', glsr_array_column($backtrace, 'function'));
+		if (false !== $search) {
+			return $this->buildBacktraceLine($backtrace, (int) $search);
+		}
+		$search = array_search('log', glsr_array_column($backtrace, 'function'));
+		if (false !== $search) {
+			$index = '{closure}' == Arr::get($backtrace, ($search + 2).'.function')
+				? $search + 4
+				: $search + 1;
+			return $this->buildBacktraceLine($backtrace, $index);
+		}
+		return 'Unknown';
+	}
+
+	/**
+	 * @param mixed $data
+	 * @return string
+	 */
+	protected function getBacktraceLineFromData($data)
+	{
+		$backtrace = $data instanceof Throwable
+			? $data->getTrace()
+			: debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);
+		return $this->buildBacktraceLine($backtrace, 0);
+	}
+
+	/**
+	 * @param mixed $data
+	 * @return string
+	 */
+	protected function getMessageFromData($data)
+	{
+		return $data instanceof Throwable
+			? $this->normalizeThrowableMessage($data->getMessage())
+			: print_r($data, 1);
+	}
+
+	/**
+	 * Interpolates context values into the message placeholders.
+	 * @param mixed $message
+	 * @param array $context
+	 * @return string
+	 */
+	protected function interpolate($message, $context = [])
+	{
+		if ($this->isObjectOrArray($message) || !is_array($context)) {
+			return print_r($message, true);
+		}
+		$replace = [];
+		foreach ($context as $key => $value) {
+			$replace['{'.$key.'}'] = $this->normalizeValue($value);
+		}
+		return strtr($message, $replace);
+	}
+
+	/**
+	 * @param mixed $value
+	 * @return bool
+	 */
+	protected function isObjectOrArray($value)
+	{
+		return is_object($value) || is_array($value);
+	}
+
+	/**
+	 * @param string $backtraceLine
+	 * @return string
+	 */
+	protected function normalizeBacktraceLine($backtraceLine)
+	{
+		$search = [
+			glsr()->path('plugin/'),
+			glsr()->path('plugin/', false),
+			trailingslashit(glsr()->path()),
+			trailingslashit(glsr()->path('', false)),
+			WP_CONTENT_DIR,
+			ABSPATH,
+		];
+		return str_replace(array_unique($search), '', $backtraceLine);
+	}
+
+	/**
+	 * @param string $message
+	 * @return string
+	 */
+	protected function normalizeThrowableMessage($message)
+	{
+		$calledIn = strpos($message, ', called in');
+		return false !== $calledIn
+			? substr($message, 0, $calledIn)
+			: $message;
+	}
+
+	/**
+	 * @param mixed $value
+	 * @return string
+	 */
+	protected function normalizeValue($value)
+	{
+		if ($value instanceof DateTime) {
+			$value = $value->format('Y-m-d H:i:s');
+		} elseif ($this->isObjectOrArray($value)) {
+			$value = json_encode($value);
+		}
+		return (string) $value;
+	}
+
+	/**
+	 * @return void
+	 */
+	protected function reset()
+	{
+		if ($this->size() <= pow(1024, 2) / 8) {
+			return;
+		}
+		$this->clear();
+		file_put_contents(
+			$this->file,
+			$this->buildLogEntry(
+				static::NOTICE,
+				__('Console was automatically cleared (128 KB maximum size)', 'site-reviews')
+			)
+		);
+	}
 }

deprecated.php

Indentation +116 added lines, -116 removed lines

@@ -3,134 +3,134 @@
 defined('WPINC') || die;
 
 if (apply_filters('site-reviews/support/deprecated/v4', true)) {
-    // Unprotected review meta has been deprecated
-    add_filter('get_post_metadata', function ($data, $postId, $metaKey, $single) {
-        $metaKeys = array_keys(glsr('Defaults\CreateReviewDefaults')->defaults());
-        if (!in_array($metaKey, $metaKeys) || glsr()->post_type != get_post_type($postId)) {
-            return $data;
-        }
-        glsr()->deprecated[] = sprintf(
-            'The "%1$s" meta_key has been deprecated for Reviews. Please use the protected "_%1$s" meta_key instead.',
-            $metaKey
-        );
-        return get_post_meta($postId, '_'.$metaKey, $single);
-    }, 10, 4);
+	// Unprotected review meta has been deprecated
+	add_filter('get_post_metadata', function ($data, $postId, $metaKey, $single) {
+		$metaKeys = array_keys(glsr('Defaults\CreateReviewDefaults')->defaults());
+		if (!in_array($metaKey, $metaKeys) || glsr()->post_type != get_post_type($postId)) {
+			return $data;
+		}
+		glsr()->deprecated[] = sprintf(
+			'The "%1$s" meta_key has been deprecated for Reviews. Please use the protected "_%1$s" meta_key instead.',
+			$metaKey
+		);
+		return get_post_meta($postId, '_'.$metaKey, $single);
+	}, 10, 4);
 
-    // Modules/Html/Template.php
-    add_filter('site-reviews/interpolate/reviews', function ($context, $template) {
-        $search = '{{ navigation }}';
-        if (false !== strpos($template, $search)) {
-            $context['navigation'] = $context['pagination'];
-            glsr()->deprecated[] = 'The {{ navigation }} template key in "YOUR_THEME/site-reviews/reviews.php" has been deprecated. Please use the {{ pagination }} template key instead.';
-        }
-        return $context;
-    }, 10, 2);
+	// Modules/Html/Template.php
+	add_filter('site-reviews/interpolate/reviews', function ($context, $template) {
+		$search = '{{ navigation }}';
+		if (false !== strpos($template, $search)) {
+			$context['navigation'] = $context['pagination'];
+			glsr()->deprecated[] = 'The {{ navigation }} template key in "YOUR_THEME/site-reviews/reviews.php" has been deprecated. Please use the {{ pagination }} template key instead.';
+		}
+		return $context;
+	}, 10, 2);
 
-    // Database/ReviewManager.php
-    add_action('site-reviews/review/created', function ($review) {
-        if (has_action('site-reviews/local/review/create')) {
-            glsr()->deprecated[] = 'The "site-reviews/local/review/create" hook has been deprecated. Please use the "site-reviews/review/created" hook instead.';
-            do_action('site-reviews/local/review/create', (array) get_post($review->ID), (array) $review, $review->ID);
-        }
-    }, 9);
+	// Database/ReviewManager.php
+	add_action('site-reviews/review/created', function ($review) {
+		if (has_action('site-reviews/local/review/create')) {
+			glsr()->deprecated[] = 'The "site-reviews/local/review/create" hook has been deprecated. Please use the "site-reviews/review/created" hook instead.';
+			do_action('site-reviews/local/review/create', (array) get_post($review->ID), (array) $review, $review->ID);
+		}
+	}, 9);
 
-    // Handlers/CreateReview.php
-    add_action('site-reviews/review/submitted', function ($review) {
-        if (has_action('site-reviews/local/review/submitted')) {
-            glsr()->deprecated[] = 'The "site-reviews/local/review/submitted" hook has been deprecated. Please use the "site-reviews/review/submitted" hook instead.';
-            do_action('site-reviews/local/review/submitted', null, $review);
-        }
-        if (has_filter('site-reviews/local/review/submitted/message')) {
-            glsr()->deprecated[] = 'The "site-reviews/local/review/submitted/message" hook has been deprecated.';
-        }
-    }, 9);
+	// Handlers/CreateReview.php
+	add_action('site-reviews/review/submitted', function ($review) {
+		if (has_action('site-reviews/local/review/submitted')) {
+			glsr()->deprecated[] = 'The "site-reviews/local/review/submitted" hook has been deprecated. Please use the "site-reviews/review/submitted" hook instead.';
+			do_action('site-reviews/local/review/submitted', null, $review);
+		}
+		if (has_filter('site-reviews/local/review/submitted/message')) {
+			glsr()->deprecated[] = 'The "site-reviews/local/review/submitted/message" hook has been deprecated.';
+		}
+	}, 9);
 
-    // Database/ReviewManager.php
-    add_filter('site-reviews/create/review-values', function ($values, $command) {
-        if (has_filter('site-reviews/local/review')) {
-            glsr()->deprecated[] = 'The "site-reviews/local/review" hook has been deprecated. Please use the "site-reviews/create/review-values" hook instead.';
-            return apply_filters('site-reviews/local/review', $values, $command);
-        }
-        return $values;
-    }, 9, 2);
+	// Database/ReviewManager.php
+	add_filter('site-reviews/create/review-values', function ($values, $command) {
+		if (has_filter('site-reviews/local/review')) {
+			glsr()->deprecated[] = 'The "site-reviews/local/review" hook has been deprecated. Please use the "site-reviews/create/review-values" hook instead.';
+			return apply_filters('site-reviews/local/review', $values, $command);
+		}
+		return $values;
+	}, 9, 2);
 
-    // Handlers/EnqueuePublicAssets.php
-    add_filter('site-reviews/enqueue/public/localize', function ($variables) {
-        if (has_filter('site-reviews/enqueue/localize')) {
-            glsr()->deprecated[] = 'The "site-reviews/enqueue/localize" hook has been deprecated. Please use the "site-reviews/enqueue/public/localize" hook instead.';
-            return apply_filters('site-reviews/enqueue/localize', $variables);
-        }
-        return $variables;
-    }, 9);
+	// Handlers/EnqueuePublicAssets.php
+	add_filter('site-reviews/enqueue/public/localize', function ($variables) {
+		if (has_filter('site-reviews/enqueue/localize')) {
+			glsr()->deprecated[] = 'The "site-reviews/enqueue/localize" hook has been deprecated. Please use the "site-reviews/enqueue/public/localize" hook instead.';
+			return apply_filters('site-reviews/enqueue/localize', $variables);
+		}
+		return $variables;
+	}, 9);
 
-    // Modules/Rating.php
-    add_filter('site-reviews/rating/average', function ($average) {
-        if (has_filter('site-reviews/average/rating')) {
-            glsr()->deprecated[] = 'The "site-reviews/average/rating" hook has been deprecated. Please use the "site-reviews/rating/average" hook instead.';
-        }
-        return $average;
-    }, 9);
+	// Modules/Rating.php
+	add_filter('site-reviews/rating/average', function ($average) {
+		if (has_filter('site-reviews/average/rating')) {
+			glsr()->deprecated[] = 'The "site-reviews/average/rating" hook has been deprecated. Please use the "site-reviews/rating/average" hook instead.';
+		}
+		return $average;
+	}, 9);
 
-    // Modules/Rating.php
-    add_filter('site-reviews/rating/ranking', function ($ranking) {
-        if (has_filter('site-reviews/bayesian/ranking')) {
-            glsr()->deprecated[] = 'The "site-reviews/bayesian/ranking" hook has been deprecated. Please use the "site-reviews/rating/ranking" hook instead.';
-        }
-        return $ranking;
-    }, 9);
+	// Modules/Rating.php
+	add_filter('site-reviews/rating/ranking', function ($ranking) {
+		if (has_filter('site-reviews/bayesian/ranking')) {
+			glsr()->deprecated[] = 'The "site-reviews/bayesian/ranking" hook has been deprecated. Please use the "site-reviews/rating/ranking" hook instead.';
+		}
+		return $ranking;
+	}, 9);
 
-    // Modules/Html/Partials/SiteReviews.php
-    add_filter('site-reviews/review/build/after', function ($renderedFields) {
-        if (has_filter('site-reviews/reviews/review/text')) {
-            glsr()->deprecated[] = 'The "site-reviews/reviews/review/text" hook has been deprecated. Please use the "site-reviews/review/build/after" hook instead.';
-        }
-        if (has_filter('site-reviews/reviews/review/title')) {
-            glsr()->deprecated[] = 'The "site-reviews/reviews/review/title" hook has been deprecated. Please use the "site-reviews/review/build/after" hook instead.';
-        }
-        return $renderedFields;
-    }, 9);
+	// Modules/Html/Partials/SiteReviews.php
+	add_filter('site-reviews/review/build/after', function ($renderedFields) {
+		if (has_filter('site-reviews/reviews/review/text')) {
+			glsr()->deprecated[] = 'The "site-reviews/reviews/review/text" hook has been deprecated. Please use the "site-reviews/review/build/after" hook instead.';
+		}
+		if (has_filter('site-reviews/reviews/review/title')) {
+			glsr()->deprecated[] = 'The "site-reviews/reviews/review/title" hook has been deprecated. Please use the "site-reviews/review/build/after" hook instead.';
+		}
+		return $renderedFields;
+	}, 9);
 
-    // Modules/Html/Partials/SiteReviews.php
-    add_filter('site-reviews/review/build/before', function ($review) {
-        if (has_filter('site-reviews/rendered/review')) {
-            glsr()->deprecated[] = 'The "site-reviews/rendered/review" hook has been deprecated. Please either use a custom "review.php" template (refer to the documentation), or use the "site-reviews/review/build/after" hook instead.';
-        }
-        if (has_filter('site-reviews/rendered/review/meta/order')) {
-            glsr()->deprecated[] = 'The "site-reviews/rendered/review/meta/order" hook has been deprecated. Please use a custom "review.php" template instead (refer to the documentation).';
-        }
-        if (has_filter('site-reviews/rendered/review/order')) {
-            glsr()->deprecated[] = 'The "site-reviews/rendered/review/order" hook has been deprecated. Please use a custom "review.php" template instead (refer to the documentation).';
-        }
-        if (has_filter('site-reviews/rendered/review-form/login-register')) {
-            glsr()->deprecated[] = 'The "site-reviews/rendered/review-form/login-register" hook has been deprecated. Please use a custom "login-register.php" template instead (refer to the documentation).';
-        }
-        if (has_filter('site-reviews/reviews/navigation_links')) {
-            glsr()->deprecated[] = 'The "site-reviews/reviews/navigation_links" hook has been deprecated. Please use a custom "pagination.php" template instead (refer to the documentation).';
-        }
-        return $review;
-    }, 9);
+	// Modules/Html/Partials/SiteReviews.php
+	add_filter('site-reviews/review/build/before', function ($review) {
+		if (has_filter('site-reviews/rendered/review')) {
+			glsr()->deprecated[] = 'The "site-reviews/rendered/review" hook has been deprecated. Please either use a custom "review.php" template (refer to the documentation), or use the "site-reviews/review/build/after" hook instead.';
+		}
+		if (has_filter('site-reviews/rendered/review/meta/order')) {
+			glsr()->deprecated[] = 'The "site-reviews/rendered/review/meta/order" hook has been deprecated. Please use a custom "review.php" template instead (refer to the documentation).';
+		}
+		if (has_filter('site-reviews/rendered/review/order')) {
+			glsr()->deprecated[] = 'The "site-reviews/rendered/review/order" hook has been deprecated. Please use a custom "review.php" template instead (refer to the documentation).';
+		}
+		if (has_filter('site-reviews/rendered/review-form/login-register')) {
+			glsr()->deprecated[] = 'The "site-reviews/rendered/review-form/login-register" hook has been deprecated. Please use a custom "login-register.php" template instead (refer to the documentation).';
+		}
+		if (has_filter('site-reviews/reviews/navigation_links')) {
+			glsr()->deprecated[] = 'The "site-reviews/reviews/navigation_links" hook has been deprecated. Please use a custom "pagination.php" template instead (refer to the documentation).';
+		}
+		return $review;
+	}, 9);
 
-    add_filter('site-reviews/validate/custom', function ($result, $request) {
-        if (has_filter('site-reviews/validate/review/submission')) {
-            glsr_log()->warning('The "site-reviews/validate/review/submission" hook has been deprecated. Please use the "site-reviews/validate/custom" hook instead.');
-            return apply_filters('site-reviews/validate/review/submission', $result, $request);
-        }
-        return $result;
-    }, 9, 2);
+	add_filter('site-reviews/validate/custom', function ($result, $request) {
+		if (has_filter('site-reviews/validate/review/submission')) {
+			glsr_log()->warning('The "site-reviews/validate/review/submission" hook has been deprecated. Please use the "site-reviews/validate/custom" hook instead.');
+			return apply_filters('site-reviews/validate/review/submission', $result, $request);
+		}
+		return $result;
+	}, 9, 2);
 
-    add_filter('site-reviews/views/file', function ($file, $view, $data) {
-        if (has_filter('site-reviews/addon/views/file')) {
-            glsr()->deprecated[] = 'The "site-reviews/addon/views/file" hook has been deprecated. Please use the "site-reviews/views/file" hook instead.';
-            $file = apply_filters('site-reviews/addon/views/file', $file, $view, $data);
-        }
-        return $file;
-    }, 9, 3);
+	add_filter('site-reviews/views/file', function ($file, $view, $data) {
+		if (has_filter('site-reviews/addon/views/file')) {
+			glsr()->deprecated[] = 'The "site-reviews/addon/views/file" hook has been deprecated. Please use the "site-reviews/views/file" hook instead.';
+			$file = apply_filters('site-reviews/addon/views/file', $file, $view, $data);
+		}
+		return $file;
+	}, 9, 3);
 }
 
 add_action('wp_footer', function () {
-    $notices = array_keys(array_flip(glsr()->deprecated));
-    natsort($notices);
-    foreach ($notices as $notice) {
-        glsr_log()->warning($notice);
-    }
+	$notices = array_keys(array_flip(glsr()->deprecated));
+	natsort($notices);
+	foreach ($notices as $notice) {
+		glsr_log()->warning($notice);
+	}
 });

plugin/Defaults/StyleValidationDefaults.php

Indentation +19 added lines, -19 removed lines

@@ -6,23 +6,23 @@
 
 class StyleValidationDefaults extends Defaults
 {
-    /**
-     * @return array
-     */
-    protected function defaults()
-    {
-        return [
-            'error_tag' => 'div',
-            'error_tag_class' => 'glsr-field-error',
-            'field_class' => 'glsr-field',
-            'field_error_class' => 'glsr-has-error',
-            'input_error_class' => 'glsr-is-invalid',
-            'input_valid_class' => 'glsr-is-valid',
-            'message_error_class' => 'glsr-has-errors',
-            'message_initial_class' => 'glsr-is-visible',
-            'message_success_class' => 'glsr-has-success',
-            'message_tag' => 'div',
-            'message_tag_class' => 'glsr-form-message',
-        ];
-    }
+	/**
+	 * @return array
+	 */
+	protected function defaults()
+	{
+		return [
+			'error_tag' => 'div',
+			'error_tag_class' => 'glsr-field-error',
+			'field_class' => 'glsr-field',
+			'field_error_class' => 'glsr-has-error',
+			'input_error_class' => 'glsr-is-invalid',
+			'input_valid_class' => 'glsr-is-valid',
+			'message_error_class' => 'glsr-has-errors',
+			'message_initial_class' => 'glsr-is-visible',
+			'message_success_class' => 'glsr-has-success',
+			'message_tag' => 'div',
+			'message_tag_class' => 'glsr-form-message',
+		];
+	}
 }

plugin/Handlers/EnqueueAdminAssets.php

Indentation +146 added lines, -146 removed lines

@@ -10,158 +10,158 @@
 
 class EnqueueAdminAssets
 {
-    /**
-     * @var array
-     */
-    protected $pointers;
+	/**
+	 * @var array
+	 */
+	protected $pointers;
 
-    /**
-     * @return void
-     */
-    public function handle(Command $command)
-    {
-        $this->generatePointers($command->pointers);
-        $this->enqueueAssets();
-        $this->localizeAssets();
-    }
+	/**
+	 * @return void
+	 */
+	public function handle(Command $command)
+	{
+		$this->generatePointers($command->pointers);
+		$this->enqueueAssets();
+		$this->localizeAssets();
+	}
 
-    /**
-     * @return void
-     */
-    public function enqueueAssets()
-    {
-        if (!$this->isCurrentScreen()) {
-            return;
-        }
-        wp_enqueue_style(
-            Application::ID,
-            glsr()->url('assets/styles/'.Application::ID.'-admin.css'),
-            [],
-            glsr()->version
-        );
-        wp_enqueue_script(
-            Application::ID,
-            glsr()->url('assets/scripts/'.Application::ID.'-admin.js'),
-            $this->getDependencies(),
-            glsr()->version,
-            true
-        );
-        if (!empty($this->pointers)) {
-            wp_enqueue_style('wp-pointer');
-            wp_enqueue_script('wp-pointer');
-        }
-    }
+	/**
+	 * @return void
+	 */
+	public function enqueueAssets()
+	{
+		if (!$this->isCurrentScreen()) {
+			return;
+		}
+		wp_enqueue_style(
+			Application::ID,
+			glsr()->url('assets/styles/'.Application::ID.'-admin.css'),
+			[],
+			glsr()->version
+		);
+		wp_enqueue_script(
+			Application::ID,
+			glsr()->url('assets/scripts/'.Application::ID.'-admin.js'),
+			$this->getDependencies(),
+			glsr()->version,
+			true
+		);
+		if (!empty($this->pointers)) {
+			wp_enqueue_style('wp-pointer');
+			wp_enqueue_script('wp-pointer');
+		}
+	}
 
-    /**
-     * @return void
-     */
-    public function localizeAssets()
-    {
-        $variables = [
-            'action' => Application::PREFIX.'action',
-            'addons' => [],
-            'ajaxurl' => admin_url('admin-ajax.php'),
-            'hideoptions' => [
-                'site_reviews' => glsr(SiteReviewsShortcode::class)->getHideOptions(),
-                'site_reviews_form' => glsr(SiteReviewsFormShortcode::class)->getHideOptions(),
-                'site_reviews_summary' => glsr(SiteReviewsSummaryShortcode::class)->getHideOptions(),
-            ],
-            'nameprefix' => Application::ID,
-            'nonce' => [
-                'change-status' => wp_create_nonce('change-status'),
-                'clear-console' => wp_create_nonce('clear-console'),
-                'count-reviews' => wp_create_nonce('count-reviews'),
-                'fetch-console' => wp_create_nonce('fetch-console'),
-                'mce-shortcode' => wp_create_nonce('mce-shortcode'),
-                'sync-reviews' => wp_create_nonce('sync-reviews'),
-                'toggle-pinned' => wp_create_nonce('toggle-pinned'),
-            ],
-            'pointers' => $this->pointers,
-            'shortcodes' => [],
-            'tinymce' => [
-                'glsr_shortcode' => glsr()->url('assets/scripts/mce-plugin.js'),
-            ],
-        ];
-        if (user_can_richedit()) {
-            $variables['shortcodes'] = $this->localizeShortcodes();
-        }
-        $variables = apply_filters('site-reviews/enqueue/admin/localize', $variables);
-        wp_localize_script(Application::ID, 'GLSR', $variables);
-    }
+	/**
+	 * @return void
+	 */
+	public function localizeAssets()
+	{
+		$variables = [
+			'action' => Application::PREFIX.'action',
+			'addons' => [],
+			'ajaxurl' => admin_url('admin-ajax.php'),
+			'hideoptions' => [
+				'site_reviews' => glsr(SiteReviewsShortcode::class)->getHideOptions(),
+				'site_reviews_form' => glsr(SiteReviewsFormShortcode::class)->getHideOptions(),
+				'site_reviews_summary' => glsr(SiteReviewsSummaryShortcode::class)->getHideOptions(),
+			],
+			'nameprefix' => Application::ID,
+			'nonce' => [
+				'change-status' => wp_create_nonce('change-status'),
+				'clear-console' => wp_create_nonce('clear-console'),
+				'count-reviews' => wp_create_nonce('count-reviews'),
+				'fetch-console' => wp_create_nonce('fetch-console'),
+				'mce-shortcode' => wp_create_nonce('mce-shortcode'),
+				'sync-reviews' => wp_create_nonce('sync-reviews'),
+				'toggle-pinned' => wp_create_nonce('toggle-pinned'),
+			],
+			'pointers' => $this->pointers,
+			'shortcodes' => [],
+			'tinymce' => [
+				'glsr_shortcode' => glsr()->url('assets/scripts/mce-plugin.js'),
+			],
+		];
+		if (user_can_richedit()) {
+			$variables['shortcodes'] = $this->localizeShortcodes();
+		}
+		$variables = apply_filters('site-reviews/enqueue/admin/localize', $variables);
+		wp_localize_script(Application::ID, 'GLSR', $variables);
+	}
 
-    /**
-     * @return array
-     */
-    protected function getDependencies()
-    {
-        $dependencies = apply_filters('site-reviews/enqueue/admin/dependencies', []);
-        $dependencies = array_merge($dependencies, [
-            'jquery', 'jquery-ui-sortable', 'underscore', 'wp-util',
-        ]);
-        return $dependencies;
-    }
+	/**
+	 * @return array
+	 */
+	protected function getDependencies()
+	{
+		$dependencies = apply_filters('site-reviews/enqueue/admin/dependencies', []);
+		$dependencies = array_merge($dependencies, [
+			'jquery', 'jquery-ui-sortable', 'underscore', 'wp-util',
+		]);
+		return $dependencies;
+	}
 
-    /**
-     * @return array
-     */
-    protected function generatePointer(array $pointer)
-    {
-        return [
-            'id' => $pointer['id'],
-            'options' => [
-                'content' => '<h3>'.$pointer['title'].'</h3><p>'.$pointer['content'].'</p>',
-                'position' => $pointer['position'],
-            ],
-            'screen' => $pointer['screen'],
-            'target' => $pointer['target'],
-        ];
-    }
+	/**
+	 * @return array
+	 */
+	protected function generatePointer(array $pointer)
+	{
+		return [
+			'id' => $pointer['id'],
+			'options' => [
+				'content' => '<h3>'.$pointer['title'].'</h3><p>'.$pointer['content'].'</p>',
+				'position' => $pointer['position'],
+			],
+			'screen' => $pointer['screen'],
+			'target' => $pointer['target'],
+		];
+	}
 
-    /**
-     * @return void
-     */
-    protected function generatePointers(array $pointers)
-    {
-        $dismissedPointers = get_user_meta(get_current_user_id(), 'dismissed_wp_pointers', true);
-        $dismissedPointers = explode(',', (string) $dismissedPointers);
-        $generatedPointers = [];
-        foreach ($pointers as $pointer) {
-            if ($pointer['screen'] != glsr_current_screen()->id) {
-                continue;
-            }
-            if (in_array($pointer['id'], $dismissedPointers)) {
-                continue;
-            }
-            $generatedPointers[] = $this->generatePointer($pointer);
-        }
-        $this->pointers = $generatedPointers;
-    }
+	/**
+	 * @return void
+	 */
+	protected function generatePointers(array $pointers)
+	{
+		$dismissedPointers = get_user_meta(get_current_user_id(), 'dismissed_wp_pointers', true);
+		$dismissedPointers = explode(',', (string) $dismissedPointers);
+		$generatedPointers = [];
+		foreach ($pointers as $pointer) {
+			if ($pointer['screen'] != glsr_current_screen()->id) {
+				continue;
+			}
+			if (in_array($pointer['id'], $dismissedPointers)) {
+				continue;
+			}
+			$generatedPointers[] = $this->generatePointer($pointer);
+		}
+		$this->pointers = $generatedPointers;
+	}
 
-    /**
-     * @return bool
-     */
-    protected function isCurrentScreen()
-    {
-        $screen = glsr_current_screen();
-        return Application::POST_TYPE == $screen->post_type
-            || 'dashboard' == $screen->id
-            || 'plugins_page_'.Application::ID == $screen->id
-            || 'post' == $screen->base
-            || 'widgets' == $screen->id;
-    }
+	/**
+	 * @return bool
+	 */
+	protected function isCurrentScreen()
+	{
+		$screen = glsr_current_screen();
+		return Application::POST_TYPE == $screen->post_type
+			|| 'dashboard' == $screen->id
+			|| 'plugins_page_'.Application::ID == $screen->id
+			|| 'post' == $screen->base
+			|| 'widgets' == $screen->id;
+	}
 
-    /**
-     * @return array
-     */
-    protected function localizeShortcodes()
-    {
-        $variables = [];
-        foreach (glsr()->mceShortcodes as $tag => $args) {
-            if (empty($args['required'])) {
-                continue;
-            }
-            $variables[$tag] = $args['required'];
-        }
-        return $variables;
-    }
+	/**
+	 * @return array
+	 */
+	protected function localizeShortcodes()
+	{
+		$variables = [];
+		foreach (glsr()->mceShortcodes as $tag => $args) {
+			if (empty($args['required'])) {
+				continue;
+			}
+			$variables[$tag] = $args['required'];
+		}
+		return $variables;
+	}
 }

plugin/Modules/Rating.php

Indentation +191 added lines, -191 removed lines

@@ -4,207 +4,207 @@
 
 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 = $this->getTotalSum($ratingCounts) / $average;
-        }
-        $roundedAverage = round($average, intval($roundBy));
-        return floatval(apply_filters('site-reviews/rating/average', $roundedAverage, $ratingCounts, $average));
-    }
+	/**
+	 * @param int $roundBy
+	 * @return float
+	 */
+	public function getAverage(array $ratingCounts, $roundBy = 1)
+	{
+		$average = array_sum($ratingCounts);
+		if ($average > 0) {
+			$average = $this->getTotalSum($ratingCounts) / $average;
+		}
+		$roundedAverage = round($average, intval($roundBy));
+		return floatval(apply_filters('site-reviews/rating/average', $roundedAverage, $ratingCounts, $average));
+	}
 
-    /**
-     * 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', __CLASS__), 2);
-    }
+	/**
+	 * @return int|float
+	 */
+	public function getOverallPercentage(array $ratingCounts)
+	{
+		return round($this->getAverage($ratingCounts) * 100 / glsr()->constant('MAX_RATING', __CLASS__), 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', __CLASS__); // 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', __CLASS__); // 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', __CLASS__);
-        $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', __CLASS__);
+		$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;
+			}
+		);
+	}
 }