ilPageLayout Class Reference

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

Collaboration diagram for ilPageLayout:

Public Member Functions
	__construct (int $a_id=0)
	getActive ()
	getDescription ()
	setDescription (string $a_description)
	getTitle ()
	setTitle (string $a_title)
	getId ()
	setModules (array $a_values=[])
	getModules ()
	activate (bool $a_setting=true)
	(De-)Activate layout More...
	delete ()
	Delete page layout. More...
	update ()
	Update page layout. More...
	readObject ()
	setXMLContent (string $content)
	getXMLContent ()
	copyXmlContent (bool $self_ass=true)
	getPreview ()

Static Public Member Functions
static	getLayoutsAsArray (int $a_active=0)
static	getLayouts (bool $a_active=false, int $a_module=0)
static	activeLayouts (int $a_module=0)
	Get active layouts. More...
static	import (string $a_filename, string $a_filepath)
	Import page layout. More...
static	getAvailableModules ()

Data Fields
const	SEQ_TEMPLATE_DIR = './components/ILIAS/Scorm2004/templates/editor/page_layouts_temp/thumbnails'
const	MODULE_SCORM = 1
const	MODULE_PORTFOLIO = 2
const	MODULE_LM = 3
int	$layout_id = 0
string	$title = ""
string	$description = ""
bool	$active = false
array	$modules = array()

Protected Member Functions
	xslt (string $xml, array $params)

Protected Attributes
string	$xml_content = null
ILIAS COPage Dom DomUtil	$dom_util
int	$special_page
int	$style_id
ilDBInterface	$db

Private Member Functions
	getXSLPath ()
	generatePreview ()

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 Page Layouts

Author

Hendrik Holtmann holtm.nosp@m.ann@.nosp@m.me.co.nosp@m.m

Definition at line 24 of file class.ilPageLayout.php.

Constructor & Destructor Documentation

__construct()

ilPageLayout::__construct

(

int

$a_id = 0

)

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

References $DIC, and $ilDB.

      {
        global $DIC;

        $this->db = $DIC->database();
        $ilDB = $DIC->database();

        //create new instance
        if ($a_id == 0) {
            $this->layout_id = $ilDB->nextId("page_layout");
            $ilDB->insert("page_layout", array(
                "layout_id" => array("integer", $this->layout_id),
                "active" => array("integer", 0),
                "title" => array("text", ""),
                "content" => array("clob", ""),
                "description" => array("text", "")
                ));
            //$query = "INSERT INTO page_layout(active) values (0);";
            //$result = $ilDB->query($query);
            //$query = "SELECT LAST_INSERT_ID() as id";
            //$res = $ilDB->query($query);
            //$row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
            //$this->layout_id = $row->id;
            $this->active = false;
        } else {
            $this->layout_id = $a_id;
        }
        $this->dom_util = $DIC->copage()->internal()->domain()->domUtil();
    }

Member Function Documentation

activate()

ilPageLayout::activate

(

bool

$a_setting = true

)

(De-)Activate layout

Definition at line 134 of file class.ilPageLayout.php.

References $db, and $ilDB.

     : void {
        $ilDB = $this->db;

        $query = "UPDATE page_layout SET active=" . $ilDB->quote($a_setting, "integer") .
            " WHERE layout_id =" . $ilDB->quote($this->layout_id, "integer");
        $result = $ilDB->manipulate($query);
    }

activeLayouts()

static ilPageLayout::activeLayouts ( int  $a_module = 0 )

static

Get active layouts.

Definition at line 340 of file class.ilPageLayout.php.

Referenced by ILIAS\LearningModule\Editing\GUIService\__construct(), ILIAS\LearningModule\Editing\EditSubObjectsGUI\__construct(), ilPCLayoutTemplateGUI\initCreationForm(), ilObjPortfolioBaseGUI\initPageForm(), ilPageConfig\loadParentKey(), and ilPageLayoutGUI\setTabs().

     : array {
        return self::getLayouts(true, $a_module);
    }

Here is the caller graph for this function:

copyXmlContent()

ilPageLayout::copyXmlContent

(

bool

$self_ass = true

)

Definition at line 221 of file class.ilPageLayout.php.

                                                         : string
    {
        $layout_page = new ilPageLayoutPage($this->layout_id);
        return $layout_page->copyXmlContent(true, 0, 0, $self_ass);
    }

delete()

ilPageLayout::delete

(

)

Delete page layout.

Definition at line 147 of file class.ilPageLayout.php.

References $db, and $ilDB.

                            : void
    {
        $ilDB = $this->db;

        $query = "DELETE FROM page_layout WHERE layout_id =" . $ilDB->quote($this->layout_id, "integer");
        $result = $ilDB->manipulate($query);
    }

generatePreview()

ilPageLayout::generatePreview ( )

private

Definition at line 240 of file class.ilPageLayout.php.

References $path, getXMLContent(), and xslt().

Referenced by getPreview().

                                      : string
    {
        $error = null;
        $dom = $this->dom_util->docFromString($this->getXMLContent(), $error);
        $path = "////PlaceHolder";
        $nodes = $this->dom_util->path($dom, $path);
        foreach ($nodes as $node) {
            $height = $node->getAttribute("Height");

            $height = str_ireplace("px", "", $height);
            $height = $height / 10;
            $node->setAttribute("Height", $height . "px");
        }

        $xml = $this->dom_util->dump($dom->documentElement);
        $output = $this->xslt($xml, []);
        return $output;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getActive()

ilPageLayout::getActive

(

)

Definition at line 73 of file class.ilPageLayout.php.

References $active.

                               : bool
    {
        return $this->active;
    }

getAvailableModules()

static ilPageLayout::getAvailableModules ( )

static

Definition at line 362 of file class.ilPageLayout.php.

References $DIC, and $lng.

Referenced by ilPageLayoutTableGUI\getPageLayouts(), ilPageLayoutAdministrationGUI\initAddPageLayoutForm(), ilPageLayoutGUI\initForm(), and setModules().

                                                : array
    {
        global $DIC;

        $lng = $DIC->language();

        return array(
            self::MODULE_PORTFOLIO => $lng->txt("style_page_layout_module_portfolio"),
            self::MODULE_LM => $lng->txt("style_page_layout_module_learning_module")
        );
    }

Here is the caller graph for this function:

getDescription()

ilPageLayout::getDescription

(

)

Definition at line 78 of file class.ilPageLayout.php.

References $description.

                                    : string
    {
        return $this->description;
    }

getId()

ilPageLayout::getId

(

)

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

References $layout_id.

                           : int
    {
        return $this->layout_id;
    }

getLayouts()

static ilPageLayout::getLayouts ( bool  $a_active = false, int  $a_module = 0  )

static

Definition at line 301 of file class.ilPageLayout.php.

References $DIC, $ilDB, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by ilPageLayoutAdministrationGUI\initAddPageLayoutForm().

     : array {
        global $DIC;

        $ilDB = $DIC->database();
        $arr_layouts = array();
        $add = "";
        $conc = " WHERE ";
        if ($a_active) {
            $add .= $conc . " (active = 1)";
            $conc = " AND ";
        }
        switch ($a_module) {
            case self::MODULE_SCORM:
                $add .= $conc . " mod_scorm = 1";
                break;

            case self::MODULE_PORTFOLIO:
                $add .= $conc . " mod_portfolio = 1";
                break;

            case self::MODULE_LM:
                $add .= $conc . " mod_lm = 1";
                break;
        }
        $query = "SELECT layout_id FROM page_layout $add ORDER BY title ";
        $result = $ilDB->query($query);
        while ($row = $result->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            $arr_layouts[] = new ilPageLayout($row['layout_id']);
        }

        return $arr_layouts;
    }

Here is the caller graph for this function:

getLayoutsAsArray()

static ilPageLayout::getLayoutsAsArray ( int  $a_active = 0 )

static

Definition at line 280 of file class.ilPageLayout.php.

References $DIC, $ilDB, ilPageObject\_exists(), and ilDBConstants\FETCHMODE_ASSOC.

Referenced by ilPageLayoutTableGUI\getPageLayouts().

     : array {
        global $DIC;

        $ilDB = $DIC->database();
        $arr_layouts = array();
        $add = "";
        if ($a_active != 0) {
            $add = "WHERE (active=1)";
        }
        $query = "SELECT * FROM page_layout $add ORDER BY title ";
        $result = $ilDB->query($query);
        while ($row = $result->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            if (ilPageObject::_exists("stys", $row["layout_id"])) {
                $arr_layouts[] = $row;
            }
        }
        return $arr_layouts;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getModules()

ilPageLayout::getModules

(

)

Definition at line 126 of file class.ilPageLayout.php.

References $modules.

                                : array
    {
        return $this->modules;
    }

getPreview()

ilPageLayout::getPreview

(

)

Definition at line 227 of file class.ilPageLayout.php.

References generatePreview().

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

Here is the call graph for this function:

getTitle()

ilPageLayout::getTitle

(

)

Definition at line 88 of file class.ilPageLayout.php.

References $title.

                              : string
    {
        return $this->title;
    }

getXMLContent()

ilPageLayout::getXMLContent

(

)

Definition at line 212 of file class.ilPageLayout.php.

References $xml_content.

Referenced by generatePreview().

                                   : string
    {
        if (!is_null($this->xml_content)) {
            return $this->xml_content;
        }
        $layout_page = new ilPageLayoutPage($this->layout_id);
        return $layout_page->getXMLContent();
    }

Here is the caller graph for this function:

getXSLPath()

ilPageLayout::getXSLPath ( )

private

Definition at line 232 of file class.ilPageLayout.php.

Referenced by xslt().

                                 : string
    {
        if (is_file("./components/ILIAS/COPage/Layout/xml/layout2html.xsl")) {
            return "./components/ILIAS/COPage/Layout/xml/layout2html.xsl";
        }
        return "../components/ILIAS/COPage/Layout/xml/layout2html.xsl";
    }

Here is the caller graph for this function:

import()

static ilPageLayout::import ( string  $a_filename, string  $a_filepath  )

static

Import page layout.

Definition at line 349 of file class.ilPageLayout.php.

Referenced by ilPageLayoutAdministrationGUI\importPageLayout().

     : void {
        $imp = new ilImport();
        $imp->importEntity(
            $a_filepath,
            $a_filename,
            "pgtp",
            "components/ILIAS/COPage"
        );
    }

Here is the caller graph for this function:

readObject()

ilPageLayout::readObject

(

)

Definition at line 184 of file class.ilPageLayout.php.

References $db, $ilDB, and setModules().

                                : void
    {
        $ilDB = $this->db;
        $query = "SELECT * FROM page_layout WHERE layout_id =" . $ilDB->quote($this->layout_id, "integer");
        $result = $ilDB->query($query);
        $row = $ilDB->fetchAssoc($result);
        $this->title = (string) $row['title'];
        $this->description = (string) $row['description'];
        $this->active = (bool) $row['active'];

        $mods = array();
        if ($row["mod_scorm"]) {
            $mods[] = self::MODULE_SCORM;
        }
        if ($row["mod_portfolio"]) {
            $mods[] = self::MODULE_PORTFOLIO;
        }
        if ($row["mod_lm"]) {
            $mods[] = self::MODULE_LM;
        }
        $this->setModules($mods);
    }

Here is the call graph for this function:

setDescription()

ilPageLayout::setDescription

(

string

$a_description

)

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

                                                         : void
    {
        $this->description = $a_description;
    }

setModules()

ilPageLayout::setModules

(

array

$a_values = []

)

Definition at line 116 of file class.ilPageLayout.php.

References $valid, and getAvailableModules().

Referenced by readObject().

                                                    : void
    {
        if ($a_values) {
            $valid = array_keys($this->getAvailableModules());
            $this->modules = array_intersect($a_values, $valid);
        } else {
            $this->modules = array();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setTitle()

ilPageLayout::setTitle

(

string

$a_title

)

Definition at line 93 of file class.ilPageLayout.php.

                                             : void
    {
        $this->title = $a_title;
    }

setXMLContent()

ilPageLayout::setXMLContent

(

string

$content

)

Definition at line 207 of file class.ilPageLayout.php.

                                                  : void
    {
        $this->xml_content = $content;
    }

update()

ilPageLayout::update

(

)

Update page layout.

Definition at line 158 of file class.ilPageLayout.php.

References $db, and $ilDB.

                            : void
    {
        $ilDB = $this->db;

        $mod_scorm = $mod_portfolio = $mod_lm = 0;
        if (in_array(self::MODULE_SCORM, $this->modules)) {
            $mod_scorm = 1;
        }
        if (in_array(self::MODULE_PORTFOLIO, $this->modules)) {
            $mod_portfolio = 1;
        }
        if (in_array(self::MODULE_LM, $this->modules)) {
            $mod_lm = 1;
        }

        $query = "UPDATE page_layout SET title=" . $ilDB->quote($this->title, "text") .
            ",description =" . $ilDB->quote($this->description, "text") .
            ",active =" . $ilDB->quote($this->active, "integer") .
            ",mod_scorm =" . $ilDB->quote($mod_scorm, "integer") .
            ",mod_portfolio =" . $ilDB->quote($mod_portfolio, "integer") .
            ",mod_lm =" . $ilDB->quote($mod_lm, "integer") .
            " WHERE layout_id =" . $ilDB->quote($this->layout_id, "integer");

        $result = $ilDB->manipulate($query);
    }

xslt()

ilPageLayout::xslt ( string  $xml, array  $params  )

protected

Definition at line 259 of file class.ilPageLayout.php.

References getXSLPath().

Referenced by generatePreview().

     : string {
        $xslt = new \XSLTProcessor();
        $xsl = file_get_contents($this->getXSLPath());
        $xslt_domdoc = new \DomDocument();
        $xslt_domdoc->loadXML($xsl);
        $xslt->importStylesheet($xslt_domdoc);
        foreach ($params as $key => $value) {
            $xslt->setParameter("", $key, (string) $value);
        }
        $xml_domdoc = new \DomDocument();
        $xml_domdoc->loadXML($xml);
        // show warnings again due to discussion in #12866
        $result = $xslt->transformToXml($xml_domdoc);
        unset($xslt);
        return $result;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$active

bool ilPageLayout::$active = false

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

Referenced by getActive().

$db

ilDBInterface ilPageLayout::$db

protected

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

Referenced by activate(), delete(), readObject(), and update().

$description

string ilPageLayout::$description = ""

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

Referenced by getDescription().

$dom_util

ILIAS COPage Dom DomUtil ilPageLayout::$dom_util

protected

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

$layout_id

int ilPageLayout::$layout_id = 0

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

Referenced by getId().

$modules

array ilPageLayout::$modules = array()

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

Referenced by getModules().

$special_page

int ilPageLayout::$special_page

protected

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

$style_id

int ilPageLayout::$style_id

protected

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

$title

string ilPageLayout::$title = ""

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

Referenced by getTitle().

$xml_content

string ilPageLayout::$xml_content = null

protected

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

Referenced by getXMLContent().

MODULE_LM

const ilPageLayout::MODULE_LM = 3

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

Referenced by ILIAS\LearningModule\Editing\GUIService\__construct(), ILIAS\LearningModule\Editing\EditSubObjectsGUI\__construct(), ilPageLayoutTableGUI\fillRow(), ilLMPageConfig\init(), ILIAS\LearningModule\Editing\EditSubObjectsGUI\initInsertTemplateForm(), and ilLMPageObjectGUI\initNewPageForm().

MODULE_PORTFOLIO

const ilPageLayout::MODULE_PORTFOLIO = 2

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

Referenced by ilPageLayoutTableGUI\fillRow(), and ilObjPortfolioBaseGUI\initPageForm().

MODULE_SCORM

const ilPageLayout::MODULE_SCORM = 1

Definition at line 27 of file class.ilPageLayout.php.

Referenced by ilPageLayoutTableGUI\fillRow().

SEQ_TEMPLATE_DIR

const ilPageLayout::SEQ_TEMPLATE_DIR = './components/ILIAS/Scorm2004/templates/editor/page_layouts_temp/thumbnails'

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

---

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

• components/ILIAS/COPage/Layout/classes/class.ilPageLayout.php