pryley / site-reviews

plugin/Helper.php

Indentation +114 added lines, -114 removed lines

@@ -9,125 +9,125 @@
 
 class Helper
 {
-    use Arr;
-    use Str;
+	use Arr;
+	use Str;
 
-    /**
-     * @param string $name
-     * @param string $path
-     * @return string
-     */
-    public function buildClassName($name, $path = '')
-    {
-        $className = $this->camelCase($name);
-        $path = ltrim(str_replace(__NAMESPACE__, '', $path), '\\');
-        return !empty($path)
-            ? __NAMESPACE__.'\\'.$path.'\\'.$className
-            : $className;
-    }
+	/**
+	 * @param string $name
+	 * @param string $path
+	 * @return string
+	 */
+	public function buildClassName($name, $path = '')
+	{
+		$className = $this->camelCase($name);
+		$path = ltrim(str_replace(__NAMESPACE__, '', $path), '\\');
+		return !empty($path)
+			? __NAMESPACE__.'\\'.$path.'\\'.$className
+			: $className;
+	}
 
-    /**
-     * @param string $name
-     * @param string $prefix
-     * @return string
-     */
-    public function buildMethodName($name, $prefix = '')
-    {
-        return lcfirst($prefix.$this->buildClassName($name));
-    }
+	/**
+	 * @param string $name
+	 * @param string $prefix
+	 * @return string
+	 */
+	public function buildMethodName($name, $prefix = '')
+	{
+		return lcfirst($prefix.$this->buildClassName($name));
+	}
 
-    /**
-     * @param string $name
-     * @return string
-     */
-    public function buildPropertyName($name)
-    {
-        return lcfirst($this->buildClassName($name));
-    }
+	/**
+	 * @param string $name
+	 * @return string
+	 */
+	public function buildPropertyName($name)
+	{
+		return lcfirst($this->buildClassName($name));
+	}
 
-    /**
-     * @param string $cast
-     * @param mixed $value
-     * @return mixed
-     */
-    public function castTo($cast = '', $value)
-    {
-        switch ($cast) {
-            case 'array':
-                return (array) $value;
-            case 'boolean':
-                return filter_var($value, FILTER_VALIDATE_BOOLEAN);
-            case 'float':
-                return (float) filter_var($value, FILTER_VALIDATE_FLOAT, FILTER_FLAG_ALLOW_THOUSAND);
-            case 'integer':
-                return (int) filter_var($value, FILTER_VALIDATE_INT);
-            case 'object':
-                return (object) (array) $value;
-            case 'string':
-                if (is_object($value) && in_array('__toString', get_class_methods($value))) {
-                    return (string) $value->__toString();
-                }
-                if (is_array($value) || is_object($value)) {
-                    return serialize($value);
-                }
-                return (string) $value;
-            default:
-                return $value;
-        }
-    }
+	/**
+	 * @param string $cast
+	 * @param mixed $value
+	 * @return mixed
+	 */
+	public function castTo($cast = '', $value)
+	{
+		switch ($cast) {
+			case 'array':
+				return (array) $value;
+			case 'boolean':
+				return filter_var($value, FILTER_VALIDATE_BOOLEAN);
+			case 'float':
+				return (float) filter_var($value, FILTER_VALIDATE_FLOAT, FILTER_FLAG_ALLOW_THOUSAND);
+			case 'integer':
+				return (int) filter_var($value, FILTER_VALIDATE_INT);
+			case 'object':
+				return (object) (array) $value;
+			case 'string':
+				if (is_object($value) && in_array('__toString', get_class_methods($value))) {
+					return (string) $value->__toString();
+				}
+				if (is_array($value) || is_object($value)) {
+					return serialize($value);
+				}
+				return (string) $value;
+			default:
+				return $value;
+		}
+	}
 
-    /**
-     * @param string $key
-     * @return mixed
-     */
-    public function filterInput($key, array $request = [])
-    {
-        if (isset($request[$key])) {
-            return $request[$key];
-        }
-        $variable = filter_input(INPUT_POST, $key);
-        if (is_null($variable) && isset($_POST[$key])) {
-            $variable = $_POST[$key];
-        }
-        return $variable;
-    }
+	/**
+	 * @param string $key
+	 * @return mixed
+	 */
+	public function filterInput($key, array $request = [])
+	{
+		if (isset($request[$key])) {
+			return $request[$key];
+		}
+		$variable = filter_input(INPUT_POST, $key);
+		if (is_null($variable) && isset($_POST[$key])) {
+			$variable = $_POST[$key];
+		}
+		return $variable;
+	}
 
-    /**
-     * @param string $key
-     * @return array
-     */
-    public function filterInputArray($key)
-    {
-        $variable = filter_input(INPUT_POST, $key, FILTER_DEFAULT, FILTER_REQUIRE_ARRAY);
-        if (empty($variable) && !empty($_POST[$key]) && is_array($_POST[$key])) {
-            $variable = $_POST[$key];
-        }
-        return (array) $variable;
-    }
+	/**
+	 * @param string $key
+	 * @return array
+	 */
+	public function filterInputArray($key)
+	{
+		$variable = filter_input(INPUT_POST, $key, FILTER_DEFAULT, FILTER_REQUIRE_ARRAY);
+		if (empty($variable) && !empty($_POST[$key]) && is_array($_POST[$key])) {
+			$variable = $_POST[$key];
+		}
+		return (array) $variable;
+	}
 
-    /**
-     * @return string
-     */
-    public function getIpAddress()
-    {
-        $cloudflareIps = glsr(Cache::class)->getCloudflareIps();
-        $ipv6 = defined('AF_INET6')
-            ? $cloudflareIps['v6']
-            : [];
-        $whitelist = apply_filters('site-reviews/whip/whitelist', [
-            Whip::CLOUDFLARE_HEADERS => [
-                Whip::IPV4 => $cloudflareIps['v4'],
-                Whip::IPV6 => $ipv6,
-            ],
-            Whip::CUSTOM_HEADERS => [
-                Whip::IPV4 => ['127.0.0.1'],
-                Whip::IPV6 => ['::1'],
-            ],
-        ]);
-        $methods = Whip::CUSTOM_HEADERS | Whip::CLOUDFLARE_HEADERS | Whip::REMOTE_ADDR;
-        $methods = apply_filters('site-reviews/whip/methods', $methods);
-        $whip = new Whip($methods, $whitelist);
-        do_action_ref_array('site-reviews/whip', [$whip]);
-        return (string) $whip->getValidIpAddress();
-    }
+	/**
+	 * @return string
+	 */
+	public function getIpAddress()
+	{
+		$cloudflareIps = glsr(Cache::class)->getCloudflareIps();
+		$ipv6 = defined('AF_INET6')
+			? $cloudflareIps['v6']
+			: [];
+		$whitelist = apply_filters('site-reviews/whip/whitelist', [
+			Whip::CLOUDFLARE_HEADERS => [
+				Whip::IPV4 => $cloudflareIps['v4'],
+				Whip::IPV6 => $ipv6,
+			],
+			Whip::CUSTOM_HEADERS => [
+				Whip::IPV4 => ['127.0.0.1'],
+				Whip::IPV6 => ['::1'],
+			],
+		]);
+		$methods = Whip::CUSTOM_HEADERS | Whip::CLOUDFLARE_HEADERS | Whip::REMOTE_ADDR;
+		$methods = apply_filters('site-reviews/whip/methods', $methods);
+		$whip = new Whip($methods, $whitelist);
+		do_action_ref_array('site-reviews/whip', [$whip]);
+		return (string) $whip->getValidIpAddress();
+	}
 }

plugin/Modules/Upgrader/Upgrade_4_0_0.php

Indentation +45 added lines, -45 removed lines

@@ -9,62 +9,62 @@
 
 class Upgrade_4_0_0
 {
-    public function __construct()
-    {
-        $this->migrateSettings();
-        $this->protectMetaKeys();
-        $this->deleteSessions();
-        delete_transient(Application::ID.'_cloudflare_ips');
-    }
+	public function __construct()
+	{
+		$this->migrateSettings();
+		$this->protectMetaKeys();
+		$this->deleteSessions();
+		delete_transient(Application::ID.'_cloudflare_ips');
+	}
 
-    /**
-     * @return void
-     */
-    public function deleteSessions()
-    {
-        global $wpdb;
-        $wpdb->query("
+	/**
+	 * @return void
+	 */
+	public function deleteSessions()
+	{
+		global $wpdb;
+		$wpdb->query("
             DELETE
             FROM {$wpdb->options}
             WHERE option_name LIKE '_glsr_session%'
         ");
-    }
+	}
 
-    /**
-     * @return void
-     */
-    public function migrateSettings()
-    {
-        if ($settings = get_option(OptionManager::databaseKey(3))) {
-            $multilingual = 'yes' == glsr(Helper::class)->dataGet($settings, 'settings.general.support.polylang')
-                ? 'polylang'
-                : '';
-            $settings = glsr(Helper::class)->dataSet($settings, 'settings.general.multilingual', $multilingual);
-            $settings = glsr(Helper::class)->dataSet($settings, 'settings.submissions.blacklist.integration', '');
-            $settings = glsr(Helper::class)->dataSet($settings, 'settings.submissions.limit', '');
-            $settings = glsr(Helper::class)->dataSet($settings, 'settings.submissions.limit_whitelist.email', '');
-            $settings = glsr(Helper::class)->dataSet($settings, 'settings.submissions.limit_whitelist.ip_address', '');
-            $settings = glsr(Helper::class)->dataSet($settings, 'settings.submissions.limit_whitelist.username', '');
-            unset($settings['settings']['general']['support']);
-            update_option(OptionManager::databaseKey(4), $settings);
-        }
-    }
+	/**
+	 * @return void
+	 */
+	public function migrateSettings()
+	{
+		if ($settings = get_option(OptionManager::databaseKey(3))) {
+			$multilingual = 'yes' == glsr(Helper::class)->dataGet($settings, 'settings.general.support.polylang')
+				? 'polylang'
+				: '';
+			$settings = glsr(Helper::class)->dataSet($settings, 'settings.general.multilingual', $multilingual);
+			$settings = glsr(Helper::class)->dataSet($settings, 'settings.submissions.blacklist.integration', '');
+			$settings = glsr(Helper::class)->dataSet($settings, 'settings.submissions.limit', '');
+			$settings = glsr(Helper::class)->dataSet($settings, 'settings.submissions.limit_whitelist.email', '');
+			$settings = glsr(Helper::class)->dataSet($settings, 'settings.submissions.limit_whitelist.ip_address', '');
+			$settings = glsr(Helper::class)->dataSet($settings, 'settings.submissions.limit_whitelist.username', '');
+			unset($settings['settings']['general']['support']);
+			update_option(OptionManager::databaseKey(4), $settings);
+		}
+	}
 
-    /**
-     * @return void
-     */
-    public function protectMetaKeys()
-    {
-        global $wpdb;
-        $keys = array_keys(glsr(CreateReviewDefaults::class)->defaults());
-        $keys = implode("','", $keys);
-        $postType = Application::POST_TYPE;
-        $wpdb->query("
+	/**
+	 * @return void
+	 */
+	public function protectMetaKeys()
+	{
+		global $wpdb;
+		$keys = array_keys(glsr(CreateReviewDefaults::class)->defaults());
+		$keys = implode("','", $keys);
+		$postType = Application::POST_TYPE;
+		$wpdb->query("
             UPDATE {$wpdb->postmeta} pm
             INNER JOIN {$wpdb->posts} p ON p.id = pm.post_id
             SET pm.meta_key = CONCAT('_', pm.meta_key)
             WHERE pm.meta_key IN ('{$keys}')
             AND p.post_type = '{$postType}'
         ");
-    }
+	}
 }

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

plugin/Defaults/EmailDefaults.php

Indentation +34 added lines, -34 removed lines

@@ -7,40 +7,40 @@
 
 class EmailDefaults extends Defaults
 {
-    /**
-     * @return array
-     */
-    protected function defaults()
-    {
-        return [
-            'after' => '',
-            'attachments' => [],
-            'bcc' => '',
-            'before' => '',
-            'cc' => '',
-            'from' => $this->getFromName().' <'.$this->getFromEmail().'>',
-            'message' => '',
-            'reply-to' => '',
-            'subject' => '',
-            'template' => '',
-            'template-tags' => [],
-            'to' => '',
-        ];
-    }
+	/**
+	 * @return array
+	 */
+	protected function defaults()
+	{
+		return [
+			'after' => '',
+			'attachments' => [],
+			'bcc' => '',
+			'before' => '',
+			'cc' => '',
+			'from' => $this->getFromName().' <'.$this->getFromEmail().'>',
+			'message' => '',
+			'reply-to' => '',
+			'subject' => '',
+			'template' => '',
+			'template-tags' => [],
+			'to' => '',
+		];
+	}
 
-    /**
-     * @return string
-     */
-    protected function getFromEmail()
-    {
-        return glsr(OptionManager::class)->getWP('admin_email');
-    }
+	/**
+	 * @return string
+	 */
+	protected function getFromEmail()
+	{
+		return glsr(OptionManager::class)->getWP('admin_email');
+	}
 
-    /**
-     * @return string
-     */
-    protected function getFromName()
-    {
-        return wp_specialchars_decode(glsr(OptionManager::class)->getWP('blogname'), ENT_QUOTES);
-    }
+	/**
+	 * @return string
+	 */
+	protected function getFromName()
+	{
+		return wp_specialchars_decode(glsr(OptionManager::class)->getWP('blogname'), ENT_QUOTES);
+	}
 }

plugin/Filters.php

Indentation +61 added lines, -61 removed lines

@@ -14,67 +14,67 @@
 
 class Filters implements HooksContract
 {
-    protected $admin;
-    protected $app;
-    protected $basename;
-    protected $blocks;
-    protected $editor;
-    protected $listtable;
-    protected $main;
-    protected $public;
-    protected $translator;
-    protected $welcome;
+	protected $admin;
+	protected $app;
+	protected $basename;
+	protected $blocks;
+	protected $editor;
+	protected $listtable;
+	protected $main;
+	protected $public;
+	protected $translator;
+	protected $welcome;
 
-    public function __construct(Application $app)
-    {
-        $this->app = $app;
-        $this->admin = $app->make(AdminController::class);
-        $this->basename = plugin_basename($app->file);
-        $this->blocks = $app->make(BlocksController::class);
-        $this->editor = $app->make(EditorController::class);
-        $this->listtable = $app->make(ListTableController::class);
-        $this->main = $app->make(MainController::class);
-        $this->public = $app->make(PublicController::class);
-        $this->translator = $app->make(Translator::class);
-        $this->welcome = $app->make(WelcomeController::class);
-    }
+	public function __construct(Application $app)
+	{
+		$this->app = $app;
+		$this->admin = $app->make(AdminController::class);
+		$this->basename = plugin_basename($app->file);
+		$this->blocks = $app->make(BlocksController::class);
+		$this->editor = $app->make(EditorController::class);
+		$this->listtable = $app->make(ListTableController::class);
+		$this->main = $app->make(MainController::class);
+		$this->public = $app->make(PublicController::class);
+		$this->translator = $app->make(Translator::class);
+		$this->welcome = $app->make(WelcomeController::class);
+	}
 
-    /**
-     * @return void
-     */
-    public function run()
-    {
-        add_filter('map_meta_cap',                                            [$this->admin, 'filterCreateCapability'], 10, 2);
-        add_filter('mce_external_plugins',                                    [$this->admin, 'filterTinymcePlugins'], 15);
-        add_filter('plugin_action_links_'.$this->basename,                    [$this->admin, 'filterActionLinks']);
-        add_filter('dashboard_glance_items',                                  [$this->admin, 'filterDashboardGlanceItems']);
-        add_filter('block_categories',                                        [$this->blocks, 'filterBlockCategories']);
-        add_filter('classic_editor_enabled_editors_for_post_type',            [$this->blocks, 'filterEnabledEditors'], 10, 2);
-        add_filter('use_block_editor_for_post_type',                          [$this->blocks, 'filterUseBlockEditor'], 10, 2);
-        add_filter('wp_editor_settings',                                      [$this->editor, 'filterEditorSettings']);
-        add_filter('the_editor',                                              [$this->editor, 'filterEditorTextarea']);
-        add_filter('is_protected_meta',                                       [$this->editor, 'filterIsProtectedMeta'], 10, 3);
-        add_filter('gettext',                                                 [$this->editor, 'filterPostStatusLabels'], 10, 3);
-        add_filter('gettext_with_context',                                    [$this->editor, 'filterPostStatusLabelsWithContext'], 10, 4);
-        add_filter('post_updated_messages',                                   [$this->editor, 'filterUpdateMessages']);
-        add_filter('bulk_post_updated_messages',                              [$this->listtable, 'filterBulkUpdateMessages'], 10, 2);
-        add_filter('manage_'.Application::POST_TYPE.'_posts_columns',         [$this->listtable, 'filterColumnsForPostType']);
-        add_filter('post_date_column_status',                                 [$this->listtable, 'filterDateColumnStatus'], 10, 2);
-        add_filter('default_hidden_columns',                                  [$this->listtable, 'filterDefaultHiddenColumns'], 10, 2);
-        add_filter('display_post_states',                                     [$this->listtable, 'filterPostStates'], 10, 2);
-        add_filter('post_row_actions',                                        [$this->listtable, 'filterRowActions'], 10, 2);
-        add_filter('manage_edit-'.Application::POST_TYPE.'_sortable_columns', [$this->listtable, 'filterSortableColumns']);
-        add_filter('ngettext',                                                [$this->listtable, 'filterStatusText'], 10, 5);
-        add_filter('script_loader_tag',                                       [$this->public, 'filterEnqueuedScripts'], 10, 2);
-        add_filter('site-reviews/config/forms/submission-form',               [$this->public, 'filterFieldOrder'], 11);
-        add_filter('query_vars',                                              [$this->public, 'filterQueryVars']);
-        add_filter('site-reviews/render/view',                                [$this->public, 'filterRenderView']);
-        add_filter('gettext',                                                 [$this->translator, 'filterGettext'], 10, 3);
-        add_filter('gettext_with_context',                                    [$this->translator, 'filterGettextWithContext'], 10, 4);
-        add_filter('ngettext',                                                [$this->translator, 'filterNgettext'], 10, 5);
-        add_filter('ngettext_with_context',                                   [$this->translator, 'filterNgettextWithContext'], 10, 6);
-        add_filter('plugin_action_links_'.$this->basename,                    [$this->welcome, 'filterActionLinks'], 9);
-        add_filter('admin_title',                                             [$this->welcome, 'filterAdminTitle']);
-        add_filter('admin_footer_text',                                       [$this->welcome, 'filterFooterText']);
-    }
+	/**
+	 * @return void
+	 */
+	public function run()
+	{
+		add_filter('map_meta_cap',                                            [$this->admin, 'filterCreateCapability'], 10, 2);
+		add_filter('mce_external_plugins',                                    [$this->admin, 'filterTinymcePlugins'], 15);
+		add_filter('plugin_action_links_'.$this->basename,                    [$this->admin, 'filterActionLinks']);
+		add_filter('dashboard_glance_items',                                  [$this->admin, 'filterDashboardGlanceItems']);
+		add_filter('block_categories',                                        [$this->blocks, 'filterBlockCategories']);
+		add_filter('classic_editor_enabled_editors_for_post_type',            [$this->blocks, 'filterEnabledEditors'], 10, 2);
+		add_filter('use_block_editor_for_post_type',                          [$this->blocks, 'filterUseBlockEditor'], 10, 2);
+		add_filter('wp_editor_settings',                                      [$this->editor, 'filterEditorSettings']);
+		add_filter('the_editor',                                              [$this->editor, 'filterEditorTextarea']);
+		add_filter('is_protected_meta',                                       [$this->editor, 'filterIsProtectedMeta'], 10, 3);
+		add_filter('gettext',                                                 [$this->editor, 'filterPostStatusLabels'], 10, 3);
+		add_filter('gettext_with_context',                                    [$this->editor, 'filterPostStatusLabelsWithContext'], 10, 4);
+		add_filter('post_updated_messages',                                   [$this->editor, 'filterUpdateMessages']);
+		add_filter('bulk_post_updated_messages',                              [$this->listtable, 'filterBulkUpdateMessages'], 10, 2);
+		add_filter('manage_'.Application::POST_TYPE.'_posts_columns',         [$this->listtable, 'filterColumnsForPostType']);
+		add_filter('post_date_column_status',                                 [$this->listtable, 'filterDateColumnStatus'], 10, 2);
+		add_filter('default_hidden_columns',                                  [$this->listtable, 'filterDefaultHiddenColumns'], 10, 2);
+		add_filter('display_post_states',                                     [$this->listtable, 'filterPostStates'], 10, 2);
+		add_filter('post_row_actions',                                        [$this->listtable, 'filterRowActions'], 10, 2);
+		add_filter('manage_edit-'.Application::POST_TYPE.'_sortable_columns', [$this->listtable, 'filterSortableColumns']);
+		add_filter('ngettext',                                                [$this->listtable, 'filterStatusText'], 10, 5);
+		add_filter('script_loader_tag',                                       [$this->public, 'filterEnqueuedScripts'], 10, 2);
+		add_filter('site-reviews/config/forms/submission-form',               [$this->public, 'filterFieldOrder'], 11);
+		add_filter('query_vars',                                              [$this->public, 'filterQueryVars']);
+		add_filter('site-reviews/render/view',                                [$this->public, 'filterRenderView']);
+		add_filter('gettext',                                                 [$this->translator, 'filterGettext'], 10, 3);
+		add_filter('gettext_with_context',                                    [$this->translator, 'filterGettextWithContext'], 10, 4);
+		add_filter('ngettext',                                                [$this->translator, 'filterNgettext'], 10, 5);
+		add_filter('ngettext_with_context',                                   [$this->translator, 'filterNgettextWithContext'], 10, 6);
+		add_filter('plugin_action_links_'.$this->basename,                    [$this->welcome, 'filterActionLinks'], 9);
+		add_filter('admin_title',                                             [$this->welcome, 'filterAdminTitle']);
+		add_filter('admin_footer_text',                                       [$this->welcome, 'filterFooterText']);
+	}
 }

plugin/Controllers/MainController.php

Indentation +87 added lines, -87 removed lines

@@ -10,94 +10,94 @@
 
 class MainController extends Controller
 {
-    /**
-     * @return void
-     * @action init
-     */
-    public function registerPostType()
-    {
-        if (!glsr()->hasPermission()) {
-            return;
-        }
-        $command = new RegisterPostType([
-            'capabilities' => ['create_posts' => 'create_'.Application::POST_TYPE],
-            'columns' => [
-                'title' => '',
-                'category' => '',
-                'assigned_to' => __('Assigned To', 'site-reviews'),
-                'reviewer' => __('Author', 'site-reviews'),
-                'review_type' => __('Type', 'site-reviews'),
-                'rating' => __('Rating', 'site-reviews'),
-                'pinned' => __('Pinned', 'site-reviews'),
-                'date' => '',
-            ],
-            'menu_icon' => 'dashicons-star-half',
-            'menu_name' => glsr()->name,
-            'map_meta_cap' => true,
-            'plural' => __('Reviews', 'site-reviews'),
-            'post_type' => Application::POST_TYPE,
-            'rest_controller_class' => RestReviewController::class,
-            'show_in_rest' => true,
-            'single' => __('Review', 'site-reviews'),
-        ]);
-        $this->execute($command);
-    }
+	/**
+	 * @return void
+	 * @action init
+	 */
+	public function registerPostType()
+	{
+		if (!glsr()->hasPermission()) {
+			return;
+		}
+		$command = new RegisterPostType([
+			'capabilities' => ['create_posts' => 'create_'.Application::POST_TYPE],
+			'columns' => [
+				'title' => '',
+				'category' => '',
+				'assigned_to' => __('Assigned To', 'site-reviews'),
+				'reviewer' => __('Author', 'site-reviews'),
+				'review_type' => __('Type', 'site-reviews'),
+				'rating' => __('Rating', 'site-reviews'),
+				'pinned' => __('Pinned', 'site-reviews'),
+				'date' => '',
+			],
+			'menu_icon' => 'dashicons-star-half',
+			'menu_name' => glsr()->name,
+			'map_meta_cap' => true,
+			'plural' => __('Reviews', 'site-reviews'),
+			'post_type' => Application::POST_TYPE,
+			'rest_controller_class' => RestReviewController::class,
+			'show_in_rest' => true,
+			'single' => __('Review', 'site-reviews'),
+		]);
+		$this->execute($command);
+	}
 
-    /**
-     * @return void
-     * @action init
-     */
-    public function registerShortcodes()
-    {
-        $command = new RegisterShortcodes([
-            'site_reviews',
-            'site_reviews_form',
-            'site_reviews_summary',
-        ]);
-        $this->execute($command);
-    }
+	/**
+	 * @return void
+	 * @action init
+	 */
+	public function registerShortcodes()
+	{
+		$command = new RegisterShortcodes([
+			'site_reviews',
+			'site_reviews_form',
+			'site_reviews_summary',
+		]);
+		$this->execute($command);
+	}
 
-    /**
-     * @return void
-     * @action init
-     */
-    public function registerTaxonomy()
-    {
-        $command = new RegisterTaxonomy([
-            'hierarchical' => true,
-            'meta_box_cb' => [glsr(EditorController::class), 'renderTaxonomyMetabox'],
-            'public' => false,
-            'rest_controller_class' => RestCategoryController::class,
-            'show_admin_column' => true,
-            'show_in_rest' => true,
-            'show_ui' => true,
-        ]);
-        $this->execute($command);
-    }
+	/**
+	 * @return void
+	 * @action init
+	 */
+	public function registerTaxonomy()
+	{
+		$command = new RegisterTaxonomy([
+			'hierarchical' => true,
+			'meta_box_cb' => [glsr(EditorController::class), 'renderTaxonomyMetabox'],
+			'public' => false,
+			'rest_controller_class' => RestCategoryController::class,
+			'show_admin_column' => true,
+			'show_in_rest' => true,
+			'show_ui' => true,
+		]);
+		$this->execute($command);
+	}
 
-    /**
-     * @return void
-     * @action widgets_init
-     */
-    public function registerWidgets()
-    {
-        $command = new RegisterWidgets([
-            'site-reviews' => [
-                'class' => 'glsr-widget glsr-widget-site-reviews',
-                'description' => __('Site Reviews: Display your recent reviews.', 'site-reviews'),
-                'title' => __('Recent Reviews', 'site-reviews'),
-            ],
-            'site-reviews-form' => [
-                'class' => 'glsr-widget glsr-widget-site-reviews-form',
-                'description' => __('Site Reviews: Display a form to submit reviews.', 'site-reviews'),
-                'title' => __('Submit a Review', 'site-reviews'),
-            ],
-            'site-reviews-summary' => [
-                'class' => 'glsr-widget glsr-widget-site-reviews-summary',
-                'description' => __('Site Reviews: Display a summary of your reviews.', 'site-reviews'),
-                'title' => __('Summary of Reviews', 'site-reviews'),
-            ],
-        ]);
-        $this->execute($command);
-    }
+	/**
+	 * @return void
+	 * @action widgets_init
+	 */
+	public function registerWidgets()
+	{
+		$command = new RegisterWidgets([
+			'site-reviews' => [
+				'class' => 'glsr-widget glsr-widget-site-reviews',
+				'description' => __('Site Reviews: Display your recent reviews.', 'site-reviews'),
+				'title' => __('Recent Reviews', 'site-reviews'),
+			],
+			'site-reviews-form' => [
+				'class' => 'glsr-widget glsr-widget-site-reviews-form',
+				'description' => __('Site Reviews: Display a form to submit reviews.', 'site-reviews'),
+				'title' => __('Submit a Review', 'site-reviews'),
+			],
+			'site-reviews-summary' => [
+				'class' => 'glsr-widget glsr-widget-site-reviews-summary',
+				'description' => __('Site Reviews: Display a summary of your reviews.', 'site-reviews'),
+				'title' => __('Summary of Reviews', 'site-reviews'),
+			],
+		]);
+		$this->execute($command);
+	}
 }