Activity.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\Component\Activities;
 
use ILIAS\Component\Dependencies\Name;
use ILIAS\Data\Result;
use ILIAS\Data\Text;
use ILIAS\Data\Description;
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;
 
interface Activity
{
    public function getName(): Name;
 
    public function getType(): ActivityType;
 
    public function getDescription(): Text\SimpleDocumentMarkdown;
 
    public function getInputDescription(FieldFactory $f): FormInput; // might better be ILIAS/UI/Input/Input, but we would need to promote many properties there before.
 
    public function getOutputDescription(Description\Factory $f): Description\Description;
 
    public function isAllowedToPerform(int $usr_id, mixed $parameters): bool;
 
    public function perform(mixed $parameters): mixed;
 
    public function maybePerformAs(InputFactory $input_factory, int $usr_id, array $raw_parameters): Result;
}