GetStatus.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\Setup\Activities;
 
use ILIAS\Data\Description;
use ILIAS\Data\Factory as DataFactory;
use ILIAS\Data\Result;
use ILIAS\Data\Text;
use ILIAS\UI\Component\Input\Container\Form\FormInput;
use ILIAS\UI\Component\Input\Factory as InputFactory;
use ILIAS\UI\Component\Input\Field\Factory as FieldFactory;
 
class GetStatus extends \ILIAS\Component\Activities\Query
{
    public function __construct(
        private readonly DataFactory $data = new DataFactory(),
    ) {
    }
 
    public function getDescription(): Text\SimpleDocumentMarkdown
    {
        return $this->data->text()->markdown()->simpleDocument(
            "Reports the status of the installation.\n\n"
            . "Not available yet: nobody is allowed to perform it."
        );
    }
 
    public function getInputDescription(FieldFactory $f): FormInput
    {
        return $f->section([], 'Get the status of the installation');
    }
 
    public function getOutputDescription(Description\Factory $f): Description\Description
    {
        return $f->object(
            $this->data->text()->markdown()->simpleDocument('The status of the installation.'),
            []
        );
    }
 
    public function isAllowedToPerform(int $usr_id, mixed $parameters): bool
    {
        return false;
    }
 
    public function perform(mixed $parameters): mixed
    {
        throw new \LogicException('The status of the installation is not available yet.');
    }
 
    public function maybePerformAs(InputFactory $input_factory, int $usr_id, array $raw_parameters): Result
    {
        if (!$this->isAllowedToPerform($usr_id, $raw_parameters)) {
            return $this->data->error(
                new \DomainException('You are not allowed to get the status of the installation.', 403)
            );
        }
 
        try {
            return $this->data->ok($this->perform($raw_parameters));
        } catch (\Exception $e) {
            return $this->data->error($e);
        }
    }
}