nystudio107 / craft-recipe

src/helpers/Json.php

<?php
/**
 * Recipe plugin for Craft CMS 3.x
 *
 * A comprehensive recipe FieldType for Craft CMS that includes metric/imperial
 * conversion, portion calculation, and JSON-LD microdata support
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2017 nystudio107

@copyright tag must contain a year and the name of the copyright holder

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

namespace nystudio107\recipe\helpers;

use Craft;

/**

Missing short description in doc comment

 * @author    nystudio107

The tag in position 1 should be the @package tag

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value for @author tag indented incorrectly; expected 2 spaces but found 4

 * @package   Recipe

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     1.0.0

The tag in position 3 should be the @author tag

Tag value for @since tag indented incorrectly; expected 3 spaces but found 5

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class Json extends \craft\helpers\Json
{
    // Static Properties
    // =========================================================================

    protected static int $recursionLevel;

    // Static Methods
    // =========================================================================

    /**

Missing short description in doc comment

Parameter $value should have a doc-comment as per coding-style.

Parameter $options should have a doc-comment as per coding-style.

     * @inheritdoc
     */

Missing @return tag in function comment

    public static function encode(
        $value,
        $options =

Multi-line assignments must have the equal sign on the second line

        JSON_UNESCAPED_UNICODE
        | JSON_UNESCAPED_SLASHES,
    ): string {
        // If `devMode` is enabled, make the JSON-LD human-readable
        if (Craft::$app->getConfig()->getGeneral()->devMode) {
            $options |= JSON_PRETTY_PRINT;
        }

        self::$recursionLevel = 0;

        return parent::encode($value, $options);
    }

    /**

Missing short description in doc comment

Parameter $data should have a doc-comment as per coding-style.

Parameter $expressions should have a doc-comment as per coding-style.

Parameter $expPrefix should have a doc-comment as per coding-style.

     * @inheritdoc
     */

Missing @return tag in function comment

    protected static function processData($data, &$expressions, $expPrefix)
    {
        ++self::$recursionLevel;
        $result = parent::processData($data, $expressions, $expPrefix);
        --self::$recursionLevel;
        static::normalizeJsonLdArray($result, self::$recursionLevel);

        return $result;
    }


    // Private Methods
    // =========================================================================

    /**
     * Normalize the JSON-LD array recursively to remove empty values, change
     * 'type' to '@type' and have it be the first item in the array
     *
     * @param $array

Missing parameter comment

     * @param $depth

Missing parameter comment

     */

Missing @return tag in function comment

    protected static function normalizeJsonLdArray(&$array, $depth): void

The parameter $depth is not used and could be removed.

    {
        $array = array_filter($array);
        $array = self::changeKey($array, 'context', '@context');
        $array = self::changeKey($array, 'type', '@type');
        ksort($array);
    }

    /**

Parameter $array should have a doc-comment as per coding-style.

Parameter $oldKey should have a doc-comment as per coding-style.

Parameter $newKey should have a doc-comment as per coding-style.

     * Replace key values without reordering the array or converting numeric
     * keys to associative keys (which unset() does)
     */

Missing @return tag in function comment

    protected static function changeKey(array $array, string $oldKey, string $newKey): array
    {
        if (!array_key_exists($oldKey, $array)) {
            return $array;
        }

        $keys = array_keys($array);
        $keys[array_search($oldKey, $keys)] = $newKey;

        return array_combine($keys, $array);
    }
}