Portfolio. More...

Inheritance diagram for ilObjPortfolioTemplate:

Collaboration diagram for ilObjPortfolioTemplate:

Public Member Functions
	initType ()

	isActivationLimited ()

	setActivationLimited ($a_value)

	setActivationVisibility ($a_value)

	getActivationVisibility ()

	setActivationStartDate ($starting_time=null)

	setActivationEndDate ($ending_time=null)

	getActivationStartDate ()

	getActivationEndDate ()

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

	setOnline ($a_value)
	Set online status. More...

	isOnline ()
	Is online? More...

	setPublicComments ($a_value)
	Set public comments status. More...

	hasPublicComments ()
	Active public comments? More...

	hasProfilePicture ()
	Get profile picture status. More...

	setProfilePicture ($a_status)
	Toggle profile picture status. More...

	getBackgroundColor ()
	Get background color. More...

	setBackgroundColor ($a_value)
	Set background color. More...

	getFontColor ()
	Get font color. More...

	setFontColor ($a_value)
	Set font color. More...

	getImage ()
	Get banner image. More...

	setImage ($a_value)
	Set banner image. More...

	getStyleSheetId ()
	Get style sheet id. More...

	setStyleSheetId ($a_style)
	Set style sheet id. More...

	getImageFullPath ($a_as_thumb=false)
	Get banner image incl. More...

	deleteImage ()
	remove existing file More...

	uploadImage (array $a_upload)
	Upload new image file. More...

	fixLinksOnTitleChange ($a_title_changes)
	Fix internal portfolio links. More...

Public Member Functions inherited from ilObject2
	__construct ($a_id=0, $a_reference=true)
	Constructor @access public. More...

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

	read ()
	Read data from db. More...

	setRefId ($a_id)
	set reference id @access public More...

	getRefId ()
	get reference id @access public More...

	getType ()
	get object type @access public More...

	setType ($a_type)
	set object type @access public More...

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

	getTitle ()
	get object title @access public More...

	getUntranslatedTitle ()
	get untranslated object title @access public More...

	setTitle ($a_title)
	set object title More...

	getDescription ()
	get object description More...

	setDescription ($a_desc)
	set object description More...

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

	getImportId ()
	get import id More...

	setImportId ($a_import_id)
	set import id More...

	getOwner ()
	get object owner More...

	getOwnerName ()

	setOwner ($a_owner)
	set object owner More...

	getCreateDate ()
	get create date @access public More...

	getLastUpdateDate ()
	get last update date @access public More...

	create ($a_clone_mode=false)

	update ()
	update object in db More...

	MDUpdateListener ($a_element)
	Meta data update listener. More...

	createMetaData ()
	create meta data entry More...

	updateMetaData ()
	update meta data entry More...

	deleteMetaData ()
	delete meta data entry More...

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

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

	setPermissions ($a_parent_ref)
	set permissions of object More...

	createReference ()
	creates reference for object More...

	countReferences ()
	count references of object More...

	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 If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) @access public More...

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container. More...

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

	cloneObject ($a_target_id, $a_copy_id=null, $a_omit_tree=false)

	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...

Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor @access public. More...

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

	read ()
	read object data from db into object More...

	getId ()
	get object id @access public More...

	setId ($a_id)
	set object id @access public More...

	setRefId ($a_id)
	set reference id @access public More...

	getRefId ()
	get reference id @access public More...

	getType ()
	get object type @access public More...

	setType ($a_type)
	set object type @access public More...

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

	getTitle ()
	get object title @access public More...

	getUntranslatedTitle ()
	get untranslated object title @access public More...

	setTitle ($a_title)
	set object title More...

	getDescription ()
	get object description More...

	setDescription ($a_desc)
	set object description More...

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

	getImportId ()
	get import id More...

	setImportId ($a_import_id)
	set import id More...

	setOfflineStatus ($a_status)
	Set offline status. More...

	getOfflineStatus ()
	Get offline status. More...

	supportsOfflineHandling ()
	Check whether object supports offline handling. More...

	getOwner ()
	get object owner More...

	getOwnerName ()

	setOwner ($a_owner)
	set object owner More...

	getCreateDate ()
	get create date @access public More...

	getLastUpdateDate ()
	get last update date @access public More...

	getDiskUsage ()
	Gets the disk usage of the object in bytes. More...

	create ()
	create More...

	update ()
	update object in db More...

	MDUpdateListener ($a_element)
	Meta data update listener. More...

	createMetaData ()
	create meta data entry More...

	updateMetaData ()
	update meta data entry More...

	deleteMetaData ()
	delete meta data entry More...

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

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

	setPermissions ($a_parent_ref)
	set permissions of object More...

	setParentRolePermissions ($a_parent_ref)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...

	createReference ()
	creates reference for object More...

	countReferences ()
	count references of object More...

	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 If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) @access public More...

	applyDidacticTemplate ($a_tpl_id)
	Apply template. More...

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...

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

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

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

Static Public Member Functions inherited from ilObjPortfolioBase
static	lookupOnline ($a_id)
	Is online? More...

static	initStorage ($a_id, $a_subdir=null)
	Init file system storage. More...

static	clonePagesAndSettings (ilObjPortfolioBase $a_source, ilObjPortfolioBase $a_target, array $a_recipe=null, $copy_all=false)
	Build template from portfolio and vice versa. More...

Static Public Member Functions inherited from ilObject2
static	_lookupObjIdByImportId ($a_import_id)

static	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...

static	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...

static	_getAllReferences ($a_id)
	get all reference ids of object More...

static	_lookupTitle ($a_id)
	lookup object title More...

static	_lookupOwner ($a_id)
	lookup object owner More...

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)
	lookup object description More...

static	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...

static	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...

static	_lookupObjId ($a_id)

static	_setDeletedDate ($a_ref_id, $a_deleted_by)

static	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...

static	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...

static	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...

static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...

static	_isInTrash ($a_ref_id)
	checks wether object is in trash More...

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

static	_lookupObjectId ($a_ref_id)
	lookup object id More...

static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...

static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data@access public More...

static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...

static	_prepareCloneSelection ($a_ref_ids, $new_type, $a_show_path=true)
	Prepare copy wizard object selection. More...

static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item. More...

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)

static	_lookupImportId ($a_obj_id)

static	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...

static	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...

static	_getAllReferences ($a_id)
	get all reference ids of object More...

static	_lookupTitle ($a_id)
	lookup object title More...

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

static	_lookupOwner ($a_id)
	lookup object owner More...

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)
	lookup object description More...

static	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...

static	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...

static	_lookupObjId ($a_id)

static	_setDeletedDate ($a_ref_id, $a_deleted_by)

static	setDeletedDates ($a_ref_ids, $a_user_id)
	Set deleted date. More...

static	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...

static	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...

static	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...

static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...

static	_isInTrash ($a_ref_id)
	checks wether object is in trash More...

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

static	_lookupObjectId ($a_ref_id)
	lookup object id More...

static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...

static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data@access public More...

static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...

static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection. More...

static	_getIcon ( $a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $a_obj_ids)
	Get long description data. More...

static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns. More...

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

static	_lookupCreationDate ($a_id)
	Lookup creation date. More...

static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...

Protected Member Functions
	doRead ()

	doCreate ()

	doUpdate ()

	deleteAllPages ()

	doCloneObject ($new_obj, $a_target_id, $a_copy_id=null)

	updateActivation ()

Protected Member Functions inherited from ilObjPortfolioBase
	doRead ()

	doReadCustom (array $a_row)

	doCreate ()

	doUpdate ()

	doUpdateCustom (array &$a_fields)

	doDelete ()

	deleteAllPages ()

Protected Member Functions inherited from ilObject2
	initType ()

	doRead ()

	doCreate ()

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

	doUpdate ()

	beforeUpdate ()

	doMDUpdateListener ($a_element)

	beforeMDUpdateListener ($a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDelete ()

	beforeDelete ()

	doCloneObject ($new_obj, $a_target_id, $a_copy_id=null)

	beforeCloneObject ()

Protected Attributes
	$activation_limited

	$activation_visibility

	$activation_starting_time

	$activation_ending_time

Protected Attributes inherited from ilObjPortfolioBase
	$setting

	$online

	$comments

	$bg_color

	$font_color

	$img

	$ppic

	$style

Protected Attributes inherited from ilObject
	$objDefinition

	$db

	$log

	$error

	$tree

	$app_event_handler

	$rbacadmin

	$rbacreview

Additional Inherited Members
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...

const	DESC_LENGTH = 128

	$lng

	$id

	$ref_id

	$type

	$title

	$untranslatedTitle

	$desc

	$long_desc

	$owner

	$create_date

	$last_update

	$import_id

	$register = false

	$referenced

	$objectList

	$max_title

	$max_desc

	$add_dots

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

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

static	createBlogInPersonalWorkspace ($a_title)

Detailed Description

Portfolio.

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 10 of file class.ilObjPortfolioTemplate.php.

Member Function Documentation

◆ deleteAllPages()

ilObjPortfolioTemplate::deleteAllPages ( )

protected

Reimplemented from ilObjPortfolioBase.

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

    {
        // 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	(	$new_obj,
		$a_target_id,
		$a_copy_id = `null`
	)

protected

Reimplemented from ilObject2.

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

    {
        //copy online status if object is not the root copy object
        $cp_options = ilCopyWizardOptions::_getInstance($a_copy_id);
 
        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();
            
            $page->copy($new_page->getId(), "", 0, true);
        }
    }

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

Here is the call graph for this function:

◆ doCreate()

ilObjPortfolioTemplate::doCreate ( )

protected

Reimplemented from ilObjPortfolioBase.

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

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

References updateActivation().

Here is the call graph for this function:

◆ doRead()

ilObjPortfolioTemplate::doRead ( )

protected

Reimplemented from ilObjPortfolioBase.

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

    {
        parent::doRead();
        
        if ($this->ref_id) {
            $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 49 of file class.ilObjPortfolioTemplate.php.

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

References updateActivation().

Here is the call graph for this function:

◆ getActivationEndDate()

ilObjPortfolioTemplate::getActivationEndDate ( )

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

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

Referenced by updateActivation().

Here is the caller graph for this function:

◆ getActivationStartDate()

ilObjPortfolioTemplate::getActivationStartDate ( )

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

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

Referenced by updateActivation().

Here is the caller graph for this function:

◆ getActivationVisibility()

ilObjPortfolioTemplate::getActivationVisibility ( )

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

    {
        return $this->activation_visibility;
    }

References $activation_visibility.

Referenced by updateActivation().

Here is the caller graph for this function:

◆ getAvailablePortfolioTemplates()

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

static

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

    {
        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;
    }

References $DIC, $ilUser, ilObject\$ref_id, $res, ilObject\_getAllReferences(), and ilObject\_getObjectsByType().

Referenced by ilObjPortfolioGUI\createFromTemplateDirect(), ilObjPortfolioGUI\createPortfolioFromAssignment(), ilExSubmissionObjectGUI\createPortfolioFromAssignmentObject(), ilObjPortfolioGUI\createPortfolioFromTemplate(), ilObjPortfolioGUI\createPortfolioFromTemplateProcess(), ilExSubmissionObjectGUI\createPortfolioTemplateObject(), ilObjPortfolioTemplateGUI\initCopyPageFormOptions(), ilObjPortfolioGUI\initCreateForm(), and ilExSubmissionObjectGUI\setSelectedPortfolioTemplateObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initType()

ilObjPortfolioTemplate::initType ( )

Reimplemented from ilObject2.

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

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

◆ isActivationLimited()

ilObjPortfolioTemplate::isActivationLimited ( )

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

    {
        return (bool) $this->activation_limited;
    }

References $activation_limited.

Referenced by updateActivation().

Here is the caller graph for this function:

◆ setActivationEndDate()

ilObjPortfolioTemplate::setActivationEndDate ( $ending_time = null )

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

    {
        $this->activation_ending_time = $ending_time;
    }

Referenced by doRead().

Here is the caller graph for this function:

◆ setActivationLimited()

ilObjPortfolioTemplate::setActivationLimited ( $a_value )

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

    {
        $this->activation_limited = (bool) $a_value;
    }

Referenced by doRead().

Here is the caller graph for this function:

◆ setActivationStartDate()

ilObjPortfolioTemplate::setActivationStartDate ( $starting_time = null )

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

    {
        $this->activation_starting_time = $starting_time;
    }

Referenced by doRead().

Here is the caller graph for this function:

◆ setActivationVisibility()

ilObjPortfolioTemplate::setActivationVisibility ( $a_value )

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

    {
        $this->activation_visibility = (bool) $a_value;
    }

Referenced by doRead().

Here is the caller graph for this function:

◆ updateActivation()

ilObjPortfolioTemplate::updateActivation ( )

protected

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

    {
        // moved activation to ilObjectActivation
        if ($this->ref_id) {
            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);
        }
    }