ILIAS\MetaData\Services\Services Class Reference

Inheritance diagram for ILIAS\MetaData\Services\Services:

Collaboration diagram for ILIAS\MetaData\Services\Services:

Public Member Functions
	__construct (GlobalContainer $dic)
	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...

Protected Member Functions
	readerFactory ()
	manipulatorFactory ()
	repository ()

Protected Attributes
InternalServices	$internal_services
ReaderFactoryInterface	$reader_factory
ManipulatorFactoryInterface	$manipulator_factory
PathsInterface	$paths
DataHelperInterface	$data_helper
SourceSelectorInterface	$derivation_source_selector
SearcherInterface	$searcher
CopyrightHelperInterface	$copyright_helper

Detailed Description

Definition at line 49 of file Services.php.

Constructor & Destructor Documentation

__construct()

ILIAS\MetaData\Services\Services::__construct

(

GlobalContainer

$dic

)

Definition at line 61 of file Services.php.

    {
        $this->internal_services = new InternalServices($dic);
    }

Member Function Documentation

copyrightHelper()

ILIAS\MetaData\Services\Services::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.

Implements ILIAS\MetaData\Services\ServicesInterface.

Definition at line 154 of file Services.php.

References ILIAS\MetaData\Services\Services\$copyright_helper, and ilMDSettings\_getInstance().

                                     : CopyrightHelperInterface
    {
        if (isset($this->copyright_helper)) {
            return $this->copyright_helper;
        }
        return $this->copyright_helper = new CopyrightHelper(
            \ilMDSettings::_getInstance(),
            $this->internal_services->paths()->pathFactory(),
            $this->internal_services->copyright()->repository(),
            $this->internal_services->copyright()->identifiersHandler(),
            $this->internal_services->copyright()->renderer(),
            $this->internal_services->search()->searchClauseFactory()
        );
    }

Here is the call graph for this function:

dataHelper()

ILIAS\MetaData\Services\Services::dataHelper

(

)

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

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

Implements ILIAS\MetaData\Services\ServicesInterface.

Definition at line 143 of file Services.php.

References ILIAS\MetaData\Services\Services\$data_helper.

                                : DataHelperInterface
    {
        if (isset($this->data_helper)) {
            return $this->data_helper;
        }
        return $this->data_helper = new DataHelper(
            $this->internal_services->dataHelper()->dataHelper(),
            $this->internal_services->presentation()->data()
        );
    }

deleteAll()

ILIAS\MetaData\Services\Services::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.

Implements ILIAS\MetaData\Services\ServicesInterface.

Definition at line 123 of file Services.php.

References ILIAS\MetaData\Services\Services\repository().

                                                                     : void
    {
        if ($sub_id === 0) {
            $sub_id = $obj_id;
        }

        $repo = $this->repository();
        $repo->deleteAllMD($obj_id, $sub_id, $type);
    }

Here is the call graph for this function:

derive()

ILIAS\MetaData\Services\Services::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.

Implements ILIAS\MetaData\Services\ServicesInterface.

Definition at line 108 of file Services.php.

References ILIAS\MetaData\Services\Services\$derivation_source_selector.

                            : SourceSelectorInterface
    {
        if (isset($this->derivation_source_selector)) {
            return $this->derivation_source_selector;
        }
        return $this->derivation_source_selector = new SourceSelector(
            $this->internal_services->repository()->repository(),
            new Creator(
                $this->internal_services->manipulator()->manipulator(),
                $this->internal_services->paths()->pathFactory(),
                $this->internal_services->manipulator()->scaffoldProvider()
            )
        );
    }

manipulate()

ILIAS\MetaData\Services\Services::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.

Implements ILIAS\MetaData\Services\ServicesInterface.

Definition at line 97 of file Services.php.

References ILIAS\MetaData\Services\Services\manipulatorFactory(), and ILIAS\MetaData\Services\Services\repository().

                                                                      : ManipulatorInterface
    {
        if ($sub_id === 0) {
            $sub_id = $obj_id;
        }

        $repo = $this->repository();
        $set = $repo->getMD($obj_id, $sub_id, $type);
        return $this->manipulatorFactory()->get($set);
    }

Here is the call graph for this function:

manipulatorFactory()

ILIAS\MetaData\Services\Services::manipulatorFactory ( )

protected

Definition at line 179 of file Services.php.

References ILIAS\MetaData\Services\Services\$manipulator_factory.

Referenced by ILIAS\MetaData\Services\Services\manipulate().

                                           : ManipulatorFactoryInterface
    {
        if (isset($this->manipulator_factory)) {
            return $this->manipulator_factory;
        }
        return $this->manipulator_factory = new ManipulatorFactory(
            $this->internal_services->manipulator()->manipulator(),
            $this->internal_services->repository()->repository()
        );
    }

Here is the caller graph for this function:

paths()

ILIAS\MetaData\Services\Services::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.

Implements ILIAS\MetaData\Services\ServicesInterface.

Definition at line 133 of file Services.php.

References ILIAS\MetaData\Services\Services\$paths.

                           : PathsInterface
    {
        if (isset($this->paths)) {
            return $this->paths;
        }
        return $this->paths = new Paths(
            $this->internal_services->paths()->pathFactory()
        );
    }

read()

ILIAS\MetaData\Services\Services::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.

Implements ILIAS\MetaData\Services\ServicesInterface.

Definition at line 66 of file Services.php.

References ILIAS\MetaData\Services\Services\readerFactory(), and ILIAS\MetaData\Services\Services\repository().

     : ReaderInterface {
        if ($sub_id === 0) {
            $sub_id = $obj_id;
        }

        $repo = $this->repository();
        if (isset($limited_to)) {
            $set = $repo->getMDOnPath($limited_to, $obj_id, $sub_id, $type);
        } else {
            $set = $repo->getMD($obj_id, $sub_id, $type);
        }
        return $this->readerFactory()->get($set);
    }

Here is the call graph for this function:

readerFactory()

ILIAS\MetaData\Services\Services::readerFactory ( )

protected

Definition at line 169 of file Services.php.

References ILIAS\MetaData\Services\Services\$reader_factory.

Referenced by ILIAS\MetaData\Services\Services\read().

                                      : ReaderFactoryInterface
    {
        if (isset($this->reader_factory)) {
            return $this->reader_factory;
        }
        return $this->reader_factory = new ReaderFactory(
            $this->internal_services->paths()->navigatorFactory()
        );
    }

Here is the caller graph for this function:

repository()

ILIAS\MetaData\Services\Services::repository ( )

protected

Definition at line 190 of file Services.php.

Referenced by ILIAS\MetaData\Services\Services\deleteAll(), ILIAS\MetaData\Services\Services\manipulate(), and ILIAS\MetaData\Services\Services\read().

                                   : RepositoryInterface
    {
        return $this->internal_services->repository()->repository();
    }

Here is the caller graph for this function:

search()

ILIAS\MetaData\Services\Services::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.

Implements ILIAS\MetaData\Services\ServicesInterface.

Definition at line 85 of file Services.php.

References ILIAS\MetaData\Services\Services\$searcher.

                            : SearcherInterface
    {
        if (isset($this->searcher)) {
            return $this->searcher;
        }
        return $this->searcher = new Searcher(
            $this->internal_services->search()->searchClauseFactory(),
            $this->internal_services->search()->searchFilterFactory(),
            $this->internal_services->repository()->repository()
        );
    }

Field Documentation

$copyright_helper

CopyrightHelperInterface ILIAS\MetaData\Services\Services::$copyright_helper

protected

Definition at line 59 of file Services.php.

Referenced by ILIAS\MetaData\Services\Services\copyrightHelper().

$data_helper

DataHelperInterface ILIAS\MetaData\Services\Services::$data_helper

protected

Definition at line 56 of file Services.php.

Referenced by ILIAS\MetaData\Services\Services\dataHelper().

$derivation_source_selector

SourceSelectorInterface ILIAS\MetaData\Services\Services::$derivation_source_selector

protected

Definition at line 57 of file Services.php.

Referenced by ILIAS\MetaData\Services\Services\derive().

$internal_services

InternalServices ILIAS\MetaData\Services\Services::$internal_services

protected

Definition at line 51 of file Services.php.

$manipulator_factory

ManipulatorFactoryInterface ILIAS\MetaData\Services\Services::$manipulator_factory

protected

Definition at line 54 of file Services.php.

Referenced by ILIAS\MetaData\Services\Services\manipulatorFactory().

$paths

PathsInterface ILIAS\MetaData\Services\Services::$paths

protected

Definition at line 55 of file Services.php.

Referenced by ILIAS\MetaData\Services\Services\paths().

$reader_factory

ReaderFactoryInterface ILIAS\MetaData\Services\Services::$reader_factory

protected

Definition at line 53 of file Services.php.

Referenced by ILIAS\MetaData\Services\Services\readerFactory().

$searcher

SearcherInterface ILIAS\MetaData\Services\Services::$searcher

protected

Definition at line 58 of file Services.php.

Referenced by ILIAS\MetaData\Services\Services\search().

---

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

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