ops-Gazelle/app/Json.php

<?php

namespace Gazelle;

abstract class Json extends Base {
    protected int $mode    = JSON_INVALID_UTF8_SUBSTITUTE | JSON_THROW_ON_ERROR;
    protected int $version = 1;
    protected string $failure;

    /**
     * The payload of a valid JSON response, implemented in the child class.
     */
    abstract public function payload(): array;

    /**
     * Configure JSON printing (any of the json_encode  JSON_* constants)
     */
    public function setMode(int $mode): static {
        $this->mode = $mode;
        return $this;
    }

    /**
     * Set the version of the Json payload. Increment the
     * value when there is significant change in the payload.
     * If not called, the version defaults to 1.
     */
    public function setVersion(int $version): static {
        $this->version = $version;
        return $this;
    }

    /**
     * General failure routine for when bad things happen.
     */
    public function failure(string $message): static {
        $this->failure = $message;
        return $this;
    }

    protected function failureResponse(): string {
        return (string)json_encode(
            array_merge([
                    'status' => 'failure',
                    'response' => [],
                    'error' => $this->failure,
                ],
                $this->info(),
                $this->debug(),
            ),
            $this->mode
        );
    }

    public function response(): string {
        $payload = $this->payload();
        if (isset($this->failure)) {
            return $this->failureResponse();
        }
        try {
            return (string)json_encode(
                array_merge([
                        'status' => 'success',
                        'response' => $payload,
                    ],
                    $this->info(),
                    $this->debug()
                ),
                $this->mode
            );
        } catch (\JsonException) {
            return $this
                ->failure("JSON encoding failed, look for malformed UTF-8 encoding")
                ->failureResponse();
        }
    }

    protected function debug(): array {
        global $Viewer;
        if (!isset($Viewer) || !$Viewer->permitted('site_debug')) {
            return [];
        }
        $info = [
            'debug' => [
                'queries' => DB::DB()->queryList(),
            ],
        ];
        if (class_exists('Sphinxql')) {
            $info['searches'] = \Sphinxql::$Queries;
        }
        return $info;
    }

    protected function info(): array {
        return [
            'info' => [
                'source'  => SITE_NAME,
                'version' => $this->version,
            ]
        ];
    }
}