ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelperInterface Interface Reference

Inheritance diagram for ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelperInterface:

Collaboration diagram for ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelperInterface:

Public Member Functions
	isCopyrightSelectionActive ()
	If copyright selection is not active, there are no copyright presets to choose from, but copyright information can still be added manually to the LOM of objects. More...
	hasPresetCopyright (ReaderInterface $reader)
	Is the copyright in the LOM of the reader's object selected from the presets? If not, custom copyright information was entered manually. More...
	readPresetCopyright (ReaderInterface $reader)
	If possible, returns the preset copyright selected for the reader's object. More...
	readCustomCopyright (ReaderInterface $reader)
	Returns the custom copyright information from the LOM of the reader's object. More...
	prepareCreateOrUpdateOfCopyrightFromPreset (ManipulatorInterface $manipulator, string $copyright_id)
	The preset copyright with the given identifier is set to be selected for the manipulator's object. More...
	prepareCreateOrUpdateOfCustomCopyright (ManipulatorInterface $manipulator, string $custom_copyright)
	The given copyright information is set to be written to the LOM of the manipulator's object. More...
	getAllCopyrightPresets ()
	Returns all preset copyright entries, or nothing if copyright selection is not active. More...
	getNonOutdatedCopyrightPresets ()
	Returns all preset copyright entries that are not marked as outdated, or nothing if copyright selection is not active. More...
	getCopyrightSearchClause (string $first_copyright_id, string ... $further_copyright_ids)
	Get a search clause that finds object with one of the given copyright entries in their LOM, to be used in {. More...

Detailed Description

Definition at line 27 of file CopyrightHelperInterface.php.

Member Function Documentation

getAllCopyrightPresets()

ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelperInterface::getAllCopyrightPresets

(

)

Returns all preset copyright entries, or nothing if copyright selection is not active.

Returned entries are ordered according to their configured positions.

Returns

CopyrightInterface[]

Implemented in ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper, and ILIAS\MetaData\Services\CopyrightHelper\NullCopyrightHelper.

getCopyrightSearchClause()

ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelperInterface::getCopyrightSearchClause	(	string	$first_copyright_id,
		string ...	$further_copyright_ids
	)

Get a search clause that finds object with one of the given copyright entries in their LOM, to be used in {.

See also

::execute()}.

If copyright selection is active, objects without any copyright information are treated as if they had the default copyright.

Implemented in ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper, and ILIAS\MetaData\Services\CopyrightHelper\NullCopyrightHelper.

getNonOutdatedCopyrightPresets()

ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelperInterface::getNonOutdatedCopyrightPresets

(

)

Returns all preset copyright entries that are not marked as outdated, or nothing if copyright selection is not active.

Returned entries are ordered according to their configured positions.

Returns

CopyrightInterface[]

Implemented in ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper, and ILIAS\MetaData\Services\CopyrightHelper\NullCopyrightHelper.

hasPresetCopyright()

ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelperInterface::hasPresetCopyright

(

ReaderInterface

$reader

)

Is the copyright in the LOM of the reader's object selected from the presets? If not, custom copyright information was entered manually.

If no copyright is assigned to the object, it is treated like it has the default copyright licence, and true is returned here.

Always returns false if copyright selection is not active.

Implemented in ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper, and ILIAS\MetaData\Services\CopyrightHelper\NullCopyrightHelper.

isCopyrightSelectionActive()

ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelperInterface::isCopyrightSelectionActive

(

)

If copyright selection is not active, there are no copyright presets to choose from, but copyright information can still be added manually to the LOM of objects.

Implemented in ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper, and ILIAS\MetaData\Services\CopyrightHelper\NullCopyrightHelper.

prepareCreateOrUpdateOfCopyrightFromPreset()

ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelperInterface::prepareCreateOrUpdateOfCopyrightFromPreset	(	ManipulatorInterface	$manipulator,
		string	$copyright_id
	)

The preset copyright with the given identifier is set to be selected for the manipulator's object.

Note that this will also overwrite custom copyright information.

Call {

See also

::execute()} to carry out the changes.

Implemented in ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper, and ILIAS\MetaData\Services\CopyrightHelper\NullCopyrightHelper.

prepareCreateOrUpdateOfCustomCopyright()

ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelperInterface::prepareCreateOrUpdateOfCustomCopyright	(	ManipulatorInterface	$manipulator,
		string	$custom_copyright
	)

The given copyright information is set to be written to the LOM of the manipulator's object.

Note that this will also overwrite any selected preset copyright.

Call {

See also

::execute()} to carry out the changes.

Implemented in ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper, and ILIAS\MetaData\Services\CopyrightHelper\NullCopyrightHelper.

readCustomCopyright()

ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelperInterface::readCustomCopyright

(

ReaderInterface

$reader

)

Returns the custom copyright information from the LOM of the reader's object.

If copyright selection is inactive, or one of the preset copyright options was selected for the object, this returns an empty string.

Implemented in ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper, and ILIAS\MetaData\Services\CopyrightHelper\NullCopyrightHelper.

readPresetCopyright()

ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelperInterface::readPresetCopyright

(

ReaderInterface

$reader

)

If possible, returns the preset copyright selected for the reader's object.

For objects which have no copyright information in their LOM, the default copyright is returned (as long as copyright selection is active).

Returns a null object if copyright selection is not active, or if the object has custom copyright information.

Implemented in ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper, and ILIAS\MetaData\Services\CopyrightHelper\NullCopyrightHelper.

---

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

• components/ILIAS/MetaData/classes/Services/CopyrightHelper/CopyrightHelperInterface.php