Portfolio base. More...

Inheritance diagram for ilObjPortfolioBase:

Collaboration diagram for ilObjPortfolioBase:

Public Member Functions
	__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	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 ()

	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 ()

Static Protected Member Functions
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)

Protected Attributes
	$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

Detailed Description

Portfolio base.

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.ilObjPortfolioBase.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjPortfolioBase::__construct	(	$a_id = `0`,
		$a_reference = `true`
	)

Constructor.

Reimplemented from ilObject2.

Definition at line 20 of file class.ilObjPortfolioBase.php.

    {
        global $DIC;
        parent::__construct($a_id, $a_reference);
 
        $this->setting = $DIC->settings();
 
        $this->db = $DIC->database();
    }

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ cloneBasics()

static ilObjPortfolioBase::cloneBasics	(	ilObjPortfolioBase	$a_source,
		ilObjPortfolioBase	$a_target
	)

staticprotected

Clone basic settings.

Parameters

ilObjPortfolioBase	$a_source
ilObjPortfolioBase	$a_target

Definition at line 407 of file class.ilObjPortfolioBase.php.

    {
        // copy portfolio properties
        $a_target->setPublicComments($a_source->hasPublicComments());
        $a_target->setProfilePicture($a_source->hasProfilePicture());
        $a_target->setFontColor($a_source->getFontColor());
        $a_target->setBackgroundColor($a_source->getBackgroundColor());
        $a_target->setImage($a_source->getImage());
        $a_target->update();
 
        // banner/images
        $source_dir = $a_source->initStorage($a_source->getId());
        $target_dir = $a_target->initStorage($a_target->getId());
        ilFSStoragePortfolio::_copyDirectory($source_dir, $target_dir);
        
        // set/copy stylesheet
        $style_id = $a_source->getStyleSheetId();
        if ($style_id > 0 && !ilObjStyleSheet::_lookupStandard($style_id)) {
            $style_obj = ilObjectFactory::getInstanceByObjId($style_id);
            $new_id = $style_obj->ilClone();
            $a_target->setStyleSheetId($new_id);
            $a_target->update();
        }
    }

References ilFileSystemStorage\_copyDirectory(), ilObjStyleSheet\_lookupStandard(), getBackgroundColor(), getFontColor(), ilObject\getId(), getImage(), ilObjectFactory\getInstanceByObjId(), getStyleSheetId(), hasProfilePicture(), hasPublicComments(), initStorage(), setBackgroundColor(), setFontColor(), setImage(), setProfilePicture(), setPublicComments(), setStyleSheetId(), and ilObject2\update().

Referenced by clonePagesAndSettings(), and ilObjPortfolioTemplate\doCloneObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clonePagesAndSettings()

static ilObjPortfolioBase::clonePagesAndSettings	(	ilObjPortfolioBase	$a_source,
		ilObjPortfolioBase	$a_target,
		array	$a_recipe = `null`,
			$copy_all = `false`
	)

static

Build template from portfolio and vice versa.

Parameters

ilObjPortfolioBase	$a_source
ilObjPortfolioBase	$a_target
array	$a_recipe

Definition at line 439 of file class.ilObjPortfolioBase.php.

    {
        global $DIC;
 
        $lng = $DIC->language();
        $ilUser = $DIC->user();
        
        $source_id = $a_source->getId();
        $target_id = $a_target->getId();
        
        if ($a_source instanceof ilObjPortfolioTemplate &&
            $a_target instanceof ilObjPortfolio) {
            $direction = "t2p";
        } elseif ($a_source instanceof ilObjPortfolio &&
            $a_target instanceof ilObjPortfolioTemplate) {
            $direction = "p2t";
        } else {
            return;
        }
        
        self::cloneBasics($a_source, $a_target);
        
        // personal skills
        $pskills = array_keys(ilPersonalSkill::getSelectedUserSkills($ilUser->getId()));
        
        // copy pages
        $blog_count = 0;
        $page_map = array();
        foreach (ilPortfolioPage::getAllPortfolioPages($source_id) as $page) {
            $page_id = $page["id"];
            
            if ($direction == "t2p") {
                $source_page = new ilPortfolioTemplatePage($page_id);
                $target_page = new ilPortfolioPage();
            } else {
                $source_page = new ilPortfolioPage($page_id);
                $target_page = new ilPortfolioTemplatePage();
            }
            $source_page->setPortfolioId($source_id);
            $target_page->setPortfolioId($target_id);
            
            $page_type = $source_page->getType();
            $page_title = $source_page->getTitle();
 
            
                
 
            $page_recipe = null;
            if (is_array($a_recipe)) {
                $page_recipe = $a_recipe[$page_id];
            }
 
            $valid = false;
            switch ($page_type) {
                // blog => blog template
                case ilPortfolioTemplatePage::TYPE_BLOG:
                    if ($direction == "p2t") {
                        $page_type = ilPortfolioTemplatePage::TYPE_BLOG_TEMPLATE;
                        $page_title = $lng->txt("obj_blog") . " " . (++$blog_count);
                        $valid = true;
                    }
                    break;
                
                // blog template => blog (needs recipe)
                case ilPortfolioTemplatePage::TYPE_BLOG_TEMPLATE:
                    if ($direction == "t2p" && (is_array($page_recipe) || $copy_all)) {
                        $page_type = ilPortfolioPage::TYPE_BLOG;
                        if ($copy_all) {
                            $page_title = self::createBlogInPersonalWorkspace($page_title);
                            $valid = true;
                        } else {
                            if ($page_recipe[0] == "blog") {
                                switch ($page_recipe[1]) {
                                    case "create":
                                        $page_title = self::createBlogInPersonalWorkspace($page_recipe[2]);
                                        $valid = true;
                                        break;
 
                                    case "reuse":
                                        $page_title = $page_recipe[2];
                                        $valid = true;
                                        break;
 
                                    case "ignore":
                                        // do nothing
                                        break;
                                }
                            }
                        }
                    }
                    break;
 
                // page editor
                default:
                    $target_page->setXMLContent($source_page->copyXmlContent(true)); // copy mobs
                    $target_page->buildDom(true);
 
 
                    // parse content / blocks
 
                    if ($direction == "t2p") {
                        $dom = $target_page->getDom();
                        if ($dom instanceof php4DOMDocument) {
                            $dom = $dom->myDOMDocument;
                        }
                        
                        // update profile/consultation hours user id
                        self::updateDomNodes($dom, "//PageContent/Profile", "User", $ilUser->getId());
                        self::updateDomNodes($dom, "//PageContent/ConsultationHours", "User", $ilUser->getId());
                        self::updateDomNodes($dom, "//PageContent/MyCourses", "User", $ilUser->getId());
                    
                        // skills
                        $xpath = new DOMXPath($dom);
                        $nodes = $xpath->query("//PageContent/Skills");
                        foreach ($nodes as $node) {
                            $skill_id = $node->getAttribute("Id");
 
                            // existing personal skills
                            if (in_array($skill_id, $pskills)) {
                                $node->setAttribute("User", $ilUser->getId());
                            }
                            // new skill
                            elseif ($copy_all || in_array($skill_id, $a_recipe["skills"])) {
                                ilPersonalSkill::addPersonalSkill($ilUser->getId(), $skill_id);
 
                                $node->setAttribute("User", $ilUser->getId());
                            }
                            // remove skill
                            else {
                                $page_element = $node->parentNode;
                                $page_element->parentNode->removeChild($page_element);
                            }
                        }
                    }
 
                    $valid = true;
                    break;
            }
 
            if ($valid) {
                // #12038 - update xml from dom
                $target_page->setXMLContent($target_page->getXMLFromDom());
                
                $target_page->setType($page_type);
                $target_page->setTitle($page_title);
                $target_page->create();
 
                if ($page_type == ilPortfolioPage::TYPE_PAGE) {
                    $target_page->update();     // handle mob usages!
                }
                $page_map[$source_page->getId()] = $target_page->getId();
            }
        }
 
        ilPortfolioPage::updateInternalLinks($page_map, $a_target);
    }

References $DIC, $ilUser, ilObject\$lng, $target_id, $valid, ilPersonalSkill\addPersonalSkill(), cloneBasics(), createBlogInPersonalWorkspace(), ilPortfolioPage\getAllPortfolioPages(), ilObject\getId(), ilPersonalSkill\getSelectedUserSkills(), ilPortfolioPage\TYPE_BLOG, ilPortfolioTemplatePage\TYPE_BLOG_TEMPLATE, ilPortfolioPage\TYPE_PAGE, updateDomNodes(), and ilPortfolioPage\updateInternalLinks().

Referenced by ilObjPortfolioTemplateGUI\afterSave().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createBlogInPersonalWorkspace()

static ilObjPortfolioBase::createBlogInPersonalWorkspace ( $a_title )

staticprotected

Definition at line 605 of file class.ilObjPortfolioBase.php.

    {
        global $DIC;
 
        $ilUser = $DIC->user();
        
        static $ws_access = null;
        
        $blog = new ilObjBlog();
        $blog->setType("blog");
        $blog->setTitle($a_title);
        $blog->create();
        
        if (!$ws_access) {
            $tree = new ilWorkspaceTree($ilUser->getId());
            
            // #13235
            if (!$tree->getRootId()) {
                $tree->createTreeForUser($ilUser->getId());
            }
            
            $ws_access = new ilWorkspaceAccessHandler($tree);
        }
        
        $tree = $ws_access->getTree();
        $node_id = $tree->insertObject($tree->getRootId(), $blog->getId());
        $ws_access->setPermissions($tree->getRootId(), $node_id);
        
        return $blog->getId();
    }

References $DIC, $ilUser, and ilObject\$tree.

Referenced by clonePagesAndSettings().

Here is the caller graph for this function:

◆ deleteAllPages()

ilObjPortfolioBase::deleteAllPages ( )

abstractprotected

Reimplemented in ilObjPortfolio, and ilObjPortfolioTemplate.

Referenced by doDelete().

Here is the caller graph for this function:

◆ deleteImage()

ilObjPortfolioBase::deleteImage ( )

remove existing file

Reimplemented in ilObjPortfolio.

Definition at line 314 of file class.ilObjPortfolioBase.php.

    {
        if ($this->id) {
            $storage = new ilFSStoragePortfolio($this->id);
            $storage->delete();
            
            $this->setImage(null);
        }
    }

References setImage().

Referenced by doDelete(), and uploadImage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doCreate()

ilObjPortfolioBase::doCreate ( )

protected

Reimplemented from ilObject2.

Reimplemented in ilObjPortfolioTemplate.

Definition at line 238 of file class.ilObjPortfolioBase.php.

    {
        $ilDB = $this->db;
        
        $ilDB->manipulate("INSERT INTO usr_portfolio (id,is_online)" .
            " VALUES (" . $ilDB->quote($this->id, "integer") . "," .
            $ilDB->quote(0, "integer") . ")");
    }

References ilObject\$db, and $ilDB.

◆ doDelete()

ilObjPortfolioBase::doDelete ( )

protected

Reimplemented from ilObject2.

Definition at line 276 of file class.ilObjPortfolioBase.php.

    {
        $ilDB = $this->db;
        
        $this->deleteAllPages();
        $this->deleteImage();
 
        $ilDB->manipulate("DELETE FROM usr_portfolio" .
            " WHERE id = " . $ilDB->quote($this->id, "integer"));
    }

References ilObject\$db, $ilDB, deleteAllPages(), and deleteImage().

Here is the call graph for this function:

◆ doRead()

ilObjPortfolioBase::doRead ( )

protected

Reimplemented from ilObject2.

Reimplemented in ilObjPortfolioTemplate.

Definition at line 212 of file class.ilObjPortfolioBase.php.

    {
        $ilDB = $this->db;
 
        $set = $ilDB->query("SELECT * FROM usr_portfolio" .
                " WHERE id = " . $ilDB->quote($this->id, "integer"));
        $row = $ilDB->fetchAssoc($set);
        
        $this->setOnline((bool) $row["is_online"]);
        $this->setProfilePicture((bool) $row["ppic"]);
        $this->setBackgroundColor($row["bg_color"]);
        $this->setFontColor($row["font_color"]);
        $this->setImage($row["img"]);
        
        // #14661
        $this->setPublicComments(ilNote::commentsActivated($this->id, 0, $this->getType()));
        
        $this->setStyleSheetId(ilObjStyleSheet::lookupObjectStyle($this->id));
        
        $this->doReadCustom($row);
    }

References ilObject\$db, $ilDB, ilNote\commentsActivated(), doReadCustom(), ilObject2\getType(), ilObjStyleSheet\lookupObjectStyle(), setBackgroundColor(), setFontColor(), setImage(), setOnline(), setProfilePicture(), setPublicComments(), and setStyleSheetId().

Here is the call graph for this function:

◆ doReadCustom()

ilObjPortfolioBase::doReadCustom ( array $a_row )

protected

Reimplemented in ilObjPortfolio.

Definition at line 234 of file class.ilObjPortfolioBase.php.

235 {

236 }

Referenced by doRead().

Here is the caller graph for this function:

◆ doUpdate()

ilObjPortfolioBase::doUpdate ( )

protected

Reimplemented from ilObject2.

Reimplemented in ilObjPortfolio, and ilObjPortfolioTemplate.

Definition at line 247 of file class.ilObjPortfolioBase.php.

    {
        $ilDB = $this->db;
        
        $fields = array(
            "is_online" => array("integer", $this->isOnline()),
            "ppic" => array("integer", $this->hasProfilePicture()),
            "bg_color" => array("text", $this->getBackgroundColor()),
            "font_color" => array("text", $this->getFontcolor()),
            "img" => array("text", $this->getImage())
        );
        $this->doUpdateCustom($fields);
        
        // #14661
        ilNote::activateComments($this->id, 0, $this->getType(), $this->hasPublicComments());
        
        ilObjStyleSheet::writeStyleUsage($this->id, $this->getStyleSheetId());
                
        $ilDB->update(
            "usr_portfolio",
            $fields,
            array("id" => array("integer", $this->id))
        );
    }

References ilObject\$db, $ilDB, ilNote\activateComments(), doUpdateCustom(), getBackgroundColor(), getImage(), getStyleSheetId(), ilObject2\getType(), hasProfilePicture(), hasPublicComments(), isOnline(), and ilObjStyleSheet\writeStyleUsage().

Here is the call graph for this function:

◆ doUpdateCustom()

ilObjPortfolioBase::doUpdateCustom ( array & $a_fields )

protected

Reimplemented in ilObjPortfolio.

Definition at line 272 of file class.ilObjPortfolioBase.php.

273 {

274 }

Referenced by doUpdate().

Here is the caller graph for this function:

◆ fixLinksOnTitleChange()

ilObjPortfolioBase::fixLinksOnTitleChange ( $a_title_changes )

Fix internal portfolio links.

Parameters

array

Definition at line 641 of file class.ilObjPortfolioBase.php.

    {
        foreach (ilPortfolioPage::getAllPortfolioPages($this->getId()) as $port_page) {
            if ($this->getType() == "prtt") {
                $page = new ilPortfolioTemplatePage($port_page["id"]);
            } else {
                $page = new ilPortfolioPage($port_page["id"]);
            }
            if ($page->renameLinksOnTitleChange($a_title_changes)) {
                $page->update(true, true);
            }
        }
    }

References ilPortfolioPage\getAllPortfolioPages(), ilObject\getId(), and ilObject2\getType().

Here is the call graph for this function:

◆ getBackgroundColor()

ilObjPortfolioBase::getBackgroundColor ( )

Get background color.

Returns: string

Definition at line 126 of file class.ilObjPortfolioBase.php.

    {
        if (!$this->bg_color) {
            $this->bg_color = "ffffff";
        }
        return $this->bg_color;
    }

References $bg_color.

Referenced by cloneBasics(), and doUpdate().

Here is the caller graph for this function:

◆ getFontColor()

ilObjPortfolioBase::getFontColor ( )

Get font color.

Returns: string

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

    {
        if (!$this->font_color) {
            $this->font_color = "505050";
        }
        return $this->font_color;
    }

References $font_color.

Referenced by cloneBasics().

Here is the caller graph for this function:

◆ getImage()

ilObjPortfolioBase::getImage ( )

Get banner image.

Returns: string

Definition at line 172 of file class.ilObjPortfolioBase.php.

    {
        return $this->img;
    }

References $img.

Referenced by cloneBasics(), and doUpdate().

Here is the caller graph for this function:

◆ getImageFullPath()

ilObjPortfolioBase::getImageFullPath ( $a_as_thumb = false )

Get banner image incl.

path

Parameters

bool $a_as_thumb

Definition at line 299 of file class.ilObjPortfolioBase.php.

    {
        if ($this->img) {
            $path = $this->initStorage($this->id);
            if (!$a_as_thumb) {
                return $path . $this->img;
            } else {
                return $path . "thb_" . $this->img;
            }
        }
    }

References $img, and initStorage().

Here is the call graph for this function:

◆ getStyleSheetId()

ilObjPortfolioBase::getStyleSheetId ( )

Get style sheet id.

Returns: bool

Definition at line 192 of file class.ilObjPortfolioBase.php.

    {
        return (int) $this->style;
    }

References $style.

Referenced by cloneBasics(), and doUpdate().

Here is the caller graph for this function:

◆ hasProfilePicture()

ilObjPortfolioBase::hasProfilePicture ( )

Get profile picture status.

Returns: bool

Definition at line 106 of file class.ilObjPortfolioBase.php.

    {
        return $this->ppic;
    }

References $ppic.

Referenced by cloneBasics(), and doUpdate().

Here is the caller graph for this function:

◆ hasPublicComments()

ilObjPortfolioBase::hasPublicComments ( )

Active public comments?

Returns: bool

Definition at line 96 of file class.ilObjPortfolioBase.php.

    {
        return $this->comments;
    }

References $comments.

Referenced by cloneBasics(), and doUpdate().

Here is the caller graph for this function:

◆ initStorage()

static ilObjPortfolioBase::initStorage	(	$a_id,
		$a_subdir = `null`
	)

static

Init file system storage.

Parameters

type	$a_id
type	$a_subdir

Returns: string

Definition at line 331 of file class.ilObjPortfolioBase.php.

    {
        $storage = new ilFSStoragePortfolio($a_id);
        $storage->create();
        
        $path = $storage->getAbsolutePath() . "/";
        
        if ($a_subdir) {
            $path .= $a_subdir . "/";
            
            if (!is_dir($path)) {
                mkdir($path);
            }
        }
                
        return $path;
    }

Referenced by cloneBasics(), getImageFullPath(), ilPortfolioDataSet\getXmlRecord(), ilPortfolioDataSet\importRecord(), and uploadImage().

Here is the caller graph for this function:

◆ isOnline()

ilObjPortfolioBase::isOnline ( )

Is online?

Returns: bool

Definition at line 58 of file class.ilObjPortfolioBase.php.

    {
        return $this->online;
    }

References $online.

Referenced by ilObjPortfolioTemplate\doCloneObject(), ilObjPortfolio\doUpdate(), and doUpdate().

Here is the caller graph for this function:

◆ lookupOnline()

static ilObjPortfolioBase::lookupOnline ( $a_id )

static

Is online?

Returns: bool

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

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        
        $set = $ilDB->query("SELECT is_online" .
            " FROM usr_portfolio" .
            " WHERE id = " . $ilDB->quote($a_id, "integer"));
        $row = $ilDB->fetchAssoc($set);
        return  (bool) $row["is_online"];
    }

References $DIC, and $ilDB.

Referenced by ilObjPortfolioTemplateAccess\_lookupOnline().

Here is the caller graph for this function:

◆ setBackgroundColor()

ilObjPortfolioBase::setBackgroundColor ( $a_value )

Set background color.

Parameters

string $a_value

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

    {
        $this->bg_color = (string) $a_value;
    }

Referenced by cloneBasics(), and doRead().

Here is the caller graph for this function:

◆ setFontColor()

ilObjPortfolioBase::setFontColor ( $a_value )

Set font color.

Parameters

string $a_value

Definition at line 162 of file class.ilObjPortfolioBase.php.

    {
        $this->font_color = (string) $a_value;
    }

Referenced by cloneBasics(), and doRead().

Here is the caller graph for this function:

◆ setImage()

ilObjPortfolioBase::setImage ( $a_value )

Set banner image.

Parameters

string $a_value

Definition at line 182 of file class.ilObjPortfolioBase.php.

    {
        $this->img = (string) $a_value;
    }

Referenced by cloneBasics(), deleteImage(), doRead(), and uploadImage().

Here is the caller graph for this function:

◆ setOnline()

ilObjPortfolioBase::setOnline ( $a_value )

Set online status.

Parameters

bool $a_value

Definition at line 48 of file class.ilObjPortfolioBase.php.

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

Referenced by doRead().

Here is the caller graph for this function:

◆ setProfilePicture()

ilObjPortfolioBase::setProfilePicture ( $a_status )

Toggle profile picture status.

Parameters

bool $a_status

Definition at line 116 of file class.ilObjPortfolioBase.php.

    {
        $this->ppic = (bool) $a_status;
    }

Referenced by cloneBasics(), and doRead().

Here is the caller graph for this function:

◆ setPublicComments()

ilObjPortfolioBase::setPublicComments ( $a_value )

Set public comments status.

Parameters

bool $a_value

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

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

Referenced by cloneBasics(), and doRead().

Here is the caller graph for this function:

◆ setStyleSheetId()

ilObjPortfolioBase::setStyleSheetId ( $a_style )

Set style sheet id.

Parameters

int $a_style

Definition at line 202 of file class.ilObjPortfolioBase.php.

    {
        $this->style = (int) $a_style;
    }

Referenced by cloneBasics(), and doRead().

Here is the caller graph for this function:

◆ updateDomNodes()

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

staticprotected

Definition at line 596 of file class.ilObjPortfolioBase.php.

    {
        $xpath_temp = new DOMXPath($a_dom);
        $nodes = $xpath_temp->query($a_xpath);
        foreach ($nodes as $node) {
            $node->setAttribute($a_attr_id, $a_attr_value);
        }
    }

Referenced by clonePagesAndSettings().

Here is the caller graph for this function:

◆ uploadImage()

ilObjPortfolioBase::uploadImage ( array $a_upload )

Upload new image file.

Parameters

array $a_upload

Returns: bool

Reimplemented in ilObjPortfolio.

Definition at line 355 of file class.ilObjPortfolioBase.php.

    {
        if (!$this->id) {
            return false;
        }
        
        $this->deleteImage();
        
        // #10074
        $clean_name = preg_replace("/[^a-zA-Z0-9\_\.\-]/", "", $a_upload["name"]);
    
        $path = $this->initStorage($this->id);
        $original = "org_" . $this->id . "_" . $clean_name;
        $thumb = "thb_" . $this->id . "_" . $clean_name;
        $processed = $this->id . "_" . $clean_name;
        
        if (ilUtil::moveUploadedFile($a_upload["tmp_name"], $original, $path . $original)) {
            chmod($path . $original, 0770);
            
            $prfa_set = new ilSetting("prfa");
            /* as banner height should overflow, we only handle width
            $dimensions = $prfa_set->get("banner_width")."x".
                $prfa_set->get("banner_height");
            */
            $dimensions = $prfa_set->get("banner_width");
 
            // take quality 100 to avoid jpeg artefacts when uploading jpeg files
            // taking only frame [0] to avoid problems with animated gifs
            $original_file = ilUtil::escapeShellArg($path . $original);
            $thumb_file = ilUtil::escapeShellArg($path . $thumb);
            $processed_file = ilUtil::escapeShellArg($path . $processed);
            ilUtil::execConvert($original_file . "[0] -geometry 100x100 -quality 100 JPEG:" . $thumb_file);
            ilUtil::execConvert($original_file . "[0] -geometry " . $dimensions . " -quality 100 JPEG:" . $processed_file);
            
            $this->setImage($processed);
            
            return true;
        }
        return false;
    }