ILIAS\Help\GuidedTour\Tour\TourManager Class Reference

Collaboration diagram for ILIAS\Help\GuidedTour\Tour\TourManager:

Public Member Functions
	__construct (protected InternalDataService $data, protected InternalDomainService $domain)
	createTour (string $title, string $description)
	getAll ()
	anyActive ()
	getByObjId (int $obj_id)
	deleteTour (int $obj_id)

Protected Attributes
bool	$any_active = null

Private Attributes
ILIAS Help GuidedTour Settings SettingsManager	$sm

Detailed Description

Definition at line 29 of file TourManager.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Help\GuidedTour\Tour\TourManager::__construct	(	protected InternalDataService	$data,
		protected InternalDomainService	$domain
	)

Definition at line 34 of file TourManager.php.

      {
        $this->sm = $domain->tourSettings();
    }

References ILIAS\Help\GuidedTour\InternalDomainService\tourSettings().

Here is the call graph for this function:

Member Function Documentation

anyActive()

ILIAS\Help\GuidedTour\Tour\TourManager::anyActive

(

)

Definition at line 68 of file TourManager.php.

                               : 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;
    }

createTour()

ILIAS\Help\GuidedTour\Tour\TourManager::createTour	(	string	$title,
		string	$description
	)

Definition at line 41 of file TourManager.php.

     : 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();
    }

deleteTour()

ILIAS\Help\GuidedTour\Tour\TourManager::deleteTour

(

int

$obj_id

)

Definition at line 89 of file TourManager.php.

     : void {
        $tour_obj = new ilObjGuidedTour($obj_id);
        $tour_obj->delete();
    }

getAll()

ILIAS\Help\GuidedTour\Tour\TourManager::getAll

(

)

Returns

\Generator<ilObjGuidedTour>

Definition at line 61 of file TourManager.php.

                            : \Generator
    {
        foreach (\ilObject::_getObjectsByType("gdtr") as $tour) {
            yield \ilObjectFactory::getInstanceByObjId($tour["obj_id"]);
        }
    }

References ilObject\_getObjectsByType().

Here is the call graph for this function:

getByObjId()

ILIAS\Help\GuidedTour\Tour\TourManager::getByObjId

(

int

$obj_id

)

Definition at line 84 of file TourManager.php.

                                           : ?ilObjGuidedTour
    {
        return \ilObjectFactory::getInstanceByObjId($obj_id);
    }

Field Documentation

$any_active

bool ILIAS\Help\GuidedTour\Tour\TourManager::$any_active = null

protected

Definition at line 31 of file TourManager.php.

$sm

ILIAS Help GuidedTour Settings SettingsManager ILIAS\Help\GuidedTour\Tour\TourManager::$sm

private

Definition at line 32 of file TourManager.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/Help/GuidedTour/Tour/TourManager.php