ILIAS\MetaData\OERHarvester\Publisher\Publisher Class Reference

Inheritance diagram for ILIAS\MetaData\OERHarvester\Publisher\Publisher:

Collaboration diagram for ILIAS\MetaData\OERHarvester\Publisher\Publisher:

Public Member Functions
	__construct (protected ExposedRecordsRepository $exposed_repo, protected ResourceStatusRepository $status_repo, protected RepoObjectHandler $repo_object_handler, protected ExportHandler $export_handler, protected PublishingSettings $publishing_settings, protected SimpleDCXMLWriter $xml_writer, protected ilAccess $access)
	block (int $obj_id)
	checkPermissionsForBlock (int $ref_id, string $type, int $obj_id)
	unblock (int $obj_id)
	checkPermissionsForUnblock (int $ref_id, string $type, int $obj_id)
	publish (int $obj_id, string $type)
	checkPermissionsForPublish (int $ref_id, string $type, int $obj_id)
	withdraw (int $obj_id)
	checkPermissionsForWithdraw (int $ref_id, string $type, int $obj_id)
	submit (int $obj_id)
	checkPermissionsForSubmit (int $ref_id, string $type, int $obj_id)
	accept (int $obj_id, string $type)
	checkPermissionsForAccept (int $ref_id, string $type, int $obj_id)
	reject (int $obj_id)
	checkPermissionsForReject (int $ref_id, string $type, int $obj_id)
	block (int $obj_id)
	checkPermissionsForBlock (int $ref_id, string $type, int $obj_id)
	unblock (int $obj_id)
	checkPermissionsForUnblock (int $ref_id, string $type, int $obj_id)
	publish (int $obj_id, string $type)
	checkPermissionsForPublish (int $ref_id, string $type, int $obj_id)
	withdraw (int $obj_id)
	checkPermissionsForWithdraw (int $ref_id, string $type, int $obj_id)
	submit (int $obj_id)
	checkPermissionsForSubmit (int $ref_id, string $type, int $obj_id)
	accept (int $obj_id, string $type)
	checkPermissionsForAccept (int $ref_id, string $type, int $obj_id)
	reject (int $obj_id)
	checkPermissionsForReject (int $ref_id, string $type, int $obj_id)

Protected Member Functions
	harvestObject (int $obj_id, int $target_ref_id)
	publishObjectToOAIPMH (int $obj_id, string $type, int $ref_id)
	deleteReferenceIfOthersExist (int $ref_id)
	buildIdentifier (int $obj_id, string $type)

Detailed Description

Definition at line 32 of file Publisher.php.

Constructor & Destructor Documentation

__construct()

ILIAS\MetaData\OERHarvester\Publisher\Publisher::__construct	(	protected ExposedRecordsRepository	$exposed_repo,
		protected ResourceStatusRepository	$status_repo,
		protected RepoObjectHandler	$repo_object_handler,
		protected ExportHandler	$export_handler,
		protected PublishingSettings	$publishing_settings,
		protected SimpleDCXMLWriter	$xml_writer,
		protected ilAccess	$access
	)

Definition at line 34 of file Publisher.php.

      {
    }

Member Function Documentation

accept()

ILIAS\MetaData\OERHarvester\Publisher\Publisher::accept	(	int	$obj_id,
		string	$type
	)

Implements ILIAS\MetaData\OERHarvester\Publisher\PublisherInterface.

Definition at line 112 of file Publisher.php.

                                                     : void
    {
        $harvested_ref_id = $this->status_repo->getHarvestRefID($obj_id);
 
        $publishing_ref_id = $this->publishing_settings->getContainerRefIDForPublishing();
        $ref_id_in_publishing = $this->repo_object_handler->referenceObjectInTargetContainer($obj_id, $publishing_ref_id);
        $this->status_repo->setHarvestRefID($obj_id, $ref_id_in_publishing);
 
        $this->deleteReferenceIfOthersExist($harvested_ref_id);
 
        $this->publishObjectToOAIPMH($obj_id, $type, $ref_id_in_publishing);
    }

References ILIAS\MetaData\OERHarvester\Publisher\Publisher\deleteReferenceIfOthersExist(), and ILIAS\MetaData\OERHarvester\Publisher\Publisher\publishObjectToOAIPMH().

Here is the call graph for this function:

block()

ILIAS\MetaData\OERHarvester\Publisher\Publisher::block

(

int

$obj_id

)

Implements ILIAS\MetaData\OERHarvester\Publisher\PublisherInterface.

Definition at line 45 of file Publisher.php.

                                      : void
    {
        $this->status_repo->setHarvestingBlocked($obj_id, true);
    }

Referenced by ILIAS\MetaData\OERHarvester\Publisher\Publisher\reject(), and ILIAS\MetaData\OERHarvester\Publisher\Publisher\withdraw().

Here is the caller graph for this function:

buildIdentifier()

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

protected

Definition at line 196 of file Publisher.php.

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

Referenced by ILIAS\MetaData\OERHarvester\Publisher\Publisher\publishObjectToOAIPMH().

Here is the caller graph for this function:

checkPermissionsForAccept()

ILIAS\MetaData\OERHarvester\Publisher\Publisher::checkPermissionsForAccept	(	int	$ref_id,
		string	$type,
		int	$obj_id
	)

Implements ILIAS\MetaData\OERHarvester\Publisher\PublisherInterface.

Definition at line 125 of file Publisher.php.

                                                                                     : bool
    {
        $publishing_ref_id = $this->publishing_settings->getContainerRefIDForPublishing();
        $harvested_ref_id = $this->status_repo->getHarvestRefID($obj_id);
        return $this->access->checkAccess('write', '', $ref_id, $type, $obj_id) &&
            $this->access->checkAccess('delete', '', $harvested_ref_id, $type, $obj_id) &&
            $this->access->checkAccess('create_' . $type, '', $publishing_ref_id);
    }

References ILIAS\Repository\access().

Here is the call graph for this function:

checkPermissionsForBlock()

ILIAS\MetaData\OERHarvester\Publisher\Publisher::checkPermissionsForBlock	(	int	$ref_id,
		string	$type,
		int	$obj_id
	)

Implements ILIAS\MetaData\OERHarvester\Publisher\PublisherInterface.

Definition at line 50 of file Publisher.php.

                                                                                    : bool
    {
        return $this->access->checkAccess('write', '', $ref_id, $type, $obj_id);
    }

References ILIAS\Repository\access().

Here is the call graph for this function:

checkPermissionsForPublish()

ILIAS\MetaData\OERHarvester\Publisher\Publisher::checkPermissionsForPublish	(	int	$ref_id,
		string	$type,
		int	$obj_id
	)

Implements ILIAS\MetaData\OERHarvester\Publisher\PublisherInterface.

Definition at line 72 of file Publisher.php.

                                                                                      : bool
    {
        $target_ref_id = $this->publishing_settings->getContainerRefIDForPublishing();
        return $this->access->checkAccess('write', '', $ref_id, $type, $obj_id) &&
            $this->access->checkAccess('create_' . $type, '', $target_ref_id);
    }

References ILIAS\Repository\access().

Here is the call graph for this function:

checkPermissionsForReject()

ILIAS\MetaData\OERHarvester\Publisher\Publisher::checkPermissionsForReject	(	int	$ref_id,
		string	$type,
		int	$obj_id
	)

Implements ILIAS\MetaData\OERHarvester\Publisher\PublisherInterface.

Definition at line 145 of file Publisher.php.

                                                                                     : bool
    {
        $harvested_ref_id = $this->status_repo->getHarvestRefID($obj_id);
        return $this->access->checkAccess('write', '', $ref_id, $type, $obj_id) &&
            $this->access->checkAccess('delete', '', $harvested_ref_id, $type, $obj_id);
    }

References ILIAS\Repository\access().

Here is the call graph for this function:

checkPermissionsForSubmit()

ILIAS\MetaData\OERHarvester\Publisher\Publisher::checkPermissionsForSubmit	(	int	$ref_id,
		string	$type,
		int	$obj_id
	)

Implements ILIAS\MetaData\OERHarvester\Publisher\PublisherInterface.

Definition at line 105 of file Publisher.php.

                                                                                     : bool
    {
        $target_ref_id = $this->publishing_settings->getContainerRefIDForEditorialStep();
        return $this->access->checkAccess('write', '', $ref_id, $type, $obj_id) &&
            $this->access->checkAccess('create_' . $type, '', $target_ref_id);
    }

References ILIAS\Repository\access().

Here is the call graph for this function:

checkPermissionsForUnblock()

ILIAS\MetaData\OERHarvester\Publisher\Publisher::checkPermissionsForUnblock	(	int	$ref_id,
		string	$type,
		int	$obj_id
	)

Implements ILIAS\MetaData\OERHarvester\Publisher\PublisherInterface.

Definition at line 60 of file Publisher.php.

                                                                                      : bool
    {
        return $this->access->checkAccess('write', '', $ref_id, $type, $obj_id);
    }

References ILIAS\Repository\access().

Here is the call graph for this function:

checkPermissionsForWithdraw()

ILIAS\MetaData\OERHarvester\Publisher\Publisher::checkPermissionsForWithdraw	(	int	$ref_id,
		string	$type,
		int	$obj_id
	)

Implements ILIAS\MetaData\OERHarvester\Publisher\PublisherInterface.

Definition at line 92 of file Publisher.php.

                                                                                       : bool
    {
        $harvested_ref_id = $this->status_repo->getHarvestRefID($obj_id);
        return $this->access->checkAccess('write', '', $ref_id, $type, $obj_id) &&
            $this->access->checkAccess('delete', '', $harvested_ref_id, $type, $obj_id);
    }

References ILIAS\Repository\access().

Here is the call graph for this function:

deleteReferenceIfOthersExist()

ILIAS\MetaData\OERHarvester\Publisher\Publisher::deleteReferenceIfOthersExist ( int  $ref_id )

protected

Definition at line 188 of file Publisher.php.

                                                                : void
    {
        if ($this->repo_object_handler->isOnlyReference($ref_id)) {
            return;
        }
        $this->repo_object_handler->deleteReference($ref_id);
    }

References $ref_id.

Referenced by ILIAS\MetaData\OERHarvester\Publisher\Publisher\accept(), ILIAS\MetaData\OERHarvester\Publisher\Publisher\reject(), and ILIAS\MetaData\OERHarvester\Publisher\Publisher\withdraw().

Here is the caller graph for this function:

harvestObject()

ILIAS\MetaData\OERHarvester\Publisher\Publisher::harvestObject ( int  $obj_id, int  $target_ref_id  )

protected

Definition at line 152 of file Publisher.php.

                                                                     : int
    {
        $new_ref_id = $this->repo_object_handler->referenceObjectInTargetContainer(
            $obj_id,
            $target_ref_id
        );
        $this->status_repo->setHarvestRefID($obj_id, $new_ref_id);
 
        if (!$this->export_handler->hasPublicAccessExport($obj_id)) {
            $this->export_handler->createPublicAccessExport($obj_id);
        }
        return $new_ref_id;
    }

Referenced by ILIAS\MetaData\OERHarvester\Publisher\Publisher\publish(), and ILIAS\MetaData\OERHarvester\Publisher\Publisher\submit().

Here is the caller graph for this function:

publish()

ILIAS\MetaData\OERHarvester\Publisher\Publisher::publish	(	int	$obj_id,
		string	$type
	)

Implements ILIAS\MetaData\OERHarvester\Publisher\PublisherInterface.

Definition at line 65 of file Publisher.php.

                                                      : void
    {
        $target_ref_id = $this->publishing_settings->getContainerRefIDForPublishing();
        $new_ref_id = $this->harvestObject($obj_id, $target_ref_id);
        $this->publishObjectToOAIPMH($obj_id, $type, $new_ref_id);
    }

References ILIAS\MetaData\OERHarvester\Publisher\Publisher\harvestObject(), and ILIAS\MetaData\OERHarvester\Publisher\Publisher\publishObjectToOAIPMH().

Here is the call graph for this function:

publishObjectToOAIPMH()

ILIAS\MetaData\OERHarvester\Publisher\Publisher::publishObjectToOAIPMH ( int  $obj_id, string  $type, int  $ref_id  )

protected

Definition at line 166 of file Publisher.php.

                                                                                    : void
    {
        $simple_dc_xml = $this->xml_writer->writeSimpleDCMetaData(
            $obj_id,
            $ref_id,
            $type
        );
        if ($this->exposed_repo->doesRecordExistForObjID($obj_id)) {
            $this->exposed_repo->updateRecord(
                $obj_id,
                false,
                $simple_dc_xml
            );
        } else {
            $this->exposed_repo->createRecord(
                $obj_id,
                $this->buildIdentifier($obj_id, $type),
                $simple_dc_xml
            );
        }
    }

References $ref_id, and ILIAS\MetaData\OERHarvester\Publisher\Publisher\buildIdentifier().

Referenced by ILIAS\MetaData\OERHarvester\Publisher\Publisher\accept(), and ILIAS\MetaData\OERHarvester\Publisher\Publisher\publish().

Here is the call graph for this function:

Here is the caller graph for this function:

reject()

ILIAS\MetaData\OERHarvester\Publisher\Publisher::reject

(

int

$obj_id

)

Implements ILIAS\MetaData\OERHarvester\Publisher\PublisherInterface.

Definition at line 134 of file Publisher.php.

                                       : void
    {
        $ref_id = $this->status_repo->getHarvestRefID($obj_id);
        $this->deleteReferenceIfOthersExist($ref_id);
        $this->status_repo->deleteHarvestRefID($obj_id);
 
        if ($this->publishing_settings->isAutomaticPublishingEnabled()) {
            $this->block($obj_id);
        }
    }

References $ref_id, ILIAS\MetaData\OERHarvester\Publisher\Publisher\block(), and ILIAS\MetaData\OERHarvester\Publisher\Publisher\deleteReferenceIfOthersExist().

Here is the call graph for this function:

submit()

ILIAS\MetaData\OERHarvester\Publisher\Publisher::submit

(

int

$obj_id

)

Implements ILIAS\MetaData\OERHarvester\Publisher\PublisherInterface.

Definition at line 99 of file Publisher.php.

                                       : void
    {
        $target_ref_id = $this->publishing_settings->getContainerRefIDForEditorialStep();
        $this->harvestObject($obj_id, $target_ref_id);
    }

References ILIAS\MetaData\OERHarvester\Publisher\Publisher\harvestObject().

Here is the call graph for this function:

unblock()

ILIAS\MetaData\OERHarvester\Publisher\Publisher::unblock

(

int

$obj_id

)

Implements ILIAS\MetaData\OERHarvester\Publisher\PublisherInterface.

Definition at line 55 of file Publisher.php.

                                        : void
    {
        $this->status_repo->setHarvestingBlocked($obj_id, false);
    }

withdraw()

ILIAS\MetaData\OERHarvester\Publisher\Publisher::withdraw

(

int

$obj_id

)

Implements ILIAS\MetaData\OERHarvester\Publisher\PublisherInterface.

Definition at line 79 of file Publisher.php.

                                         : void
    {
        $this->exposed_repo->updateRecord($obj_id, true, null);
 
        $ref_id = $this->status_repo->getHarvestRefID($obj_id);
        $this->deleteReferenceIfOthersExist($ref_id);
        $this->status_repo->deleteHarvestRefID($obj_id);
 
        if ($this->publishing_settings->isAutomaticPublishingEnabled()) {
            $this->block($obj_id);
        }
    }

References $ref_id, ILIAS\MetaData\OERHarvester\Publisher\Publisher\block(), and ILIAS\MetaData\OERHarvester\Publisher\Publisher\deleteReferenceIfOthersExist().

Here is the call graph for this function:

---

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

• components/ILIAS/MetaData/classes/OERHarvester/Publisher/Publisher.php