Manages repository object related content style behaviour. More...

Collaboration diagram for ILIAS\Style\Content\Object\ObjectManager:

Public Member Functions
	__construct (InternalRepoService $repo_service, InternalDomainService $domain_service, int $ref_id, int $obj_id=0)

	getSelectableStyles ()
	Get all selectable styles. More...

	updateStyleId (int $style_id)

	setOwnerOfStyle (int $style_id)

	getStyleId ()

	cloneTo (int $obj_id)
	Clones a style to a new object (or references the same standard style) More...

	inheritFromParent ()
	Inherits a non local style from the parent container. More...

	getEffectiveStyleId ()

	isOwned (int $style_id)

	globalFixed ()

	getGlobalFixedTitle ()

	getGlobalDefaultTitle ()

	hasEffectiveIndividualStyle (int $current_style)

	canSelectStyle (int $current_style)

	countOverallOwned ()

	countObjSelected (int $style_id)

Protected Member Functions
	isSelectable (int $style_id)

Protected Attributes
ilLogger	$log

ilSetting	$settings

ObjectDBRepository	$object_repo

int	$obj_id

ContainerDBRepository	$container_repo

int	$ref_id

InternalRepoService	$repo_service

InternalDomainService	$domain_service

Detailed Description

Manages repository object related content style behaviour.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 35 of file class.ObjectManager.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Style\Content\Object\ObjectManager::__construct	(	InternalRepoService	$repo_service,
		InternalDomainService	$domain_service,
		int	$ref_id,
		int	$obj_id = `0`
	)

Definition at line 46 of file class.ObjectManager.php.

      {
        $this->settings = $domain_service->settings();
        $this->ref_id = $ref_id;
        $this->obj_id = ($obj_id > 0)
            ? $obj_id
            : ilObject::_lookupObjId($ref_id);
        $this->repo_service = $repo_service;
        $this->domain_service = $domain_service;
        $this->container_repo = $repo_service->repositoryContainer();
        $this->object_repo = $repo_service->object();
        $this->log = $this->domain_service->log();
    }

References ILIAS\Style\Content\Object\ObjectManager\$domain_service, ILIAS\Style\Content\Object\ObjectManager\$obj_id, ILIAS\Style\Content\Object\ObjectManager\$ref_id, ILIAS\Style\Content\Object\ObjectManager\$repo_service, ilObject\_lookupObjId(), ILIAS\Style\Content\InternalRepoService\object(), ILIAS\Style\Content\InternalRepoService\repositoryContainer(), and ILIAS\Repository\settings().

Here is the call graph for this function:

Member Function Documentation

◆ canSelectStyle()

ILIAS\Style\Content\Object\ObjectManager::canSelectStyle ( int $current_style )

Definition at line 237 of file class.ObjectManager.php.

                                                      : bool
    {
        if ($this->globalFixed() || $this->hasEffectiveIndividualStyle($current_style)) {
            return false;
        }
        return true;
    }

References ILIAS\Style\Content\Object\ObjectManager\globalFixed(), and ILIAS\Style\Content\Object\ObjectManager\hasEffectiveIndividualStyle().

Here is the call graph for this function:

◆ cloneTo()

ILIAS\Style\Content\Object\ObjectManager::cloneTo ( int $obj_id )

Clones a style to a new object (or references the same standard style)

Definition at line 129 of file class.ObjectManager.php.

                                        : void
    {
        $this->log->debug("Cloning style from ref id: " . $this->ref_id .
            ", obj id: " . $this->obj_id . ", style id: " . $this->getStyleId() . ", to new obj id: " .
            $obj_id);
        $style_id = $this->getStyleId();
        if ($style_id > 0 && !ilObjStyleSheet::_lookupStandard($style_id)) {
            $style_obj = ilObjectFactory::getInstanceByObjId($style_id);
            $new_id = $style_obj->ilClone();
            ilObjStyleSheet::writeStyleUsage($obj_id, $new_id);
            ilObjStyleSheet::writeOwner($obj_id, $new_id);
        } else {
            ilObjStyleSheet::writeStyleUsage($obj_id, $style_id);
        }
    }

References ILIAS\Style\Content\Object\ObjectManager\$obj_id, ilObjStyleSheet\_lookupStandard(), ilObjectFactory\getInstanceByObjId(), ILIAS\Style\Content\Object\ObjectManager\getStyleId(), ilObjStyleSheet\writeOwner(), and ilObjStyleSheet\writeStyleUsage().

Here is the call graph for this function:

◆ countObjSelected()

ILIAS\Style\Content\Object\ObjectManager::countObjSelected ( int $style_id )

Definition at line 250 of file class.ObjectManager.php.

                                                   : int
    {
        return $this->object_repo->countObjSelected($style_id);
    }

◆ countOverallOwned()

ILIAS\Style\Content\Object\ObjectManager::countOverallOwned ( )

Definition at line 245 of file class.ObjectManager.php.

                                       : int
    {
        return $this->object_repo->countOverallOwned();
    }

◆ getEffectiveStyleId()

ILIAS\Style\Content\Object\ObjectManager::getEffectiveStyleId ( )

Definition at line 164 of file class.ObjectManager.php.

                                         : int
    {
        $settings = $this->settings;
 
        // the currently set/stored style for the object
        $style_id = $this->getStyleId();
 
        // the set style must either be owned or be selectable
        if (!$this->isOwned($style_id) && !$this->isSelectable($style_id)) {
            $style_id = 0;
        }
 
        // check global fixed content style, which overwrites anything
        $fixed_style = (int) $settings->get("fixed_content_style_id");
        if ($fixed_style > 0) {
            $style_id = $fixed_style;
        }
 
        // if no style id is set up to this point, check/use global default style
        if ($style_id <= 0) {
            $style_id = (int) $settings->get("default_content_style_id");
        }
 
        if ($style_id > 0 && ilObject::_lookupType($style_id) === "sty") {
            return $style_id;
        }
        return 0;
    }

References ILIAS\Style\Content\Object\ObjectManager\$settings, ilObject\_lookupType(), ilSetting\get(), ILIAS\Style\Content\Object\ObjectManager\getStyleId(), ILIAS\Repository\int(), ILIAS\Style\Content\Object\ObjectManager\isOwned(), and ILIAS\Style\Content\Object\ObjectManager\isSelectable().

Here is the call graph for this function:

◆ getGlobalDefaultTitle()

ILIAS\Style\Content\Object\ObjectManager::getGlobalDefaultTitle ( )

Definition at line 217 of file class.ObjectManager.php.

                                           : string
    {
        $style_id = (int) $this->settings->get("default_content_style_id");
        if ($style_id > 0) {
            return ilObject::_lookupTitle($style_id);
        }
        return "";
    }

References ilObject\_lookupTitle(), ILIAS\Repository\int(), and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ getGlobalFixedTitle()

ILIAS\Style\Content\Object\ObjectManager::getGlobalFixedTitle ( )

Definition at line 208 of file class.ObjectManager.php.

                                         : string
    {
        if ($this->globalFixed()) {
            $fixed_style = (int) $this->settings->get("fixed_content_style_id");
            return ilObject::_lookupTitle($fixed_style);
        }
        return "";
    }

References ilObject\_lookupTitle(), ILIAS\Style\Content\Object\ObjectManager\globalFixed(), ILIAS\Repository\int(), and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ getSelectableStyles()

ILIAS\Style\Content\Object\ObjectManager::getSelectableStyles ( )

Get all selectable styles.

If a global fixed style is set, this returns an empty array. If a ref id is provided for the manager, upper container will be searched for shared local content styles.

Definition at line 69 of file class.ObjectManager.php.

                                         : array
    {
        $settings = $this->settings;
        $tree = $this->domain_service->repositoryTree();
        $container_repo = $this->container_repo;
 
        $fixed_style = $settings->get("fixed_content_style_id");
        if ($fixed_style > 0) {
            return [];
        } else {
            $st_styles = ilObjStyleSheet::_getStandardStyles(
                true,
                false,
                $this->ref_id
            );
 
            if ($this->ref_id > 0) {
                $path = $tree->getPathId($this->ref_id);
                $reuse_ref_ids = $container_repo->filterByReuse($path);
                $container_obj_ids = array_map(function ($ref_id) {
                    return ilObject::_lookupObjId($ref_id);
                }, $reuse_ref_ids);
                foreach ($this->object_repo->getOwnedStyles($container_obj_ids) as $obj_id => $style_id) {
                    $st_styles[$style_id] =
                        ilObject::_lookupTitle($style_id) .
                        " (" . ilObject::_lookupTitle($obj_id) . ")";
                }
            }
        }
        ksort($st_styles);
        return $st_styles;
    }

References ILIAS\Style\Content\Object\ObjectManager\$container_repo, ILIAS\Style\Content\Object\ObjectManager\$obj_id, $path, ILIAS\Style\Content\Object\ObjectManager\$ref_id, ILIAS\Style\Content\Object\ObjectManager\$settings, ilObjStyleSheet\_getStandardStyles(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ILIAS\Style\Content\Container\ContainerDBRepository\filterByReuse(), and ilSetting\get().

Referenced by ILIAS\Style\Content\Object\ObjectManager\isSelectable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStyleId()

ILIAS\Style\Content\Object\ObjectManager::getStyleId ( )

Definition at line 121 of file class.ObjectManager.php.

                                : int
    {
        return ilObjStyleSheet::lookupObjectStyle($this->obj_id);
    }

References ilObjStyleSheet\lookupObjectStyle().

Referenced by ILIAS\Style\Content\Object\ObjectManager\cloneTo(), and ILIAS\Style\Content\Object\ObjectManager\getEffectiveStyleId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ globalFixed()

ILIAS\Style\Content\Object\ObjectManager::globalFixed ( )

Definition at line 199 of file class.ObjectManager.php.

                                 : bool
    {
        $fixed_style = (int) $this->settings->get("fixed_content_style_id");
        if ($fixed_style > 0) {
            return true;
        }
        return false;
    }

References ILIAS\Repository\int(), and ILIAS\Repository\settings().

Referenced by ILIAS\Style\Content\Object\ObjectManager\canSelectStyle(), ILIAS\Style\Content\Object\ObjectManager\getGlobalFixedTitle(), and ILIAS\Style\Content\Object\ObjectManager\hasEffectiveIndividualStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasEffectiveIndividualStyle()

ILIAS\Style\Content\Object\ObjectManager::hasEffectiveIndividualStyle ( int $current_style )

Definition at line 226 of file class.ObjectManager.php.

                                                                   : bool
    {
        if ($this->globalFixed()) {
            return false;
        }
        if ($current_style > 0 && $this->isOwned($current_style)) {
            return true;
        }
        return false;
    }

References ILIAS\Style\Content\Object\ObjectManager\globalFixed(), and ILIAS\Style\Content\Object\ObjectManager\isOwned().

Referenced by ILIAS\Style\Content\Object\ObjectManager\canSelectStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ inheritFromParent()

ILIAS\Style\Content\Object\ObjectManager::inheritFromParent ( )

Inherits a non local style from the parent container.

Definition at line 148 of file class.ObjectManager.php.

                                       : void
    {
        if ($this->ref_id > 0) {
            $tree = $this->domain_service->repositoryTree();
            $parent_ref_id = $tree->getParentId($this->ref_id);
            $parent_id = ilObject::_lookupObjId((int) $parent_ref_id);
            $obj_id = ilObject::_lookupObjId($this->ref_id);
            $style_id = ilObjStyleSheet::lookupObjectStyle($parent_id);
            if ($style_id > 0) {
                if (ilObjStyleSheet::_lookupStandard($style_id)) {
                    ilObjStyleSheet::writeStyleUsage($obj_id, $style_id);
                }
            }
        }
    }

References ILIAS\Style\Content\Object\ObjectManager\$obj_id, ilObject\_lookupObjId(), ilObjStyleSheet\_lookupStandard(), ilObjStyleSheet\lookupObjectStyle(), and ilObjStyleSheet\writeStyleUsage().

Here is the call graph for this function:

◆ isOwned()

ILIAS\Style\Content\Object\ObjectManager::isOwned ( int $style_id )

Definition at line 194 of file class.ObjectManager.php.

                                          : bool
    {
        return $this->object_repo->isOwned($this->obj_id, $style_id);
    }

Referenced by ILIAS\Style\Content\Object\ObjectManager\getEffectiveStyleId(), and ILIAS\Style\Content\Object\ObjectManager\hasEffectiveIndividualStyle().

Here is the caller graph for this function:

◆ isSelectable()

ILIAS\Style\Content\Object\ObjectManager::isSelectable ( int $style_id )

protected

Definition at line 102 of file class.ObjectManager.php.

                                                  : bool
    {
        $sel_types = $this->getSelectableStyles();
        if (isset($sel_types[$style_id])) {
            return true;
        }
        return false;
    }

References ILIAS\Style\Content\Object\ObjectManager\getSelectableStyles().

Referenced by ILIAS\Style\Content\Object\ObjectManager\getEffectiveStyleId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setOwnerOfStyle()

ILIAS\Style\Content\Object\ObjectManager::setOwnerOfStyle ( int $style_id )

Definition at line 116 of file class.ObjectManager.php.

                                                  : void
    {
        ilObjStyleSheet::writeOwner($this->obj_id, $style_id);
    }

References ilObjStyleSheet\writeOwner().

Here is the call graph for this function:

◆ updateStyleId()

ILIAS\Style\Content\Object\ObjectManager::updateStyleId ( int $style_id )

Definition at line 111 of file class.ObjectManager.php.

                                                : void
    {
        ilObjStyleSheet::writeStyleUsage($this->obj_id, $style_id);
    }

References ilObjStyleSheet\writeStyleUsage().

Here is the call graph for this function:

Field Documentation

◆ $container_repo

ContainerDBRepository ILIAS\Style\Content\Object\ObjectManager::$container_repo

protected

Definition at line 41 of file class.ObjectManager.php.

Referenced by ILIAS\Style\Content\Object\ObjectManager\getSelectableStyles().

◆ $domain_service

InternalDomainService ILIAS\Style\Content\Object\ObjectManager::$domain_service

protected

Definition at line 44 of file class.ObjectManager.php.

Referenced by ILIAS\Style\Content\Object\ObjectManager\__construct().

◆ $log

ilLogger ILIAS\Style\Content\Object\ObjectManager::$log

protected

Definition at line 37 of file class.ObjectManager.php.

◆ $obj_id

int ILIAS\Style\Content\Object\ObjectManager::$obj_id

protected

Definition at line 40 of file class.ObjectManager.php.

Referenced by ILIAS\Style\Content\Object\ObjectManager\__construct(), ILIAS\Style\Content\Object\ObjectManager\cloneTo(), ILIAS\Style\Content\Object\ObjectManager\getSelectableStyles(), and ILIAS\Style\Content\Object\ObjectManager\inheritFromParent().

◆ $object_repo

ObjectDBRepository ILIAS\Style\Content\Object\ObjectManager::$object_repo

protected

Definition at line 39 of file class.ObjectManager.php.

◆ $ref_id

int ILIAS\Style\Content\Object\ObjectManager::$ref_id

protected

Definition at line 42 of file class.ObjectManager.php.

Referenced by ILIAS\Style\Content\Object\ObjectManager\__construct(), and ILIAS\Style\Content\Object\ObjectManager\getSelectableStyles().

◆ $repo_service

InternalRepoService ILIAS\Style\Content\Object\ObjectManager::$repo_service

protected

Definition at line 43 of file class.ObjectManager.php.

Referenced by ILIAS\Style\Content\Object\ObjectManager\__construct().

◆ $settings

ilSetting ILIAS\Style\Content\Object\ObjectManager::$settings

protected

Definition at line 38 of file class.ObjectManager.php.

Referenced by ILIAS\Style\Content\Object\ObjectManager\getEffectiveStyleId(), and ILIAS\Style\Content\Object\ObjectManager\getSelectableStyles().

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

components/ILIAS/Style/Content/Object/class.ObjectManager.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ canSelectStyle()

◆ cloneTo()

◆ countObjSelected()

◆ countOverallOwned()

◆ getEffectiveStyleId()

◆ getGlobalDefaultTitle()

◆ getGlobalFixedTitle()

◆ getSelectableStyles()

◆ getStyleId()

◆ globalFixed()

◆ hasEffectiveIndividualStyle()

◆ inheritFromParent()

◆ isOwned()

◆ isSelectable()

◆ setOwnerOfStyle()

◆ updateStyleId()

Field Documentation

◆ $container_repo

◆ $domain_service

◆ $log

◆ $obj_id

◆ $object_repo

◆ $ref_id

◆ $repo_service

◆ $settings