ilPageLayout Class Reference

Class ilPageLayout. More...

Collaboration diagram for ilPageLayout:

Public Member Functions
	__construct ($a_id=null)
	getActive ()
	getDescription ()
	setDescription ($a_description)
	getTitle ()
	setTitle ($a_title)
	getId ()
	setStyleId ($a_val)
	Set style id. More...
	getStyleId ()
	Get style id. More...
	setSpecialPage ($a_val)
	Set special page. More...
	getSpecialPage ()
	Get special page. More...
	setModules (array $a_values=null)
	Set modules. More...
	getModules ()
	Get modules. More...
	activate ($a_setting=true)
	(De-)Activate layout More...
	delete ()
	Delete page layout. More...
	update ()
	Update page layout. More...
	readObject ()
	Read page layout. More...
	getXMLContent ()
	Get xml content. More...
	getPreview ()
	Get preview. More...

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

Data Fields
const	SEQ_TEMPLATE_DIR = './Modules/Scorm2004/templates/editor/page_layouts_temp/thumbnails'
const	MODULE_SCORM = 1
const	MODULE_PORTFOLIO = 2
const	MODULE_LM = 3
	$layout_id = null
	$title = null
	$description = null
	$active = null
	$modules = array()

Protected Attributes
	$db

Private Member Functions
	getXSLPath ()
	generatePreview ()

Detailed Description

Class ilPageLayout.

Class for Page Layouts

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilPageLayout::__construct

(

$a_id = null

)

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

References $DIC, and $ilDB.

    {
        global $DIC;

        $this->db = $DIC->database();
        $ilDB = $DIC->database();
        //create new instance
        if ($a_id == null) {
            $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;
        }
    }

Member Function Documentation

activate()

ilPageLayout::activate

(

$a_setting = true

)

(De-)Activate layout

Parameters

boolean

$a_setting

true/false

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

References $db, $ilDB, $query, and $result.

    {
        $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 (   $a_special_page = false,   $a_module = null  )

static

Get active layouts.

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

Referenced by ilChapterHierarchyFormGUI\__construct(), ilSCORM2004OrganizationHFormGUI\getMenuItems(), ilObjPortfolioGUI\initCreateForm(), ilObjPortfolioBaseGUI\initPageForm(), ilObjSCORM2004LearningModuleGUI\insertTemplateGUI(), and ilPageLayoutGUI\setTabs().

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

Here is the caller graph for this function:

delete()

ilPageLayout::delete

(

)

Delete page layout.

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

References $db, $ilDB, $query, and $result.

    {
        $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 256 of file class.ilPageLayout.php.

References $res, $xml, DOMXML_LOAD_PARSING, domxml_open_mem(), getXMLContent(), getXSLPath(), xpath_eval(), xpath_new_context(), xslt_create(), xslt_error(), and xslt_free().

Referenced by getPreview().

    {
        $xml = $this->getXMLContent();
        
        $dom = @domxml_open_mem($xml, DOMXML_LOAD_PARSING, $error);
        $xpc = xpath_new_context($dom);
        $path = "////PlaceHolder";
        $res = xpath_eval($xpc, $path);
        
        foreach ($res->nodeset as $item) {
            $height = $item->get_attribute("Height");
                
            $height = str_ireplace("px", "", $height);
            $height = $height / 10;
            $item->set_attribute("Height", $height . "px");
        }
        $xsl = file_get_contents($this->getXSLPath());
        
        $xml = $dom->dump_mem(0, "UTF-8");
            
        $args = array( '/_xml' => $xml, '/_xsl' => $xsl );
        
        $xh = xslt_create();
        $output = xslt_process($xh, "arg:/_xml", "arg:/_xsl", null, $args, null);
        xslt_error($xh);
        xslt_free($xh);
        return $output;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getActive()

ilPageLayout::getActive

(

)

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

References $active.

    {
        return $this->active;
    }

getAvailableModules()

static ilPageLayout::getAvailableModules ( )

static

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

References $DIC, and $lng.

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

    {
        global $DIC;

        $lng = $DIC->language();
        
        return array(
            self::MODULE_SCORM => $lng->txt("style_page_layout_module_scorm"),
            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 67 of file class.ilPageLayout.php.

References $description.

    {
        return $this->description;
    }

getId()

ilPageLayout::getId

(

)

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

References $layout_id.

    {
        return $this->layout_id;
    }

getLayouts()

static ilPageLayout::getLayouts (   $a_active = false,   $a_special_page = false,   $a_module = null  )

static

Get layouts.

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

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

Referenced by ilPageLayoutAdministrationGUI\initAddPageLayoutForm().

    {
        global $DIC;

        $ilDB = $DIC->database();
        $arr_layouts = array();
        $add = "WHERE special_page = " . $ilDB->quote($a_special_page, "integer");
        if ($a_active) {
            $add .= " AND (active = 1)";
        }
        switch ($a_module) {
            case self::MODULE_SCORM:
                $add .= " AND mod_scorm = 1";
                break;
            
            case self::MODULE_PORTFOLIO:
                $add .= " AND mod_portfolio = 1";
                break;

            case self::MODULE_LM:
                $add .= " AND 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)) {
            array_push($arr_layouts, new ilPageLayout($row['layout_id']));
        }

        return $arr_layouts;
    }

Here is the caller graph for this function:

getLayoutsAsArray()

static ilPageLayout::getLayoutsAsArray (   $a_active = 0 )

static

Static access functions.

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

References $active, $DIC, $ilDB, $query, $result, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by ilPageLayoutTableGUI\getPageLayouts().

    {
        global $DIC;

        $ilDB = $DIC->database();
        $arr_layouts = array();
        if ($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)) {
            array_push($arr_layouts, $row);
        }
        return $arr_layouts;
    }

Here is the caller graph for this function:

getModules()

ilPageLayout::getModules

(

)

Get modules.

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

References $modules.

    {
        return $this->modules;
    }

getPreview()

ilPageLayout::getPreview

(

)

Get preview.

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

References generatePreview().

    {
        return $this->generatePreview();
    }

Here is the call graph for this function:

getSpecialPage()

ilPageLayout::getSpecialPage

(

)

Get special page.

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

Referenced by update().

    {
        return $this->special_page;
    }

Here is the caller graph for this function:

getStyleId()

ilPageLayout::getStyleId

(

)

Get style id.

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

Referenced by update().

    {
        return $this->style_id;
    }

Here is the caller graph for this function:

getTitle()

ilPageLayout::getTitle

(

)

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

References $title.

    {
        return $this->title;
    }

getXMLContent()

ilPageLayout::getXMLContent

(

)

Get xml content.

Returns

string content xml

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

Referenced by generatePreview().

    {
        include_once "Services/COPage/Layout/classes/class.ilPageLayoutPage.php";
        $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 251 of file class.ilPageLayout.php.

Referenced by generatePreview().

    {
        return "./Services/COPage/Layout/xml/layout2html.xsl";
    }

Here is the caller graph for this function:

import()

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

static

Import page layout.

Parameters

string	$a_filename	file name
string	$a_fiepath	complete path (incl. name) to file

Returns

object new object

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

Referenced by ilPageLayoutAdministrationGUI\importPageLayout().

    {
        include_once("./Services/Export/classes/class.ilImport.php");
        $imp = new ilImport();
        $imp->importEntity(
            $a_filepath,
            $a_filename,
            "pgtp",
            "Services/COPage"
        );
    }

Here is the caller graph for this function:

readObject()

ilPageLayout::readObject

(

)

Read page layout.

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

References $db, $ilDB, $query, $result, setModules(), setSpecialPage(), and setStyleId().

    {
        $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 = $row['title'];
        $this->setStyleId($row['style_id']);
        $this->setSpecialPage($row['special_page']);
        $this->description = $row['description'];
        $this->active = $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

(

$a_description

)

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

    {
        $this->description = $a_description;
    }

setModules()

ilPageLayout::setModules

(

array

$a_values = null

)

Set modules.

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

References $valid, and getAvailableModules().

Referenced by readObject().

    {
        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:

setSpecialPage()

ilPageLayout::setSpecialPage

(

$a_val

)

Set special page.

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

Referenced by readObject().

    {
        $this->special_page = $a_val;
    }

Here is the caller graph for this function:

setStyleId()

ilPageLayout::setStyleId

(

$a_val

)

Set style id.

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

Referenced by readObject().

    {
        $this->style_id = $a_val;
    }

Here is the caller graph for this function:

setTitle()

ilPageLayout::setTitle

(

$a_title

)

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

    {
        $this->title = $a_title;
    }

update()

ilPageLayout::update

(

)

Update page layout.

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

References $db, $ilDB, $query, $result, getSpecialPage(), and getStyleId().

    {
        $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") .
            ",style_id =" . $ilDB->quote($this->getStyleId(), "integer") .
            ",special_page =" . $ilDB->quote((int) $this->getSpecialPage(), "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);
    }

Here is the call graph for this function:

Field Documentation

$active

ilPageLayout::$active = null

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

Referenced by getActive(), and getLayoutsAsArray().

$db

ilPageLayout::$db

protected

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

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

$description

ilPageLayout::$description = null

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

Referenced by getDescription().

$layout_id

ilPageLayout::$layout_id = null

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

Referenced by getId().

$modules

ilPageLayout::$modules = array()

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

Referenced by getModules().

$title

ilPageLayout::$title = null

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

Referenced by getTitle().

MODULE_LM

const ilPageLayout::MODULE_LM = 3

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

Referenced by ilChapterHierarchyFormGUI\__construct(), ilPageLayoutTableGUI\fillRow(), ilStructureObjectGUI\initInsertTemplateForm(), and ilLMPageObjectGUI\initNewPageForm().

MODULE_PORTFOLIO

const ilPageLayout::MODULE_PORTFOLIO = 2

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

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

MODULE_SCORM

const ilPageLayout::MODULE_SCORM = 1

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

Referenced by ilPageLayoutTableGUI\fillRow(), and ilObjSCORM2004LearningModuleGUI\insertTemplateGUI().

SEQ_TEMPLATE_DIR

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

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

---

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

• Services/COPage/Layout/classes/class.ilPageLayout.php