This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilObjPortfolioTemplate:

Collaboration diagram for ilObjPortfolioTemplate:

Public Member Functions
	isActivationLimited ()

	setActivationLimited (bool $a_value)

	setActivationVisibility (bool $a_value)

	getActivationVisibility ()

	setActivationStartDate (?int $starting_time=null)

	setActivationEndDate (?int $ending_time=null)

	getActivationStartDate ()

	getActivationEndDate ()

Public Member Functions inherited from ilObjPortfolioBase
	__construct (int $a_id=0, bool $a_reference=true)
	Constructor. More...

	setPublicComments (bool $a_value)

	hasPublicComments ()

	hasProfilePicture ()

	setProfilePicture (bool $a_status)

	getBackgroundColor ()

	setBackgroundColor (string $a_value)
	Set background color, e.g. More...

	getFontColor ()

	setFontColor (string $a_value)

	fixLinksOnTitleChange (array $a_title_changes)
	Update internal portfolio links on title change. More...

Public Member Functions inherited from ilObject2
	__construct (int $a_id=0, bool $a_reference=true)
	Constructor. More...

	read ()

	create (bool $a_clone_mode=false)

	update ()

	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...

	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...

	cloneObject (int $target_id, int $copy_id=0, bool $omit_tree=false)

Public Member Functions inherited from ilObject
	getObjectProperties ()

	flushObjectProperties ()

	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...

	processAutoRating ()

	read ()

	getId ()

	setId (int $id)

	setRefId (int $ref_id)

	getRefId ()

	getType ()

	setType (string $type)

	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...

	getTitle ()

	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...

	setTitle (string $title)

	getDescription ()

	setDescription (string $description)

	getLongDescription ()
	get object long description (stored in object_description) More...

	getImportId ()

	setImportId (string $import_id)

	setOfflineStatus (bool $status)

	getOfflineStatus ()

	supportsOfflineHandling ()

	getOwner ()

	getOwnerName ()
	get full name of object owner More...

	setOwner (int $usr_id)

	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...

	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...

	create ()
	note: title, description and type should be set when this function is called More...

	update ()

	MDUpdateListener (string $element)
	Metadata update listener. More...

	createMetaData ()

	updateMetaData ()

	deleteMetaData ()

	updateOwner ()
	update owner of object in db More...

	putInTree (int $parent_ref_id)
	maybe this method should be in tree object!? More...

	setPermissions (int $parent_ref_id)

	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...

	createReference ()
	creates reference for object More...

	countReferences ()

	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...

	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type. More...

	applyDidacticTemplate (int $tpl_id)

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo (int $target_id, int $copy_id, int $new_obj_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...

	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...

	selfOrParentWithRatingEnabled ()

	getPossibleSubObjects (bool $filter=true)
	get all possible sub objects of this type the object can decide which types of sub objects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	getAvailablePortfolioTemplates (string $a_permission="read")

Static Public Member Functions inherited from ilObjPortfolioBase
static	clonePagesAndSettings (ilObjPortfolioBase $a_source, ilObjPortfolioBase $a_target, ?array $a_recipe=null, bool $copy_all=false)
	Build template from portfolio and vice versa. More...

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...

static	_lookupImportId (int $obj_id)

static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...

static	_getIdForImportId (string $import_id)

static	_getAllReferences (int $id)
	get all reference ids for object ID More...

static	_lookupTitle (int $obj_id)

static	lookupOfflineStatus (int $obj_id)
	Lookup offline status using objectDataCache. More...

static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...

static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)

static	_lookupDescription (int $obj_id)

static	_lookupLastUpdate (int $obj_id, bool $formatted=false)

static	_getLastUpdateOfObjects (array $obj_ids)

static	_lookupObjId (int $ref_id)

static	_setDeletedDate (int $ref_id, int $deleted_by)

static	setDeletedDates (array $ref_ids, int $user_id)

static	_resetDeletedDate (int $ref_id)

static	_lookupDeletedDate (int $ref_id)

static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...

static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...

static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...

static	_lookupType (int $id, bool $reference=false)

static	_isInTrash (int $ref_id)

static	_hasUntrashedReference (int $obj_id)
	checks whether an object has at least one reference that is not in trash More...

static	_lookupObjectId (int $ref_id)

static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...

static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...

static	_getObjectsByType (string $obj_type="", ?int $owner=null)

static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...

static	getIconForType (string $type)

static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $obj_ids)

static	getAllOwnedRepositoryObjects (int $user_id)

static	fixMissingTitles ($type, array &$obj_title_map)
	Try to fix missing object titles. More...

static	_lookupCreationDate (int $obj_id)

static	_getObjectTypeIdByTitle (string $type, ?\ilDBInterface $ilDB=null)

Protected Member Functions
	initType ()

	doRead ()

	doCreate (bool $clone_mode=false)

	doUpdate ()

	deleteAllPages ()

	doCloneObject (ilObject2 $new_obj, int $a_target_id, ?int $a_copy_id=null)

	updateActivation ()

Protected Member Functions inherited from ilObjPortfolioBase
	doRead ()

	doReadCustom (array $a_row)
	May be overwritten by derived classes. More...

	doCreate (bool $clone_mode=false)

	doUpdate ()

	doUpdateCustom (array &$a_fields)
	May be overwritte by derived classes. More...

	doDelete ()

	deleteAllPages ()

Protected Member Functions inherited from ilObject2
	initType ()

	doRead ()

	doCreate (bool $clone_mode=false)

	beforeCreate ()
	If overwritten this method should return true, there is currently no "abort" handling for cases where "false" is returned. More...

	doUpdate ()

	beforeUpdate ()

	doDelete ()

	beforeDelete ()

	doCloneObject (ilObject2 $new_obj, int $a_target_id, ?int $a_copy_id=null)

	beforeCloneObject ()

Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)

	beforeMDUpdateListener (string $a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDeleteMetaData ()

	beforeDeleteMetaData ()

	handleAutoRating ()

	hasAutoRating ()

Protected Attributes
bool	$activation_limited = false

bool	$activation_visibility = false

int	$activation_starting_time = 0

int	$activation_ending_time = 0

Protected Attributes inherited from ilObjPortfolioBase
ILIAS Notes Service	$notes

ilSetting	$setting

bool	$comments = false

string	$bg_color = ""

string	$font_color = ""

string	$img = ""

string	$ppic = ""

bool	$style = false

Protected Attributes inherited from ilObject
ilLogger	$obj_log

ILIAS	$ilias

ilObjectDefinition	$obj_definition

ilDBInterface	$db

ilLogger	$log

ilErrorHandling	$error

ilTree	$tree

ilAppEventHandler	$app_event_handler

ilRbacAdmin	$rbac_admin

ilRbacReview	$rbac_review

ilObjUser	$user

ilLanguage	$lng

LOMServices	$lom_services

bool	$call_by_reference

int	$max_title = self::TITLE_LENGTH

int	$max_desc = self::DESC_LENGTH

bool	$add_dots = true

int	$ref_id = null

string	$type = ""

string	$title = ""

string	$desc = ""

string	$long_desc = ""

int	$owner = 0

string	$create_date = ""

string	$last_update = ""

string	$import_id = ""

bool	$register = false

Additional Inherited Members
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255

const	DESC_LENGTH = 128

const	LONG_DESC_LENGTH = 4000

const	TABLE_OBJECT_DATA = "object_data"

array	$objectList

string	$untranslatedTitle

Static Protected Member Functions inherited from ilObjPortfolioBase
static	cloneBasics (ilObjPortfolioBase $a_source, ilObjPortfolioBase $a_target)
	Clone basic settings. More...

static	updateDomNodes (DOMDocument $a_dom, string $a_xpath, string $a_attr_id, string $a_attr_value)

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 22 of file class.ilObjPortfolioTemplate.php.

Member Function Documentation

◆ deleteAllPages()

ilObjPortfolioTemplate::deleteAllPages ( )

protected

Reimplemented from ilObjPortfolioBase.

Definition at line 67 of file class.ilObjPortfolioTemplate.php.

                                       : void
    {
        // delete pages
        $pages = ilPortfolioTemplatePage::getAllPortfolioPages($this->id);
        foreach ($pages as $page) {
            $page_obj = new ilPortfolioTemplatePage($page["id"]);
            $page_obj->setPortfolioId($this->id);
            $page_obj->delete();
        }
    }

References ilPortfolioPage\getAllPortfolioPages().

Here is the call graph for this function:

◆ doCloneObject()

ilObjPortfolioTemplate::doCloneObject	(	ilObject2	$new_obj,
		int	$a_target_id,
		?int	$a_copy_id = `null`
	)

protected

Reimplemented from ilObject2.

Definition at line 78 of file class.ilObjPortfolioTemplate.php.

                                                                                                  : void
    {
        assert($new_obj instanceof ilObjPortfolioTemplate);
        //copy online status if object is not the root copy object
        $cp_options = ilCopyWizardOptions::_getInstance($a_copy_id);
 
        /* should be handled by object
        if (!$cp_options->isRootNode($this->getRefId())) {
            $new_obj->setOnline($this->isOnline());
        }*/
 
        self::cloneBasics($this, $new_obj);
 
        // copy pages
        foreach (ilPortfolioPage::getAllPortfolioPages($this->getId()) as $page) {
            // see ilObjWiki::cloneObject();
 
            $page = new ilPortfolioTemplatePage($page["id"]);
 
            $new_page = new ilPortfolioTemplatePage();
            $new_page->setPortfolioId($new_obj->getId());
            $new_page->setTitle($page->getTitle());
            $new_page->setType($page->getType());
            $new_page->setOrderNr($page->getOrderNr());
            $new_page->create(false);
 
            $page->copy($new_page->getId(), "", $new_obj->getId(), true, $a_copy_id);
        }
    }

References ilCopyWizardOptions\_getInstance(), ilObjPortfolioBase\cloneBasics(), ilPortfolioPage\getAllPortfolioPages(), and ilObject\getId().

Here is the call graph for this function:

◆ doCreate()

ilObjPortfolioTemplate::doCreate ( bool $clone_mode = false )

protected

Reimplemented from ilObjPortfolioBase.

Definition at line 55 of file class.ilObjPortfolioTemplate.php.

                                                         : void
    {
        parent::doCreate($clone_mode);
        $this->updateActivation();
    }

References updateActivation().

Here is the call graph for this function:

◆ doRead()

ilObjPortfolioTemplate::doRead ( )

protected

Reimplemented from ilObjPortfolioBase.

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

                               : void
    {
        parent::doRead();
 
        if (($this->ref_id ?? 0) > 0) {
            $activation = ilObjectActivation::getItem($this->ref_id);
            switch ($activation["timing_type"]) {
                case ilObjectActivation::TIMINGS_ACTIVATION:
                    $this->setActivationLimited(true);
                    $this->setActivationStartDate($activation["timing_start"]);
                    $this->setActivationEndDate($activation["timing_end"]);
                    $this->setActivationVisibility($activation["visible"]);
                    break;
 
                default:
                    $this->setActivationLimited(false);
                    break;
            }
        }
    }

References ilObjectActivation\getItem(), setActivationEndDate(), setActivationLimited(), setActivationStartDate(), setActivationVisibility(), and ilObjectActivation\TIMINGS_ACTIVATION.

Here is the call graph for this function:

◆ doUpdate()

ilObjPortfolioTemplate::doUpdate ( )

protected

Reimplemented from ilObjPortfolioBase.

Definition at line 61 of file class.ilObjPortfolioTemplate.php.

                                 : void
    {
        parent::doUpdate();
        $this->updateActivation();
    }

References updateActivation().

Here is the call graph for this function:

◆ getActivationEndDate()

ilObjPortfolioTemplate::getActivationEndDate ( )

Definition at line 168 of file class.ilObjPortfolioTemplate.php.

                                          : ?int
    {
        return ($this->activation_ending_time > 0) ? $this->activation_ending_time : null;
    }

Referenced by updateActivation().

Here is the caller graph for this function:

◆ getActivationStartDate()

ilObjPortfolioTemplate::getActivationStartDate ( )

Definition at line 163 of file class.ilObjPortfolioTemplate.php.

                                            : ?int
    {
        return ($this->activation_starting_time > 0) ? $this->activation_starting_time : null;
    }

Referenced by updateActivation().

Here is the caller graph for this function:

◆ getActivationVisibility()

ilObjPortfolioTemplate::getActivationVisibility ( )

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

                                             : bool
    {
        return $this->activation_visibility;
    }

References $activation_visibility.

Referenced by updateActivation().

Here is the caller graph for this function:

◆ getAvailablePortfolioTemplates()

static ilObjPortfolioTemplate::getAvailablePortfolioTemplates ( string $a_permission = "read" )

static

Definition at line 177 of file class.ilObjPortfolioTemplate.php.

     : array {
        global $DIC;
 
        $ilUser = $DIC->user();
        $ilAccess = $DIC->access();
 
        $res = array();
 
        foreach (ilObject::_getObjectsByType("prtt") as $obj) {
            $has_permission = false;
 
            if ($obj["owner"] == $ilUser->getId()) {
                $has_permission = true;
            } else {
                foreach (ilObject::_getAllReferences($obj["obj_id"]) as $ref_id) {
                    if ($ilAccess->checkAccess($a_permission, "", $ref_id)) {
                        $has_permission = true;
                        break;
                    }
                }
            }
 
            if ($has_permission) {
                $res[$obj["obj_id"]] = $obj["title"];
            }
        }
 
        asort($res);
        return $res;
    }

Referenced by ilObjPortfolioGUI\createPortfolioFromAssignment(), ilExSubmissionObjectGUI\createPortfolioFromAssignmentObject(), ilObjPortfolioTemplateGUI\initCopyPageFormOptions(), ilObjPortfolioGUI\initCreateFromTemplateForm(), ilExSubmissionObjectGUI\setSelectedPortfolioTemplateObject(), and ilPortfolioRepositoryGUI\show().

Here is the caller graph for this function:

◆ initType()

ilObjPortfolioTemplate::initType ( )

protected

Reimplemented from ilObject2.

Definition at line 29 of file class.ilObjPortfolioTemplate.php.

                                 : void
    {
        $this->type = "prtt";
    }

◆ isActivationLimited()

ilObjPortfolioTemplate::isActivationLimited ( )

Definition at line 133 of file class.ilObjPortfolioTemplate.php.

                                         : bool
    {
        return $this->activation_limited;
    }

References $activation_limited.

Referenced by updateActivation().

Here is the caller graph for this function:

◆ setActivationEndDate()

ilObjPortfolioTemplate::setActivationEndDate ( ?int $ending_time = null )

Definition at line 158 of file class.ilObjPortfolioTemplate.php.

                                                                  : void
    {
        $this->activation_ending_time = $ending_time;
    }

Referenced by doRead().

Here is the caller graph for this function:

◆ setActivationLimited()

ilObjPortfolioTemplate::setActivationLimited ( bool $a_value )

Definition at line 138 of file class.ilObjPortfolioTemplate.php.

                                                       : void
    {
        $this->activation_limited = $a_value;
    }

Referenced by doRead().

Here is the caller graph for this function:

◆ setActivationStartDate()

ilObjPortfolioTemplate::setActivationStartDate ( ?int $starting_time = null )

Definition at line 153 of file class.ilObjPortfolioTemplate.php.

                                                                      : void
    {
        $this->activation_starting_time = $starting_time;
    }

Referenced by doRead().

Here is the caller graph for this function:

◆ setActivationVisibility()

ilObjPortfolioTemplate::setActivationVisibility ( bool $a_value )

Definition at line 143 of file class.ilObjPortfolioTemplate.php.

                                                          : void
    {
        $this->activation_visibility = $a_value;
    }

Referenced by doRead().

Here is the caller graph for this function:

◆ updateActivation()

ilObjPortfolioTemplate::updateActivation ( )

protected

Definition at line 113 of file class.ilObjPortfolioTemplate.php.

                                         : void
    {
        // moved activation to ilObjectActivation
        if (($this->ref_id ?? 0) > 0) {
            ilObjectActivation::getItem($this->ref_id);
 
            $item = new ilObjectActivation();
            if (!$this->isActivationLimited()) {
                $item->setTimingType(ilObjectActivation::TIMINGS_DEACTIVATED);
            } else {
                $item->setTimingType(ilObjectActivation::TIMINGS_ACTIVATION);
                $item->setTimingStart($this->getActivationStartDate());
                $item->setTimingEnd($this->getActivationEndDate());
                $item->toggleVisible($this->getActivationVisibility());
            }
 
            $item->update($this->ref_id);
        }
    }