ilObjPortfolio Class Reference

Portfolio. More...

Inheritance diagram for ilObjPortfolio:

Collaboration diagram for ilObjPortfolio:

Public Member Functions
	initType ()
	setDefault ($a_value)
	Set default.
	isDefault ()
	Is default?
	deleteImage ()
	remove existing file
	uploadImage (array $a_upload)
	Upload new image file.
Public Member Functions inherited from ilObjPortfolioBase
	setOnline ($a_value)
	Set online status.
	isOnline ()
	Is online?
	setPublicComments ($a_value)
	Set public comments status.
	hasPublicComments ()
	Active public comments?
	hasProfilePicture ()
	Get profile picture status.
	setProfilePicture ($a_status)
	Toggle profile picture status.
	getBackgroundColor ()
	Get background color.
	setBackgroundColor ($a_value)
	Set background color.
	getFontColor ()
	Get font color.
	setFontColor ($a_value)
	Set font color.
	getImage ()
	Get banner image.
	setImage ($a_value)
	Set banner image.
	getStyleSheetId ()
	Get style sheet id.
	setStyleSheetId ($a_style)
	Set style sheet id.
	getImageFullPath ($a_as_thumb=false)
	Get banner image incl.
Public Member Functions inherited from ilObject2
	__construct ($a_id=0, $a_reference=true)
	Constructor public.
	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not)
	read ($a_force_db=false)
	Read data from db.
	getId ()
	get object id public
	setId ($a_id)
	set object id public
	setRefId ($a_id)
	set reference id public
	getRefId ()
	get reference id public
	getType ()
	get object type public
	setType ($a_type)
	set object type public
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions
	getTitle ()
	get object title public
	getUntranslatedTitle ()
	get untranslated object title public
	setTitle ($a_title)
	set object title
	getDescription ()
	get object description
	setDescription ($a_desc)
	set object description
	getLongDescription ()
	get object long description (stored in object_description)
	getImportId ()
	get import id
	setImportId ($a_import_id)
	set import id
	getOwner ()
	get object owner
	getOwnerName ()
	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id
	setOwner ($a_owner)
	set object owner
	getCreateDate ()
	get create date public
	getLastUpdateDate ()
	get last update date public
	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class)
	create ($a_clone_mode=false)
	update ()
	update object in db
	MDUpdateListener ($a_element)
	Meta data update listener.
	createMetaData ()
	create meta data entry
	updateMetaData ()
	update meta data entry
	deleteMetaData ()
	delete meta data entry
	updateOwner ()
	update owner of object in db
	_getIdForImportId ($a_import_id)
	get current object id for import id (static)
	_lookupOwner ($a_id)
	lookup object owner
	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update
	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects.
	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree
	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes
	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes
	_writeTitle ($a_obj_id, $a_title)
	write title to db (static)
	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static)
	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static)
	_isInTrash ($a_ref_id)
	checks wether object is in trash
	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash
	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type
	putInTree ($a_parent_ref)
	maybe this method should be in tree object!?
	setPermissions ($a_parent_ref)
	set permissions of object
	createReference ()
	creates reference for object
	countReferences ()
	count references of object
	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!!
	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
	notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
	notifys an object about an event occured Based on the event passed, each object may decide how it reacts.
	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.
	cloneMetaData ($target_obj)
	Copy meta data.
	cloneObject ($a_target_id, $a_copy_id=null, $a_omit_tree=false)
	Clone object permissions, put in tree ...
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies.
Public Member Functions inherited from ilObject
	ilObject ($a_id=0, $a_reference=true)
	Constructor public.
	getDiskUsage ()
	Gets the disk usage of the object in bytes.
	create ()
	create
	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.
	applyDidacticTemplate ($a_tpl_id)
	Apply template.
	getXMLZip ()
	getHTMLDirectory ()
	_lookupCreationDate ($a_id)
	Lookup creation date.

Static Public Member Functions
static	setUserDefault ($a_user_id, $a_portfolio_id=null)
	Set the user default portfolio.
static	getPortfoliosOfUser ($a_user_id)
	Get views of user.
static	getDefaultPortfolio ($a_user_id)
	Get default portfolio of user.
static	deleteUserPortfolios ($a_user_id)
	Delete all portfolio data for user.
static	getAvailablePortfolioLinksForUserIds (array $a_owner_ids, $a_back_url=null)
Static Public Member Functions inherited from ilObjPortfolioBase
static	lookupOnline ($a_id)
	Is online?
static	initStorage ($a_id, $a_subdir=null)
	Init file system storage.
static	clonePagesAndSettings (ilObjPortfolioBase $a_source, ilObjPortfolioBase $a_target, array $a_recipe=null)
	Build template from portfolio and vice versa.
Static Public Member Functions inherited from ilObject2
static	_lookupObjIdByImportId ($a_import_id)
static	_getAllReferences ($a_id)
	get all reference ids of object
static	_lookupTitle ($a_id)
	lookup object title
static	_getIdsForTitle ($title, $type= '', $partialmatch=false)
static	_lookupDescription ($a_id)
	lookup object description
static	_lookupObjId ($a_id)
static	_lookupType ($a_id, $a_reference=false)
	lookup object type
static	_lookupObjectId ($a_ref_id)
	lookup object id
static	_exists ($a_id, $a_reference=false)
static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type.
static	_prepareCloneSelection ($a_ref_ids, $new_type)
static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item.
Static Public Member Functions inherited from ilObject
static	setDeletedDates ($a_ref_ids)
	Set deleted date type $ilDB.
static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data
static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection.
static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies.
static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies.
static	getLongDescriptions (array $a_obj_ids)
	Get long description data.
static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns.
static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course.

Protected Member Functions
	doReadCustom (array $a_row)
	doUpdate ()
	doUpdateCustom (array &$a_fields)
	deleteAllPages ()
	handleQuotaUpdate ()
Protected Member Functions inherited from ilObjPortfolioBase
	doRead ()
	doCreate ()
	doDelete ()
Protected Member Functions inherited from ilObject2
	beforeCreate ()
	beforeUpdate ()
	doMDUpdateListener ($a_element)
	beforeMDUpdateListener ($a_element)
	doCreateMetaData ()
	beforeCreateMetaData ()
	doUpdateMetaData ()
	beforeUpdateMetaData ()
	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

Additional Inherited Members
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title
const	DESC_LENGTH = 128
	$ilias
	$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
	$obj_data_record
	object_data record
Static Protected Member Functions inherited from ilObjPortfolioBase
static	cloneBasics (ilObjPortfolioBase $a_source, ilObjPortfolioBase $a_target)
	Clone basic settings.
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

ilObjPortfolio::deleteAllPages ( )

protected

Reimplemented from ilObjPortfolioBase.

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

References ilPortfolioPage\getAllPages().

        {
                // delete pages
                include_once "Modules/Portfolio/classes/class.ilPortfolioPage.php";
                $pages = ilPortfolioPage::getAllPages($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:

ilObjPortfolio::deleteImage

(

)

remove existing file

Reimplemented from ilObjPortfolioBase.

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

References handleQuotaUpdate().

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

Here is the call graph for this function:

static ilObjPortfolio::deleteUserPortfolios (   $a_user_id )

static

Delete all portfolio data for user.

Parameters

int

$a_user_id

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

References getPortfoliosOfUser().

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 call graph for this function:

Here is the caller graph for this function:

ilObjPortfolio::doReadCustom ( array  $a_row )

protected

Reimplemented from ilObjPortfolioBase.

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:

ilObjPortfolio::doUpdate ( )

protected

Reimplemented from ilObjPortfolioBase.

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:

ilObjPortfolio::doUpdateCustom ( array &  $a_fields )

protected

Reimplemented from ilObjPortfolioBase.

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

References isDefault().

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

Here is the call graph for this function:

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

static

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

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

Referenced by 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:

static ilObjPortfolio::getDefaultPortfolio (   $a_user_id )

static

Get default portfolio of user.

Parameters

type

$a_user_id

Returns

int

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

References $ilDB, $ilSetting, and $res.

Referenced by ilUsersOnlineBlockGUI\fillRow(), ilPublicUserProfileGUI\getProfilePortfolio(), ilPersonalProfileGUI\getProfilePortfolio(), and ilPortfolioAccessHandler\syncProfile().

        {
                global $ilDB, $ilSetting;
                
                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:

static ilObjPortfolio::getPortfoliosOfUser (   $a_user_id )

static

Get views of user.

Parameters

int

$a_user_id

Returns

array

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

References $ilDB, and $res.

Referenced by deleteUserPortfolios(), ilPortfolioTableGUI\getItems(), ilExAssignmentGUI\getOverviewBody(), ilObjPortfolioGUI\initCopyPageFormOptions(), ilObjPortfolioTemplateGUI\initDidacticTemplate(), and ilObjExerciseGUI\selectPortfolioObject().

        {
                global $ilDB;

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

ilObjPortfolio::handleQuotaUpdate ( )

protected

Definition at line 213 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:

ilObjPortfolio::initType

(

)

Reimplemented from ilObject2.

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

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

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:

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:

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

References $ilDB.

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

        {
                global $ilDB;
                
                $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:

ilObjPortfolio::uploadImage

(

array

$a_upload

)

Upload new image file.

Parameters

array

$a_upload

Returns

bool

Reimplemented from ilObjPortfolioBase.

Definition at line 203 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

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