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

Inheritance diagram for ilPortfolioDataSet:

Collaboration diagram for ilPortfolioDataSet:

Public Member Functions
	__construct ()

	getSupportedVersions ()

	readData (string $a_entity, string $a_version, array $a_ids)

	getXmlRecord (string $a_entity, string $a_version, array $a_set)

	importRecord (string $a_entity, array $a_types, array $a_rec, ilImportMapping $a_mapping, string $a_schema_version)

Public Member Functions inherited from ilDataSet
	__construct ()

	init (string $a_entity, string $a_schema_version)
	Init. More...

	getSupportedVersions ()

	readData (string $a_entity, string $a_version, array $a_ids)
	Read data from DB. More...

	initByExporter (ilXmlExporter $xml_exporter)

	setImportDirectory (string $a_val)

	getImportDirectory ()

	setDSPrefix (string $a_val)

	getDSPrefix ()

	getDSPrefixString ()

	getDirectDataFromQuery (string $a_query, bool $a_convert_to_leading_upper=true, bool $a_set=true)
	Get data from query.This is a standard procedure, all db field names are directly mapped to abstract fields. More...

	convertToLeadingUpper (string $a_str)
	Make xyz_abc a XyzAbc string. More...

	getXmlRepresentation (string $a_entity, string $a_schema_version, ?array $a_ids, string $a_field="", bool $a_omit_header=false, bool $a_omit_types=false)
	Get xml representation <dataset install_id="123" install_url="..."> <types entity="table_name" version="4.0.1"> <ftype name="field_1" type="text"> <ftype name="field_2" type="date"> <ftype name="field_3" type="integer"> </types> <types ...> ... More...

	addRecordsXml (ilXmlWriter $a_writer, array $a_prefixes, string $a_entity, string $a_schema_version, array $a_ids, ?string $a_field="")

	afterXmlRecordWriting (string $a_entity, string $a_version, array $a_set)

	getNamespaces (array &$namespaces, string $a_entity, string $a_schema_version)

	getXmlRecord (string $a_entity, string $a_version, array $a_set)
	Get xml record for version. More...

	getXmlTypes (string $a_entity, string $a_version)
	Get xml types. More...

	getXMLEntityName (string $a_entity, string $a_version)
	Get entity name for xml (may be overwritten) More...

	getXMLEntityTag (string $a_entity, string $a_schema_version)
	Get entity tag. More...

	setImport (ilSurveyImporter $a_val)

	getImport ()

	setCurrentInstallationId (string $a_val)

	getCurrentInstallationId ()

	importRecord (string $a_entity, array $a_types, array $a_rec, ilImportMapping $a_mapping, string $a_schema_version)
	Needs to be overwritten for import use case. More...

	getCollection (array $record, string $entity, string $schema_version, string $field, string $value)

	getContainerExportConfig (array $record, string $entity, string $schema_version, string $field, string $value)

Protected Member Functions
	getXmlNamespace (string $a_entity, string $a_schema_version)

	getTypes (string $a_entity, string $a_version)

	getDependencies (string $a_entity, string $a_version, ?array $a_rec=null, ?array $a_ids=null)

Protected Member Functions inherited from ilDataSet
	getTypes (string $a_entity, string $a_version)
	Get (abstract) types for (abstract) field names. More...

	getXmlNamespace (string $a_entity, string $a_schema_version)

	getExportDirInContainer (string $exp_dir)

	getIRSSContainerExportConfig (StorableResource $source_container, string $source_path, string $target_path="")

	getDependencies (string $a_entity, string $a_version, ?array $a_rec=null, ?array $a_ids=null)

	createObjectExportId (string $a_type, string $a_id)
	Build ilias export id. More...

	parseObjectExportId (string $a_id, ?string $a_fallback_id=null)
	Parse export id. More...

	stripTags (array $rec, array $omit_keys=[])

Protected Attributes
ilObjPortfolio	$current_portfolio

ILIAS Notes Service	$notes

Protected Attributes inherited from ilDataSet
ILIAS ResourceStorage Services	$irss

string	$current_installation_id = ""

array	$data = []

ilDBInterface	$db

ilLogger	$ds_log

string	$import_directory = ""

string	$entity = ""

string	$schema_version = ""

string	$component_export_dir = ""

string	$ds_prefix = "ds"

string	$version = ""

ilSurveyImporter	$import

ilExport	$export

Additional Inherited Members
Data Fields inherited from ilDataSet
const	DATASET_NS = 'http://www.ilias.de/Services/DataSet/ds/4_3'

const	DATASET_NS_PREFIX = 'ds'

const	EXPORT_NO_INST_ID = 1

const	EXPORT_ID_ILIAS_LOCAL = 2

const	EXPORT_ID_ILIAS_LOCAL_INVALID = 3

const	EXPORT_ID_ILIAS_REMOTE = 4

const	EXPORT_ID_ILIAS_REMOTE_INVALID = 5

const	EXPORT_ID = 6

const	EXPORT_ID_INVALID = 7

int	$dircnt = 0

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 Data set class

Only for portfolio templates!

This class implements the following entities:

portfolio: object data (usr_portfolio)
portfolio_page: data from table usr_portfolio_page

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 30 of file class.ilPortfolioDataSet.php.

Constructor & Destructor Documentation

◆ __construct()

ilPortfolioDataSet::__construct ( )

Definition at line 35 of file class.ilPortfolioDataSet.php.

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

     {
         global $DIC;
 
         parent::__construct();
         $this->notes = $DIC->notes();
     }

Here is the call graph for this function:

Member Function Documentation

◆ getDependencies()

ilPortfolioDataSet::getDependencies	(	string	$a_entity,
		string	$a_version,
		?array	$a_rec = `null`,
		?array	$a_ids = `null`
	)

protected

Definition at line 145 of file class.ilPortfolioDataSet.php.

References null.

      : array {
         if ($a_entity === "prtt") {
             return array(
                 "portfolio_page" => array("ids" => $a_rec["Id"] ?? null)
             );
         }
         return [];
     }

◆ getSupportedVersions()

ilPortfolioDataSet::getSupportedVersions ( )

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

                                           : array
     {
         return array("4.4.0", "5.0.0", "10.0");
     }

◆ getTypes()

ilPortfolioDataSet::getTypes	(	string	$a_entity,
		string	$a_version
	)

protected

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

                                                                     : array
     {
         if ($a_entity === "prtt") {
             switch ($a_version) {
                 case "4.4.0":
                 case "5.0.0":
                     return array(
                         "Id" => "integer",
                         "Title" => "text",
                         "Description" => "text",
                         "Comments" => "integer",
                         "BgColor" => "text",
                         "FontColor" => "text",
                         "Img" => "text",
                         "Ppic" => "integer",
                         "Dir" => "directory"
                         );
                 case "10.0":
                     return array(
                         "Id" => "integer",
                         "Title" => "text",
                         "Description" => "text",
                         "Comments" => "integer",
                         "BgColor" => "text",
                         "FontColor" => "text",
                         "Ppic" => "integer"
                         );
             }
         }
 
         if ($a_entity === "portfolio_page") {
             switch ($a_version) {
                 case "4.4.0":
                 case "5.0.0":
                 case "10.0":
                     return array(
                         "Id" => "integer",
                         "PortfolioId" => "integer",
                         "Title" => "integer",
                         "OrderNr" => "integer",
                         "Type" => "text"
                     );
             }
         }
         return [];
     }

◆ getXmlNamespace()

ilPortfolioDataSet::getXmlNamespace	(	string	$a_entity,
		string	$a_schema_version
	)

protected

Definition at line 49 of file class.ilPortfolioDataSet.php.

                                                                                   : string
     {
         return "https://www.ilias.de/xml/Modules/Portfolio/" . $a_entity;
     }

◆ getXmlRecord()

ilPortfolioDataSet::getXmlRecord	(	string	$a_entity,
		string	$a_version,
		array	$a_set
	)

Definition at line 159 of file class.ilPortfolioDataSet.php.

      : array {
         if ($a_entity === "prtt") {
             $a_set["Comments"] = $this->notes->domain()->commentsActive((int) $a_set["Id"]);
         }
 
         return $a_set;
     }

◆ importRecord()

ilPortfolioDataSet::importRecord	(	string	$a_entity,
		array	$a_types,
		array	$a_rec,
		ilImportMapping	$a_mapping,
		string	$a_schema_version
	)

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

References ilImportMapping\addMapping(), ilObjectFactory\getInstanceByObjId(), ilImportMapping\getMapping(), ILIAS\Repository\int(), and ilDataSet\stripTags().

      : void {
         $a_rec = $this->stripTags($a_rec);
         switch ($a_entity) {
             case "prtt":
 
                 // container copy
                 if ($new_id = $a_mapping->getMapping("components/ILIAS/Container", "objs", $a_rec["Id"])) {
                     $newObj = ilObjectFactory::getInstanceByObjId($new_id, false);
                 } else {
                     $newObj = new ilObjPortfolioTemplate();
                     $newObj->create();
                 }
 
                 $newObj->setTitle($a_rec["Title"]);
                 $newObj->setDescription($a_rec["Description"]);
                 $newObj->setPublicComments($a_rec["Comments"]);
                 $newObj->setBackgroundColor($a_rec["BgColor"]);
                 $newObj->setFontColor($a_rec["FontColor"]);
                 $newObj->setProfilePicture($a_rec["Ppic"]);
                 $newObj->update();
 
                 $a_mapping->addMapping("components/ILIAS/Portfolio", "prtt", $a_rec["Id"], $newObj->getId());
                 $a_mapping->addMapping("components/ILIAS/ILIASObject", "obj", $a_rec["Id"], $newObj->getId());
                 break;
 
             case "portfolio_page":
                 $prtt_id = (int) $a_mapping->getMapping("components/ILIAS/Portfolio", "prtt", $a_rec["PortfolioId"]);
                 if ($prtt_id) {
                     $newObj = new ilPortfolioTemplatePage();
                     $newObj->setPortfolioId($prtt_id);
                     $newObj->setTitle($a_rec["Title"]);
                     $newObj->setType($a_rec["Type"]);
                     $newObj->setOrderNr($a_rec["OrderNr"]);
                     $newObj->create(true);
 
                     $a_mapping->addMapping("components/ILIAS/COPage", "pg", "prtt:" . $a_rec["Id"], "prtt:" . $newObj->getId());
                 }
                 break;
         }
     }

Here is the call graph for this function:

◆ readData()

ilPortfolioDataSet::readData	(	string	$a_entity,
		string	$a_version,
		array	$a_ids
	)

Definition at line 101 of file class.ilPortfolioDataSet.php.

References ilDataSet\$db, $ilDB, and ilDataSet\getDirectDataFromQuery().

                                                                                : void
     {
         $ilDB = $this->db;
 
         if (!is_array($a_ids)) {
             $a_ids = array($a_ids);
         }
 
         if ($a_entity === "prtt") {
             switch ($a_version) {
                 case "4.4.0":
                     $this->getDirectDataFromQuery("SELECT prtf.id,od.title,od.description," .
                         "prtf.comments,prtf.bg_color,prtf.font_color,prtf.img,prtf.ppic" .
                         " FROM usr_portfolio prtf" .
                         " JOIN object_data od ON (od.obj_id = prtf.id)" .
                         " WHERE " . $ilDB->in("prtf.id", $a_ids, false, "integer") .
                         " AND od.type = " . $ilDB->quote("prtt", "text"));
                     break;
 
                 case "5.0.0":
                 case "10.0":
                     $this->getDirectDataFromQuery("SELECT prtf.id,od.title,od.description," .
                         "prtf.bg_color,prtf.font_color,prtf.ppic" .
                         " FROM usr_portfolio prtf" .
                         " JOIN object_data od ON (od.obj_id = prtf.id)" .
                         " WHERE " . $ilDB->in("prtf.id", $a_ids, false, "integer") .
                         " AND od.type = " . $ilDB->quote("prtt", "text"));
                     break;
             }
         }
 
         if ($a_entity === "portfolio_page") {
             switch ($a_version) {
                 case "4.4.0":
                 case "5.0.0":
                 case "10.0":
                     $this->getDirectDataFromQuery("SELECT id,portfolio_id,title,order_nr,type" .
                         " FROM usr_portfolio_page" .
                         " WHERE " . $ilDB->in("portfolio_id", $a_ids, false, "integer"));
                     break;
             }
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $current_portfolio

ilObjPortfolio ilPortfolioDataSet::$current_portfolio

protected

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

◆ $notes

ILIAS Notes Service ilPortfolioDataSet::$notes

protected

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

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

components/ILIAS/Portfolio/Export/class.ilPortfolioDataSet.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDependencies()

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

◆ getXmlRecord()

◆ importRecord()

◆ readData()

Field Documentation

◆ $current_portfolio

◆ $notes