pryley / site-reviews

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

Spacing +71 added lines, -71 removed lines

@@ -57,19 +57,19 @@ 
     /**
      * @return static
      */
-    public function validate(array $request)
+    public function validate( array $request )
     {
         $this->form_id = $request['form_id'];
-        $this->options = glsr(OptionManager::class)->all();
-        $this->request = $this->validateRequest($request);
+        $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);
+        if( !empty($this->error) ) {
+            $this->setSessionValues( 'message', $this->error );
         }
         return $this;
     }
@@ -79,9 +79,9 @@ 
      * @param mixed $fallback
      * @return mixed
      */
-    protected function getOption($path, $fallback = '')
+    protected function getOption( $path, $fallback = '' )
     {
-        return glsr(Helper::class)->dataGet($this->options, $path, $fallback);
+        return glsr( Helper::class )->dataGet( $this->options, $path, $fallback );
     }
 
     /**
@@ -89,11 +89,11 @@ 
      */
     protected function getRecaptchaStatus()
     {
-        if (!glsr(OptionManager::class)->isRecaptchaEnabled()) {
+        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))
+        if( empty($this->request['_recaptcha-token']) ) {
+            return $this->request['_counter'] < intval( apply_filters( 'site-reviews/recaptcha/timeout', 5 ) )
                 ? static::RECAPTCHA_EMPTY
                 : static::RECAPTCHA_FAILED;
         }
@@ -105,23 +105,23 @@ 
      */
     protected function getRecaptchaTokenStatus()
     {
-        $endpoint = add_query_arg([
-            'remoteip' => glsr(Helper::class)->getIpAddress(),
+        $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());
+            '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)
+        $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);
+        foreach( $response->{'error-codes'} as $error ) {
+            glsr_log()->error( 'reCAPTCHA error: '.$error );
         }
         return static::RECAPTCHA_INVALID;
     }
@@ -129,34 +129,34 @@ 
     /**
      * @return array
      */
-    protected function getValidationRules(array $request)
+    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', []))
+            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));
+        $excluded = explode( ',', glsr_get( $request, 'excluded' ) );
+        return array_diff_key( $rules, array_flip( $excluded ) );
     }
 
     /**
      * @return bool
      */
-    protected function isRequestValid(array $request)
+    protected function isRequestValid( array $request )
     {
-        $rules = $this->getValidationRules($request);
-        $errors = glsr(Validator::class)->validate($request, $rules);
-        if (empty($errors)) {
+        $rules = $this->getValidationRules( $request );
+        $errors = glsr( Validator::class )->validate( $request, $rules );
+        if( empty($errors) ) {
             return true;
         }
-        $this->setSessionValues('errors', $errors);
-        $this->setSessionValues('values', $request);
+        $this->setSessionValues( 'errors', $errors );
+        $this->setSessionValues( 'values', $request );
         return false;
     }
 
-    protected function setError($message, $loggedMessage = '')
+    protected function setError( $message, $loggedMessage = '' )
     {
-        $this->setSessionValues('errors', [], $loggedMessage);
+        $this->setSessionValues( 'errors', [], $loggedMessage );
         $this->error = $message;
     }
 
@@ -166,11 +166,11 @@ 
      * @param string $loggedMessage
      * @return void
      */
-    protected function setSessionValues($type, $value, $loggedMessage = '')
+    protected function setSessionValues( $type, $value, $loggedMessage = '' )
     {
-        glsr()->sessionSet($this->form_id.$type, $value);
-        if (!empty($loggedMessage)) {
-            glsr_log()->warning($loggedMessage)->debug($this->request);
+        glsr()->sessionSet( $this->form_id.$type, $value );
+        if( !empty($loggedMessage) ) {
+            glsr_log()->warning( $loggedMessage )->debug( $this->request );
         }
     }
 
@@ -179,13 +179,13 @@ 
      */
     protected function validateAkismet()
     {
-        if (!empty($this->error)) {
+        if( !empty($this->error) ) {
             return;
         }
-        if (!glsr(Akismet::class)->isSpam($this->request)) {
+        if( !glsr( Akismet::class )->isSpam( $this->request ) ) {
             return;
         }
-        $this->setError(__('This review has been flagged as possible spam and cannot be submitted.', 'site-reviews'),
+        $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):'
         );
     }
@@ -195,18 +195,18 @@ 
      */
     protected function validateBlacklist()
     {
-        if (!empty($this->error)) {
+        if( !empty($this->error) ) {
             return;
         }
-        if (!glsr(Blacklist::class)->isBlacklisted($this->request)) {
+        if( !glsr( Blacklist::class )->isBlacklisted( $this->request ) ) {
             return;
         }
-        $blacklistAction = $this->getOption('settings.submissions.blacklist.action');
-        if ('reject' != $blacklistAction) {
+        $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'),
+        $this->setError( __( 'Your review cannot be submitted at this time.', 'site-reviews' ),
             'Blacklisted submission detected:'
         );
     }
@@ -216,18 +216,18 @@ 
      */
     protected function validateCustom()
     {
-        if (!empty($this->error)) {
+        if( !empty($this->error) ) {
             return;
         }
-        $validated = apply_filters('site-reviews/validate/custom', true, $this->request);
-        if (true === $validated) {
+        $validated = apply_filters( 'site-reviews/validate/custom', true, $this->request );
+        if( true === $validated ) {
             return;
         }
-        $errorMessage = is_string($validated)
+        $errorMessage = is_string( $validated )
             ? $validated
-            : __('The review submission failed. Please notify the site administrator.', 'site-reviews');
-        $this->setError($errorMessage);
-        $this->setSessionValues('values', $this->request);
+            : __( 'The review submission failed. Please notify the site administrator.', 'site-reviews' );
+        $this->setError( $errorMessage );
+        $this->setSessionValues( 'values', $this->request );
     }
 
     /**
@@ -235,13 +235,13 @@ 
      */
     protected function validateHoneyPot()
     {
-        if (!empty($this->error)) {
+        if( !empty($this->error) ) {
             return;
         }
-        if (empty($this->request['gotcha'])) {
+        if( empty($this->request['gotcha']) ) {
             return;
         }
-        $this->setError(__('The review submission failed. Please notify the site administrator.', 'site-reviews'),
+        $this->setError( __( 'The review submission failed. Please notify the site administrator.', 'site-reviews' ),
             'The Honeypot caught a bad submission:'
         );
     }
@@ -251,13 +251,13 @@ 
      */
     protected function validateReviewLimits()
     {
-        if (!empty($this->error)) {
+        if( !empty($this->error) ) {
             return;
         }
-        if (!glsr(ReviewLimits::class)->hasReachedLimit($this->request)) {
+        if( !glsr( ReviewLimits::class )->hasReachedLimit( $this->request ) ) {
             return;
         }
-        $this->setError(__('You have already submitted a review.', 'site-reviews'));
+        $this->setError( __( 'You have already submitted a review.', 'site-reviews' ) );
     }
 
     /**
@@ -265,35 +265,35 @@ 
      */
     protected function validateRecaptcha()
     {
-        if (!empty($this->error)) {
+        if( !empty($this->error) ) {
             return;
         }
         $status = $this->getRecaptchaStatus();
-        if (in_array($status, [static::RECAPTCHA_DISABLED, static::RECAPTCHA_VALID])) {
+        if( in_array( $status, [static::RECAPTCHA_DISABLED, static::RECAPTCHA_VALID] ) ) {
             return;
         }
-        if (static::RECAPTCHA_EMPTY === $status) {
-            $this->setSessionValues('recaptcha', 'unset');
+        if( static::RECAPTCHA_EMPTY === $status ) {
+            $this->setSessionValues( 'recaptcha', 'unset' );
             $this->recaptchaIsUnset = true;
             return;
         }
-        $this->setSessionValues('recaptcha', 'reset');
+        $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'),
+            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]);
+        $this->setError( $errors[$status] );
     }
 
     /**
      * @return array
      */
-    protected function validateRequest(array $request)
+    protected function validateRequest( array $request )
     {
-        if (!$this->isRequestValid($request)) {
-            $this->error = __('Please fix the submission errors.', 'site-reviews');
+        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_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);
+	}
 }

Spacing +28 added lines, -28 removed lines

@@ -13,26 +13,26 @@ 
      * @return array
      * @filter site-reviews/get/reviews/query
      */
-    public function filterReviewsQuery(array $parameters, array $args)
+    public function filterReviewsQuery( array $parameters, array $args )
     {
-        if ($authorId = get_current_user_id()) {
+        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 apply_filters( 'site-reviews/reviews-limits/query', $parameters, $args );
     }
 
     /**
      * @return bool
      */
-    public function hasReachedLimit(array $request = [])
+    public function hasReachedLimit( array $request = [] )
     {
         $this->request = $request;
-        $method = glsr(Helper::class)->buildMethodName(
-            glsr(OptionManager::class)->get('settings.submissions.limit'), 'validateBy'
+        $method = glsr( Helper::class )->buildMethodName(
+            glsr( OptionManager::class )->get( 'settings.submissions.limit' ), 'validateBy'
         );
-        return method_exists($this, $method)
-            ? !call_user_func([$this, $method])
+        return method_exists( $this, $method )
+            ? !call_user_func( [$this, $method] )
             : false;
     }
 
@@ -41,39 +41,39 @@ 
      * @param string $whitelist
      * @return bool
      */
-    public function isWhitelisted($value, $whitelist)
+    public function isWhitelisted( $value, $whitelist )
     {
-        if (empty($whitelist)) {
+        if( empty($whitelist) ) {
             return false;
         }
-        return in_array($value, array_filter(explode("\n", $whitelist), 'trim'));
+        return in_array( $value, array_filter( explode( "\n", $whitelist ), 'trim' ) );
     }
 
     /**
      * @param string $whitelistName
      * @return string
      */
-    protected function getWhitelist($whitelistName)
+    protected function getWhitelist( $whitelistName )
     {
-        return glsr(OptionManager::class)->get('settings.submissions.limit_whitelist.'.$whitelistName);
+        return glsr( OptionManager::class )->get( 'settings.submissions.limit_whitelist.'.$whitelistName );
     }
 
     /**
      * @return bool
      */
-    protected function validate($key, $value, $addMetaQuery = true)
+    protected function validate( $key, $value, $addMetaQuery = true )
     {
-        if ($this->isWhitelisted($value, $this->getWhitelist($key))) {
+        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) {
+        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);
+        $reviews = glsr_get_reviews( $args );
+        remove_filter( 'site-reviews/get/reviews/query', [$this, 'filterReviewsQuery'], 5 );
+        return 0 === count( $reviews );
     }
 
     /**
@@ -81,8 +81,8 @@ 
      */
     protected function validateByEmail()
     {
-        glsr_log()->debug('Email is: '.glsr_get($this->request, 'email'));
-        return $this->validate('email', glsr_get($this->request, 'email'));
+        glsr_log()->debug( 'Email is: '.glsr_get( $this->request, 'email' ) );
+        return $this->validate( 'email', glsr_get( $this->request, 'email' ) );
     }
 
     /**
@@ -90,8 +90,8 @@ 
      */
     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'));
+        glsr_log()->debug( 'IP Address is: '.glsr_get( $this->request, 'ip_address' ) );
+        return $this->validate( 'ip_address', glsr_get( $this->request, 'ip_address' ) );
     }
 
     /**
@@ -100,10 +100,10 @@ 
     protected function validateByUsername()
     {
         $user = wp_get_current_user();
-        if (!$user->exists()) {
+        if( !$user->exists() ) {
             return true;
         }
-        glsr_log()->debug('Username is: '.$user->user_login);
-        return $this->validate('username', $user->user_login, false);
+        glsr_log()->debug( 'Username is: '.$user->user_login );
+        return $this->validate( 'username', $user->user_login, false );
     }
 }

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

Spacing +71 added lines, -71 removed lines

@@ -21,9 +21,9 @@ 
      */
     public function enqueueAssets()
     {
-        $command = new EnqueueAdminAssets([
+        $command = new EnqueueAdminAssets( [
             'pointers' => [[
-                'content' => __('You can pin exceptional reviews so that they are always shown first.', 'site-reviews'),
+                'content' => __( 'You can pin exceptional reviews so that they are always shown first.', 'site-reviews' ),
                 'id' => 'glsr-pointer-pinned',
                 'position' => [
                     'edge' => 'right',
@@ -31,24 +31,24 @@ 
                 ],
                 'screen' => Application::POST_TYPE,
                 'target' => '#misc-pub-pinned',
-                'title' => __('Pin Your Reviews', 'site-reviews'),
+                'title' => __( 'Pin Your Reviews', 'site-reviews' ),
             ]],
-        ]);
-        $this->execute($command);
+        ] );
+        $this->execute( $command );
     }
 
     /**
      * @return array
      * @filter plugin_action_links_site-reviews/site-reviews.php
      */
-    public function filterActionLinks(array $links)
+    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'),
-        ]);
+        $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;
     }
 
@@ -58,9 +58,9 @@ 
      * @return array
      * @filter map_meta_cap
      */
-    public function filterCreateCapability($capabilities, $capability)
+    public function filterCreateCapability( $capabilities, $capability )
     {
-        if ($capability == 'create_'.Application::POST_TYPE) {
+        if( $capability == 'create_'.Application::POST_TYPE ) {
             $capabilities[] = 'do_not_allow';
         }
         return $capabilities;
@@ -71,23 +71,23 @@ 
      * @return array
      * @filter dashboard_glance_items
      */
-    public function filterDashboardGlanceItems($items)
+    public function filterDashboardGlanceItems( $items )
     {
-        $postCount = wp_count_posts(Application::POST_TYPE);
-        if (empty($postCount->publish)) {
+        $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, [
+        $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, [
+            ] )
+            : glsr( Builder::class )->span( $text, [
                 'class' => 'glsr-review-count',
-            ]);
+            ] );
         return $items;
     }
 
@@ -96,11 +96,11 @@ 
      * @return array
      * @filter mce_external_plugins
      */
-    public function filterTinymcePlugins($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');
+        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;
     }
@@ -111,12 +111,12 @@ 
      */
     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);
+        $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 );
     }
 
     /**
@@ -124,22 +124,22 @@ 
      * @return void|null
      * @action media_buttons
      */
-    public function renderTinymceButton($editorId)
+    public function renderTinymceButton( $editorId )
     {
-        $allowedEditors = apply_filters('site-reviews/tinymce/editor-ids', ['content'], $editorId);
-        if ('post' != glsr_current_screen()->base || !in_array($editorId, $allowedEditors)) {
+        $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) {
+        foreach( glsr()->mceShortcodes as $shortcode => $values ) {
             $shortcodes[$shortcode] = $values;
         }
-        if (empty($shortcodes)) {
+        if( empty($shortcodes) ) {
             return;
         }
-        glsr()->render('partials/editor/tinymce', [
+        glsr()->render( 'partials/editor/tinymce', [
             'shortcodes' => $shortcodes,
-        ]);
+        ] );
     }
 
     /**
@@ -147,8 +147,8 @@ 
      */
     public function routerClearConsole()
     {
-        glsr(Console::class)->clear();
-        glsr(Notice::class)->addSuccess(__('Console cleared.', 'site-reviews'));
+        glsr( Console::class )->clear();
+        glsr( Notice::class )->addSuccess( __( 'Console cleared.', 'site-reviews' ) );
     }
 
     /**
@@ -156,19 +156,19 @@ 
      */
     public function routerFetchConsole()
     {
-        glsr(Notice::class)->addSuccess(__('Console reloaded.', 'site-reviews'));
+        glsr( Notice::class )->addSuccess( __( 'Console reloaded.', 'site-reviews' ) );
     }
 
     /**
      * @param bool $showNotice
      * @return void
      */
-    public function routerCountReviews($showNotice = true)
+    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'));
+        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' ) );
         }
     }
 
@@ -177,7 +177,7 @@ 
      */
     public function routerDownloadConsole()
     {
-        $this->download(Application::ID.'-console.txt', glsr(Console::class)->get());
+        $this->download( Application::ID.'-console.txt', glsr( Console::class )->get() );
     }
 
     /**
@@ -185,7 +185,7 @@ 
      */
     public function routerDownloadSystemInfo()
     {
-        $this->download(Application::ID.'-system-info.txt', glsr(System::class)->get());
+        $this->download( Application::ID.'-system-info.txt', glsr( System::class )->get() );
     }
 
     /**
@@ -193,7 +193,7 @@ 
      */
     public function routerExportSettings()
     {
-        $this->download(Application::ID.'-settings.json', glsr(OptionManager::class)->json());
+        $this->download( Application::ID.'-settings.json', glsr( OptionManager::class )->json() );
     }
 
     /**
@@ -202,35 +202,35 @@ 
     public function routerImportSettings()
     {
         $file = $_FILES['import-file'];
-        if (UPLOAD_ERR_OK !== $file['error']) {
-            return glsr(Notice::class)->addError($this->getUploadError($file['error']));
+        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'));
+        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'));
+        $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'));
+        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)
+    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'),
+            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 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);
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -33,7 +33,7 @@ 
      */
     protected function getFromEmail()
     {
-        return glsr(OptionManager::class)->getWP('admin_email');
+        return glsr( OptionManager::class )->getWP( 'admin_email' );
     }
 
     /**
@@ -41,6 +41,6 @@ 
      */
     protected function getFromName()
     {
-        return wp_specialchars_decode(glsr(OptionManager::class)->getWP('blogname'), ENT_QUOTES);
+        return wp_specialchars_decode( glsr( OptionManager::class )->getWP( 'blogname' ), ENT_QUOTES );
     }
 }

views/pages/welcome/whatsnew.php

Spacing +1 added lines, -1 removed lines

@@ -1,4 +1,4 @@
-<?php defined('WPINC') || die; ?>
+<?php defined( 'WPINC' ) || die; ?>
 
 <p class="about-description">We think you'll love the changes in this new release!</p>
 <div class="is-fullwidth">

views/pages/welcome/index.php

Spacing +5 added lines, -5 removed lines

@@ -1,23 +1,23 @@
-<?php defined('WPINC') || die; ?>
+<?php defined( 'WPINC' ) || die; ?>
 
 <div class="glsr-welcome wrap about-wrap about-wrap-content">
     <h1>Welcome to <?= glsr()->name; ?></h1>
     <div class="about-text">Site Reviews is a free WordPress review plugin with advanced features that makes it easy to manage reviews on your website. Follow the instructions below to get started!</div>
     <div class="wp-badge">Version <?= glsr()->version; ?></div>
     <p class="about-buttons">
-        <a class="button" href="<?= admin_url('edit.php?post_type=site-review&page=documentation'); ?>">Documentation</a>
+        <a class="button" href="<?= admin_url( 'edit.php?post_type=site-review&page=documentation' ); ?>">Documentation</a>
         <a class="button" href="https://wordpress.org/support/plugin/site-reviews/">Support</a>
         <a target="_blank" class="button" href="https://www.facebook.com/sharer/sharer.php?u=https%3A//geminilabs.io/site-reviews"><span class="dashicons dashicons-facebook-alt"></span> Share</a>
         <a target="_blank" class="button" href="https://twitter.com/intent/tweet?text=Site Reviews is a fantastic WordPress review plugin with advanced features that makes it easy to manage reviews on your website.&url=https://geminilabs.io/site-reviews&hashtags=WordPress,reviewplugins,"><span class="dashicons dashicons-twitter"></span> Tweet</a>
     </p>
     <nav class="glsr-nav-tab-wrapper nav-tab-wrapper">
-        <?php foreach ($tabs as $id => $title) : ?>
+        <?php foreach( $tabs as $id => $title ) : ?>
         <a class="glsr-nav-tab nav-tab" href="#<?= $id; ?>"><?= $title; ?></a>
         <?php endforeach; ?>
     </nav>
-    <?php foreach ($tabs as $id => $title) : ?>
+    <?php foreach( $tabs as $id => $title ) : ?>
     <div class="glsr-nav-view ui-tabs-hide" id="<?= $id; ?>">
-        <?php $template->render('pages/welcome/'.$id, $data); ?>
+        <?php $template->render( 'pages/welcome/'.$id, $data ); ?>
     </div>
     <?php endforeach; ?>
     <input type="hidden" name="_active_tab">

views/pages/documentation/hooks.php

Spacing +12 added lines, -12 removed lines

@@ -1,4 +1,4 @@ 
-<?php defined('WPINC') || die; ?>
+<?php defined( 'WPINC' ) || die; ?>
 
 <p>Hooks (also known as <a href="https://developer.wordpress.org/plugins/hooks/index.html">Actions and Filters</a>) are used in your theme's <code>functions.php</code> file to make changes to the plugin.</p>
 
@@ -6,13 +6,13 @@ 
     <div class="glsr-card-header">
         <h3>Customise the order of the fields in the review submission form</h3>
         <button type="button" class="handlediv" aria-expanded="true">
-            <span class="screen-reader-text"><?= __('Toggle documentation panel', 'site-reviews'); ?></span>
+            <span class="screen-reader-text"><?= __( 'Toggle documentation panel', 'site-reviews' ); ?></span>
             <span class="toggle-indicator" aria-hidden="true"></span>
         </button>
     </div>
     <div class="inside">
         <p>Use this hook to customise the order of the fields in the review submission form used by Site Reviews.</p>
-        <p>See the <code><a data-expand="#faq-07" href="<?= admin_url('edit.php?post_type=site-review&page=documentation#!faq'); ?>">FAQ</a></code> for a detailed example of how to use this hook.</p>
+        <p>See the <code><a data-expand="#faq-07" href="<?= admin_url( 'edit.php?post_type=site-review&page=documentation#!faq' ); ?>">FAQ</a></code> for a detailed example of how to use this hook.</p>
         <pre><code class="php">/**
  * Customises the order of the fields used in the Site Reviews submission form.
  * Paste this in your active theme's functions.php file.
@@ -30,13 +30,13 @@ 
     <div class="glsr-card-header">
         <h3>Customise the star images</h3>
         <button type="button" class="handlediv" aria-expanded="true">
-            <span class="screen-reader-text"><?= __('Toggle documentation panel', 'site-reviews'); ?></span>
+            <span class="screen-reader-text"><?= __( 'Toggle documentation panel', 'site-reviews' ); ?></span>
             <span class="toggle-indicator" aria-hidden="true"></span>
         </button>
     </div>
     <div class="inside">
         <p>Use this hook to customise the star images used by Site Reviews.</p>
-        <p>See the <code><a data-expand="#faq-11" href="<?= admin_url('edit.php?post_type=site-review&page=documentation#!faq'); ?>">FAQ</a></code> for a detailed example of how to use this hook.</p>
+        <p>See the <code><a data-expand="#faq-11" href="<?= admin_url( 'edit.php?post_type=site-review&page=documentation#!faq' ); ?>">FAQ</a></code> for a detailed example of how to use this hook.</p>
         <pre><code class="php">/**
  * Customises the stars used by Site Reviews.
  * Paste this in your active theme's functions.php file.
@@ -54,7 +54,7 @@ 
     <div class="glsr-card-header">
         <h3>Disable the plugin javascript</h3>
         <button type="button" class="handlediv" aria-expanded="true">
-            <span class="screen-reader-text"><?= __('Toggle documentation panel', 'site-reviews'); ?></span>
+            <span class="screen-reader-text"><?= __( 'Toggle documentation panel', 'site-reviews' ); ?></span>
             <span class="toggle-indicator" aria-hidden="true"></span>
         </button>
     </div>
@@ -73,7 +73,7 @@ 
     <div class="glsr-card-header">
         <h3>Disable the plugin stylesheet</h3>
         <button type="button" class="handlediv" aria-expanded="true">
-            <span class="screen-reader-text"><?= __('Toggle documentation panel', 'site-reviews'); ?></span>
+            <span class="screen-reader-text"><?= __( 'Toggle documentation panel', 'site-reviews' ); ?></span>
             <span class="toggle-indicator" aria-hidden="true"></span>
         </button>
     </div>
@@ -92,7 +92,7 @@ 
     <div class="glsr-card-header">
         <h3>Disable the polyfill.io script</h3>
         <button type="button" class="handlediv" aria-expanded="true">
-            <span class="screen-reader-text"><?= __('Toggle documentation panel', 'site-reviews'); ?></span>
+            <span class="screen-reader-text"><?= __( 'Toggle documentation panel', 'site-reviews' ); ?></span>
             <span class="toggle-indicator" aria-hidden="true"></span>
         </button>
     </div>
@@ -112,7 +112,7 @@ 
     <div class="glsr-card-header">
         <h3>Do something immediately after a review has been submitted</h3>
         <button type="button" class="handlediv" aria-expanded="true">
-            <span class="screen-reader-text"><?= __('Toggle documentation panel', 'site-reviews'); ?></span>
+            <span class="screen-reader-text"><?= __( 'Toggle documentation panel', 'site-reviews' ); ?></span>
             <span class="toggle-indicator" aria-hidden="true"></span>
         </button>
     </div>
@@ -136,14 +136,14 @@ 
     <div class="glsr-card-header">
         <h3>Modify the schema</h3>
         <button type="button" class="handlediv" aria-expanded="true">
-            <span class="screen-reader-text"><?= __('Toggle documentation panel', 'site-reviews'); ?></span>
+            <span class="screen-reader-text"><?= __( 'Toggle documentation panel', 'site-reviews' ); ?></span>
             <span class="toggle-indicator" aria-hidden="true"></span>
         </button>
     </div>
     <div class="inside">
         <p>Use this hook if you would like to modify the schema type properties.</p>
         <p>This hook is specific to the schema type. For example, to modify the schema properties for the LocalBusiness schema type you would use the <code>site-reviews/schema/LocalBusiness</code> hook, but to modify the schema properties for the Product schema type you would use the <code>site-reviews/schema/Product</code> hook.</p>
-        <p>See the <code><a data-expand="#faq-01" href="<?= admin_url('edit.php?post_type=site-review&page=documentation#!faq'); ?>">FAQ</a></code> for a detailed example of how to use this hook.</p>
+        <p>See the <code><a data-expand="#faq-01" href="<?= admin_url( 'edit.php?post_type=site-review&page=documentation#!faq' ); ?>">FAQ</a></code> for a detailed example of how to use this hook.</p>
         <p>Make sure to use Google's <a href="https://search.google.com/structured-data/testing-tool">Structured Data Testing Tool</a> to test the schema after any custom modifications have been made.</p>
         <pre><code class="php">/**
  * Modifies the properties of the schema created by Site Reviews.
@@ -163,7 +163,7 @@ 
     <div class="glsr-card-header">
         <h3>Modify the submitted review before it is saved</h3>
         <button type="button" class="handlediv" aria-expanded="true">
-            <span class="screen-reader-text"><?= __('Toggle documentation panel', 'site-reviews'); ?></span>
+            <span class="screen-reader-text"><?= __( 'Toggle documentation panel', 'site-reviews' ); ?></span>
             <span class="toggle-indicator" aria-hidden="true"></span>
         </button>
     </div>

views/pages/settings/schema.php

Spacing +3 added lines, -3 removed lines

@@ -1,7 +1,7 @@
-<?php defined('WPINC') || die; ?>
+<?php defined( 'WPINC' ) || die; ?>
 
-<p><?= __('The JSON-LD schema is disabled by default. To use it, please enable the option in your blocks or shortcodes. The schema appears in Google\'s search results and shows the star rating and other information about your reviews. If the schema has been enabled, you can use Google\'s <a href="https://search.google.com/structured-data/testing-tool">Structured Data Testing Tool</a> to test your pages for valid schema data.', 'site-reviews'); ?></p>
-<p><?= __('You may override any of these options on a per-post/page basis by using its Custom Field name and adding a custom value using the <a href="https://codex.wordpress.org/Using_Custom_Fields#Usage">Custom Fields</a> metabox.', 'site-reviews'); ?></p>
+<p><?= __( 'The JSON-LD schema is disabled by default. To use it, please enable the option in your blocks or shortcodes. The schema appears in Google\'s search results and shows the star rating and other information about your reviews. If the schema has been enabled, you can use Google\'s <a href="https://search.google.com/structured-data/testing-tool">Structured Data Testing Tool</a> to test your pages for valid schema data.', 'site-reviews' ); ?></p>
+<p><?= __( 'You may override any of these options on a per-post/page basis by using its Custom Field name and adding a custom value using the <a href="https://codex.wordpress.org/Using_Custom_Fields#Usage">Custom Fields</a> metabox.', 'site-reviews' ); ?></p>
 <table class="form-table">
     <tbody>
         {{ rows }}

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

Spacing +27 added lines, -27 removed lines

@@ -16,31 +16,31 @@ 
      */
     public function registerPostType()
     {
-        if (!glsr()->hasPermission()) {
+        if( !glsr()->hasPermission() ) {
             return;
         }
-        $command = new RegisterPostType([
+        $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'),
+                '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'),
+            '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);
+            'single' => __( 'Review', 'site-reviews' ),
+        ] );
+        $this->execute( $command );
     }
 
     /**
@@ -49,12 +49,12 @@ 
      */
     public function registerShortcodes()
     {
-        $command = new RegisterShortcodes([
+        $command = new RegisterShortcodes( [
             'site_reviews',
             'site_reviews_form',
             'site_reviews_summary',
-        ]);
-        $this->execute($command);
+        ] );
+        $this->execute( $command );
     }
 
     /**
@@ -63,16 +63,16 @@ 
      */
     public function registerTaxonomy()
     {
-        $command = new RegisterTaxonomy([
+        $command = new RegisterTaxonomy( [
             'hierarchical' => true,
-            'meta_box_cb' => [glsr(EditorController::class), 'renderTaxonomyMetabox'],
+            '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);
+        ] );
+        $this->execute( $command );
     }
 
     /**
@@ -81,23 +81,23 @@ 
      */
     public function registerWidgets()
     {
-        $command = new 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'),
+                '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'),
+                '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'),
+                'description' => __( 'Site Reviews: Display a summary of your reviews.', 'site-reviews' ),
+                'title' => __( 'Summary of Reviews', 'site-reviews' ),
             ],
-        ]);
-        $this->execute($command);
+        ] );
+        $this->execute( $command );
     }
 }