Main business logic for characteristics. More...

Collaboration diagram for ILIAS\Style\Content\CharacteristicManager:

Public Member Functions
	__construct (int $style_id, Access\StyleAccessManager $access_manager, CharacteristicDBRepo $char_repo, CharacteristicCopyPasteSessionRepo $char_copy_paste_repo, ColorDBRepo $color_repo, ilObjUser $user)

	addCharacteristic (string $type, string $char, bool $hidden=false)

	exists (string $type, string $char)
	Check if characteristic exists. More...

	getByKey (string $type, string $characteristic)
	Get characteristic by key. More...

	getByType (string $type)
	Get characteristics by type. More...

	getByTypes (array $types, bool $include_hidden=true, bool $include_outdated=true)
	Get characteristics by type. More...

	getBySuperType (string $supertype)
	Get characteristics by supertype. More...

	getPresentationTitle (string $type, string $characteristic, bool $fallback_to_characteristic=true)
	Get characteristic by key. More...

	saveTitles (string $type, string $characteristic, array $titles)
	Save titles for characteristic. More...

	saveHidden (string $type, string $characteristic, bool $hide)
	Save characteristic hidden status. More...

	saveOutdated (string $type, string $characteristic, bool $outdated)
	Save characteristic outdated status. More...

	isOutdated (string $type, string $characteristic)

	saveOrderNrs (string $type, array $order_nrs)
	Save characteristics order. More...

	deleteCharacteristic (string $type, string $class)
	Delete Characteristic. More...

	setCopyCharacteristics (string $style_type, array $characteristics)

	hasCopiedCharacteristics (string $style_type)
	Is in copy process? More...

	clearCopyCharacteristics ()

	getCopyCharacteristicStyleId ()

	getCopyCharacteristicStyleType ()

	getCopyCharacteristics ()

	copyCharacteristicFromSource (int $source_style_id, string $source_style_type, string $source_char, string $new_char, array $new_titles)
	Copy characteristic. More...

	replaceParameter (string $a_tag, string $a_class, string $a_par, string $a_val, string $a_type, int $a_mq_id=0, bool $a_custom=false)

	deleteParameter (string $a_tag, string $a_class, string $a_par, string $a_type, int $a_mq_id=0, bool $a_custom=false)

Protected Attributes
CharacteristicDBRepo	$repo

ColorDBRepo	$color_repo

ilObjUser	$user

Access StyleAccessManager	$access_manager

CharacteristicCopyPasteSessionRepo	$session

int	$style_id

Detailed Description

Main business logic for characteristics.

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

Definition at line 31 of file class.CharacteristicManager.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Style\Content\CharacteristicManager::__construct	(	int	$style_id,
		Access\StyleAccessManager	$access_manager,
		CharacteristicDBRepo	$char_repo,
		CharacteristicCopyPasteSessionRepo	$char_copy_paste_repo,
		ColorDBRepo	$color_repo,
		ilObjUser	$user
	)

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

      {
        $this->user = $user;
        $this->repo = $char_repo;
        $this->color_repo = $color_repo;
        $this->access_manager = $access_manager;
        $this->session = $char_copy_paste_repo;
        $this->style_id = $style_id;
    }

References ILIAS\Style\Content\CharacteristicManager\$access_manager, ILIAS\Style\Content\CharacteristicManager\$color_repo, ILIAS\Style\Content\CharacteristicManager\$style_id, ILIAS\Style\Content\CharacteristicManager\$user, and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ addCharacteristic()

ILIAS\Style\Content\CharacteristicManager::addCharacteristic	(	string	$type,
		string	$char,
		bool	$hidden = `false`
	)

Definition at line 56 of file class.CharacteristicManager.php.

     : void {
        $this->repo->addCharacteristic(
            $this->style_id,
            $type,
            $char,
            $hidden
        );
 
        ilObjStyleSheet::_writeUpToDate($this->style_id, false);
    }

◆ clearCopyCharacteristics()

ILIAS\Style\Content\CharacteristicManager::clearCopyCharacteristics ( )

Definition at line 302 of file class.CharacteristicManager.php.

                                              : void
    {
        $this->session->clear();
    }

◆ copyCharacteristicFromSource()

ILIAS\Style\Content\CharacteristicManager::copyCharacteristicFromSource	(	int	$source_style_id,
		string	$source_style_type,
		string	$source_char,
		string	$new_char,
		array	$new_titles
	)

Copy characteristic.

Exceptions

ContentStyleNoPermissionException

Definition at line 329 of file class.CharacteristicManager.php.

     : void {
        if (!$this->access_manager->checkWrite()) {
            throw new ContentStyleNoPermissionException("No write permission for style.");
        }
 
        if ($this->exists($source_style_type, $new_char)) {
            $target_char = $this->getByKey($source_style_type, $new_char);
            if (count($new_titles) == 0) {
                $new_titles = $target_char->getTitles();
            }
            $this->deleteCharacteristic($source_style_type, $new_char);
        }
 
        $this->addCharacteristic($source_style_type, $new_char);
        $this->saveTitles($source_style_type, $new_char, $new_titles);
 
        $from_style = new ilObjStyleSheet($source_style_id);
 
        // todo fix using mq_id
        $pars = $from_style->getParametersOfClass($source_style_type, $source_char);
 
        $colors = array();
        foreach ($pars as $p => $v) {
            if (substr($v, 0, 1) == "!") {
                $colors[] = substr($v, 1);
            }
            $this->replaceParameter(
                ilObjStyleSheet::_determineTag($source_style_type),
                $new_char,
                $p,
                $v,
                $source_style_type
            );
        }
 
        // copy colors
        foreach ($colors as $c) {
            if (!$this->color_repo->colorExists($this->style_id, $c)) {
                $this->color_repo->addColor(
                    $this->style_id,
                    $c,
                    $from_style->getColorCodeForName($c)
                );
            }
        }
    }

◆ deleteCharacteristic()

ILIAS\Style\Content\CharacteristicManager::deleteCharacteristic	(	string	$type,
		string	$class
	)

Delete Characteristic.

Exceptions

ContentStyleNoPermissionException

Definition at line 264 of file class.CharacteristicManager.php.

     : void {
        if (!$this->access_manager->checkWrite()) {
            throw new ContentStyleNoPermissionException("No write permission for style.");
        }
        $tag = ilObjStyleSheet::_determineTag($type);
 
        // check, if characteristic is not a core style
        $core_styles = ilObjStyleSheet::_getCoreStyles();
        if (empty($core_styles[$type . "." . $tag . "." . $class])) {
            $this->repo->deleteCharacteristic(
                $this->style_id,
                $type,
                $tag,
                $class
            );
        }
 
        ilObjStyleSheet::_writeUpToDate($this->style_id, false);
    }

◆ deleteParameter()

ILIAS\Style\Content\CharacteristicManager::deleteParameter	(	string	$a_tag,
		string	$a_class,
		string	$a_par,
		string	$a_type,
		int	$a_mq_id = `0`,
		bool	$a_custom = `false`
	)

Definition at line 414 of file class.CharacteristicManager.php.

     : void {
        $this->repo->deleteParameter(
            $this->style_id,
            $a_tag,
            $a_class,
            $a_par,
            $a_type,
            $a_mq_id,
            $a_custom
        );
    }

◆ exists()

ILIAS\Style\Content\CharacteristicManager::exists	(	string	$type,
		string	$char
	)

Check if characteristic exists.

Definition at line 74 of file class.CharacteristicManager.php.

     : bool {
        return $this->repo->exists(
            $this->style_id,
            $type,
            $char
        );
    }

◆ getByKey()

ILIAS\Style\Content\CharacteristicManager::getByKey	(	string	$type,
		string	$characteristic
	)

Get characteristic by key.

Definition at line 88 of file class.CharacteristicManager.php.

     : ?Characteristic {
        return $this->repo->getByKey(
            $this->style_id,
            $type,
            $characteristic
        );
    }

◆ getBySuperType()

ILIAS\Style\Content\CharacteristicManager::getBySuperType ( string $supertype )

Get characteristics by supertype.

Definition at line 130 of file class.CharacteristicManager.php.

     : array {
        return $this->repo->getBySuperType(
            $this->style_id,
            $supertype
        );
    }

◆ getByType()

ILIAS\Style\Content\CharacteristicManager::getByType ( string $type )

Get characteristics by type.

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

     : array {
        return $this->repo->getByType(
            $this->style_id,
            $type
        );
    }

◆ getByTypes()

ILIAS\Style\Content\CharacteristicManager::getByTypes	(	array	$types,
		bool	$include_hidden = `true`,
		bool	$include_outdated = `true`
	)

Get characteristics by type.

Definition at line 114 of file class.CharacteristicManager.php.

     : array {
        return $this->repo->getByTypes(
            $this->style_id,
            $types,
            $include_hidden,
            $include_outdated
        );
    }

◆ getCopyCharacteristics()

ILIAS\Style\Content\CharacteristicManager::getCopyCharacteristics ( )

Definition at line 319 of file class.CharacteristicManager.php.

                                            : array
    {
        $data = $this->session->getData();
        return $data->characteristics;
    }

References $data.

◆ getCopyCharacteristicStyleId()

ILIAS\Style\Content\CharacteristicManager::getCopyCharacteristicStyleId ( )

Definition at line 307 of file class.CharacteristicManager.php.

                                                  : int
    {
        $data = $this->session->getData();
        return (int) $data->style_id;
    }

References $data.

◆ getCopyCharacteristicStyleType()

ILIAS\Style\Content\CharacteristicManager::getCopyCharacteristicStyleType ( )

Definition at line 313 of file class.CharacteristicManager.php.

                                                    : string
    {
        $data = $this->session->getData();
        return $data->style_type;
    }

References $data.

◆ getPresentationTitle()

ILIAS\Style\Content\CharacteristicManager::getPresentationTitle	(	string	$type,
		string	$characteristic,
		bool	$fallback_to_characteristic = `true`
	)

Get characteristic by key.

Definition at line 142 of file class.CharacteristicManager.php.

     : string {
        $char = $this->repo->getByKey(
            $this->style_id,
            $type,
            $characteristic
        );
 
        $titles = $char ? $char->getTitles() : [];
 
        $lang = $this->user->getLanguage();
 
        if (($titles[$lang] ?? "") != "") {
            return $titles[$lang];
        }
        if ($fallback_to_characteristic) {
            return $characteristic;
        }
        return "";
    }

References $lang.

◆ hasCopiedCharacteristics()

ILIAS\Style\Content\CharacteristicManager::hasCopiedCharacteristics ( string $style_type )

Is in copy process?

Definition at line 297 of file class.CharacteristicManager.php.

                                                                : bool
    {
        return $this->session->hasEntries($style_type);
    }

◆ isOutdated()

ILIAS\Style\Content\CharacteristicManager::isOutdated	(	string	$type,
		string	$characteristic
	)

Definition at line 224 of file class.CharacteristicManager.php.

     : bool {
        return $this->repo->isOutdated(
            $this->style_id,
            $type,
            $characteristic
        );
    }

◆ replaceParameter()

ILIAS\Style\Content\CharacteristicManager::replaceParameter	(	string	$a_tag,
		string	$a_class,
		string	$a_par,
		string	$a_val,
		string	$a_type,
		int	$a_mq_id = `0`,
		bool	$a_custom = `false`
	)

Definition at line 382 of file class.CharacteristicManager.php.

     : void {
        if ($a_val != "") {
            $this->repo->replaceParameter(
                $this->style_id,
                $a_tag,
                $a_class,
                $a_par,
                $a_val,
                $a_type,
                $a_mq_id,
                $a_custom
            );
        } else {
            $this->deleteParameter(
                $a_tag,
                $a_class,
                $a_par,
                $a_type,
                $a_mq_id,
                $a_custom
            );
        }
    }

◆ saveHidden()

ILIAS\Style\Content\CharacteristicManager::saveHidden	(	string	$type,
		string	$characteristic,
		bool	$hide
	)

Save characteristic hidden status.

Definition at line 189 of file class.CharacteristicManager.php.

     : void {
        if (!$this->access_manager->checkWrite()) {
            throw new ContentStyleNoPermissionException("No write permission for style.");
        }
        $this->repo->saveHidden(
            $this->style_id,
            $type,
            $characteristic,
            $hide
        );
    }

◆ saveOrderNrs()

ILIAS\Style\Content\CharacteristicManager::saveOrderNrs	(	string	$type,
		array	$order_nrs
	)

Save characteristics order.

Parameters

array $order_nrs (key is characteristic value is order nr)

Definition at line 239 of file class.CharacteristicManager.php.

     : void {
        if (!$this->access_manager->checkWrite()) {
            throw new ContentStyleNoPermissionException("No write permission for style.");
        }
 
        asort($order_nrs, SORT_NUMERIC);
 
        foreach ($order_nrs as $char => $nr) {
            $this->repo->saveOrderNr(
                $this->style_id,
                $type,
                $char,
                (int) $nr
            );
        }
    }

◆ saveOutdated()

ILIAS\Style\Content\CharacteristicManager::saveOutdated	(	string	$type,
		string	$characteristic,
		bool	$outdated
	)

Save characteristic outdated status.

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

     : void {
        if (!$this->access_manager->checkWrite()) {
            throw new ContentStyleNoPermissionException("No write permission for style.");
        }
        $this->repo->saveOutdated(
            $this->style_id,
            $type,
            $characteristic,
            $outdated
        );
    }

◆ saveTitles()

ILIAS\Style\Content\CharacteristicManager::saveTitles	(	string	$type,
		string	$characteristic,
		array	$titles
	)

Save titles for characteristic.

Exceptions

ContentStyleNoPermissionException

Definition at line 170 of file class.CharacteristicManager.php.

     : void {
        if (!$this->access_manager->checkWrite()) {
            throw new ContentStyleNoPermissionException("No write permission for style.");
        }
        $this->repo->saveTitles(
            $this->style_id,
            $type,
            $characteristic,
            $titles
        );
    }

◆ setCopyCharacteristics()

ILIAS\Style\Content\CharacteristicManager::setCopyCharacteristics	(	string	$style_type,
		array	$characteristics
	)

Definition at line 287 of file class.CharacteristicManager.php.

     : void {
        $this->session->set($this->style_id, $style_type, $characteristics);
    }

Field Documentation

◆ $access_manager

Access StyleAccessManager ILIAS\Style\Content\CharacteristicManager::$access_manager

protected

Definition at line 36 of file class.CharacteristicManager.php.

Referenced by ILIAS\Style\Content\CharacteristicManager\__construct().

◆ $color_repo

ColorDBRepo ILIAS\Style\Content\CharacteristicManager::$color_repo

protected

Definition at line 34 of file class.CharacteristicManager.php.

Referenced by ILIAS\Style\Content\CharacteristicManager\__construct().

◆ $repo

CharacteristicDBRepo ILIAS\Style\Content\CharacteristicManager::$repo

protected

Definition at line 33 of file class.CharacteristicManager.php.

◆ $session

CharacteristicCopyPasteSessionRepo ILIAS\Style\Content\CharacteristicManager::$session

protected

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

◆ $style_id

int ILIAS\Style\Content\CharacteristicManager::$style_id

protected

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

Referenced by ILIAS\Style\Content\CharacteristicManager\__construct().

◆ $user

ilObjUser ILIAS\Style\Content\CharacteristicManager::$user

protected

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

Referenced by ILIAS\Style\Content\CharacteristicManager\__construct().

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

Services/Style/Content/Characteristic/class.CharacteristicManager.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCharacteristic()

◆ clearCopyCharacteristics()

◆ copyCharacteristicFromSource()

◆ deleteCharacteristic()

◆ deleteParameter()

◆ exists()

◆ getByKey()

◆ getBySuperType()

◆ getByType()

◆ getByTypes()

◆ getCopyCharacteristics()

◆ getCopyCharacteristicStyleId()

◆ getCopyCharacteristicStyleType()

◆ getPresentationTitle()

◆ hasCopiedCharacteristics()

◆ isOutdated()

◆ replaceParameter()

◆ saveHidden()

◆ saveOrderNrs()

◆ saveOutdated()

◆ saveTitles()

◆ setCopyCharacteristics()

Field Documentation

◆ $access_manager

◆ $color_repo

◆ $repo

◆ $session

◆ $style_id

◆ $user