ILIAS\MediaPool\Search\SubitemPropertiesReader Class Reference

Inheritance diagram for ILIAS\MediaPool\Search\SubitemPropertiesReader:

Collaboration diagram for ILIAS\MediaPool\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 Attributes
ilLanguage	$lng
DataFactory	$data_factory
StaticURL	$static_url
ilCtrlInterface	$ctrl

Detailed Description

Definition at line 36 of file SubitemPropertiesReader.php.

Member Function Documentation

getSubitemProperties()

ILIAS\MediaPool\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 56 of file SubitemPropertiesReader.php.

     : Generator {
        foreach ($subitem_ids as $subitem_id) {
            $link = null;
            switch ($subitem_id->type()) {
                case 'fold':
                    $link = $this->static_url->builder()->build(
                        'mep',
                        $this->data_factory->refId($parent_ref_id),
                        [$subitem_id->id()]
                    );
                    break;
 
                case 'mob':
                    $this->ctrl->setParameterByClass(ilMediaPoolPresentationGUI::class, 'ref_id', $parent_ref_id);
                    $this->ctrl->setParameterByClass(ilMediaPoolPresentationGUI::class, 'force_filter', $subitem_id->id());
                    $link = $this->data_factory->uri(rtrim(ILIAS_HTTP_PATH, '/') . '/' .
                        $this->ctrl->getLinkTargetByClass(ilMediaPoolPresentationGUI::class, 'allMedia'));
                    $this->ctrl->clearParameterByClass(ilMediaPoolPresentationGUI::class, 'force_filter');
                    $this->ctrl->clearParameterByClass(ilMediaPoolPresentationGUI::class, 'ref_id');
                    break;
 
                case 'pg':
                    $pool = new ilObjMediaPool($parent_ref_id);
                    $parent_id = $pool->getParentId((int) $subitem_id->id());
                    $link = $this->static_url->builder()->build(
                        'mep',
                        $this->data_factory->refId($parent_ref_id),
                        $parent_id === null ? [] : [$parent_id]
                    );
                    break;
            }
            if ($link === null) {
                continue;
            }
            yield $factory->get(
                $subitem_id,
                ilMediaPoolItem::lookupTitle((int) $subitem_id->id()),
                $link,
                false,
                $this->lng->txt('obj_' . $subitem_id->type())
            );
        }
    }

References ILIAS\Repository\ctrl(), ILIAS\Search\Presentation\Result\Subitem\PropertiesFactory\get(), and ilMediaPoolItem\lookupTitle().

Here is the call graph for this function:

init()

ILIAS\MediaPool\Search\SubitemPropertiesReader::init

(

Container

$dic

)

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

Definition at line 48 of file SubitemPropertiesReader.php.

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

References $dic, 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\MediaPool\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 43 of file SubitemPropertiesReader.php.

                                 : string
    {
        return 'mep';
    }

Field Documentation

$ctrl

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

protected

Definition at line 41 of file SubitemPropertiesReader.php.

$data_factory

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

protected

Definition at line 39 of file SubitemPropertiesReader.php.

$lng

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

protected

Definition at line 38 of file SubitemPropertiesReader.php.

$static_url

StaticURL ILIAS\MediaPool\Search\SubitemPropertiesReader::$static_url

protected

Definition at line 40 of file SubitemPropertiesReader.php.

---

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

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