Service.php

Go to the documentation of this file.

<?php
 
namespace Elgg\Ajax;
 
use Elgg\Assets\ExternalFiles;
use Elgg\EventsService;
use Elgg\Exceptions\InvalidArgumentException;
use Elgg\Exceptions\RuntimeException;
use Elgg\Http\Request;
use Elgg\Javascript\ESMService;
use Elgg\SystemMessagesService;
use PHPUnit\Util\Json;
use Symfony\Component\HttpFoundation\JsonResponse;
 
class Service {
 
    protected bool $response_sent = false;
 
    protected array $allowed_views = [];
 
    public function __construct(
        protected EventsService $events,
        protected SystemMessagesService $msgs,
        protected Request $request,
        protected ESMService $esm,
        protected ExternalFiles $externalFiles
    ) {
    }
 
    public function isAjax2Request(): bool {
        return $this->request->headers->get('X-Elgg-Ajax-API') === '2';
    }
 
    public function isReady(): bool {
        return !$this->response_sent && $this->isAjax2Request();
    }
 
    public function decodeJson($string) {
        if (!is_string($string)) {
            return $string;
        }
        
        $object = json_decode($string);
        return ($object === null) ? $string : $object;
    }
 
    public function respondFromOutput(mixed $output, string $event_type = '', bool $try_decode = true): JsonResponse|false {
        if ($try_decode) {
            $output = $this->decodeJson($output);
        }
        
        if (is_object($output) && isset($output->value)) {
            $data = $output;
        } elseif (is_array($output) && isset($output['value'])) {
            $data = (object) $output;
        } else {
            $data = (object) ['value' => $output];
        }
 
        if ($event_type) {
            $data = (object) $this->events->triggerResults('ajax_results', $event_type, [], $data);
        }
 
        if (!property_exists($data, 'value')) {
            throw new InvalidArgumentException('$data must have a property "value"');
        }
 
        if ($this->request->getParam('elgg_fetch_messages', true)) {
            $messages = $this->msgs->dumpRegister();
            foreach ($messages as $type => $msgs) {
                $messages[$type] = array_map(function($value) {
                    return (string) $value;
                }, $msgs);
            }
 
            $data->_elgg_msgs = (object) $messages;
        }
 
        if ($this->request->getParam('elgg_fetch_deps', true)) {
            $deps = [
                'js' => $this->esm->getImports(),
                'css' => [],
            ];
 
            foreach ($this->externalFiles->getLoadedResources('css', 'head') as $name => $resource) {
                if ($name === 'elgg') {
                    // prevent loading of elgg.css in admin context
                    continue;
                }
 
                $deps['css'][] = [
                    'name' => $name,
                    'href' => $resource->url,
                    'integrity' => $resource->integrity,
                ];
            }
 
            $data->_elgg_deps = $deps;
        }
        
        $response = _elgg_services()->responseFactory->prepareJsonResponse($data);
        $response->setTtl((int) $this->request->getParam('elgg_response_ttl', 0, false));
 
        $this->response_sent = true;
        return _elgg_services()->responseFactory->send($response);
    }
 
    public function respondWithError(string $msg = '', int $status = 400): JsonResponse|false {
        $response = new JsonResponse(['error' => $msg], $status);
        
        // clear already set system messages as we respond directly with an error as message body
        $this->msgs->dumpRegister();
 
        $this->response_sent = true;
        return _elgg_services()->responseFactory->send($response);
    }
 
    public function registerView(string $view): void {
        $this->allowed_views[$view] = true;
    }
 
    public function unregisterView(string $view): void {
        unset($this->allowed_views[$view]);
    }
 
    public function getViews(): array {
        return array_keys($this->allowed_views);
    }
}