ILIAS\MetaData\Services\ServicesInterface Interface Reference

Inheritance diagram for ILIAS\MetaData\Services\ServicesInterface:

Collaboration diagram for ILIAS\MetaData\Services\ServicesInterface:

Public Member Functions
	read (int $obj_id, int $sub_id, string $type, ?PathInterface $limited_to=null)
	Get a reader, which can read out LOM of an ILIAS object. More...
	search ()
	Get a searcher, in which you can assemble a search clause and filters, and use these to find objects whose LOM matches the search. More...
	manipulate (int $obj_id, int $sub_id, string $type)
	Get a manipulator, which can manipulate the LOM of an ILIAS object. More...
	derive ()
	Derives LOM from a target, for a source. More...
	deleteAll (int $obj_id, int $sub_id, string $type)
	Delete all LOM of an ILIAS object. More...
	paths ()
	Elements in LOM are identified by paths to them from the root. More...
	dataHelper ()
	The data carried by many LOM elements is in LOM-specific formats. More...
	copyrightHelper ()
	The LOM of an object also contains its copyright information, which might consist of a reference to a preset copyright. More...

Detailed Description

Definition at line 32 of file ServicesInterface.php.

Member Function Documentation

copyrightHelper()

ILIAS\MetaData\Services\ServicesInterface::copyrightHelper

(

)

The LOM of an object also contains its copyright information, which might consist of a reference to a preset copyright.

This helper offers some infrastructure to parse and manipulate copyright information of objects, to access the copyright presets, and to search and filter objects by copyright.

Implemented in ILIAS\MetaData\Services\Services.

dataHelper()

ILIAS\MetaData\Services\ServicesInterface::dataHelper

(

)

The data carried by many LOM elements is in LOM-specific formats.

Get a collection of helpful translations from or to these formats.

Implemented in ILIAS\MetaData\Services\Services.

deleteAll()

ILIAS\MetaData\Services\ServicesInterface::deleteAll	(	int	$obj_id,
		int	$sub_id,
		string	$type
	)

Delete all LOM of an ILIAS object.

See {

See also

::read()} for a description of the parameters.

Implemented in ILIAS\MetaData\Services\Services.

derive()

ILIAS\MetaData\Services\ServicesInterface::derive

(

)

Derives LOM from a target, for a source.

Encompasses both copying LOM between ILIAS objects and creating LOM for an object from some basic properties.

Implemented in ILIAS\MetaData\Services\Services.

manipulate()

ILIAS\MetaData\Services\ServicesInterface::manipulate	(	int	$obj_id,
		int	$sub_id,
		string	$type
	)

Get a manipulator, which can manipulate the LOM of an ILIAS object.

See {

See also

::read()} for a description of the parameters.

Implemented in ILIAS\MetaData\Services\Services.

paths()

ILIAS\MetaData\Services\ServicesInterface::paths

(

)

Elements in LOM are identified by paths to them from the root.

Get a collection of frequently used paths, as well as a builder to construct custom ones.

Implemented in ILIAS\MetaData\Services\Services.

read()

ILIAS\MetaData\Services\ServicesInterface::read	(	int	$obj_id,
		int	$sub_id,
		string	$type,
		?PathInterface	$limited_to = null
	)

Get a reader, which can read out LOM of an ILIAS object.

The object is specified with three parameters:

1. obj_id: The obj_id of the object if it is a repository object, else the obj_id of its parent repository object. If the object does not have a fixed parent (e.g. MediaObject), then this parameter is 0.
2. sub_id: The obj_id of the object. If the object is a repository object by itself and not a sub-object, then you can set this parameter to 0, but we recommend passing the obj_id again.
3. type: The type of the object (and not its parent's), e.g. 'crs' or 'lm'.

Optionally, a path can be specified to which the reading is restricted: the reader will then only have access to elements on the path, along with recursively all sub-elements of the last element of the path. 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.

Implemented in ILIAS\MetaData\Services\Services.

search()

ILIAS\MetaData\Services\ServicesInterface::search

(

)

Get a searcher, in which you can assemble a search clause and filters, and use these to find objects whose LOM matches the search.

Implemented in ILIAS\MetaData\Services\Services.

---

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

• components/ILIAS/MetaData/classes/Services/ServicesInterface.php