class.ilSystemStyleLessFile.php

Go to the documentation of this file.

<?php
require_once("./Services/Style/System/classes/Less/class.ilSystemStyleLessItem.php");
require_once("./Services/Style/System/classes/Less/class.ilSystemStyleLessCategory.php");
require_once("./Services/Style/System/classes/Less/class.ilSystemStyleLessComment.php");
require_once("./Services/Style/System/classes/Less/class.ilSystemStyleLessVariable.php");


/***
 * This data abstracts a complete less file. A less file is composed of categories, variables and random comments
 * (unclassified information)
 *
 * @author            Timon Amstutz <timon.amstutz@ilub.unibe.ch>
 * @version           $Id$
 *
 */
class ilSystemStyleLessFile
{
        protected $items = array();

        protected $comments_ids = array();

        protected $variables_ids= array();

        protected $categories_ids = array();

        protected $less_variables_file_path = "";

        public function __construct($less_variables_file)
        {
                $this->less_variables_file = $less_variables_file;
                $this->read();
        }

        public function read(){
                $last_variable_comment = null;
                $last_category_id = null;
                $last_category_name = null;

                $regex_category = '/\/\/==\s(.*)/'; //Matches //== Category Name
                $regex_category_by_line = '/^\/\/[\s]?$/'; //Matches // at the end of the line with not comment
                $regex_category_comment = '/\/\/##\s(.*)/'; //Matches Matches //## Category Description
                $regex_variable = '/^@(.*)/'; //Matches @VariableName value;
                $regex_variable_comment = '/\/\/\*\*\s(.*)/'; //Matches //** Variable Comment
                $regex_variable_name = '/(?:@)(.*)(?:\:)/'; //Matches @variableName
                $regex_variable_value = '/(?::)(.*)(?:;)/'; //Matches value;
                $regex_variable_references = '/(?:@)([a-zA-Z0-9_-]*)/'; //Matches references in value

                try{
                        $handle = fopen($this->getLessVariablesFile(), "r");
                }catch(Exception $e){
                        throw new ilSystemStyleException(ilSystemStyleException::FILE_OPENING_FAILED, $this->getLessVariablesFile());
                }


                if ($handle) {
                        $line_number = 1;
                        $last_line_is_category = false;
                        //Reads file line by line
                        while (($line = fgets($handle)) !== false) {
                                //This might be part of the categories structure, if so, ignore
                                if($last_line_is_category && preg_match($regex_category_by_line, $line, $out)){
                                        $line = fgets($handle);
                                }
                                $last_line_is_category = false;
                                if(preg_match($regex_category, $line, $out)){
                                        //Check Category
                                        $last_category_id = $this->addItem(new ilSystemStyleLessCategory($out[1]));
                                        $last_category_name = $out[1];
                                        $last_line_is_category = true;
                                } else if(preg_match($regex_category_comment, $line, $out)){
                                        //Check Comment Category
                                        $last_category = $this->getItemById($last_category_id);
                                        $last_category->setComment($out[1]);
                                } else if(preg_match($regex_variable_comment, $line, $out)){
                                        //Check Variables Comment
                                        $last_variable_comment = $out[1];
                                } else if(preg_match($regex_variable, $line, $out)){
                                        //Check Variables

                                        //Name
                                        preg_match($regex_variable_name, $out[0], $variable);

                                        //Value
                                        preg_match($regex_variable_value, $line, $value);

                                        //References
                                        $temp_value = $value[0];
                                        $references = array();
                                        while(preg_match($regex_variable_references,$temp_value,$reference)){
                                                $references[] = $reference[1];
                                                $temp_value = str_replace($reference,"",$temp_value);
                                        }

                                        $this->addItem(new ilSystemStyleLessVariable(
                                                $variable[1],
                                                ltrim ( $value[1] ," \t\n\r\0\x0B" ),
                                                $last_variable_comment,
                                                $last_category_name,
                                                $references));
                                        $last_variable_comment = "";

                                }else{
                                        $this->addItem(new ilSystemStyleLessComment($line));
                                }


                                $line_number++;
                        }
                        fclose($handle);
                } else {
                        throw new ilSystemStyleException(ilSystemStyleException::FILE_OPENING_FAILED);
                }
        }

        public function write(){
                file_put_contents($this->getLessVariablesFile(),$this->getContent());
        }

        public function getContent(){
                $output = "";

                foreach($this->items as $item){
                        $output .= $item->__toString();
                }
                return $output;
        }

        public function addItem(ilSystemStyleLessItem $item){
                $id = array_push($this->items,$item)-1;


                if(get_class($item)=="ilSystemStyleLessComment"){
                        $this->comments_ids[] = $id;
                }else if(get_class($item)=="ilSystemStyleLessCategory"){
                        $this->categories_ids[] = $id;
                }else if(get_class($item)=="ilSystemStyleLessVariable"){
                        $this->variables_ids[] = $id;
                }

                return $id;
        }

        public function getCategories(){
                $categories = array();

                foreach($this->categories_ids as $category_id){
                        $categories[] = $this->items[$category_id];
                }

                return $categories;

        }

        public function getVariablesPerCategory($category = ""){
                $variables = array();

                foreach($this->variables_ids as $variables_id){
                        if(!$category || $this->items[$variables_id]->getCategoryName() == $category){
                                $variables[] = $this->items[$variables_id];
                        }
                }

                return $variables;
        }

        public function getItemById($id){
                return $this->items[$id];
        }

        public function getVariableByName($name = ""){
                foreach($this->variables_ids as $variables_id){
                        if($this->items[$variables_id]->getName() == $name){
                                return $this->items[$variables_id];
                        }
                }
                return null;

        }

        public function getReferencesToVariable($variable_name){
                $references = [];

                foreach($this->variables_ids as $id){
                        foreach($this->items[$id]->getReferences() as $reference){
                                if($variable_name == $reference)
                                $references[] = $this->items[$id]->getName();
                        }
                }
                return $references;
        }

        public function getReferencesToVariableAsString($variable_name){
                $references_string = "";
                foreach($this->getReferencesToVariable($variable_name) as $reference){
                        $references_string .= "$reference; ";
                }
                return $references_string;
        }

        public function getLessVariablesFile()
        {
                return $this->less_variables_file;
        }

        public function setLessVariablesFile($less_variables_file)
        {
                $this->less_variables_file = $less_variables_file;
        }

        public function getItems()
        {
                return $this->items;
        }

        public function getCommentsIds()
        {
                return $this->comments_ids;
        }

        public function getVariablesIds()
        {
                return $this->variables_ids;
        }

        public function getCategoriesIds()
        {
                return $this->categories_ids;
        }
}