class.ilSkinXML.php

Go to the documentation of this file.

<?php
include_once("Services/Style/System/classes/Exceptions/class.ilSystemStyleException.php");
include_once("Services/Style/System/classes/Utilities/class.ilSkinStyleXML.php");

class ilSkinXML implements \Iterator, \Countable{

        protected $id = "";


        protected $name = "";

        protected $styles = array();

        protected $version = "0.1";


        public function __construct($id, $name)
        {
                $this->setId($id);
                $this->setName($name);
        }

        public static function parseFromXML($path = ""){
                try{
                        $xml = new SimpleXMLElement(file_get_contents($path));
                }catch(Exception $e){
                        throw new ilSystemStyleException(ilSystemStyleException::FILE_OPENING_FAILED, $path);
                }

                $id = basename (dirname($path));
                $skin = new self($id,(string)$xml->attributes()["name"]);
        $skin->setVersion((string)$xml->attributes()["version"]);

                $last_style = null;


                foreach($xml->children() as $style_xml){

                        $style = ilSkinStyleXML::parseFromXMLElement($style_xml);

                        if($style_xml->getName() == "substyle") {
                                if(!$last_style){
                                        throw new ilSystemStyleException(ilSystemStyleException::NO_PARENT_STYLE, $style->getId());
                                }
                                $style->setSubstyleOf($last_style->getId());
                        }else{
                                $last_style = $style;
                        }
                        $skin->addStyle($style);

                }
                return $skin;
        }

        public function asXML(){
                $xml = new SimpleXMLElement('<?xml version="1.0" encoding="UTF-8"?><template/>');
                $xml->addAttribute("xmlns","http://www.w3.org");
                $xml->addAttribute("version",$this->getVersion());
                $xml->addAttribute("name",$this->getName());

                $last_style = null;

                foreach($this->getStyles() as $style){
                        if(!$style->isSubstyle()){
                                $this->addChildToXML($xml, $style);

                                foreach($this->getSubstylesOfStyle($style->getId()) as $substyle){
                                        $this->addChildToXML($xml, $substyle);
                                }
                        }
                }

                $dom = new DOMDocument('1.0', 'utf-8');
                $dom->formatOutput = true;
                $dom->loadXML($xml->asXML());
                return $dom->saveXML();
        }

        protected function addChildToXML(SimpleXMLElement $xml,ilSkinStyleXML $style){
                $xml_style = null;
                if($style->isSubstyle()){
                        $xml_style = $xml->addChild("substyle");
                }
                else{
                        $xml_style = $xml->addChild("style");
                }
                $xml_style->addAttribute("id", $style->getId());
                $xml_style->addAttribute("name", $style->getName());
                $xml_style->addAttribute("image_directory", $style->getImageDirectory());
                $xml_style->addAttribute("css_file", $style->getCssFile());
                $xml_style->addAttribute("sound_directory", $style->getSoundDirectory());
                $xml_style->addAttribute("font_directory", $style->getFontDirectory());
        }

        public function writeToXMLFile($path){
                file_put_contents($path, $this->asXML());
        }
        public function addStyle(ilSkinStyleXML $style){
                $this->styles[] = $style;
        }

        public function removeStyle($id){
                foreach($this->getStyles() as $index => $style){
                        if($style->getId() == $id){
                                unset($this->styles[$index]);
                                return;
                        }
                }
                throw new ilSystemStyleException(ilSystemStyleException::INVALID_ID,$id);
        }

        public function getStyle($id){
                foreach($this->getStyles() as $style){
                        if($style->getId() == $id){
                                return $style;
                        }
                }
                throw new ilSystemStyleException(ilSystemStyleException::INVALID_ID,$id);
        }

        public function hasStyle($id){
                foreach($this->getStyles() as $style){
                        if($style->getId() == $id){
                                return true;
                        }
                }
                return false;
        }

        public function getDefaultStyle(){
                return array_values($this->styles)[0];
        }

        public function valid() {
                return current($this->styles) !== false;
        }

        public function key() {
                return key($this->styles);
        }

        public function current() {
                return current($this->styles);
        }

        public function next() {
                next($this->styles);
        }
        public function rewind() {
                reset($this->styles);
        }

        public function count(){
                return count($this->styles);
        }

        public function getId()
        {
                return $this->id;
        }

        public function setId($id)
        {
                if (strpos($id, ' ') !== false) {
                        throw new ilSystemStyleException(ilSystemStyleException::INVALID_CHARACTERS_IN_ID, $id);
                }
                $this->id = str_replace(" ","_",$id);
        }


        public function getName()
        {
                return $this->name;
        }

        public function setName($name)
        {
                $this->name = $name;
        }

        public function getStyles()
        {
                return $this->styles;
        }

        public function setStyles($styles)
        {
                $this->styles = $styles;
        }

    public function getVersion()
    {
        return $this->version;
    }

    public function setVersion($version)
    {
        if($version != null && $version != '' && $this->isVersionChangeable()) {
            $this->version = $version;
        }
    }

    public function getVersionStep($version)
    {
        if($this->isVersionChangeable()) {
            $v = explode('.', ($version == "" ? '0.1' : $version));
            $v[count($v) - 1] = ($v[count($v) - 1] + 1);
            $this->version = implode('.', $v);
        }
        return $this->version;
    }

    public function isVersionChangeable()
    {
        return ($this->version != '$Id$');
    }

        public function getSubstylesOfStyle($style_id){
                $substyles = array();

                if($this->getStyle($style_id)){
                        foreach($this->getStyles() as $style){
                                if($style->getId() != $style_id && $style->isSubstyle()){
                                        if($style->getSubstyleOf() == $style_id){
                                                $substyles[$style->getId()] = $style;
                                        }
                                }
                        }
                }
                return $substyles;
        }

        public function hasStyleSubstyles($style_id){
                if($this->getStyle($style_id)){
                        foreach($this->getStyles() as $style){
                                if($style->getId() != $style_id && $style->isSubstyle()){
                                        if($style->getSubstyleOf() == $style_id){
                                                return true;
                                        }
                                }
                        }
                }
                return false;

        }

        public function hasStyles(){
                return count($this->getStyles()) > 0;
        }
}