ilObjPortfolio Class Reference

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

Inheritance diagram for ilObjPortfolio:

Collaboration diagram for ilObjPortfolio:

Public Member Functions
	isCommentsExportPossible ()
	Is export possible. More...
Public Member Functions inherited from ilObjPortfolioBase
	__construct (int $a_id=0, bool $a_reference=true)
	setOnline (bool $a_value)
	isOnline ()
	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 ()
	cloneMetaData (ilObject $target_obj)
	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	getPortfoliosOfUser (int $a_user_id)
	Get portfolios of user. More...
static	getDefaultPortfolio (int $a_user_id)
static	deleteUserPortfolios (int $a_user_id)
	Delete all portfolio data for user. More...
static	getAvailablePortfolioLinksForUserIds (array $a_owner_ids, ?string $a_back_url=null)
static	getAdvMDSubItemTitle (int $a_obj_id, string $a_sub_type, int $a_sub_id)
Static Public Member Functions inherited from ilObjPortfolioBase
static	lookupOnline (int $a_id)
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 ()
	deleteAllPages ()
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 ()

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)
Protected Attributes inherited from ilObjPortfolioBase
ILIAS Notes Service	$notes
ilSetting	$setting
bool	$online = false
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

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 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 23 of file class.ilObjPortfolio.php.

Member Function Documentation

deleteAllPages()

ilObjPortfolio::deleteAllPages ( )

protected

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

References Vendor\Package\$e, and ilPortfolioPage\getAllPortfolioPages().

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

Here is the call graph for this function:

deleteUserPortfolios()

static ilObjPortfolio::deleteUserPortfolios ( int  $a_user_id )

static

Delete all portfolio data for user.

Definition at line 86 of file class.ilObjPortfolio.php.

Referenced by ilObjUser\delete().

                                                               : void
    {
        $all = self::getPortfoliosOfUser($a_user_id);
        if ($all) {
            $access_handler = new ilPortfolioAccessHandler();

            foreach ($all as $item) {
                $access_handler->removePermission($item["id"]);

                $portfolio = new self($item["id"], false);
                $portfolio->delete();
            }
        }
    }

Here is the caller graph for this function:

getAdvMDSubItemTitle()

static ilObjPortfolio::getAdvMDSubItemTitle ( int  $a_obj_id, string  $a_sub_type, int  $a_sub_id  )

static

Implements ilAdvancedMetaDataSubItems.

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

                                                                                                 : string
    {
        return \ilPortfolioPage::lookupTitle($a_sub_id);
    }

getAvailablePortfolioLinksForUserIds()

static ilObjPortfolio::getAvailablePortfolioLinksForUserIds ( array  $a_owner_ids, ?string  $a_back_url = null  )

static

Definition at line 101 of file class.ilObjPortfolio.php.

References $id, $params, $res, ilObject\$title, $url, and null.

Referenced by ilPublicUserProfileGUI\getEmbeddable(), ilLearningSequenceRoles\readMemberData(), ilObjGroupGUI\readMemberData(), and ilObjCourseGUI\readMemberData().

     : array {
        $res = array();

        $access_handler = new ilPortfolioAccessHandler();

        $params = null;
        if ($a_back_url) {
            //$params = array("back_url" => rawurlencode($a_back_url));
        }
        $params = [];

        foreach ($access_handler->getShardObjectsDataForUserIds($a_owner_ids) as $owner_id => $items) {
            foreach ($items as $id => $title) {
                $url = ilLink::_getLink($id, 'prtf', $params);
                $res[$owner_id][$url] = $title;
            }
        }

        return $res;
    }

Here is the caller graph for this function:

getDefaultPortfolio()

static ilObjPortfolio::getDefaultPortfolio ( int  $a_user_id )

static

Deprecated:

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

References null.

Referenced by ilUserProfileBadge\evaluate(), ilPublicUserProfileGUI\getProfilePortfolio(), ilPersonalProfileGUI\getProfilePortfolio(), ilBuddySystemNotification\hasPublicProfile(), and ilPortfolioAccessHandler\syncProfile().

                                                              : ?int
    {
        return null;
    }

Here is the caller graph for this function:

getPortfoliosOfUser()

static ilObjPortfolio::getPortfoliosOfUser ( int  $a_user_id )

static

Get portfolios of user.

Returns

array[]

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

References $DIC, $ilDB, and $res.

Referenced by ilExAssTypePortfolioGUI\buildSubmissionPropertiesAndActions(), ilExSubmissionObjectGUI\getOverviewContentPortfolio(), ilPortfolioRepositoryGUI\getPortfolioList(), ilObjPortfolioGUI\initCopyPageFormOptions(), ilObjPortfolioTemplateGUI\initDidacticTemplate(), and ilExSubmissionObjectGUI\selectPortfolioObject().

     : array {
        global $DIC;

        $ilDB = $DIC->database();

        $set = $ilDB->query("SELECT up.*,od.title,od.description" .
            " FROM usr_portfolio up" .
            " JOIN object_data od ON (up.id = od.obj_id)" .
            " WHERE od.owner = " . $ilDB->quote($a_user_id, "integer") .
            " AND od.type = " . $ilDB->quote("prtf", "text") .
            " ORDER BY od.title");
        $res = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            $res[] = $rec;
        }
        return $res;
    }

Here is the caller graph for this function:

initType()

ilObjPortfolio::initType ( )

protected

Definition at line 25 of file class.ilObjPortfolio.php.

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

isCommentsExportPossible()

ilObjPortfolio::isCommentsExportPossible

(

)

Is export possible.

Definition at line 128 of file class.ilObjPortfolio.php.

References ilObjPortfolioBase\$setting, ilSetting\get(), and ilPrivacySettings\getInstance().

                                              : bool
    {
        $setting = $this->setting;
        $privacy = ilPrivacySettings::getInstance();
        if ($setting->get("disable_comments")) {
            return false;
        }
        if (!$this->notes->domain()->commentsActive($this->id)) {
            return false;
        }
        if (!$privacy->enabledCommentsExport()) {
            return false;
        }
        return true;
    }

Here is the call graph for this function:

---

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

• components/ILIAS/Portfolio/classes/class.ilObjPortfolio.php