JSKOS\PrettyJsonSerializable

Complexity

Total Complexity

17

Size/Duplication

Total Lines	78
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	jsonSerialize()	0	4	1
C	jsonLDSerialize()	0	38	14
A	__toString()	0	4	1
A	json()	0	4	1

<?php declare(strict_types = 1);

namespace JSKOS;

/**
 * Provide consistent JSON(-LD) serializing.
 */
abstract class PrettyJsonSerializable implements \JsonSerializable
{
    const DEFAULT_CONTEXT = 'https://gbv.github.io/jskos/context.json';

    /**
     * Returns data which should be serialized to JSON.
     *
     * Delegates to jsonLDSerialize which can be called with a JSON-LD context URL.
     */
    public function jsonSerialize()
    {
        return $this->jsonLDSerialize();
    }

    /**
     * Returns data which should be serialized to JSON.
     *
     * Include all non-null members and the JSON-LD context (`@context`).
     * Keys are sorted by Unicode codepoint for stable output.
     *
     * @param string $context optional JSON-LD context URL. Use empty string to omit.
     * @param bool $types include default type URIs.
     */
    public function jsonLDSerialize(string $context = self::DEFAULT_CONTEXT, bool $types = null)
    {
        $json = [];

        foreach ($this as $key => $value) {
            if (isset($value)) {
                if ($value instanceof PrettyJsonSerializable) {
                    $value = $value->jsonLDSerialize('', false);
                } elseif (is_array($value) and !count(array_filter(array_keys($value), 'is_string'))) {
                    $a = [];
                    foreach ($value as $m) {
                        if ($m instanceof PrettyJsonSerializable) {
                            $m = $m->jsonLDSerialize('', false);
                        }
                        $a[] = $m;
                    }
                    $value = $a;
                }
                $json[$key] = $value;
            }
        }

        # don't serialize implicitly deriveable types for brevity
        if ($context) {
            $json['@context'] = $context;
        }
        if ($types === null) {
            $types = (bool)$context;
        }
        if (!$types && count($json['type'] ?? []) == 1 && count(static::TYPES)) {
            if ($json['type'][0] == static::TYPES[0]) {
                unset($json['type']);
            }
        }

        ksort($json);
        return $json;
    }

    /**
     * Serialize to JSON in string context.
     */
    public function __toString()
    {
        return json_encode($this, JSON_UNESCAPED_SLASHES);
    }

    /**
     * Serialize to pretty-printed JSON.
     */
    public function json()
    {
        return json_encode($this, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
    }
}