ILIAS  release_4-3 Revision
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
ilObjPortfolio Class Reference

Portfolio. More...

+ Inheritance diagram for ilObjPortfolio:
+ Collaboration diagram for ilObjPortfolio:

Public Member Functions

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

Static Public Member Functions

static setUserDefault ($a_user_id, $a_portfolio_id=null)
 Set the user default portfolio.
static getPortfoliosOfUser ($a_user_id)
 Get views of user.
static getDefaultPortfolio ($a_user_id)
 Get default portfolio of user.
static initStorage ($a_id, $a_subdir=null)
 Init file system storage.
static deleteUserPortfolios ($a_user_id)
 Delete all portfolio data for user.
- Static Public Member Functions inherited from ilObject2
static _lookupObjIdByImportId ($a_import_id)
static _getAllReferences ($a_id)
 get all reference ids of object
static _lookupTitle ($a_id)
 lookup object title
static _getIdsForTitle ($title, $type= '', $partialmatch=false)
static _lookupDescription ($a_id)
 lookup object description
static _lookupObjId ($a_id)
static _lookupType ($a_id, $a_reference=false)
 lookup object type
static _lookupObjectId ($a_ref_id)
 lookup object id
static _getObjectsByType ($a_obj_type="", $a_owner="")
 Get objects by type.
static _prepareCloneSelection ($a_ref_ids, $new_type)
static _getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
 Get icon for repository item.
- Static Public Member Functions inherited from ilObject
static _prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
 Prepare copy wizard object selection.
static collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
 Collect deletion dependencies.
static getDeletionDependencies ($a_obj_id)
 Get deletion dependencies.
static getLongDescriptions (array $a_obj_ids)
 Get long description data.
static getAllOwnedRepositoryObjects ($a_user_id)
 Get all ids of objects user owns.

Protected Member Functions

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

Protected Attributes

 $online
 $comments
 $default
 $bg_color
 $font_color
 $img
 $ppic

Additional Inherited Members

- Data Fields inherited from ilObject
const TITLE_LENGTH = 128
 max length of object title
 $ilias
 $lng
 $id
 $ref_id
 $type
 $title
 $untranslatedTitle
 $desc
 $long_desc
 $owner
 $create_date
 $last_update
 $import_id
 $register = false
 $referenced
 $objectList
 $max_title
 $max_desc
 $add_dots
 $obj_data_record
 object_data record

Detailed Description

Portfolio.

Author
Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Version
$Id$

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

Member Function Documentation

ilObjPortfolio::deleteImage ( )

remove existing file

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

References setImage().

Referenced by doDelete(), and uploadImage().

{
if($this->id)
{
include_once "Services/Portfolio/classes/class.ilFSStoragePortfolio.php";
$storage = new ilFSStoragePortfolio($this->id);
$storage->delete();
$this->setImage(null);
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static ilObjPortfolio::deleteUserPortfolios (   $a_user_id)
static

Delete all portfolio data for user.

Parameters
int$a_user_id

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

References getPortfoliosOfUser().

Referenced by ilObjUser\delete().

{
$all = self::getPortfoliosOfUser($a_user_id);
if($all)
{
include_once "Services/Portfolio/classes/class.ilPortfolioAccessHandler.php";
$access_handler = new ilPortfolioAccessHandler();
foreach($all as $item)
{
$access_handler->removePermission($item["id"]);
$portfolio = new self($item["id"], false);
$portfolio->delete();
}
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjPortfolio::doCreate ( )
protected

Reimplemented from ilObject2.

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

References isDefault(), and isOnline().

{
global $ilDB;
$ilDB->manipulate("INSERT INTO usr_portfolio (id,is_online,is_default)".
" VALUES (".$ilDB->quote($this->id, "integer").",".
$ilDB->quote($this->isOnline(), "integer").",".
$ilDB->quote($this->isDefault(), "integer").")");
}

+ Here is the call graph for this function:

ilObjPortfolio::doDelete ( )
protected

Reimplemented from ilObject2.

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

References deleteImage(), and ilPortfolioPage\getAllPages().

{
global $ilDB;
// delete pages
include_once "Services/Portfolio/classes/class.ilPortfolioPage.php";
$pages = ilPortfolioPage::getAllPages($this->id);
foreach($pages as $page)
{
$page = new ilPortfolioPage($this->id, $page["id"]);
$page->delete();
}
$this->deleteImage();
$ilDB->manipulate("DELETE FROM usr_portfolio".
" WHERE id = ".$ilDB->quote($this->id, "integer"));
}

+ Here is the call graph for this function:

ilObjPortfolio::doRead ( )
protected

Reimplemented from ilObject2.

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

References $row, setBackgroundColor(), setDefault(), setFontColor(), setImage(), setOnline(), setProfilePicture(), and setPublicComments().

{
global $ilDB;
$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->setPublicComments((bool)$row["comments"]);
$this->setProfilePicture((bool)$row["ppic"]);
$this->setDefault((bool)$row["is_default"]);
$this->setBackgroundColor($row["bg_color"]);
$this->setFontColor($row["font_color"]);
$this->setImage($row["img"]);
}

+ Here is the call graph for this function:

ilObjPortfolio::doUpdate ( )
protected

Reimplemented from ilObject2.

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

References isDefault(), isOnline(), and setDefault().

{
global $ilDB;
// must be online to be default
if(!$this->isOnline() && $this->isDefault())
{
$this->setDefault(false);
}
$ilDB->manipulate("UPDATE usr_portfolio SET".
" is_online = ".$ilDB->quote($this->isOnline(), "integer").
",comments = ".$ilDB->quote($this->hasPublicComments(), "integer").
",ppic = ".$ilDB->quote($this->hasProfilePicture(), "integer").
",is_default = ".$ilDB->quote($this->isDefault(), "integer").
",bg_color = ".$ilDB->quote($this->getBackgroundColor(), "text").
",font_color = ".$ilDB->quote($this->getFontcolor(), "text").
",img = ".$ilDB->quote($this->getImage(), "text").
" WHERE id = ".$ilDB->quote($this->id, "integer"));
}

+ Here is the call graph for this function:

ilObjPortfolio::getBackgroundColor ( )

Get background color.

Returns
string

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

References $bg_color.

{
if(!$this->bg_color)
{
$this->bg_color = "ffffff";
}
return $this->bg_color;
}
static ilObjPortfolio::getDefaultPortfolio (   $a_user_id)
static

Get default portfolio of user.

Parameters
type$a_user_id
Returns
int

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

References $ilSetting, and $res.

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

{
global $ilDB, $ilSetting;
if(!$ilSetting->get('user_portfolios'))
{
return;
}
$set = $ilDB->query("SELECT up.id FROM usr_portfolio up".
" JOIN object_data od ON (up.id = od.obj_id)".
" WHERE od.owner = ".$ilDB->quote($a_user_id, "integer").
" AND up.is_default = ".$ilDB->quote(1, "integer"));
$res = $ilDB->fetchAssoc($set);
if($res["id"])
{
return $res["id"];
}
}

+ Here is the caller graph for this function:

ilObjPortfolio::getFontColor ( )

Get font color.

Returns
string

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

References $font_color.

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

Get banner image.

Returns
string

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

References $img.

{
return $this->img;
}
ilObjPortfolio::getImageFullPath (   $a_as_thumb = false)

Get banner image incl.

path

Parameters
bool$a_as_thumb

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

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

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

+ Here is the call graph for this function:

static ilObjPortfolio::getPortfoliosOfUser (   $a_user_id)
static

Get views of user.

Parameters
int$a_user_id
Returns
array

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

References $res.

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

{
global $ilDB;
$set = $ilDB->query("SELECT up.*,od.title,od.description".
" FROM usr_portfolio up".
" JOIN object_data od ON (up.id = od.obj_id)".
" WHERE od.owner = ".$ilDB->quote($a_user_id, "integer").
" ORDER BY od.title");
$res = array();
while ($rec = $ilDB->fetchAssoc($set))
{
$res[] = $rec;
}
return $res;
}

+ Here is the caller graph for this function:

ilObjPortfolio::hasProfilePicture ( )

Get profile picture status.

Returns
bool

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

References $ppic.

{
return $this->ppic;
}
ilObjPortfolio::hasPublicComments ( )

Active public comments?

Returns
bool

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

References $comments.

{
return $this->comments;
}
static ilObjPortfolio::initStorage (   $a_id,
  $a_subdir = null 
)
static

Init file system storage.

Parameters
type$a_id
type$a_subdir
Returns
string

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

References $path.

Referenced by getImageFullPath(), and uploadImage().

{
include_once "Services/Portfolio/classes/class.ilFSStoragePortfolio.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;
}

+ Here is the caller graph for this function:

ilObjPortfolio::initType ( )

Reimplemented from ilObject2.

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

{
$this->type = "prtf";
}
ilObjPortfolio::isDefault ( )

Is default?

Returns
bool

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

References $default.

Referenced by doCreate(), and doUpdate().

{
return $this->default;
}

+ Here is the caller graph for this function:

ilObjPortfolio::isOnline ( )

Is online?

Returns
bool

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

References $online.

Referenced by doCreate(), and doUpdate().

{
return $this->online;
}

+ Here is the caller graph for this function:

ilObjPortfolio::setBackgroundColor (   $a_value)

Set background color.

Parameters
string$a_value

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

Referenced by doRead().

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

+ Here is the caller graph for this function:

ilObjPortfolio::setDefault (   $a_value)

Set default.

Parameters
bool$a_value

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

Referenced by doRead(), and doUpdate().

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

+ Here is the caller graph for this function:

ilObjPortfolio::setFontColor (   $a_value)

Set font color.

Parameters
string$a_value

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

Referenced by doRead().

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

+ Here is the caller graph for this function:

ilObjPortfolio::setImage (   $a_value)

Set banner image.

Parameters
string$a_value

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

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

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

+ Here is the caller graph for this function:

ilObjPortfolio::setOnline (   $a_value)

Set online status.

Parameters
bool$a_value

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

Referenced by doRead().

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

+ Here is the caller graph for this function:

ilObjPortfolio::setProfilePicture (   $a_status)

Toggle profile picture status.

Parameters
bool$a_status

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

Referenced by doRead().

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

+ Here is the caller graph for this function:

ilObjPortfolio::setPublicComments (   $a_value)

Set public comments status.

Parameters
bool$a_value

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

Referenced by doRead().

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

+ Here is the caller graph for this function:

static ilObjPortfolio::setUserDefault (   $a_user_id,
  $a_portfolio_id = null 
)
static

Set the user default portfolio.

Parameters
int$a_user_id
int$a_portfolio_id

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

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

{
global $ilDB;
$all = array();
foreach(self::getPortfoliosOfUser($a_user_id) as $item)
{
$all[] = $item["id"];
}
if($all)
{
$ilDB->manipulate("UPDATE usr_portfolio".
" SET is_default = ".$ilDB->quote(false, "integer").
" WHERE ".$ilDB->in("id", $all, "", "integer"));
}
if($a_portfolio_id)
{
$ilDB->manipulate("UPDATE usr_portfolio".
" SET is_default = ".$ilDB->quote(true, "integer").
" WHERE id = ".$ilDB->quote($a_portfolio_id, "integer"));
}
}

+ Here is the caller graph for this function:

ilObjPortfolio::uploadImage ( array  $a_upload)

Upload new image file.

Parameters
array$a_upload
Returns
bool

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

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

{
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(@move_uploaded_file($a_upload["tmp_name"], $path.$original))
{
chmod($path.$original, 0770);
$prfa_set = new ilSetting("prfa");
$dimensions = $prfa_set->get("banner_width")."x".
$prfa_set->get("banner_height");
// 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;
}

+ Here is the call graph for this function:

Field Documentation

ilObjPortfolio::$bg_color
protected

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

Referenced by getBackgroundColor().

ilObjPortfolio::$comments
protected

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

Referenced by hasPublicComments().

ilObjPortfolio::$default
protected

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

Referenced by isDefault().

ilObjPortfolio::$font_color
protected

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

Referenced by getFontColor().

ilObjPortfolio::$img
protected

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

Referenced by getImage(), and getImageFullPath().

ilObjPortfolio::$online
protected

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

Referenced by isOnline().

ilObjPortfolio::$ppic
protected

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

Referenced by hasProfilePicture().

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