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
	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.
	deleteImage ()
	remove existing file
	uploadImage (array $a_upload)
	Upload new image file.
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	getAvailablePortfolioTemplates ($a_permission="read")
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
	doRead ()
	doCreate ()
	doUpdate ()
	deleteAllPages ()
	doCloneObject ($new_obj, $a_target_id, $a_copy_id=null)
	updateActivation ()
Protected Member Functions inherited from ilObjPortfolioBase
	doReadCustom (array $a_row)
	doUpdateCustom (array &$a_fields)
	doDelete ()
Protected Member Functions inherited from ilObject2
	beforeCreate ()
	beforeUpdate ()
	doMDUpdateListener ($a_element)
	beforeMDUpdateListener ($a_element)
	doCreateMetaData ()
	beforeCreateMetaData ()
	doUpdateMetaData ()
	beforeUpdateMetaData ()
	beforeDelete ()
	beforeCloneObject ()

Protected Attributes
	$activation_limited
	$activation_visibility
	$activation_starting_time
	$activation_ending_time
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.ilObjPortfolioTemplate.php.

Member Function Documentation

ilObjPortfolioTemplate::deleteAllPages ( )

protected

Reimplemented from ilObjPortfolioBase.

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

References ilPortfolioPage\getAllPages().

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

Here is the call graph for this function:

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

protected

Reimplemented from ilObject2.

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

References ilCopyWizardOptions\_getInstance(), ilObjPortfolioBase\cloneBasics(), ilPortfolioPage\getAllPages(), ilObject2\getId(), and ilObjPortfolioBase\isOnline().

        {
                //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
                include_once "Modules/Portfolio/classes/class.ilPortfolioTemplatePage.php";
                foreach(ilPortfolioPage::getAllPages($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);   
                }       
        }

Here is the call graph for this function:

ilObjPortfolioTemplate::doCreate ( )

protected

Reimplemented from ilObjPortfolioBase.

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

References updateActivation().

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

Here is the call graph for this function:

ilObjPortfolioTemplate::doRead ( )

protected

Reimplemented from ilObjPortfolioBase.

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

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

        {       
                parent::doRead();
                
                if($this->ref_id)
                {
                        include_once "./Services/Object/classes/class.ilObjectActivation.php";
                        $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;                                                  
                        }
                }
        }

Here is the call graph for this function:

ilObjPortfolioTemplate::doUpdate ( )

protected

Reimplemented from ilObjPortfolioBase.

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

References updateActivation().

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

Here is the call graph for this function:

ilObjPortfolioTemplate::getActivationEndDate ( )

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

Referenced by updateActivation().

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

Here is the caller graph for this function:

ilObjPortfolioTemplate::getActivationStartDate ( )

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

Referenced by updateActivation().

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

Here is the caller graph for this function:

ilObjPortfolioTemplate::getActivationVisibility ( )

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

References $activation_visibility.

Referenced by updateActivation().

        {
                return $this->activation_visibility;
        }

Here is the caller graph for this function:

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

static

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

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

Referenced by ilObjPortfolioGUI\createPortfolioFromTemplate(), ilObjPortfolioGUI\createPortfolioFromTemplateProcess(), ilObjExerciseGUI\createPortfolioTemplateObject(), ilExAssignmentGUI\getOverviewBody(), ilObjPortfolioTemplateGUI\initCopyPageFormOptions(), ilObjPortfolioGUI\initCreateForm(), and ilObjExerciseGUI\setSelectedPortfolioTemplateObject().

        {
                global $ilUser, $ilAccess;
                
                $res = array();
                
                foreach(ilObject::_getObjectsByType("prtt") as $obj)
                {
                        $has_permission = false;
                        
                        if($obj["owner"] == $ilUser->getId() && false)
                        {
                                $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;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjPortfolioTemplate::initType ( )

Reimplemented from ilObject2.

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

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

ilObjPortfolioTemplate::isActivationLimited ( )

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

References $activation_limited.

Referenced by updateActivation().

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

Here is the caller graph for this function:

ilObjPortfolioTemplate::setActivationEndDate ( $ending_time = NULL )

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

Referenced by doRead().

        {
                $this->activation_ending_time = $ending_time;
        }

Here is the caller graph for this function:

ilObjPortfolioTemplate::setActivationLimited ( $a_value )

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

Referenced by doRead().

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

Here is the caller graph for this function:

ilObjPortfolioTemplate::setActivationStartDate ( $starting_time = NULL )

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

Referenced by doRead().

        {
                $this->activation_starting_time = $starting_time;
        }

Here is the caller graph for this function:

ilObjPortfolioTemplate::setActivationVisibility ( $a_value )

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

Referenced by doRead().

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

Here is the caller graph for this function:

ilObjPortfolioTemplate::updateActivation ( )

protected

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

References getActivationEndDate(), getActivationStartDate(), getActivationVisibility(), ilObjectActivation\getItem(), isActivationLimited(), ilObjectActivation\setTimingType(), ilObjectActivation\TIMINGS_ACTIVATION, and ilObjectActivation\TIMINGS_DEACTIVATED.

Referenced by doCreate(), and doUpdate().

        {
                // moved activation to ilObjectActivation
                if($this->ref_id)
                {
                        include_once "./Services/Object/classes/class.ilObjectActivation.php";          
                        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);           
                }
        }