ilPortfolioDataSet Class Reference

Portfolio Data set class. More...

Inheritance diagram for ilPortfolioDataSet:

Collaboration diagram for ilPortfolioDataSet:

Public Member Functions
	getSupportedVersions ()
	Get supported versions. More...
	getXmlNamespace ($a_entity, $a_schema_version)
	Get xml namespace. More...
	readData ($a_entity, $a_version, $a_ids, $a_field="")
	Read data. More...
	getXmlRecord ($a_entity, $a_version, $a_set)
	Get xml record. More...
	importRecord ($a_entity, $a_types, $a_rec, $a_mapping, $a_schema_version)
	Import record. More...
Public Member Functions inherited from ilDataSet
	__construct ()
	Constructor. More...
	init ($a_entity, $a_schema_version)
	Init. More...
	getSupportedVersions ()
	Get supported version. More...
	readData ($a_entity, $a_version, $a_ids)
	Read data from DB. More...
	setExportDirectories ($a_relative, $a_absolute)
	Set export directories. More...
	setImportDirectory ($a_val)
	Set import directory. More...
	getImportDirectory ()
	Get import directory. More...
	setDSPrefix ($a_val)
	Set XML dataset namespace prefix. More...
	getDSPrefix ()
	Get XML dataset namespace prefix. More...
	getDSPrefixString ()
	getDirectDataFromQuery ($a_query, $a_convert_to_leading_upper=true, $a_set=true)
	Get data from query.This is a standard procedure, all db field names are directly mapped to abstract fields. More...
	convertToLeadingUpper ($a_str)
	Make xyz_abc a XyzAbc string. More...
	getJsonRepresentation ()
	Get json representation. More...
	getXmlRepresentation ( $a_entity, $a_schema_version, $a_ids, $a_field="", $a_omit_header=false, $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 ...> ... </types> <set entity="table_name"> <rec> <field_1>content</field_1> <field_2>my_date</field_2> <field_3>my_number</field_3> </rec> ... </set> </dataset> More...
	addRecordsXml ($a_writer, $a_prefixes, $a_entity, $a_schema_version, $a_ids, $a_field="")
	Add records xml. More...
	afterXmlRecordWriting ($a_entity, $a_version, $a_set)
	After xml record writing hook record. More...
	getNamespaces (&$namespaces, $a_entity, $a_schema_version)
	Get xml namespaces. More...
	getXmlRecord ($a_entity, $a_version, $a_set)
	Get xml record for version. More...
	getJsonRecord ($a_set)
	Get json record for version. More...
	getXmlTypes ($a_entity, $a_version)
	Get xml types. More...
	getJsonTypes ($a_entity, $a_version)
	Get json types. More...
	getXMLEntityName ($a_entity, $a_version)
	Get entity name for xml (may be overwritten) More...
	getXMLEntityTag ($a_entity, $a_schema_version)
	Get entity tag. More...
	getJsonEntityName ($a_entity, $a_version)
	Get entity name for json (may be overwritten) More...
	setImport ($a_val)
	Set import object. More...
	getImport ()
	Get import object. More...
	setCurrentInstallationId ($a_val)
	Set current installation id. More...
	getCurrentInstallationId ()
	Get current installation id. More...

Protected Member Functions
	getTypes ($a_entity, $a_version)
	Get field types for entity. More...
	getDependencies ($a_entity, $a_version, $a_rec, $a_ids)
	Determine the dependent sets of data. More...
Protected Member Functions inherited from ilDataSet
	getTypes ($a_entity, $a_version)
	Get (abstract) types for (abstract) field names. More...
	getXmlNamespace ($a_entity, $a_schema_version)
	Get xml namespace. More...
	createObjectExportId ($a_type, $a_id)
	Build ilias export id. More...
	parseObjectExportId ($a_id, $a_fallback_id=null)
	Parse export id. More...

Protected Attributes
	$current_portfolio
Protected Attributes inherited from ilDataSet
	$current_installation_id = ""
	$db
	$ds_log

Additional Inherited Members
Data Fields inherited from ilDataSet
	$dircnt
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

Detailed Description

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

Version

$Id$

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

Member Function Documentation

getDependencies()

ilPortfolioDataSet::getDependencies (   $a_entity,   $a_version,   $a_rec,   $a_ids  )

protected

Determine the dependent sets of data.

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

    {
        switch ($a_entity) {
            case "prtt":
                return array(
                    "portfolio_page" => array("ids" => $a_rec["Id"])
                );
        }
        return false;
    }

getSupportedVersions()

ilPortfolioDataSet::getSupportedVersions

(

)

Get supported versions.

Reimplemented from ilDataSet.

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

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

getTypes()

ilPortfolioDataSet::getTypes (   $a_entity,   $a_version  )

protected

Get field types for entity.

Reimplemented from ilDataSet.

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

    {
        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"
                        );
            }
        }
        
        if ($a_entity == "portfolio_page") {
            switch ($a_version) {
                case "4.4.0":
                case "5.0.0":
                    return array(
                        "Id" => "integer",
                        "PortfolioId" => "integer",
                        "Title" => "integer",
                        "OrderNr" => "integer",
                        "Type" => "text"
                    );
            }
        }
    }

getXmlNamespace()

ilPortfolioDataSet::getXmlNamespace	(		$a_entity,
			$a_schema_version
	)

Get xml namespace.

Reimplemented from ilDataSet.

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

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

getXmlRecord()

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

Get xml record.

Parameters

return

Reimplemented from ilDataSet.

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

    {
        if ($a_entity == "prtt") {
            include_once("./Modules/Portfolio/classes/class.ilObjPortfolioTemplate.php");
            $dir = ilObjPortfolioTemplate::initStorage($a_set["Id"]);
            $a_set["Dir"] = $dir;
            
            include_once("./Services/Notes/classes/class.ilNote.php");
            $a_set["Comments"] = ilNote::commentsActivated($a_set["Id"], 0, "prtt");
        }
 
        return $a_set;
    }

References ilNote\commentsActivated(), and ilObjPortfolioBase\initStorage().

Here is the call graph for this function:

importRecord()

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

Import record.

Parameters

return

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

    {
        switch ($a_entity) {
            case "prtt":
                include_once("./Modules/Portfolio/classes/class.ilObjPortfolioTemplate.php");
                
                // container copy
                if ($new_id = $a_mapping->getMapping("Services/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->setImage($a_rec["Img"]);
                $newObj->update();
                
                // handle image(s)
                if ($a_rec["Img"]) {
                    $dir = str_replace("..", "", $a_rec["Dir"]);
                    if ($dir != "" && $this->getImportDirectory() != "") {
                        $source_dir = $this->getImportDirectory() . "/" . $dir;
                        $target_dir = ilObjPortfolioTemplate::initStorage($newObj->getId());
                        ilUtil::rCopy($source_dir, $target_dir);
                    }
                }
 
                $a_mapping->addMapping("Modules/Portfolio", "prtt", $a_rec["Id"], $newObj->getId());
                $a_mapping->addMapping("Services/Object", "obj", $a_rec["Id"], $newObj->getId());
                break;
 
            case "portfolio_page":
                $prtt_id = (int) $a_mapping->getMapping("Modules/Portfolio", "prtt", $a_rec["PortfolioId"]);
                if ($prtt_id) {
                    include_once("./Modules/Portfolio/classes/class.ilPortfolioTemplatePage.php");
                    $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("Services/COPage", "pg", "prtt:" . $a_rec["Id"], "prtt:" . $newObj->getId());
                }
                break;
        }
    }

References ilDataSet\getImportDirectory(), ilObjectFactory\getInstanceByObjId(), ilObjPortfolioBase\initStorage(), and ilUtil\rCopy().

Here is the call graph for this function:

readData()

ilPortfolioDataSet::readData	(		$a_entity,
			$a_version,
			$a_ids,
			$a_field = ""
	)

Read data.

Parameters

return

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

    {
        $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":
                    $this->getDirectDataFromQuery("SELECT prtf.id,od.title,od.description," .
                        "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;
            }
        }
        
        if ($a_entity == "portfolio_page") {
            switch ($a_version) {
                case "4.4.0":
                case "5.0.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;
            }
        }
    }

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

Here is the call graph for this function:

Field Documentation

$current_portfolio

ilPortfolioDataSet::$current_portfolio

protected

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

---

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

• Modules/Portfolio/classes/class.ilPortfolioDataSet.php