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

Inheritance diagram for ilObjPortfolioBase:

Collaboration diagram for ilObjPortfolioBase:

Public Member Functions
	__construct (int $a_id=0, bool $a_reference=true)
	Constructor. More...

	setOnline (bool $a_value)

	isOnline ()

	setPublicComments (bool $a_value)

	hasPublicComments ()

	hasProfilePicture ()

	setProfilePicture (bool $a_status)

	getBackgroundColor ()

	setBackgroundColor (string $a_value)
	Set background color, e.g. More...

	getFontColor ()

	setFontColor (string $a_value)

	getImage ()
	Get banner image. More...

	setImage (string $a_value)
	Set banner image. More...

	getImageFullPath (bool $a_as_thumb=false)
	Get banner image incl. More...

	deleteImage ()
	remove existing file More...

	uploadImage (array $a_upload)
	Upload new image file. More...

	fixLinksOnTitleChange (array $a_title_changes)
	Update internal portfolio links on title change. More...

Public Member Functions inherited from ilObject2
	__construct (int $a_id=0, bool $a_reference=true)
	Constructor. More...

	read ()

	create (bool $a_clone_mode=false)

	update ()

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

	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...

	cloneObject (int $target_id, int $copy_id=0, bool $omit_tree=false)

Public Member Functions inherited from ilObject
	__construct (int $id=0, bool $reference=true)

	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...

	processAutoRating ()

	read ()

	getId ()

	setId (int $id)

	setRefId (int $ref_id)

	getRefId ()

	getType ()

	setType (string $type)

	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...

	getTitle ()

	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...

	setTitle (string $title)

	getDescription ()

	setDescription (string $desc)

	getLongDescription ()
	get object long description (stored in object_description) More...

	getImportId ()

	setImportId (string $import_id)

	setOfflineStatus (bool $status)

	getOfflineStatus ()

	supportsOfflineHandling ()

	getOwner ()

	getOwnerName ()
	get full name of object owner More...

	setOwner (int $usr_id)

	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...

	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...

	create ()
	note: title, description and type should be set when this function is called More...

	update ()

	MDUpdateListener (string $element)
	Metadata update listener. More...

	createMetaData ()

	updateMetaData ()

	deleteMetaData ()

	updateOwner ()
	update owner of object in db More...

	putInTree (int $parent_ref_id)
	maybe this method should be in tree object!? More...

	setPermissions (int $parent_ref_id)

	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...

	createReference ()
	creates reference for object More...

	countReferences ()

	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...

	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type. More...

	applyDidacticTemplate (int $tpl_id)

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo (int $target_id, int $copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...

	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...

	selfOrParentWithRatingEnabled ()

	getPossibleSubObjects (bool $filter=true)
	get all possible sub objects of this type the object can decide which types of sub objects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	lookupOnline (int $a_id)

static	initStorage (int $a_id, string $a_subdir=null)
	Init file system storage. More...

static	clonePagesAndSettings (ilObjPortfolioBase $a_source, ilObjPortfolioBase $a_target, ?array $a_recipe=null, bool $copy_all=false)
	Build template from portfolio and vice versa. More...

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...

static	_lookupImportId (int $obj_id)

static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...

static	_getIdForImportId (string $import_id)

static	_getAllReferences (int $id)
	get all reference ids for object ID More...

static	_lookupTitle (int $obj_id)

static	lookupOfflineStatus (int $obj_id)
	Lookup offline status using objectDataCache. More...

static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...

static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)

static	_lookupDescription (int $obj_id)

static	_lookupLastUpdate (int $obj_id, bool $formatted=false)

static	_getLastUpdateOfObjects (array $obj_ids)

static	_lookupObjId (int $ref_id)

static	_setDeletedDate (int $ref_id, int $deleted_by)

static	setDeletedDates (array $ref_ids, int $user_id)

static	_resetDeletedDate (int $ref_id)

static	_lookupDeletedDate (int $ref_id)

static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...

static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...

static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...

static	_lookupType (int $id, bool $reference=false)

static	_isInTrash (int $ref_id)

static	_hasUntrashedReference (int $obj_id)
	checks whether an object has at least one reference that is not in trash More...

static	_lookupObjectId (int $ref_id)

static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...

static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...

static	_getObjectsByType (string $obj_type="", int $owner=null)

static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...

static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $obj_ids)

static	getAllOwnedRepositoryObjects (int $user_id)

static	fixMissingTitles ($type, array &$obj_title_map)
	Try to fix missing object titles. More...

static	_lookupCreationDate (int $obj_id)

static	_getObjectTypeIdByTitle (string $type, \ilDBInterface $ilDB=null)

Protected Member Functions
	doRead ()

	doReadCustom (array $a_row)
	May be overwritten by derived classes. More...

	doCreate (bool $clone_mode=false)

	doUpdate ()

	doUpdateCustom (array &$a_fields)
	May be overwritte by derived classes. More...

	doDelete ()

	deleteAllPages ()

Protected Member Functions inherited from ilObject2
	initType ()

	doRead ()

	doCreate (bool $clone_mode=false)

	beforeCreate ()
	If overwritten this method should return true, there is currently no "abort" handling for cases where "false" is returned. More...

	doUpdate ()

	beforeUpdate ()

	doDelete ()

	beforeDelete ()

	doCloneObject (ilObject2 $new_obj, int $a_target_id, ?int $a_copy_id=null)

	beforeCloneObject ()

Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)

	beforeMDUpdateListener (string $a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDeleteMetaData ()

	beforeDeleteMetaData ()

	handleAutoRating ()

	hasAutoRating ()

Static Protected Member Functions
static	cloneBasics (ilObjPortfolioBase $a_source, ilObjPortfolioBase $a_target)
	Clone basic settings. More...

static	updateDomNodes (DOMDocument $a_dom, string $a_xpath, string $a_attr_id, string $a_attr_value)

static	createBlogInPersonalWorkspace (string $a_title)

Protected Attributes
ILIAS Notes Service	$notes

ilSetting	$setting

bool	$online = false

bool	$comments = false

string	$bg_color = ""

string	$font_color = ""

string	$img = ""

string	$ppic = ""

bool	$style = false

Protected Attributes inherited from ilObject
ilLogger	$obj_log

ILIAS	$ilias

ilObjectDefinition	$obj_definition

ilDBInterface	$db

ilLogger	$log

ilErrorHandling	$error

ilTree	$tree

ilAppEventHandler	$app_event_handler

ilRbacAdmin	$rbac_admin

ilRbacReview	$rbac_review

ilObjUser	$user

ilLanguage	$lng

int	$id

bool	$referenced

bool	$call_by_reference

int	$max_title = self::TITLE_LENGTH

int	$max_desc = self::DESC_LENGTH

bool	$add_dots = true

int	$ref_id = null

string	$type = ""

string	$title = ""

bool	$offline = false

string	$desc = ""

string	$long_desc = ""

int	$owner = 0

string	$create_date = ""

string	$last_update = ""

string	$import_id = ""

bool	$register = false

Additional Inherited Members
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255

const	DESC_LENGTH = 128

const	LONG_DESC_LENGTH = 4000

const	TABLE_OBJECT_DATA = "object_data"

array	$objectList

string	$untranslatedTitle

Detailed Description

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

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Portfolio 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 24 of file class.ilObjPortfolioBase.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

int	$a_id	reference_id or object_id
bool	$a_reference	treat the id as reference_id (true) or object_id (false)

Reimplemented from ilObject2.

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

      {
        global $DIC;
 
        $this->notes = $DIC->notes();
 
        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 343 of file class.ilObjPortfolioBase.php.

     : void {
        global $DIC;
 
        // 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);
 
        // container settings
        foreach (ilContainer::_getContainerSettings($a_source->getId()) as $keyword => $value) {
            ilContainer::_writeContainerSetting($a_target->getId(), $keyword, $value);
        }
 
        // style
        $content_style_domain = $DIC
            ->contentStyle()
            ->domain()
            ->styleForObjId($a_source->getId());
        $content_style_domain->cloneTo($a_target->getId());
    }

Referenced by ilObjPortfolioTemplate\doCloneObject().

Here is the caller graph for this function:

◆ clonePagesAndSettings()

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

static

Build template from portfolio and vice versa.

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

     : void {
        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);
 
        // copy advanced metadata
        $copy_id = ilCopyWizardOptions::_allocateCopyId();
        ilAdvancedMDValues::_cloneValues($copy_id, $a_source->getId(), $a_target->getId());
 
        // copy selection of global optional sets
        ilAdvancedMDRecord::saveObjRecSelection(
            $a_target->getId(),
            'pfpg',
            ilAdvancedMDRecord::getObjRecSelection($a_source->getId(), 'pfpg')
        );
 
        // fix metadata record type assignment
        // e.g. if portfolio is created from template
        // we need to change this from prtt to prtf
        foreach (\ilAdvancedMDRecord::_getSelectedRecordsByObject(
            ilObject::_lookupType($a_source->getId()),
            $a_target->getId(),
            "pfpg",
            false
        ) as $rec) {
            /*
             * BT 35494: reset assignement of the newly cloned local records,
             * and only append what's needed to global ones
             */
            $target_type = ilObject::_lookupType($a_target->getId());
            if ($rec->getParentObject() == $a_target->getId()) {
                $rec->setAssignedObjectTypes(
                    [[
                         "obj_type" => $target_type,
                         "sub_type" => "pfpg",
                         "optional" => 0
                     ]
                    ]
                );
            } elseif (!$rec->isAssignedObjectType($target_type, 'pfpg')) {
                $rec->appendAssignedObjectType(
                    $target_type,
                    "pfpg"
                );
            }
            $rec->update();
        }
 
        // 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 (isset($a_recipe)) {
                $page_recipe = $a_recipe[$page_id] ?? null;
            }
 
            $valid = false;
            switch ($page_type) {
                // blog => blog template
                case ilPortfolioPage::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;
                        } elseif ($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,
                            $a_target->getId(),
                            $copy_id
                        )
                    );
                    $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(false);
 
                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);
    }

Referenced by ILIAS\Portfolio\Administration\PortfolioRoleAssignmentManager\assignPortfoliosOnLogin(), and ilObjPortfolioGUI\createPortfolioFromAssignment().

Here is the caller graph for this function:

◆ createBlogInPersonalWorkspace()

static ilObjPortfolioBase::createBlogInPersonalWorkspace ( string $a_title )

staticprotected

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

                                                                            : int
    {
        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, and $ilUser.

◆ 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 252 of file class.ilObjPortfolioBase.php.

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

Referenced by doDelete().

Here is the caller graph for this function:

◆ doCreate()

ilObjPortfolioBase::doCreate ( bool $clone_mode = false )

protected

Reimplemented from ilObject2.

Reimplemented in ilObjPortfolioTemplate.

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

                                                         : void
    {
        $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 214 of file class.ilObjPortfolioBase.php.

                                 : void
    {
        $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 148 of file class.ilObjPortfolioBase.php.

                               : void
    {
        $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((string) $row["bg_color"]);
        $this->setFontColor((string) $row["font_color"]);
        $this->setImage((string) $row["img"]);
 
        // #14661
        $this->setPublicComments($this->notes->domain()->commentsActive($this->id));
 
        $this->doReadCustom($row);
    }

References ilObject\$db, $ilDB, doReadCustom(), setBackgroundColor(), setFontColor(), setImage(), setOnline(), setProfilePicture(), and setPublicComments().

Here is the call graph for this function:

◆ doReadCustom()

ilObjPortfolioBase::doReadCustom ( array $a_row )

protected

May be overwritten by derived classes.

Reimplemented in ilObjPortfolio.

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

                                                 : void
    {
    }

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 184 of file class.ilObjPortfolioBase.php.

                                 : void
    {
        $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
        $this->notes->domain()->activateComments($this->id, $this->hasPublicComments());
 
        $ilDB->update(
            "usr_portfolio",
            $fields,
            array("id" => array("integer", $this->id))
        );
    }

References ilObject\$db, $ilDB, doUpdateCustom(), getBackgroundColor(), getFontColor(), getImage(), hasProfilePicture(), hasPublicComments(), and isOnline().

Here is the call graph for this function:

◆ doUpdateCustom()

ilObjPortfolioBase::doUpdateCustom ( array & $a_fields )

protected

May be overwritte by derived classes.

Reimplemented in ilObjPortfolio.

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

                                                       : void
    {
    }

Referenced by doUpdate().

Here is the caller graph for this function:

◆ fixLinksOnTitleChange()

ilObjPortfolioBase::fixLinksOnTitleChange ( array $a_title_changes )

Update internal portfolio links on title change.

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

                                                                 : void
    {
        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(), and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

◆ getBackgroundColor()

ilObjPortfolioBase::getBackgroundColor ( )

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

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

References $bg_color.

Referenced by doUpdate().

Here is the caller graph for this function:

◆ getFontColor()

ilObjPortfolioBase::getFontColor ( )

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

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

References $font_color.

Referenced by doUpdate().

Here is the caller graph for this function:

◆ getImage()

ilObjPortfolioBase::getImage ( )

Get banner image.

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

                              : string
    {
        return $this->img;
    }

References $img.

Referenced by doUpdate().

Here is the caller graph for this function:

◆ getImageFullPath()

ilObjPortfolioBase::getImageFullPath ( bool $a_as_thumb = false )

Get banner image incl.

path

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

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

References $img, $path, and initStorage().

Here is the call graph for this function:

◆ hasProfilePicture()

ilObjPortfolioBase::hasProfilePicture ( )

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

                                       : bool
    {
        return $this->ppic;
    }

References $ppic.

Referenced by doUpdate().

Here is the caller graph for this function:

◆ hasPublicComments()

ilObjPortfolioBase::hasPublicComments ( )

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

                                       : bool
    {
        return $this->comments;
    }

References $comments.

Referenced by doUpdate().

Here is the caller graph for this function:

◆ initStorage()

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

static

Init file system storage.

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

     : string {
        $storage = new ilFSStoragePortfolio($a_id);
        $storage->create();
 
        $path = $storage->getAbsolutePath() . "/";
 
        if ($a_subdir) {
            $path .= $a_subdir . "/";
 
            if (!is_dir($path) && !mkdir($path) && !is_dir($path)) {
                throw new \RuntimeException(sprintf('Directory "%s" was not created', $path));
            }
        }
 
        return $path;
    }

References $path.

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

Here is the caller graph for this function:

◆ isOnline()

ilObjPortfolioBase::isOnline ( )

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

                              : bool
    {
        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 ( int $a_id )

static

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

                                                  : bool
    {
        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 ( string $a_value )

Set background color, e.g.

"efefef"

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

                                                       : void
    {
        $this->bg_color = $a_value;
    }

Referenced by doRead().

Here is the caller graph for this function:

◆ setFontColor()

ilObjPortfolioBase::setFontColor ( string $a_value )

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

                                                 : void
    {
        $this->font_color = $a_value;
    }

Referenced by doRead().

Here is the caller graph for this function:

◆ setImage()

ilObjPortfolioBase::setImage ( string $a_value )

Set banner image.

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

                                             : void
    {
        $this->img = $a_value;
    }

Referenced by doRead().

Here is the caller graph for this function:

◆ setOnline()

ilObjPortfolioBase::setOnline ( bool $a_value )

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

                                            : void
    {
        $this->online = $a_value;
    }

Referenced by doRead().

Here is the caller graph for this function:

◆ setProfilePicture()

ilObjPortfolioBase::setProfilePicture ( bool $a_status )

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

                                                     : void
    {
        $this->ppic = $a_status;
    }

Referenced by doRead().

Here is the caller graph for this function:

◆ setPublicComments()

ilObjPortfolioBase::setPublicComments ( bool $a_value )

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

                                                    : void
    {
        $this->comments = $a_value;
    }

Referenced by doRead().

Here is the caller graph for this function:

◆ updateDomNodes()

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

staticprotected

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

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

◆ uploadImage()

ilObjPortfolioBase::uploadImage ( array $a_upload )

Upload new image file.

Reimplemented in ilObjPortfolio.

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

     : bool {
        if (!$this->id) {
            return false;
        }
 
        $this->deleteImage();
 
        // #10074
        $clean_name = preg_replace("/[^a-zA-Z0-9\_\.\-]/", "", $a_upload["name"]);
 
        $path = self::initStorage($this->id);
        $original = "org_" . $this->id . "_" . $clean_name;
        $thumb = "thb_" . $this->id . "_" . $clean_name;
        $processed = $this->id . "_" . $clean_name;
 
        if (ilFileUtils::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 = ilShellUtil::escapeShellArg($path . $original);
            $thumb_file = ilShellUtil::escapeShellArg($path . $thumb);
            $processed_file = ilShellUtil::escapeShellArg($path . $processed);
            ilShellUtil::execConvert($original_file . "[0] -geometry 100x100 -quality 100 JPEG:" . $thumb_file);
            ilShellUtil::execConvert(
                $original_file . "[0] -geometry " . $dimensions . " -quality 100 JPEG:" . $processed_file
            );
 
            $this->setImage($processed);
 
            return true;
        }
        return false;
    }

Field Documentation

◆ $bg_color

string ilObjPortfolioBase::$bg_color = ""

protected

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

Referenced by getBackgroundColor().

◆ $comments

bool ilObjPortfolioBase::$comments = false

protected

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

Referenced by hasPublicComments().

◆ $font_color

string ilObjPortfolioBase::$font_color = ""

protected

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

Referenced by getFontColor().

◆ $img

string ilObjPortfolioBase::$img = ""

protected

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

Referenced by getImage(), and getImageFullPath().

◆ $notes

ILIAS Notes Service ilObjPortfolioBase::$notes

protected

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

◆ $online

bool ilObjPortfolioBase::$online = false

protected

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

Referenced by isOnline().

◆ $ppic

string ilObjPortfolioBase::$ppic = ""

protected

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

Referenced by hasProfilePicture().

◆ $setting

ilSetting ilObjPortfolioBase::$setting

protected

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

◆ $style

bool ilObjPortfolioBase::$style = false

protected

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

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

Modules/Portfolio/classes/class.ilObjPortfolioBase.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ cloneBasics()

◆ clonePagesAndSettings()

◆ createBlogInPersonalWorkspace()

◆ deleteAllPages()

◆ deleteImage()

◆ doCreate()

◆ doDelete()

◆ doRead()

◆ doReadCustom()

◆ doUpdate()

◆ doUpdateCustom()

◆ fixLinksOnTitleChange()

◆ getBackgroundColor()

◆ getFontColor()

◆ getImage()

◆ getImageFullPath()

◆ hasProfilePicture()

◆ hasPublicComments()

◆ initStorage()

◆ isOnline()

◆ lookupOnline()

◆ setBackgroundColor()

◆ setFontColor()

◆ setImage()

◆ setOnline()

◆ setProfilePicture()

◆ setPublicComments()

◆ updateDomNodes()

◆ uploadImage()

Field Documentation

◆ $bg_color

◆ $comments

◆ $font_color

◆ $img

◆ $notes

◆ $online

◆ $ppic

◆ $setting

◆ $style