Shortcode::normalize() - Code Metrics - Inspection of "backup dump (will rollback after repair)" - pryley/site-reviews - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — develop ( db5b9c...b55dd4 )

by Paul

created 2025-01-24 14:05 UTC

Shortcode::normalize() A

↳ Parent: Shortcode

Complexity

Conditions	4
Paths	6

Size

Total Lines	15
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	6

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	10
c	1
b	0
f	0
dl	0
loc	15
rs	9.9332
ccs	3
cts	6
cp	0.5
cc	4
nc	6
nop	2
crap	6

<?php

namespace GeminiLabs\SiteReviews\Shortcodes;

use GeminiLabs\SiteReviews\Contracts\ShortcodeContract;
use GeminiLabs\SiteReviews\Database\ShortcodeOptionManager;
use GeminiLabs\SiteReviews\Defaults\DefaultsAbstract;
use GeminiLabs\SiteReviews\Helper;
use GeminiLabs\SiteReviews\Helpers\Arr;
use GeminiLabs\SiteReviews\Helpers\Cast;
use GeminiLabs\SiteReviews\Helpers\Str;
use GeminiLabs\SiteReviews\Modules\Html\Builder;
use GeminiLabs\SiteReviews\Modules\Multilingual;
use GeminiLabs\SiteReviews\Modules\Rating;
use GeminiLabs\SiteReviews\Modules\Sanitizer;
use GeminiLabs\SiteReviews\Modules\Style;

abstract class Shortcode implements ShortcodeContract
{
    public array $args;
    public string $debug;
    public string $description;
    public string $from;
    public string $name;
    public string $tag;

    public function __construct()
    {
        $this->args = [];
        $this->debug = '';
        $this->description = $this->description();
        $this->from = '';
        $this->name = $this->name();
        $this->tag = $this->tag();
    }

    public function attributes(array $values, string $from = 'function'): array
    {
        $attributes = $this->defaults()->dataAttributes($values);
        $attributes = wp_parse_args($attributes, [
            'class' => glsr(Style::class)->styleClasses(),
            'data-from' => $from,
            'data-shortcode' => $this->tag,
            'id' => Arr::get($values, 'id'),
        ]);
        unset($attributes['data-id']);
        unset($attributes['data-form_id']);
        $attributes = glsr()->filterArray("shortcode/{$this->tag}/attributes", $attributes, $this);
        $attributes = array_map('esc_attr', $attributes);
        return $attributes;
    }

    public function build($args = [], string $from = 'shortcode'): string
    {
        $this->normalize(wp_parse_args($args), $from);
        $template = $this->buildTemplate();
        $attributes = $this->attributes($this->args, $from);
        $html = glsr(Builder::class)->div($template, $attributes);
        return sprintf('%s%s', $this->debug, $html);
    }

    public function defaults(): DefaultsAbstract
    {
        $classname = str_replace('Shortcodes\\', 'Defaults\\', get_class($this));
        $classname = str_replace('Shortcode', 'Defaults', $classname);
        return glsr($classname);
    }

    public function hasVisibleFields(array $args = []): bool
    {
        if (!empty($args)) {
            $this->normalize($args);
        }
        $defaults = $this->options('hide');
        $hide = $this->args['hide'] ?? [];
        $hide = array_flip(Arr::consolidate($hide));
        unset($defaults['if_empty'], $hide['if_empty']);
        return !empty(array_diff_key($defaults, $hide));
    }

    public function normalize(array $args, string $from = ''): ShortcodeContract
    {
        if (!empty($from)) {
            $this->from = $from;
        }
        $args = glsr()->filterArray('shortcode/args', $args, $this->tag);
        $args = $this->defaults()->unguardedRestrict($args);
        foreach ($args as $key => &$value) {
            $method = Helper::buildMethodName('normalize', $key);
            if (method_exists($this, $method)) {
                $value = call_user_func([$this, $method], $value, $args);
            }
        }
        $this->args = $args;
        return $this;
    }

    /**
     * Returns the options for a shortcode setting. Results are filtered
     * by the "site-reviews/shortcode/options/{$options}" hook.
     */
    public function options(string $option, array $args = []): array
    {
        $args['option'] = $option;
        $args['shortcode'] = $this->tag;
        return call_user_func([glsr(ShortcodeOptionManager::class), $option], $args);
    }

    public function register(): void
    {
        if (!function_exists('add_shortcode')) {
            return;
        }
        $shortcode = (new \ReflectionClass($this))->getShortName();
        $shortcode = Str::snakeCase($shortcode);
        $shortcode = str_replace('_shortcode', '', $shortcode);
        add_shortcode($shortcode, fn ($atts) => $this->build($atts));
        glsr()->append('shortcodes', get_class($this), $shortcode);
    }

    /**
     * Returns the filtered shortcode settings configuration.
     */
    public function settings(): array
    {
        $config = $this->config();
        $config = glsr()->filterArray("shortcode/{$this->tag}/config", $config, $this);
        $config = glsr()->filterArray('shortcode/config', $config, $this->tag, $this);
        return $config;
    }

    public function tag(): string
    {
        return Str::snakeCase(
            str_replace('Shortcode', '', (new \ReflectionClass($this))->getShortName())
        );
    }

    /**
     * Returns the unfiltered shortcode settings configuration.
     */
    abstract protected function config(): array;

    protected function debug(array $data = []): void
    {
        if (empty($this->args['debug']) || 'shortcode' !== $this->from) {
            return;
        }
        $data = wp_parse_args($data, [
            'args' => $this->args,
            'shortcode' => $this->tag,
        ]);
        ksort($data);
        ob_start();
        glsr_debug($data);
        $this->debug = ob_get_clean();
    }

    protected function displayOptions(): array
    {
        return [];
    }

    protected function hideOptions(): array
    {
        return [];
    }

    /**
     * @param string $value
     */
    protected function normalizeAssignedPosts($value): string
    {
        $values = Cast::toArray($value);
        $postTypes = [];
        foreach ($values as $postType) {
            if (!is_numeric($postType) && post_type_exists((string) $postType)) {
                $postTypes[] = $postType;
            }
        }
        $values = glsr(Sanitizer::class)->sanitizePostIds($values);
        $values = glsr(Multilingual::class)->getPostIdsForAllLanguages($values);
        $values = array_merge($values, $postTypes);
        return implode(',', $values);
    }

    /**
     * @param string $value
     */
    protected function normalizeAssignedTerms($value): string
    {
        $values = glsr(Sanitizer::class)->sanitizeTermIds($value);
        $values = glsr(Multilingual::class)->getTermIdsForAllLanguages($values);
        return implode(',', $values);
    }

    /**
     * @param string $value
     */
    protected function normalizeAssignedUsers($value): string
    {
        $values = glsr(Sanitizer::class)->sanitizeUserIds($value);
        return implode(',', $values);
    }

    /**
     * @param string|array $value
     */
    protected function normalizeHide($value): array
    {
        $hideKeys = array_keys($this->options('hide'));
        return array_filter(Cast::toArray($value),
            fn ($value) => in_array($value, $hideKeys)
        );
    }

    /**
     * @param string $value
     */
    protected function normalizeLabels($value): array
    {
        $defaults = [
            __('Excellent', 'site-reviews'),
            __('Very good', 'site-reviews'),
            __('Average', 'site-reviews'),
            __('Poor', 'site-reviews'),
            __('Terrible', 'site-reviews'),
        ];
        $maxRating = Rating::max();
        $defaults = array_pad(array_slice($defaults, 0, $maxRating), $maxRating, '');
        $labels = array_map('trim', explode(',', $value));
        foreach ($defaults as $i => $label) {
            if (!empty($labels[$i])) {
                $defaults[$i] = $labels[$i];
            }
        }
        return array_combine(range($maxRating, 1), $defaults);
    }
}


1		<?php
2
3		namespace GeminiLabs\SiteReviews\Shortcodes;
4
5		use GeminiLabs\SiteReviews\Contracts\ShortcodeContract;
6		use GeminiLabs\SiteReviews\Database\ShortcodeOptionManager;
7		use GeminiLabs\SiteReviews\Defaults\DefaultsAbstract;
8		use GeminiLabs\SiteReviews\Helper;
9		use GeminiLabs\SiteReviews\Helpers\Arr;
10		use GeminiLabs\SiteReviews\Helpers\Cast;
11		use GeminiLabs\SiteReviews\Helpers\Str;
12		use GeminiLabs\SiteReviews\Modules\Html\Builder;
13		use GeminiLabs\SiteReviews\Modules\Multilingual;
14		use GeminiLabs\SiteReviews\Modules\Rating;
15		use GeminiLabs\SiteReviews\Modules\Sanitizer;
16		use GeminiLabs\SiteReviews\Modules\Style;
17
18		abstract class Shortcode implements ShortcodeContract
19		{
20		public array $args;
21		public string $debug;
22		public string $description;
23		public string $from;
24	8	public string $name;
25		public string $tag;
26	8
27		public function __construct()
28		{
29		$this->args = [];
30		$this->debug = '';
31		$this->description = $this->description();
32		$this->from = '';
33		$this->name = $this->name();
34		$this->tag = $this->tag();
35		}
36
37		public function attributes(array $values, string $from = 'function'): array
38		{
39		$attributes = $this->defaults()->dataAttributes($values);
40		$attributes = wp_parse_args($attributes, [
41		'class' => glsr(Style::class)->styleClasses(),
42		'data-from' => $from,
43		'data-shortcode' => $this->tag,
44		'id' => Arr::get($values, 'id'),
45		]);
46		unset($attributes['data-id']);
47		unset($attributes['data-form_id']);
48		$attributes = glsr()->filterArray("shortcode/{$this->tag}/attributes", $attributes, $this);
49		$attributes = array_map('esc_attr', $attributes);
50		return $attributes;
51		}
52
53		public function build($args = [], string $from = 'shortcode'): string
54		{
55		$this->normalize(wp_parse_args($args), $from);
56		$template = $this->buildTemplate();
57		$attributes = $this->attributes($this->args, $from);
58		$html = glsr(Builder::class)->div($template, $attributes);
59		return sprintf('%s%s', $this->debug, $html);
60		}
61
62		public function defaults(): DefaultsAbstract
63		{
64		$classname = str_replace('Shortcodes\\', 'Defaults\\', get_class($this));
65		$classname = str_replace('Shortcode', 'Defaults', $classname);
66		return glsr($classname);
67		}
68
69		public function hasVisibleFields(array $args = []): bool
70		{
71		if (!empty($args)) {
72		$this->normalize($args);
73		}
74		$defaults = $this->options('hide');
75		$hide = $this->args['hide'] ?? [];
76		$hide = array_flip(Arr::consolidate($hide));
77		unset($defaults['if_empty'], $hide['if_empty']);
78		return !empty(array_diff_key($defaults, $hide));
79		}
80
81		public function normalize(array $args, string $from = ''): ShortcodeContract
82		{
83	8	if (!empty($from)) {
84		$this->from = $from;
85	8	}
86	8	$args = glsr()->filterArray('shortcode/args', $args, $this->tag);
87		$args = $this->defaults()->unguardedRestrict($args);
88		foreach ($args as $key => &$value) {
89		$method = Helper::buildMethodName('normalize', $key);
90		if (method_exists($this, $method)) {
91		$value = call_user_func([$this, $method], $value, $args);
92		}
93		}
94		$this->args = $args;
95		return $this;
96		}
97
98		/**
99		* Returns the options for a shortcode setting. Results are filtered
100		* by the "site-reviews/shortcode/options/{$options}" hook.
101		*/
102		public function options(string $option, array $args = []): array
103		{
104		$args['option'] = $option;
105		$args['shortcode'] = $this->tag;
106		return call_user_func([glsr(ShortcodeOptionManager::class), $option], $args);
107		}
108
109		public function register(): void
110		{
111		if (!function_exists('add_shortcode')) {
112		return;
113		}
114		$shortcode = (new \ReflectionClass($this))->getShortName();
115		$shortcode = Str::snakeCase($shortcode);
116		$shortcode = str_replace('_shortcode', '', $shortcode);
117		add_shortcode($shortcode, fn ($atts) => $this->build($atts));
118		glsr()->append('shortcodes', get_class($this), $shortcode);
119		}
120
121		/**
122		* Returns the filtered shortcode settings configuration.
123		*/
124		public function settings(): array
125		{
126		$config = $this->config();
127		$config = glsr()->filterArray("shortcode/{$this->tag}/config", $config, $this);
128		$config = glsr()->filterArray('shortcode/config', $config, $this->tag, $this);
129		return $config;
130		}
131
132		public function tag(): string
133		{
134		return Str::snakeCase(
135		str_replace('Shortcode', '', (new \ReflectionClass($this))->getShortName())
136		);
137		}
138
139		/**
140		* Returns the unfiltered shortcode settings configuration.
141		*/
142		abstract protected function config(): array;
143
144		protected function debug(array $data = []): void
145		{
146		if (empty($this->args['debug']) \|\| 'shortcode' !== $this->from) {
147		return;
148		}
149		$data = wp_parse_args($data, [
150		'args' => $this->args,
151		'shortcode' => $this->tag,
152		]);
153		ksort($data);
154		ob_start();
155		glsr_debug($data);
156		$this->debug = ob_get_clean();
157		}
158
159		protected function displayOptions(): array
160		{
161		return [];
162		}
163
164		protected function hideOptions(): array
165		{
166		return [];
167		}
168
169		/**
170		* @param string $value
171		*/
172		protected function normalizeAssignedPosts($value): string
173		{
174		$values = Cast::toArray($value);
175		$postTypes = [];
176		foreach ($values as $postType) {
177		if (!is_numeric($postType) && post_type_exists((string) $postType)) {
178		$postTypes[] = $postType;
179		}
180		}
181		$values = glsr(Sanitizer::class)->sanitizePostIds($values);
182		$values = glsr(Multilingual::class)->getPostIdsForAllLanguages($values);
183		$values = array_merge($values, $postTypes);
184		return implode(',', $values);
185		}
186
187		/**
188		* @param string $value
189		*/
190		protected function normalizeAssignedTerms($value): string
191		{
192		$values = glsr(Sanitizer::class)->sanitizeTermIds($value);
193		$values = glsr(Multilingual::class)->getTermIdsForAllLanguages($values);
194		return implode(',', $values);
195		}
196
197		/**
198		* @param string $value
199		*/
200		protected function normalizeAssignedUsers($value): string
201		{
202		$values = glsr(Sanitizer::class)->sanitizeUserIds($value);
203		return implode(',', $values);
204		}
205
206		/**
207		* @param string\|array $value
208		*/
209		protected function normalizeHide($value): array
210		{
211		$hideKeys = array_keys($this->options('hide'));
212		return array_filter(Cast::toArray($value),
213		fn ($value) => in_array($value, $hideKeys)
214		);
215		}
216
217	8	/**
218		* @param string $value
219	8	*/
220	8	protected function normalizeLabels($value): array
221	8	{
222		$defaults = [
223		__('Excellent', 'site-reviews'),
224		__('Very good', 'site-reviews'),
225		__('Average', 'site-reviews'),
226		__('Poor', 'site-reviews'),
227		__('Terrible', 'site-reviews'),
228		];
229		$maxRating = Rating::max();
230		$defaults = array_pad(array_slice($defaults, 0, $maxRating), $maxRating, '');
231		$labels = array_map('trim', explode(',', $value));
232		foreach ($defaults as $i => $label) {
233		if (!empty($labels[$i])) {
234		$defaults[$i] = $labels[$i];
235		}
236		}
237		return array_combine(range($maxRating, 1), $defaults);
238		}
239		}
240

pryley / site-reviews

Push — develop ( db5b9c...b55dd4 )

Shortcode::normalize() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like