ILIAS\LearningModule\Search\SubitemPropertiesReader Class Reference

Inheritance diagram for ILIAS\LearningModule\Search\SubitemPropertiesReader:

Collaboration diagram for ILIAS\LearningModule\Search\SubitemPropertiesReader:

Public Member Functions
	init (Container $dic)
	getSubitemProperties (PropertiesFactory $factory, int $parent_ref_id, ID ... $subitem_ids)
	Order of the output should respect the order of the subitem_ids. More...
	init (Container $dic)
	getSubitemProperties (PropertiesFactory $factory, int $parent_ref_id, ID ... $subitem_ids)
	Order of the output should respect the order of the subitem_ids. More...

Static Public Member Functions
static	type ()
	Type of the parent object. More...
static	type ()
	Type of the parent object. More...

Protected Member Functions
	getPropertiesForLMObject (PropertiesFactory $factory, int $parent_ref_id, ID $subitem_id, string $presentable_type)
	getPropertiesForFile (PropertiesFactory $factory, int $parent_ref_id, ID $subitem_id)

Protected Attributes
ilLanguage	$lng
DataFactory	$data_factory
ilCtrlInterface	$ctrl

Detailed Description

Definition at line 36 of file SubitemPropertiesReader.php.

Member Function Documentation

getPropertiesForFile()

ILIAS\LearningModule\Search\SubitemPropertiesReader::getPropertiesForFile ( PropertiesFactory  $factory, int  $parent_ref_id, ID  $subitem_id  )

protected

Definition at line 110 of file SubitemPropertiesReader.php.

     : Properties {
        $this->ctrl->setParameterByClass(ilLMPresentationGUI::class, 'ref_id', $parent_ref_id);
        $this->ctrl->setParameterByClass(ilLMPresentationGUI::class, 'file_id', 'il__file_' . $subitem_id->id());
        $link = rtrim(ILIAS_HTTP_PATH, '/') . '/' .
            $this->ctrl->getLinkTargetByClass(ilLMPresentationGUI::class, 'downloadFile');
        $this->ctrl->clearParameterByClass(ilLMPresentationGUI::class, 'file_id');
        $this->ctrl->clearParameterByClass(ilLMPresentationGUI::class, 'ref_id');
        return $factory->get(
            $subitem_id,
            ilObject::_lookupTitle((int) $subitem_id->id()),
            $this->data_factory->uri($link),
            false,
            $this->lng->txt('obj_file')
        );
    }

Referenced by ILIAS\LearningModule\Search\SubitemPropertiesReader\getSubitemProperties().

Here is the caller graph for this function:

getPropertiesForLMObject()

ILIAS\LearningModule\Search\SubitemPropertiesReader::getPropertiesForLMObject ( PropertiesFactory  $factory, int  $parent_ref_id, ID  $subitem_id, string  $presentable_type  )

protected

Definition at line 89 of file SubitemPropertiesReader.php.

     : Properties {
        $this->ctrl->setParameterByClass(ilLMPresentationGUI::class, 'ref_id', $parent_ref_id);
        $this->ctrl->setParameterByClass(ilLMPresentationGUI::class, 'obj_id', $subitem_id->id());
        $link = rtrim(ILIAS_HTTP_PATH, '/') . '/' .
            $this->ctrl->getLinkTargetByClass(ilLMPresentationGUI::class, '');
        $this->ctrl->clearParameterByClass(ilLMPresentationGUI::class, 'obj_id');
        $this->ctrl->clearParameterByClass(ilLMPresentationGUI::class, 'ref_id');
        return $factory->get(
            $subitem_id,
            ilLMObject::_lookupTitle((int) $subitem_id->id()),
            $this->data_factory->uri($link),
            false,
            $presentable_type
        );
    }

Referenced by ILIAS\LearningModule\Search\SubitemPropertiesReader\getSubitemProperties().

Here is the caller graph for this function:

getSubitemProperties()

ILIAS\LearningModule\Search\SubitemPropertiesReader::getSubitemProperties	(	PropertiesFactory	$factory,
		int	$parent_ref_id,
		ID ...	$subitem_ids
	)

Order of the output should respect the order of the subitem_ids.

Subitems that should not be shown in the search results should not be included in the output (read access on the parent object is already checked).

Returns

Properties[]

Implements ILIAS\Search\Presentation\Result\Subitem\PropertiesReader.

Definition at line 54 of file SubitemPropertiesReader.php.

     : Generator {
        $obj_id = ilObject::_lookupObjId($parent_ref_id);
        foreach ($subitem_ids as $subitem_id) {
            switch ($subitem_id->type()) {
                case 'pg':
                    yield $this->getPropertiesForLMObject(
                        $factory,
                        $parent_ref_id,
                        $subitem_id,
                        $this->lng->txt('obj_pg')
                    );
                    break;
 
                case 'st':
                    yield $this->getPropertiesForLMObject(
                        $factory,
                        $parent_ref_id,
                        $subitem_id,
                        $this->lng->txt('obj_st')
                    );
                    break;
 
                case 'file':
                    if (!ilObject::_exists((int) $subitem_id->id())) {
                        break;
                    }
                    yield $this->getPropertiesForFile($factory, $parent_ref_id, $subitem_id);
            }
        }
    }

References ilObject\_exists(), ILIAS\LearningModule\Search\SubitemPropertiesReader\getPropertiesForFile(), ILIAS\LearningModule\Search\SubitemPropertiesReader\getPropertiesForLMObject(), and ILIAS\Repository\lng().

Here is the call graph for this function:

init()

ILIAS\LearningModule\Search\SubitemPropertiesReader::init

(

Container

$dic

)

Implements ILIAS\Search\Presentation\Result\Subitem\PropertiesReader.

Definition at line 47 of file SubitemPropertiesReader.php.

                                        : void
    {
        $this->lng = $dic->language();
        $this->data_factory = new DataFactory();
        $this->ctrl = $dic->ctrl();
    }

References ILIAS\DI\Container\ctrl(), ILIAS\Repository\ctrl(), ILIAS\DI\Container\language(), and ILIAS\Repository\lng().

Here is the call graph for this function:

type()

static ILIAS\LearningModule\Search\SubitemPropertiesReader::type ( )

static

Type of the parent object.

Should do nothing but return a string, is called during setup.

Implements ILIAS\Search\Presentation\Result\Subitem\PropertiesReader.

Definition at line 42 of file SubitemPropertiesReader.php.

                                 : string
    {
        return 'lm';
    }

Field Documentation

$ctrl

ilCtrlInterface ILIAS\LearningModule\Search\SubitemPropertiesReader::$ctrl

protected

Definition at line 40 of file SubitemPropertiesReader.php.

$data_factory

DataFactory ILIAS\LearningModule\Search\SubitemPropertiesReader::$data_factory

protected

Definition at line 39 of file SubitemPropertiesReader.php.

$lng

ilLanguage ILIAS\LearningModule\Search\SubitemPropertiesReader::$lng

protected

Definition at line 38 of file SubitemPropertiesReader.php.

---

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

• components/ILIAS/LearningModule/Search/SubitemPropertiesReader.php