pryley / site-reviews

plugin/Modules/Html/Partials/SiteReviewsSummary.php

Indentation +187 added lines, -187 removed lines

@@ -10,191 +10,191 @@
 
 class SiteReviewsSummary
 {
-    /**
-     * @var array
-     */
-    protected $args;
-
-    /**
-     * @var float
-     */
-    protected $averageRating;
-
-    /**
-     * @var array
-     */
-    protected $ratingCounts;
-
-    /**
-     * @return void|string
-     */
-    public function build(array $args = [])
-    {
-        $this->args = $args;
-        $this->ratingCounts = glsr(ReviewManager::class)->getRatingCounts($args);
-        if (!array_sum($this->ratingCounts) && $this->isHidden('if_empty')) {
-            return;
-        }
-        $this->averageRating = glsr(Rating::class)->getAverage($this->ratingCounts);
-        $this->generateSchema();
-        return glsr(Template::class)->build('templates/reviews-summary', [
-            'context' => [
-                'assigned_to' => $this->args['assigned_to'],
-                'category' => $this->args['category'],
-                'class' => $this->getClass(),
-                'id' => $this->args['id'],
-                'percentages' => $this->buildPercentage(),
-                'rating' => $this->buildRating(),
-                'stars' => $this->buildStars(),
-                'text' => $this->buildText(),
-            ],
-        ]);
-    }
-
-    /**
-     * @return void|string
-     */
-    protected function buildPercentage()
-    {
-        if ($this->isHidden('bars')) {
-            return;
-        }
-        $percentages = preg_filter('/$/', '%', glsr(Rating::class)->getPercentages($this->ratingCounts));
-        $bars = array_reduce(range(glsr()->constant('MAX_RATING', Rating::class), 1), function ($carry, $level) use ($percentages) {
-            $label = $this->buildPercentageLabel($this->args['labels'][$level]);
-            $background = $this->buildPercentageBackground($percentages[$level]);
-            $count = apply_filters('site-reviews/summary/counts',
-                $percentages[$level],
-                $this->ratingCounts[$level]
-            );
-            $percent = $this->buildPercentageCount($count);
-            return $carry.glsr(Builder::class)->div($label.$background.$percent, [
-                'class' => 'glsr-bar',
-            ]);
-        });
-        return $this->wrap('percentage', $bars);
-    }
-
-    /**
-     * @param string $percent
-     * @return string
-     */
-    protected function buildPercentageBackground($percent)
-    {
-        $backgroundPercent = glsr(Builder::class)->span([
-            'class' => 'glsr-bar-background-percent',
-            'style' => 'width:'.$percent,
-        ]);
-        return '<span class="glsr-bar-background">'.$backgroundPercent.'</span>';
-    }
-
-    /**
-     * @param string $count
-     * @return string
-     */
-    protected function buildPercentageCount($count)
-    {
-        return '<span class="glsr-bar-percent">'.$count.'</span>';
-    }
-
-    /**
-     * @param string $label
-     * @return string
-     */
-    protected function buildPercentageLabel($label)
-    {
-        return '<span class="glsr-bar-label">'.$label.'</span>';
-    }
-
-    /**
-     * @return void|string
-     */
-    protected function buildRating()
-    {
-        if ($this->isHidden('rating')) {
-            return;
-        }
-        return $this->wrap('rating', '<span>'.$this->averageRating.'</span>');
-    }
-
-    /**
-     * @return void|string
-     */
-    protected function buildStars()
-    {
-        if ($this->isHidden('stars')) {
-            return;
-        }
-        $stars = glsr_star_rating($this->averageRating);
-        return $this->wrap('stars', $stars);
-    }
-
-    /**
-     * @return void|string
-     */
-    protected function buildText()
-    {
-        if ($this->isHidden('summary')) {
-            return;
-        }
-        $count = intval(array_sum($this->ratingCounts));
-        if (empty($this->args['text'])) {
-            // @todo document this change
-            $this->args['text'] = _nx(
-                '{rating} out of {max} stars (based on {num} review)',
-                '{rating} out of {max} stars (based on {num} reviews)',
-                $count,
-                'Do not translate {rating}, {max}, and {num}, they are template tags.',
-                'site-reviews'
-            );
-        }
-        $summary = str_replace(
-            ['{rating}', '{max}', '{num}'],
-            [$this->averageRating, glsr()->constant('MAX_RATING', Rating::class), $count],
-            $this->args['text']
-        );
-        return $this->wrap('text', '<span>'.$summary.'</span>');
-    }
-
-    /**
-     * @return void
-     */
-    protected function generateSchema()
-    {
-        if (!wp_validate_boolean($this->args['schema'])) {
-            return;
-        }
-        glsr(Schema::class)->store(
-            glsr(Schema::class)->buildSummary($this->args)
-        );
-    }
-
-    /**
-     * @return string
-     */
-    protected function getClass()
-    {
-        return trim('glsr-summary glsr-default '.$this->args['class']);
-    }
-
-    /**
-     * @param string $key
-     * @return bool
-     */
-    protected function isHidden($key)
-    {
-        return in_array($key, $this->args['hide']);
-    }
-
-    /**
-     * @param string $key
-     * @param string $value
-     * @return string
-     */
-    protected function wrap($key, $value)
-    {
-        return glsr(Builder::class)->div($value, [
-            'class' => 'glsr-summary-'.$key,
-        ]);
-    }
+	/**
+	 * @var array
+	 */
+	protected $args;
+
+	/**
+	 * @var float
+	 */
+	protected $averageRating;
+
+	/**
+	 * @var array
+	 */
+	protected $ratingCounts;
+
+	/**
+	 * @return void|string
+	 */
+	public function build(array $args = [])
+	{
+		$this->args = $args;
+		$this->ratingCounts = glsr(ReviewManager::class)->getRatingCounts($args);
+		if (!array_sum($this->ratingCounts) && $this->isHidden('if_empty')) {
+			return;
+		}
+		$this->averageRating = glsr(Rating::class)->getAverage($this->ratingCounts);
+		$this->generateSchema();
+		return glsr(Template::class)->build('templates/reviews-summary', [
+			'context' => [
+				'assigned_to' => $this->args['assigned_to'],
+				'category' => $this->args['category'],
+				'class' => $this->getClass(),
+				'id' => $this->args['id'],
+				'percentages' => $this->buildPercentage(),
+				'rating' => $this->buildRating(),
+				'stars' => $this->buildStars(),
+				'text' => $this->buildText(),
+			],
+		]);
+	}
+
+	/**
+	 * @return void|string
+	 */
+	protected function buildPercentage()
+	{
+		if ($this->isHidden('bars')) {
+			return;
+		}
+		$percentages = preg_filter('/$/', '%', glsr(Rating::class)->getPercentages($this->ratingCounts));
+		$bars = array_reduce(range(glsr()->constant('MAX_RATING', Rating::class), 1), function ($carry, $level) use ($percentages) {
+			$label = $this->buildPercentageLabel($this->args['labels'][$level]);
+			$background = $this->buildPercentageBackground($percentages[$level]);
+			$count = apply_filters('site-reviews/summary/counts',
+				$percentages[$level],
+				$this->ratingCounts[$level]
+			);
+			$percent = $this->buildPercentageCount($count);
+			return $carry.glsr(Builder::class)->div($label.$background.$percent, [
+				'class' => 'glsr-bar',
+			]);
+		});
+		return $this->wrap('percentage', $bars);
+	}
+
+	/**
+	 * @param string $percent
+	 * @return string
+	 */
+	protected function buildPercentageBackground($percent)
+	{
+		$backgroundPercent = glsr(Builder::class)->span([
+			'class' => 'glsr-bar-background-percent',
+			'style' => 'width:'.$percent,
+		]);
+		return '<span class="glsr-bar-background">'.$backgroundPercent.'</span>';
+	}
+
+	/**
+	 * @param string $count
+	 * @return string
+	 */
+	protected function buildPercentageCount($count)
+	{
+		return '<span class="glsr-bar-percent">'.$count.'</span>';
+	}
+
+	/**
+	 * @param string $label
+	 * @return string
+	 */
+	protected function buildPercentageLabel($label)
+	{
+		return '<span class="glsr-bar-label">'.$label.'</span>';
+	}
+
+	/**
+	 * @return void|string
+	 */
+	protected function buildRating()
+	{
+		if ($this->isHidden('rating')) {
+			return;
+		}
+		return $this->wrap('rating', '<span>'.$this->averageRating.'</span>');
+	}
+
+	/**
+	 * @return void|string
+	 */
+	protected function buildStars()
+	{
+		if ($this->isHidden('stars')) {
+			return;
+		}
+		$stars = glsr_star_rating($this->averageRating);
+		return $this->wrap('stars', $stars);
+	}
+
+	/**
+	 * @return void|string
+	 */
+	protected function buildText()
+	{
+		if ($this->isHidden('summary')) {
+			return;
+		}
+		$count = intval(array_sum($this->ratingCounts));
+		if (empty($this->args['text'])) {
+			// @todo document this change
+			$this->args['text'] = _nx(
+				'{rating} out of {max} stars (based on {num} review)',
+				'{rating} out of {max} stars (based on {num} reviews)',
+				$count,
+				'Do not translate {rating}, {max}, and {num}, they are template tags.',
+				'site-reviews'
+			);
+		}
+		$summary = str_replace(
+			['{rating}', '{max}', '{num}'],
+			[$this->averageRating, glsr()->constant('MAX_RATING', Rating::class), $count],
+			$this->args['text']
+		);
+		return $this->wrap('text', '<span>'.$summary.'</span>');
+	}
+
+	/**
+	 * @return void
+	 */
+	protected function generateSchema()
+	{
+		if (!wp_validate_boolean($this->args['schema'])) {
+			return;
+		}
+		glsr(Schema::class)->store(
+			glsr(Schema::class)->buildSummary($this->args)
+		);
+	}
+
+	/**
+	 * @return string
+	 */
+	protected function getClass()
+	{
+		return trim('glsr-summary glsr-default '.$this->args['class']);
+	}
+
+	/**
+	 * @param string $key
+	 * @return bool
+	 */
+	protected function isHidden($key)
+	{
+		return in_array($key, $this->args['hide']);
+	}
+
+	/**
+	 * @param string $key
+	 * @param string $value
+	 * @return string
+	 */
+	protected function wrap($key, $value)
+	{
+		return glsr(Builder::class)->div($value, [
+			'class' => 'glsr-summary-'.$key,
+		]);
+	}
 }

plugin/Modules/Html/Partials/Pagination.php

Indentation +48 added lines, -48 removed lines

@@ -9,55 +9,55 @@
 
 class Pagination implements PartialContract
 {
-    /**
-     * @var array
-     */
-    protected $args;
+	/**
+	 * @var array
+	 */
+	protected $args;
 
-    /**
-     * @return void|string
-     */
-    public function build(array $args = [])
-    {
-        $this->args = $this->normalize($args);
-        if ($this->args['total'] < 2) {
-            return;
-        }
-        return glsr(Template::class)->build('templates/pagination', [
-            'context' => [
-                'links' => apply_filters('site-reviews/paginate_links', $this->buildLinks(), $this->args),
-                'loader' => '<div class="glsr-loader"></div>',
-                'screen_reader_text' => __('Site Reviews navigation', 'site-reviews'),
-            ],
-        ]);
-    }
+	/**
+	 * @return void|string
+	 */
+	public function build(array $args = [])
+	{
+		$this->args = $this->normalize($args);
+		if ($this->args['total'] < 2) {
+			return;
+		}
+		return glsr(Template::class)->build('templates/pagination', [
+			'context' => [
+				'links' => apply_filters('site-reviews/paginate_links', $this->buildLinks(), $this->args),
+				'loader' => '<div class="glsr-loader"></div>',
+				'screen_reader_text' => __('Site Reviews navigation', 'site-reviews'),
+			],
+		]);
+	}
 
-    /**
-     * @return string
-     */
-    protected function buildLinks()
-    {
-        $args = glsr(Style::class)->paginationArgs($this->args);
-        if (is_front_page()) {
-            unset($args['format']);
-        }
-        if ('array' == $args['type']) {
-            $args['type'] = 'plain';
-        }
-        return paginate_links($args);
-    }
+	/**
+	 * @return string
+	 */
+	protected function buildLinks()
+	{
+		$args = glsr(Style::class)->paginationArgs($this->args);
+		if (is_front_page()) {
+			unset($args['format']);
+		}
+		if ('array' == $args['type']) {
+			$args['type'] = 'plain';
+		}
+		return paginate_links($args);
+	}
 
-    /**
-     * @return array
-     */
-    protected function normalize(array $args)
-    {
-        if ($baseUrl = glsr_get($args, 'baseUrl')) {
-            $args['base'] = $baseUrl.'%_%';
-        }
-        return wp_parse_args(array_filter($args), [
-            'current' => glsr(QueryBuilder::class)->getPaged(),
-            'total' => 1,
-        ]);
-    }
+	/**
+	 * @return array
+	 */
+	protected function normalize(array $args)
+	{
+		if ($baseUrl = glsr_get($args, 'baseUrl')) {
+			$args['base'] = $baseUrl.'%_%';
+		}
+		return wp_parse_args(array_filter($args), [
+			'current' => glsr(QueryBuilder::class)->getPaged(),
+			'total' => 1,
+		]);
+	}
 }

plugin/Modules/Html/ReviewHtml.php

Indentation +40 added lines, -40 removed lines

@@ -7,48 +7,48 @@
 
 class ReviewHtml extends ArrayObject
 {
-    /**
-     * @var Review
-     */
-    public $review;
+	/**
+	 * @var Review
+	 */
+	public $review;
 
-    /**
-     * @var array
-     */
-    public $values;
+	/**
+	 * @var array
+	 */
+	public $values;
 
-    public function __construct(Review $review, array $values = [])
-    {
-        $this->review = $review;
-        $this->values = $values;
-        parent::__construct($values, ArrayObject::STD_PROP_LIST | ArrayObject::ARRAY_AS_PROPS);
-    }
+	public function __construct(Review $review, array $values = [])
+	{
+		$this->review = $review;
+		$this->values = $values;
+		parent::__construct($values, ArrayObject::STD_PROP_LIST | ArrayObject::ARRAY_AS_PROPS);
+	}
 
-    /**
-     * @return string|void
-     */
-    public function __toString()
-    {
-        if (empty($this->values)) {
-            return;
-        }
-        return glsr(Template::class)->build('templates/review', [
-            'context' => $this->values,
-            'review' => $this->review,
-        ]);
-    }
+	/**
+	 * @return string|void
+	 */
+	public function __toString()
+	{
+		if (empty($this->values)) {
+			return;
+		}
+		return glsr(Template::class)->build('templates/review', [
+			'context' => $this->values,
+			'review' => $this->review,
+		]);
+	}
 
-    /**
-     * @param mixed $key
-     * @return mixed
-     */
-    public function offsetGet($key)
-    {
-        if (property_exists($this, $key)) {
-            return $this->{$key};
-        }
-        return array_key_exists($key, $this->values)
-            ? $this->values[$key]
-            : null;
-    }
+	/**
+	 * @param mixed $key
+	 * @return mixed
+	 */
+	public function offsetGet($key)
+	{
+		if (property_exists($this, $key)) {
+			return $this->{$key};
+		}
+		return array_key_exists($key, $this->values)
+			? $this->values[$key]
+			: null;
+	}
 }

plugin/Modules/Html/Field.php

Indentation +233 added lines, -233 removed lines

@@ -8,237 +8,237 @@
 
 class Field
 {
-    /**
-     * @var array
-     */
-    public $field;
-
-    public function __construct(array $field = [])
-    {
-        $this->field = wp_parse_args($field, [
-            'errors' => false,
-            'is_hidden' => false,
-            'is_multi' => false,
-            'is_public' => false,
-            'is_raw' => false,
-            'is_setting' => false,
-            'is_valid' => true,
-            'is_widget' => false,
-            'path' => '',
-        ]);
-        $this->normalize();
-    }
-
-    /**
-     * @return string
-     */
-    public function __toString()
-    {
-        return (string) $this->build();
-    }
-
-    /**
-     * @return void|string
-     */
-    public function build()
-    {
-        if (!$this->field['is_valid']) {
-            return;
-        }
-        if ($this->field['is_raw']) {
-            return glsr(Builder::class)->{$this->field['type']}($this->field);
-        }
-        if (!$this->field['is_setting']) {
-            return $this->buildField();
-        }
-        if (!$this->field['is_multi']) {
-            return $this->buildSettingField();
-        }
-        return $this->buildSettingMultiField();
-    }
-
-    /**
-     * @return void
-     */
-    public function render()
-    {
-        echo $this->build();
-    }
-
-    /**
-     * @return string
-     */
-    protected function buildField()
-    {
-        $field = glsr(Template::class)->build('templates/form/field_'.$this->field['type'], [
-            'context' => [
-                'class' => $this->getFieldClass(),
-                'errors' => $this->getFieldErrors(),
-                'field' => glsr(Builder::class)->raw($this->field),
-                'label' => glsr(Builder::class)->label([
-                    'class' => 'glsr-'.$this->field['type'].'-label',
-                    'for' => $this->field['id'],
-                    'is_public' => $this->field['is_public'],
-                    'text' => $this->field['label'].'<span></span>',
-                    'type' => $this->field['type'],
-                ]),
-            ],
-        ]);
-        return apply_filters('site-reviews/rendered/field', $field, $this->field['type'], $this->field);
-    }
-
-    /**
-     * @return string
-     */
-    protected function buildSettingField()
-    {
-        return glsr(Template::class)->build('partials/form/table-row', [
-            'context' => [
-                'class' => $this->getFieldClass(),
-                'field' => glsr(Builder::class)->{$this->field['type']}($this->field),
-                'label' => glsr(Builder::class)->label($this->field['legend'], ['for' => $this->field['id']]),
-            ],
-        ]);
-    }
-
-    /**
-     * @return string
-     */
-    protected function buildSettingMultiField()
-    {
-        $dependsOn = $this->getFieldDependsOn();
-        unset($this->field['data-depends']);
-        return glsr(Template::class)->build('partials/form/table-row-multiple', [
-            'context' => [
-                'class' => $this->getFieldClass(),
-                'depends_on' => $dependsOn,
-                'field' => glsr(Builder::class)->{$this->field['type']}($this->field),
-                'label' => glsr(Builder::class)->label($this->field['legend'], ['for' => $this->field['id']]),
-                'legend' => $this->field['legend'],
-            ],
-        ]);
-    }
-
-    /**
-     * @return string
-     */
-    protected function getFieldClass()
-    {
-        $classes = [];
-        if (!empty($this->field['errors'])) {
-            $classes[] = 'glsr-has-error';
-        }
-        if ($this->field['is_hidden']) {
-            $classes[] = 'hidden';
-        }
-        if (!empty($this->field['required'])) {
-            $classes[] = 'glsr-required';
-        }
-        $classes = apply_filters('site-reviews/rendered/field/classes', $classes, $this->field);
-        return implode(' ', $classes);
-    }
-
-    /**
-     * @return string
-     */
-    protected function getFieldDependsOn()
-    {
-        return !empty($this->field['data-depends'])
-            ? $this->field['data-depends']
-            : '';
-    }
-
-    /**
-     * @return void|string
-     */
-    protected function getFieldErrors()
-    {
-        if (empty($this->field['errors']) || !is_array($this->field['errors'])) {
-            return;
-        }
-        $errors = array_reduce($this->field['errors'], function ($carry, $error) {
-            return $carry.glsr(Builder::class)->span($error, ['class' => 'glsr-field-error']);
-        });
-        return glsr(Template::class)->build('templates/form/field-errors', [
-            'context' => [
-                'errors' => $errors,
-            ],
-        ]);
-    }
-
-    /**
-     * @return string
-     */
-    protected function getFieldPrefix()
-    {
-        return $this->field['is_setting']
-            ? OptionManager::databaseKey()
-            : Application::ID;
-    }
-
-    /**
-     * @return bool
-     */
-    protected function isFieldValid()
-    {
-        $missingValues = [];
-        $requiredValues = [
-            'name', 'type',
-        ];
-        foreach ($requiredValues as $value) {
-            if (isset($this->field[$value])) {
-                continue;
-            }
-            $missingValues[] = $value;
-            $this->field['is_valid'] = false;
-        }
-        if (!empty($missingValues)) {
-            glsr_log()
-                ->warning('Field is missing: '.implode(', ', $missingValues))
-                ->debug($this->field);
-        }
-        return $this->field['is_valid'];
-    }
-
-    /**
-     * @return void
-     */
-    protected function normalize()
-    {
-        if (!$this->isFieldValid()) {
-            return;
-        }
-        $this->field['path'] = $this->field['name'];
-        $className = glsr(Helper::class)->buildClassName($this->field['type'], __NAMESPACE__.'\Fields');
-        if (class_exists($className)) {
-            $this->field = $className::merge($this->field);
-        }
-        $this->normalizeFieldId();
-        $this->normalizeFieldName();
-    }
-
-    /**
-     * @return void
-     */
-    protected function normalizeFieldId()
-    {
-        if (isset($this->field['id']) || $this->field['is_raw']) {
-            return;
-        }
-        $this->field['id'] = glsr(Helper::class)->convertPathToId(
-            $this->field['path'],
-            $this->getFieldPrefix()
-        );
-    }
-
-    /**
-     * @return void
-     */
-    protected function normalizeFieldName()
-    {
-        $this->field['name'] = glsr(Helper::class)->convertPathToName(
-            $this->field['path'],
-            $this->getFieldPrefix()
-        );
-    }
+	/**
+	 * @var array
+	 */
+	public $field;
+
+	public function __construct(array $field = [])
+	{
+		$this->field = wp_parse_args($field, [
+			'errors' => false,
+			'is_hidden' => false,
+			'is_multi' => false,
+			'is_public' => false,
+			'is_raw' => false,
+			'is_setting' => false,
+			'is_valid' => true,
+			'is_widget' => false,
+			'path' => '',
+		]);
+		$this->normalize();
+	}
+
+	/**
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return (string) $this->build();
+	}
+
+	/**
+	 * @return void|string
+	 */
+	public function build()
+	{
+		if (!$this->field['is_valid']) {
+			return;
+		}
+		if ($this->field['is_raw']) {
+			return glsr(Builder::class)->{$this->field['type']}($this->field);
+		}
+		if (!$this->field['is_setting']) {
+			return $this->buildField();
+		}
+		if (!$this->field['is_multi']) {
+			return $this->buildSettingField();
+		}
+		return $this->buildSettingMultiField();
+	}
+
+	/**
+	 * @return void
+	 */
+	public function render()
+	{
+		echo $this->build();
+	}
+
+	/**
+	 * @return string
+	 */
+	protected function buildField()
+	{
+		$field = glsr(Template::class)->build('templates/form/field_'.$this->field['type'], [
+			'context' => [
+				'class' => $this->getFieldClass(),
+				'errors' => $this->getFieldErrors(),
+				'field' => glsr(Builder::class)->raw($this->field),
+				'label' => glsr(Builder::class)->label([
+					'class' => 'glsr-'.$this->field['type'].'-label',
+					'for' => $this->field['id'],
+					'is_public' => $this->field['is_public'],
+					'text' => $this->field['label'].'<span></span>',
+					'type' => $this->field['type'],
+				]),
+			],
+		]);
+		return apply_filters('site-reviews/rendered/field', $field, $this->field['type'], $this->field);
+	}
+
+	/**
+	 * @return string
+	 */
+	protected function buildSettingField()
+	{
+		return glsr(Template::class)->build('partials/form/table-row', [
+			'context' => [
+				'class' => $this->getFieldClass(),
+				'field' => glsr(Builder::class)->{$this->field['type']}($this->field),
+				'label' => glsr(Builder::class)->label($this->field['legend'], ['for' => $this->field['id']]),
+			],
+		]);
+	}
+
+	/**
+	 * @return string
+	 */
+	protected function buildSettingMultiField()
+	{
+		$dependsOn = $this->getFieldDependsOn();
+		unset($this->field['data-depends']);
+		return glsr(Template::class)->build('partials/form/table-row-multiple', [
+			'context' => [
+				'class' => $this->getFieldClass(),
+				'depends_on' => $dependsOn,
+				'field' => glsr(Builder::class)->{$this->field['type']}($this->field),
+				'label' => glsr(Builder::class)->label($this->field['legend'], ['for' => $this->field['id']]),
+				'legend' => $this->field['legend'],
+			],
+		]);
+	}
+
+	/**
+	 * @return string
+	 */
+	protected function getFieldClass()
+	{
+		$classes = [];
+		if (!empty($this->field['errors'])) {
+			$classes[] = 'glsr-has-error';
+		}
+		if ($this->field['is_hidden']) {
+			$classes[] = 'hidden';
+		}
+		if (!empty($this->field['required'])) {
+			$classes[] = 'glsr-required';
+		}
+		$classes = apply_filters('site-reviews/rendered/field/classes', $classes, $this->field);
+		return implode(' ', $classes);
+	}
+
+	/**
+	 * @return string
+	 */
+	protected function getFieldDependsOn()
+	{
+		return !empty($this->field['data-depends'])
+			? $this->field['data-depends']
+			: '';
+	}
+
+	/**
+	 * @return void|string
+	 */
+	protected function getFieldErrors()
+	{
+		if (empty($this->field['errors']) || !is_array($this->field['errors'])) {
+			return;
+		}
+		$errors = array_reduce($this->field['errors'], function ($carry, $error) {
+			return $carry.glsr(Builder::class)->span($error, ['class' => 'glsr-field-error']);
+		});
+		return glsr(Template::class)->build('templates/form/field-errors', [
+			'context' => [
+				'errors' => $errors,
+			],
+		]);
+	}
+
+	/**
+	 * @return string
+	 */
+	protected function getFieldPrefix()
+	{
+		return $this->field['is_setting']
+			? OptionManager::databaseKey()
+			: Application::ID;
+	}
+
+	/**
+	 * @return bool
+	 */
+	protected function isFieldValid()
+	{
+		$missingValues = [];
+		$requiredValues = [
+			'name', 'type',
+		];
+		foreach ($requiredValues as $value) {
+			if (isset($this->field[$value])) {
+				continue;
+			}
+			$missingValues[] = $value;
+			$this->field['is_valid'] = false;
+		}
+		if (!empty($missingValues)) {
+			glsr_log()
+				->warning('Field is missing: '.implode(', ', $missingValues))
+				->debug($this->field);
+		}
+		return $this->field['is_valid'];
+	}
+
+	/**
+	 * @return void
+	 */
+	protected function normalize()
+	{
+		if (!$this->isFieldValid()) {
+			return;
+		}
+		$this->field['path'] = $this->field['name'];
+		$className = glsr(Helper::class)->buildClassName($this->field['type'], __NAMESPACE__.'\Fields');
+		if (class_exists($className)) {
+			$this->field = $className::merge($this->field);
+		}
+		$this->normalizeFieldId();
+		$this->normalizeFieldName();
+	}
+
+	/**
+	 * @return void
+	 */
+	protected function normalizeFieldId()
+	{
+		if (isset($this->field['id']) || $this->field['is_raw']) {
+			return;
+		}
+		$this->field['id'] = glsr(Helper::class)->convertPathToId(
+			$this->field['path'],
+			$this->getFieldPrefix()
+		);
+	}
+
+	/**
+	 * @return void
+	 */
+	protected function normalizeFieldName()
+	{
+		$this->field['name'] = glsr(Helper::class)->convertPathToName(
+			$this->field['path'],
+			$this->getFieldPrefix()
+		);
+	}
 }

plugin/Modules/Html/Template.php

Indentation +70 added lines, -70 removed lines

@@ -6,78 +6,78 @@
 
 class Template
 {
-    /**
-     * @param string $templatePath
-     * @return void|string
-     */
-    public function build($templatePath, array $data = [])
-    {
-        $data = $this->normalize($data);
-        ob_start();
-        glsr()->render($templatePath, $data);
-        $template = ob_get_clean();
-        $path = glsr(Helper::class)->removePrefix('templates/', $templatePath);
-        $template = apply_filters('site-reviews/build/template/'.$path, $template, $data);
-        $template = $this->interpolate($template, $data['context'], $path);
-        $template = apply_filters('site-reviews/rendered/template', $template, $templatePath, $data);
-        $template = apply_filters('site-reviews/rendered/template/'.$path, $template, $data);
-        return $template;
-    }
+	/**
+	 * @param string $templatePath
+	 * @return void|string
+	 */
+	public function build($templatePath, array $data = [])
+	{
+		$data = $this->normalize($data);
+		ob_start();
+		glsr()->render($templatePath, $data);
+		$template = ob_get_clean();
+		$path = glsr(Helper::class)->removePrefix('templates/', $templatePath);
+		$template = apply_filters('site-reviews/build/template/'.$path, $template, $data);
+		$template = $this->interpolate($template, $data['context'], $path);
+		$template = apply_filters('site-reviews/rendered/template', $template, $templatePath, $data);
+		$template = apply_filters('site-reviews/rendered/template/'.$path, $template, $data);
+		return $template;
+	}
 
-    /**
-     * Interpolate context values into template placeholders.
-     * @param string $template
-     * @param string $templatePath
-     * @return string
-     */
-    public function interpolate($template, array $context = [], $templatePath)
-    {
-        $context = $this->normalizeContext($context);
-        $context = apply_filters('site-reviews/interpolate/'.$templatePath, $context, $template);
-        foreach ($context as $key => $value) {
-            $template = strtr(
-                $template,
-                array_fill_keys(['{'.$key.'}', '{{ '.$key.' }}'], $value)
-            );
-        }
-        return trim($template);
-    }
+	/**
+	 * Interpolate context values into template placeholders.
+	 * @param string $template
+	 * @param string $templatePath
+	 * @return string
+	 */
+	public function interpolate($template, array $context = [], $templatePath)
+	{
+		$context = $this->normalizeContext($context);
+		$context = apply_filters('site-reviews/interpolate/'.$templatePath, $context, $template);
+		foreach ($context as $key => $value) {
+			$template = strtr(
+				$template,
+				array_fill_keys(['{'.$key.'}', '{{ '.$key.' }}'], $value)
+			);
+		}
+		return trim($template);
+	}
 
-    /**
-     * @param string $templatePath
-     * @return void|string
-     */
-    public function render($templatePath, array $data = [])
-    {
-        echo $this->build($templatePath, $data);
-    }
+	/**
+	 * @param string $templatePath
+	 * @return void|string
+	 */
+	public function render($templatePath, array $data = [])
+	{
+		echo $this->build($templatePath, $data);
+	}
 
-    /**
-     * @return array
-     */
-    protected function normalize(array $data)
-    {
-        $arrayKeys = ['context', 'globals'];
-        $data = wp_parse_args($data, array_fill_keys($arrayKeys, []));
-        foreach ($arrayKeys as $key) {
-            if (is_array($data[$key])) {
-                continue;
-            }
-            $data[$key] = [];
-        }
-        return $data;
-    }
+	/**
+	 * @return array
+	 */
+	protected function normalize(array $data)
+	{
+		$arrayKeys = ['context', 'globals'];
+		$data = wp_parse_args($data, array_fill_keys($arrayKeys, []));
+		foreach ($arrayKeys as $key) {
+			if (is_array($data[$key])) {
+				continue;
+			}
+			$data[$key] = [];
+		}
+		return $data;
+	}
 
-    /**
-     * @return array
-     */
-    protected function normalizeContext(array $context)
-    {
-        $context = array_filter($context, function ($value) {
-            return !is_array($value) && !is_object($value);
-        });
-        return array_map(function ($value) {
-            return (string) $value;
-        }, $context);
-    }
+	/**
+	 * @return array
+	 */
+	protected function normalizeContext(array $context)
+	{
+		$context = array_filter($context, function ($value) {
+			return !is_array($value) && !is_object($value);
+		});
+		return array_map(function ($value) {
+			return (string) $value;
+		}, $context);
+	}
 }

plugin/Modules/Style.php

Indentation +128 added lines, -128 removed lines

@@ -11,144 +11,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 glsr(Helper::class)->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 glsr(Helper::class)->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 = glsr_get($this->fields, $key, glsr_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 = glsr_get($this->fields, $key, glsr_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/Modules/Console.php

Indentation +429 added lines, -429 removed lines

@@ -9,433 +9,433 @@
 
 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(glsr_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 = glsr_get($this->getLevels(), $level);
-            $context = glsr(Helper::class)->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 = glsr(Helper::class)->consolidateArray(glsr()->{$this->logOnceKey});
-        $levels = $this->getLevels();
-        foreach ($once as $entry) {
-            $levelName = glsr_get($entry, 'level');
-            if (!in_array($levelName, $levels)) {
-                continue;
-            }
-            $level = glsr_get(array_flip($levels), $levelName);
-            $message = glsr_get($entry, 'message');
-            $backtraceLine = glsr_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 = glsr(Helper::class)->consolidateArray(glsr()->{$this->logOnceKey});
-        $filtered = array_filter($once, function ($entry) use ($levelName, $handle) {
-            return glsr_get($entry, 'level') == $levelName
-                && glsr_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',
-            glsr_get($backtrace, $index.'.file'), // realpath
-            glsr_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 (false === strpos($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('log', glsr_array_column($backtrace, 'function'));
-        if (false !== $search) {
-            $index = '{closure}' == glsr_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(glsr_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 = glsr_get($this->getLevels(), $level);
+			$context = glsr(Helper::class)->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 = glsr(Helper::class)->consolidateArray(glsr()->{$this->logOnceKey});
+		$levels = $this->getLevels();
+		foreach ($once as $entry) {
+			$levelName = glsr_get($entry, 'level');
+			if (!in_array($levelName, $levels)) {
+				continue;
+			}
+			$level = glsr_get(array_flip($levels), $levelName);
+			$message = glsr_get($entry, 'message');
+			$backtraceLine = glsr_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 = glsr(Helper::class)->consolidateArray(glsr()->{$this->logOnceKey});
+		$filtered = array_filter($once, function ($entry) use ($levelName, $handle) {
+			return glsr_get($entry, 'level') == $levelName
+				&& glsr_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',
+			glsr_get($backtrace, $index.'.file'), // realpath
+			glsr_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 (false === strpos($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('log', glsr_array_column($backtrace, 'function'));
+		if (false !== $search) {
+			$index = '{closure}' == glsr_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')
+			)
+		);
+	}
 }

plugin/Modules/Schema/Thing.php

Indentation +8 added lines, -8 removed lines

@@ -19,12 +19,12 @@
  */
 class Thing extends BaseType
 {
-    /**
-     * @var array
-     * @see http://schema.org/{property_name}
-     */
-    public $allowed = [
-        'additionalType', 'alternateName', 'description', 'disambiguatingDescription', 'identifier',
-        'image', 'mainEntityOfPage', 'name', 'potentialAction', 'sameAs', 'url',
-    ];
+	/**
+	 * @var array
+	 * @see http://schema.org/{property_name}
+	 */
+	public $allowed = [
+		'additionalType', 'alternateName', 'description', 'disambiguatingDescription', 'identifier',
+		'image', 'mainEntityOfPage', 'name', 'potentialAction', 'sameAs', 'url',
+	];
 }

plugin/Modules/Schema/UnknownType.php

Indentation +14 added lines, -14 removed lines

@@ -4,19 +4,19 @@
 
 class UnknownType extends BaseType
 {
-    /**
-     * @var array
-     * @see http://schema.org/{property_name}
-     */
-    public $allowed = [
-        'aggregateRating',
-    ];
+	/**
+	 * @var array
+	 * @see http://schema.org/{property_name}
+	 */
+	public $allowed = [
+		'aggregateRating',
+	];
 
-    /**
-     * @var array
-     * @see http://schema.org/{property_name}
-     */
-    public $parents = [
-        'Thing',
-    ];
+	/**
+	 * @var array
+	 * @see http://schema.org/{property_name}
+	 */
+	public $parents = [
+		'Thing',
+	];
 }