pryley / site-reviews

plugin/Defaults/ValidateReviewDefaults.php

Indentation +18 added lines, -18 removed lines

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

plugin/Modules/Console.php

Indentation +433 added lines, -433 removed lines

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

deprecated.php

Indentation +116 added lines, -116 removed lines

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

plugin/Modules/Schema.php

Indentation +296 added lines, -296 removed lines

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

plugin/Handlers/EnqueuePublicAssets.php

Indentation +136 added lines, -136 removed lines

@@ -9,148 +9,148 @@
 
 class EnqueuePublicAssets
 {
-    /**
-     * @return void
-     */
-    public function handle()
-    {
-        $this->enqueueAssets();
-        $this->enqueuePolyfillService();
-        $this->enqueueRecaptchaScript();
-        $this->inlineScript();
-        $this->inlineStyles();
-    }
+	/**
+	 * @return void
+	 */
+	public function handle()
+	{
+		$this->enqueueAssets();
+		$this->enqueuePolyfillService();
+		$this->enqueueRecaptchaScript();
+		$this->inlineScript();
+		$this->inlineStyles();
+	}
 
-    /**
-     * @return void
-     */
-    public function enqueueAssets()
-    {
-        if (apply_filters('site-reviews/assets/css', true)) {
-            wp_enqueue_style(
-                Application::ID,
-                $this->getStylesheet(),
-                [],
-                glsr()->version
-            );
-        }
-        if (apply_filters('site-reviews/assets/js', true)) {
-            $dependencies = apply_filters('site-reviews/assets/polyfill', true)
-                ? [Application::ID.'/polyfill']
-                : [];
-            $dependencies = apply_filters('site-reviews/enqueue/public/dependencies', $dependencies);
-            wp_enqueue_script(
-                Application::ID,
-                glsr()->url('assets/scripts/'.Application::ID.'.js'),
-                $dependencies,
-                glsr()->version,
-                true
-            );
-        }
-    }
+	/**
+	 * @return void
+	 */
+	public function enqueueAssets()
+	{
+		if (apply_filters('site-reviews/assets/css', true)) {
+			wp_enqueue_style(
+				Application::ID,
+				$this->getStylesheet(),
+				[],
+				glsr()->version
+			);
+		}
+		if (apply_filters('site-reviews/assets/js', true)) {
+			$dependencies = apply_filters('site-reviews/assets/polyfill', true)
+				? [Application::ID.'/polyfill']
+				: [];
+			$dependencies = apply_filters('site-reviews/enqueue/public/dependencies', $dependencies);
+			wp_enqueue_script(
+				Application::ID,
+				glsr()->url('assets/scripts/'.Application::ID.'.js'),
+				$dependencies,
+				glsr()->version,
+				true
+			);
+		}
+	}
 
-    /**
-     * @return void
-     */
-    public function enqueuePolyfillService()
-    {
-        if (!apply_filters('site-reviews/assets/polyfill', true)) {
-            return;
-        }
-        wp_enqueue_script(Application::ID.'/polyfill', add_query_arg([
-            'features' => 'Array.prototype.findIndex,CustomEvent,Element.prototype.closest,Element.prototype.dataset,Event,XMLHttpRequest,MutationObserver',
-            'flags' => 'gated',
-        ], 'https://polyfill.io/v3/polyfill.min.js'));
-    }
+	/**
+	 * @return void
+	 */
+	public function enqueuePolyfillService()
+	{
+		if (!apply_filters('site-reviews/assets/polyfill', true)) {
+			return;
+		}
+		wp_enqueue_script(Application::ID.'/polyfill', add_query_arg([
+			'features' => 'Array.prototype.findIndex,CustomEvent,Element.prototype.closest,Element.prototype.dataset,Event,XMLHttpRequest,MutationObserver',
+			'flags' => 'gated',
+		], 'https://polyfill.io/v3/polyfill.min.js'));
+	}
 
-    /**
-     * @return void
-     */
-    public function enqueueRecaptchaScript()
-    {
-        // wpforms-recaptcha
-        // google-recaptcha
-        // nf-google-recaptcha
-        if (!glsr(OptionManager::class)->isRecaptchaEnabled()) {
-            return;
-        }
-        $language = apply_filters('site-reviews/recaptcha/language', get_locale());
-        wp_enqueue_script(Application::ID.'/google-recaptcha', add_query_arg([
-            'hl' => $language,
-            'render' => 'explicit',
-        ], 'https://www.google.com/recaptcha/api.js'));
-    }
+	/**
+	 * @return void
+	 */
+	public function enqueueRecaptchaScript()
+	{
+		// wpforms-recaptcha
+		// google-recaptcha
+		// nf-google-recaptcha
+		if (!glsr(OptionManager::class)->isRecaptchaEnabled()) {
+			return;
+		}
+		$language = apply_filters('site-reviews/recaptcha/language', get_locale());
+		wp_enqueue_script(Application::ID.'/google-recaptcha', add_query_arg([
+			'hl' => $language,
+			'render' => 'explicit',
+		], 'https://www.google.com/recaptcha/api.js'));
+	}
 
-    /**
-     * @return void
-     */
-    public function inlineScript()
-    {
-        $variables = [
-            'action' => Application::PREFIX.'action',
-            'ajaxpagination' => $this->getFixedSelectorsForPagination(),
-            'ajaxurl' => admin_url('admin-ajax.php'),
-            'nameprefix' => Application::ID,
-            'validationconfig' => glsr(Style::class)->validation,
-            'validationstrings' => glsr(ValidationStringsDefaults::class)->defaults(),
-        ];
-        $variables = apply_filters('site-reviews/enqueue/public/localize', $variables);
-        wp_add_inline_script(Application::ID, $this->buildInlineScript($variables), 'before');
-    }
+	/**
+	 * @return void
+	 */
+	public function inlineScript()
+	{
+		$variables = [
+			'action' => Application::PREFIX.'action',
+			'ajaxpagination' => $this->getFixedSelectorsForPagination(),
+			'ajaxurl' => admin_url('admin-ajax.php'),
+			'nameprefix' => Application::ID,
+			'validationconfig' => glsr(Style::class)->validation,
+			'validationstrings' => glsr(ValidationStringsDefaults::class)->defaults(),
+		];
+		$variables = apply_filters('site-reviews/enqueue/public/localize', $variables);
+		wp_add_inline_script(Application::ID, $this->buildInlineScript($variables), 'before');
+	}
 
-    /**
-     * @return void
-     */
-    public function inlineStyles()
-    {
-        $inlineStylesheetPath = glsr()->path('assets/styles/inline-styles.css');
-        if (!apply_filters('site-reviews/assets/css', true)) {
-            return;
-        }
-        if (!file_exists($inlineStylesheetPath)) {
-            glsr_log()->error('Inline stylesheet is missing: '.$inlineStylesheetPath);
-            return;
-        }
-        $inlineStylesheetValues = glsr()->config('inline-styles');
-        $stylesheet = str_replace(
-            array_keys($inlineStylesheetValues),
-            array_values($inlineStylesheetValues),
-            file_get_contents($inlineStylesheetPath)
-        );
-        wp_add_inline_style(Application::ID, $stylesheet);
-    }
+	/**
+	 * @return void
+	 */
+	public function inlineStyles()
+	{
+		$inlineStylesheetPath = glsr()->path('assets/styles/inline-styles.css');
+		if (!apply_filters('site-reviews/assets/css', true)) {
+			return;
+		}
+		if (!file_exists($inlineStylesheetPath)) {
+			glsr_log()->error('Inline stylesheet is missing: '.$inlineStylesheetPath);
+			return;
+		}
+		$inlineStylesheetValues = glsr()->config('inline-styles');
+		$stylesheet = str_replace(
+			array_keys($inlineStylesheetValues),
+			array_values($inlineStylesheetValues),
+			file_get_contents($inlineStylesheetPath)
+		);
+		wp_add_inline_style(Application::ID, $stylesheet);
+	}
 
-    /**
-     * @return string
-     */
-    protected function buildInlineScript(array $variables)
-    {
-        $script = 'window.hasOwnProperty("GLSR")||(window.GLSR={});';
-        foreach ($variables as $key => $value) {
-            $script.= sprintf('GLSR.%s=%s;', $key, json_encode($value, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE));
-        }
-        $pattern = '/\"([^ \-\"]+)\"(:[{\[\"])/'; // removes unnecessary quotes surrounding object keys
-        $optimizedScript = preg_replace($pattern, '$1$2', $script);
-        return apply_filters('site-reviews/enqueue/public/inline-script', $optimizedScript, $script, $variables);
-    }
+	/**
+	 * @return string
+	 */
+	protected function buildInlineScript(array $variables)
+	{
+		$script = 'window.hasOwnProperty("GLSR")||(window.GLSR={});';
+		foreach ($variables as $key => $value) {
+			$script.= sprintf('GLSR.%s=%s;', $key, json_encode($value, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE));
+		}
+		$pattern = '/\"([^ \-\"]+)\"(:[{\[\"])/'; // removes unnecessary quotes surrounding object keys
+		$optimizedScript = preg_replace($pattern, '$1$2', $script);
+		return apply_filters('site-reviews/enqueue/public/inline-script', $optimizedScript, $script, $variables);
+	}
 
-    /**
-     * @return array
-     */
-    protected function getFixedSelectorsForPagination()
-    {
-        $selectors = ['#wpadminbar', '.site-navigation-fixed'];
-        return apply_filters('site-reviews/enqueue/public/localize/ajax-pagination', $selectors);
-    }
+	/**
+	 * @return array
+	 */
+	protected function getFixedSelectorsForPagination()
+	{
+		$selectors = ['#wpadminbar', '.site-navigation-fixed'];
+		return apply_filters('site-reviews/enqueue/public/localize/ajax-pagination', $selectors);
+	}
 
-    /**
-     * @return string
-     */
-    protected function getStylesheet()
-    {
-        $currentStyle = glsr(Style::class)->style;
-        return file_exists(glsr()->path('assets/styles/custom/'.$currentStyle.'.css'))
-            ? glsr()->url('assets/styles/custom/'.$currentStyle.'.css')
-            : glsr()->url('assets/styles/'.Application::ID.'.css');
-    }
+	/**
+	 * @return string
+	 */
+	protected function getStylesheet()
+	{
+		$currentStyle = glsr(Style::class)->style;
+		return file_exists(glsr()->path('assets/styles/custom/'.$currentStyle.'.css'))
+			? glsr()->url('assets/styles/custom/'.$currentStyle.'.css')
+			: glsr()->url('assets/styles/'.Application::ID.'.css');
+	}
 }

plugin/Modules/Upgrader.php

Indentation +74 added lines, -74 removed lines

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

plugin/Controllers/SettingsController.php

Indentation +111 added lines, -111 removed lines

@@ -9,120 +9,120 @@
 
 class SettingsController extends Controller
 {
-    /**
-     * @param mixed $input
-     * @return array
-     * @callback register_setting
-     */
-    public function callbackRegisterSettings($input)
-    {
-        $settings = Arr::consolidateArray($input);
-        if (1 === count($settings) && array_key_exists('settings', $settings)) {
-            $options = array_replace_recursive(glsr(OptionManager::class)->all(), $input);
-            $options = $this->sanitizeGeneral($input, $options);
-            $options = $this->sanitizeSubmissions($input, $options);
-            $options = $this->sanitizeTranslations($input, $options);
-            $options = apply_filters('site-reviews/settings/callback', $options, $settings);
-            if (filter_input(INPUT_POST, 'option_page') == Application::ID.'-settings') {
-                glsr(Notice::class)->addSuccess(__('Settings updated.', 'site-reviews'));
-            }
-            return $options;
-        }
-        return $input;
-    }
+	/**
+	 * @param mixed $input
+	 * @return array
+	 * @callback register_setting
+	 */
+	public function callbackRegisterSettings($input)
+	{
+		$settings = Arr::consolidateArray($input);
+		if (1 === count($settings) && array_key_exists('settings', $settings)) {
+			$options = array_replace_recursive(glsr(OptionManager::class)->all(), $input);
+			$options = $this->sanitizeGeneral($input, $options);
+			$options = $this->sanitizeSubmissions($input, $options);
+			$options = $this->sanitizeTranslations($input, $options);
+			$options = apply_filters('site-reviews/settings/callback', $options, $settings);
+			if (filter_input(INPUT_POST, 'option_page') == Application::ID.'-settings') {
+				glsr(Notice::class)->addSuccess(__('Settings updated.', 'site-reviews'));
+			}
+			return $options;
+		}
+		return $input;
+	}
 
-    /**
-     * @return void
-     * @action admin_init
-     */
-    public function registerSettings()
-    {
-        register_setting(Application::ID.'-settings', OptionManager::databaseKey(), [
-            'sanitize_callback' => [$this, 'callbackRegisterSettings'],
-        ]);
-    }
+	/**
+	 * @return void
+	 * @action admin_init
+	 */
+	public function registerSettings()
+	{
+		register_setting(Application::ID.'-settings', OptionManager::databaseKey(), [
+			'sanitize_callback' => [$this, 'callbackRegisterSettings'],
+		]);
+	}
 
-    /**
-     * @return array
-     */
-    protected function sanitizeGeneral(array $input, array $options)
-    {
-        $key = 'settings.general';
-        $inputForm = Arr::get($input, $key);
-        if (!$this->hasMultilingualIntegration(Arr::get($inputForm, 'multilingual'))) {
-            $options = Arr::set($options, $key.'.multilingual', '');
-        }
-        if ('' == trim(Arr::get($inputForm, 'notification_message'))) {
-            $defaultValue = Arr::get(glsr()->defaults, $key.'.notification_message');
-            $options = Arr::set($options, $key.'.notification_message', $defaultValue);
-        }
-        $defaultValue = Arr::get($inputForm, 'notifications', []);
-        $options = Arr::set($options, $key.'.notifications', $defaultValue);
-        return $options;
-    }
+	/**
+	 * @return array
+	 */
+	protected function sanitizeGeneral(array $input, array $options)
+	{
+		$key = 'settings.general';
+		$inputForm = Arr::get($input, $key);
+		if (!$this->hasMultilingualIntegration(Arr::get($inputForm, 'multilingual'))) {
+			$options = Arr::set($options, $key.'.multilingual', '');
+		}
+		if ('' == trim(Arr::get($inputForm, 'notification_message'))) {
+			$defaultValue = Arr::get(glsr()->defaults, $key.'.notification_message');
+			$options = Arr::set($options, $key.'.notification_message', $defaultValue);
+		}
+		$defaultValue = Arr::get($inputForm, 'notifications', []);
+		$options = Arr::set($options, $key.'.notifications', $defaultValue);
+		return $options;
+	}
 
-    /**
-     * @return array
-     */
-    protected function sanitizeSubmissions(array $input, array $options)
-    {
-        $key = 'settings.submissions';
-        $inputForm = Arr::get($input, $key);
-        $defaultValue = isset($inputForm['required'])
-            ? $inputForm['required']
-            : [];
-        $options = Arr::set($options, $key.'.required', $defaultValue);
-        return $options;
-    }
+	/**
+	 * @return array
+	 */
+	protected function sanitizeSubmissions(array $input, array $options)
+	{
+		$key = 'settings.submissions';
+		$inputForm = Arr::get($input, $key);
+		$defaultValue = isset($inputForm['required'])
+			? $inputForm['required']
+			: [];
+		$options = Arr::set($options, $key.'.required', $defaultValue);
+		return $options;
+	}
 
-    /**
-     * @return array
-     */
-    protected function sanitizeTranslations(array $input, array $options)
-    {
-        $key = 'settings.strings';
-        $inputForm = Arr::consolidateArray(Arr::get($input, $key));
-        if (!empty($inputForm)) {
-            $options = Arr::set($options, $key, array_values(array_filter($inputForm)));
-            $allowedTags = [
-                'a' => ['class' => [], 'href' => [], 'target' => []],
-                'span' => ['class' => []],
-            ];
-            array_walk($options['settings']['strings'], function (&$string) use ($allowedTags) {
-                if (isset($string['s2'])) {
-                    $string['s2'] = wp_kses($string['s2'], $allowedTags);
-                }
-                if (isset($string['p2'])) {
-                    $string['p2'] = wp_kses($string['p2'], $allowedTags);
-                }
-            });
-        }
-        return $options;
-    }
+	/**
+	 * @return array
+	 */
+	protected function sanitizeTranslations(array $input, array $options)
+	{
+		$key = 'settings.strings';
+		$inputForm = Arr::consolidateArray(Arr::get($input, $key));
+		if (!empty($inputForm)) {
+			$options = Arr::set($options, $key, array_values(array_filter($inputForm)));
+			$allowedTags = [
+				'a' => ['class' => [], 'href' => [], 'target' => []],
+				'span' => ['class' => []],
+			];
+			array_walk($options['settings']['strings'], function (&$string) use ($allowedTags) {
+				if (isset($string['s2'])) {
+					$string['s2'] = wp_kses($string['s2'], $allowedTags);
+				}
+				if (isset($string['p2'])) {
+					$string['p2'] = wp_kses($string['p2'], $allowedTags);
+				}
+			});
+		}
+		return $options;
+	}
 
-    /**
-     * @return bool
-     */
-    protected function hasMultilingualIntegration($integration)
-    {
-        if (!in_array($integration, ['polylang', 'wpml'])) {
-            return false;
-        }
-        $integrationClass = 'GeminiLabs\SiteReviews\Modules\\'.ucfirst($integration);
-        if (!glsr($integrationClass)->isActive()) {
-            glsr(Notice::class)->addError(sprintf(
-                __('Please install/activate the %s plugin to enable integration.', 'site-reviews'),
-                constant($integrationClass.'::PLUGIN_NAME')
-            ));
-            return false;
-        } elseif (!glsr($integrationClass)->isSupported()) {
-            glsr(Notice::class)->addError(sprintf(
-                __('Please update the %s plugin to v%s or greater to enable integration.', 'site-reviews'),
-                constant($integrationClass.'::PLUGIN_NAME'),
-                constant($integrationClass.'::SUPPORTED_VERSION')
-            ));
-            return false;
-        }
-        return true;
-    }
+	/**
+	 * @return bool
+	 */
+	protected function hasMultilingualIntegration($integration)
+	{
+		if (!in_array($integration, ['polylang', 'wpml'])) {
+			return false;
+		}
+		$integrationClass = 'GeminiLabs\SiteReviews\Modules\\'.ucfirst($integration);
+		if (!glsr($integrationClass)->isActive()) {
+			glsr(Notice::class)->addError(sprintf(
+				__('Please install/activate the %s plugin to enable integration.', 'site-reviews'),
+				constant($integrationClass.'::PLUGIN_NAME')
+			));
+			return false;
+		} elseif (!glsr($integrationClass)->isSupported()) {
+			glsr(Notice::class)->addError(sprintf(
+				__('Please update the %s plugin to v%s or greater to enable integration.', 'site-reviews'),
+				constant($integrationClass.'::PLUGIN_NAME'),
+				constant($integrationClass.'::SUPPORTED_VERSION')
+			));
+			return false;
+		}
+		return true;
+	}
 }

plugin/Defaults/StyleValidationDefaults.php

Indentation +19 added lines, -19 removed lines

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

plugin/Handlers/EnqueueAdminAssets.php

Indentation +146 added lines, -146 removed lines

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