pryley / site-reviews

plugin/Database/DefaultsManager.php

Indentation +52 added lines, -52 removed lines

@@ -6,60 +6,60 @@
 
 class DefaultsManager
 {
-    /**
-     * @return array
-     */
-    public function defaults()
-    {
-        $settings = $this->settings();
-        $defaults = (array) array_combine(array_keys($settings), glsr_array_column($settings, 'default'));
-        return wp_parse_args($defaults, [
-            'version' => '',
-            'version_upgraded_from' => '',
-        ]);
-    }
+	/**
+	 * @return array
+	 */
+	public function defaults()
+	{
+		$settings = $this->settings();
+		$defaults = (array) array_combine(array_keys($settings), glsr_array_column($settings, 'default'));
+		return wp_parse_args($defaults, [
+			'version' => '',
+			'version_upgraded_from' => '',
+		]);
+	}
 
-    /**
-     * @return array
-     */
-    public function get()
-    {
-        return Arr::convertDotNotationArray($this->defaults());
-    }
+	/**
+	 * @return array
+	 */
+	public function get()
+	{
+		return Arr::convertDotNotationArray($this->defaults());
+	}
 
-    /**
-     * @return array
-     */
-    public function set()
-    {
-        $settings = glsr(OptionManager::class)->all();
-        $currentSettings = Arr::removeEmptyArrayValues($settings);
-        $defaultSettings = array_replace_recursive($this->get(), $currentSettings);
-        $updatedSettings = array_replace_recursive($settings, $defaultSettings);
-        update_option(OptionManager::databaseKey(), $updatedSettings);
-        return $defaultSettings;
-    }
+	/**
+	 * @return array
+	 */
+	public function set()
+	{
+		$settings = glsr(OptionManager::class)->all();
+		$currentSettings = Arr::removeEmptyArrayValues($settings);
+		$defaultSettings = array_replace_recursive($this->get(), $currentSettings);
+		$updatedSettings = array_replace_recursive($settings, $defaultSettings);
+		update_option(OptionManager::databaseKey(), $updatedSettings);
+		return $defaultSettings;
+	}
 
-    /**
-     * @return array
-     */
-    public function settings()
-    {
-        $settings = apply_filters('site-reviews/addon/settings', glsr()->config('settings'));
-        return $this->normalize($settings);
-    }
+	/**
+	 * @return array
+	 */
+	public function settings()
+	{
+		$settings = apply_filters('site-reviews/addon/settings', glsr()->config('settings'));
+		return $this->normalize($settings);
+	}
 
-    /**
-     * @return array
-     */
-    protected function normalize(array $settings)
-    {
-        array_walk($settings, function (&$setting) {
-            if (isset($setting['default'])) {
-                return;
-            }
-            $setting['default'] = '';
-        });
-        return $settings;
-    }
+	/**
+	 * @return array
+	 */
+	protected function normalize(array $settings)
+	{
+		array_walk($settings, function (&$setting) {
+			if (isset($setting['default'])) {
+				return;
+			}
+			$setting['default'] = '';
+		});
+		return $settings;
+	}
 }

plugin/Modules/Html/Settings.php

Indentation +235 added lines, -235 removed lines

@@ -11,239 +11,239 @@
 
 class Settings
 {
-    /**
-     * @var array
-     */
-    public $settings;
-
-    /**
-     * @param string $id
-     * @return string
-     */
-    public function buildFields($id)
-    {
-        $this->settings = glsr(DefaultsManager::class)->settings();
-        $method = Helper::buildMethodName($id, 'getTemplateDataFor');
-        $data = !method_exists($this, $method)
-            ? $this->getTemplateData($id)
-            : $this->$method($id);
-        return glsr(Template::class)->build('pages/settings/'.$id, $data);
-    }
-
-    /**
-     * @return string
-     */
-    protected function getFieldDefault(array $field)
-    {
-        return Arr::get($field, 'default');
-    }
-
-    /**
-     * @return string
-     */
-    protected function getFieldNameForDependsOn($path)
-    {
-        $fieldName = Str::convertPathToName($path, OptionManager::databaseKey());
-        return $this->isMultiDependency($path)
-            ? $fieldName.'[]'
-            : $fieldName;
-    }
-
-    /**
-     * @return array
-     */
-    protected function getSettingFields($path)
-    {
-        return array_filter($this->settings, function ($key) use ($path) {
-            return Str::startsWith($path, $key);
-        }, ARRAY_FILTER_USE_KEY);
-    }
-
-    /**
-     * @return string
-     */
-    protected function getSettingRows(array $fields)
-    {
-        $rows = '';
-        foreach ($fields as $name => $field) {
-            $field = wp_parse_args($field, [
-                'is_setting' => true,
-                'name' => $name,
-            ]);
-            $rows.= new Field($this->normalize($field));
-        }
-        return $rows;
-    }
-
-    /**
-     * @param string $id
-     * @return array
-     */
-    protected function getTemplateData($id)
-    {
-        $fields = $this->getSettingFields($this->normalizeSettingPath($id));
-        return [
-            'context' => [
-                'rows' => $this->getSettingRows($fields),
-            ],
-        ];
-    }
-
-    /**
-     * @param string $id
-     * @return array
-     */
-    protected function getTemplateDataForAddons($id)
-    {
-        $fields = $this->getSettingFields($this->normalizeSettingPath($id));
-        $settings = Arr::convertDotNotationArray($fields);
-        $settingKeys = array_keys($settings['settings']['addons']);
-        $results = [];
-        foreach ($settingKeys as $key) {
-            $addonFields = array_filter($fields, function ($path) use ($key) {
-                return Str::startsWith('settings.addons.'.$key, $path);
-            }, ARRAY_FILTER_USE_KEY);
-            $results[$key] = $this->getSettingRows($addonFields);
-        }
-        ksort($results);
-        return [
-            'settings' => $results,
-        ];
-    }
-
-    /**
-     * @param string $id
-     * @return array
-     */
-    protected function getTemplateDataForLicenses($id)
-    {
-        $fields = $this->getSettingFields($this->normalizeSettingPath($id));
-        ksort($fields);
-        return [
-            'context' => [
-                'rows' => $this->getSettingRows($fields),
-            ],
-        ];
-    }
-
-    /**
-     * @return array
-     */
-    protected function getTemplateDataForTranslations()
-    {
-        $translations = glsr(Translation::class)->renderAll();
-        $class = empty($translations)
-            ? 'glsr-hidden'
-            : '';
-        return [
-            'context' => [
-                'class' => $class,
-                'database_key' => OptionManager::databaseKey(),
-                'translations' => $translations,
-            ],
-        ];
-    }
-
-    /**
-     * @param string $path
-     * @param string|array $expectedValue
-     * @return bool
-     */
-    protected function isFieldHidden($path, $expectedValue)
-    {
-        $optionValue = glsr(OptionManager::class)->get(
-            $path,
-            Arr::get(glsr()->defaults, $path)
-        );
-        if (is_array($expectedValue)) {
-            return is_array($optionValue)
-                ? 0 === count(array_intersect($optionValue, $expectedValue))
-                : !in_array($optionValue, $expectedValue);
-        }
-        return $optionValue != $expectedValue;
-    }
-
-    /**
-     * @return bool
-     */
-    protected function isMultiDependency($path)
-    {
-        if (isset($this->settings[$path])) {
-            $field = $this->settings[$path];
-            return ('checkbox' == $field['type'] && !empty($field['options']))
-                || !empty($field['multiple']);
-        }
-        return false;
-    }
-
-    /**
-     * @return array
-     */
-    protected function normalize(array $field)
-    {
-        $field = $this->normalizeDependsOn($field);
-        $field = $this->normalizeLabelAndLegend($field);
-        $field = $this->normalizeValue($field);
-        return $field;
-    }
-
-    /**
-     * @return array
-     */
-    protected function normalizeDependsOn(array $field)
-    {
-        if (!empty($field['depends_on']) && is_array($field['depends_on'])) {
-            $isFieldHidden = false;
-            $conditions = [];
-            foreach ($field['depends_on'] as $path => $value) {
-                $conditions[] = [
-                    'name' => $this->getFieldNameForDependsOn($path),
-                    'value' => $value,
-                ];
-                if ($this->isFieldHidden($path, $value)) {
-                    $isFieldHidden = true;
-                }
-            }
-            $field['data-depends'] = json_encode($conditions, JSON_HEX_APOS | JSON_HEX_QUOT);
-            $field['is_hidden'] = $isFieldHidden;
-        }
-        return $field;
-    }
-
-    /**
-     * @return array
-     */
-    protected function normalizeLabelAndLegend(array $field)
-    {
-        if (!empty($field['label'])) {
-            $field['legend'] = $field['label'];
-            unset($field['label']);
-        } else {
-            $field['is_valid'] = false;
-            glsr_log()->warning('Setting field is missing a label')->debug($field);
-        }
-        return $field;
-    }
-
-    /**
-     * @return array
-     */
-    protected function normalizeValue(array $field)
-    {
-        if (!isset($field['value'])) {
-            $field['value'] = glsr(OptionManager::class)->get(
-                $field['name'],
-                $this->getFieldDefault($field)
-            );
-        }
-        return $field;
-    }
-
-    /**
-     * @return string
-     */
-    protected function normalizeSettingPath($path)
-    {
-        return Str::prefix('settings.', rtrim($path, '.'));
-    }
+	/**
+	 * @var array
+	 */
+	public $settings;
+
+	/**
+	 * @param string $id
+	 * @return string
+	 */
+	public function buildFields($id)
+	{
+		$this->settings = glsr(DefaultsManager::class)->settings();
+		$method = Helper::buildMethodName($id, 'getTemplateDataFor');
+		$data = !method_exists($this, $method)
+			? $this->getTemplateData($id)
+			: $this->$method($id);
+		return glsr(Template::class)->build('pages/settings/'.$id, $data);
+	}
+
+	/**
+	 * @return string
+	 */
+	protected function getFieldDefault(array $field)
+	{
+		return Arr::get($field, 'default');
+	}
+
+	/**
+	 * @return string
+	 */
+	protected function getFieldNameForDependsOn($path)
+	{
+		$fieldName = Str::convertPathToName($path, OptionManager::databaseKey());
+		return $this->isMultiDependency($path)
+			? $fieldName.'[]'
+			: $fieldName;
+	}
+
+	/**
+	 * @return array
+	 */
+	protected function getSettingFields($path)
+	{
+		return array_filter($this->settings, function ($key) use ($path) {
+			return Str::startsWith($path, $key);
+		}, ARRAY_FILTER_USE_KEY);
+	}
+
+	/**
+	 * @return string
+	 */
+	protected function getSettingRows(array $fields)
+	{
+		$rows = '';
+		foreach ($fields as $name => $field) {
+			$field = wp_parse_args($field, [
+				'is_setting' => true,
+				'name' => $name,
+			]);
+			$rows.= new Field($this->normalize($field));
+		}
+		return $rows;
+	}
+
+	/**
+	 * @param string $id
+	 * @return array
+	 */
+	protected function getTemplateData($id)
+	{
+		$fields = $this->getSettingFields($this->normalizeSettingPath($id));
+		return [
+			'context' => [
+				'rows' => $this->getSettingRows($fields),
+			],
+		];
+	}
+
+	/**
+	 * @param string $id
+	 * @return array
+	 */
+	protected function getTemplateDataForAddons($id)
+	{
+		$fields = $this->getSettingFields($this->normalizeSettingPath($id));
+		$settings = Arr::convertDotNotationArray($fields);
+		$settingKeys = array_keys($settings['settings']['addons']);
+		$results = [];
+		foreach ($settingKeys as $key) {
+			$addonFields = array_filter($fields, function ($path) use ($key) {
+				return Str::startsWith('settings.addons.'.$key, $path);
+			}, ARRAY_FILTER_USE_KEY);
+			$results[$key] = $this->getSettingRows($addonFields);
+		}
+		ksort($results);
+		return [
+			'settings' => $results,
+		];
+	}
+
+	/**
+	 * @param string $id
+	 * @return array
+	 */
+	protected function getTemplateDataForLicenses($id)
+	{
+		$fields = $this->getSettingFields($this->normalizeSettingPath($id));
+		ksort($fields);
+		return [
+			'context' => [
+				'rows' => $this->getSettingRows($fields),
+			],
+		];
+	}
+
+	/**
+	 * @return array
+	 */
+	protected function getTemplateDataForTranslations()
+	{
+		$translations = glsr(Translation::class)->renderAll();
+		$class = empty($translations)
+			? 'glsr-hidden'
+			: '';
+		return [
+			'context' => [
+				'class' => $class,
+				'database_key' => OptionManager::databaseKey(),
+				'translations' => $translations,
+			],
+		];
+	}
+
+	/**
+	 * @param string $path
+	 * @param string|array $expectedValue
+	 * @return bool
+	 */
+	protected function isFieldHidden($path, $expectedValue)
+	{
+		$optionValue = glsr(OptionManager::class)->get(
+			$path,
+			Arr::get(glsr()->defaults, $path)
+		);
+		if (is_array($expectedValue)) {
+			return is_array($optionValue)
+				? 0 === count(array_intersect($optionValue, $expectedValue))
+				: !in_array($optionValue, $expectedValue);
+		}
+		return $optionValue != $expectedValue;
+	}
+
+	/**
+	 * @return bool
+	 */
+	protected function isMultiDependency($path)
+	{
+		if (isset($this->settings[$path])) {
+			$field = $this->settings[$path];
+			return ('checkbox' == $field['type'] && !empty($field['options']))
+				|| !empty($field['multiple']);
+		}
+		return false;
+	}
+
+	/**
+	 * @return array
+	 */
+	protected function normalize(array $field)
+	{
+		$field = $this->normalizeDependsOn($field);
+		$field = $this->normalizeLabelAndLegend($field);
+		$field = $this->normalizeValue($field);
+		return $field;
+	}
+
+	/**
+	 * @return array
+	 */
+	protected function normalizeDependsOn(array $field)
+	{
+		if (!empty($field['depends_on']) && is_array($field['depends_on'])) {
+			$isFieldHidden = false;
+			$conditions = [];
+			foreach ($field['depends_on'] as $path => $value) {
+				$conditions[] = [
+					'name' => $this->getFieldNameForDependsOn($path),
+					'value' => $value,
+				];
+				if ($this->isFieldHidden($path, $value)) {
+					$isFieldHidden = true;
+				}
+			}
+			$field['data-depends'] = json_encode($conditions, JSON_HEX_APOS | JSON_HEX_QUOT);
+			$field['is_hidden'] = $isFieldHidden;
+		}
+		return $field;
+	}
+
+	/**
+	 * @return array
+	 */
+	protected function normalizeLabelAndLegend(array $field)
+	{
+		if (!empty($field['label'])) {
+			$field['legend'] = $field['label'];
+			unset($field['label']);
+		} else {
+			$field['is_valid'] = false;
+			glsr_log()->warning('Setting field is missing a label')->debug($field);
+		}
+		return $field;
+	}
+
+	/**
+	 * @return array
+	 */
+	protected function normalizeValue(array $field)
+	{
+		if (!isset($field['value'])) {
+			$field['value'] = glsr(OptionManager::class)->get(
+				$field['name'],
+				$this->getFieldDefault($field)
+			);
+		}
+		return $field;
+	}
+
+	/**
+	 * @return string
+	 */
+	protected function normalizeSettingPath($path)
+	{
+		return Str::prefix('settings.', rtrim($path, '.'));
+	}
 }

plugin/Modules/Style.php

Indentation +128 added lines, -128 removed lines

@@ -12,144 +12,144 @@
 
 class Style
 {
-    /**
-     * @var array
-     */
-    public $fields;
+	/**
+	 * @var array
+	 */
+	public $fields;
 
-    /**
-     * @var string
-     */
-    public $style;
+	/**
+	 * @var string
+	 */
+	public $style;
 
-    /**
-     * @var array
-     */
-    public $pagination;
+	/**
+	 * @var array
+	 */
+	public $pagination;
 
-    /**
-     * @var array
-     */
-    public $validation;
+	/**
+	 * @var array
+	 */
+	public $validation;
 
-    public function __construct()
-    {
-        $this->style = glsr(OptionManager::class)->get('settings.general.style', 'default');
-        $this->setConfig();
-    }
+	public function __construct()
+	{
+		$this->style = glsr(OptionManager::class)->get('settings.general.style', 'default');
+		$this->setConfig();
+	}
 
-    /**
-     * @param string $view
-     * @return string
-     */
-    public function filterView($view)
-    {
-        $styledViews = [
-            'templates/form/field',
-            'templates/form/response',
-            'templates/form/submit-button',
-            'templates/reviews-form',
-        ];
-        if (!preg_match('('.implode('|', $styledViews).')', $view)) {
-            return $view;
-        }
-        $views = $this->generatePossibleViews($view);
-        foreach ($views as $possibleView) {
-            if (!file_exists(glsr()->file($possibleView))) {
-                continue;
-            }
-            return Str::removePrefix('views/', $possibleView);
-        }
-        return $view;
-    }
+	/**
+	 * @param string $view
+	 * @return string
+	 */
+	public function filterView($view)
+	{
+		$styledViews = [
+			'templates/form/field',
+			'templates/form/response',
+			'templates/form/submit-button',
+			'templates/reviews-form',
+		];
+		if (!preg_match('('.implode('|', $styledViews).')', $view)) {
+			return $view;
+		}
+		$views = $this->generatePossibleViews($view);
+		foreach ($views as $possibleView) {
+			if (!file_exists(glsr()->file($possibleView))) {
+				continue;
+			}
+			return Str::removePrefix('views/', $possibleView);
+		}
+		return $view;
+	}
 
-    /**
-     * @return string
-     */
-    public function get()
-    {
-        return apply_filters('site-reviews/style', $this->style);
-    }
+	/**
+	 * @return string
+	 */
+	public function get()
+	{
+		return apply_filters('site-reviews/style', $this->style);
+	}
 
-    /**
-     * @return array
-     */
-    public function setConfig()
-    {
-        $config = shortcode_atts(
-            array_fill_keys(['fields', 'pagination', 'validation'], []),
-            glsr()->config('styles/'.$this->style)
-        );
-        $this->fields = glsr(StyleFieldsDefaults::class)->restrict($config['fields']);
-        $this->pagination = glsr(PaginationDefaults::class)->restrict($config['pagination']);
-        $this->validation = glsr(StyleValidationDefaults::class)->restrict($config['validation']);
-    }
+	/**
+	 * @return array
+	 */
+	public function setConfig()
+	{
+		$config = shortcode_atts(
+			array_fill_keys(['fields', 'pagination', 'validation'], []),
+			glsr()->config('styles/'.$this->style)
+		);
+		$this->fields = glsr(StyleFieldsDefaults::class)->restrict($config['fields']);
+		$this->pagination = glsr(PaginationDefaults::class)->restrict($config['pagination']);
+		$this->validation = glsr(StyleValidationDefaults::class)->restrict($config['validation']);
+	}
 
-    /**
-     * @return void
-     */
-    public function modifyField(Builder $instance)
-    {
-        if (!$this->isPublicInstance($instance) || empty(array_filter($this->fields))) {
-            return;
-        }
-        call_user_func_array([$this, 'customize'], [$instance]);
-    }
+	/**
+	 * @return void
+	 */
+	public function modifyField(Builder $instance)
+	{
+		if (!$this->isPublicInstance($instance) || empty(array_filter($this->fields))) {
+			return;
+		}
+		call_user_func_array([$this, 'customize'], [$instance]);
+	}
 
-    /**
-     * @return array
-     */
-    public function paginationArgs(array $args)
-    {
-        return wp_parse_args($args, $this->pagination);
-    }
+	/**
+	 * @return array
+	 */
+	public function paginationArgs(array $args)
+	{
+		return wp_parse_args($args, $this->pagination);
+	}
 
-    /**
-     * @return void
-     */
-    protected function customize(Builder $instance)
-    {
-        if (!array_key_exists($instance->tag, $this->fields)) {
-            return;
-        }
-        $args = wp_parse_args($instance->args, array_fill_keys(['class', 'type'], ''));
-        $key = $instance->tag.'_'.$args['type'];
-        $classes = Arr::get($this->fields, $key, Arr::get($this->fields, $instance->tag));
-        $instance->args['class'] = trim($args['class'].' '.$classes);
-        do_action_ref_array('site-reviews/customize/'.$this->style, [$instance]);
-    }
+	/**
+	 * @return void
+	 */
+	protected function customize(Builder $instance)
+	{
+		if (!array_key_exists($instance->tag, $this->fields)) {
+			return;
+		}
+		$args = wp_parse_args($instance->args, array_fill_keys(['class', 'type'], ''));
+		$key = $instance->tag.'_'.$args['type'];
+		$classes = Arr::get($this->fields, $key, Arr::get($this->fields, $instance->tag));
+		$instance->args['class'] = trim($args['class'].' '.$classes);
+		do_action_ref_array('site-reviews/customize/'.$this->style, [$instance]);
+	}
 
-    /**
-     * @param string $view
-     * @return array
-     */
-    protected function generatePossibleViews($view)
-    {
-        $basename = basename($view);
-        $basepath = rtrim($view, $basename);
-        $customPath = 'views/partials/styles/'.$this->style.'/';
-        $parts = explode('_', $basename);
-        $views = [
-            $customPath.$basename,
-            $customPath.$parts[0],
-            $view,
-            $basepath.$parts[0],
-        ];
-        return array_filter($views);
-    }
+	/**
+	 * @param string $view
+	 * @return array
+	 */
+	protected function generatePossibleViews($view)
+	{
+		$basename = basename($view);
+		$basepath = rtrim($view, $basename);
+		$customPath = 'views/partials/styles/'.$this->style.'/';
+		$parts = explode('_', $basename);
+		$views = [
+			$customPath.$basename,
+			$customPath.$parts[0],
+			$view,
+			$basepath.$parts[0],
+		];
+		return array_filter($views);
+	}
 
-    /**
-     * @return bool
-     */
-    protected function isPublicInstance(Builder $instance)
-    {
-        $args = wp_parse_args($instance->args, [
-            'is_public' => false,
-            'is_raw' => false,
-        ]);
-        if (is_admin() || !$args['is_public'] || $args['is_raw']) {
-            return false;
-        }
-        return true;
-    }
+	/**
+	 * @return bool
+	 */
+	protected function isPublicInstance(Builder $instance)
+	{
+		$args = wp_parse_args($instance->args, [
+			'is_public' => false,
+			'is_raw' => false,
+		]);
+		if (is_admin() || !$args['is_public'] || $args['is_raw']) {
+			return false;
+		}
+		return true;
+	}
 }

plugin/Review.php

Indentation +157 added lines, -157 removed lines

@@ -12,173 +12,173 @@
 
 class Review implements \ArrayAccess
 {
-    public $assigned_to;
-    public $author;
-    public $avatar;
-    public $content;
-    public $custom;
-    public $date;
-    public $email;
-    public $ID;
-    public $ip_address;
-    public $modified;
-    public $pinned;
-    public $rating;
-    public $response;
-    public $review_id;
-    public $review_type;
-    public $status;
-    public $term_ids;
-    public $title;
-    public $url;
-    public $user_id;
+	public $assigned_to;
+	public $author;
+	public $avatar;
+	public $content;
+	public $custom;
+	public $date;
+	public $email;
+	public $ID;
+	public $ip_address;
+	public $modified;
+	public $pinned;
+	public $rating;
+	public $response;
+	public $review_id;
+	public $review_type;
+	public $status;
+	public $term_ids;
+	public $title;
+	public $url;
+	public $user_id;
 
-    public function __construct(WP_Post $post)
-    {
-        if (Application::POST_TYPE != $post->post_type) {
-            return;
-        }
-        $this->content = $post->post_content;
-        $this->date = $post->post_date;
-        $this->ID = intval($post->ID);
-        $this->status = $post->post_status;
-        $this->title = $post->post_title;
-        $this->user_id = intval($post->post_author);
-        $this->setProperties($post);
-        $this->setTermIds($post);
-    }
+	public function __construct(WP_Post $post)
+	{
+		if (Application::POST_TYPE != $post->post_type) {
+			return;
+		}
+		$this->content = $post->post_content;
+		$this->date = $post->post_date;
+		$this->ID = intval($post->ID);
+		$this->status = $post->post_status;
+		$this->title = $post->post_title;
+		$this->user_id = intval($post->post_author);
+		$this->setProperties($post);
+		$this->setTermIds($post);
+	}
 
-    /**
-     * @return mixed
-     */
-    public function __get($key)
-    {
-        return $this->offsetGet($key);
-    }
+	/**
+	 * @return mixed
+	 */
+	public function __get($key)
+	{
+		return $this->offsetGet($key);
+	}
 
-    /**
-     * @return string
-     */
-    public function __toString()
-    {
-        return (string) $this->build();
-    }
+	/**
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return (string) $this->build();
+	}
 
-    /**
-     * @return ReviewHtml
-     */
-    public function build(array $args = [])
-    {
-        if (empty($this->ID)) {
-            return new ReviewHtml($this);
-        }
-        $partial = glsr(SiteReviewsPartial::class);
-        $partial->args = glsr(SiteReviewsDefaults::class)->merge($args);
-        $partial->options = Arr::flattenArray(glsr(OptionManager::class)->all());
-        return $partial->buildReview($this);
-    }
+	/**
+	 * @return ReviewHtml
+	 */
+	public function build(array $args = [])
+	{
+		if (empty($this->ID)) {
+			return new ReviewHtml($this);
+		}
+		$partial = glsr(SiteReviewsPartial::class);
+		$partial->args = glsr(SiteReviewsDefaults::class)->merge($args);
+		$partial->options = Arr::flattenArray(glsr(OptionManager::class)->all());
+		return $partial->buildReview($this);
+	}
 
-    /**
-     * @param mixed $key
-     * @return bool
-     */
-    public function offsetExists($key)
-    {
-        return property_exists($this, $key) || array_key_exists($key, (array) $this->custom);
-    }
+	/**
+	 * @param mixed $key
+	 * @return bool
+	 */
+	public function offsetExists($key)
+	{
+		return property_exists($this, $key) || array_key_exists($key, (array) $this->custom);
+	}
 
-    /**
-     * @param mixed $key
-     * @return mixed
-     */
-    public function offsetGet($key)
-    {
-        return property_exists($this, $key)
-            ? $this->$key
-            : Arr::get($this->custom, $key, null);
-    }
+	/**
+	 * @param mixed $key
+	 * @return mixed
+	 */
+	public function offsetGet($key)
+	{
+		return property_exists($this, $key)
+			? $this->$key
+			: Arr::get($this->custom, $key, null);
+	}
 
-    /**
-     * @param mixed $key
-     * @param mixed $value
-     * @return void
-     */
-    public function offsetSet($key, $value)
-    {
-        if (property_exists($this, $key)) {
-            $this->$key = $value;
-            return;
-        }
-        if (!is_array($this->custom)) {
-            $this->custom = array_filter((array) $this->custom);
-        }
-        $this->custom[$key] = $value;
-    }
+	/**
+	 * @param mixed $key
+	 * @param mixed $value
+	 * @return void
+	 */
+	public function offsetSet($key, $value)
+	{
+		if (property_exists($this, $key)) {
+			$this->$key = $value;
+			return;
+		}
+		if (!is_array($this->custom)) {
+			$this->custom = array_filter((array) $this->custom);
+		}
+		$this->custom[$key] = $value;
+	}
 
-    /**
-     * @param mixed $key
-     * @return void
-     */
-    public function offsetUnset($key)
-    {
-        $this->offsetSet($key, null);
-    }
+	/**
+	 * @param mixed $key
+	 * @return void
+	 */
+	public function offsetUnset($key)
+	{
+		$this->offsetSet($key, null);
+	}
 
-    /**
-     * @return void
-     */
-    public function render()
-    {
-        echo $this->build();
-    }
+	/**
+	 * @return void
+	 */
+	public function render()
+	{
+		echo $this->build();
+	}
 
-    /**
-     * @return bool
-     */
-    protected function isModified(array $properties)
-    {
-        return $this->date != $properties['date']
-            || $this->content != $properties['content']
-            || $this->title != $properties['title'];
-    }
+	/**
+	 * @return bool
+	 */
+	protected function isModified(array $properties)
+	{
+		return $this->date != $properties['date']
+			|| $this->content != $properties['content']
+			|| $this->title != $properties['title'];
+	}
 
-    /**
-     * @return void
-     */
-    protected function setProperties(WP_Post $post)
-    {
-        $defaults = [
-            'author' => __('Anonymous', 'site-reviews'),
-            'date' => '',
-            'review_id' => '',
-            'review_type' => 'local',
-        ];
-        $meta = array_filter(
-            array_map('array_shift', array_filter((array) get_post_meta($post->ID))),
-            'strlen'
-        );
-        $meta = array_merge($defaults, Arr::unprefixArrayKeys($meta));
-        $properties = glsr(CreateReviewDefaults::class)->restrict(array_merge($defaults, $meta));
-        $this->modified = $this->isModified($properties);
-        array_walk($properties, function ($value, $key) {
-            if (!property_exists($this, $key) || isset($this->$key)) {
-                return;
-            }
-            $this->$key = maybe_unserialize($value);
-        });
-    }
+	/**
+	 * @return void
+	 */
+	protected function setProperties(WP_Post $post)
+	{
+		$defaults = [
+			'author' => __('Anonymous', 'site-reviews'),
+			'date' => '',
+			'review_id' => '',
+			'review_type' => 'local',
+		];
+		$meta = array_filter(
+			array_map('array_shift', array_filter((array) get_post_meta($post->ID))),
+			'strlen'
+		);
+		$meta = array_merge($defaults, Arr::unprefixArrayKeys($meta));
+		$properties = glsr(CreateReviewDefaults::class)->restrict(array_merge($defaults, $meta));
+		$this->modified = $this->isModified($properties);
+		array_walk($properties, function ($value, $key) {
+			if (!property_exists($this, $key) || isset($this->$key)) {
+				return;
+			}
+			$this->$key = maybe_unserialize($value);
+		});
+	}
 
-    /**
-     * @return void
-     */
-    protected function setTermIds(WP_Post $post)
-    {
-        $this->term_ids = [];
-        if (!is_array($terms = get_the_terms($post, Application::TAXONOMY))) {
-            return;
-        }
-        foreach ($terms as $term) {
-            $this->term_ids[] = $term->term_id;
-        }
-    }
+	/**
+	 * @return void
+	 */
+	protected function setTermIds(WP_Post $post)
+	{
+		$this->term_ids = [];
+		if (!is_array($terms = get_the_terms($post, Application::TAXONOMY))) {
+			return;
+		}
+		foreach ($terms as $term) {
+			$this->term_ids[] = $term->term_id;
+		}
+	}
 }

plugin/Blocks/SiteReviewsBlock.php

Indentation +115 added lines, -115 removed lines

@@ -6,124 +6,124 @@
 
 class SiteReviewsBlock extends BlockGenerator
 {
-    /**
-     * @return array
-     */
-    public function attributes()
-    {
-        return [
-            'assigned_to' => [
-                'default' => '',
-                'type' => 'string',
-            ],
-            'category' => [
-                'default' => '',
-                'type' => 'string',
-            ],
-            'className' => [
-                'default' => '',
-                'type' => 'string',
-            ],
-            'display' => [
-                'default' => 5,
-                'type' => 'number',
-            ],
-            'hide' => [
-                'default' => '',
-                'type' => 'string',
-            ],
-            'id' => [
-                'default' => '',
-                'type' => 'string',
-            ],
-            'pagination' => [
-                'default' => '',
-                'type' => 'string',
-            ],
-            'post_id' => [
-                'default' => '',
-                'type' => 'string',
-            ],
-            'rating' => [
-                'default' => 0,
-                'type' => 'number',
-            ],
-            'schema' => [
-                'default' => false,
-                'type' => 'boolean',
-            ],
-            'type' => [
-                'default' => 'local',
-                'type' => 'string',
-            ],
-        ];
-    }
+	/**
+	 * @return array
+	 */
+	public function attributes()
+	{
+		return [
+			'assigned_to' => [
+				'default' => '',
+				'type' => 'string',
+			],
+			'category' => [
+				'default' => '',
+				'type' => 'string',
+			],
+			'className' => [
+				'default' => '',
+				'type' => 'string',
+			],
+			'display' => [
+				'default' => 5,
+				'type' => 'number',
+			],
+			'hide' => [
+				'default' => '',
+				'type' => 'string',
+			],
+			'id' => [
+				'default' => '',
+				'type' => 'string',
+			],
+			'pagination' => [
+				'default' => '',
+				'type' => 'string',
+			],
+			'post_id' => [
+				'default' => '',
+				'type' => 'string',
+			],
+			'rating' => [
+				'default' => 0,
+				'type' => 'number',
+			],
+			'schema' => [
+				'default' => false,
+				'type' => 'boolean',
+			],
+			'type' => [
+				'default' => 'local',
+				'type' => 'string',
+			],
+		];
+	}
 
-    /**
-     * @return string
-     */
-    public function render(array $attributes)
-    {
-        $attributes['class'] = $attributes['className'];
-        $shortcode = glsr(Shortcode::class);
-        if ('edit' == filter_input(INPUT_GET, 'context')) {
-            $attributes = $this->normalize($attributes);
-            $this->filterReviewLinks();
-            $this->filterShortcodeClass();
-            $this->filterShowMoreLinks('content');
-            $this->filterShowMoreLinks('response');
-            if (!$this->hasVisibleFields($shortcode, $attributes)) {
-                $this->filterInterpolation();
-            }
-        }
-        return $shortcode->buildShortcode($attributes);
-    }
+	/**
+	 * @return string
+	 */
+	public function render(array $attributes)
+	{
+		$attributes['class'] = $attributes['className'];
+		$shortcode = glsr(Shortcode::class);
+		if ('edit' == filter_input(INPUT_GET, 'context')) {
+			$attributes = $this->normalize($attributes);
+			$this->filterReviewLinks();
+			$this->filterShortcodeClass();
+			$this->filterShowMoreLinks('content');
+			$this->filterShowMoreLinks('response');
+			if (!$this->hasVisibleFields($shortcode, $attributes)) {
+				$this->filterInterpolation();
+			}
+		}
+		return $shortcode->buildShortcode($attributes);
+	}
 
-    /**
-     * @return void
-     */
-    protected function filterInterpolation()
-    {
-        add_filter('site-reviews/interpolate/reviews', function ($context) {
-            $context['class'] = 'glsr-default glsr-block-disabled';
-            $context['reviews'] = __('You have hidden all of the fields for this block.', 'site-reviews');
-            return $context;
-        });
-    }
+	/**
+	 * @return void
+	 */
+	protected function filterInterpolation()
+	{
+		add_filter('site-reviews/interpolate/reviews', function ($context) {
+			$context['class'] = 'glsr-default glsr-block-disabled';
+			$context['reviews'] = __('You have hidden all of the fields for this block.', 'site-reviews');
+			return $context;
+		});
+	}
 
-    /**
-     * @return void
-     */
-    protected function filterReviewLinks()
-    {
-        add_filter('site-reviews/rendered/template/reviews', function ($template) {
-            return str_replace('<a', '<a tabindex="-1"', $template);
-        });
-    }
+	/**
+	 * @return void
+	 */
+	protected function filterReviewLinks()
+	{
+		add_filter('site-reviews/rendered/template/reviews', function ($template) {
+			return str_replace('<a', '<a tabindex="-1"', $template);
+		});
+	}
 
-    /**
-     * @return void
-     */
-    protected function filterShortcodeClass()
-    {
-        add_filter('site-reviews/style', function () {
-            return 'default';
-        });
-    }
+	/**
+	 * @return void
+	 */
+	protected function filterShortcodeClass()
+	{
+		add_filter('site-reviews/style', function () {
+			return 'default';
+		});
+	}
 
-    /**
-     * @param string $field
-     * @return void
-     */
-    protected function filterShowMoreLinks($field)
-    {
-        add_filter('site-reviews/review/wrap/'.$field, function ($value) {
-            $value = preg_replace(
-                '/(.*)(<span class="glsr-hidden)(.*)(<\/span>)(.*)/s',
-                '$1... <a href="#" class="glsr-read-more" tabindex="-1">'.__('Show more', 'site-reviews').'</a>$5',
-                $value
-            );
-            return $value;
-        });
-    }
+	/**
+	 * @param string $field
+	 * @return void
+	 */
+	protected function filterShowMoreLinks($field)
+	{
+		add_filter('site-reviews/review/wrap/'.$field, function ($value) {
+			$value = preg_replace(
+				'/(.*)(<span class="glsr-hidden)(.*)(<\/span>)(.*)/s',
+				'$1... <a href="#" class="glsr-read-more" tabindex="-1">'.__('Show more', 'site-reviews').'</a>$5',
+				$value
+			);
+			return $value;
+		});
+	}
 }

plugin/Defaults/DefaultsAbstract.php

Indentation +133 added lines, -133 removed lines

@@ -8,137 +8,137 @@
 
 abstract class DefaultsAbstract
 {
-    /**
-     * @var array
-     */
-    protected $callable = [
-        'defaults', 'filter', 'merge', 'restrict', 'unguarded',
-    ];
-
-    /**
-     * @var array
-     */
-    protected $guarded = [];
-
-    /**
-     * @var array
-     */
-    protected $mapped = [];
-
-    /**
-     * @param string $name
-     * @return void|array
-     */
-    public function __call($name, array $args = [])
-    {
-        if (!method_exists($this, $name) || !in_array($name, $this->callable)) {
-            return;
-        }
-        $args[0] = $this->mapKeys(Arr::get($args, 0, []));
-        $defaults = call_user_func_array([$this, $name], $args);
-        $hookName = (new ReflectionClass($this))->getShortName();
-        $hookName = str_replace('Defaults', '', $hookName);
-        $hookName = Str::dashCase($hookName);
-        return apply_filters('site-reviews/defaults/'.$hookName, $defaults, $name);
-    }
-
-    /**
-     * @return array
-     */
-    abstract protected function defaults();
-
-    /**
-     * @return array
-     */
-    protected function filter(array $values = [])
-    {
-        return $this->normalize($this->merge(array_filter($values)), $values);
-    }
-
-    /**
-     * @return string
-     */
-    protected function filteredJson(array $values = [])
-    {
-        $defaults = $this->flattenArray(
-            array_diff_key($this->defaults(), array_flip($this->guarded))
-        );
-        $values = $this->flattenArray(
-            shortcode_atts($defaults, $values)
-        );
-        $filtered = array_filter(array_diff_assoc($values, $defaults), function ($value) {
-            return !$this->isEmpty($value);
-        });
-        return json_encode($filtered, JSON_HEX_APOS | JSON_HEX_QUOT | JSON_HEX_TAG | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
-    }
-
-    /**
-     * @return array
-     */
-    protected function flattenArray(array $values)
-    {
-        array_walk($values, function (&$value) {
-            if (!is_array($value)) {
-                return;
-            }
-            $value = implode(',', $value);
-        });
-        return $values;
-    }
-
-    /**
-     * @param mixed $var
-     * @return bool
-     */
-    protected function isEmpty($var)
-    {
-        return !is_numeric($var) && !is_bool($var) && empty($var);
-    }
-
-    /**
-     * @return array
-     */
-    protected function mapKeys(array $args)
-    {
-        foreach ($this->mapped as $old => $new) {
-            if (array_key_exists($old, $args)) {
-                $args[$new] = $args[$old];
-                unset($args[$old]);
-            }
-        }
-        return $args;
-    }
-
-    /**
-     * @return array
-     */
-    protected function merge(array $values = [])
-    {
-        return $this->normalize(wp_parse_args($values, $this->defaults()), $values);
-    }
-
-    /**
-     * @return array
-     */
-    protected function normalize(array $values, array $originalValues)
-    {
-        $values['json'] = $this->filteredJson($originalValues);
-        return $values;
-    }
-
-    /**
-     * @return array
-     */
-    protected function restrict(array $values = [])
-    {
-        return $this->normalize(shortcode_atts($this->defaults(), $values), $values);
-    }
-
-    /**
-     * @return array
-     */
-    protected function unguarded()
-    {
-        return array_diff_key($this->defaults(), array_flip($this->guarded));
-    }
+	/**
+	 * @var array
+	 */
+	protected $callable = [
+		'defaults', 'filter', 'merge', 'restrict', 'unguarded',
+	];
+
+	/**
+	 * @var array
+	 */
+	protected $guarded = [];
+
+	/**
+	 * @var array
+	 */
+	protected $mapped = [];
+
+	/**
+	 * @param string $name
+	 * @return void|array
+	 */
+	public function __call($name, array $args = [])
+	{
+		if (!method_exists($this, $name) || !in_array($name, $this->callable)) {
+			return;
+		}
+		$args[0] = $this->mapKeys(Arr::get($args, 0, []));
+		$defaults = call_user_func_array([$this, $name], $args);
+		$hookName = (new ReflectionClass($this))->getShortName();
+		$hookName = str_replace('Defaults', '', $hookName);
+		$hookName = Str::dashCase($hookName);
+		return apply_filters('site-reviews/defaults/'.$hookName, $defaults, $name);
+	}
+
+	/**
+	 * @return array
+	 */
+	abstract protected function defaults();
+
+	/**
+	 * @return array
+	 */
+	protected function filter(array $values = [])
+	{
+		return $this->normalize($this->merge(array_filter($values)), $values);
+	}
+
+	/**
+	 * @return string
+	 */
+	protected function filteredJson(array $values = [])
+	{
+		$defaults = $this->flattenArray(
+			array_diff_key($this->defaults(), array_flip($this->guarded))
+		);
+		$values = $this->flattenArray(
+			shortcode_atts($defaults, $values)
+		);
+		$filtered = array_filter(array_diff_assoc($values, $defaults), function ($value) {
+			return !$this->isEmpty($value);
+		});
+		return json_encode($filtered, JSON_HEX_APOS | JSON_HEX_QUOT | JSON_HEX_TAG | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
+	}
+
+	/**
+	 * @return array
+	 */
+	protected function flattenArray(array $values)
+	{
+		array_walk($values, function (&$value) {
+			if (!is_array($value)) {
+				return;
+			}
+			$value = implode(',', $value);
+		});
+		return $values;
+	}
+
+	/**
+	 * @param mixed $var
+	 * @return bool
+	 */
+	protected function isEmpty($var)
+	{
+		return !is_numeric($var) && !is_bool($var) && empty($var);
+	}
+
+	/**
+	 * @return array
+	 */
+	protected function mapKeys(array $args)
+	{
+		foreach ($this->mapped as $old => $new) {
+			if (array_key_exists($old, $args)) {
+				$args[$new] = $args[$old];
+				unset($args[$old]);
+			}
+		}
+		return $args;
+	}
+
+	/**
+	 * @return array
+	 */
+	protected function merge(array $values = [])
+	{
+		return $this->normalize(wp_parse_args($values, $this->defaults()), $values);
+	}
+
+	/**
+	 * @return array
+	 */
+	protected function normalize(array $values, array $originalValues)
+	{
+		$values['json'] = $this->filteredJson($originalValues);
+		return $values;
+	}
+
+	/**
+	 * @return array
+	 */
+	protected function restrict(array $values = [])
+	{
+		return $this->normalize(shortcode_atts($this->defaults(), $values), $values);
+	}
+
+	/**
+	 * @return array
+	 */
+	protected function unguarded()
+	{
+		return array_diff_key($this->defaults(), array_flip($this->guarded));
+	}
 }

plugin/Controllers/TranslationController.php

Indentation +224 added lines, -224 removed lines

@@ -10,228 +10,228 @@
 
 class TranslationController
 {
-    /**
-     * @var Translator
-     */
-    public $translator;
-
-    public function __construct(Translator $translator)
-    {
-        $this->translator = $translator;
-    }
-
-    /**
-     * @param array $messages
-     * @return array
-     * @filter bulk_post_updated_messages
-     */
-    public function filterBulkUpdateMessages($messages, array $counts)
-    {
-        $messages = Arr::consolidateArray($messages);
-        $messages[Application::POST_TYPE] = [
-            'updated' => _n('%s review updated.', '%s reviews updated.', $counts['updated'], 'site-reviews'),
-            'locked' => _n('%s review not updated, somebody is editing it.', '%s reviews not updated, somebody is editing them.', $counts['locked'], 'site-reviews'),
-            'deleted' => _n('%s review permanently deleted.', '%s reviews permanently deleted.', $counts['deleted'], 'site-reviews'),
-            'trashed' => _n('%s review moved to the Trash.', '%s reviews moved to the Trash.', $counts['trashed'], 'site-reviews'),
-            'untrashed' => _n('%s review restored from the Trash.', '%s reviews restored from the Trash.', $counts['untrashed'], 'site-reviews'),
-        ];
-        return $messages;
-    }
-
-    /**
-     * @param string $translation
-     * @param string $text
-     * @param string $domain
-     * @return string
-     * @filter gettext
-     */
-    public function filterGettext($translation, $text, $domain)
-    {
-        return apply_filters('site-reviews/gettext/'.$domain, $translation, $text);
-    }
-
-    /**
-     * @param string $translation
-     * @param string $text
-     * @return string
-     * @filter site-reviews/gettext/site-reviews
-     */
-    public function filterGettextSiteReviews($translation, $text)
-    {
-        return $this->translator->translate($translation, Application::ID, [
-            'single' => $text,
-        ]);
-    }
-
-    /**
-     * @param string $translation
-     * @param string $text
-     * @param string $context
-     * @param string $domain
-     * @return string
-     * @filter gettext_with_context
-     */
-    public function filterGettextWithContext($translation, $text, $context, $domain)
-    {
-        return apply_filters('site-reviews/gettext_with_context/'.$domain, $translation, $text, $context);
-    }
-
-    /**
-     * @param string $translation
-     * @param string $text
-     * @param string $context
-     * @return string
-     * @filter site-reviews/gettext_with_context/site-reviews
-     */
-    public function filterGettextWithContextSiteReviews($translation, $text, $context)
-    {
-        return $this->translator->translate($translation, Application::ID, [
-            'context' => $context,
-            'single' => $text,
-        ]);
-    }
-
-    /**
-     * @param string $translation
-     * @param string $single
-     * @param string $plural
-     * @param int $number
-     * @param string $domain
-     * @return string
-     * @filter ngettext
-     */
-    public function filterNgettext($translation, $single, $plural, $number, $domain)
-    {
-        return apply_filters('site-reviews/ngettext/'.$domain, $translation, $single, $plural, $number);
-    }
-
-    /**
-     * @param string $translation
-     * @param string $single
-     * @param string $plural
-     * @param int $number
-     * @return string
-     * @filter site-reviews/ngettext/site-reviews
-     */
-    public function filterNgettextSiteReviews($translation, $single, $plural, $number)
-    {
-        return $this->translator->translate($translation, Application::ID, [
-            'number' => $number,
-            'plural' => $plural,
-            'single' => $single,
-        ]);
-    }
-
-    /**
-     * @param string $translation
-     * @param string $single
-     * @param string $plural
-     * @param int $number
-     * @param string $context
-     * @param string $domain
-     * @return string
-     * @filter ngettext_with_context
-     */
-    public function filterNgettextWithContext($translation, $single, $plural, $number, $context, $domain)
-    {
-        return apply_filters('site-reviews/ngettext_with_context/'.$domain, $translation, $single, $plural, $number, $context);
-    }
-
-    /**
-     * @param string $translation
-     * @param string $single
-     * @param string $plural
-     * @param int $number
-     * @param string $context
-     * @return string
-     * @filter site-reviews/ngettext_with_context/site-reviews
-     */
-    public function filterNgettextWithContextSiteReviews($translation, $single, $plural, $number, $context)
-    {
-        return $this->translator->translate($translation, Application::ID, [
-            'context' => $context,
-            'number' => $number,
-            'plural' => $plural,
-            'single' => $single,
-        ]);
-    }
-
-    /**
-     * @param array $postStates
-     * @param \WP_Post $post
-     * @return array
-     * @filter display_post_states
-     */
-    public function filterPostStates($postStates, $post)
-    {
-        $postStates = Arr::consolidateArray($postStates);
-        if (Application::POST_TYPE == Arr::get($post, 'post_type') && array_key_exists('pending', $postStates)) {
-            $postStates['pending'] = __('Unapproved', 'site-reviews');
-        }
-        return $postStates;
-    }
-
-    /**
-     * @param string $translation
-     * @param string $text
-     * @return string
-     * @filter site-reviews/gettext/default
-     * @filter site-reviews/gettext_with_context/default
-     */
-    public function filterPostStatusLabels($translation, $text)
-    {
-        return $this->canModifyTranslation()
-            ? glsr(Labels::class)->filterPostStatusLabels($translation, $text)
-            : $translation;
-    }
-
-    /**
-     * @param string $translation
-     * @param string $single
-     * @param string $plural
-     * @param int $number
-     * @return string
-     * @filter site-reviews/ngettext/default
-     */
-    public function filterPostStatusText($translation, $single, $plural, $number)
-    {
-        if ($this->canModifyTranslation()) {
-            $strings = [
-                'Published' => __('Approved', 'site-reviews'),
-                'Pending' => __('Unapproved', 'site-reviews'),
-            ];
-            foreach ($strings as $search => $replace) {
-                if (!Str::contains($single, $search)) {
-                    continue;
-                }
-                return $this->translator->getTranslation([
-                    'number' => $number,
-                    'plural' => str_replace($search, $replace, $plural),
-                    'single' => str_replace($search, $replace, $single),
-                ]);
-            }
-        }
-        return $translation;
-    }
-
-    /**
-     * @return void
-     * @action admin_enqueue_scripts
-     */
-    public function translatePostStatusLabels()
-    {
-        if ($this->canModifyTranslation()) {
-            glsr(Labels::class)->translatePostStatusLabels();
-        }
-    }
-
-    /**
-     * @return bool
-     */
-    protected function canModifyTranslation()
-    {
-        $screen = glsr_current_screen();
-        return Application::POST_TYPE == $screen->post_type 
-            && in_array($screen->base, ['edit', 'post']);
-    }
+	/**
+	 * @var Translator
+	 */
+	public $translator;
+
+	public function __construct(Translator $translator)
+	{
+		$this->translator = $translator;
+	}
+
+	/**
+	 * @param array $messages
+	 * @return array
+	 * @filter bulk_post_updated_messages
+	 */
+	public function filterBulkUpdateMessages($messages, array $counts)
+	{
+		$messages = Arr::consolidateArray($messages);
+		$messages[Application::POST_TYPE] = [
+			'updated' => _n('%s review updated.', '%s reviews updated.', $counts['updated'], 'site-reviews'),
+			'locked' => _n('%s review not updated, somebody is editing it.', '%s reviews not updated, somebody is editing them.', $counts['locked'], 'site-reviews'),
+			'deleted' => _n('%s review permanently deleted.', '%s reviews permanently deleted.', $counts['deleted'], 'site-reviews'),
+			'trashed' => _n('%s review moved to the Trash.', '%s reviews moved to the Trash.', $counts['trashed'], 'site-reviews'),
+			'untrashed' => _n('%s review restored from the Trash.', '%s reviews restored from the Trash.', $counts['untrashed'], 'site-reviews'),
+		];
+		return $messages;
+	}
+
+	/**
+	 * @param string $translation
+	 * @param string $text
+	 * @param string $domain
+	 * @return string
+	 * @filter gettext
+	 */
+	public function filterGettext($translation, $text, $domain)
+	{
+		return apply_filters('site-reviews/gettext/'.$domain, $translation, $text);
+	}
+
+	/**
+	 * @param string $translation
+	 * @param string $text
+	 * @return string
+	 * @filter site-reviews/gettext/site-reviews
+	 */
+	public function filterGettextSiteReviews($translation, $text)
+	{
+		return $this->translator->translate($translation, Application::ID, [
+			'single' => $text,
+		]);
+	}
+
+	/**
+	 * @param string $translation
+	 * @param string $text
+	 * @param string $context
+	 * @param string $domain
+	 * @return string
+	 * @filter gettext_with_context
+	 */
+	public function filterGettextWithContext($translation, $text, $context, $domain)
+	{
+		return apply_filters('site-reviews/gettext_with_context/'.$domain, $translation, $text, $context);
+	}
+
+	/**
+	 * @param string $translation
+	 * @param string $text
+	 * @param string $context
+	 * @return string
+	 * @filter site-reviews/gettext_with_context/site-reviews
+	 */
+	public function filterGettextWithContextSiteReviews($translation, $text, $context)
+	{
+		return $this->translator->translate($translation, Application::ID, [
+			'context' => $context,
+			'single' => $text,
+		]);
+	}
+
+	/**
+	 * @param string $translation
+	 * @param string $single
+	 * @param string $plural
+	 * @param int $number
+	 * @param string $domain
+	 * @return string
+	 * @filter ngettext
+	 */
+	public function filterNgettext($translation, $single, $plural, $number, $domain)
+	{
+		return apply_filters('site-reviews/ngettext/'.$domain, $translation, $single, $plural, $number);
+	}
+
+	/**
+	 * @param string $translation
+	 * @param string $single
+	 * @param string $plural
+	 * @param int $number
+	 * @return string
+	 * @filter site-reviews/ngettext/site-reviews
+	 */
+	public function filterNgettextSiteReviews($translation, $single, $plural, $number)
+	{
+		return $this->translator->translate($translation, Application::ID, [
+			'number' => $number,
+			'plural' => $plural,
+			'single' => $single,
+		]);
+	}
+
+	/**
+	 * @param string $translation
+	 * @param string $single
+	 * @param string $plural
+	 * @param int $number
+	 * @param string $context
+	 * @param string $domain
+	 * @return string
+	 * @filter ngettext_with_context
+	 */
+	public function filterNgettextWithContext($translation, $single, $plural, $number, $context, $domain)
+	{
+		return apply_filters('site-reviews/ngettext_with_context/'.$domain, $translation, $single, $plural, $number, $context);
+	}
+
+	/**
+	 * @param string $translation
+	 * @param string $single
+	 * @param string $plural
+	 * @param int $number
+	 * @param string $context
+	 * @return string
+	 * @filter site-reviews/ngettext_with_context/site-reviews
+	 */
+	public function filterNgettextWithContextSiteReviews($translation, $single, $plural, $number, $context)
+	{
+		return $this->translator->translate($translation, Application::ID, [
+			'context' => $context,
+			'number' => $number,
+			'plural' => $plural,
+			'single' => $single,
+		]);
+	}
+
+	/**
+	 * @param array $postStates
+	 * @param \WP_Post $post
+	 * @return array
+	 * @filter display_post_states
+	 */
+	public function filterPostStates($postStates, $post)
+	{
+		$postStates = Arr::consolidateArray($postStates);
+		if (Application::POST_TYPE == Arr::get($post, 'post_type') && array_key_exists('pending', $postStates)) {
+			$postStates['pending'] = __('Unapproved', 'site-reviews');
+		}
+		return $postStates;
+	}
+
+	/**
+	 * @param string $translation
+	 * @param string $text
+	 * @return string
+	 * @filter site-reviews/gettext/default
+	 * @filter site-reviews/gettext_with_context/default
+	 */
+	public function filterPostStatusLabels($translation, $text)
+	{
+		return $this->canModifyTranslation()
+			? glsr(Labels::class)->filterPostStatusLabels($translation, $text)
+			: $translation;
+	}
+
+	/**
+	 * @param string $translation
+	 * @param string $single
+	 * @param string $plural
+	 * @param int $number
+	 * @return string
+	 * @filter site-reviews/ngettext/default
+	 */
+	public function filterPostStatusText($translation, $single, $plural, $number)
+	{
+		if ($this->canModifyTranslation()) {
+			$strings = [
+				'Published' => __('Approved', 'site-reviews'),
+				'Pending' => __('Unapproved', 'site-reviews'),
+			];
+			foreach ($strings as $search => $replace) {
+				if (!Str::contains($single, $search)) {
+					continue;
+				}
+				return $this->translator->getTranslation([
+					'number' => $number,
+					'plural' => str_replace($search, $replace, $plural),
+					'single' => str_replace($search, $replace, $single),
+				]);
+			}
+		}
+		return $translation;
+	}
+
+	/**
+	 * @return void
+	 * @action admin_enqueue_scripts
+	 */
+	public function translatePostStatusLabels()
+	{
+		if ($this->canModifyTranslation()) {
+			glsr(Labels::class)->translatePostStatusLabels();
+		}
+	}
+
+	/**
+	 * @return bool
+	 */
+	protected function canModifyTranslation()
+	{
+		$screen = glsr_current_screen();
+		return Application::POST_TYPE == $screen->post_type 
+			&& in_array($screen->base, ['edit', 'post']);
+	}
 }

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