ilObjPortfolio Class Reference

Portfolio. More...

Inheritance diagram for ilObjPortfolio:

Collaboration diagram for ilObjPortfolio:

Public Member Functions
	initType ()
	setDefault ($a_value)
	Set default. More...
	isDefault ()
	Is default? More...
	deleteImage ()
	uploadImage (array $a_upload)
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 public. More...
	withReferences ()
	read ()
	Read data from db. More...
	getId ()
	setId ($a_id)
	setRefId ($a_id)
	getRefId ()
	getType ()
	setType ($a_type)
	getPresentationTitle ()
	getTitle ()
	getUntranslatedTitle ()
	setTitle ($a_title)
	getDescription ()
	setDescription ($a_desc)
	getLongDescription ()
	getImportId ()
	setImportId ($a_import_id)
	getOwner ()
	getOwnerName ()
	setOwner ($a_owner)
	getCreateDate ()
	getLastUpdateDate ()
	create ($a_clone_mode=false)
	update ()
	MDUpdateListener ($a_element)
	createMetaData ()
	updateMetaData ()
	deleteMetaData ()
	updateOwner ()
	putInTree ($a_parent_ref)
	setPermissions ($a_parent_ref)
	createReference ()
	countReferences ()
	delete ()
	initDefaultRoles ()
	setRegisterMode ($a_bool)
	isUserRegistered ($a_user_id=0)
	requireRegistration ()
	appendCopyInfo ($a_target_id, $a_copy_id)
	cloneMetaData ($target_obj)
	cloneObject ($a_target_id, $a_copy_id=null, $a_omit_tree=false)
	cloneDependencies ($a_target_id, $a_copy_id)
Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor 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 public More...
	setId ($a_id)
	set object id public More...
	setRefId ($a_id)
	set reference id public More...
	getRefId ()
	get reference id public More...
	getType ()
	get object type public More...
	setType ($a_type)
	set object type public More...
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...
	getTitle ()
	get object title public More...
	getUntranslatedTitle ()
	get untranslated object title 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 public More...
	getLastUpdateDate ()
	get last update date 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...
	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) 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	setUserDefault ($a_user_id, $a_portfolio_id=null)
	Set the user default portfolio. More...
static	getPortfoliosOfUser ($a_user_id)
	Get views of user. More...
static	getDefaultPortfolio ($a_user_id)
	Get default portfolio of user. More...
static	deleteUserPortfolios ($a_user_id)
	Delete all portfolio data for user. More...
static	getAvailablePortfolioLinksForUserIds (array $a_owner_ids, $a_back_url=null)
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)
static	_getIdForImportId ($a_import_id)
static	_getAllReferences ($a_id)
static	_lookupTitle ($a_id)
static	_lookupOwner ($a_id)
static	_getIdsForTitle ($title, $type='', $partialmatch=false)
static	_lookupDescription ($a_id)
static	_lookupLastUpdate ($a_id, $a_as_string=false)
static	_getLastUpdateOfObjects ($a_objs)
static	_lookupObjId ($a_id)
static	_setDeletedDate ($a_ref_id)
static	_resetDeletedDate ($a_ref_id)
static	_lookupDeletedDate ($a_ref_id)
static	_writeTitle ($a_obj_id, $a_title)
static	_writeDescription ($a_obj_id, $a_desc)
static	_writeImportId ($a_obj_id, $a_import_id)
static	_lookupType ($a_id, $a_reference=false)
static	_isInTrash ($a_ref_id)
static	_hasUntrashedReference ($a_obj_id)
static	_lookupObjectId ($a_ref_id)
static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
static	_exists ($a_id, $a_reference=false, $a_type=null)
static	_getObjectsByType ($a_obj_type="", $a_owner="")
static	_prepareCloneSelection ($a_ref_ids, $new_type, $a_show_path=true)
static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
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)
	only called in ilTree::saveSubTree More...
static	setDeletedDates ($a_ref_ids)
	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 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	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
	doReadCustom (array $a_row)
	doUpdate ()
	doUpdateCustom (array &$a_fields)
	deleteAllPages ()
	handleQuotaUpdate ()
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 ()
	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
	$default
Protected Attributes inherited from ilObjPortfolioBase
	$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

Version

$Id$

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

Member Function Documentation

deleteAllPages()

ilObjPortfolio::deleteAllPages ( )

protected

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

References ilPortfolioPage\getAllPortfolioPages().

    {
        // delete pages
        include_once "Modules/Portfolio/classes/class.ilPortfolioPage.php";
        $pages = ilPortfolioPage::getAllPortfolioPages($this->id);
        foreach ($pages as $page) {
            $page_obj = new ilPortfolioPage($page["id"]);
            $page_obj->setPortfolioId($this->id);
            $page_obj->delete();
        }
    }

Here is the call graph for this function:

deleteImage()

ilObjPortfolio::deleteImage

(

)

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

References handleQuotaUpdate().

    {
        if ($this->id) {
            parent::deleteImage();
            $this->handleQuotaUpdate();
        }
    }

Here is the call graph for this function:

deleteUserPortfolios()

static ilObjPortfolio::deleteUserPortfolios (   $a_user_id )

static

Delete all portfolio data for user.

Parameters

int

$a_user_id

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

Referenced by ilObjUser\delete().

    {
        $all = self::getPortfoliosOfUser($a_user_id);
        if ($all) {
            include_once "Modules/Portfolio/classes/class.ilPortfolioAccessHandler.php";
            $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:

doReadCustom()

ilObjPortfolio::doReadCustom ( array  $a_row )

protected

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

References setDefault().

    {
        $this->setDefault((bool) $a_row["is_default"]);
    }

Here is the call graph for this function:

doUpdate()

ilObjPortfolio::doUpdate ( )

protected

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

References isDefault(), ilObjPortfolioBase\isOnline(), and setDefault().

    {
        // must be online to be default
        if (!$this->isOnline() && $this->isDefault()) {
            $this->setDefault(false);
        }
    
        parent::doUpdate();
    }

Here is the call graph for this function:

doUpdateCustom()

ilObjPortfolio::doUpdateCustom ( array &  $a_fields )

protected

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

References isDefault().

    {
        $a_fields["is_default"] = array("integer", $this->isDefault());
    }

Here is the call graph for this function:

getAvailablePortfolioLinksForUserIds()

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

static

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

References ilObject\$id, PHPMailer\PHPMailer\$params, $res, ilObject\$title, $url, and ilLink\_getLink().

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

    {
        $res = array();
        
        include_once "Modules/Portfolio/classes/class.ilPortfolioAccessHandler.php";
        $access_handler = new ilPortfolioAccessHandler();
        
        $params = null;
        if ($a_back_url) {
            $params = array("back_url" => rawurlencode($a_back_url));
        }
        
        include_once "Services/Link/classes/class.ilLink.php";
        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 call graph for this function:

Here is the caller graph for this function:

getDefaultPortfolio()

static ilObjPortfolio::getDefaultPortfolio (   $a_user_id )

static

Get default portfolio of user.

Parameters

type

$a_user_id

Returns

int

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

References $DIC, $ilDB, $ilSetting, and $res.

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

    {
        global $DIC;

        $ilDB = $DIC->database();
        $ilSetting = $DIC->settings();
        
        if (!$ilSetting->get('user_portfolios')) {
            return;
        }
            
        $set = $ilDB->query("SELECT up.id FROM usr_portfolio up" .
            " JOIN object_data od ON (up.id = od.obj_id)" .
            " WHERE od.owner = " . $ilDB->quote($a_user_id, "integer") .
            " AND up.is_default = " . $ilDB->quote(1, "integer"));
        $res = $ilDB->fetchAssoc($set);
        if ($res["id"]) {
            return $res["id"];
        }
    }

Here is the caller graph for this function:

getPortfoliosOfUser()

static ilObjPortfolio::getPortfoliosOfUser (   $a_user_id )

static

Get views of user.

Parameters

int

$a_user_id

Returns

array

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

References $DIC, $ilDB, and $res.

Referenced by ilPDPortfolioBlockGUI\fillDataSection(), ilPortfolioTableGUI\getItems(), ilExSubmissionObjectGUI\getOverviewContentPortfolio(), ilPortfolioRepositoryGUI\getPortfolioList(), ilObjPortfolioGUI\initCopyPageFormOptions(), ilObjPortfolioTemplateGUI\initDidacticTemplate(), and ilExSubmissionObjectGUI\selectPortfolioObject().

    {
        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:

handleQuotaUpdate()

ilObjPortfolio::handleQuotaUpdate ( )

protected

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

References ilUtil\dirsize(), ilObject2\getId(), ilObject2\getType(), ilDiskQuotaHandler\handleUpdatedSourceObject(), and ilObjPortfolioBase\initStorage().

Referenced by deleteImage(), and uploadImage().

    {
        include_once "Services/DiskQuota/classes/class.ilDiskQuotaHandler.php";
        ilDiskQuotaHandler::handleUpdatedSourceObject(
            $this->getType(),
            $this->getId(),
            ilUtil::dirsize($this->initStorage($this->getId())),
            array($this->getId()),
            true
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initType()

ilObjPortfolio::initType

(

)

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

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

isDefault()

ilObjPortfolio::isDefault

(

)

Is default?

Returns

bool

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

References $default.

Referenced by doUpdate(), and doUpdateCustom().

    {
        return $this->default;
    }

Here is the caller graph for this function:

setDefault()

ilObjPortfolio::setDefault

(

$a_value

)

Set default.

Parameters

bool

$a_value

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

Referenced by doReadCustom(), and doUpdate().

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

Here is the caller graph for this function:

setUserDefault()

static ilObjPortfolio::setUserDefault (   $a_user_id,   $a_portfolio_id = null  )

static

Set the user default portfolio.

Parameters

int	$a_user_id
int	$a_portfolio_id

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

References $DIC, and $ilDB.

Referenced by ilPortfolioRepositoryGUI\setDefault(), ilPortfolioAccessHandler\syncProfile(), ilPortfolioRepositoryGUI\unsetDefault(), and ilObjPortfolioGUI\updateCustom().

    {
        global $DIC;

        $ilDB = $DIC->database();
        
        $all = array();
        foreach (self::getPortfoliosOfUser($a_user_id) as $item) {
            $all[] = $item["id"];
        }
        if ($all) {
            $ilDB->manipulate("UPDATE usr_portfolio" .
                " SET is_default = " . $ilDB->quote(false, "integer") .
                " WHERE " . $ilDB->in("id", $all, "", "integer"));
        }

        if ($a_portfolio_id) {
            $ilDB->manipulate("UPDATE usr_portfolio" .
                " SET is_default = " . $ilDB->quote(true, "integer") .
                " WHERE id = " . $ilDB->quote($a_portfolio_id, "integer"));
        }
    }

Here is the caller graph for this function:

uploadImage()

ilObjPortfolio::uploadImage

(

array

$a_upload

)

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

References handleQuotaUpdate().

    {
        if (parent::uploadImage($a_upload)) {
            $this->handleQuotaUpdate();
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Field Documentation

$default

ilObjPortfolio::$default

protected

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

Referenced by isDefault().

---

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

• Modules/Portfolio/classes/class.ilObjPortfolio.php