Blog Data set class This class implements the following entities: More...

Inheritance diagram for ilBlogDataSet:

Collaboration diagram for ilBlogDataSet:

Public Member Functions
	__construct ()

	getSupportedVersions ()

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

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

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

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

	setExportDirectories (string $a_relative, string $a_absolute)

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

Static Public Attributes
static array	$style_map = array()

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

	getTypes (string $a_entity, string $a_version)
	Get (abstract) types for (abstract) field names. More...

	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)

	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
Service	$notes

ilObjBlog	$current_blog

ILIAS Style Content DomainService	$content_style_domain

Protected Attributes inherited from ilDataSet
string	$current_installation_id = ""

array	$data = []

ilDBInterface	$db

ilLogger	$ds_log

string	$import_directory = ""

string	$entity = ""

string	$schema_version = ""

string	$relative_export_dir = ""

string	$absolute_export_dir = ""

string	$ds_prefix = "ds"

string	$version = ""

ilSurveyImporter	$import

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

Blog Data set class This class implements the following entities:

blog: object data
blog_posting: data from table il_blog_posting
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 28 of file class.ilBlogDataSet.php.

Constructor & Destructor Documentation

◆ __construct()

ilBlogDataSet::__construct ( )

Reimplemented from ilDataSet.

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ getDependencies()

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

protected

Reimplemented from ilDataSet.

Definition at line 236 of file class.ilBlogDataSet.php.

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

◆ getSupportedVersions()

ilBlogDataSet::getSupportedVersions ( )

Reimplemented from ilDataSet.

Definition at line 45 of file class.ilBlogDataSet.php.

                                          : array
    {
        return array("4.3.0", "5.0.0", "5.3.0");
    }

◆ getTypes()

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

protected

Get (abstract) types for (abstract) field names.

Please note that the abstract fields/types only depend on the version! Not on a choosen representation!

Returns: array types array, e.g. array("field_1" => "text", "field_2" => "integer", ...)

Reimplemented from ilDataSet.

Definition at line 57 of file class.ilBlogDataSet.php.

     : array {
        if ($a_entity === "blog") {
            switch ($a_version) {
                case "4.3.0":
                    return array(
                        "Id" => "integer",
                        "Title" => "text",
                        "Description" => "text",
                        "Notes" => "integer",
                        "BgColor" => "text",
                        "FontColor" => "text",
                        "Img" => "text",
                        "Ppic" => "integer",
                        "RssActive" => "integer",
                        "Approval" => "integer",
                        "Dir" => "directory"
                    );
 
                case "5.0.0":
                    return array(
                        "Id" => "integer",
                        "Title" => "text",
                        "Description" => "text",
                        "Notes" => "integer",
                        "BgColor" => "text",
                        "FontColor" => "text",
                        "Img" => "text",
                        "Ppic" => "integer",
                        "RssActive" => "integer",
                        "Approval" => "integer",
                        "Dir" => "directory",
                        "AbsShorten" => "integer",
                        "AbsShortenLen" => "integer",
                        "AbsImage" => "integer",
                        "AbsImgWidth" => "integer",
                        "AbsImgHeight" => "integer",
                        "NavMode" => "integer",
                        "NavListPost" => "integer",
                        "NavListMon" => "integer",
                        "Keywords" => "integer",
                        "Authors" => "integer",
                        "NavOrder" => "text",
                        "OvPost" => "integer",
                        "Style" => "integer"
                    );
 
                case "5.3.0":
                    return array(
                        "Id" => "integer",
                        "Title" => "text",
                        "Description" => "text",
                        "Notes" => "integer",
                        "BgColor" => "text",
                        "FontColor" => "text",
                        "Img" => "text",
                        "Ppic" => "integer",
                        "RssActive" => "integer",
                        "Approval" => "integer",
                        "Dir" => "directory",
                        "AbsShorten" => "integer",
                        "AbsShortenLen" => "integer",
                        "AbsImage" => "integer",
                        "AbsImgWidth" => "integer",
                        "AbsImgHeight" => "integer",
                        "NavMode" => "integer",
                        "NavListMonWithPost" => "integer",
                        "NavListMon" => "integer",
                        "Keywords" => "integer",
                        "Authors" => "integer",
                        "NavOrder" => "text",
                        "OvPost" => "integer",
                        "Style" => "integer"
                    );
 
            }
        }
 
        if ($a_entity === "blog_posting") {
            switch ($a_version) {
                case "4.3.0":
                case "5.0.0":
                case "5.3.0":
                    return array(
                        "Id" => "integer",
                        "BlogId" => "integer",
                        "Title" => "integer",
                        "Created" => "text",
                        "Author" => "text",
                        "Approved" => "integer",
                        "LastWithdrawn" => "text"
                    );
            }
        }
        return [];
    }

◆ getXmlNamespace()

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

protected

Reimplemented from ilDataSet.

Definition at line 50 of file class.ilBlogDataSet.php.

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

◆ getXmlRecord()

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

Get xml record for version.

Parameters

array $a_set abstract data record

Reimplemented from ilDataSet.

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

     : array {
        if ($a_entity === "blog") {
            $style = $this->content_style_domain->styleForObjId((int) $a_set["Id"]);
 
            $dir = ilObjBlog::initStorage($a_set["Id"]);
            $a_set["Dir"] = $dir;
 
            $a_set["Style"] = $style->getStyleId();
 
            // #14734
            $a_set["Notes"] = $this->notes->domain()->commentsActive((int) $a_set["Id"]);
        }
 
        return $a_set;
    }

References ilObjBlog\initStorage().

Here is the call graph for this function:

◆ importRecord()

ilBlogDataSet::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.

Reimplemented from ilDataSet.

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

     : void {
        $a_rec = $this->stripTags($a_rec);
        switch ($a_entity) {
            case "blog":
 
                // container copy
                if ($new_id = $a_mapping->getMapping("Services/Container", "objs", $a_rec["Id"])) {
                    $newObj = ilObjectFactory::getInstanceByObjId($new_id, false);
                } else {
                    $newObj = new ilObjBlog();
                    $newObj->create();
                }
 
                $newObj->setTitle($a_rec["Title"] ?? "");
                $newObj->setDescription($a_rec["Description"] ?? "");
                $newObj->setNotesStatus((bool) ($a_rec["Notes"] ?? false));
                $newObj->setBackgroundColor($a_rec["BgColor"] ?? "");
                $newObj->setFontColor($a_rec["FontColor"] ?? "");
                $newObj->setProfilePicture((bool) ($a_rec["Ppic"] ?? false));
                $newObj->setRSS((bool) ($a_rec["RssActive"] ?? false));
                $newObj->setApproval((bool) ($a_rec["Approval"] ?? false));
                $newObj->setImage($a_rec["Img"] ?? "");
 
                $newObj->setAbstractShorten((bool) ($a_rec["AbsShorten"] ?? false));
                $newObj->setAbstractShortenLength((int) ($a_rec["AbsShortenLen"] ?? 0));
                $newObj->setAbstractImage((int) ($a_rec["AbsImage"] ?? 0));
                $newObj->setAbstractImageWidth((int) ($a_rec["AbsImgWidth"] ?? 0));
                $newObj->setAbstractImageHeight((int) ($a_rec["AbsImgHeight"] ?? 0));
                $newObj->setNavMode((int) ($a_rec["NavMode"] ?? 0));
                if (($a_rec["NavListMonWithPost"] ?? 0) == 0) {
                    $newObj->setNavModeListMonthsWithPostings(3);
                } else {
                    $newObj->setNavModeListMonthsWithPostings((int) $a_rec["NavListMonWithPost"]);
                }
                //$newObj->setNavModeListPostings($a_rec["NavListPost"]);
                if (($nav_list_months = $a_rec["NavListMon"] ?? null) !== null) {
                    $nav_list_months = (int) $nav_list_months;
                }
                $newObj->setNavModeListMonths($nav_list_months);
                $newObj->setKeywords((bool) ($a_rec["Keywords"] ?? false));
                $newObj->setAuthors((bool) ($a_rec["Authors"] ?? false));
                $newObj->setOrder(
                    trim($a_rec["NavOrder"])
                        ? explode(";", $a_rec["NavOrder"])
                        : []
                );
                if (($ov_post = $a_rec["OvPost"] ?? null) !== null) {
                    $ov_post = (int) $ov_post;
                }
                $newObj->setOverviewPostings($ov_post);
 
                $newObj->update();
 
                // handle image(s)
                if ($a_rec["Img"] ?? false) {
                    $dir = str_replace("..", "", $a_rec["Dir"]);
                    if ($dir !== "" && $this->getImportDirectory() !== "") {
                        $source_dir = $this->getImportDirectory() . "/" . $dir;
                        $target_dir = ilObjBlog::initStorage($newObj->getId());
                        ilFileUtils::rCopy($source_dir, $target_dir);
                    }
                }
 
                if ($a_rec["Style"] ?? false) {
                    self::$style_map[$a_rec["Style"]][] = $newObj->getId();
                }
                $a_mapping->addMapping("Modules/Blog", "blog", $a_rec["Id"], $newObj->getId());
                break;
 
            case "blog_posting":
                $blog_id = (int) $a_mapping->getMapping("Modules/Blog", "blog", $a_rec["BlogId"]);
                if ($blog_id) {
                    $newObj = new ilBlogPosting();
                    $newObj->setBlogId($blog_id);
                    $newObj->setTitle($a_rec["Title"] ?? "");
                    $newObj->setCreated(new ilDateTime($a_rec["Created"] ?? null, IL_CAL_DATETIME));
                    $newObj->setApproved($a_rec["Approved"] ?? null);
                    $newObj->setWithdrawn(new ilDateTime($a_rec["LastWithdrawn"] ?? null, IL_CAL_DATETIME));
 
                    // parse export id into local id (if possible)
                    $author = $this->parseObjectExportId($a_rec["Author"] ?? "", -1);
                    $newObj->setAuthor((int) $author["id"]);
 
                    $newObj->create(true);
 
                    // keywords
                    $keywords = array();
                    for ($loop = 0; $loop < 1000; $loop++) {
                        $idx = "Keyword" . $loop;
                        if (isset($a_rec[$idx])) {
                            $keyword = trim($a_rec[$idx]);
                            if ($keyword !== '') {
                                $keywords[] = $keyword;
                            }
                        }
                    }
                    if (count($keywords)) {
                        $newObj->updateKeywords($keywords);
                    }
 
                    $a_mapping->addMapping("Services/COPage", "pg", "blp:" . $a_rec["Id"], "blp:" . $newObj->getId());
                }
                break;
        }
    }

References ilImportMapping\addMapping(), ilObjectFactory\getInstanceByObjId(), ilImportMapping\getMapping(), IL_CAL_DATETIME, ilObjBlog\initStorage(), ILIAS\Repository\int(), and ilFileUtils\rCopy().

Here is the call graph for this function:

◆ readData()

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

Read data from DB.

This should result in the abstract field structure of the version set in the constructor.

Reimplemented from ilDataSet.

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

     : void {
        $ilDB = $this->db;
 
        if ($a_entity === "blog") {
            switch ($a_version) {
                case "4.3.0":
                    $this->getDirectDataFromQuery(
                        "SELECT bl.id,od.title,od.description," .
                        "bl.notes,bl.bg_color,bl.font_color,bl.img,bl.ppic,bl.rss_active,bl.approval" .
                        " FROM il_blog bl" .
                        " JOIN object_data od ON (od.obj_id = bl.id)" .
                        " WHERE " . $ilDB->in("bl.id", $a_ids, false, "integer") .
                        " AND od.type = " . $ilDB->quote("blog", "text")
                    );
                    break;
 
                case "5.0.0":
                    $this->getDirectDataFromQuery(
                        "SELECT bl.id,od.title,od.description," .
                        "bl.bg_color,bl.font_color,bl.img,bl.ppic,bl.rss_active,bl.approval," .
                        "bl.abs_shorten,bl.abs_shorten_len,bl.abs_image,bl.abs_img_width,bl.abs_img_height," .
                        "bl.nav_mode,bl.nav_list_post,bl.nav_list_mon,bl.keywords,bl.authors,bl.nav_order," .
                        "bl.ov_post" .
                        " FROM il_blog bl" .
                        " JOIN object_data od ON (od.obj_id = bl.id)" .
                        " WHERE " . $ilDB->in("bl.id", $a_ids, false, "integer") .
                        " AND od.type = " . $ilDB->quote("blog", "text")
                    );
                    break;
 
                case "5.3.0":
                    $this->getDirectDataFromQuery(
                        "SELECT bl.id,od.title,od.description," .
                        "bl.bg_color,bl.font_color,bl.img,bl.ppic,bl.rss_active,bl.approval," .
                        "bl.abs_shorten,bl.abs_shorten_len,bl.abs_image,bl.abs_img_width,bl.abs_img_height," .
                        "bl.nav_mode,bl.nav_list_mon_with_post,bl.nav_list_mon,bl.keywords,bl.authors,bl.nav_order," .
                        "bl.ov_post" .
                        " FROM il_blog bl" .
                        " JOIN object_data od ON (od.obj_id = bl.id)" .
                        " WHERE " . $ilDB->in("bl.id", $a_ids, false, "integer") .
                        " AND od.type = " . $ilDB->quote("blog", "text")
                    );
                    break;
            }
        }
 
        if ($a_entity === "blog_posting") {
            switch ($a_version) {
                case "4.3.0":
                case "5.0.0":
                case "5.3.0":
                    $this->getDirectDataFromQuery(
                        "SELECT id,blog_id,title,created,author,approved,last_withdrawn" .
                        " FROM il_blog_posting WHERE " .
                        $ilDB->in("blog_id", $a_ids, false, "integer")
                    );
                    foreach ($this->data as $idx => $item) {
                        // create full export id
                        $this->data[$idx]["Author"] = $this->createObjectExportId("usr", $item["Author"]);
                    }
                    break;
            }
 
            // keywords
            foreach ($this->data as $idx => $item) {
                $blog_id = ilBlogPosting::lookupBlogId($item["Id"]);
                $keywords = ilBlogPosting::getKeywords($blog_id, $item["Id"]);
                if ($keywords) {
                    foreach ($keywords as $kidx => $keyword) {
                        $this->data[$idx]["Keyword" . $kidx] = $keyword;
                    }
                }
            }
        }
    }

References $ilDB.

Field Documentation

◆ $content_style_domain

ILIAS Style Content DomainService ilBlogDataSet::$content_style_domain

protected

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

◆ $current_blog

ilObjBlog ilBlogDataSet::$current_blog

protected

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

◆ $notes

Service ilBlogDataSet::$notes

protected

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

◆ $style_map

array ilBlogDataSet::$style_map = array()

static

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

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

Modules/Blog/Export/class.ilBlogDataSet.php

Public Member Functions

Static Public Attributes

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

◆ $content_style_domain

◆ $current_blog

◆ $notes

◆ $style_map