pryley / site-reviews

plugin/Database/SqlQueries.php

Indentation +103 added lines, -103 removed lines

@@ -7,23 +7,23 @@ 
 
 class SqlQueries
 {
-    protected $db;
-    protected $postType;
+	protected $db;
+	protected $postType;
 
-    public function __construct()
-    {
-        global $wpdb;
-        $this->db = $wpdb;
-        $this->postType = Application::POST_TYPE;
-    }
+	public function __construct()
+	{
+		global $wpdb;
+		$this->db = $wpdb;
+		$this->postType = Application::POST_TYPE;
+	}
 
-    /**
-     * @param string $metaReviewId
-     * @return int
-     */
-    public function getPostIdFromReviewId($metaReviewId)
-    {
-        $postId = $this->db->get_var("
+	/**
+	 * @param string $metaReviewId
+	 * @return int
+	 */
+	public function getPostIdFromReviewId($metaReviewId)
+	{
+		$postId = $this->db->get_var("
             SELECT p.ID
             FROM {$this->db->posts} AS p
             INNER JOIN {$this->db->postmeta} AS m ON p.ID = m.post_id
@@ -31,17 +31,17 @@ 
             AND m.meta_key = '_review_id'
             AND m.meta_value = '{$metaReviewId}'
         ");
-        return intval($postId);
-    }
+		return intval($postId);
+	}
 
-    /**
-     * @param int $lastPostId
-     * @param int $limit
-     * @return array
-     */
-    public function getReviewCounts(array $args, $lastPostId = 0, $limit = 500)
-    {
-        return (array) $this->db->get_results("
+	/**
+	 * @param int $lastPostId
+	 * @param int $limit
+	 * @return array
+	 */
+	public function getReviewCounts(array $args, $lastPostId = 0, $limit = 500)
+	{
+		return (array) $this->db->get_results("
             SELECT DISTINCT p.ID, m1.meta_value AS rating, m2.meta_value AS type
             FROM {$this->db->posts} AS p
             INNER JOIN {$this->db->postmeta} AS m1 ON p.ID = m1.post_id
@@ -56,17 +56,17 @@ 
             ORDER By p.ID ASC
             LIMIT {$limit}
         ");
-    }
+	}
 
-    /**
-     * @todo remove this?
-     * @param string $metaKey
-     * @return array
-     */
-    public function getReviewCountsFor($metaKey)
-    {
-        $metaKey = glsr(Helper::class)->prefix('_', $metaKey);
-        return (array) $this->db->get_results("
+	/**
+	 * @todo remove this?
+	 * @param string $metaKey
+	 * @return array
+	 */
+	public function getReviewCountsFor($metaKey)
+	{
+		$metaKey = glsr(Helper::class)->prefix('_', $metaKey);
+		return (array) $this->db->get_results("
             SELECT DISTINCT m.meta_value AS name, COUNT(*) num_posts
             FROM {$this->db->posts} AS p
             INNER JOIN {$this->db->postmeta} AS m ON p.ID = m.post_id
@@ -74,16 +74,16 @@ 
             AND m.meta_key = '{$metaKey}'
             GROUP BY name
         ");
-    }
+	}
 
-    /**
-     * @todo remove this?
-     * @param string $reviewType
-     * @return array
-     */
-    public function getReviewIdsByType($reviewType)
-    {
-        $results = $this->db->get_col("
+	/**
+	 * @todo remove this?
+	 * @param string $reviewType
+	 * @return array
+	 */
+	public function getReviewIdsByType($reviewType)
+	{
+		$results = $this->db->get_col("
             SELECT DISTINCT m1.meta_value AS review_id
             FROM {$this->db->posts} AS p
             INNER JOIN {$this->db->postmeta} AS m1 ON p.ID = m1.post_id
@@ -93,20 +93,20 @@ 
             AND m2.meta_key = '_review_type'
             AND m2.meta_value = '{$reviewType}'
         ");
-        return array_keys(array_flip($results));
-    }
+		return array_keys(array_flip($results));
+	}
 
-    /**
-     * @param int $greaterThanId
-     * @param int $limit
-     * @return array
-     */
-    public function getReviewRatingsFromIds(array $postIds, $greaterThanId = 0, $limit = 100)
-    {
-        sort($postIds);
-        $postIds = array_slice($postIds, intval(array_search($greaterThanId, $postIds)), $limit);
-        $postIds = implode(',', $postIds);
-        return (array) $this->db->get_results("
+	/**
+	 * @param int $greaterThanId
+	 * @param int $limit
+	 * @return array
+	 */
+	public function getReviewRatingsFromIds(array $postIds, $greaterThanId = 0, $limit = 100)
+	{
+		sort($postIds);
+		$postIds = array_slice($postIds, intval(array_search($greaterThanId, $postIds)), $limit);
+		$postIds = implode(',', $postIds);
+		return (array) $this->db->get_results("
             SELECT p.ID, m.meta_value AS rating
             FROM {$this->db->posts} AS p
             INNER JOIN {$this->db->postmeta} AS m ON p.ID = m.post_id
@@ -119,17 +119,17 @@ 
             ORDER By p.ID ASC
             LIMIT {$limit}
         ");
-    }
+	}
 
-    /**
-     * @param string $key
-     * @param string $status
-     * @return array
-     */
-    public function getReviewsMeta($key, $status = 'publish')
-    {
-        $key = glsr(Helper::class)->prefix('_', $key);
-        $values = $this->db->get_col("
+	/**
+	 * @param string $key
+	 * @param string $status
+	 * @return array
+	 */
+	public function getReviewsMeta($key, $status = 'publish')
+	{
+		$key = glsr(Helper::class)->prefix('_', $key);
+		$values = $this->db->get_col("
             SELECT DISTINCT m.meta_value
             FROM {$this->db->postmeta} m
             LEFT JOIN {$this->db->posts} p ON p.ID = m.post_id
@@ -140,42 +140,42 @@ 
             GROUP BY p.ID -- remove duplicate meta_value entries
             ORDER BY m.meta_id ASC -- sort by oldest meta_value
         ");
-        sort($values);
-        return $values;
-    }
+		sort($values);
+		return $values;
+	}
 
-    /**
-     * @param string $and
-     * @return string
-     */
-    protected function getAndForCounts(array $args, $and = '')
-    {
-        $postIds = implode(',', array_filter(glsr_get($args, 'post_ids', [])));
-        $termIds = implode(',', array_filter(glsr_get($args, 'term_ids', [])));
-        if (!empty($args['type'])) {
-            $and.= "AND m2.meta_value = '{$args['type']}' ";
-        }
-        if ($postIds) {
-            $and.= "AND m3.meta_key = '_assigned_to' AND m3.meta_value IN ({$postIds}) ";
-        }
-        if ($termIds) {
-            $and.= "AND tr.term_taxonomy_id IN ({$termIds}) ";
-        }
-        return apply_filters('site-reviews/query/and-for-counts', $and);
-    }
+	/**
+	 * @param string $and
+	 * @return string
+	 */
+	protected function getAndForCounts(array $args, $and = '')
+	{
+		$postIds = implode(',', array_filter(glsr_get($args, 'post_ids', [])));
+		$termIds = implode(',', array_filter(glsr_get($args, 'term_ids', [])));
+		if (!empty($args['type'])) {
+			$and.= "AND m2.meta_value = '{$args['type']}' ";
+		}
+		if ($postIds) {
+			$and.= "AND m3.meta_key = '_assigned_to' AND m3.meta_value IN ({$postIds}) ";
+		}
+		if ($termIds) {
+			$and.= "AND tr.term_taxonomy_id IN ({$termIds}) ";
+		}
+		return apply_filters('site-reviews/query/and-for-counts', $and);
+	}
 
-    /**
-     * @param string $innerJoin
-     * @return string
-     */
-    protected function getInnerJoinForCounts(array $args, $innerJoin = '')
-    {
-        if (!empty(glsr_get($args, 'post_ids'))) {
-            $innerJoin.= "INNER JOIN {$this->db->postmeta} AS m3 ON p.ID = m3.post_id ";
-        }
-        if (!empty(glsr_get($args, 'term_ids'))) {
-            $innerJoin.= "INNER JOIN {$this->db->term_relationships} AS tr ON p.ID = tr.object_id ";
-        }
-        return apply_filters('site-reviews/query/inner-join-for-counts', $innerJoin);
-    }
+	/**
+	 * @param string $innerJoin
+	 * @return string
+	 */
+	protected function getInnerJoinForCounts(array $args, $innerJoin = '')
+	{
+		if (!empty(glsr_get($args, 'post_ids'))) {
+			$innerJoin.= "INNER JOIN {$this->db->postmeta} AS m3 ON p.ID = m3.post_id ";
+		}
+		if (!empty(glsr_get($args, 'term_ids'))) {
+			$innerJoin.= "INNER JOIN {$this->db->term_relationships} AS tr ON p.ID = tr.object_id ";
+		}
+		return apply_filters('site-reviews/query/inner-join-for-counts', $innerJoin);
+	}
 }

plugin/Modules/Upgrader.php

Indentation +75 added lines, -75 removed lines

@@ -7,84 +7,84 @@
 
 class Upgrader
 {
-    /**
-     * @return string
-     */
-    public $currentVersion;
+	/**
+	 * @return string
+	 */
+	public $currentVersion;
 
-    /**
-     * @return void
-     */
-    public function run()
-    {
-        $filenames = [];
-        $iterator = new DirectoryIterator(dirname(__FILE__).'/Upgrader');
-        foreach ($iterator as $fileinfo) {
-            if ($fileinfo->isFile()) {
-                $filenames[] = $fileinfo->getFilename();
-            }
-        }
-        natsort($filenames);
-        $this->currentVersion = $this->currentVersion();
-        array_walk($filenames, function ($file) {
-            $className = str_replace('.php', '', $file);
-            $upgradeFromVersion = str_replace(['Upgrade_', '_'], ['', '.'], $className);
-            $suffix = preg_replace('/[\d.]+(.+)?/', '${1}', glsr()->version); // allow alpha/beta versions
-            if ('0.0.0' == $this->currentVersion
-                || version_compare($this->currentVersion, $upgradeFromVersion.$suffix, '>=')) {
-                return;
-            }
-            glsr('Modules\\Upgrader\\'.$className);
-            glsr_log()->notice('Completed Upgrade for v'.$upgradeFromVersion.$suffix);
-        });
-        $this->finish();
-    }
+	/**
+	 * @return void
+	 */
+	public function run()
+	{
+		$filenames = [];
+		$iterator = new DirectoryIterator(dirname(__FILE__).'/Upgrader');
+		foreach ($iterator as $fileinfo) {
+			if ($fileinfo->isFile()) {
+				$filenames[] = $fileinfo->getFilename();
+			}
+		}
+		natsort($filenames);
+		$this->currentVersion = $this->currentVersion();
+		array_walk($filenames, function ($file) {
+			$className = str_replace('.php', '', $file);
+			$upgradeFromVersion = str_replace(['Upgrade_', '_'], ['', '.'], $className);
+			$suffix = preg_replace('/[\d.]+(.+)?/', '${1}', glsr()->version); // allow alpha/beta versions
+			if ('0.0.0' == $this->currentVersion
+				|| version_compare($this->currentVersion, $upgradeFromVersion.$suffix, '>=')) {
+				return;
+			}
+			glsr('Modules\\Upgrader\\'.$className);
+			glsr_log()->notice('Completed Upgrade for v'.$upgradeFromVersion.$suffix);
+		});
+		$this->finish();
+	}
 
-    /**
-     * @return void
-     */
-    public function finish()
-    {
-        if ($this->currentVersion !== glsr()->version) {
-            $this->setReviewCounts();
-            $this->updateVersionFrom($this->currentVersion);
-        } elseif (!glsr(OptionManager::class)->get('last_review_count', false)) {
-            $this->setReviewCounts();
-        }
-    }
+	/**
+	 * @return void
+	 */
+	public function finish()
+	{
+		if ($this->currentVersion !== glsr()->version) {
+			$this->setReviewCounts();
+			$this->updateVersionFrom($this->currentVersion);
+		} elseif (!glsr(OptionManager::class)->get('last_review_count', false)) {
+			$this->setReviewCounts();
+		}
+	}
 
-    /**
-     * @return string
-     */
-    protected function currentVersion()
-    {
-        $fallback = '0.0.0';
-        $majorVersions = [4, 3, 2];
-        foreach ($majorVersions as $majorVersion) {
-            $settings = get_option(OptionManager::databaseKey($majorVersion));
-            $version = glsr_get($settings, 'version', $fallback);
-            if (version_compare($version, $fallback, '>')) {
-                return $version;
-            }
-        }
-        return $fallback;
-    }
+	/**
+	 * @return string
+	 */
+	protected function currentVersion()
+	{
+		$fallback = '0.0.0';
+		$majorVersions = [4, 3, 2];
+		foreach ($majorVersions as $majorVersion) {
+			$settings = get_option(OptionManager::databaseKey($majorVersion));
+			$version = glsr_get($settings, 'version', $fallback);
+			if (version_compare($version, $fallback, '>')) {
+				return $version;
+			}
+		}
+		return $fallback;
+	}
 
-    /**
-     * @return void
-     */
-    protected function setReviewCounts()
-    {
-        add_action('admin_init', 'glsr_calculate_ratings');
-    }
+	/**
+	 * @return void
+	 */
+	protected function setReviewCounts()
+	{
+		add_action('admin_init', 'glsr_calculate_ratings');
+	}
 
-    /**
-     * @param string $previousVersion
-     * @return void
-     */
-    protected function updateVersionFrom($previousVersion)
-    {
-        glsr(OptionManager::class)->set('version', glsr()->version);
-        glsr(OptionManager::class)->set('version_upgraded_from', $previousVersion);
-    }
+	/**
+	 * @param string $previousVersion
+	 * @return void
+	 */
+	protected function updateVersionFrom($previousVersion)
+	{
+		glsr(OptionManager::class)->set('version', glsr()->version);
+		glsr(OptionManager::class)->set('version_upgraded_from', $previousVersion);
+	}
 }

plugin/Modules/Wpml.php

Indentation +73 added lines, -73 removed lines

@@ -7,83 +7,83 @@
 
 class Wpml implements Contract
 {
-    const PLUGIN_NAME = 'WPML';
-    const SUPPORTED_VERSION = '3.3.5';
+	const PLUGIN_NAME = 'WPML';
+	const SUPPORTED_VERSION = '3.3.5';
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getPost($postId)
-    {
-        $postId = trim($postId);
-        if (!is_numeric($postId)) {
-            return;
-        }
-        if ($this->isEnabled()) {
-            $postId = apply_filters('wpml_object_id', $postId, 'any', true);
-        }
-        return get_post(intval($postId));
-    }
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getPost($postId)
+	{
+		$postId = trim($postId);
+		if (!is_numeric($postId)) {
+			return;
+		}
+		if ($this->isEnabled()) {
+			$postId = apply_filters('wpml_object_id', $postId, 'any', true);
+		}
+		return get_post(intval($postId));
+	}
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getPostIds(array $postIds)
-    {
-        if (!$this->isEnabled()) {
-            return $postIds;
-        }
-        $newPostIds = [];
-        foreach ($this->cleanIds($postIds) as $postId) {
-            $postType = get_post_type($postId);
-            if (!$postType) {
-                continue;
-            }
-            $elementType = 'post_'.$postType;
-            $trid = apply_filters('wpml_element_trid', null, $postId, $elementType);
-            $translations = apply_filters('wpml_get_element_translations', null, $trid, $elementType);
-            if (!is_array($translations)) {
-                $translations = [];
-            }
-            $newPostIds = array_merge(
-                $newPostIds,
-                array_column($translations, 'element_id')
-            );
-        }
-        return $this->cleanIds($newPostIds);
-    }
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getPostIds(array $postIds)
+	{
+		if (!$this->isEnabled()) {
+			return $postIds;
+		}
+		$newPostIds = [];
+		foreach ($this->cleanIds($postIds) as $postId) {
+			$postType = get_post_type($postId);
+			if (!$postType) {
+				continue;
+			}
+			$elementType = 'post_'.$postType;
+			$trid = apply_filters('wpml_element_trid', null, $postId, $elementType);
+			$translations = apply_filters('wpml_get_element_translations', null, $trid, $elementType);
+			if (!is_array($translations)) {
+				$translations = [];
+			}
+			$newPostIds = array_merge(
+				$newPostIds,
+				array_column($translations, 'element_id')
+			);
+		}
+		return $this->cleanIds($newPostIds);
+	}
 
-    /**
-     * {@inheritdoc}
-     */
-    public function isActive()
-    {
-        return defined('ICL_SITEPRESS_VERSION');
-    }
+	/**
+	 * {@inheritdoc}
+	 */
+	public function isActive()
+	{
+		return defined('ICL_SITEPRESS_VERSION');
+	}
 
-    /**
-     * {@inheritdoc}
-     */
-    public function isEnabled()
-    {
-        return $this->isActive()
-            && 'wpml' == glsr(OptionManager::class)->get('settings.general.multilingual');
-    }
+	/**
+	 * {@inheritdoc}
+	 */
+	public function isEnabled()
+	{
+		return $this->isActive()
+			&& 'wpml' == glsr(OptionManager::class)->get('settings.general.multilingual');
+	}
 
-    /**
-     * {@inheritdoc}
-     */
-    public function isSupported()
-    {
-        return $this->isActive()
-            && version_compare(ICL_SITEPRESS_VERSION, static::SUPPORTED_VERSION, '>=');
-    }
+	/**
+	 * {@inheritdoc}
+	 */
+	public function isSupported()
+	{
+		return $this->isActive()
+			&& version_compare(ICL_SITEPRESS_VERSION, static::SUPPORTED_VERSION, '>=');
+	}
 
-    /**
-     * @return array
-     */
-    protected function cleanIds(array $postIds)
-    {
-        return array_filter(array_unique($postIds));
-    }
+	/**
+	 * @return array
+	 */
+	protected function cleanIds(array $postIds)
+	{
+		return array_filter(array_unique($postIds));
+	}
 }

plugin/Modules/Polylang.php

Indentation +69 added lines, -69 removed lines

@@ -7,79 +7,79 @@
 
 class Polylang implements Contract
 {
-    const PLUGIN_NAME = 'Polylang';
-    const SUPPORTED_VERSION = '2.3';
+	const PLUGIN_NAME = 'Polylang';
+	const SUPPORTED_VERSION = '2.3';
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getPost($postId)
-    {
-        $postId = trim($postId);
-        if (!is_numeric($postId)) {
-            return;
-        }
-        if ($this->isEnabled()) {
-            $polylangPostId = pll_get_post($postId, pll_get_post_language(get_the_ID()));
-        }
-        if (!empty($polylangPostId)) {
-            $postId = $polylangPostId;
-        }
-        return get_post(intval($postId));
-    }
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getPost($postId)
+	{
+		$postId = trim($postId);
+		if (!is_numeric($postId)) {
+			return;
+		}
+		if ($this->isEnabled()) {
+			$polylangPostId = pll_get_post($postId, pll_get_post_language(get_the_ID()));
+		}
+		if (!empty($polylangPostId)) {
+			$postId = $polylangPostId;
+		}
+		return get_post(intval($postId));
+	}
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getPostIds(array $postIds)
-    {
-        if (!$this->isEnabled()) {
-            return $postIds;
-        }
-        $newPostIds = [];
-        foreach ($this->cleanIds($postIds) as $postId) {
-            $newPostIds = array_merge(
-                $newPostIds,
-                array_values(pll_get_post_translations($postId))
-            );
-        }
-        return $this->cleanIds($newPostIds);
-    }
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getPostIds(array $postIds)
+	{
+		if (!$this->isEnabled()) {
+			return $postIds;
+		}
+		$newPostIds = [];
+		foreach ($this->cleanIds($postIds) as $postId) {
+			$newPostIds = array_merge(
+				$newPostIds,
+				array_values(pll_get_post_translations($postId))
+			);
+		}
+		return $this->cleanIds($newPostIds);
+	}
 
-    /**
-     * {@inheritdoc}
-     */
-    public function isActive()
-    {
-        return function_exists('PLL')
-            && function_exists('pll_get_post')
-            && function_exists('pll_get_post_language')
-            && function_exists('pll_get_post_translations');
-    }
+	/**
+	 * {@inheritdoc}
+	 */
+	public function isActive()
+	{
+		return function_exists('PLL')
+			&& function_exists('pll_get_post')
+			&& function_exists('pll_get_post_language')
+			&& function_exists('pll_get_post_translations');
+	}
 
-    /**
-     * {@inheritdoc}
-     */
-    public function isEnabled()
-    {
-        return $this->isActive()
-            && 'polylang' == glsr(OptionManager::class)->get('settings.general.multilingual');
-    }
+	/**
+	 * {@inheritdoc}
+	 */
+	public function isEnabled()
+	{
+		return $this->isActive()
+			&& 'polylang' == glsr(OptionManager::class)->get('settings.general.multilingual');
+	}
 
-    /**
-     * {@inheritdoc}
-     */
-    public function isSupported()
-    {
-        return defined('POLYLANG_VERSION')
-            && version_compare(POLYLANG_VERSION, static::SUPPORTED_VERSION, '>=');
-    }
+	/**
+	 * {@inheritdoc}
+	 */
+	public function isSupported()
+	{
+		return defined('POLYLANG_VERSION')
+			&& version_compare(POLYLANG_VERSION, static::SUPPORTED_VERSION, '>=');
+	}
 
-    /**
-     * @return array
-     */
-    protected function cleanIds(array $postIds)
-    {
-        return array_filter(array_unique($postIds));
-    }
+	/**
+	 * @return array
+	 */
+	protected function cleanIds(array $postIds)
+	{
+		return array_filter(array_unique($postIds));
+	}
 }

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', __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;
+			}
+		);
+	}
 }

plugin/Modules/Validator/ValidateReview.php

Indentation +262 added lines, -262 removed lines

@@ -12,288 +12,288 @@
 
 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->validateReviewLimits();
-        $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->validateReviewLimits();
+		$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;
+	}
 
-    protected function setError($message, $loggedMessage = '')
-    {
-        $this->setSessionValues('errors', [], $loggedMessage);
-        $this->error = $message;
-    }
+	protected function setError($message, $loggedMessage = '')
+	{
+		$this->setSessionValues('errors', [], $loggedMessage);
+		$this->error = $message;
+	}
 
-    /**
-     * @param string $type
-     * @param mixed $value
-     * @param string $loggedMessage
-     * @return void
-     */
-    protected function setSessionValues($type, $value, $loggedMessage = '')
-    {
-        glsr()->sessionSet($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()->sessionSet($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->setError(__('This review has been flagged as possible spam and cannot be submitted.', 'site-reviews'),
-            'Akismet caught a spam submission (consider adding the IP address to the blacklist):'
-        );
-    }
+	/**
+	 * @return void
+	 */
+	protected function validateAkismet()
+	{
+		if (!empty($this->error)) {
+			return;
+		}
+		if (!glsr(Akismet::class)->isSpam($this->request)) {
+			return;
+		}
+		$this->setError(__('This review has been flagged as possible spam and cannot be submitted.', 'site-reviews'),
+			'Akismet caught a spam submission (consider adding the IP address to the blacklist):'
+		);
+	}
 
-    /**
-     * @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->request['blacklisted'] = true;
-            return;
-        }
-        $this->setError(__('Your review cannot be submitted at this time.', 'site-reviews'),
-            'Blacklisted submission detected:'
-        );
-    }
+	/**
+	 * @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->request['blacklisted'] = true;
+			return;
+		}
+		$this->setError(__('Your review cannot be submitted at this time.', 'site-reviews'),
+			'Blacklisted submission detected:'
+		);
+	}
 
-    /**
-     * @return void
-     */
-    protected function validateCustom()
-    {
-        if (!empty($this->error)) {
-            return;
-        }
-        $validated = apply_filters('site-reviews/validate/custom', true, $this->request);
-        if (true === $validated) {
-            return;
-        }
-        $errorMessage = is_string($validated)
-            ? $validated
-            : __('The review submission failed. Please notify the site administrator.', 'site-reviews');
-        $this->setError($errorMessage);
-        $this->setSessionValues('values', $this->request);
-    }
+	/**
+	 * @return void
+	 */
+	protected function validateCustom()
+	{
+		if (!empty($this->error)) {
+			return;
+		}
+		$validated = apply_filters('site-reviews/validate/custom', true, $this->request);
+		if (true === $validated) {
+			return;
+		}
+		$errorMessage = is_string($validated)
+			? $validated
+			: __('The review submission failed. Please notify the site administrator.', 'site-reviews');
+		$this->setError($errorMessage);
+		$this->setSessionValues('values', $this->request);
+	}
 
-    /**
-     * @return void
-     */
-    protected function validateHoneyPot()
-    {
-        if (!empty($this->error)) {
-            return;
-        }
-        if (empty($this->request['gotcha'])) {
-            return;
-        }
-        $this->setError(__('The review submission failed. Please notify the site administrator.', 'site-reviews'),
-            'The Honeypot caught a bad submission:'
-        );
-    }
+	/**
+	 * @return void
+	 */
+	protected function validateHoneyPot()
+	{
+		if (!empty($this->error)) {
+			return;
+		}
+		if (empty($this->request['gotcha'])) {
+			return;
+		}
+		$this->setError(__('The review submission failed. Please notify the site administrator.', 'site-reviews'),
+			'The Honeypot caught a bad submission:'
+		);
+	}
 
-    /**
-     * @return void
-     */
-    protected function validateReviewLimits()
-    {
-        if (!empty($this->error)) {
-            return;
-        }
-        if (!glsr(ReviewLimits::class)->hasReachedLimit($this->request)) {
-            return;
-        }
-        $this->setError(__('You have already submitted a review.', 'site-reviews'));
-    }
+	/**
+	 * @return void
+	 */
+	protected function validateReviewLimits()
+	{
+		if (!empty($this->error)) {
+			return;
+		}
+		if (!glsr(ReviewLimits::class)->hasReachedLimit($this->request)) {
+			return;
+		}
+		$this->setError(__('You have already submitted a review.', '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 (static::RECAPTCHA_EMPTY === $status) {
-            $this->setSessionValues('recaptcha', 'unset');
-            $this->recaptchaIsUnset = true;
-            return;
-        }
-        $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->setError($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 (static::RECAPTCHA_EMPTY === $status) {
+			$this->setSessionValues('recaptcha', 'unset');
+			$this->recaptchaIsUnset = true;
+			return;
+		}
+		$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->setError($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/ReviewLimits.php

Indentation +91 added lines, -91 removed lines

@@ -7,103 +7,103 @@
 
 class ReviewLimits
 {
-    protected $request;
+	protected $request;
 
-    /**
-     * @return array
-     * @filter site-reviews/get/reviews/query
-     */
-    public function filterReviewsQuery(array $parameters, array $args)
-    {
-        if ($authorId = get_current_user_id()) {
-            $parameters['author'] = $authorId;
-        }
-        $parameters['post_status'] = ['pending', 'publish'];
-        return apply_filters('site-reviews/reviews-limits/query', $parameters, $args);
-    }
+	/**
+	 * @return array
+	 * @filter site-reviews/get/reviews/query
+	 */
+	public function filterReviewsQuery(array $parameters, array $args)
+	{
+		if ($authorId = get_current_user_id()) {
+			$parameters['author'] = $authorId;
+		}
+		$parameters['post_status'] = ['pending', 'publish'];
+		return apply_filters('site-reviews/reviews-limits/query', $parameters, $args);
+	}
 
-    /**
-     * @return bool
-     */
-    public function hasReachedLimit(array $request = [])
-    {
-        $this->request = $request;
-        $method = glsr(Helper::class)->buildMethodName(
-            glsr(OptionManager::class)->get('settings.submissions.limit'), 'validateBy'
-        );
-        return method_exists($this, $method)
-            ? !call_user_func([$this, $method])
-            : false;
-    }
+	/**
+	 * @return bool
+	 */
+	public function hasReachedLimit(array $request = [])
+	{
+		$this->request = $request;
+		$method = glsr(Helper::class)->buildMethodName(
+			glsr(OptionManager::class)->get('settings.submissions.limit'), 'validateBy'
+		);
+		return method_exists($this, $method)
+			? !call_user_func([$this, $method])
+			: false;
+	}
 
-    /**
-     * @param string $value
-     * @param string $whitelist
-     * @return bool
-     */
-    public function isWhitelisted($value, $whitelist)
-    {
-        if (empty($whitelist)) {
-            return false;
-        }
-        return in_array($value, array_filter(explode("\n", $whitelist), 'trim'));
-    }
+	/**
+	 * @param string $value
+	 * @param string $whitelist
+	 * @return bool
+	 */
+	public function isWhitelisted($value, $whitelist)
+	{
+		if (empty($whitelist)) {
+			return false;
+		}
+		return in_array($value, array_filter(explode("\n", $whitelist), 'trim'));
+	}
 
-    /**
-     * @param string $whitelistName
-     * @return string
-     */
-    protected function getWhitelist($whitelistName)
-    {
-        return glsr(OptionManager::class)->get('settings.submissions.limit_whitelist.'.$whitelistName);
-    }
+	/**
+	 * @param string $whitelistName
+	 * @return string
+	 */
+	protected function getWhitelist($whitelistName)
+	{
+		return glsr(OptionManager::class)->get('settings.submissions.limit_whitelist.'.$whitelistName);
+	}
 
-    /**
-     * @return bool
-     */
-    protected function validate($key, $value, $addMetaQuery = true)
-    {
-        if ($this->isWhitelisted($value, $this->getWhitelist($key))) {
-            return true;
-        }
-        add_filter('site-reviews/get/reviews/query', [$this, 'filterReviewsQuery'], 5, 2);
-        $args = ['assigned_to' => glsr_get($this->request, 'assign_to')];
-        if ($addMetaQuery) {
-            $args[$key] = $value;
-        }
-        $reviews = glsr_get_reviews($args);
-        remove_filter('site-reviews/get/reviews/query', [$this, 'filterReviewsQuery'], 5);
-        return 0 === count($reviews);
-    }
+	/**
+	 * @return bool
+	 */
+	protected function validate($key, $value, $addMetaQuery = true)
+	{
+		if ($this->isWhitelisted($value, $this->getWhitelist($key))) {
+			return true;
+		}
+		add_filter('site-reviews/get/reviews/query', [$this, 'filterReviewsQuery'], 5, 2);
+		$args = ['assigned_to' => glsr_get($this->request, 'assign_to')];
+		if ($addMetaQuery) {
+			$args[$key] = $value;
+		}
+		$reviews = glsr_get_reviews($args);
+		remove_filter('site-reviews/get/reviews/query', [$this, 'filterReviewsQuery'], 5);
+		return 0 === count($reviews);
+	}
 
-    /**
-     * @return bool
-     */
-    protected function validateByEmail()
-    {
-        glsr_log()->debug('Email is: '.glsr_get($this->request, 'email'));
-        return $this->validate('email', glsr_get($this->request, 'email'));
-    }
+	/**
+	 * @return bool
+	 */
+	protected function validateByEmail()
+	{
+		glsr_log()->debug('Email is: '.glsr_get($this->request, 'email'));
+		return $this->validate('email', glsr_get($this->request, 'email'));
+	}
 
-    /**
-     * @return bool
-     */
-    protected function validateByIpAddress()
-    {
-        glsr_log()->debug('IP Address is: '.glsr_get($this->request, 'ip_address'));
-        return $this->validate('ip_address', glsr_get($this->request, 'ip_address'));
-    }
+	/**
+	 * @return bool
+	 */
+	protected function validateByIpAddress()
+	{
+		glsr_log()->debug('IP Address is: '.glsr_get($this->request, 'ip_address'));
+		return $this->validate('ip_address', glsr_get($this->request, 'ip_address'));
+	}
 
-    /**
-     * @return bool
-     */
-    protected function validateByUsername()
-    {
-        $user = wp_get_current_user();
-        if (!$user->exists()) {
-            return true;
-        }
-        glsr_log()->debug('Username is: '.$user->user_login);
-        return $this->validate('username', $user->user_login, false);
-    }
+	/**
+	 * @return bool
+	 */
+	protected function validateByUsername()
+	{
+		$user = wp_get_current_user();
+		if (!$user->exists()) {
+			return true;
+		}
+		glsr_log()->debug('Username is: '.$user->user_login);
+		return $this->validate('username', $user->user_login, false);
+	}
 }

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()
-    {
-        wp_enqueue_style(
-            Application::ID,
-            glsr()->url('assets/styles/'.Application::ID.'-admin.css'),
-            [],
-            glsr()->version
-        );
-        if (!$this->isCurrentScreen()) {
-            return;
-        }
-        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()
+	{
+		wp_enqueue_style(
+			Application::ID,
+			glsr()->url('assets/styles/'.Application::ID.'-admin.css'),
+			[],
+			glsr()->version
+		);
+		if (!$this->isCurrentScreen()) {
+			return;
+		}
+		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/Controllers/AdminController.php

Indentation +218 added lines, -218 removed lines

@@ -15,222 +15,222 @@
 
 class AdminController extends Controller
 {
-    /**
-     * @return void
-     * @action admin_enqueue_scripts
-     */
-    public function enqueueAssets()
-    {
-        $command = new EnqueueAdminAssets([
-            'pointers' => [[
-                'content' => __('You can pin exceptional reviews so that they are always shown first.', 'site-reviews'),
-                'id' => 'glsr-pointer-pinned',
-                'position' => [
-                    'edge' => 'right',
-                    'align' => 'middle',
-                ],
-                'screen' => Application::POST_TYPE,
-                'target' => '#misc-pub-pinned',
-                'title' => __('Pin Your Reviews', 'site-reviews'),
-            ]],
-        ]);
-        $this->execute($command);
-    }
-
-    /**
-     * @return array
-     * @filter plugin_action_links_site-reviews/site-reviews.php
-     */
-    public function filterActionLinks(array $links)
-    {
-        $links['documentation'] = glsr(Builder::class)->a(__('Help', 'site-reviews'), [
-            'href' => admin_url('edit.php?post_type='.Application::POST_TYPE.'&page=documentation'),
-        ]);
-        $links['settings'] = glsr(Builder::class)->a(__('Settings', 'site-reviews'), [
-            'href' => admin_url('edit.php?post_type='.Application::POST_TYPE.'&page=settings'),
-        ]);
-        return $links;
-    }
-
-    /**
-     * @param array $capabilities
-     * @param string $capability
-     * @return array
-     * @filter map_meta_cap
-     */
-    public function filterCreateCapability($capabilities, $capability)
-    {
-        if ($capability == 'create_'.Application::POST_TYPE) {
-            $capabilities[] = 'do_not_allow';
-        }
-        return $capabilities;
-    }
-
-    /**
-     * @param array $items
-     * @return array
-     * @filter dashboard_glance_items
-     */
-    public function filterDashboardGlanceItems($items)
-    {
-        $postCount = wp_count_posts(Application::POST_TYPE);
-        if (empty($postCount->publish)) {
-            return $items;
-        }
-        $text = _n('%s Review', '%s Reviews', $postCount->publish, 'site-reviews');
-        $text = sprintf($text, number_format_i18n($postCount->publish));
-        $items = glsr(Helper::class)->consolidateArray($items);
-        $items[] = current_user_can(get_post_type_object(Application::POST_TYPE)->cap->edit_posts)
-            ? glsr(Builder::class)->a($text, [
-                'class' => 'glsr-review-count',
-                'href' => 'edit.php?post_type='.Application::POST_TYPE,
-            ])
-            : glsr(Builder::class)->span($text, [
-                'class' => 'glsr-review-count',
-            ]);
-        return $items;
-    }
-
-    /**
-     * @param array $plugins
-     * @return array
-     * @filter mce_external_plugins
-     */
-    public function filterTinymcePlugins($plugins)
-    {
-        if (current_user_can('edit_posts') || current_user_can('edit_pages')) {
-            $plugins = glsr(Helper::class)->consolidateArray($plugins);
-            $plugins['glsr_shortcode'] = glsr()->url('assets/scripts/mce-plugin.js');
-        }
-        return $plugins;
-    }
-
-    /**
-     * @return void
-     * @action admin_init
-     */
-    public function registerTinymcePopups()
-    {
-        $command = new RegisterTinymcePopups([
-            'site_reviews' => esc_html__('Recent Reviews', 'site-reviews'),
-            'site_reviews_form' => esc_html__('Submit a Review', 'site-reviews'),
-            'site_reviews_summary' => esc_html__('Summary of Reviews', 'site-reviews'),
-        ]);
-        $this->execute($command);
-    }
-
-    /**
-     * @param string $editorId
-     * @return void|null
-     * @action media_buttons
-     */
-    public function renderTinymceButton($editorId)
-    {
-        $allowedEditors = apply_filters('site-reviews/tinymce/editor-ids', ['content'], $editorId);
-        if ('post' != glsr_current_screen()->base || !in_array($editorId, $allowedEditors)) {
-            return;
-        }
-        $shortcodes = [];
-        foreach (glsr()->mceShortcodes as $shortcode => $values) {
-            $shortcodes[$shortcode] = $values;
-        }
-        if (empty($shortcodes)) {
-            return;
-        }
-        glsr()->render('partials/editor/tinymce', [
-            'shortcodes' => $shortcodes,
-        ]);
-    }
-
-    /**
-     * @return void
-     */
-    public function routerClearConsole()
-    {
-        glsr(Console::class)->clear();
-        glsr(Notice::class)->addSuccess(__('Console cleared.', 'site-reviews'));
-    }
-
-    /**
-     * @return void
-     */
-    public function routerFetchConsole()
-    {
-        glsr(Notice::class)->addSuccess(__('Console reloaded.', 'site-reviews'));
-    }
-
-    /**
-     * @param bool $showNotice
-     * @return void
-     */
-    public function routerCountReviews($showNotice = true)
-    {
-        glsr(CountsManager::class)->countAll();
-        glsr(OptionManager::class)->set('last_review_count', current_time('timestamp'));
-        if ($showNotice) {
-            glsr(Notice::class)->clear()->addSuccess(__('Recalculated rating counts.', 'site-reviews'));
-        }
-    }
-
-    /**
-     * @return void
-     */
-    public function routerDownloadConsole()
-    {
-        $this->download(Application::ID.'-console.txt', glsr(Console::class)->get());
-    }
-
-    /**
-     * @return void
-     */
-    public function routerDownloadSystemInfo()
-    {
-        $this->download(Application::ID.'-system-info.txt', glsr(System::class)->get());
-    }
-
-    /**
-     * @return void
-     */
-    public function routerExportSettings()
-    {
-        $this->download(Application::ID.'-settings.json', glsr(OptionManager::class)->json());
-    }
-
-    /**
-     * @return void
-     */
-    public function routerImportSettings()
-    {
-        $file = $_FILES['import-file'];
-        if (UPLOAD_ERR_OK !== $file['error']) {
-            return glsr(Notice::class)->addError($this->getUploadError($file['error']));
-        }
-        if ('application/json' !== $file['type'] || !glsr(Helper::class)->endsWith('.json', $file['name'])) {
-            return glsr(Notice::class)->addError(__('Please use a valid Site Reviews settings file.', 'site-reviews'));
-        }
-        $settings = json_decode(file_get_contents($file['tmp_name']), true);
-        if (empty($settings)) {
-            return glsr(Notice::class)->addWarning(__('There were no settings found to import.', 'site-reviews'));
-        }
-        glsr(OptionManager::class)->set(glsr(OptionManager::class)->normalize($settings));
-        glsr(Notice::class)->addSuccess(__('Settings imported.', 'site-reviews'));
-    }
-
-    /**
-     * @param int $errorCode
-     * @return string
-     */
-    protected function getUploadError($errorCode)
-    {
-        $errors = [
-            UPLOAD_ERR_INI_SIZE => __('The uploaded file exceeds the upload_max_filesize directive in php.ini.', 'site-reviews'),
-            UPLOAD_ERR_FORM_SIZE => __('The uploaded file is too big.', 'site-reviews'),
-            UPLOAD_ERR_PARTIAL => __('The uploaded file was only partially uploaded.', 'site-reviews'),
-            UPLOAD_ERR_NO_FILE => __('No file was uploaded.', 'site-reviews'),
-            UPLOAD_ERR_NO_TMP_DIR => __('Missing a temporary folder.', 'site-reviews'),
-            UPLOAD_ERR_CANT_WRITE => __('Failed to write file to disk.', 'site-reviews'),
-            UPLOAD_ERR_EXTENSION => __('A PHP extension stopped the file upload.', 'site-reviews'),
-        ];
-        return glsr_get($errors, $errorCode, __('Unknown upload error.', 'site-reviews'));
-    }
+	/**
+	 * @return void
+	 * @action admin_enqueue_scripts
+	 */
+	public function enqueueAssets()
+	{
+		$command = new EnqueueAdminAssets([
+			'pointers' => [[
+				'content' => __('You can pin exceptional reviews so that they are always shown first.', 'site-reviews'),
+				'id' => 'glsr-pointer-pinned',
+				'position' => [
+					'edge' => 'right',
+					'align' => 'middle',
+				],
+				'screen' => Application::POST_TYPE,
+				'target' => '#misc-pub-pinned',
+				'title' => __('Pin Your Reviews', 'site-reviews'),
+			]],
+		]);
+		$this->execute($command);
+	}
+
+	/**
+	 * @return array
+	 * @filter plugin_action_links_site-reviews/site-reviews.php
+	 */
+	public function filterActionLinks(array $links)
+	{
+		$links['documentation'] = glsr(Builder::class)->a(__('Help', 'site-reviews'), [
+			'href' => admin_url('edit.php?post_type='.Application::POST_TYPE.'&page=documentation'),
+		]);
+		$links['settings'] = glsr(Builder::class)->a(__('Settings', 'site-reviews'), [
+			'href' => admin_url('edit.php?post_type='.Application::POST_TYPE.'&page=settings'),
+		]);
+		return $links;
+	}
+
+	/**
+	 * @param array $capabilities
+	 * @param string $capability
+	 * @return array
+	 * @filter map_meta_cap
+	 */
+	public function filterCreateCapability($capabilities, $capability)
+	{
+		if ($capability == 'create_'.Application::POST_TYPE) {
+			$capabilities[] = 'do_not_allow';
+		}
+		return $capabilities;
+	}
+
+	/**
+	 * @param array $items
+	 * @return array
+	 * @filter dashboard_glance_items
+	 */
+	public function filterDashboardGlanceItems($items)
+	{
+		$postCount = wp_count_posts(Application::POST_TYPE);
+		if (empty($postCount->publish)) {
+			return $items;
+		}
+		$text = _n('%s Review', '%s Reviews', $postCount->publish, 'site-reviews');
+		$text = sprintf($text, number_format_i18n($postCount->publish));
+		$items = glsr(Helper::class)->consolidateArray($items);
+		$items[] = current_user_can(get_post_type_object(Application::POST_TYPE)->cap->edit_posts)
+			? glsr(Builder::class)->a($text, [
+				'class' => 'glsr-review-count',
+				'href' => 'edit.php?post_type='.Application::POST_TYPE,
+			])
+			: glsr(Builder::class)->span($text, [
+				'class' => 'glsr-review-count',
+			]);
+		return $items;
+	}
+
+	/**
+	 * @param array $plugins
+	 * @return array
+	 * @filter mce_external_plugins
+	 */
+	public function filterTinymcePlugins($plugins)
+	{
+		if (current_user_can('edit_posts') || current_user_can('edit_pages')) {
+			$plugins = glsr(Helper::class)->consolidateArray($plugins);
+			$plugins['glsr_shortcode'] = glsr()->url('assets/scripts/mce-plugin.js');
+		}
+		return $plugins;
+	}
+
+	/**
+	 * @return void
+	 * @action admin_init
+	 */
+	public function registerTinymcePopups()
+	{
+		$command = new RegisterTinymcePopups([
+			'site_reviews' => esc_html__('Recent Reviews', 'site-reviews'),
+			'site_reviews_form' => esc_html__('Submit a Review', 'site-reviews'),
+			'site_reviews_summary' => esc_html__('Summary of Reviews', 'site-reviews'),
+		]);
+		$this->execute($command);
+	}
+
+	/**
+	 * @param string $editorId
+	 * @return void|null
+	 * @action media_buttons
+	 */
+	public function renderTinymceButton($editorId)
+	{
+		$allowedEditors = apply_filters('site-reviews/tinymce/editor-ids', ['content'], $editorId);
+		if ('post' != glsr_current_screen()->base || !in_array($editorId, $allowedEditors)) {
+			return;
+		}
+		$shortcodes = [];
+		foreach (glsr()->mceShortcodes as $shortcode => $values) {
+			$shortcodes[$shortcode] = $values;
+		}
+		if (empty($shortcodes)) {
+			return;
+		}
+		glsr()->render('partials/editor/tinymce', [
+			'shortcodes' => $shortcodes,
+		]);
+	}
+
+	/**
+	 * @return void
+	 */
+	public function routerClearConsole()
+	{
+		glsr(Console::class)->clear();
+		glsr(Notice::class)->addSuccess(__('Console cleared.', 'site-reviews'));
+	}
+
+	/**
+	 * @return void
+	 */
+	public function routerFetchConsole()
+	{
+		glsr(Notice::class)->addSuccess(__('Console reloaded.', 'site-reviews'));
+	}
+
+	/**
+	 * @param bool $showNotice
+	 * @return void
+	 */
+	public function routerCountReviews($showNotice = true)
+	{
+		glsr(CountsManager::class)->countAll();
+		glsr(OptionManager::class)->set('last_review_count', current_time('timestamp'));
+		if ($showNotice) {
+			glsr(Notice::class)->clear()->addSuccess(__('Recalculated rating counts.', 'site-reviews'));
+		}
+	}
+
+	/**
+	 * @return void
+	 */
+	public function routerDownloadConsole()
+	{
+		$this->download(Application::ID.'-console.txt', glsr(Console::class)->get());
+	}
+
+	/**
+	 * @return void
+	 */
+	public function routerDownloadSystemInfo()
+	{
+		$this->download(Application::ID.'-system-info.txt', glsr(System::class)->get());
+	}
+
+	/**
+	 * @return void
+	 */
+	public function routerExportSettings()
+	{
+		$this->download(Application::ID.'-settings.json', glsr(OptionManager::class)->json());
+	}
+
+	/**
+	 * @return void
+	 */
+	public function routerImportSettings()
+	{
+		$file = $_FILES['import-file'];
+		if (UPLOAD_ERR_OK !== $file['error']) {
+			return glsr(Notice::class)->addError($this->getUploadError($file['error']));
+		}
+		if ('application/json' !== $file['type'] || !glsr(Helper::class)->endsWith('.json', $file['name'])) {
+			return glsr(Notice::class)->addError(__('Please use a valid Site Reviews settings file.', 'site-reviews'));
+		}
+		$settings = json_decode(file_get_contents($file['tmp_name']), true);
+		if (empty($settings)) {
+			return glsr(Notice::class)->addWarning(__('There were no settings found to import.', 'site-reviews'));
+		}
+		glsr(OptionManager::class)->set(glsr(OptionManager::class)->normalize($settings));
+		glsr(Notice::class)->addSuccess(__('Settings imported.', 'site-reviews'));
+	}
+
+	/**
+	 * @param int $errorCode
+	 * @return string
+	 */
+	protected function getUploadError($errorCode)
+	{
+		$errors = [
+			UPLOAD_ERR_INI_SIZE => __('The uploaded file exceeds the upload_max_filesize directive in php.ini.', 'site-reviews'),
+			UPLOAD_ERR_FORM_SIZE => __('The uploaded file is too big.', 'site-reviews'),
+			UPLOAD_ERR_PARTIAL => __('The uploaded file was only partially uploaded.', 'site-reviews'),
+			UPLOAD_ERR_NO_FILE => __('No file was uploaded.', 'site-reviews'),
+			UPLOAD_ERR_NO_TMP_DIR => __('Missing a temporary folder.', 'site-reviews'),
+			UPLOAD_ERR_CANT_WRITE => __('Failed to write file to disk.', 'site-reviews'),
+			UPLOAD_ERR_EXTENSION => __('A PHP extension stopped the file upload.', 'site-reviews'),
+		];
+		return glsr_get($errors, $errorCode, __('Unknown upload error.', 'site-reviews'));
+	}
 }