Inheritance diagram for ILIAS\MetaData\Repository\LOMDatabaseRepository:

Collaboration diagram for ILIAS\MetaData\Repository\LOMDatabaseRepository:

Public Member Functions
	__construct (RessourceIDFactoryInterface $ressource_factory, DatabaseManipulatorInterface $manipulator, DatabaseReaderInterface $reader, DatabaseSearcherInterface $searcher, ProcessorInterface $processor, IdentifierHandlerInterface $identifier_handler)

	getMD (int $obj_id, int $sub_id, string $type)

	getMDOnPath (PathInterface $path, int $obj_id, int $sub_id, string $type)
	Returns an MD set with only the elements specified on a path, and all nested subelements of the last elements on the path. More...

	searchMD (ClauseInterface $clause, ?int $limit, ?int $offset, FilterInterface ... $filters)

	manipulateMD (SetInterface $set)
	Follows a trail of markers from the root element, and creates, updates or deletes marked MD elements along the trail. More...

	transferMD (SetInterface $from_set, int $to_obj_id, int $to_sub_id, string $to_type, bool $throw_error_if_invalid)
	Transfers a metadata set to an object, regardless of its source. More...

	deleteAllMD (int $obj_id, int $sub_id, string $type)

Protected Attributes
RessourceIDFactoryInterface	$ressource_factory

DatabaseManipulatorInterface	$manipulator

DatabaseReaderInterface	$reader

DatabaseSearcherInterface	$searcher

ProcessorInterface	$processor

IdentifierHandlerInterface	$identifier_handler

Detailed Description

Definition at line 35 of file LOMDatabaseRepository.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\MetaData\Repository\LOMDatabaseRepository::__construct	(	RessourceIDFactoryInterface	$ressource_factory,
		DatabaseManipulatorInterface	$manipulator,
		DatabaseReaderInterface	$reader,
		DatabaseSearcherInterface	$searcher,
		ProcessorInterface	$processor,
		IdentifierHandlerInterface	$identifier_handler
	)

Definition at line 44 of file LOMDatabaseRepository.php.

References ILIAS\MetaData\Repository\LOMDatabaseRepository\$identifier_handler, ILIAS\MetaData\Repository\LOMDatabaseRepository\$manipulator, ILIAS\MetaData\Repository\LOMDatabaseRepository\$processor, ILIAS\MetaData\Repository\LOMDatabaseRepository\$reader, ILIAS\MetaData\Repository\LOMDatabaseRepository\$ressource_factory, and ILIAS\MetaData\Repository\LOMDatabaseRepository\$searcher.

       {
         $this->ressource_factory = $ressource_factory;
         $this->manipulator = $manipulator;
         $this->reader = $reader;
         $this->searcher = $searcher;
         $this->processor = $processor;
         $this->identifier_handler = $identifier_handler;
     }

Member Function Documentation

◆ deleteAllMD()

ILIAS\MetaData\Repository\LOMDatabaseRepository::deleteAllMD	(	int	$obj_id,
		int	$sub_id,
		string	$type
	)

Implements ILIAS\MetaData\Repository\RepositoryInterface.

Definition at line 123 of file LOMDatabaseRepository.php.

      : void {
         $this->manipulator->deleteAllMD(
             $this->ressource_factory->ressourceID($obj_id, $sub_id, $type)
         );
     }

◆ getMD()

ILIAS\MetaData\Repository\LOMDatabaseRepository::getMD	(	int	$obj_id,
		int	$sub_id,
		string	$type
	)

obj_id: Object ID (NOT ref_id!) of the parent repository object (e.g for page objects the obj_id of the content object; for media objects this is set to 0, because their object id are not assigned to ref ids). NOTE: In the metadata tables, this corresponds to the field rbac_id.
sub_id: ID of the object carrying the metadata, which might be a subobject of an enclosing repository object (e.g for structure objects the obj_id of the structure object). Might be the same as the objID. NOTE: In the metadata tables, this corresponds to the field obj_id.
type: (Sub-)Type of the object (e.g st,pg,crs ...). NOTE: In the metadata tables, this corresponds to the field obj_type.

Implements ILIAS\MetaData\Repository\RepositoryInterface.

Definition at line 60 of file LOMDatabaseRepository.php.

      : SetInterface {
         return $this->processor->finishAndCleanData(
             $this->reader->getMD(
                 $this->ressource_factory->ressourceID($obj_id, $sub_id, $type)
             )
         );
     }

◆ getMDOnPath()

ILIAS\MetaData\Repository\LOMDatabaseRepository::getMDOnPath	(	PathInterface	$path,
		int	$obj_id,
		int	$sub_id,
		string	$type
	)

Returns an MD set with only the elements specified on a path, and all nested subelements of the last elements on the path.

The path must start from the root element. Note that path filters are ignored, and if the path contains steps to super elements, it is only followed down to the first element that the path returns to. Note that resulting partial MD sets might not be completely valid, due to conditions between elements. Be careful when dealing with vocabularies, or Technical > Requirement > OrComposite.

Implements ILIAS\MetaData\Repository\RepositoryInterface.

Definition at line 72 of file LOMDatabaseRepository.php.

      : SetInterface {
         return $this->processor->finishAndCleanData(
             $this->reader->getMDOnPath(
                 $path,
                 $this->ressource_factory->ressourceID($obj_id, $sub_id, $type)
             )
         );
     }

◆ manipulateMD()

ILIAS\MetaData\Repository\LOMDatabaseRepository::manipulateMD ( SetInterface $set )

Follows a trail of markers from the root element, and creates, updates or deletes marked MD elements along the trail.

Non-scaffold elements with 'create or update' markers are updated, and scaffold elements with 'create or update' markers are created with the data value on the marker. Stops when encountering a neutral marker on a scaffold.

Implements ILIAS\MetaData\Repository\RepositoryInterface.

Definition at line 98 of file LOMDatabaseRepository.php.

                                                    : void
     {
         $this->processor->checkMarkers($set);
         $this->manipulator->manipulateMD($set);
     }

◆ searchMD()

ILIAS\MetaData\Repository\LOMDatabaseRepository::searchMD	(	ClauseInterface	$clause,
		?int	$limit,
		?int	$offset,
		FilterInterface ...	$filters
	)

Returns: RessourceIDInterface[]

Implements ILIAS\MetaData\Repository\RepositoryInterface.

Definition at line 89 of file LOMDatabaseRepository.php.

References ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from().

      : \Generator {
         yield from $this->searcher->search($clause, $limit, $offset, ...$filters);
     }

Here is the call graph for this function:

◆ transferMD()

ILIAS\MetaData\Repository\LOMDatabaseRepository::transferMD	(	SetInterface	$from_set,
		int	$to_obj_id,
		int	$to_sub_id,
		string	$to_type,
		bool	$throw_error_if_invalid
	)

Transfers a metadata set to an object, regardless of its source.

Takes The data from 'create or update' markers takes priority over the data carried by marked elements, but 'delete' markers and unmarked or neutrally marked scaffolds are ignored. Always deletes whatever metadata already exist at the target.

If $throw_error_if_invalid is set true, an error is thrown if the markers on the $from_set are invalid, otherwise the invalid markers are replaced by neutral markers.

Implements ILIAS\MetaData\Repository\RepositoryInterface.

Definition at line 104 of file LOMDatabaseRepository.php.

      : void {
         $to_ressource_id = $this->ressource_factory->ressourceID($to_obj_id, $to_sub_id, $to_type);
 
         if ($throw_error_if_invalid) {
             $this->processor->checkMarkers($from_set);
         } else {
             $this->processor->cleanMarkers($from_set);
         }
         $from_set = $this->identifier_handler->prepareUpdateOfIdentifier($from_set, $to_ressource_id);
         $this->manipulator->deleteAllMD($to_ressource_id);
         $this->manipulator->transferMD($from_set, $to_ressource_id);
     }

Field Documentation

◆ $identifier_handler

IdentifierHandlerInterface ILIAS\MetaData\Repository\LOMDatabaseRepository::$identifier_handler

protected

Definition at line 42 of file LOMDatabaseRepository.php.

Referenced by ILIAS\MetaData\Repository\LOMDatabaseRepository\__construct().

◆ $manipulator

DatabaseManipulatorInterface ILIAS\MetaData\Repository\LOMDatabaseRepository::$manipulator

protected

Definition at line 38 of file LOMDatabaseRepository.php.

Referenced by ILIAS\MetaData\Repository\LOMDatabaseRepository\__construct().

◆ $processor

ProcessorInterface ILIAS\MetaData\Repository\LOMDatabaseRepository::$processor

protected

Definition at line 41 of file LOMDatabaseRepository.php.

Referenced by ILIAS\MetaData\Repository\LOMDatabaseRepository\__construct().

◆ $reader

DatabaseReaderInterface ILIAS\MetaData\Repository\LOMDatabaseRepository::$reader

protected

Definition at line 39 of file LOMDatabaseRepository.php.

Referenced by ILIAS\MetaData\Repository\LOMDatabaseRepository\__construct().

◆ $ressource_factory

RessourceIDFactoryInterface ILIAS\MetaData\Repository\LOMDatabaseRepository::$ressource_factory

protected

Definition at line 37 of file LOMDatabaseRepository.php.

Referenced by ILIAS\MetaData\Repository\LOMDatabaseRepository\__construct().

◆ $searcher

DatabaseSearcherInterface ILIAS\MetaData\Repository\LOMDatabaseRepository::$searcher

protected

Definition at line 40 of file LOMDatabaseRepository.php.

Referenced by ILIAS\MetaData\Repository\LOMDatabaseRepository\__construct().

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

components/ILIAS/MetaData/classes/Repository/LOMDatabaseRepository.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ deleteAllMD()

◆ getMD()

◆ getMDOnPath()

◆ manipulateMD()

◆ searchMD()

◆ transferMD()

Field Documentation

◆ $identifier_handler

◆ $manipulator

◆ $processor

◆ $reader

◆ $ressource_factory

◆ $searcher