ilCategoryXmlWriter Class Reference

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

Inheritance diagram for ilCategoryXmlWriter:

Collaboration diagram for ilCategoryXmlWriter:

Public Member Functions
	__construct (ilObjCategory $cat=null)
	setMode (int $a_mode)
	getMode ()
	getCategory ()
	export (bool $a_with_header=true)
	getXml ()
Public Member Functions inherited from ilXmlWriter
	__construct (string $version="1.0", string $outEnc="utf-8", string $inEnc="utf-8")
	xmlSetDtdDef (string $dtdDef)
	Sets dtd definition. More...
	xmlSetGenCmt (string $genCmt)
	Sets generated comment. More...
	xmlFormatData (string $data)
	Indents text for better reading. More...
	xmlHeader ()
	Writes xml header. More...
	xmlStartTag (string $tag, ?array $attrs=null, bool $empty=false, bool $encode=true, bool $escape=true)
	Writes a starttag. More...
	xmlEndTag (string $tag)
	Writes an endtag. More...
	xmlData (string $data, bool $encode=true, bool $escape=true)
	Writes data. More...
	xmlElement (string $tag, $attrs=null, $data=null, $encode=true, $escape=true)
	Writes a basic element (no children, just textual content) More...
	xmlDumpFile (string $file, bool $format=true)
	Dumps xml document from memory into a file. More...
	xmlDumpMem (bool $format=true)
	Returns xml document from memory. More...
	appendXML (string $a_str)
	append xml string to document More...
	xmlClear ()
	clears xmlStr More...

Data Fields
const	MODE_SOAP = 1
const	MODE_EXPORT = 2

Protected Member Functions
	buildHeader ()
	buildCategory ()
	buildFooter ()
	buildTranslations ()

Protected Attributes
ilSetting	$settings

Private Attributes
int	$mode = self::MODE_SOAP
ilObjCategory	$category

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 Class for category export

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

__construct()

ilCategoryXmlWriter::__construct

(

ilObjCategory

$cat = null

)

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

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

    {
        global $DIC;

        $this->settings = $DIC->settings();
        parent::__construct();

        $this->category = $cat;
    }

Here is the call graph for this function:

Member Function Documentation

buildCategory()

ilCategoryXmlWriter::buildCategory ( )

protected

Definition at line 92 of file class.ilCategoryXmlWriter.php.

References ilXmlWriter\xmlStartTag().

Referenced by export().

                                      : void
    {
        $this->xmlStartTag('Category');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildFooter()

ilCategoryXmlWriter::buildFooter ( )

protected

Definition at line 98 of file class.ilCategoryXmlWriter.php.

References ilXmlWriter\xmlEndTag().

Referenced by export().

                                    : void
    {
        $this->xmlEndTag('Category');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildHeader()

ilCategoryXmlWriter::buildHeader ( )

protected

Definition at line 80 of file class.ilCategoryXmlWriter.php.

References $ilSetting, $settings, getCategory(), ILIAS\Survey\Mode\getId(), ilXmlWriter\xmlHeader(), ilXmlWriter\xmlSetDtdDef(), and ilXmlWriter\xmlSetGenCmt().

Referenced by export().

                                    : bool
    {
        $ilSetting = $this->settings;

        $this->xmlSetDtdDef("<!DOCTYPE category PUBLIC \"-//ILIAS//DTD Group//EN\" \"" . ILIAS_HTTP_PATH . "/xml/ilias_cat_4_5.dtd\">");
        $this->xmlSetGenCmt("Export of ILIAS category " . $this->getCategory()->getId() . " of installation " . $ilSetting->get('inst_id') . ".");
        $this->xmlHeader();

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildTranslations()

ilCategoryXmlWriter::buildTranslations ( )

protected

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

References getCategory(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by export().

                                          : void
    {
        $this->xmlStartTag('Translations');

        $translations = $this->getCategory()->getObjectTranslation()->getLanguages();
        foreach ($translations as $translation) {
            $this->xmlStartTag(
                'Translation',
                [
                    'default' => (int) $translation->isDefault(),
                    'language' => $translation->getLanguageCode()
                ]
            );
            $this->xmlElement('Title', [], $translation->getTitle());
            $this->xmlElement('Description', [], $translation->getDescription());
            $this->xmlEndTag('Translation');
        }
        $this->xmlEndTag('Translations');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

export()

ilCategoryXmlWriter::export

(

bool

$a_with_header = true

)

Definition at line 60 of file class.ilCategoryXmlWriter.php.

References ilContainer\_exportContainerSettings(), ilContainerSortingSettings\_exportContainerSortingSettings(), buildCategory(), buildFooter(), buildHeader(), buildTranslations(), getCategory(), ILIAS\Survey\Mode\getId(), and getMode().

                                                      : void
    {
        if ($this->getMode() === self::MODE_EXPORT) {
            if ($a_with_header) {
                $this->buildHeader();
            }
            $this->buildCategory();
            $this->buildTranslations();
            ilContainerSortingSettings::_exportContainerSortingSettings($this, $this->getCategory()->getId());
            ilContainer::_exportContainerSettings($this, $this->category->getId());
            $this->buildFooter();
        }
    }

Here is the call graph for this function:

getCategory()

ilCategoryXmlWriter::getCategory

(

)

Definition at line 55 of file class.ilCategoryXmlWriter.php.

References $category.

Referenced by buildHeader(), buildTranslations(), and export().

                                 : ilObjCategory
    {
        return $this->category;
    }

Here is the caller graph for this function:

getMode()

ilCategoryXmlWriter::getMode

(

)

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

References $mode.

Referenced by export().

                             : int
    {
        return $this->mode;
    }

Here is the caller graph for this function:

getXml()

ilCategoryXmlWriter::getXml

(

)

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

References ilXmlWriter\xmlDumpMem().

                            : string
    {
        return $this->xmlDumpMem(false);
    }

Here is the call graph for this function:

setMode()

ilCategoryXmlWriter::setMode

(

int

$a_mode

)

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

                                        : void
    {
        $this->mode = $a_mode;
    }

Field Documentation

$category

ilObjCategory ilCategoryXmlWriter::$category

private

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

Referenced by getCategory().

$mode

int ilCategoryXmlWriter::$mode = self::MODE_SOAP

private

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

Referenced by getMode().

$settings

ilSetting ilCategoryXmlWriter::$settings

protected

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

Referenced by buildHeader().

MODE_EXPORT

const ilCategoryXmlWriter::MODE_EXPORT = 2

Definition at line 29 of file class.ilCategoryXmlWriter.php.

Referenced by ilCategoryExporter\getXmlRepresentation().

MODE_SOAP

const ilCategoryXmlWriter::MODE_SOAP = 1

Definition at line 28 of file class.ilCategoryXmlWriter.php.

---

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

• Modules/Category/Export/class.ilCategoryXmlWriter.php