Collaboration diagram for ILIAS\MetaData\OERHarvester\Harvester:

Public Member Functions
	__construct (SettingsInterface $settings, ObjectHandler $object_handler, ExportHandler $export_handler, StatusRepository $status_repository, ExposedRecordRepository $exposed_record_repository, CopyrightSearchFactory $copyright_search_factory, LOMRepository $lom_repository, SimpleDCXMLWriter $xml_writer, \ilLogger $logger)

	run (Result $result)

Protected Member Functions
	findHarvestableObjectIDs ()

	deleteDeprecatedReferences (array $harvestable_obj_ids, array $currently_harvested_obj_ids)
	Returns number of deletions. More...

	harvestObjects (array $harvestable_obj_ids, array $currently_harvested_obj_ids)
	Returns number of harvested objects. More...

	updateExposedRecords (array $harvestable_obj_ids,)
	Returns number of changed exposed records. More...

	logDebug (string $message)

	logError (string $message)

	buildIdentifier (int $obj_id, string $type)

Protected Attributes
SettingsInterface	$settings

ObjectHandler	$object_handler

ExportHandler	$export_handler

StatusRepository	$status_repository

ExposedRecordRepository	$exposed_record_repository

CopyrightSearchFactory	$copyright_search_factory

LOMRepository	$lom_repository

SimpleDCXMLWriter	$xml_writer

ilLogger	$logger

Detailed Description

Definition at line 33 of file Harvester.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\MetaData\OERHarvester\Harvester::__construct	(	SettingsInterface	$settings,
		ObjectHandler	$object_handler,
		ExportHandler	$export_handler,
		StatusRepository	$status_repository,
		ExposedRecordRepository	$exposed_record_repository,
		CopyrightSearchFactory	$copyright_search_factory,
		LOMRepository	$lom_repository,
		SimpleDCXMLWriter	$xml_writer,
		\ilLogger	$logger
	)

Definition at line 45 of file Harvester.php.

       {
         $this->settings = $settings;
         $this->object_handler = $object_handler;
         $this->export_handler = $export_handler;
         $this->status_repository = $status_repository;
         $this->exposed_record_repository = $exposed_record_repository;
         $this->copyright_search_factory = $copyright_search_factory;
         $this->lom_repository = $lom_repository;
         $this->xml_writer = $xml_writer;
         $this->logger = $logger;
     }

Here is the call graph for this function:

Member Function Documentation

◆ buildIdentifier()

ILIAS\MetaData\OERHarvester\Harvester::buildIdentifier	(	int	$obj_id,
		string	$type
	)

protected

Definition at line 293 of file Harvester.php.

Referenced by ILIAS\MetaData\OERHarvester\Harvester\updateExposedRecords().

                                                                  : string
     {
         return 'il__' . $type . '_' . $obj_id;
     }

Here is the caller graph for this function:

◆ deleteDeprecatedReferences()

ILIAS\MetaData\OERHarvester\Harvester::deleteDeprecatedReferences	(	array	$harvestable_obj_ids,
		array	$currently_harvested_obj_ids
	)

protected

Returns number of deletions.

Parameters

int[]	$harvestable_obj_ids
int[]	$currently_harvested_obj_ids

Definition at line 133 of file Harvester.php.

References Vendor\Package\$e, $ref_id, ILIAS\MetaData\OERHarvester\Harvester\logDebug(), and ILIAS\MetaData\OERHarvester\Harvester\logError().

Referenced by ILIAS\MetaData\OERHarvester\Harvester\run().

      : int {
         $count = 0;
         foreach ($currently_harvested_obj_ids as $obj_id) {
             if (in_array($obj_id, $harvestable_obj_ids)) {
                 continue;
             }
 
             $ref_id = $this->status_repository->getHarvestRefID($obj_id);
             $this->logDebug('Deleting deprecated object with ref_id: ' . $ref_id);
             try {
                 $this->object_handler->deleteReference($ref_id);
             } catch (\Exception $e) {
                 $this->logError(
                     'Error when deleting harvested reference with ref_id ' .
                     $ref_id . ': ' . $e->getMessage()
                 );
                 continue;
             }
             $this->status_repository->deleteHarvestRefID($obj_id);
             $count++;
         }
         return $count;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findHarvestableObjectIDs()

ILIAS\MetaData\OERHarvester\Harvester::findHarvestableObjectIDs ( )

protected

Definition at line 102 of file Harvester.php.

References $results, and ILIAS\Repository\settings().

Referenced by ILIAS\MetaData\OERHarvester\Harvester\run().

                                                  : array
     {
         $searcher = $this->copyright_search_factory->get()
                                                    ->withRestrictionToRepositoryObjects(true);
         foreach ($this->settings->getObjectTypesSelectedForHarvesting() as $type) {
             $searcher = $searcher->withAdditionalTypeFilter($type);
         }
         $search_results = [];
         foreach ($searcher->search(
             $this->lom_repository,
             ...$this->settings->getCopyrightEntryIDsSelectedForHarvesting()
         ) as $ressource_id) {
             $search_results[] = $ressource_id->objID();
         }
 
         $unblocked = $this->status_repository->filterOutBlockedObjects(...$search_results);
         $results = [];
         foreach ($unblocked as $obj_id) {
             if ($this->object_handler->isObjectDeleted($obj_id)) {
                 continue;
             }
             $results[] = $obj_id;
         }
         return $results;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ harvestObjects()

ILIAS\MetaData\OERHarvester\Harvester::harvestObjects	(	array	$harvestable_obj_ids,
		array	$currently_harvested_obj_ids
	)

protected

Returns number of harvested objects.

Parameters

int[]	$harvestable_obj_ids
int[]	$currently_harvested_obj_ids

Definition at line 165 of file Harvester.php.

References Vendor\Package\$e, ILIAS\MetaData\OERHarvester\Harvester\logDebug(), ILIAS\MetaData\OERHarvester\Harvester\logError(), and ILIAS\Repository\settings().

Referenced by ILIAS\MetaData\OERHarvester\Harvester\run().

      : int {
         $count = 0;
 
         $target_ref_id = $this->settings->getContainerRefIDForHarvesting();
         if (!$target_ref_id) {
             return 0;
         }
 
         foreach ($harvestable_obj_ids as $obj_id) {
             if (in_array($obj_id, $currently_harvested_obj_ids)) {
                 continue;
             }
 
             $this->logDebug('Creating new reference for object with obj_id: ' . $obj_id);
             try {
                 $new_ref_id = $this->object_handler->referenceObjectInTargetContainer(
                     $obj_id,
                     $target_ref_id
                 );
             } catch (\Exception $e) {
                 $this->logError(
                     'Error when creating reference for object with obj_id ' .
                     $obj_id . ': ' . $e->getMessage()
                 );
                 continue;
             }
             $this->status_repository->setHarvestRefID($obj_id, $new_ref_id);
 
             try {
                 if (!$this->export_handler->hasPublicAccessExport($obj_id)) {
                     $this->export_handler->createPublicAccessExport($obj_id);
                 }
             } catch (\Exception $e) {
                 $this->logError(
                     'Error when creating export for object with obj_id ' .
                     $obj_id . ': ' . $e->getMessage()
                 );
             }
 
             $count++;
         }
         return $count;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ logDebug()

ILIAS\MetaData\OERHarvester\Harvester::logDebug ( string $message )

protected

Definition at line 283 of file Harvester.php.

References ILIAS\Repository\logger().

Referenced by ILIAS\MetaData\OERHarvester\Harvester\deleteDeprecatedReferences(), ILIAS\MetaData\OERHarvester\Harvester\harvestObjects(), and ILIAS\MetaData\OERHarvester\Harvester\updateExposedRecords().

                                                 : void
     {
         $this->logger->debug($message);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ logError()

ILIAS\MetaData\OERHarvester\Harvester::logError ( string $message )

protected

Definition at line 288 of file Harvester.php.

References ILIAS\Repository\logger().

Referenced by ILIAS\MetaData\OERHarvester\Harvester\deleteDeprecatedReferences(), and ILIAS\MetaData\OERHarvester\Harvester\harvestObjects().

                                                 : void
     {
         $this->logger->error($message);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run()

ILIAS\MetaData\OERHarvester\Harvester::run ( Result $result )

Definition at line 67 of file Harvester.php.

References Vendor\Package\$e, $messages, ILIAS\MetaData\OERHarvester\Harvester\deleteDeprecatedReferences(), ILIAS\MetaData\OERHarvester\Harvester\findHarvestableObjectIDs(), ILIAS\MetaData\OERHarvester\Harvester\harvestObjects(), and ILIAS\MetaData\OERHarvester\Harvester\updateExposedRecords().

                                        : Result
     {
         try {
             $messages = [];
 
             $harvestable_obj_ids = $this->findHarvestableObjectIDs();
             $currently_harvested_obj_ids = iterator_to_array($this->status_repository->getAllHarvestedObjIDs());
 
             $deletion_count = $this->deleteDeprecatedReferences(
                 $harvestable_obj_ids,
                 $currently_harvested_obj_ids
             );
             $messages[] = 'Deleted ' . $deletion_count . ' deprecated references.';
             $harvest_count = $this->harvestObjects(
                 $harvestable_obj_ids,
                 $currently_harvested_obj_ids
             );
             $messages[] = 'Created ' . $harvest_count . ' new references.';
             $exposure_count = $this->updateExposedRecords(
                 $harvestable_obj_ids
             );
             $messages[] = 'Created, updated, or deleted ' . $exposure_count . ' exposed records.';
 
             if ($deletion_count !== 0 || $harvest_count !== 0 || $exposure_count !== 0) {
                 $result = $result->withStatus(\ILIAS\Cron\Job\JobResult::STATUS_OK);
             } else {
                 $result = $result->withStatus(\ILIAS\Cron\Job\JobResult::STATUS_NO_ACTION);
             }
             return $result->withMessage(implode('<br>', $messages));
         } catch (\Exception $e) {
             return $result->withStatus(\ILIAS\Cron\Job\JobResult::STATUS_FAIL)
                           ->withMessage($e->getMessage());
         }
     }

Here is the call graph for this function:

◆ updateExposedRecords()

ILIAS\MetaData\OERHarvester\Harvester::updateExposedRecords ( array $harvestable_obj_ids )

protected

Returns number of changed exposed records.

Parameters

int[] $harvestable_obj_ids

Definition at line 216 of file Harvester.php.

References $ref_id, ILIAS\MetaData\OERHarvester\Harvester\buildIdentifier(), ILIAS\MetaData\OERHarvester\Harvester\logDebug(), and ILIAS\Repository\settings().

Referenced by ILIAS\MetaData\OERHarvester\Harvester\run().

      : int {
         $count = 0;
 
         $source_ref_id = $this->settings->getContainerRefIDForExposing();
         if (!$source_ref_id) {
             return 0;
         }
 
         $already_exposed = [];
         foreach ($this->exposed_record_repository->getRecords() as $record) {
             $obj_id = $record->infos()->objID();
             $already_exposed[] = $obj_id;
 
             $ref_id = $this->object_handler->getObjectReferenceIDInContainer($obj_id, $source_ref_id);
 
             if (!in_array($obj_id, $harvestable_obj_ids) || is_null($ref_id)) {
                 $this->logDebug('Deleting exposed record for object with obj_id: ' . $obj_id);
                 $this->exposed_record_repository->deleteRecord($obj_id);
                 $count++;
                 continue;
             }
 
             $simple_dc_xml = $this->xml_writer->writeSimpleDCMetaData(
                 $obj_id,
                 $ref_id,
                 $this->object_handler->getTypeOfReferencedObject($ref_id)
             );
 
             if ($simple_dc_xml->saveXML() !== $record->metadata()->saveXML()) {
                 $this->logDebug('Updating exposed record for object with obj_id: ' . $obj_id);
                 $this->exposed_record_repository->updateRecord($obj_id, $simple_dc_xml);
                 $count++;
             }
         }
 
         foreach ($harvestable_obj_ids as $obj_id) {
             if (in_array($obj_id, $already_exposed)) {
                 continue;
             }
 
             $ref_id = $this->object_handler->getObjectReferenceIDInContainer($obj_id, $source_ref_id);
             if (is_null($ref_id)) {
                 continue;
             }
 
             $type = $this->object_handler->getTypeOfReferencedObject($ref_id);
 
             $simple_dc_xml = $this->xml_writer->writeSimpleDCMetaData(
                 $obj_id,
                 $ref_id,
                 $type
             );
 
             $this->logDebug('Creating exposed record for object with obj_id: ' . $obj_id);
             $this->exposed_record_repository->createRecord(
                 $obj_id,
                 $this->buildIdentifier($obj_id, $type),
                 $simple_dc_xml
             );
             $count++;
         }
 
         return $count;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $copyright_search_factory

CopyrightSearchFactory ILIAS\MetaData\OERHarvester\Harvester::$copyright_search_factory

protected

Definition at line 40 of file Harvester.php.

Referenced by ILIAS\MetaData\OERHarvester\Harvester\__construct().

◆ $export_handler

ExportHandler ILIAS\MetaData\OERHarvester\Harvester::$export_handler

protected

Definition at line 37 of file Harvester.php.

Referenced by ILIAS\MetaData\OERHarvester\Harvester\__construct().

◆ $exposed_record_repository

ExposedRecordRepository ILIAS\MetaData\OERHarvester\Harvester::$exposed_record_repository

protected

Definition at line 39 of file Harvester.php.

Referenced by ILIAS\MetaData\OERHarvester\Harvester\__construct().

◆ $logger

ilLogger ILIAS\MetaData\OERHarvester\Harvester::$logger

protected

Definition at line 43 of file Harvester.php.

Referenced by ILIAS\MetaData\OERHarvester\Harvester\__construct().

◆ $lom_repository

LOMRepository ILIAS\MetaData\OERHarvester\Harvester::$lom_repository

protected

Definition at line 41 of file Harvester.php.

Referenced by ILIAS\MetaData\OERHarvester\Harvester\__construct().

◆ $object_handler

ObjectHandler ILIAS\MetaData\OERHarvester\Harvester::$object_handler

protected

Definition at line 36 of file Harvester.php.

Referenced by ILIAS\MetaData\OERHarvester\Harvester\__construct().

◆ $settings

SettingsInterface ILIAS\MetaData\OERHarvester\Harvester::$settings

protected

Definition at line 35 of file Harvester.php.

Referenced by ILIAS\MetaData\OERHarvester\Harvester\__construct().

◆ $status_repository

StatusRepository ILIAS\MetaData\OERHarvester\Harvester::$status_repository

protected

Definition at line 38 of file Harvester.php.

Referenced by ILIAS\MetaData\OERHarvester\Harvester\__construct().

◆ $xml_writer

SimpleDCXMLWriter ILIAS\MetaData\OERHarvester\Harvester::$xml_writer

protected

Definition at line 42 of file Harvester.php.

Referenced by ILIAS\MetaData\OERHarvester\Harvester\__construct().

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

components/ILIAS/MetaData/classes/OERHarvester/Harvester.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildIdentifier()

◆ deleteDeprecatedReferences()

◆ findHarvestableObjectIDs()

◆ harvestObjects()

◆ logDebug()

◆ logError()

◆ run()

◆ updateExposedRecords()

Field Documentation

◆ $copyright_search_factory

◆ $export_handler

◆ $exposed_record_repository

◆ $logger

◆ $lom_repository

◆ $object_handler

◆ $settings

◆ $status_repository

◆ $xml_writer