GeminiLabs\SiteReviews\Defaults\SiteReviewsDefaults

Complexity

Total Complexity

4

Size/Duplication

Total Lines	100
Duplicated Lines	0 %

Test Coverage

Coverage

96.3%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	defaults()	0	22	1
A	normalize()	0	8	3

<?php

namespace GeminiLabs\SiteReviews\Defaults;

use GeminiLabs\SiteReviews\Helpers\Arr;
use GeminiLabs\SiteReviews\Modules\Rating;

class SiteReviewsDefaults extends DefaultsAbstract
{
    /**
     * The values that should be cast before sanitization is run.
     * This is done before $sanitize and $enums.
     */
    public array $casts = [
        'debug' => 'bool',
        'pagination' => 'string',
        'schema' => 'bool',
        'terms' => 'string',
        'verified' => 'string',
    ];

    /**
     * The values that should be constrained after sanitization is run.
     * This is done after $casts and $sanitize.
     */
    public array $enums = [
        'pagination' => ['ajax', 'loadmore', '1', 'true'],
        'terms' => ['0', 'false', '1', 'true'],
        'verified' => ['0', 'false', '1', 'true'],
    ];

    /**
     * The values that should be guarded.
     *
     * @var string[]
     */
    public array $guarded = [
        'fallback',
    ];

    /**
     * The keys that should be mapped to other keys.
     * Keys are mapped before the values are normalized and sanitized.
     * Note: Mapped keys should not be included in the defaults!
     */
    public array $mapped = [
        'assigned_to' => 'assigned_posts',
        'category' => 'assigned_terms',
        'className' => 'class',
        'per_page' => 'display',
        'user' => 'assigned_users',
    ];

    /**
     * The values that should be sanitized.
     * This is done after $casts and before $enums.
     */
    public array $sanitize = [
        'author' => 'user-id',
        'class' => 'attr-class',
        'display' => 'min:1',
        'fallback' => 'text-post',
        'hide' => 'array-string',
        'id' => 'id-unique',
        'offset' => 'min:0',
        'page' => 'min:1',
        'rating' => 'rating',
        'rating_field' => 'name',
        'type' => 'slug',
    ];

    protected function defaults(): array
    {
        return [
            'assigned_posts' => '',
            'assigned_terms' => '',
            'assigned_users' => '',
            'author' => 0,
            'class' => '',
            'display' => 5,
            'debug' => false,
            'fallback' => '',
            'hide' => [],
            'id' => '',
            'offset' => 0,
            'page' => 1,
            'pagination' => '',
            'rating' => Rating::min(),
            'rating_field' => 'rating', // used for custom rating fields
            'schema' => false,
            'terms' => '',
            'type' => '',
            'verified' => '',
        ];
    }

    /**
     * Normalize provided values, this always runs first.
     */
    protected function normalize(array $values = []): array
    {
        foreach ($this->mapped as $old => $new) {
            if ('custom' === Arr::get($values, $old)) { // @todo is this deprecated??
                $values[$old] = Arr::get($values, $new);
            }
        }
        return $values;
    }
}