TourManager.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\Help\GuidedTour\Tour;
 
use ILIAS\Help\GuidedTour\InternalDataService;
use ILIAS\Help\GuidedTour\InternalDomainService;
use ilObjGuidedTour;
use ILIAS\Help\GuidedTour\Settings\PermissionType;
use ilObjectFactory;
 
class TourManager
{
    protected ?bool $any_active = null;
    private \ILIAS\Help\GuidedTour\Settings\SettingsManager $sm;
 
    public function __construct(
        protected InternalDataService $data,
        protected InternalDomainService $domain
    ) {
        $this->sm = $domain->tourSettings();
    }
 
    public function createTour(
        string $title,
        string $description
    ): int {
        $tour_obj = new ilObjGuidedTour();
        $tour_obj->setTitle($title);
        $tour_obj->setDescription($description);
        $tour_obj->create();
        $this->sm->save($this->data->settings(
            $tour_obj->getId(),
            false,
            "",
            PermissionType::None
        ));
        return $tour_obj->getId();
    }
 
    public function getAll(): \Generator
    {
        foreach (\ilObject::_getObjectsByType("gdtr") as $tour) {
            yield \ilObjectFactory::getInstanceByObjId($tour["obj_id"]);
        }
    }
 
    public function anyActive(): bool
    {
        if (!is_null($this->any_active)) {
            return $this->any_active;
        }
        foreach ($this->getAll() as $tour) {
            $settings = $this->sm->getByObjId($tour->getId());
            if ($settings?->isActive()) {
                $this->any_active = true;
                return true;
            }
        }
        $this->any_active = false;
        return false;
    }
 
    public function getByObjId(int $obj_id): ?ilObjGuidedTour
    {
        return \ilObjectFactory::getInstanceByObjId($obj_id);
    }
 
    public function deleteTour(
        int $obj_id
    ): void {
        $tour_obj = new ilObjGuidedTour($obj_id);
        $tour_obj->delete();
    }
 
}