ilCOPageHTMLExport Class Reference

HTML export class for pages. More...

Collaboration diagram for ilCOPageHTMLExport:

Public Member Functions
	__construct ($a_exp_dir)
	Initialisation. More...
	setContentStyleId ($a_val)
	Set content style id. More...
	getContentStyleId ()
	Get content style id. More...
	createDirectories ()
	Create directories. More...
	exportStyles ()
	Export content style. More...
	exportSupportScripts ()
	Export support scripts. More...
	getPreparedMainTemplate ($a_tpl="")
	Get prepared main template. More...
	collectPageElements ($a_type, $a_id)
	Collect page elements (that need to be exported separately) More...
	exportPageElements ()
	Export page elements. More...
	exportHTMLMOB ($a_mob_id, &$a_linked_mobs)
	Export media object to html. More...
	exportHTMLFile ($a_file_id)
	Export file object. More...
	exportHTMLFileDirect ($a_file_id, $a_source_file, $a_file_name)
	Export file from path. More...

Private Attributes
	$mobs = array()
	$files = array()
	$files_direct = array()
	$exp_dir = ""
	$content_style_id = 0

Detailed Description

HTML export class for pages.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

Id

Definition at line 11 of file class.ilCOPageHTMLExport.php.

Constructor & Destructor Documentation

__construct()

ilCOPageHTMLExport::__construct

(

$a_exp_dir

)

Initialisation.

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

        {
                $this->exp_dir = $a_exp_dir;
                $this->mobs_dir = $a_exp_dir."/mobs";
                $this->files_dir = $a_exp_dir."/files";
                $this->tex_dir = $a_exp_dir."/teximg";
                $this->content_style_dir = $a_exp_dir."/content_style";
                $this->content_style_img_dir = $a_exp_dir."/content_style/images";
                
                include_once("./Services/MediaObjects/classes/class.ilPlayerUtil.php");
                $this->services_dir = $a_exp_dir."/Services";
                $this->media_service_dir = $this->services_dir."/MediaObjects";
                $this->flv_dir = $a_exp_dir."/".ilPlayerUtil::getFlashVideoPlayerDirectory();
                $this->mp3_dir = $this->media_service_dir."/flash_mp3_player";
 
                $this->js_dir = $a_exp_dir.'/js';
                $this->js_yahoo_dir = $a_exp_dir.'/js/yahoo';
                $this->css_dir = $a_exp_dir.'/css';
 
                $GLOBALS["teximgcnt"] = 0;
        }

References $GLOBALS, and ilPlayerUtil\getFlashVideoPlayerDirectory().

Here is the call graph for this function:

Member Function Documentation

collectPageElements()

ilCOPageHTMLExport::collectPageElements	(		$a_type,
			$a_id
	)

Collect page elements (that need to be exported separately)

Parameters

string	$a_pg_type	page type
int	$a_pg_id	page id

Definition at line 256 of file class.ilCOPageHTMLExport.php.

        {
                // collect media objects
                $pg_mobs = ilObjMediaObject::_getMobsOfObject($a_type, $a_id);
                foreach($pg_mobs as $pg_mob)
                {
                        $this->mobs[$pg_mob] = $pg_mob;
                }
                
                // collect all files
                include_once("./Modules/File/classes/class.ilObjFile.php");
                $files = ilObjFile::_getFilesOfObject($a_type, $a_id);
                foreach($files as $f)
                {
                        $this->files[$f] = $f;
                }
 
                
                $skill_tree = $ws_tree = null;          
                
                $pcs = ilPageContentUsage::getUsagesOfPage($a_id, $a_type);
                foreach ($pcs as $pc)                   
                {               
                        // skils
                        if ($pc["type"] == "skmg")
                        {
                                $skill_id = $pc["id"];
                                
                                // trying to find user id
                                $user_id = null;
                                switch($a_type)
                                {
                                        case "prtf:pg":
                                                include_once "Modules/Portfolio/classes/class.ilPortfolioPage.php";
                                                $page = new ilPortfolioPage($a_id);
                                                $user_id = $page->create_user;
                                                break;
                                        
                                        default:
                                                // :TODO:
                                                break;
                                }
                                
                                if($user_id)
                                {
                                        // we only need 1 instance each
                                        if(!$skill_tree)
                                        {
                                                include_once "Services/Skill/classes/class.ilSkillTree.php";
                                                $skill_tree = new ilSkillTree();
 
                                                include_once "Services/Skill/classes/class.ilPersonalSkill.php";
 
                                                include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceTree.php";
                                                $ws_tree = new ilWorkspaceTree($user_id);
                                        }                               
 
                                        // walk skill tree
                                        include_once("./Services/Skill/classes/class.ilVirtualSkillTree.php");
                                        $vtree = new ilVirtualSkillTree();
                                        $tref_id = 0;
                                        $skill_id = (int) $skill_id;
                                        include_once("./Services/Skill/classes/class.ilSkillTreeNode.php");
                                        if (ilSkillTreeNode::_lookupType($skill_id) == "sktr")
                                        {
                                                include_once("./Services/Skill/classes/class.ilSkillTemplateReference.php");
                                                $tref_id = $skill_id;
                                                $skill_id = ilSkillTemplateReference::_lookupTemplateId($skill_id);
                                        }
                                        $b_skills = $vtree->getSubTreeForCSkillId($skill_id.":".$tref_id, true);
 
                                        foreach ($b_skills as $bs)
                                        {
                                                $skill = ilSkillTreeNodeFactory::getInstance($bs["skill_id"]);
                                                $level_data = $skill->getLevelData();                   
                                                foreach ($level_data as $k => $v)
                                                {
                                                        // get assigned materials from personal skill                           
                                                        $mat = ilPersonalSkill::getAssignedMaterial($user_id, $bs["tref_id"], $v["id"]);
                                                        if(sizeof($mat))
                                                        {                                                                                                               
                                                                foreach($mat as $item)
                                                                {
                                                                        $wsp_id = $item["wsp_id"];
                                                                        $obj_id = $ws_tree->lookupObjectId($wsp_id);
 
                                                                        // all possible material types for now
                                                                        switch(ilObject::_lookupType($obj_id))
                                                                        {
                                                                                case "file":
                                                                                        $this->files[$obj_id] = $obj_id;
                                                                                        break;
 
                                                                                case "tstv":
                                                                                        include_once "Modules/Test/classes/class.ilObjTestVerification.php";
                                                                                        $obj = new ilObjTestVerification($obj_id, false);
                                                                                        $this->files_direct[$obj_id] = array($obj->getFilePath(),
                                                                                                $obj->getOfflineFilename());                                                            
                                                                                        break;
 
                                                                                case "excv":                                                                            
                                                                                        include_once "Modules/Exercise/classes/class.ilObjExerciseVerification.php";
                                                                                        $obj = new ilObjExerciseVerification($obj_id, false);
                                                                                        $this->files_direct[$obj_id] = array($obj->getFilePath(),
                                                                                                $obj->getOfflineFilename());    
                                                                                        break;          
                                                                                
                                                                                case "crsv":                                                                            
                                                                                        include_once "Modules/Course/classes/Verification/class.ilObjCourseVerification.php";
                                                                                        $obj = new ilObjCourseVerification($obj_id, false);
                                                                                        $this->files_direct[$obj_id] = array($obj->getFilePath(),
                                                                                                $obj->getOfflineFilename());    
                                                                                        break;  
                                                                                
                                                                                case "scov":                                                                            
                                                                                        include_once "Modules/ScormAicc/classes/Verification/class.ilObjSCORMVerification.php";
                                                                                        $obj = new ilObjSCORMVerification($obj_id, false);
                                                                                        $this->files_direct[$obj_id] = array($obj->getFilePath(),
                                                                                                $obj->getOfflineFilename());    
                                                                                        break;
                                                                        }
                                                                }
                                                        }
                                                }
                                        }
                                }       
                        }
                }
 
        }

References $files, ilObjFile\_getFilesOfObject(), ilObjMediaObject\_getMobsOfObject(), ilSkillTemplateReference\_lookupTemplateId(), ilObject\_lookupType(), ilSkillTreeNode\_lookupType(), ilPersonalSkill\getAssignedMaterial(), ilSkillTreeNodeFactory\getInstance(), and ilPageContentUsage\getUsagesOfPage().

Here is the call graph for this function:

createDirectories()

ilCOPageHTMLExport::createDirectories

(

)

Create directories.

Parameters

return

Definition at line 70 of file class.ilCOPageHTMLExport.php.

        {
                ilUtil::makeDir($this->mobs_dir);
                ilUtil::makeDir($this->files_dir);
                ilUtil::makeDir($this->tex_dir);
                ilUtil::makeDir($this->content_style_dir);
                ilUtil::makeDir($this->content_style_img_dir);
                ilUtil::makeDir($this->services_dir);
                ilUtil::makeDir($this->media_service_dir);
                ilUtil::makeDir($this->flv_dir);
                ilUtil::makeDir($this->mp3_dir);
                
                ilUtil::makeDir($this->js_dir);
                ilUtil::makeDir($this->js_yahoo_dir);
                ilUtil::makeDir($this->css_dir);
        }

References ilUtil\makeDir().

Here is the call graph for this function:

exportHTMLFile()

ilCOPageHTMLExport::exportHTMLFile

(

$a_file_id

)

Export file object.

Definition at line 493 of file class.ilCOPageHTMLExport.php.

        {
                $file_dir = $this->files_dir."/file_".$a_file_id;
                ilUtil::makeDir($file_dir);
                
                include_once("./Modules/File/classes/class.ilObjFile.php");
                $file_obj = new ilObjFile($a_file_id, false);
                $source_file = $file_obj->getDirectory($file_obj->getVersion())."/".$file_obj->getFileName();
                if (!is_file($source_file))
                {
                        $source_file = $file_obj->getDirectory()."/".$file_obj->getFileName();
                }
                if (is_file($source_file))
                {
                        copy($source_file, $file_dir."/".$file_obj->getFileName());
                }
        }

References ilUtil\makeDir().

Referenced by exportPageElements().

Here is the call graph for this function:

Here is the caller graph for this function:

exportHTMLFileDirect()

ilCOPageHTMLExport::exportHTMLFileDirect	(		$a_file_id,
			$a_source_file,
			$a_file_name
	)

Export file from path.

Definition at line 514 of file class.ilCOPageHTMLExport.php.

        {
                $file_dir = $this->files_dir."/file_".$a_file_id;
                ilUtil::makeDir($file_dir);
                                                                
                if (is_file($a_source_file))
                {
                        copy($a_source_file, 
                                $file_dir."/".ilUtil::getASCIIFilename($a_file_name));
                }
        }

References ilUtil\getASCIIFilename(), and ilUtil\makeDir().

Referenced by exportPageElements().

Here is the call graph for this function:

Here is the caller graph for this function:

exportHTMLMOB()

ilCOPageHTMLExport::exportHTMLMOB	(		$a_mob_id,
		&	$a_linked_mobs
	)

Export media object to html.

Definition at line 429 of file class.ilCOPageHTMLExport.php.

        {
                global $tpl;
 
                $source_dir = ilUtil::getWebspaceDir()."/mobs/mm_".$a_mob_id;
                if (@is_dir($source_dir))
                {
                        ilUtil::makeDir($this->mobs_dir."/mm_".$a_mob_id);
                        ilUtil::rCopy($source_dir, $this->mobs_dir."/mm_".$a_mob_id);
                }
 
                // #12930 - fullscreen
                include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
                $mob_obj = new ilObjMediaObject($a_mob_id);
                if ($mob_obj->hasFullscreenItem())
                {       
                        // render media object html
                        $xh = xslt_create();            
                        $output = xslt_process(
                                $xh, 
                                "arg:/_xml",
                                "arg:/_xsl", 
                                NULL, 
                                array(
                                        "/_xml" => 
                                                "<dummy>".
                                                        $mob_obj->getXML(IL_MODE_ALIAS).
                                                        $mob_obj->getXML(IL_MODE_OUTPUT).
                                                "</dummy>", 
                                        "/_xsl" => file_get_contents("./Services/COPage/xsl/page.xsl")
                                ), 
                                array("mode"=>"fullscreen"));
                        xslt_free($xh);
                        unset($xh);
                                                
                        // render fullscreen html
                        $tpl = new ilTemplate("tpl.fullscreen.html", true, true, "Services/COPage");                                            
                        $tpl = $this->getPreparedMainTemplate($tpl); // adds js/css             
                        $tpl->setCurrentBlock("ilMedia");                       
                        $tpl->setVariable("MEDIA_CONTENT", $output);
                        $output = $tpl->get();
                        unset($tpl);
                        
                        // write file
                        $file = $this->exp_dir."/fullscreen_".$a_mob_id.".html";
                        if(!($fp = @fopen($file,"w+")))
                        {
                                die("<b>Error</b>: Could not open \"".$file."\" for writing".
                                        " in <b>".__FILE__."</b> on line <b>".__LINE__."</b><br />");
                        }
                        chmod($file, 0770);                     
                        fwrite($fp, $output);
                        fclose($fp);    
                        unset($fp);
                        unset($output);
                }
                
                $linked_mobs = $mob_obj->getLinkedMediaObjects();
                $a_linked_mobs = array_merge($a_linked_mobs, $linked_mobs);
        }

References $file, $tpl, getPreparedMainTemplate(), ilUtil\getWebspaceDir(), IL_MODE_ALIAS, IL_MODE_OUTPUT, ilUtil\makeDir(), ilUtil\rCopy(), xslt_create(), and xslt_free().

Referenced by exportPageElements().

Here is the call graph for this function:

Here is the caller graph for this function:

exportPageElements()

ilCOPageHTMLExport::exportPageElements

(

)

Export page elements.

Parameters

return

Definition at line 393 of file class.ilCOPageHTMLExport.php.

        {
                // export all media objects
                $linked_mobs = array();
                foreach ($this->mobs as $mob)
                {
                        if (ilObject::_exists($mob) && ilObject::_lookupType($mob) == "mob")
                        {
                                $this->exportHTMLMOB($mob, $linked_mobs);
                        }
                }
                $linked_mobs2 = array();                                // mobs linked in link areas
                foreach ($linked_mobs as $mob)
                {
                        if (ilObject::_exists($mob))
                        {
                                $this->exportHTMLMOB($mob, $linked_mobs2);
                        }
                }
 
                // export all file objects
                foreach ($this->files as $file)
                {
                        $this->exportHTMLFile($file);
                }
                
                // export all files (which are not objects
                foreach ($this->files_direct as $file_id => $attr)
                {                       
                        $this->exportHTMLFileDirect($file_id, $attr[0], $attr[1]);
                }
        }

References $file, ilObject\_exists(), ilObject\_lookupType(), exportHTMLFile(), exportHTMLFileDirect(), and exportHTMLMOB().

Here is the call graph for this function:

exportStyles()

ilCOPageHTMLExport::exportStyles

(

)

Export content style.

Parameters

return

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

        {
                include_once "Services/Style/classes/class.ilObjStyleSheet.php";
                
                // export content style sheet
                if ($this->getContentStyleId() < 1)
                {
                        $cont_stylesheet = "./Services/COPage/css/content.css";
 
                        $css = fread(fopen($cont_stylesheet,'r'),filesize($cont_stylesheet));
                        preg_match_all("/url\‍(([^\‍)]*)\‍)/",$css,$files);
                        foreach (array_unique($files[1]) as $fileref)
                        {
                                if (is_file(str_replace("..", ".", $fileref)))
                                {
                                        copy(str_replace("..", ".", $fileref), $this->content_style_img_dir."/".basename($fileref));
                                }
                                $css = str_replace($fileref, "images/".basename($fileref),$css);
                        }
                        fwrite(fopen($this->content_style_dir."/content.css",'w'),$css);
                }
                else
                {                       
                        $style = new ilObjStyleSheet($this->getContentStyleId());
                        $style->writeCSSFile($this->content_style_dir."/content.css", "images");
                        $style->copyImagesToDir($this->content_style_img_dir);
                }
                
                // export syntax highlighting style
                $syn_stylesheet = ilObjStyleSheet::getSyntaxStylePath();
                copy($syn_stylesheet, $this->exp_dir."/syntaxhighlight.css");
        }

References $files, getContentStyleId(), and ilObjStyleSheet\getSyntaxStylePath().

Here is the call graph for this function:

exportSupportScripts()

ilCOPageHTMLExport::exportSupportScripts

(

)

Export support scripts.

Parameters

return

Definition at line 132 of file class.ilCOPageHTMLExport.php.

        {
                
                // basic js
                copy('./Services/JavaScript/js/Basic.js', $this->js_dir.'/Basic.js');
                
                copy('./Services/UIComponent/Overlay/js/ilOverlay.js',$this->js_dir.'/ilOverlay.js');
                
                // jquery
                include_once("./Services/jQuery/classes/class.iljQueryUtil.php");
                copy(iljQueryUtil::getLocaljQueryPath(), $this->js_dir.'/jquery.js');
                copy(iljQueryUtil::getLocaljQueryUIPath(), $this->js_dir.'/jquery-ui-min.js');
                copy(iljQueryUtil::getLocalMaphilightPath(), $this->js_dir.'/maphilight.js');
 
                // yui stuff we use
                include_once("./Services/YUI/classes/class.ilYuiUtil.php");
                copy(ilYuiUtil::getLocalPath('yahoo/yahoo-min.js'),
                        $this->js_yahoo_dir.'/yahoo-min.js');
                copy(ilYuiUtil::getLocalPath('yahoo-dom-event/yahoo-dom-event.js'),
                        $this->js_yahoo_dir.'/yahoo-dom-event.js');
                copy(ilYuiUtil::getLocalPath('animation/animation-min.js'),
                        $this->js_yahoo_dir.'/animation-min.js');
                copy(ilYuiUtil::getLocalPath('container/container-min.js'),
                        $this->js_yahoo_dir.'/container-min.js');
                copy(ilYuiUtil::getLocalPath('container/assets/skins/sam/container.css'),
                        $this->css_dir.'/container.css');
                
                // accordion
                copy('./Services/Accordion/js/accordion.js',
                        $this->js_dir.'/accordion.js');
                copy('./Services/Accordion/css/accordion.css',
                        $this->css_dir.'/accordion.css');
                
                // page presentation js
                copy('./Services/COPage/js/ilCOPagePres.js',
                        $this->js_dir.'/ilCOPagePres.js');
                
                // tooltip
                copy('./Services/UIComponent/Tooltip/js/ilTooltip.js',
                        $this->js_dir.'/ilTooltip.js');
                
                // mediaelement.js
                include_once("./Services/MediaObjects/classes/class.ilPlayerUtil.php");
                ilPlayerUtil::copyPlayerFilesToTargetDirectory($this->flv_dir);
 
                // matching question
                copy('./Modules/TestQuestionPool/js/ilMatchingQuestion.js',
                        $this->js_dir.'/ilMatchingQuestion.js');
                copy('./Modules/TestQuestionPool/templates/default/test_javascript.css',
                        $this->css_dir.'/test_javascript.css');
 
 
//              copy(ilPlayerUtil::getLocalMediaElementCssPath(),
//                      $this->css_dir.'/mediaelementplayer.css');
//              copy(ilPlayerUtil::getLocalMediaElementJsPath(),
//                      $this->js_dir.'/mediaelement-and-player.js');
        }

References ilPlayerUtil\copyPlayerFilesToTargetDirectory(), iljQueryUtil\getLocaljQueryPath(), iljQueryUtil\getLocaljQueryUIPath(), iljQueryUtil\getLocalMaphilightPath(), and ilYuiUtil\getLocalPath().

Here is the call graph for this function:

getContentStyleId()

ilCOPageHTMLExport::getContentStyleId

(

)

Get content style id.

Returns

int content style id

Definition at line 59 of file class.ilCOPageHTMLExport.php.

        {
                return $this->content_style_id;
        }

References $content_style_id.

Referenced by exportStyles().

Here is the caller graph for this function:

getPreparedMainTemplate()

ilCOPageHTMLExport::getPreparedMainTemplate

(

$a_tpl = ""

)

Get prepared main template.

Parameters

return

Definition at line 196 of file class.ilCOPageHTMLExport.php.

        {
                global $ilUser;
                
                include_once("./Services/MediaObjects/classes/class.ilPlayerUtil.php");
                
                if ($a_tpl != "")
                {
                        $tpl = $a_tpl;
                }
                else
                {
                        // template workaround: reset of template
                        $tpl = new ilTemplate("tpl.main.html", true, true);
                }
                
                // scripts needed
                $scripts = array("./js/yahoo/yahoo-min.js", "./js/yahoo/yahoo-dom-event.js",
                        "./js/yahoo/animation-min.js", "./js/yahoo/container-min.js",
                        "./js/Basic.js", "./js/jquery.js", "./js/jquery-ui-min.js",
                        "./js/ilOverlay.js", "./js/accordion.js", "./js/ilCOPagePres.js",
                        "./js/ilTooltip.js", "./js/maphilight.js", "./js/ilMatchingQuestion.js");
                $scripts = array_merge($scripts, ilPlayerUtil::getJsFilePaths());
 
                $mathJaxSetting = new ilSetting("MathJax");
                $use_mathjax = $mathJaxSetting->get("enable");
                if ($use_mathjax)
                {
                        $scripts[] = $mathJaxSetting->get("path_to_mathjax");
                }
 
                foreach ($scripts as $script)
                {
                        $tpl->setCurrentBlock("js_file");
                        $tpl->setVariable("JS_FILE", $script);
                        $tpl->parseCurrentBlock();
                }
 
                // css files needed
                $style_name = $ilUser->prefs["style"].".css";
                $css_files = array("./css/accordion.css", "./css/container.css",
                        "./content_style/content.css", "./style/".$style_name, "./css/test_javascript.css");
                $css_files = array_merge($css_files, ilPlayerUtil::getCssFilePaths());
 
                foreach ($css_files as $css)
                {
                        $tpl->setCurrentBlock("css_file");
                        $tpl->setVariable("CSS_FILE", $css);
                        $tpl->parseCurrentBlock();
                }
 
                return $tpl;
        }

References $ilUser, $mathJaxSetting, $tpl, ilPlayerUtil\getCssFilePaths(), and ilPlayerUtil\getJsFilePaths().

Referenced by exportHTMLMOB(), and ilObjSCORM2004LearningModule\exportHTMLScoObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

setContentStyleId()

ilCOPageHTMLExport::setContentStyleId

(

$a_val

)

Set content style id.

Parameters

int

$a_val

content style id

Definition at line 49 of file class.ilCOPageHTMLExport.php.

        {
                $this->content_style_id = $a_val;
        }

Field Documentation

$content_style_id

ilCOPageHTMLExport::$content_style_id = 0

private

Definition at line 17 of file class.ilCOPageHTMLExport.php.

Referenced by getContentStyleId().

$exp_dir

ilCOPageHTMLExport::$exp_dir = ""

private

Definition at line 16 of file class.ilCOPageHTMLExport.php.

$files

ilCOPageHTMLExport::$files = array()

private

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

Referenced by collectPageElements(), and exportStyles().

$files_direct

ilCOPageHTMLExport::$files_direct = array()

private

Definition at line 15 of file class.ilCOPageHTMLExport.php.

$mobs

ilCOPageHTMLExport::$mobs = array()

private

Definition at line 13 of file class.ilCOPageHTMLExport.php.

---

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

• Services/COPage/classes/class.ilCOPageHTMLExport.php