ILIAS\BookingManager\Common\Table Namespace Reference

Data Structures
interface	Table
interface	TableAction
	@template RecordType More...
class	TableActions
interface	TableActionsFactory

Functions
	getTableActions ()
	onExecute (URLBuilder $url_builder, URLBuilderToken $row_id_token, URLBuilderToken $action_token, URLBuilderToken $action_type_token)
	showModal (URLBuilder $url_builder, URLBuilderToken $row_id_token, URLBuilderToken $action_token, URLBuilderToken $action_type_token,)
	submit (URLBuilder $url_builder, URLBuilderToken $row_id_token, URLBuilderToken $action_token, URLBuilderToken $action_type_token,)
	showErrorMessage (string $message)
	showSuccessMessage (string $message)
	getSelectionErrorMessage ()
	getModal (URLBuilder $url_builder, array $selected_records, bool $all_records_selected)
	onSubmit (URLBuilder $url_builder, array $selected_records, bool $all_records_selected)
	resolveRecords (?array $selected_ids=null)

Variables
trait	TableActionExecutorTrait
trait	TableActionModalTrait
	@template RecordType More...
const string	SUBMIT_MODAL_ACTION = 'submitModalAction'
readonly HttpService	$http
readonly UIRenderer	$ui_renderer

Function Documentation

getModal()

ILIAS\BookingManager\Common\Table\getModal ( URLBuilder  $url_builder, array  $selected_records, bool  $all_records_selected  )

abstractprotected

Parameters

list<RecordType>

$selected_records

getSelectionErrorMessage()

ILIAS\BookingManager\Common\Table\getSelectionErrorMessage

(

)

Definition at line 139 of file TableActionModalTrait.php.

                                              : ?string
    {
        return $this->lng->txt('no_valid_selection');
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getTableActions()

ILIAS\BookingManager\Common\Table\getTableActions ( )

abstractprotected

Referenced by ILIAS\BookingManager\BookableItem\Table\BookableItemTable\getRows(), ILIAS\BookingManager\Participant\Table\ParticipantTable\getRows(), ILIAS\BookingManager\Schedule\Table\ScheduleTable\getRows(), ILIAS\BookingManager\Bookings\Table\BookingsTable\getTable(), and ILIAS\BookingManager\BookableItem\Table\BookableItemTable\getTableActions().

Here is the caller graph for this function:

onExecute()

ILIAS\BookingManager\Common\Table\onExecute	(	URLBuilder	$url_builder,
		URLBuilderToken	$row_id_token,
		URLBuilderToken	$action_token,
		URLBuilderToken	$action_type_token
	)

Definition at line 43 of file TableActionModalTrait.php.

     : ?Modal {
        return match($this->http->resolveRowParameter($action_type_token->getName())) {
            self::SUBMIT_MODAL_ACTION => $this->submit($url_builder, $row_id_token, $action_token, $action_type_token),
            default => $this->showModal($url_builder, $row_id_token, $action_token, $action_type_token),
        };
    }

References ILIAS\BookingManager\Common\Table\showModal(), ILIAS\BookingManager\Common\Table\submit(), and ILIAS\BookingManager\Common\Table\SUBMIT_MODAL_ACTION.

Here is the call graph for this function:

onSubmit()

ILIAS\BookingManager\Common\Table\onSubmit ( URLBuilder  $url_builder, array  $selected_records, bool  $all_records_selected  )

abstractprotected

Parameters

list<RecordType>

$selected_records

resolveRecords()

ILIAS\BookingManager\Common\Table\resolveRecords ( ?array  $selected_ids = null )

abstractprotected

showErrorMessage()

ILIAS\BookingManager\Common\Table\showErrorMessage ( string  $message )

protected

Definition at line 129 of file TableActionModalTrait.php.

                                                        : void
    {
        $this->tpl->setOnScreenMessage(ilGlobalTemplateInterface::MESSAGE_TYPE_FAILURE, $message, true);
    }

References ILIAS\UICore\GlobalTemplate\MESSAGE_TYPE_FAILURE.

Referenced by ILIAS\BookingManager\BookableItem\Table\Action\BookableItemTableDeleteAction\onSubmit(), ILIAS\BookingManager\Bookings\Table\Action\BookingsTableCancelAction\onSubmit(), ILIAS\BookingManager\Bookings\Table\Action\BookingsTableDeleteAction\onSubmit(), ILIAS\BookingManager\Participant\Table\Action\ParticipantTableDeleteAction\onSubmit(), and ILIAS\BookingManager\Schedule\Table\Action\ScheduleTableDeleteAction\onSubmit().

Here is the caller graph for this function:

showModal()

ILIAS\BookingManager\Common\Table\showModal ( URLBuilder  $url_builder, URLBuilderToken  $row_id_token, URLBuilderToken  $action_token, URLBuilderToken  $action_type_token  )

protected

Definition at line 55 of file TableActionModalTrait.php.

     : void {
        $selected_ids = $this->http->resolveRowParameters($row_id_token->getName());
        $all_records_selected = $selected_ids === HttpService::ALL_OBJECTS;
 
        if ($all_records_selected) {
            $selected_ids = null;
        } else {
            $selected_ids = is_string($selected_ids) ? [] : $selected_ids;
        }
 
        $selected_records = array_filter(
            $this->resolveRecords($selected_ids),
            fn(mixed $record): bool => $this->allowActionForRecord($record)
        );
 
        $this->http->sendAsync(
            $this->ui_renderer->renderAsync(
                $this->getModal(
                    $url_builder
                        ->withParameter($row_id_token, $all_records_selected ? HttpService::ALL_OBJECTS : ($selected_ids ?? []))
                        ->withParameter($action_token, $this->getActionId())
                        ->withParameter($action_type_token, self::SUBMIT_MODAL_ACTION),
                    $selected_records,
                    $all_records_selected
                )
            )
        );
    }

Referenced by ILIAS\Test\Participants\ParticipantTableActions\execute(), ILIAS\BookingManager\BookableItem\Table\Action\BookableItemTableCancelBookingAction\onExecute(), and ILIAS\BookingManager\Common\Table\onExecute().

Here is the caller graph for this function:

showSuccessMessage()

ILIAS\BookingManager\Common\Table\showSuccessMessage ( string  $message )

protected

Definition at line 134 of file TableActionModalTrait.php.

                                                          : void
    {
        $this->tpl->setOnScreenMessage(ilGlobalTemplateInterface::MESSAGE_TYPE_SUCCESS, $message, true);
    }

References ILIAS\UICore\GlobalTemplate\MESSAGE_TYPE_SUCCESS.

Referenced by ILIAS\BookingManager\Bookings\Table\Action\BookingsTableCancelAction\onSubmit(), and ILIAS\BookingManager\Bookings\Table\Action\BookingsTableDeleteAction\onSubmit().

Here is the caller graph for this function:

submit()

ILIAS\BookingManager\Common\Table\submit ( URLBuilder  $url_builder, URLBuilderToken  $row_id_token, URLBuilderToken  $action_token, URLBuilderToken  $action_type_token  )

protected

Definition at line 89 of file TableActionModalTrait.php.

     : ?Modal {
        $selected_ids = $this->http->resolveRowParameters($row_id_token->getName());
        $all_records_selected = $selected_ids === HttpService::ALL_OBJECTS;
 
        if ($all_records_selected) {
            $selected_ids = null;
        } else {
            $selected_ids = is_string($selected_ids) ? [] : $selected_ids;
        }
 
        if (!$all_records_selected && $selected_ids === []) {
            $this->showErrorMessage($this->getSelectionErrorMessage());
            return null;
        }
 
        $selected_records = array_filter(
            $this->resolveRecords($selected_ids),
            fn(mixed $record): bool => $this->allowActionForRecord($record)
        );
 
        if ($selected_records === []) {
            $this->showErrorMessage($this->getSelectionErrorMessage());
            return null;
        }
 
        return $this->onSubmit(
            $url_builder
                ->withParameter($row_id_token, $all_records_selected ? HttpService::ALL_OBJECTS : $selected_ids)
                ->withParameter($action_token, $this->getActionId())
                ->withParameter($action_type_token, self::SUBMIT_MODAL_ACTION),
            $selected_records,
            $all_records_selected
        );
    }

Referenced by ILIAS\Test\Participants\ParticipantTableActions\execute(), ILIAS\BookingManager\BookableItem\Table\Action\BookableItemTableCancelBookingAction\onExecute(), ILIAS\BookingManager\Common\Table\onExecute(), ILIAS\BookingManager\BookingProcess\ObjectSelectionListGUI\render(), ilBookBulkCreationGUI\renderConfirmation(), ilTermDefinitionBulkCreationGUI\renderConfirmation(), and LauncherInlineTest\testLauncherInlineRendering().

Here is the caller graph for this function:

Variable Documentation

$http

readonly HttpService ILIAS::BookingManager::Common::Table\$http

private

Definition at line 39 of file TableActionModalTrait.php.

Referenced by ilMailSearchObjectsTableGUI\__construct(), ilSessionStatisticsGUI\__construct(), ILIAS\Test\Questions\Presentation\QuestionsTableQuery\__construct(), ilOrgUnitExtension\__construct(), ILIAS\FileDelivery\Delivery\StreamDelivery\__construct(), ILIAS\Chatroom\Bans\BannedUsersTable\__construct(), ILIAS\User\Profile\Prompt\StartUpStep\__construct(), ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable\__construct(), ILIAS\Forum\Moderation\ForumModeratorsTable\__construct(), ILIAS\Contact\MailingLists\MailingListsMembersTable\__construct(), ILIAS\Contact\MailingLists\MailingListsTable\__construct(), ILIAS\Contact\MemberSearch\MailMemberSearchTable\__construct(), ILIAS\Search\GUI\Direct\SearchStateHandlerImpl\__construct(), ILIAS\Search\GUI\Lucene\SearchStateHandlerImpl\__construct(), ILIAS\GlobalScreen\GUI\Access\Access\__construct(), ILIAS\GlobalScreen\GUI\Pons\__construct(), ILIAS\Test\Results\Presentation\AttemptResultsTable\__construct(), ILIAS\UI\examples\Input\Field\Image\base(), ILIAS\UI\examples\Input\Field\TreeMultiSelect\base(), ILIAS\UI\examples\Input\Field\TreeSelect\base(), ILIAS\StaticURL\Request\BundledRequestBuilder\buildRequest(), ILIAS\StaticURL\Request\LegacyRequestBuilder\buildRequest(), ILIAS\StaticURL\Request\ShortlinkRequestBuilder\buildRequest(), ILIAS\StaticURL\Request\StaticURLRequestBuilder\buildRequest(), ILIAS\UI\examples\Progress\Bar\callArtificialTaskEndpoint(), ilPropertyFormGUI\checkInput(), ilDclTableView\createOrGetStandardView(), ILIAS\WebDAV\Entrypoint\enter(), ilMailForm\getRecipientAsync(), ILIAS\FileDelivery\http(), ilMembershipNotifications\importFromForm(), ILIAS\UI\examples\Input\Field\File\in_form(), ILIAS\UI\examples\Input\Field\File\multiple(), ILIAS\StaticURL\Handler\HandlerService\performRedirect(), nusoap_client\send(), ILIAS\Repository\send(), ILIAS\Saml\Module\sendXMLString(), ILIAS\UI\examples\Progress\Bar\server(), ilRTEBaseTestCase\setMocks(), CapabilityTest\setUp(), ILIAS\Tests\FileDelivery\FileDeliveryTypes\FileDeliveryTypeFactoryTest\setUp(), ilAssQuestionPreviewGUITest\setUp(), ilMailOptionsGUITest\testMailOptionsAreAccessibleIfGlobalAccessIsNotDenied(), ilMailOptionsGUITest\testMailOptionsAreNotAccessibleIfGlobalAccessIsDeniedAndUserWillBeRedirectedToMailSystem(), ILIAS\Badge\test\TileViewTest\testShow(), and ILIAS\LegalDocuments\test\AdministrationTest\testWithDocumentAndCriterion().

$ui_renderer

readonly UIRenderer ILIAS::BookingManager::Common::Table\$ui_renderer

private

Definition at line 41 of file TableActionModalTrait.php.

Referenced by ilStudyProgrammeIndividualPlanTableGUI\__construct(), ilStudyProgrammeExpandableProgressListGUI\__construct(), ilPollUserTableGUI\__construct(), ilCalendarBlockGUI\addSubscriptionButton(), ILIAS\UI\examples\Table\Column\StatusIcon\base(), ILIAS\UI\examples\Table\Data\base(), ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI\buildFiles(), ILIAS\UI\examples\Table\Presentation\environment(), ilTable2GUI\fillFooter(), ilContentStylesTableGUI\fillRow(), ilSurveyQuestionTableGUI\fillRow(), ilSurveyQuestionsTableGUI\fillRow(), ilWikiFunctionsBlockGUI\getLegacyContent(), ilObjQuestionPoolGUI\getTable(), ilOrgUnitTypeGUI\getTableDataRetrieval(), ILIAS\Init\AllModernComponents\populateComponentsInLegacyEnvironment(), ilNewsTimelineItemGUI\render(), ilNewsTimelineItemGUI\renderMedia(), ilNewsTimelineItemGUI\renderMediaModal(), ilTestQuestionNavigationGUITest\setUp(), SettingsScoringGUITest\testScoringResultsGUIConstruct(), and ILIAS\UI\examples\Table\Data\with_additional_viewcontrols().

SUBMIT_MODAL_ACTION

const string ILIAS::BookingManager::Common::Table\SUBMIT_MODAL_ACTION = 'submitModalAction'

Definition at line 37 of file TableActionModalTrait.php.

Referenced by ILIAS\BookingManager\BookableItem\Table\Action\BookableItemTableCancelBookingAction\onExecute(), and ILIAS\BookingManager\Common\Table\onExecute().

TableActionExecutorTrait

trait ILIAS::BookingManager::Common::Table\TableActionExecutorTrait

Initial value:

{
    public function execute(URLBuilder $url_builder): ?Modal
    {
        return $this->getTableActions()->execute(...$this->acquireParameters($url_builder));
    }
 
    abstract protected function acquireParameters(URLBuilder $url_builder): array

Definition at line 26 of file TableActionExecutorTrait.php.

TableActionModalTrait

trait ILIAS::BookingManager::Common::Table\TableActionModalTrait

Initial value:

{
    public const string SHOW_MODAL_ACTION = 'showModalAction'

@template RecordType

Definition at line 33 of file TableActionModalTrait.php.