ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
ilObjPortfolioBase Class Reference

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 public. More...
 
 withReferences ()
 
 read ()
 Read data from db. More...
 
 setRefId ($a_id)
 
 getRefId ()
 
 getType ()
 
 setType ($a_type)
 
 getPresentationTitle ()
 
 getTitle ()
 
 getUntranslatedTitle ()
 
 setTitle ($a_title)
 
 getDescription ()
 
 setDescription ($a_desc)
 
 getLongDescription ()
 
 getImportId ()
 
 setImportId ($a_import_id)
 
 getOwner ()
 
 getOwnerName ()
 
 setOwner ($a_owner)
 
 getCreateDate ()
 
 getLastUpdateDate ()
 
 create ($a_clone_mode=false)
 
 update ()
 
 MDUpdateListener ($a_element)
 
 createMetaData ()
 
 updateMetaData ()
 
 deleteMetaData ()
 
 updateOwner ()
 
 putInTree ($a_parent_ref)
 
 setPermissions ($a_parent_ref)
 
 createReference ()
 
 countReferences ()
 
 delete ()
 
 initDefaultRoles ()
 
 setRegisterMode ($a_bool)
 
 isUserRegistered ($a_user_id=0)
 
 requireRegistration ()
 
 appendCopyInfo ($a_target_id, $a_copy_id)
 
 cloneMetaData ($target_obj)
 
 cloneObject ($a_target_id, $a_copy_id=null, $a_omit_tree=false)
 
 cloneDependencies ($a_target_id, $a_copy_id)
 
- Public Member Functions inherited from ilObject
 __construct ($a_id=0, $a_reference=true)
 Constructor public. More...
 
 withReferences ()
 determines wehter objects are referenced or not (got ref ids or not) More...
 
 read ()
 read object data from db into object More...
 
 getId ()
 get object id public More...
 
 setId ($a_id)
 set object id public More...
 
 setRefId ($a_id)
 set reference id public More...
 
 getRefId ()
 get reference id public More...
 
 getType ()
 get object type public More...
 
 setType ($a_type)
 set object type public More...
 
 getPresentationTitle ()
 get presentation title Normally same as title Overwritten for sessions More...
 
 getTitle ()
 get object title public More...
 
 getUntranslatedTitle ()
 get untranslated object title public More...
 
 setTitle ($a_title)
 set object title More...
 
 getDescription ()
 get object description More...
 
 setDescription ($a_desc)
 set object description More...
 
 getLongDescription ()
 get object long description (stored in object_description) More...
 
 getImportId ()
 get import id More...
 
 setImportId ($a_import_id)
 set import id More...
 
 setOfflineStatus ($a_status)
 Set offline status. More...
 
 getOfflineStatus ()
 Get offline status. More...
 
 supportsOfflineHandling ()
 Check whether object supports offline handling. More...
 
 getOwner ()
 get object owner More...
 
 getOwnerName ()
 
 setOwner ($a_owner)
 set object owner More...
 
 getCreateDate ()
 get create date public More...
 
 getLastUpdateDate ()
 get last update date public More...
 
 getDiskUsage ()
 Gets the disk usage of the object in bytes. More...
 
 create ()
 create More...
 
 update ()
 update object in db More...
 
 MDUpdateListener ($a_element)
 Meta data update listener. More...
 
 createMetaData ()
 create meta data entry More...
 
 updateMetaData ()
 update meta data entry More...
 
 deleteMetaData ()
 delete meta data entry More...
 
 updateOwner ()
 update owner of object in db More...
 
 putInTree ($a_parent_ref)
 maybe this method should be in tree object!? More...
 
 setPermissions ($a_parent_ref)
 set permissions of object More...
 
 setParentRolePermissions ($a_parent_ref)
 Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...
 
 createReference ()
 creates reference for object More...
 
 countReferences ()
 count references of object More...
 
 initDefaultRoles ()
 init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) public More...
 
 applyDidacticTemplate ($a_tpl_id)
 Apply template. More...
 
 setRegisterMode ($a_bool)
 
 isUserRegistered ($a_user_id=0)
 
 requireRegistration ()
 
 getXMLZip ()
 
 getHTMLDirectory ()
 
 appendCopyInfo ($a_target_id, $a_copy_id)
 Prepend Copy info if object with same name exists in that container. More...
 
 cloneDependencies ($a_target_id, $a_copy_id)
 Clone object dependencies. More...
 
 cloneMetaData ($target_obj)
 Copy meta data. More...
 
 getPossibleSubObjects ($a_filter=true)
 get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...
 

Static Public Member Functions

static lookupOnline ($a_id)
 Is online? More...
 
static initStorage ($a_id, $a_subdir=null)
 Init file system storage. More...
 
static clonePagesAndSettings (ilObjPortfolioBase $a_source, ilObjPortfolioBase $a_target, array $a_recipe=null, $copy_all=false)
 Build template from portfolio and vice versa. More...
 
- Static Public Member Functions inherited from ilObject2
static _lookupObjIdByImportId ($a_import_id)
 
static _lookupOwnerName ($a_owner_id)
 
static _getIdForImportId ($a_import_id)
 
static _getAllReferences ($a_id)
 
static _lookupTitle ($a_id)
 
static _lookupOwner ($a_id)
 
static _getIdsForTitle ($title, $type='', $partialmatch=false)
 
static _lookupDescription ($a_id)
 
static _lookupLastUpdate ($a_id, $a_as_string=false)
 
static _getLastUpdateOfObjects ($a_objs)
 
static _lookupObjId ($a_id)
 
static _setDeletedDate ($a_ref_id, $a_deleted_by)
 
static _resetDeletedDate ($a_ref_id)
 
static _lookupDeletedDate ($a_ref_id)
 
static _writeTitle ($a_obj_id, $a_title)
 
static _writeDescription ($a_obj_id, $a_desc)
 
static _writeImportId ($a_obj_id, $a_import_id)
 
static _lookupType ($a_id, $a_reference=false)
 
static _isInTrash ($a_ref_id)
 
static _hasUntrashedReference ($a_obj_id)
 
static _lookupObjectId ($a_ref_id)
 
static _getObjectsDataForType ($a_type, $a_omit_trash=false)
 
static _exists ($a_id, $a_reference=false, $a_type=null)
 
static _getObjectsByType ($a_obj_type="", $a_owner="")
 
static _prepareCloneSelection ($a_ref_ids, $new_type, $a_show_path=true)
 
static _getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
 
- Static Public Member Functions inherited from ilObject
static _lookupObjIdByImportId ($a_import_id)
 
static _lookupImportId ($a_obj_id)
 
static _lookupOwnerName ($a_owner_id)
 lookup owner name for owner id More...
 
static _getIdForImportId ($a_import_id)
 get current object id for import id (static) More...
 
static _getAllReferences ($a_id)
 get all reference ids of object More...
 
static _lookupTitle ($a_id)
 lookup object title More...
 
static lookupOfflineStatus ($a_obj_id)
 Lookup offline status using objectDataCache. More...
 
static _lookupOwner ($a_id)
 lookup object owner More...
 
static _getIdsForTitle ($title, $type='', $partialmatch=false)
 
static _lookupDescription ($a_id)
 lookup object description More...
 
static _lookupLastUpdate ($a_id, $a_as_string=false)
 lookup last update More...
 
static _getLastUpdateOfObjects ($a_objs)
 Get last update for a set of media objects. More...
 
static _lookupObjId ($a_id)
 
static _setDeletedDate ($a_ref_id, $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 More...
 
static _getObjectsByType ($a_obj_type="", $a_owner="")
 Get objects by type. More...
 
static _prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
 Prepare copy wizard object selection. More...
 
static collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
 Collect deletion dependencies. More...
 
static getDeletionDependencies ($a_obj_id)
 Get deletion dependencies. More...
 
static getLongDescriptions (array $a_obj_ids)
 Get long description data. More...
 
static getAllOwnedRepositoryObjects ($a_user_id)
 Get all ids of objects user owns. More...
 
static fixMissingTitles ($a_type, array &$a_obj_title_map)
 Try to fix missing object titles. More...
 
static _lookupCreationDate ($a_id)
 Lookup creation date. More...
 
static hasAutoRating ($a_type, $a_ref_id)
 Check if auto rating is active for parent group/course. More...
 

Protected Member Functions

 doRead ()
 
 doReadCustom (array $a_row)
 
 doCreate ()
 
 doUpdate ()
 
 doUpdateCustom (array &$a_fields)
 
 doDelete ()
 
 deleteAllPages ()
 
- Protected Member Functions inherited from ilObject2
 initType ()
 
 doRead ()
 
 doCreate ()
 
 beforeCreate ()
 
 doUpdate ()
 
 beforeUpdate ()
 
 doMDUpdateListener ($a_element)
 
 beforeMDUpdateListener ($a_element)
 
 doCreateMetaData ()
 
 beforeCreateMetaData ()
 
 doUpdateMetaData ()
 
 beforeUpdateMetaData ()
 
 doDelete ()
 
 beforeDelete ()
 
 doCloneObject ($new_obj, $a_target_id, $a_copy_id=null)
 
 beforeCloneObject ()
 

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

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

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

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

17  {
18  global $DIC;
19  parent::__construct($a_id, $a_reference);
20 
21  $this->db = $DIC->database();
22  }
__construct(Container $dic, ilPlugin $plugin)
$DIC
Definition: xapitoken.php:46
+ 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 401 of file class.ilObjPortfolioBase.php.

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

402  {
403  // copy portfolio properties
404  $a_target->setPublicComments($a_source->hasPublicComments());
405  $a_target->setProfilePicture($a_source->hasProfilePicture());
406  $a_target->setFontColor($a_source->getFontColor());
407  $a_target->setBackgroundColor($a_source->getBackgroundColor());
408  $a_target->setImage($a_source->getImage());
409  $a_target->update();
410 
411  // banner/images
412  $source_dir = $a_source->initStorage($a_source->getId());
413  $target_dir = $a_target->initStorage($a_target->getId());
414  ilFSStoragePortfolio::_copyDirectory($source_dir, $target_dir);
415 
416  // set/copy stylesheet
417  $style_id = $a_source->getStyleSheetId();
418  if ($style_id > 0 && !ilObjStyleSheet::_lookupStandard($style_id)) {
419  $style_obj = ilObjectFactory::getInstanceByObjId($style_id);
420  $new_id = $style_obj->ilClone();
421  $a_target->setStyleSheetId($new_id);
422  $a_target->update();
423  }
424  }
getStyleSheetId()
Get style sheet id.
setPublicComments($a_value)
Set public comments status.
static initStorage($a_id, $a_subdir=null)
Init file system storage.
setFontColor($a_value)
Set font color.
hasProfilePicture()
Get profile picture status.
getBackgroundColor()
Get background color.
getFontColor()
Get font color.
static _lookupStandard($a_id)
Lookup standard flag.
static _copyDirectory($a_source, $a_target)
Copy directory and all contents.
getId()
get object id public
hasPublicComments()
Active public comments?
static getInstanceByObjId($a_obj_id, $stop_on_error=true)
get an instance of an Ilias object by object id
getImage()
Get banner image.
setStyleSheetId($a_style)
Set style sheet id.
setBackgroundColor($a_value)
Set background color.
setImage($a_value)
Set banner image.
setProfilePicture($a_status)
Toggle profile picture status.
+ Here is the call 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 433 of file class.ilObjPortfolioBase.php.

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

Referenced by ilObjPortfolioTemplateGUI\afterSave().

434  {
435  global $DIC;
436 
437  $lng = $DIC->language();
438  $ilUser = $DIC->user();
439 
440  $source_id = $a_source->getId();
441  $target_id = $a_target->getId();
442 
443  if ($a_source instanceof ilObjPortfolioTemplate &&
444  $a_target instanceof ilObjPortfolio) {
445  $direction = "t2p";
446  } elseif ($a_source instanceof ilObjPortfolio &&
447  $a_target instanceof ilObjPortfolioTemplate) {
448  $direction = "p2t";
449  } else {
450  return;
451  }
452 
453  self::cloneBasics($a_source, $a_target);
454 
455  // personal skills
456  $pskills = array_keys(ilPersonalSkill::getSelectedUserSkills($ilUser->getId()));
457 
458  // copy pages
459  $blog_count = 0;
460  $page_map = array();
461  foreach (ilPortfolioPage::getAllPortfolioPages($source_id) as $page) {
462  $page_id = $page["id"];
463 
464  if ($direction == "t2p") {
465  $source_page = new ilPortfolioTemplatePage($page_id);
466  $target_page = new ilPortfolioPage();
467  } else {
468  $source_page = new ilPortfolioPage($page_id);
469  $target_page = new ilPortfolioTemplatePage();
470  }
471  $source_page->setPortfolioId($source_id);
472  $target_page->setPortfolioId($target_id);
473 
474  $page_type = $source_page->getType();
475  $page_title = $source_page->getTitle();
476 
477 
478 
479 
480  $page_recipe = null;
481  if (is_array($a_recipe)) {
482  $page_recipe = $a_recipe[$page_id];
483  }
484 
485  $valid = false;
486  switch ($page_type) {
487  // blog => blog template
489  if ($direction == "p2t") {
491  $page_title = $lng->txt("obj_blog") . " " . (++$blog_count);
492  $valid = true;
493  }
494  break;
495 
496  // blog template => blog (needs recipe)
498  if ($direction == "t2p" && (is_array($page_recipe) || $copy_all)) {
499  $page_type = ilPortfolioPage::TYPE_BLOG;
500  if ($copy_all) {
501  $page_title = self::createBlogInPersonalWorkspace($page_title);
502  $valid = true;
503  } else {
504  if ($page_recipe[0] == "blog") {
505  switch ($page_recipe[1]) {
506  case "create":
507  $page_title = self::createBlogInPersonalWorkspace($page_recipe[2]);
508  $valid = true;
509  break;
510 
511  case "reuse":
512  $page_title = $page_recipe[2];
513  $valid = true;
514  break;
515 
516  case "ignore":
517  // do nothing
518  break;
519  }
520  }
521  }
522  }
523  break;
524 
525  // page editor
526  default:
527  $target_page->setXMLContent($source_page->copyXmlContent(true)); // copy mobs
528  $target_page->buildDom(true);
529 
530 
531  // parse content / blocks
532 
533  if ($direction == "t2p") {
534  $dom = $target_page->getDom();
535  if ($dom instanceof php4DOMDocument) {
536  $dom = $dom->myDOMDocument;
537  }
538 
539  // update profile/consultation hours user id
540  self::updateDomNodes($dom, "//PageContent/Profile", "User", $ilUser->getId());
541  self::updateDomNodes($dom, "//PageContent/ConsultationHours", "User", $ilUser->getId());
542  self::updateDomNodes($dom, "//PageContent/MyCourses", "User", $ilUser->getId());
543 
544  // skills
545  $xpath = new DOMXPath($dom);
546  $nodes = $xpath->query("//PageContent/Skills");
547  foreach ($nodes as $node) {
548  $skill_id = $node->getAttribute("Id");
549 
550  // existing personal skills
551  if (in_array($skill_id, $pskills)) {
552  $node->setAttribute("User", $ilUser->getId());
553  }
554  // new skill
555  elseif ($copy_all || in_array($skill_id, $a_recipe["skills"])) {
556  ilPersonalSkill::addPersonalSkill($ilUser->getId(), $skill_id);
557 
558  $node->setAttribute("User", $ilUser->getId());
559  }
560  // remove skill
561  else {
562  $page_element = $node->parentNode;
563  $page_element->parentNode->removeChild($page_element);
564  }
565  }
566  }
567 
568  $valid = true;
569  break;
570  }
571 
572  if ($valid) {
573  // #12038 - update xml from dom
574  $target_page->setXMLContent($target_page->getXMLFromDom());
575 
576  $target_page->setType($page_type);
577  $target_page->setTitle($page_title);
578  $target_page->create();
579 
580  if ($page_type == ilPortfolioPage::TYPE_PAGE) {
581  $target_page->update(); // handle mob usages!
582  }
583  $page_map[$source_page->getId()] = $target_page->getId();
584  }
585  }
586 
587  ilPortfolioPage::updateInternalLinks($page_map, $a_target);
588  }
static getAllPortfolioPages($a_portfolio_id)
Get pages of portfolio.
$valid
$target_id
Definition: goto.php:49
static getSelectedUserSkills($a_user_id)
Get personal selected user skills.
static updateInternalLinks($a_copied_nodes, ilObjPortfolioBase $a_target_obj)
Update internal links, after multiple pages have been copied.
getId()
get object id public
static addPersonalSkill($a_user_id, $a_skill_node_id)
Add personal skill.
$ilUser
Definition: imgupload.php:18
Page for user portfolio.
Page for portfolio template.
$DIC
Definition: xapitoken.php:46
+ 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 599 of file class.ilObjPortfolioBase.php.

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

600  {
601  global $DIC;
602 
603  $ilUser = $DIC->user();
604 
605  static $ws_access = null;
606 
607  $blog = new ilObjBlog();
608  $blog->setType("blog");
609  $blog->setTitle($a_title);
610  $blog->create();
611 
612  if (!$ws_access) {
613  $tree = new ilWorkspaceTree($ilUser->getId());
614 
615  // #13235
616  if (!$tree->getRootId()) {
617  $tree->createTreeForUser($ilUser->getId());
618  }
619 
620  $ws_access = new ilWorkspaceAccessHandler($tree);
621  }
622 
623  $tree = $ws_access->getTree();
624  $node_id = $tree->insertObject($tree->getRootId(), $blog->getId());
625  $ws_access->setPermissions($tree->getRootId(), $node_id);
626 
627  return $blog->getId();
628  }
Access handler for personal workspace.
Tree handler for personal workspace.
Class ilObjBlog.
$ilUser
Definition: imgupload.php:18
$DIC
Definition: xapitoken.php:46

◆ deleteAllPages()

ilObjPortfolioBase::deleteAllPages ( )
abstractprotected

Referenced by doDelete().

+ Here is the caller graph for this function:

◆ deleteImage()

ilObjPortfolioBase::deleteImage ( )

remove existing file

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

References setImage().

Referenced by doDelete(), and uploadImage().

309  {
310  if ($this->id) {
311  $storage = new ilFSStoragePortfolio($this->id);
312  $storage->delete();
313 
314  $this->setImage(null);
315  }
316  }
setImage($a_value)
Set banner image.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ doCreate()

ilObjPortfolioBase::doCreate ( )
protected

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

References ilObject\$db, and $ilDB.

233  {
234  $ilDB = $this->db;
235 
236  $ilDB->manipulate("INSERT INTO usr_portfolio (id,is_online)" .
237  " VALUES (" . $ilDB->quote($this->id, "integer") . "," .
238  $ilDB->quote(0, "integer") . ")");
239  }
global $ilDB

◆ doDelete()

ilObjPortfolioBase::doDelete ( )
protected

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

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

271  {
272  $ilDB = $this->db;
273 
274  $this->deleteAllPages();
275  $this->deleteImage();
276 
277  $ilDB->manipulate("DELETE FROM usr_portfolio" .
278  " WHERE id = " . $ilDB->quote($this->id, "integer"));
279  }
deleteImage()
remove existing file
global $ilDB
+ Here is the call graph for this function:

◆ doRead()

ilObjPortfolioBase::doRead ( )
protected

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

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

207  {
208  $ilDB = $this->db;
209 
210  $set = $ilDB->query("SELECT * FROM usr_portfolio" .
211  " WHERE id = " . $ilDB->quote($this->id, "integer"));
212  $row = $ilDB->fetchAssoc($set);
213 
214  $this->setOnline((bool) $row["is_online"]);
215  $this->setProfilePicture((bool) $row["ppic"]);
216  $this->setBackgroundColor($row["bg_color"]);
217  $this->setFontColor($row["font_color"]);
218  $this->setImage($row["img"]);
219 
220  // #14661
221  $this->setPublicComments(ilNote::commentsActivated($this->id, 0, $this->getType()));
222 
224 
225  $this->doReadCustom($row);
226  }
static commentsActivated($a_rep_obj_id, $a_obj_id, $a_obj_type, $a_news_id=0)
Are comments activated for object?
setPublicComments($a_value)
Set public comments status.
setFontColor($a_value)
Set font color.
static lookupObjectStyle($a_obj_id)
Lookup object style.
setOnline($a_value)
Set online status.
setStyleSheetId($a_style)
Set style sheet id.
global $ilDB
setBackgroundColor($a_value)
Set background color.
setImage($a_value)
Set banner image.
setProfilePicture($a_status)
Toggle profile picture status.
+ Here is the call graph for this function:

◆ doReadCustom()

ilObjPortfolioBase::doReadCustom ( array  $a_row)
protected

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

Referenced by doRead().

229  {
230  }
+ Here is the caller graph for this function:

◆ doUpdate()

ilObjPortfolioBase::doUpdate ( )
protected

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

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

242  {
243  $ilDB = $this->db;
244 
245  $fields = array(
246  "is_online" => array("integer", $this->isOnline()),
247  "ppic" => array("integer", $this->hasProfilePicture()),
248  "bg_color" => array("text", $this->getBackgroundColor()),
249  "font_color" => array("text", $this->getFontcolor()),
250  "img" => array("text", $this->getImage())
251  );
252  $this->doUpdateCustom($fields);
253 
254  // #14661
255  ilNote::activateComments($this->id, 0, $this->getType(), $this->hasPublicComments());
256 
258 
259  $ilDB->update(
260  "usr_portfolio",
261  $fields,
262  array("id" => array("integer", $this->id))
263  );
264  }
getStyleSheetId()
Get style sheet id.
hasProfilePicture()
Get profile picture status.
getBackgroundColor()
Get background color.
static writeStyleUsage($a_obj_id, $a_style_id)
Write style usage.
hasPublicComments()
Active public comments?
getImage()
Get banner image.
static activateComments($a_rep_obj_id, $a_obj_id, $a_obj_type, $a_activate=true)
Activate notes feature.
global $ilDB
doUpdateCustom(array &$a_fields)
+ Here is the call graph for this function:

◆ doUpdateCustom()

ilObjPortfolioBase::doUpdateCustom ( array &  $a_fields)
protected

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

Referenced by doUpdate().

267  {
268  }
+ Here is the caller graph for this function:

◆ fixLinksOnTitleChange()

ilObjPortfolioBase::fixLinksOnTitleChange (   $a_title_changes)

Fix internal portfolio links.

Parameters
array

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

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

636  {
637  foreach (ilPortfolioPage::getAllPortfolioPages($this->getId()) as $port_page) {
638  if ($this->getType() == "prtt") {
639  $page = new ilPortfolioTemplatePage($port_page["id"]);
640  } else {
641  $page = new ilPortfolioPage($port_page["id"]);
642  }
643  if ($page->renameLinksOnTitleChange($a_title_changes)) {
644  $page->update(true, true);
645  }
646  }
647  }
static getAllPortfolioPages($a_portfolio_id)
Get pages of portfolio.
getId()
get object id public
Page for user portfolio.
Page for portfolio template.
+ Here is the call graph for this function:

◆ getBackgroundColor()

ilObjPortfolioBase::getBackgroundColor ( )

Get background color.

Returns
string

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

References $bg_color.

Referenced by cloneBasics(), and doUpdate().

121  {
122  if (!$this->bg_color) {
123  $this->bg_color = "ffffff";
124  }
125  return $this->bg_color;
126  }
+ Here is the caller graph for this function:

◆ getFontColor()

ilObjPortfolioBase::getFontColor ( )

Get font color.

Returns
string

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

References $font_color.

Referenced by cloneBasics().

144  {
145  if (!$this->font_color) {
146  $this->font_color = "505050";
147  }
148  return $this->font_color;
149  }
+ Here is the caller graph for this function:

◆ getImage()

ilObjPortfolioBase::getImage ( )

Get banner image.

Returns
string

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

References $img.

Referenced by cloneBasics(), and doUpdate().

167  {
168  return $this->img;
169  }
+ 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 293 of file class.ilObjPortfolioBase.php.

References $img, and initStorage().

294  {
295  if ($this->img) {
296  $path = $this->initStorage($this->id);
297  if (!$a_as_thumb) {
298  return $path . $this->img;
299  } else {
300  return $path . "thb_" . $this->img;
301  }
302  }
303  }
static initStorage($a_id, $a_subdir=null)
Init file system storage.
+ Here is the call graph for this function:

◆ getStyleSheetId()

ilObjPortfolioBase::getStyleSheetId ( )

Get style sheet id.

Returns
bool

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

References $style.

Referenced by cloneBasics(), and doUpdate().

187  {
188  return (int) $this->style;
189  }
+ Here is the caller graph for this function:

◆ hasProfilePicture()

ilObjPortfolioBase::hasProfilePicture ( )

Get profile picture status.

Returns
bool

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

References $ppic.

Referenced by cloneBasics(), and doUpdate().

101  {
102  return $this->ppic;
103  }
+ Here is the caller graph for this function:

◆ hasPublicComments()

ilObjPortfolioBase::hasPublicComments ( )

Active public comments?

Returns
bool

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

References $comments.

Referenced by cloneBasics(), and doUpdate().

91  {
92  return $this->comments;
93  }
+ 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 325 of file class.ilObjPortfolioBase.php.

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

326  {
327  $storage = new ilFSStoragePortfolio($a_id);
328  $storage->create();
329 
330  $path = $storage->getAbsolutePath() . "/";
331 
332  if ($a_subdir) {
333  $path .= $a_subdir . "/";
334 
335  if (!is_dir($path)) {
336  mkdir($path);
337  }
338  }
339 
340  return $path;
341  }
+ Here is the caller graph for this function:

◆ isOnline()

ilObjPortfolioBase::isOnline ( )

Is online?

Returns
bool

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

References $online.

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

53  {
54  return $this->online;
55  }
+ Here is the caller graph for this function:

◆ lookupOnline()

static ilObjPortfolioBase::lookupOnline (   $a_id)
static

Is online?

Returns
bool

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

References $DIC, and $ilDB.

Referenced by ilObjPortfolioTemplateAccess\_lookupOnline().

63  {
64  global $DIC;
65 
66  $ilDB = $DIC->database();
67 
68  $set = $ilDB->query("SELECT is_online" .
69  " FROM usr_portfolio" .
70  " WHERE id = " . $ilDB->quote($a_id, "integer"));
71  $row = $ilDB->fetchAssoc($set);
72  return (bool) $row["is_online"];
73  }
global $ilDB
$DIC
Definition: xapitoken.php:46
+ Here is the caller graph for this function:

◆ setBackgroundColor()

ilObjPortfolioBase::setBackgroundColor (   $a_value)

Set background color.

Parameters
string$a_value

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

Referenced by cloneBasics(), and doRead().

134  {
135  $this->bg_color = (string) $a_value;
136  }
+ Here is the caller graph for this function:

◆ setFontColor()

ilObjPortfolioBase::setFontColor (   $a_value)

Set font color.

Parameters
string$a_value

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

Referenced by cloneBasics(), and doRead().

157  {
158  $this->font_color = (string) $a_value;
159  }
+ Here is the caller graph for this function:

◆ setImage()

ilObjPortfolioBase::setImage (   $a_value)

Set banner image.

Parameters
string$a_value

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

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

177  {
178  $this->img = (string) $a_value;
179  }
+ Here is the caller graph for this function:

◆ setOnline()

ilObjPortfolioBase::setOnline (   $a_value)

Set online status.

Parameters
bool$a_value

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

Referenced by doRead().

43  {
44  $this->online = (bool) $a_value;
45  }
+ Here is the caller graph for this function:

◆ setProfilePicture()

ilObjPortfolioBase::setProfilePicture (   $a_status)

Toggle profile picture status.

Parameters
bool$a_status

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

Referenced by cloneBasics(), and doRead().

111  {
112  $this->ppic = (bool) $a_status;
113  }
+ Here is the caller graph for this function:

◆ setPublicComments()

ilObjPortfolioBase::setPublicComments (   $a_value)

Set public comments status.

Parameters
bool$a_value

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

Referenced by cloneBasics(), and doRead().

81  {
82  $this->comments = (bool) $a_value;
83  }
+ Here is the caller graph for this function:

◆ setStyleSheetId()

ilObjPortfolioBase::setStyleSheetId (   $a_style)

Set style sheet id.

Parameters
int$a_style

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

Referenced by cloneBasics(), and doRead().

197  {
198  $this->style = (int) $a_style;
199  }
+ 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 590 of file class.ilObjPortfolioBase.php.

591  {
592  $xpath_temp = new DOMXPath($a_dom);
593  $nodes = $xpath_temp->query($a_xpath);
594  foreach ($nodes as $node) {
595  $node->setAttribute($a_attr_id, $a_attr_value);
596  }
597  }

◆ uploadImage()

ilObjPortfolioBase::uploadImage ( array  $a_upload)

Upload new image file.

Parameters
array$a_upload
Returns
bool

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

References deleteImage(), ilUtil\escapeShellArg(), ilUtil\execConvert(), initStorage(), ilUtil\moveUploadedFile(), and setImage().

350  {
351  if (!$this->id) {
352  return false;
353  }
354 
355  $this->deleteImage();
356 
357  // #10074
358  $clean_name = preg_replace("/[^a-zA-Z0-9\_\.\-]/", "", $a_upload["name"]);
359 
360  $path = $this->initStorage($this->id);
361  $original = "org_" . $this->id . "_" . $clean_name;
362  $thumb = "thb_" . $this->id . "_" . $clean_name;
363  $processed = $this->id . "_" . $clean_name;
364 
365  if (ilUtil::moveUploadedFile($a_upload["tmp_name"], $original, $path . $original)) {
366  chmod($path . $original, 0770);
367 
368  $prfa_set = new ilSetting("prfa");
369  /* as banner height should overflow, we only handle width
370  $dimensions = $prfa_set->get("banner_width")."x".
371  $prfa_set->get("banner_height");
372  */
373  $dimensions = $prfa_set->get("banner_width");
374 
375  // take quality 100 to avoid jpeg artefacts when uploading jpeg files
376  // taking only frame [0] to avoid problems with animated gifs
377  $original_file = ilUtil::escapeShellArg($path . $original);
378  $thumb_file = ilUtil::escapeShellArg($path . $thumb);
379  $processed_file = ilUtil::escapeShellArg($path . $processed);
380  ilUtil::execConvert($original_file . "[0] -geometry 100x100 -quality 100 JPEG:" . $thumb_file);
381  ilUtil::execConvert($original_file . "[0] -geometry " . $dimensions . " -quality 100 JPEG:" . $processed_file);
382 
383  $this->setImage($processed);
384 
385  return true;
386  }
387  return false;
388  }
deleteImage()
remove existing file
static initStorage($a_id, $a_subdir=null)
Init file system storage.
static execConvert($args)
execute convert command
static moveUploadedFile($a_file, $a_name, $a_target, $a_raise_errors=true, $a_mode="move_uploaded")
move uploaded file
static escapeShellArg($a_arg)
setImage($a_value)
Set banner image.
+ Here is the call graph for this function:

Field Documentation

◆ $bg_color

ilObjPortfolioBase::$bg_color
protected

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

Referenced by getBackgroundColor().

◆ $comments

ilObjPortfolioBase::$comments
protected

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

Referenced by hasPublicComments().

◆ $font_color

ilObjPortfolioBase::$font_color
protected

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

Referenced by getFontColor().

◆ $img

ilObjPortfolioBase::$img
protected

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

Referenced by getImage(), and getImageFullPath().

◆ $online

ilObjPortfolioBase::$online
protected

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

Referenced by isOnline().

◆ $ppic

ilObjPortfolioBase::$ppic
protected

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

Referenced by hasProfilePicture().

◆ $style

ilObjPortfolioBase::$style
protected

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

Referenced by getStyleSheetId().


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