ilBlogDataSet Class Reference

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...
	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 ...> ... </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...
	getCollection (array $record, string $entity, string $schema_version, string $field, string $value)
	getContainerExportConfig (array $record, string $entity, string $schema_version, string $field, string $value)

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)
	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
InternalService	$service
SettingsManager	$blog_settings
ReadingTimeManager	$reading_time
Service	$notes
ilObjBlog	$current_blog
ILIAS Style Content DomainService	$content_style_domain
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

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 33 of file class.ilBlogDataSet.php.

Constructor & Destructor Documentation

__construct()

ilBlogDataSet::__construct

(

)

Reimplemented from ilDataSet.

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

    {
        global $DIC;
        parent::__construct();
 
        $this->service = $DIC->blog()->internal();
 
        $this->content_style_domain = $DIC
            ->contentStyle()
            ->domain();
        $this->notes = $DIC->notes();
        $this->reading_time = $this->service->domain()->readingTime();
        $this->blog_settings = $this->service->domain()->blogSettings();
    }

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 301 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 58 of file class.ilBlogDataSet.php.

                                          : array
    {
        return array("4.3.0", "5.0.0", "5.3.0", "8.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 75 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"
                    );
 
                case "8.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",
                        "ReadingTime" => "integer"
                    );
            }
        }
 
        if ($a_entity === "blog_posting") {
            switch ($a_version) {
                case "4.3.0":
                case "5.0.0":
                case "5.3.0":
                case "8.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 63 of file class.ilBlogDataSet.php.

     : string {
 
        if ($a_entity === 'blog' || $a_entity == 'blog_posting') {
            // they share the same xsd, therfore the same namespace
            return "http://www.ilias.de/xml/Modules/Blog/blog";
        }
        return "http://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 315 of file class.ilBlogDataSet.php.

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

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 332 of file class.ilBlogDataSet.php.

     : void {
        $data = $this->service->data();
        $a_rec = $this->stripTags($a_rec);
        switch ($a_entity) {
            case "blog":
 
                // container copy
                if ($new_id = $a_mapping->getMapping("components/ILIAS/Container", "objs", $a_rec["Id"])) {
                    $newObj = ilObjectFactory::getInstanceByObjId((int) $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->update();
 
                $blog_settings = $data->settings(
                    $newObj->getId(),
                    (bool) ($a_rec["Ppic"] ?? false),
                    $a_rec["BgColor"] ?? "",
                    $a_rec["FontColor"] ?? "",
                    (bool) ($a_rec["RssActive"] ?? false),
                    (bool) ($a_rec["Approval"] ?? false),
                    (bool) ($a_rec["AbsShorten"] ?? false),
                    (int) ($a_rec["AbsShortenLen"] ?? 0),
                    (bool) ($a_rec["AbsImage"] ?? 0),
                    (int) ($a_rec["AbsImgWidth"] ?? 0),
                    (int) ($a_rec["AbsImgHeight"] ?? 0),
                    (bool) ($a_rec["Keywords"] ?? false),
                    (bool) ($a_rec["Authors"] ?? false),
                    (int) ($a_rec["NavMode"] ?? 0),
                    (($a_rec["NavListMonWithPost"] ?? 0) == 0)
                        ? 3
                        : (int) $a_rec["NavListMonWithPost"],
                    (int) ($a_rec["NavListMon"] ?? 3),
                    (int) ($a_rec["OvPost"] ?? null),
                    trim($a_rec["NavOrder"])
                        ? explode(";", $a_rec["NavOrder"])
                        : []
                );
                $this->blog_settings->update($blog_settings);
 
                if ($a_rec["Style"] ?? false) {
                    self::$style_map[$a_rec["Style"]][] = $newObj->getId();
                }
 
                // reading time
                $this->reading_time->activate($newObj->getId(), (bool) ($a_rec["ReadingTime"] ?? false));
 
                $a_mapping->addMapping("components/ILIAS/Blog", "blog", $a_rec["Id"], (string) $newObj->getId());
                $a_mapping->addMapping(
                    'components/ILIAS/MetaData',
                    'md',
                    $a_rec["Id"] . ':0:blog',
                    $newObj->getId() . ':0:blog'
                );
                break;
 
            case "blog_posting":
                $blog_id = (int) $a_mapping->getMapping("components/ILIAS/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((bool) ($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(
                        "components/ILIAS/COPage",
                        "pg",
                        "blp:" . $a_rec["Id"],
                        "blp:" . $newObj->getId()
                    );
                }
                break;
        }
    }

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 203 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;
 
                case "8.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")
                    );
                    foreach ($this->data as $idx => $item) {
                        $this->data[$idx]["ReadingTime"] = (int) $this->reading_time->isActivated((int) $item["Id"]);
                    }
                    break;
            }
        }
 
        if ($a_entity === "blog_posting") {
            switch ($a_version) {
                case "4.3.0":
                case "5.0.0":
                case "5.3.0":
                case "8.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", (string) $item["Author"]);
                    }
                    break;
            }
 
            // keywords
            foreach ($this->data as $idx => $item) {
                $blog_id = $this->service->domain()->posting()->lookupBlogId((int) $item["Id"]);
                $keywords = $this->service->domain()->posting()->getKeywords((int) $blog_id, (int) $item["Id"]);
                if ($keywords) {
                    foreach ($keywords as $kidx => $keyword) {
                        $this->data[$idx]["Keyword" . $kidx] = $keyword;
                    }
                }
            }
        }
    }

References $ilDB, and ILIAS\Repository\int().

Here is the call graph for this function:

Field Documentation

$blog_settings

SettingsManager ilBlogDataSet::$blog_settings

protected

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

$content_style_domain

ILIAS Style Content DomainService ilBlogDataSet::$content_style_domain

protected

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

$current_blog

ilObjBlog ilBlogDataSet::$current_blog

protected

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

$notes

Service ilBlogDataSet::$notes

protected

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

$reading_time

ReadingTimeManager ilBlogDataSet::$reading_time

protected

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

$service

InternalService ilBlogDataSet::$service

protected

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

$style_map

array ilBlogDataSet::$style_map = array()

static

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

---

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

• components/ILIAS/Blog/Export/class.ilBlogDataSet.php